hisptz · nnkogift · Nov 3, 2025 · Sep 23, 2025 · Sep 26, 2025 · Sep 26, 2025
diff --git a/.idea/conventionalCommit.xml b/.idea/conventionalCommit.xml
diff --git a/.idea/git_toolbox_prj.xml b/.idea/git_toolbox_prj.xml
diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
diff --git a/.idea/jsLinters/eslint.xml b/.idea/jsLinters/eslint.xml
diff --git a/.idea/prettier.xml b/.idea/prettier.xml
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
diff --git a/docs/standalone-action-tracker/administration/index.md b/docs/standalone-action-tracker/administration/index.md
diff --git a/docs/standalone-action-tracker/administration/intro.md b/docs/standalone-action-tracker/administration/intro.md
diff --git a/docs/standalone-action-tracker/best-practices/index.md b/docs/standalone-action-tracker/best-practices/index.md
diff --git a/docs/standalone-action-tracker/best-practices/intro.md b/docs/standalone-action-tracker/best-practices/intro.md
diff --git a/docs/standalone-action-tracker/concepts.md b/docs/standalone-action-tracker/concepts.md
@@ -0,0 +1,46 @@
+---
+title: Concepts
+sidebar_position: 4
+---
+
+# Concepts
+
+This section outlines some of the key concepts of the standalone action tracker. These concepts make up how the
+standalone action tracker works to ensure proper tracking.
+
+## Categories
+
+Actions in the standalone action tracker can be categorized into one or more categories. This is to enable a
+customizable grouping of actions based on a specific use case. This allows for a better overview and analysis of the
+actions.
+
+Categorization in the standalone action tracker is done initially when selecting the configuration type. The standalone
+action tracker only supports up to level 3 of categorization. The levels are named **Basic**, **Secondary** and
+**Tertiary**.
+
+- **Basic activity tracking**: The basic activity tracking is the most basic level of categorization. In this setup, the
+  actions are only categorized once without any nested categories.
+
+- **Secondary activity tracking**: The secondary activity tracking is a more advanced level of categorization. In this
+  setup, the actions are categorized twice (one nested category).
+
+- **Tertiary activity tracking**: The tertiary activity tracking is the most advanced level of categorization. In this
+  setup, the actions are categorized three (two nested categories).
+
+It is important to understand which of these level of categorization is the best fit for your use case before starting
+to setup your standalone action tracker. Selecting a level of categorization cannot be changed at a later time.
+
+:::warning
+Level of categorization is not editable in the standalone action tracker. To change the level of categorization,
+you will need to re-setup the standalone action tracker.
+:::
+
+## Actions
+
+An action is a single event/entity tracked in the standalone action tracker. An action has properties like start and end
+date and status that allow the user to view and analyze the actions.
+
+- **Start date**: The start date of an action is the date when the action is planned to start.
+- **End date**: The end date of an action is the date when the action was ended.
+- **Status**: The status of an action with values which are configurable by the user.
+
diff --git a/docs/standalone-action-tracker/configuration/access.md b/docs/standalone-action-tracker/configuration/access.md
@@ -0,0 +1,38 @@
+---
+title: Access & Authorization
+sidebar_position: 1
+---
+
+# Access & Authorization
+
+After installation, you will need to configure who can access the Standalone Action Tracker. This configuration is done
+in the DHIS2 users app. You also need to configure the app system authorities to roles depending on the activities they
+will be performing in the Standalone Action Tracker. You can have one or more roles corresponding to the authorities.
+
+The application access is configured as any other app access in DHIS2.
+
+## Steps
+
+1. Open the Users app
+2. Navigate to the roles configuration by click on the User Roles
+3. Select and edit the role that you want to be able to access the Standalone Action Tracker app
+4. On authorities configuration area, select the `actiontrackerstandalone app` on the available authorities. ( Selection
+   should move it to the selected authorities area )
+![access](/img/standalone-action-tracker/app-access.png)
+5. On the system authorities area, There will be 3 Standalone Action Tracker specific authorities:
+   ![access](/img/standalone-action-tracker/in-app-authorities.png)
+
+| Authority Name                        | Description                                                                           |
+|---------------------------------------|---------------------------------------------------------------------------------------|
+| Standalone Action Tracker - Configure | This allows the user to add/update the standalone action tracker configuration        |
+| Standalone Action Tracker - Planning  | This allows the user to add/update the standalone action tracker planning information |
+| Standalone Action Tracker - Tracking  | This allows the user to track already planned actions/activities                      |
+
+Select any of the authorities that apply to the user role you are updating. A user role can have one or more of the 3
+authorities.
+
+5. Save the changes
+
+## Next steps
+
+Ensure all users that will be using the Standalone Action Tracker have been assigned the role that has been configured.
diff --git a/docs/standalone-action-tracker/configuration/action.md b/docs/standalone-action-tracker/configuration/action.md
@@ -0,0 +1,116 @@
+---
+title: Action Configuration
+sidebar_position: 5
+---
+
+# Action Configuration
+
+## Overview
+
+The action section allows you to configure action and action status metadata. You can learn about this
+concept [here](../concepts.md#actions)
+
+## Action Planning
+
+In this section you can configure what data you want to collect during action planning.
+
+### Action Name
+
+An action name is a label for the action in the standalone action tracker.
+This will appear on headings and button labels
+
+![Action Name](/img/standalone-action-tracker/action-name-configuration.png)
+
+An action should have a start
+date, end date, and a label by minimum. By default, the action will have the fields `Start Date`, `End Date`,
+`Description`, and `Activity`. You can remove or add fields to the action.
+
+To add a new field, click on the `Add Field` button. From here, you can decide to either add a new field from already
+existing DHIS2 metadata or create a new field. Adding from existing DHIS2 metadata will allow you to select any of the
+fields that are already configured in DHIS2. This should only be done if the defined field is not used in any other
+programs within DHIS2.
+
+:::warning
+Selecting an existing field from DHIS2 will modify the field to work with your configuration. This change will affect
+any other program using the field and so it is recommended to create a new field instead.
+:::
+
+To create a new field, click on the `Add new field` option. This will open a form where you can configure the field.
+
+![category-fields-add-new](/img/standalone-action-tracker/categories-add-new-field.png)
+
+### Field Configuration
+
+You can configure the following fields for a action field:
+
+| Field                     | Description                                                                                                                                                                                                            |
+|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Display Name              | This is the name of the field in the form. It will also be the column name if the field is set to show in column                                                                                                       |
+| Short Name                | This is a shorter version of the name. It should not exceed 50 characters. This will be used as a label in views that need limited length labels                                                                       |
+| Type                      | Type of data the field will hold, supported fields are `Text`, `Long Text`, `Number`, `Integer`, and `Date`                                                                                                            |
+| Option set                | For `Text`, `Number`, and `Integer` fields, you can select an option set to restrict the values that can be selected for the field. You can create a new option set or use an existing option set from DHIS2 metadata. |
+| Field should be mandatory | Check this to ensure the field is filled when performing data entry                                                                                                                                                    |
+| Show field as column      | This will show the field as a column in the category card.                                                                                                                                                             |
+
+You can add as many fields as needed.
+
+## Action Tracking
+
+There are 3 areas of configuration for action tracking in the standalone action tracker:
+
+### Action Status Review Date
+
+This is the configuration for the mandatory date field for each of the action status update. The only configuration for
+this field is the label of the field. By default, the field is labelled as `Review Date`. You can rename the field to
+whatever fits your use case.
+
+### Action Status Fields
+
+In this section you can configure what data you want to collect during action tracking. The `Status`, `Reporting Date`
+fields are mandatory and cannot be removed. By default, the `Comment` as a long text field is added. You can remove or
+modify this field. You can also add new fields. Supported fields in action tracking are `Text`, `Long Text`, `Number`,
+`Integer`, `Date`, and `File Resource`. The file resource field allows you to upload files like reports and images as
+supporting documents.
+
+:::info
+You can add a `File Resource` field to allow upload of documents or images in action tracking
+:::
+
+You can configure the following fields for an action status field:
+
+| Field                     | Description                                                                                                                                                                                                            |
+|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Display Name              | This is the name of the field in the form. It will also be the column name if the field is set to show in column                                                                                                       |
+| Short Name                | This is a shorter version of the name. It should not exceed 50 characters. This will be used as a label in views that need limited length labels                                                                       |
+| Type                      | Type of data the field will hold, supported fields are `Text`, `Long Text`, `Number`, `Integer`,`Date`, and `File Resource`                                                                                            |
+| Option set                | For `Text`, `Number`, and `Integer` fields, you can select an option set to restrict the values that can be selected for the field. You can create a new option set or use an existing option set from DHIS2 metadata. |
+| Field should be mandatory | Check this to ensure the field is filled when performing data entry                                                                                                                                                    |
+| Show field as column      | This will show the field as a column in the category card.                                                                                                                                                             |
+
+### Action Status Options
+
+In this section you can configure the options that will be available for the `Status` field. This is a special field
+that determines the status of the action at any reporting period.
+
+By default, the are 4 status options, `Not Started`, `In Progress`, `Completed`, and `Cancelled`. You can add as many
+options as needed, or modify the existing options to match your use case.
+
+To add a new option, click on the `Add new option` button. This will open a form where you can configure the option. All
+fields are mandatory.
+
+![action-status-option](/img/standalone-action-tracker/action-status-option.png)
+You can configure the following fields for an action status option:
+
+| Field | Description                                                                 |
+|-------|-----------------------------------------------------------------------------|
+| Name  | The name of the option, this will be the label displayed                    |
+| Code  | The code of the option, this is a unique value to be stored in the database |
+| Color | The color of the option in the action status column                         |
+| Icon  | The icon of the option displayed in the latest action status column         |
+
+## Next Steps
+
+Click on `Save changes` button to save the changes.
+
+Congratulations! You have completed the configuration of the standalone action tracker. Head over to
+the [planning](../planning) section