Feature/access scorecard

docs/scorecard/administration/migrate-scorecard-v1.md

@@ -0,0 +1,20 @@
+---
+sidebar_position: 4
+---
+# Migrate Scorecard V1
+
+If you have existing scorecards created using the older version of the Scorecard Application (V1), you can migrate them into the new Scorecard App for continued use. The migration tool is built into the application and allows you to transfer configurations seamlessly.
+
+## Steps to Migrate Scorecards
+- Open the Scorecard Application, then  at the bottom-right corner of the interface, you will see an option to Migrate from V1 to access page for inbuilt tools for scorecard migration.
+
+![access panel to migrate v1 scorecards](/img/scorecard/access-panel-to-migrate-v1-scorecards.png)
+
+
+- In migration page, list of available scorecards configured in the old Scorecard App will be displayed, then select the scorecard(s) you wish to migrate.
+- Click the **`Migrate`** button and wait for the migration process to complete.
+- Once migration is completed successfully, the migrated scorecard(s) will appear in the new Scorecard App, where they can be accessed and used as normal.
+
+![manage migration scorecard v1](/img/scorecard/manage-migration-scorecard-v1.png)
+
+> **Note**: After migration, it is recommended to review the scorecard configurations including verify that indicators, filters, and other options are working as expected in the scorecard application.

docs/scorecard/configuration/configuring-scorecard-as-widget.md

@@ -3,7 +3,7 @@ sidebar_position: 5
 ---
 
 # Scorecard In Dashboard
-The Scorecard in Dashboard feature allows users to embed scorecards directly into dashboards for easy visualization and monitoring. This ensures that key metrics are displayed in a centralized, interactive, and customizable format tailored to programmatic or organizational needs.
+The Scorecard in Dashboard feature allows users to embed scorecards directly into dashboards for easy visualization and monitoring. This ensures that key metrics are displayed in a centralized, interactive, and customizable format tailored to programmatic or organisational needs.
 
 ## Prerequisites
 Before adding a scorecard to a dashboard, ensure the following requirements are met:

docs/scorecard/configuration/higlight-indicators.md

@@ -15,7 +15,7 @@ To add new highlighted indicator, below are steps to follow:-
 3. Once selected, the indicator will appear as a highlighted metric within the scorecard, drawing attention to its performance if option to view highlighted has been enabled.
 
 ## Managing Highlighted Indicators
-Over time, program priorities may change, and highlighted indicators may need to be updated, refined, or removed. The scorecard provides flexible options for managing highlighted indicators to ensure they remain accurate and aligned with evolving goals. This flexibility ensures that highlighted indicators remain relevant, actionable, and aligned with organizational priorities
+Over time, program priorities may change, and highlighted indicators may need to be updated, refined, or removed. The scorecard provides flexible options for managing highlighted indicators to ensure they remain accurate and aligned with evolving goals. This flexibility ensures that highlighted indicators remain relevant, actionable, and aligned with organisational priorities
 
 Options for managing highlighted indicators include:-
  - **Deleting** highlighted indicators that are no longer relevant or needed.

docs/scorecard/features.md

@@ -12,6 +12,8 @@ The scorecard app comes with built-in, interactive help features to guide users
  - **How it works**: Users can click on **help icons** for detailed instructions as result reducing the need for external manuals.
  - **Why it matters**: Ensures that even new users can navigate and configure the scorecard independently, reducing training needs.
 
+![interactive help in action](/img/scorecard/interactive-help-in-action.png)
+
 ## Reusability Metadata from DHIS2 instance
 The Scorecard App is built on DHIS2’s existing metadata like indicators, data elements and others, which means it integrates seamlessly with the Maintenance App.
  - **What it does**: Automatically pulls data from DHIS2 indicators, data elements and other metadata already defined in the DHIS2 instance.

docs/scorecard/installation.md

@@ -11,16 +11,16 @@ The Scorecard App is an optional DHIS2 application that needs to be installed in
 
 ## Install from DHIS2 App Hub
 The DHIS2 App Hub is the official marketplace for DHIS2 apps, providing the latest stable and secure versions. Installing directly from the App Hub ensures compatibility with your DHIS2 version and makes it easier to update in the future. To install the scorecard application from DHIS2 App Hub, you can follow below steps:-
-1. Log in to your DHIS2 instance with an account that has App Management authority.
-2. Go to **Apps** → **App Management**.
-3. Click **App Hub** on side menu of app management application to open the DHIS2 App Hub.
-4. Search for **Scorecard App**, and click the scorecard app icon.
-5. Select the latest compatible version for your DHIS2 instance or previous versions if needed.
-6. Click Install and wait for the process to complete.
-7. Refresh your browser to load the new app.
-8. Confirm that the Scorecard App appears in the Apps menu.
-9. Open the app and test that it runs correctly.
-10. Adjust user roles and sharing settings if other users need access.
+- Log in to your DHIS2 instance with an account that has App Management authority.
+- Go to **Apps** → **App Management**.
+- Click **App Hub** on side menu of app management application to open the DHIS2 App Hub.
+- Search for **Scorecard App**, and click the scorecard app icon.
+- Select the latest compatible version for your DHIS2 instance or previous versions if needed.
+- Click Install and wait for the process to complete.
+- Refresh your browser to load the new app.
+- Confirm that the Scorecard App appears in the Apps menu.
+- Open the app and test that it runs correctly.
+- Adjust user roles and sharing settings if other users need access.
 
 
 ![Fig](/img/scorecard/scorecard-sample-img.png)
@@ -33,14 +33,14 @@ The DHIS2 App Hub is the official marketplace for DHIS2 apps, providing the late
 
 ## Manual Upload
 This option is useful if your DHIS2 instance does not have internet access or if you have been provided a specific version of the app for your implementation but needs prior download of scorecard app packages. To install the socrecard application manually, you can follow below steps
-1. Download the Scorecard App .zip package from [DHIS2 App Hub](https://apps.dhis2.org/) ***or*** [GitHub Release Page](https://github.com/hisptz/scorecard-app/releases).
-2. Log in to your DHIS2 instance with an account that has App Management authority.
-3. Go to **Apps** → **App Management**.
-4. Click **Manual Install** on side menu of app management application, then **Upload an app to install** buttom to select then choose previously downloaded .zip package for the scorecard and wait for the process to complete.
-5.  Refresh your browser to load the new app.
-6. Confirm that the Scorecard App appears in the Apps menu.
-7. Open the app and test that it runs correctly.
-8. Adjust user roles and sharing settings if other users need access.
+- Download the Scorecard App .zip package from [DHIS2 App Hub](https://apps.dhis2.org/) ***or*** [GitHub Release Page](https://github.com/hisptz/scorecard-app/releases).
+- Log in to your DHIS2 instance with an account that has App Management authority.
+- Go to **Apps** → **App Management**.
+- Click **Manual Install** on side menu of app management application, then **Upload an app to install** buttom to select then choose previously downloaded .zip package for the scorecard and wait for the process to complete.
+- Refresh your browser to load the new app.
+- Confirm that the Scorecard App appears in the Apps menu.
+- Open the app and test that it runs correctly.
+- Adjust user roles and sharing settings if other users need access.
 
 
 

docs/scorecard/navigation/access-scorecard.md

@@ -4,25 +4,67 @@ sidebar_position: 1
 
 # Access Scorecard
 
-## tips
- - listing, search, layouts, paginations, helps tips
- - option edit, view & delete fn
+The Scorecard App can be accessed directly from within DHIS2, either through the global app menu or from a configured dashboard. This ensures users can quickly navigate to scorecards for analysis, configuration, or management.
 
+## Accessing Using Scorecard App
 
-## Accessing the Scorecard App
-- Open the **Global DHIS2 Menu** at the top of your instance.
-- Select **Scorecard App** from the list of available apps.
-- Notifications and alerts related to the Scorecard App will also appear in the global menu area.
+Since the Scorecard App is a custom DHIS2 web application, it is accessible through the global app menu:
+- Open the Global DHIS2 Menu at the top of your instance.
+- Select Scorecard App from the list of available apps.
+- The application will open, displaying the Scorecard App home page.
 
----
+![open scorecard app](/img/scorecard/open-scorecard-app.png)
+
+### Available options on the home page
+Upon opening the app, several options and functionalities are available:
+- **Interactive Help**: Click the help button to view a quick interactive guide on using the Scorecard Applications.
+- **Add New Scorecard**: Use the Add New Scorecard button to create and configure a new scorecard.
+- **Manage Existing Scorecards**: This section displays all scorecards you have access to. Several management options are available, each supporting efficient navigation and configuration.
+
+### Manage Existing Scorecards
+When viewing existing scorecards, the application provides a set of tools to help users locate, organise, and act on scorecards. Each option is illustrated with figures in the user guide.
+
+#### Search Of Scorecard
+In case of huge list of scorecards, and user can quickly find a scorecard by typing its name into the Search bar. This is especially useful when working with a large number of scorecards.
+
+![search specific scorecard](/img/scorecard/search-specific-scorecard.png)
+
+#### Scorecard List Page Navigation
+
+If there are many scorecards, they are organized across multiple pages for improving performance on listing the scorecard. For moving between paginations, the page navigation toolbar facilitate navigation of list between pages navigations.
+
+![navigate between page scorecard list](/img/scorecard/navigate-between-page-scorecard-list.png)
+
+#### Change Number of Items per Page
+
+By default, 10 scorecards are displayed per page. You can change this setting to display 5, 20, 75, or 100 scorecards per page depending on your preference.
+
+![change pagination size scorecard list](/img/scorecard/change-pagination-size-scorecard-list.png)
+
+#### Layout Options
+In view list of scorecard, there are different view for displaying the list of scorecard, below are the view supported:-
+- **Grid View**: It's the default layout and displays scorecards as cards for a quick visual overview.
+- **List View**: Displays scorecards in a tabular style with more text-based details.
+
+![change scorecard list view](/img/scorecard/change-scorecard-list-view.png)
+
+#### Scorecard Actions
+
+Each scorecard card (or row in List view) contains action buttons, with availability depending on user sharing settings:
+- **View**: Open the scorecard for further analysis.
+- **Edit**: Modify the configuration of the scorecard.
+- **Delete**: Permanently remove the scorecard from the system.
+
+
+
+![scorecard-action-options](/img/scorecard/scorecard-action-options.png)
+
+## Accessing Scorecard from Dashboard
+If a scorecard has been added to a DHIS2 dashboard, it can also be accessed directly from there for further analysis. Below is step guides to access the scorecard directly from the dashboard:-
+- Open the dashboard containing the configured scorecard.
+- Locate the scorecard card and click the **`More Options`** button.
+- Select **`Open In Scorecard`** to open the specific scorecard in the Scorecard App for further exploration.
 
-## Selecting a Scorecard
-- Once the app is open, you will see a list of available scorecards.
-- You can:
-  - **Browse the list** directly.
-  - **Search by name** using the search bar at the top.
-  - **Navigate pages** using arrows at the bottom of the list.
-- Layouts:
-  - Switch between **horizontal** and **vertical** listing layouts for easier browsing.
+![access scorecard from dashboard](/img/scorecard/access-scorecard-from-dashboard.png)
 
----
+> **Tip**: Access via the dashboard is useful for program managers and decision makers who rely on dashboards for routine monitoring but may want deeper analysis within the Scorecard App.

docs/scorecard/navigation/display-and-export-options.md

@@ -3,16 +3,50 @@ sidebar_position: 4
 ---
 
 # Display & Export Options
+The Scorecard application provides several display and export options that allow users to customize how scorecard data is viewed, analyzed, and shared. These features enhance flexibility by enabling temporary adjustments to the scorecard layout and by supporting export to multiple formats for external use.
 
-## tips
-- **Display controls**:
-  - Show/hide scorecard title, legend, or item numbers.
-  - Display or hide empty rows.
-  - Display averages (rows/columns).
-  - Show arrows indicating performance trends.
-  - Highlight specific indicators of interest.
-- **Export options**:
-  - Download scorecards as **Excel, PDF, CSV**.
-  - Export metadata as **JSON or CSV** for integration with other tools.
-- **Refresh**:
-  - Click the refresh icon to reload the scorecard with the latest analysis results.
+## Accessing Scorecard options
+Scorecards include a range of options to modify the default display setup, giving users flexibility in tailoring the layout, visibility, and analysis approach. These options allow adjustments beyond the initial configuration defined during setup. Below are scorecard option, that can be adjusted:-
+### Available Display Options
+#### Visibility Options
+- **Legend**: Displays the legend in the scorecard header when selected.
+- **Title**: Shows the scorecard title in the header for clear identification.
+- **Item Number**: Adds row numbers to the scorecard for easier reference.
+- **Empty Rows**: Ensures empty rows are displayed, helping to identify missing data.
+- **Show Hierarchy**: Displays the full organisational unit hierarchy if needed.
+- **Average Column**: Adds a column that shows the average value across selected organisational units.
+- **Average Row**: Adds a row that shows the average value across all indicators.
+- **Highlighted Indicators**: Displays the highlighted indicators section when enabled.
+
+#### Filter by Averages
+- **All**: Displays all available data without filtering.
+- **Below Average**: Shows only data points whose column average fall below the overall average.
+- **Above Average**: Shows only data points whose column average perform above the overall average.
+
+#### Data Display Options
+- **Arrows**: Displays trend arrows within data cells, showing whether values are increasing or decreasing as compare value with pervious period and **effective gap** set on specific indicator/data source.
+- **Show Data in Rows**: Switches the default table layout so that indicators appear in rows and organisational units appear in columns, offering an alternative perspective for analysis.
+
+### Applying Display Options
+- To access, click the **`Options`** button to open the scorecard option panel  for adjustment.
+- Adjust the preferred options, then click the **`Update`** button to apply changes.
+
+![access scorecard options](/img/scorecard/access-scorecard-options.png)
+
+> **Note:** These modifications are temporary and will be reset when the scorecard is refreshed or reopened.
+>
+
+
+
+
+## Export Scorecard
+In addition to in-app viewing, scorecards can be exported into different formats for reporting, presentations, or further analysis. Export options make it easy to share insights across teams or systems.
+### Supported Export Formats
+- **CSV / Excel**: Export raw scorecard data for use in spreadsheets or external data analysis tools.
+- **PDF**: Generate a formatted printable PDF for reports and presentations.
+- **Export to ALMA**: Export scorecard data and metadata for integration with the ALMA repository.
+### Steps to Export
+- Click the **`Download`** button to access the panel with options to exports.
+- Select the preferred format (CSV, Excel, PDF, or ALMA for data or metadta of ALMA) and confirm the download or printing.
+
+![access scorecard export options](/img/scorecard/access-scorecard-export-options.png)

docs/scorecard/navigation/index.md

@@ -3,8 +3,7 @@ sidebar_position: 6
 ---
 
 # Navigation
-The Scorecard App provides intuitive navigation and filtering tools that allow users to quickly find and analyze performance data.
 
--  summary of how access listing, navigations around scorecard
+## Navigating the Scorecard
 
----
+The Scorecard App offers simple and flexible navigation, enabling users to access scorecards directly from the DHIS2 app menu or from configured dashboards. Within the app, users can search, filter, and organize scorecards, switch between grid or list views, and perform key actions such as viewing, editing, or deleting based on permissions. These features ensure efficient access and management, supporting both routine monitoring and deeper analysis.