Enhanced Staffing Dashboard

The Enhanced Staffing Dashboard integration generates, and then exports up to six weeks of staffing dashboard data to a CSV file.

Note: This integration is an extension that is developed outside the normal release schedule to meet specific customer needs; it must be installed by an Integration Consultant. To request one of these extensions, you must submit a request by way of the Gateway Request Portal for BITS, accompanied by a change order.

Managers analyze and adjust resource levels in the staffing dashboard for time periods such as yesterday, today, tomorrow, or a specific date.

The Enhanced Staffing Dashboard extension generates a file with location data that covers a wider time period than the staffing dashboard. This broader view allows more efficient analysis of how resource adjustments affect the budget. The manager adjusts the staffing board using the file’s schedule and workload metrics data, which includes:

  • Count of planned resources

  • Count of scheduled resources

  • Variance

  • Volume

Enhanced Staffing Dashboard concept

The administrator configures the integration's location type depending on the level in the organization at which staffing adjustments are made. For example, if staffing data is monitored and adjusted at the department level, then the location type is set to Department.

At the integration's runtime, a location query and time period, such as Current Schedule Period, are selected.

By default, all jobs under the location type are sent to the output file. However, the option to select only a few jobs is available.

All time spans and scheduled zones associated with the selected location are sent to the output file.

Considerations

  • The workload planner must be configured to view workload planner data, and be attached to a workload planner profile.

  • Because volume can differ for various spans, volume must be populated at the department and span level, and not at the job level.

  • All users of the Enhanced Staffing Dashboard must be assigned to a display profile that is configured with the workload planner profile.

Before you start

Before you configure this integration, you must do the following:

    1. Configure Access to Integrations.

    2. Configure the following:

    • Zone Categories: Configure a zone category that is assigned during the schedule zone set configuration. See the Define zone categories topic.

    • Schedule Zone Sets: Configure a schedule zone set that is used to measure coverage. See the Define zone categories topic.

    • Workload Shift Sets: Configure a workload shift set that defines the workload requirements for a specified location. See the Configure coverage by zone or shift set topic.

    • Workload Planner Profiles: Configure the workload planner profile that contains all workload planners which are visible to the manager. Add the workload planner from the available to the selected list. See the Configure Workload Planner Profiles topic.

    • Display Profiles: Configure the display profile that is assigned to those who use the workload planner. Select the appropriate workload planner profile. See the Display Profiles topic.

    1. Get the URL, User, and Password for the APIGatewayServer.

Configure the Enhanced Staffing Dashboard integration

  1. Deploy the Enhanced Staffing Dashboard integration
    Note: For more information, see the Deploy Integration Packs to your Atom topic.

    1. Open the Integration Template Designer: Select Main Menu Administration > Application Setup > Integrations Setup > Design Integration Templates.

      Note: If prompted, enter your Username and Password. Click Tap Log in.

    2. Make sure that the Account is correct. If not, select the right account.

    3. Select the Deploy tab > Integration Packs.
    4. From the list in the left column, search for and select the Pro WFM Enhanced Staffing Dashboard Extension integration.
      Note: If the integration does not display, select Browse Integration Packs to search for and select the iPack.

    5. Click Tap Install.

    6. From Unattached Environments, select the environment in which to deploy the integration process for the selected integration. Click Tap the double-left arrows button
      Select items
      .
  2. Configure the Enhanced Staffing Dashboard integration settings
    1. Select the environment
      1. Select the Manage tab > Atom Management.
      2. Select your environment.
    2. Select environment extensions
      1. In Administration, click tap Environment Extensions.
      2. In Process Filter, click tap the magnifying glass
        Search button
        . It can take several seconds before the button becomes active.
      3. Scroll to and select the integration pack: Enhanced Staffing Dashboard > EnhancedStaffingDashboard_iPack_v3.
  3. Configure connection settings
    Caution: If you select Use Default for the connection settings and process properties, ensure that Value is blank. If Value is not blank, that value overrides the default value whether or not Use Default is selected or cleared. Example: If the default value is abc, but Value shows xyz, the integration uses xyz regardless of the setting of Use Default.
    1. Select Connection Settings.

    2. From the Connection dropdown list, select and configure the following:

      Connection Settings

      Connection Settings for the Virtual Roster Employee Demographics Export integration

      Setting

      Required

      Actions

      EnhancedStaffingDashboard_iPack_v3_APIGatewayServer

      Required

      To change the default API gateway server:

      1. Clear Use Default.
      2. Enter the URL to the server.

        Example: <tenantURL>/api

      Use the format <tenantURL>/api.

      EnhancedStaffingDashboard_iPack_v3_SFTPServer

      Required

      The SFTP server setting defines the connection to the file that contains the records. Integrations access only the internal SFTP account.

      To change the default SFTP server parameters:

      1. For each field, clear Use Default.
      2. Enter the following values:

        • Enter the name of the internal Host.

        • Enter the number of the Port for the internal SFTP account.

        • In User, enter the username for the internal SFTP account.

        • In Password, select <Encrypted>. Enter the new password for the internal SFTP account.

        • Click Tap Apply.

      EnhancedStaffingDashboard_iPack_v3_Locale_CRT

      Required

      Enable Override.

  4. Configure process properties
    1. Select Process Properties.
      Caution: Do not edit the default values of the AuthenticationProperties. By default, cookies are enabled and set the values for authentication properties.

    2. Select EnhancedStaffingDashboard_iPack_v3 to set process properties that must be configured before the integration can run. This main process starts the integration process and handles errors.

      Process Properties

      Process Properties

      Property

      Required

      Actions

      EnhancedStaffingDashboard_iPack_v3_CRTConfig

      Required

      For EnhancedStaffingDashboard_iPack_v3_Locale_CRT:

      1. Clear Use Default.
      2. Enter Parameter Name, Locale Policy, Message, Description.

      EnhancedStaffingDashboard_iPack_v3_ControlProperties

      Required

      Update the extended parameters for EnhancedStaffingDashboard_iPack_v3_ControlProperties,

      To define the last node of the selected location:

      1. Clear Use Default.
      2. Enter the integration parameter details:
      • Name: _LastNodeName.
      • Default value: Job.

      To define the second to last node of the selected location:

      1. Clear Use Default.
      2. Enter the integration parameter details:
      • Name: _LastNodeBeforeJob.
      • Default value: Department.
  5. Configure cross-reference tables

    Cross-reference tables (CRT) are the look-up tables that the integrations use to translate parameter values. One or more data values from the source system can be used to assign one or more parameters in the destination system.

    • If more than one row matches a reference value, the first match is the output value.
    • If no match is found, the output value can be null, or the integration can produce errors.
    1. Select Cross Reference.
    2. From the Cross Reference dropdown list, select the EnhancedStaffingDashboard_iPack_v3_Locale_CRT table.
    3. Select Override, which allows you to:
      • Download the table when you run the integration.
      • Edit the table cells in Extensions.
    4. When you finish, click tap OK.

    EnhancedStaffingDashboard_iPack_v3_Locale_CRT: Allows translation of messages and labels into different languages.

    Enhanced Staffing Dashboard — Locale CRT structure

    Press Ganey NDNQI Report — Locale CRT structure

    Column header

    Description

    Parameter Name

    Parameters defined in EnhancedStaffingDashboard_iPack_v3_Locale_CRT process property.

    Locale Policy

    Locale Policy.

    You can use an asterisk ( *) as a wildcard, but put the less-restrictive locale policy names at the bottom of the table because the integration scans cross-reference tables from the top.

    Message

    Message shown in the Run Summary section or localized exceptions name.

    Example: Hyperfind or Location not provided.

    Description

    The description that is shown in Additional Details.

    Note:

    • Localization of integration extensions remains optional, but is supported.

    • The cross-reference table (CRT) holds all messages represented with standard English labels; these apply to all locales when the Locale is set to a wildcard (*).

    • Some or all messages can be translated by adding lines to the table in their preferred translation for specific locales. Messages for the most commonly used Locale Policy should be defined at the top of the CRT.

    • Names of the parameters in the CRT column "Parameter Name" must be used as is. If any parameter value needs to be localized for a different Locale Policy, copy the "Parameter Name" with the * Locale Policy, add a new row to the CRT with the appropriate Locale Policy, and then add the localized values in the Message (or Value) and Description CRT columns.

    • Do not enter values in the CRT column "Description" if it is blank.

    • Do not modify placeholders (<>) or the configurable values that are included in the CRT column "Message" (or "Value").

    Sample Locale CRT

    Sample Locale CRT

    Parameter Name

    Locale

    Policy

    Message

    Description

    Error_MaximumDuration

    *

    Selected Date Range or Symbolic Period exceeds the Maximum Duration limit.

    Selected Date Range exceeds the Maximum Duration parameter limit.

    Error_InvaildsymbolicPeriod

    *

    Selected Symbolic Period is invalid.

    The Symbolic Period selection is not allowed by the integration.

    Error_LocationType

    *

    Invalid Location Type.

    The Location Type parameter does not match a location in UKG Pro Workforce Management.

    Error_DateRangeInvalid

    *

    Invalid Date Range.

    The selected Date Range exceeds the Maximum Duration limit.

    Error_AppendTimestampToFileInvalid

    *

    AppendTimestampToFile is not correct.

    The Append Timestamp To File parameter configuration is not correct.

    Error_EmptyLocation

    *

    The selected location is empty or a Hyperfind was selected. The integration supports only Location queries.

    The selected Location is empty or a Hyperfind was selected. The integration supports only Location queries.

    Error_FileNameInvalid

    *

    Invalid FileName value.

    The File Name parameter configuration is not correct.

    Error_InvalidDateformat

    *

    Invalid DateFormat.

    The Date Format parameter configuration is not correct.

    Error_InvalidFractionSeparator

    *

    Invalid FractionSeparator.

    The Fraction Separator configuration is not correct.

    Error_LocationTypeEmpty

    *

    LocationType parameter must be configured.

    The Location Type parameter must contain a valid Location Type.

    Error_InvalidOrgLevel

    *

    The Location cannot be a Job level.

    The selected Location cannot be configured at the Job level.

    Label_FileHeaderDate

    *

    Date

    Date column label in the output file.

    Label_FileHeaderLocationType

    *

    Department

    Department column label in the output file.

    Label_FileHeaderJob

    *

    Job

    Job column label in the output

    file header.

    Label_FileHeaderPlanned

    *

    Planned

    Planned column label in the

    output file.

    Label_FileHeaderScheduled

    *

    Scheduled

    Scheduled column label in the

    output file.

    Label_FileHeaderScheduleTimeSpans

    *

    Time Span Name

    Time Span Name column label in the output file.

    Label_FileHeaderVariance

    *

    Variance

    Variance column label in the output file.

    Label_FileHeaderVolume

    *

    Volume

    Volume column label in the output file.

    Label_DisqualifiedJobs

    *

    Disqualified Jobs

    Disqualified Jobs count label.

    Label_DisqualifiedSpans

    *

    Disqualified Spans

    Disqualified Spans label

    Label_IntegrationTypeName

    *

    Integration Type

    Import or export Integration Type Name label.

    Label_IntegrationTypeValue

    *

    Export

    Import or export Integration Type label.

    Label_ExportedJobs

    *

    Exported Jobs

    Exported Jobs count label.

    Label_ProcessedJobs

    *

    Processed Jobs

    Processed Jobs count label.

    Label_IntegrationStatusSuccessMessage

    *

    Integration completed without errors

    Message that displays success when integration completes without error.

    Label_IntegrationStatusSuccessWithDisqualify

    *

    Integration completed without errors, but certain records are disqualified. Click additional details for more info.

    Message that displays when integration completes with partial success.

    Label_IntegrationExecutionId

    *

    Integration Execution ID

    Integration Execution ID used in process reporting.

    Message_LocationTypeUnavailable

    *

    LocationType is unavailable from the selected Location.

    The Location Type parameter is not available in the selected Location.

    Message_TimeSpanInvalid

    *

    Schedule time spans are disqualified or are not available in selected location.

    Specific Time spans have been disqualified or the time span is not available in the selected location.

    Message_LocationTypeInvalid

    *

    LocationType is invalid.

    Location Type does not match a configured value in UKG Pro Workforce Management.

    Message_LocationInvalid

    *

    Selected Location is disqualified - a Time Span must be assigned.

    Time Span is not assigned to the selected Location.

Install the Enhanced Staffing Dashboard integration

After the integrations are deployed and the connection settings and process properties are configured, install the integrations to make them available for running or scheduling.

Note:

  • An integration template is the configured integration that you deploy to an Atom and then install to make available for running or scheduling.

  • An installed integration is a single instance of an integration that is based on an integration template. When you install an integration, you can define parameters or set parameters to be defined when the integration is run.
  1. Select Main Menu Administration > Application Setup > Integrations Setup > Install Integrations.
  2. Click Tap Create .
  3. In Integration Name, enter a unique name, such as EnhancedStaffingDashboard_iPack_v3.
  4. (Optional) Enter a Description.
    Note: Do not select API Integration.
  5. In File Access, select None to not select a connection.
  6. (Optional) If the person who runs the integration does not have full access to integrations, select Execute Integration with System Account. This allows the integration access to all APIs in the FAP, and the relevant permissions and data, regardless of the FAP and GDAP of the person who runs the integration.

  7. (Optional) Select Re-Run to allow repeated runs of the integration with the same parameter values as the previous run.

  8. Email Notifications

    (Optional)

    1. Select Yes to send email and control center notifications for integration runs.
    2. Enter the email addresses of the recipients for the following types of run status. For multiple recipients, separate the addresses by a comma, but no spaces:

      In Progress — The integration run started and has not finished.

      Completed — The integration ran successfully without errors.

      Failed — The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set, the integration set stops.

      Completed with Errors — The integration run has errors or could not run.

  9. In Skip Configuration, select None(default) to allow multiple integrations to run at the same time or with the same data without restrictions.
    Note: Do not select Allow Minute Interval.

  10. Integration template and parameters

    1. In Integration Template, select EnhancedStaffingDashboard_iPack_v3.

    2. Click Tap Assign .

    3. In Integration Parameters, you can override default settings. Click Tap Create.

    4. Complete the configuration for each parameter value.

    5. Click Save.

      Repeat this step for each integration parameter that supports the Enhanced Staffing Dashboard process.

      Enhanced Staffing Dashboard — Integration parameters

      Enhanced Staffing Dashboard - Integration parameters

      Parameter name

      Description

      Parameter type

      User prompt

      Location

      Location query for which the integration will run. Default = All Home Locations
      Caution: Only location queries are supported; Hyperfind queries are not supported.

      Hyperfind

      Yes

      LocationType

      Business structure node representing the level at which the staffing dashboard shows data. Default = Department

      Text

      No

      FractionSeparator

      Delimiter value.

      Supported values include:

      • .(period) (default)

      • ,(comma)

      Text

      No

      TimePeriod

      The date range, or symbolic period for which the integration will run. Default = Current_SchedPeriod

      Caution:

      Unsupported values include:

      • Current, previous, and next pay period

      • Last 90 days

      • Last 3 months

      • Last 4 quarters

      • Same week last year

      Time Period

      Yes

      MaximumDuration(days)

      The maximum duration of days that the integration supports. Default = 42
      Caution: The value must not exceed 42.

      Number

      No

      ScheduleTimeSpans

      Name of the scheduled time span to be included in the output file.

      If left blank, all related scheduled time spans will be included.

      Text

      No

      OutputDirectory

      SFTP directory path to which the dashboard data file is exported. Default = /Outbound

      Text

      No

      FileName

      Output file name. Default = StaffingDashboardDetails

      Text

      No

      SFTPAction

      SFTP Action to perform when files with the same name exist in the remote directory.

      Supported case-sensitive values include:

      • Create New Name(default)

      • Append

      • Overwrite

      • Error

      Text

      No

      AppendTimestampToFile

      Format of timestamp appended to the generated file name.

      Supported values include:

      • yyyy-MM-dd'T'hhmmSSS(default)

      • dd-MM-yyyyThhmmSSS

      • MM-dd-yyyyThhmmSSS

      Text

      No

      DateFormat

      Date format used in the generated file.

      Supported values include:

      • MM/dd/yyyy

      • MM-dd-yyyy

      • dd-MM-yyyy(default)

      • dd/MM/yyyy

      • yyyy-MM-dd

      • yyyy/MM/dd

      Time

      No

      JobColumnText

      List of jobs for the selected Location. One or more jobs can be selected. Default = All

      Text

      No

      PopulateSubtotals

      Determines whether to populate the generated file with totalized values for Planned, Scheduled, and Variance hours.

      Default = No

      Boolean

      No

  11. Ensure that the generic data access profiles (GDAP) allow access to the Enhanced Staffing Dashboard integration for the people who need to run the installed integrations. See Configure Access to Integrations .

Run and test the Enhanced Staffing Dashboard integration

Run integrations to test that the configuration is set up correctly.

  1. Run the integration
    1. Select the integration:
      1. Select Main Menu Maintenance > Integrations.
      2. Click Tap Run an Integration .
      3. Select the EnhancedStaffingDashboard_iPack_v3 integration from the list. Click Tap Select.
      4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the system assigns a default name, which ends with a date and time stamp.
    2. Set parameters as follows:
      • Location: Select the location.
      • TimePeriod: Select a symbolic time frame or enter a date range.
    3. Select the following:
      • Run Integration : If this is the first time this integration is being run.
      • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter values again. Click Tap Yes to continue, or No to not run the integration and to return to the parameter settings.
    4. Wait for the confirmation that the integration completed or failed. Close the panel.
    5. Click Tap Refresh .
    6. To see details, select the integration run. Select Run Summary.
  2. Check the results

    Status indicators

    • In-Progress: The run of this integration has not yet completed.
    • Completed: The integration ran successfully without errors.
    • Scheduled: This integration is scheduled to run later or repeatedly.
    • (Grayed out) Scheduled but Deleted: This integration is scheduled to run, but the integration template has been deleted. When it runs, it will generate an error. To prevent this error, delete the scheduled integration run.
    • Completed with Errors: The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set, the integration set stops.
    • Failed: The integration run has errors or could not run.
    • To troubleshoot and resolve errors, do the following:

      Check the Run Summary for details.

      • To troubleshoot all types of errors, or if the Run Summary shows a large number of errors, click tap Go to Additional Details (if available), or click tap the Source File to open and examine the input source file.
      • (Only for import integrations) To troubleshoot and resubmit integrations that have transactional or data errors, click tap Go to Transaction Assistant.

    To check the results in more detail:

    1. Click Tap the tile for the integration run.
    2. Click Tap Run Summary to see the results of the integration run.

      Example Run Summary details

      Note: The available details vary by integration and configuration.
      • Integration Run Name: Name of this run of the integration.
      • Process Name: Name of any integration set that includes this integration.
      • Integration Name: Name of the installed integration.
      • Integration Reference ID: Unique identifier for this integration run (to help in troubleshooting errors).
      • User: The person or user account that ran the integration.
      • Integration Type: Import, Export, or None
      • Start Date: Date and time when the integration run started.
      • End Date: Date and time when the integration run finished.
      • Status: In-Progress, Completed, Completed with Errors, or Failed.
      • Records Processed: Number of records that were processed.
      • Records Created: Number of records that were created.
      • Errors: Number of records that failed.
      • Source Files, Output File, and Error Files: For file-based import integrations, use Manage SFTP to access the source and output files on the inbound (source) and outbound (destination) SFTP folders. See the Manage SFTP topic.
    3. Log in to the destination system and ensure that the data has been correctly updated.
    Note: You can schedule integrations and integration sets to run once later or at a recurring frequency. See the Schedule Integrations topic.

Target file properties

  • File name: StaffingDashboardDetails
  • File extension: .csv
  • Format: Comma delimited
  • Frequency: On-demand or scheduled
  • Header row: Yes
  • Footer row: No
  • Output folder: /Outbound

Target file layout

Output file layout for the Enhanced Staffing Dashboard

Field

Description

Date

The user-selected Symbolic Period or Date Range.

Department

A dynamic column that contains the Location Type.

Job

The job assigned to the user-selected Location Type.

Time Span Name

The time span of the associated data.

Planned

Planned count that displays in the Workload Planner.

Scheduled

Scheduled count that displays in the Schedule Planner.

Variance

The difference between Scheduled and Planned (Scheduled count - Planned count).

Volume

Volume data that displays in the Workload Planner

APIs

API details

APIs for the Enhanced Staffing Dashboard integration

API name

Type

Resource path

Description

Update Integration Execution Details

POST

/v1/platform/integrations/update_status

Updates integration status details.

Submit Integration Execution Additional Details

POST

/v1/platform/integration_executions/{id}/additional_details

Submits all additional details related to an integration execution (API or batch) into the system.

Retrieve Data Element Definitions by Keys

POST

/v1/commons/data_dictionary/data_elements/multi_read

Retrieves location type ID.

Retrieve Locale Date Span

POST

/v1/commons/symbolicperiod/read

Retrieves the symbolic period.

Retrieve Locations

POST

/v1/commons/locations/multi_read

Retrieves location descendants.

Retrieve Data

POST

/v1/commons/data/multi_read

Retrieve workload planner data using Retrieve Data.

Retrieve Symbolic Periods

GET

/v1/commons/symbolicperiod

Retrieves all symbolic periods in the system.

Execute Hyperfind Query

POST

/v1/commons/hyperfind/execute

Executes a Hyperfind query by ID or qualifier and returns the result.

Retrieve User Preferences for Current User

GET

/v1/commons/user_preferences/locale_policy

Retrieves user preferences for the current user.

Retrieve Location by Path

GET

/v1/commons/locations

Retrieves Organizational Map location information by location (node) path and date.

Version history

Version history - Integration

Version

Description

1

Initial release. This integration generates, and then exports up to six weeks of staffing dashboard data to a CSV file.

2

Enhancements:

  • Implements schedule shift.

  • Supports multiple locations, including all org levels.

  • Format change such that report filtering is based on: Date, Location Type, Zone and Shift.

  • Output file improvement that populates volume at the department and span level instead of the job level.

iPack_v3

The Enhanced Staffing Dashboard integration delivery is now by way of an iPack.