Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 20 additions & 12 deletions docs/scorecard/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,24 @@ 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:-
- Log in to your DHIS2 instance with an account that has App Management authority.
- Go to **Apps** → **App Management**.
- Open **`App Management`** from app menu.

![access app management app](/img/scorecard/access-app-management-app.png)

- 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.
- Search for **`Scorecard`**, and select the SScorecard app from the results (publisher: *HISP Tanzania*).
- Select the latest compatible version for your DHIS2 instance or previous versions if needed.
- Click Install and wait for the process to complete.

![search-scorecard-app-on-app-hub](/img/scorecard/search-scorecard-app-on-app-hub.png)

- Click **`Install`** and wait for the process to complete.

![install scorecard app from app hub](/img/scorecard/install-scorecard-app-from-app-hub.png)
- 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)

>**Important**
> - If the app does not appear after installation, clear your browser cache and refresh.
> - Always install the latest stable version to benefit from new features and bug fixes.
Expand All @@ -33,19 +38,22 @@ 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
- 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).
- Download the Scorecard App .zip package from [DHIS2 App Hub](https://apps.dhis2.org/?page=1&query=scorecard) ***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**.
- Open **`App Management`** from app menu.

![access app management app](/img/scorecard/access-app-management-app.png)

- 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.

![manual installation of scorecard from file](/img/scorecard/manual-installation-of-scorecard-from-file.png)

- 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)

## Best Practices
## Upgrading to a newer version
- Always clear your browser cache to prevent conflicts between old cached files and the new version.
Expand All @@ -57,7 +65,7 @@ This option is useful if your DHIS2 instance does not have internet access or if
- Verify that the Scorecard App version matches your DHIS2 instance version (e.g., v2.40+).
- Using an incompatible app version may lead to errors or missing features.
## Security considerations:
- Always download apps from trusted sources ([DHIS2 App Hub](https://apps.dhis2.org/) ***or*** [GitHub Release Page](https://github.com/hisptz/scorecard-app/releases)).
- Always download apps from trusted sources ([DHIS2 App Hub](https://apps.dhis2.org/?page=1&query=scorecard) ***or*** [GitHub Release Page](https://github.com/hisptz/scorecard-app/releases)).
- Avoid installing unverified packages to reduce risks of instability.
## Post-installation setup:
- Configure scorecard domains, indicators, and thresholds in collaboration with program teams.
Expand Down
85 changes: 39 additions & 46 deletions docs/scorecard/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,54 +5,47 @@ sidebar_position: 10

# Troubleshooting

Common issues and solutions when using the Scorecard App:
This section provides guidance on resolving common issues that may occur when using the **Scorecard Application**. Each issue includes its likely cause and recommended solution.

---

## Scorecard Not Loading
- **Cause**: Cached files conflict after an update.
- **Fix**: Clear browser cache and refresh DHIS2.

---
## Scorecard Fails to Load
**Possible Cause:** Browser cache may contain outdated or conflicting files after a system update.
**Recommended Solution:**
- Clear your browser cache and cookies.
- Refresh and attempt to reopen the Scorecard Application.

## Scorecard Not Found
- **Cause**: Invalid scorecard ID entered in the browser URL.
- **Fix**: Open the scorecard directly from the Scorecard App menu.

---
**Possible Cause:** The scorecard ID entered in the browser’s URL is invalid or has been deleted.
**Recommended Solution:**
- Access the Scorecard directly from the **Scorecard Application** instead of using a bookmarked link.
- Confirm that the scorecard still exists and you have the required permissions to access it.

## Access Denied
- **Cause**: User lacks appropriate permissions.
- **Fix**: Update user roles and sharing settings in DHIS2.

---

## Data Missing
- **Cause**: Filters applied incorrectly, or indicator metadata is incomplete.
- **Fix**: Reset filters, verify indicator configuration in Indicator Maintenance App.

---

## Slow Performance
- **Cause**: Too many organisation units or indicators selected at once.
- **Fix**: Reduce selection size or break down scorecards into smaller sets.

---

## General Errors
- **Cause**: Network issues or technical glitches.
- **Fix**:
- Refresh app or browser (CTRL + R).
- Check system logs using “View Logs”.
- If persistent, report to DHIS2 administrator.

## Error Management
- **Access denied error**:
- Occurs when a user lacks permission.
- Fix by updating sharing settings.
- **Scorecard not found**:
- Happens when a wrong ID is used in the URL.
- Verify by selecting the scorecard directly from the app menu.
- **General errors**:
- Often caused by network issues.
- Refresh the page or clear the browser cache.
**Possible Cause:** The user account does not have sufficient permissions to access or manage the selected scorecard.
**Recommended Solution:**
- Verify that the correct **user roles** are assigned in the **User Management App**.
- Review or update the **sharing settings** of the scorecard to grant the necessary access level (view, edit, or delete).

## Data Not Displaying
**Possible Cause:** Incorrect filters have been applied, or related metadata (such as indicators or data elements) is incomplete or misconfigured.
**Recommended Solution:**
- Reset all applied filters within the Scorecard App.
- Review the configuration of indicators and data elements in the **Maintenance App** to ensure completeness and accuracy.

## Slow or Delayed Performance
**Possible Cause:** The scorecard is configured with a large number of organisation units or indicators, which can slow down data retrieval and rendering.
**Recommended Solution:**
- Limit the number of selected organisation units and indicators/data items.
- Consider dividing large scorecards into smaller, focused scorecards for better performance.

## General Errors and System Glitches
**Possible Cause:** Temporary network issues or browser-related inconsistencies.
**Recommended Solution:**
- Refresh the app or browser window (**Ctrl + R**).
- If the issue persists, contact your **DHIS2 system administrator** for technical assistance.

## Error Management Summary
| Error Type | Description | Recommended Action |
|-------------|-------------|--------------------|
| **Access Denied** | Occurs when a user lacks the appropriate permissions. | Review and update sharing settings or user roles. |
| **Scorecard Not Found** | Triggered when an invalid or outdated scorecard ID is used. | Access the scorecard via the application’s main interface. |
| **General Errors** | Often linked to temporary network or browser issues. | Refresh the page or clear cache and try again. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed static/img/scorecard/scorecard-sample-img.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.