Health Check

Prev Next

PowerRoster Analytics – Health Check

PowerRoster Analytics provides a Health Check page to monitor system status, identify issues, and display important notifications. This tool helps organisations stay informed about detected issues and compliance alerts that may require action.

How Health Check Flags Work

  • Red: Indicates critical issues that require immediate attention.

  • Orange: Identifies potential service issues.

  • Green: Indicates the service is functioning normally with no issues requiring action.

How to View the Health Check Report in PowerRoster

To view the Health Check report within PowerRoster:

  1. Navigate to PowerRoster App > Settings > Select Health Check.

  2. The page displays all services, their current health status, and any incidents as shown below:

Field

Description

TenantID and OrgID

The Tenant ID and Org ID are displayed in the header and can be selected and copied as needed.

PowerRoster Licensing Status

Displays a list of subscription configuration records in the environment.

  • Red: Indicates an expired license.

  • Green: Indicates an active license.

  • Empty: No license exists.

PowerRoster Engine Status

Working Hours Calendar Engine – Monitors the execution of the flow "Rostering IP - 60sec Recurrence RPI Work Hours Calendar Allocation."

  • Green: Online and functioning correctly.

  • Amber: Online but encountered a failure in the last hour.

  • Red: Offline or experiencing an error.

RPI Generation Engine – Monitors the execution of the flow "Rostering IP - (Child) - RPI Generation Engine."

  • Green: Online and functioning correctly.

  • Amber: Online but encountered a failure in the last hour.

  • Red: Offline or experiencing an error.

Availability Engine – Tracks the flow "Rostering IP - Schedule - Leave Approval Behavior."

  • Green: Online and functioning correctly.

  • Amber: Online but encountered a failure in the last hour.

  • Red: Offline or experiencing an error.

PowerRoster Processes

Displays a list of active PowerRoster processes, providing an overview of system operations and their current statuses.

PowerRoster App Setting Status

Displays a list of the statuses for the app settings, providing an overview of their current configurations and operational state.

Open Environment Configuration Manager

A new screen has been added to the Health Checker page, allowing clients to select configuration options to install, repair, or upgrade PowerRoster in their environment. The Health Check page is accessible via the Settings area in the PowerRoster App. To view the new options, select Environment Configuration Manager.

Users can select multiple configuration options and click Run to proceed. The process may take a few minutes, depending on the selected options. Once completed, the user will be redirected to the Health Checker’s main page with a notification banner.

  • Update PowerWorker Licenses:

    The PowerRoster Licensing Status section automatically refreshes after running Update PowerWorker Licenses, eliminating the need to manually refresh the page.

  • Add Missing Default Global App Settings

    Generates missing App Settings in the environment using default values without affecting any existing records. To identify missing App Settings, refer to the App Settings section on the Health Checker page.

  • Override Existing Global App Settings with Default Values

    Reverts App Settings used by PowerRoster to their default values.

    Important

    This action is irreversible, so it is recommended to export current App Settings beforehand to preserve customisations.

    This process will not generate missing App Settings or affect any settings that are not used by PowerRoster.

    To identify App Settings that are not using default values, refer to the App Settings section on the Health Checker page.

  • Delete Deprecated or Unused Global App Settings

    Removes any App Settings that are not used by the current version of PowerRoster, including deprecated settings or those created for other purposes within the environment.

    Important

    This action is irreversible, so it is recommended to back up App Setting values beforehand to preserve customisations.

    To identify App Settings that are not being used by PowerRoster, refer to the App Settings section on the Health Checker page.

  • Apply Default Global Roster Settings

    Updates the Roster Setting where RecordId is set to ‘Global’. This setting is used by all rosters by default. PowerRoster can function with or without this record, but it is recommended if the client wants to configure default settings.

    Selecting this option will generate the missing Global Roster Setting or update the existing record with the latest changes.

    Important:

    • This action will override all configurations in the Roster Setting and cannot be undone.

    • It is recommended to save the current Roster Setting values before proceeding.

    • There is no automatic check to confirm if the Roster Setting needs updating, so manual comparison is required after running the update.

  • Setup Default Roster Periods for existing Rosters

    With the introduction of the new Roster Periods and Roster Statuses tables, Rosters no longer use the Status Reason field for locking rules or writing to the Work Hours Calendar. For more details, refer to the Roster Period feature.

    Since this functionality has been transitioned to Roster Periods, this option allows clients to assign a single Roster Period per Roster and set a Roster Status that aligns with the roster’s original Status Reason (e.g., Draft, Published, and Revised).

    • Running this option will not modify any existing data.

    • It will not retrigger any PowerRoster Engines.