Multi-week Workload Pattern

Configure Access to Integrations.

Staffing matrix: Configure a staffing matrix associated with each location for which the multi-week workload pattern applies. See the Staffing Matrix topic.

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

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

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.

1. Select Connection Settings.

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

   Connection Settings

   Connection Settings for the integration

   Setting	Required	Actions
   MultiweekWorkloadPattern_iPack_v2_APIGatewayServer	Required	To change the default API gateway server: Clear Use Default. Enter the URL to the server. Example: <tenantURL>/api
   MultiweekWorkloadPattern_iPack_v2_Locale_CRT	Required	Enable Override.

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 properties

   Process property name	Column header value
   _MultiweekWorkloadPattern_iPack_v2_Locale_CRT	Parameter Name, Locale Policy, Value, Description

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.

1. Select Cross Reference.

2. From the Cross Reference list, select the MultiweekWorkloadPattern_iPack_v2_Locale_CRT table.

3. Select Override, which allows you to:

   • Download the tables when you run the integration
   • Edit the table cells in Extensions
4. When you finish, click tap OK.

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

   Multi-week Workload Pattern - Locale CRT structure

   Multi-week Workload Pattern - 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	Value	Description
   Error_EmptyLocation	Location must not be empty.
   Error_EmptyLocationType	Location is not valid.
   Error_InvalidDateFormat	Date format for start date or end date is not valid.
   Error_InvalidEndDate	End date must be in the future.
   Error_InvalidStartDate	Start date must be in the future.
   Error_NoEndDate	End date must not be empty.
   Error_NoStartDate	Start date must not be empty.
   Label_DisqualifiedLocation	Disqualified Location
   Label_IntegrationExecutionId	Integration Execution ID
   Label_IntegrationTypeName	Integration Type
   Label_IntegrationTypeValue	Import
   Label_LocationCount	Location count
   Message_AdditionalDetails	Integration has completed with errors.
   Message_BadWorkloadkPatternRequest	Bad request for workload pattern	Error occurred while creating workload pattern. Verify staffing matrix data.
   Message_Inactive_Matrix	Matrix not found.	Staffing matrix not found for this location.
   Message_Location	Location
   Message_MatrixWeekRangeInvalid	Matrix week range is not valid.	Gap between volume ranges is not uniform.
   Message_MultipleStaffingMatrix	Multiple active matrices found.	Activate the preferred matrix; <MatrixCount> active matrices found for this location.
   Message_WithoutErrors	Integration has completed without errors.

   Custom tags used in the notifications are replaced with actual values as described in the custom tags notifications table.

   Custom tags — Comment Note

   Custom tags - Comment notes

   Tag	Description
   < MatrixCount>	Count of active staffing matrices in location.

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

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.

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.

   Multi-week Workload Pattern — Integration parameters

   Multi-week Workload Pattern — 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

See Configure Access to Integrations .

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.

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.