22.7 Configure tracked entities

22.7.1 About tracked entities

A tracked entity is a types of entities which can be tracked through the system. It can be anything from persons to commodities, for example a medicine or a person.

A program must have one tracked entity. To enrol a tracked entity instance into a program, the tracked entity of an entity and tracked entity of a program must be the same.

Tracked entity attributes are used to register extra information for a tracked entity. Tracked entity attributes can be shared between programs.

22.7.2 Create or edit a tracked entity attribute

  1. Open the Maintenance app and click Program > Tracked entity attribute .

  2. Click the add button.

  3. In the Name field, type the tracked entity attribute name.

  4. (Optional) Type a Short name .

  5. (Optional) In the Code field, assign a code.

  6. (Optional) Type a Description .

  7. Select an Option set .

  8. In the Value type field, select the type of data that the tracked entity attribute will record.

    Value types

    Value type

    Description

    Age

    -

    Coordinate

    A point coordinate specified as longitude and latitude in decimal degrees. All coordinate should be specified in the format “-19.23 , 56.42” with a comma separating the longitude and latitude.

    Date

    Dates render as calendar widget in data entry.

    Date & time

    -

    E-mail

    -

    File

    A file resource where you can store external files, for example documents and photos.

    Image Similar to File, but restricted to images.

    Integer

    Any whole number (positive and negative), including zero.

    Letter

    -

    Long text

    Textual value. Renders as text area in forms.

    Negative integer

    Any whole number less than (but not including) zero.

    Number

    Any real numeric value with a single decimal point. Thousands separators and scientific notation is not supported.

    Percentage

    Whole numbers inclusive between 0 and 100.

    Phone number

    Positive integer

    Any whole number greater than (but not including) zero.

    Positive of zero integer

    Any positive whole number, including zero.

    Organisation unit

    -

    Unit interval

    Any real number greater than or equal to 0 and less than or equal to 1.

    Text

    Textual value. The maximum number of allowed characters per value is 50,000.

    Time

    Time is stored in HH:mm format.

    HH is a number between 0 and 23

    mm is a number between 00 and 59

    Tracker associate

    -

    Username

    This will be populated with the username of the user which performs data entry automatically during the data entry process.

    Yes/No

    Boolean values, renders as drop-down lists in data entry.

    Yes only

    True values, renders as check-boxes in data entry.

  9. Select an Aggregation type .

    Aggregation operators

    Aggregation operator

    Description

    Average

    Average the values in both the period as and the organisation unit dimensions.

    Average (sum in organisation unit hierarchy)

    Average of data values in the period dimension, sum in the organisation unit dimensions.

    Count

    Count of data values.

    Min

    Minimum of data values.

    Max

    Maximum of data values.

    None

    No aggregation is performed in any dimension.

    Sum

    Sum of data values in the period and organisation unit dimension.

    Standard deviation

    Standard deviation (population-based) of data values.

    Variance

    Variance (population-based) of data values.

  10. Select Unique to specify that the values of the tracked entity attribute is unique.

    There are two options for the unique setting:

    • Entire system : The values of the tracked entity attribute can duplicate with values which belong to other tracked entity attributes. But the values in this tracked entity attribute must not duplicate.

      Select Automatically generated to allow automatic generation of the tracked entity attribute value. When the generate setting is selected on, an optional field for specifying pattern also displays. This field should contain a pattern based on the TextPattern syntax. When the value is automatically generated, it will be unique for this attribute for the entire system. See the TextPattern section for more information on how it works.

    • Organisation unit : The values of the tracked entity attribute must not duplicate in the same organisation unit.

  11. Select Inherit to registry a new entity for relationship with an available entity, all inherit entity attribute values of the entity will be pre-filled in the registration form.

  12. (Optional) Select Confidential .

    This option is only available if you have configured encryption for the system.

  13. (Optional) Select Display in list without program .

  14. (Optional) Assign one or multiple Legends .

  15. Click Save .

22.7.3 Create or edit a tracked entity type

  1. Open the Maintenance app and click Program > Tracked entity type .

  2. Click the add button or an already exsisting tracked entity type .

  3. Type a Name of the tracked entity.

  4. (Optional) Enter a Description of the tracked entity.

  5. (Optional) Enter a Minimum number of attributes required to search . This specifies the amount of attributes that need to be filled out in order to be able to search for this tracked entity type in a global search . See Configure Search for more information.

  6. (Optional) Enter a Maximum number of tracked entity instances to return in search . This specifies the amount of tracked entity instances that will be returned in a global search . See Configure Search for more information.

  7. (Optional) Add Tracked entity type attributes . This is used to configure search, see Configure Search for more information.

  8. (Optional) Enter an Alternative name of the tracked entity.

  9. Click Save .