Schedule Post Audit Report

In regions where a posted schedule is considered final and cannot be altered, the Schedule Post Audit Report extension provides organizations with details that prove whether the original shift start and end times remain unchanged.

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.

This extension uses the last schedule post action as the anchor point to gather the posted schedule. It then captures differences that exist as of the audit date, and exports the data to a .CSV file for viewing with Excel™.

The objective of the Schedule Post Audit Report is to identify changes that disrupt the employee's work-life balance. Changes that impact the shift start or end times are captured in this audit report, and include actions such as:

  • Shift changes

  • Shift additions

  • Shift deletions

  • Paycode additions

Internal actions that are considered non-disruptive are excluded from the report. These include:

  • Job transfers

  • Labor category transfers

  • Cost center transfers

  • Work rule transfers

  • Changes to scheduled break segments

  • Comments and schedule tags added to shifts.

Reporting flexibility is offered by way of two versions:

  • Full Audit Report contains all days and shifts in the reporting period, regardless of whether shifts or shift changes exist.

  • Delta Audit Report contains only the days in the reporting period where a shift was altered.

The audit report captures paycodes that are considered disruptive when added to the posted schedule. Organizations control which paycode edits display on the report by adding them to a Paycode Display Profile (DAP). This DAP serves as a reference point by the integration, and must include only paycodes that need to be audited.

Considerations and limitations

  • The export file layout cannot be changed dynamically. It displays four organizational nodes, including the job node plus the three parent nodes above the job.

  • The integration expects that the same number of hierarchical levels in the business structure is applied across the organization. In cases where a ragged business structure hierarchy is configured, the audit report continues to display four nodes.

  • Only the employee's primary job is displayed.

  • Multiple shifts that fall on the same day are displayed on separate lines in the .CSV file. For example, a shift is deleted, a new shift is added, and then that shift is altered.

  • Date and time values that are exported to the report adhere to the locale policy assigned to the person who runs the integration.

  • Only .CSV format is supported for the report.

User experience

Run the Schedule Post Audit Report integration

After navigating to the integration, the user selects the report version, Hyperfind and time period for which a comma-separated (.CSV) file is then generated.

Before you start

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

  1. Configure Access to Integrations.

  2. Configure the following:

    • Paycodes: Create, or confirm the existence of hours, day, and money paycodes that will be included in the report. See the Paycode definition topic.

    • Paycode Data Access Profiles (DAP): Create a paycode DAP that controls which paycodes, including absence paycodes, are contained in the report. See the Paycode Data Access Profile topic.

      Example: Schedule Post Audit Report DAP

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

Configure the Schedule Post Audit Report integration

  1. Deploy the Schedule Post Audit Report 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 Schedule Post Audit Report 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 Schedule Post Audit Report 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: Schedule Post Audit Report > SchedulePostAuditReport_iPack_v1.
  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 list, select and configure the following:

      Connection Settings

      Connection Settings for the integration

      Setting

      Required

      Actions

      SchedulePostAuditReport_iPack_v1_APIGatewayServer

      Required

      To change the default API gateway server:

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

        Example: <tenantURL>/api

      SchedulePostAuditReport_iPack_v1_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:

      For each field, clear Use Default.

      1. Enter the following values:

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

      SchedulePostAuditReport_iPack_v1_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 SchedulePostAuditReport_iPack_v1 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

    Process property name

    Column header value

    _SchedulePostAuditReport_iPack_v1_Locale_CRT

    Parameter Name, Locale Policy, Value, Description

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

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

    Schedule Post Audit Report — Locale CRT structure

    Schedule Post Audit Report Locale CRT structure

    Column name

    Description

    Parameter Name

    Internal parameter; do not change.

    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.

    Value

    Message shown in Additional Details, or value of the label defined in the Run Summary section.

    Comment was not provided.

    Description

    The description that is shown in Additional Details.

    The employee is not assigned a shift.

    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 content

    Sample Locale CRT content

    Parameter Name

    Locale Policy

    Value

    Description

    Error_EmptyAppendTimestamp

    *

    Append timestamp is not configured.

    Error_EmptyBlankOrgJobNodeQualifier

    *

    Blank Org Job Node Qualifier is not configured.

    Error_EmptyOutputDirectory

    *

    Output Directory is not configured.

    Error_EmptyReportName

    *

    Report Name is not configured.

    Error_InvalidAppendTimestamp

    *

    Invalid Date/time format to append in the report name

    Error_InvalidBlankOrgJobNodeQualifier

    *

    Invalid Blank Org Job Node Qualifier

    Error_InvalidEmployeeMessage

    *

    Employee <EmployeeIds> does not exist in the system.

    Error_PayCodeAccessProfileEmpty

    *

    Paycode Access Profile is not configured.

    Error_PayCodeAccessProfileInvalid

    *

    Paycode Access Profile <PayCodeAccessProfile> is not configured in the system.

    Error_StartDateRangeInvalid

    *

    The date range cannot exceed 365 days.

    Error_EndDateRangeInvalid

    *

    The end date cannot exceed 6 weeks in the future.

    Label_Store

    *

    Store

    Label_Function

    *

    Function

    Label_Department

    *

    Department

    Label_Job

    *

    Job

    Label_EmployeeID

    *

    Employee ID

    Label_EmployeeName

    *

    Employee name

    Label_ShiftDate

    *

    Shift Date

    Label_PostedShift

    *

    Posted Shift

    Label_ChangedShift

    *

    Changed Shift

    Label_ChangedType

    *

    Changed Type

    Label_PayCode

    *

    Pay Code

    Label_EditDate

    *

    Edit Date

    Label_EditTime

    *

    Edit Time

    Label_User

    *

    User

    Label_UserID

    *

    User ID

    Label_ReportName

    *

    Report Name

    Label_ReportRunBy

    *

    Run By

    Label_ReportRunDateTime

    *

    Run Date

    Label_Reportperiod

    *

    Period

    Label_ReportQuery

    *

    Query

    Label_InvalidEmployee

    *

    Invalid Employee

    Label_EmployeeNumber

    *

    Employee Number

    Label_IntegrationTypeName

    *

    Integration Type

    Label_IntegrationTypeValue

    *

    Export

    Label_IntegrationExecutionId

    *

    Integration Execution ID

    Label_ProcessedEmployees

    *

    Processed Employees

    Label_ExportedEmployeesRecords

    *

    Exported Employees Records

    Label_ReportChangeTypeShiftAdded

    *

    Shift Added

    Label_ReportChangeTypeShiftChanged

    *

    Shift Changed

    Label_ReportChangeTypeShiftDeleted

    *

    Shift Deleted

    Label_ReportChangeTypePaycodeAdded

    *

    Paycode Added

    Message_CompletedWithoutError

    *

    Integration has completed without errors.

    Message_CompletedWithoutErrorADL

    *

    Integration has completed without errors. Additional details, such as disqualifications, may be accessible using the button below.

    Message_CompletedWithError

    *

    Completed with errors

    Message_CompletedWithErrorADL

    *

    Process completed with record level errors. Additional details, such as disqualifications, may be accessible using the button below.

    Custom tags available for use in messages and labels include: < EmployeeIds>, < PayCodeAccessProfile>.

Install the Schedule Post Audit Report 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 SchedulePostAuditReport_iPack_v1.
  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 SchedulePostAuditReport_iPack_v1.
    2. Click Tap Assign .
    3. In Integration Parameters, you can override default settings. Click Tap Create.
    4. Complete the configuration for each integration control parameter value.

    5. Click Tap Save.

      Repeat this step for each integration control parameter that supports the Schedule Post Audit Report process.

      Integration Parameters

      Integration Parameters

      Parameter name

      Description / User prompt / Mandatory

      Template parameter

      Parameter type

      Hyperfind or Locations

      The default Hyperfind or Location query that contains the employees for whom the integration is run.

      Default = All Home Locations

      User prompt = Yes

      Mandatory = Yes

      Note: Ad-hoc Hyperfinds are not supported. All Home does not include terminated and inactive employees even if they have totals during the period. To include these totals, configure a Hyperfind that includes terminated and inactive employees, and select that Hyperfind in this process property. The maximum number of employees in a Hyperfind is 3500. To process more employees, divide the population into smaller Hyperfinds to run sequentially.

      HyperfindorLocation(s)

      Hyperfind

      Employee IDs

      A comma-separated list of specific employees for whom the integration is run.

      When no value is entered, the integration defaults to the Hyperfind or Locations parameter.

      To process the integration for only a limited group of employees, enter the person numbers as defined in the source system, each separated by a comma (,) but not spaces.

      User prompt = Yes

      Mandatory = Yes

      EmployeeID(s)

      Text

      Symbolic Period

      The date range or symbolic time period for which the integration retrieves data.

      Supported values include:

      0= Previous pay period (default)

      1= Current pay period

      2= Next pay period

      3= Previous schedule period

      4= Current schedule period

      5= Next schedule period

      6= Week to date

      7= Last week

      8= Yesterday

      10= Range of relative dates

      11= Specific date

      12= Relative specific date

      13= Today

      User prompt = Yes

      Mandatory = Yes

      SymbolicPeriod

      Time Period

      Report Name

      The name of the report created by the integration.

      Default = SchedulePostAuditReport

      User prompt = No

      Mandatory = Yes

      ReportName

      Text

      Output Directory

      The SFTP output directory where the schedule post audit report is written.

      Default = /Outbound

      User prompt = No

      Mandatory = Yes

      OutputDirectory

      Text

      Report Type

      Default = Full Audit Report

      User prompt = No

      Mandatory = Yes

      ReportType

      Dropdown

      Append Timestamp

      Identifies the format that the integration follows when appending the date timestamp to the report name.

      Supported values include:

      yyyy-MM-dd'T'HH:mm:ss.SSS(default) yyyy-MM-dd HH:mm:ss.SSS yyyy-MM-dd'T'HH:mm:ss.SSS yyyy-MM-dd*HH:mm:ss yyyy-MM-dd*HH:mm:ss:SSS yy-MM-dd HH:mm:ss dd-MMM-yyyy HH:mm:ss dd MMM yyyy HH:mm:ss MM/dd/yyyy hh:mm:ss a MMM dd yyyy HH:mm:ss MMM dd HH:mm:ss

      User prompt = No

      Mandatory = Yes

      AppendTimestamp

      Text

      SFTP Action

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

      Default = Create New Name

      User prompt = No

      Mandatory = Yes

      SFTPAction

      Dropdown

      Blank Org Job Node Qualifier

      Identifies the value that is passed to the report when the business structure value is empty.

      Default = null

      User prompt = No

      Mandatory = Yes

      BlankOrgJobNodeQualifier

      Text

      Pay Code Access Profile

      The data access profile which contains the paycodes that are displayed in the audit report.

      Default = Schedule Post Audit Report DAP

      User prompt = No

      Mandatory = Yes

      PayCodeAccessProfile

      Text

    6. Ensure that the generic data access profiles (GDAP) allow access to the Schedule Post Audit Report integration for the people who need to run the installed integrations.

      See Configure Access to Integrations .

Run and test the Schedule Post Audit Report 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 SchedulePostAuditReport_iPack_v1 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:
      • Hyperfind or Location: Select a Hyperfind or Location query of employees.
      • Employee IDs: To process data for only a limited group of employees, enter the person numbers, as defined in the source system, each separated by a comma (,) but no spaces.

        For 3 employees: 13997,15556,20012

      • Symbolic Period: Select a symbolic period or 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.

APIs

API details

APIs for the integration

API name

Type

Resource path

Description

Execute Hyperfind Query

POST

/v1/commons/hyperfind/execute

Execute a Hyperfind query by ID or qualifier.

Retrieve Schedule Audits

POST

/v1/scheduling/audits/multi_read

Retrieve an audit set.

Retrieve Locations

POST

/v1/commons/locations/multi_read

Retrieve the location name and path by the location ID.

Retrieve Persons

POST

/v1/commons/persons/extensions/multi_read

Retrieve User Preferences for Current User

GET

/v1/commons/user_preferences/locale_policy

Return user preferences for the current user or tenant.

Retrieve Full Paycodes as Manager

GET

/v1/timekeeping/setup/paycodes

Returns a list of paycodes for the current manager.

Target file properties

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

Target file layout

Output file layout

Field

Description

Org Path

Employee ID

Person number in the application.

Employee Name

Full name.

Shift Date

Calendar date.

Posted Shift

Shift details at posting time.

Changed Shift

Shift details at audit time.

Change Type

Shift added, deleted, or changed, or paycode added.

Pay Code

Name + added paycode duration.

Edit Date

Edit Time

User

User ID

Version history

Version history

Version

Description

1

Initial release.

iPack_v1

The Schedule Post Audit Report integration delivery is now by way of an iPack.

A script error was generated by the Schedule Post Audit Report integration when it encountered a paycode edit that created an open shift.