Multi-week Workload Pattern

This extension provides organizations with a mechanism to roll-out a Multi-week Workload Pattern.

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.

Certain organizations have predictable workloads that span a 2- or 4-week period. For these organizations, this extension leverages the staffing matrix to define and roll-out a multi-week workload pattern.

The volume parameter of the staffing matrix is used to indicate the weeks for which the workload is prepared. For each location, the staffing matrix contains the required headcount relative to the weeks in the pattern.

After the user launches the integration and selects the location, start and end dates, the pattern is rolled-out to the workload planner.

In the event that partial weeks are selected in the date range, the roll-out is performed according to the days in the matrix and workload planner.

Multiple locations can be selected during the roll-out, provided that a staffing matrix is established for each one.

Considerations and limitations

  • Only one active staffing matrix and workload pattern must be present for the location for which the roll-out is performed. If multiple active staffing matrices are defined for the same location, the integration only process the latest active matrix.

  • When configuring the staffing matrix and workload pattern, all jobs in the location must be selected even though a workload might not be assigned to every job.

  • If a workload plan already exists, the extension overwrites the Plan and Budget columns. The Actual column value, however, is not overwritten and must be corrected manually.

  • The staffing matrix volume range must be configured sequentially. Gaps are not allowed.

Boomi extension setup

Caution: Allow only qualified personnel who have training in the Boomi™ application to configure or create integrations.
Important: Professional Services will complete Boomi extension setup steps and deploy the integration.
  1. Get the URL, User, and Password for the APIGatewayServer.
  2. Install and attach the iPack.
    Note: For more information, see the Deploy Integration Packs to your Atom topic.
    1. Open the Integration Template Designer: Select Main Menu > Administration > Time 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 Multiweek Workload Pattern 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 .
  3. Configure the Multiweek Workload Pattern Extension 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 . It can take several seconds before the button becomes active.
      3. Scroll to and select the integration pack: Multiweek Workload Pattern > MultiweekWorkloadPattern_iPack_v2.
  4. 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

      Setting

      Required

      Actions

      MultiweekWorkloadPattern_iPack_v2_APIGatewayServer

      Required

      To change the default API gateway server:

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

        Example: <tenantURL>/api

      MultiweekWorkloadPattern_iPack_v2_Locale_CRT

      Required

      Enable Override.

  5. 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 MultiweekWorkloadPattern_iPack_v2 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 property name

      Column header value

      _MultiweekWorkloadPattern_iPack_v2_Locale_CRT

      Parameter Name, Locale Policy, Value, Description

Configure the Multi Week Workload Pattern integration

After the integration is deployed, complete the following configurations before you utilize this integration.

Note: Configuration examples are intended for illustration purposes only, and do not necessarily represent the needs of your organization. We recommend that you analyze your organization's needs before completing application setup configuration.

Application setup

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

  1. Configure Access to Integrations.
  2. Configure the following:
    • Accrual profiles: Configure accrual codes, policies, and profiles as follows:
      1. Create an accrual code: Enter a Name, set the Accrual Type to Days, and enter the number hours that constitute a day in hh:mm format. See the Accrual codes topic.
      2. Link the accrual code to an accrual policy, do not configure the grant. See the Accrual policies topic.
      3. Assign the accrual policy to an accrual profile, then to the employees by one of the following methods:
        • Select Main Menu Administration > Time application setup > Accruals — See the Accrual profiles topic.
        • Select Main Menu Administration > Time application setup > Employment Terms > Employment Terms — See the Employment Terms topic.
    • Combined paycode: Create four combined paycodes to define whether to consider time as worked or excluded. Summarize the combined paycodes into days and hours, and then configure each as Visible in Report Options and Report Totals and Visible on Totals tab in Timecard. See the Combined Paycodes topic.

      Examples include:

      • FI-Worked Hours: Includes Regular, Overtime, and so on.

      • FI-Worked Days: Includes Training Day, and so on.

      • FI-Excluded Hours: Includes Sickness, Family Emergency, and so on.

      • FI-Excluded Days: Includes Vacation Day, Personal Day, and so on.

    • Hyperfind: Configure a public Hyperfind query, such as AbsenceAveraging, for the employees who are subject to monthly vacation grants. See the Hyperfind Queries topic.
    • (Optional) Paycode: Configure a paycode to indicate grants on the Timecard on the day when the accrual grant is given. See the Paycode definition topic.
    • (Optional) Comment: Configure a comment that the integration attaches to the paycode in the Timecard. The paycodes category must be selected during configuration. See the Comments topic.
    • (Optional) Note: Configure notes for the comments of the paycode to specify extra details. Example: Excluded Days until last month: <value of excluded days>.
    • Extension table: Create an extension table using the DDL specified in the integration template. See the Extension Tables topic.

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.

To make a cross-reference table available for integration processes, populate the table with data.

Note:
  • 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.
Caution:

  • Values entered in the CRTs are case-sensitive, and must match values configured in the application, where appropriate. Comma entries are not supported.

  • Wildcards configured in the CRTs must be defined at the bottom of the table.

MonthlyVacationGrants_iPack_v2_VacationGrant_CRT: Stores configuration parameters of the different accrual profiles.

Monthly Vacation Grants — Vacation Grant CRT structure

Column name

Description

Accrual Profile

The accrual profile that is assigned to the employees.

Accrual Code

The accrual code that is used to calculate the grant.

Seniority Level

The setting whether to define grants based on Hire Date or Seniority Date.

Seniority Period (months)

The period of the seniority in months.

Time Of Grant

The time in the month when the grant is given; must be a decimal value.

Example: For 35 hours and 30 minutes, enter 30.5, not 30:30.

Time Of Grant Unit (days/hours)

The unit of the threshold for the time of the grant, based on the number of worked days or hours.

Sickness Rule (in days)

The maximum number of sick days that can be assimilated as worked days over an accrual year.

Grant Amount

The vacation grant that is credited to the employee.

Install the Multi-week Workload Pattern 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 > Time application setup > Integrations Setup > Install Integrations.
  2. Click Tap Create .
  3. In Integration Name enter a unique name, such as MultiweekWorkloadPattern_iPack_v2.
  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 MultiweekWorkloadPattern_iPack_v2.
    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 Multi-week Workload Pattern process.

      Integration parameters

      Parameter name

      Description / User prompt / Mandatory

      Template parameter

      Parameter type

      Locations

      The default Location for which the integration is run.

      Default = 1(All Home Locations)

      User prompt = Yes

      Mandatory = Yes

      Location

      Hyperfind

      StartDate

      Start date of the workload load pattern.

      User prompt = Yes

      Mandatory = Yes

      Supported values include:

      • yyyy-MM-dd(default)

      • yyyy/MM/dd

      • MM/dd/yyyy

      • MM-dd-yyyy

      • dd-MM-yyyy

      • dd/MM/yyyy

      StartDate

      Date

      EndDate

      End date of the workload load pattern.

      User prompt = Yes

      Mandatory = Yes

      Supported values include:

      • yyyy-MM-dd(default)

      • yyyy/MM/dd

      • MM/dd/yyyy

      • MM-dd-yyyy

      • dd-MM-yyyy

      • dd/MM/yyyy

      EndDate

      Date

  11. Ensure that the generic data access profiles (GDAP) allow access to the Multi-week Workload Pattern integration for the people who need to run the installed integrations.

    See Configure Access to Integrations .

Run and test the Multi-week Workload Pattern 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 MultiweekWorkloadPattern_iPack_v2 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:
      • Locations: Select a location query.
      • Start Date: Select a start date.
      • End Date: Select an end date.
    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

API name

Type

Resource path

Description

Retrieve User Preferences for Current User

GET

/v1/commons/user_preferences/locale_policy

Returns user preferences.

Retrieve Staffing Matrices

POST

/v1/scheduling/staffing_matrices/multi_read

Retrieves a collection of staffing matrices by object reference or location.

Retrieve Locations

GET

/v1/commons/locations/multi_read

Retrieves organizational map location (node) information by ID.

Bulk Create or Update Workload Patterns

POST

/v1/scheduling/workload_patterns/multi_upsert

Creates or updates workload patterns in bulk.

Version history

Version

Description

1

Initial release.

iPack_v2

The Multi-week Workload Pattern integration delivery is now by way of an iPack.