Configuration


All the configuration options presented in this page may be added to your .env file. However, you have nothing to do if you want to use the default values.

Basic xAPI settings

Statements API limit

When performing a GET request on the Statements API, by default, the number of returned statements is limited to 100, except when you define your own limit in the request. You can change this default value in the .env file. For example:

XAPI_STATEMENTS_LIMIT=50

Statements authority

TRAX LRS sets or overrides the authority of all the incoming statements. When creating a client in TRAX LRS, you can define the matching authority. When no authority is defined for a client, the default authority is used:

{
    "objectType": "Agent",
    "account": {
        "name": "authority",
        "homePage": "http://traxlrs.com"
    }
}

You can change this default authority in the .env file. For example:

XAPI_STATEMENTS_AUTHORITY_NAME=my-authority
XAPI__STATEMENTS_AUTHORITY_HOMEPAGE=http://my-lrs.com

Configuration profile

{danger} Choose a configuration profile before starting to record statements. Then, don't change it or you may get inconsistent behaviors.

TRAX LRS offers several configuration profiles to better match your LRS use case. The default profile is basic. It can be changed in the .env file:

XAPI_STORE_PROFILE=relational

basic

TRAX LRS simply stores statements in the statements table, then extracts and stores activities in the activities table.

No more information is stored in the database. This is enought to meet the xAPI conformance requirements without complexity. And this is great if you want to give the priority to writing performances.

relational

TRAX LRS stores agents and verbs in specific tables. It also stores the relations between statements, activities, agents and verbs.

Relations are used to build faster requests when exploring data. But writing operations are a bit slower.

partial_pseudo

This profile enables the pseudonymization feature of TRAX LRS on agents only, but not on groups.

This profile decreases writing and reading performances.

full_pseudo

This profile enables the pseudonymization feature of TRAX LRS on agents and groups.

This profile decreases writing and reading performances.