SLA Report Menu

The SLA (Service Level Agreement) Report in Joget provides comprehensive insights into the performance of processes where SLAs are implemented. This feature helps monitor and analyze process efficiency based on predefined service-level metrics.

Prerequisite

Before generating an SLA report, ensure that the Process Data Collector for each Joget app where SLA reporting is intended is enabled. This step is essential for gathering the necessary data.

For detailed instructions, see Enabling Data Collection for SLA Implementation documentation.

Configure SLA report

To configure SLA Report properties, in UI Builder, drag and drop the SLA Report element onto the canvas and click on it.

When adding SLA Report, you will see the following fields available for configuration:

  • Label: This is the menu label displayed for the Manage Permission Menu. It's a mandatory field, and you can add Font Awesome Icons to your menu labels.
  • Menu ID: Item link slug. Optional field.
    Unique field
    Ensure that the value defined here is unique to other UI menus in the app since the first matching/conflicting ID will take precedence in page loading.
  • Process: Limit SLA results to a specific process within the current app.
  • Show only processes & activities have SLA set?: Check to limit report results to processes and activities with configured SLAs.

UI

The UI settings for the SLA Report Menu allow you to customize the report interface's appearance and layout. You can add custom HTML content to the header and footer, enhancing the report's presentation and functionality. These settings help create a user-friendly and visually appealing interface for viewing SLA metrics.

Fileds to configure:

  • Custom Header: Add custom HTML content for the header.
  • Custom Footer: Include custom HTML content for the footer.

SLA Report Runtime View

The SLA Report menu offers two primary views:

  • First Level: Overview of all process SLAs.
  • Second Level: Detailed view of activities under selected processes (accessed by clicking process names from the first level).

If there are incomplete activities/tasks, the Max Delay timer updates based on the current time until all activities are completed.

Guide to SLA Display Columns

Understand the metrics displayed in the SLA Report:

  • Min Delay (Seconds): Shortest delay among all activities per process.
  • Max Delay (Seconds): Longest delay among all activities per process, updated until all activities are completed.
  • Ratio On Time (%): Percentage of activities completed on time or no delays divided by total activities.
  • Ratio With Delay (%): Percentage count of activities delayed divided by total activities.
  • Service Level Monitor: Ratio On Time vs Service Level indicator configured in General Settings fields Medium Warning Level and Critical Warning Level. If the Ratio On Time is less than the Medium Warning Level, it will change color to yellow. If the Ratio On Time is less than the Critical Warning Level, it will change color to red.

Performance & offline

The Performance & Offline settings for the SLA Report Menu are designed to optimize the performance of the SLA reporting feature and enable offline support. Configuring cache settings can improve load times and ensure the SLA report is accessible even in environments with limited connectivity. 

Cache settings

The Cache Settings in the SLA Report Menu help manage how content is cached to improve performance.

Fields to Configure:

  • Scope:
    Options include are: 
    • None: No caching.
    • Application: Cache content by application where all users will see the same content.
    • User: Cache by username.
  • Duration (s): Duration in seconds to cache content defaults to 20 seconds if applicable.

For more information, see Performance Improvement with UI Caching.

PWA offline settings

The PWA Offline Settings in the SLA Report Menu enable offline support by caching content for mobile browsers. This ensures that users can continue accessing and interacting with the SLA report without an active internet connection. Configuring these settings enhances the user experience by providing uninterrupted access to SLA metrics, especially for mobile users.

Fields to Configure:

  • Enable cache for offline support: Check to enable caching for offline support, which is generally used for mobile browsers.
  • Cache all List links in the first page: Enable caching for any List links present on the first page of the UI menu.

See Progressive Web Application (PWA) documentation for more details.

Additional resource

For more information on SLA reports, see the Process Deadlines, Exceptions and SLAs.

Created by Julieth Last modified by Aadrian on Dec 13, 2024