Copy Schedule

A store manager wants to copy last week's schedule to the following week. The original schedule contains Sick paycodes. It also contains an employee working as a Sales Associate through Day 2 of next week, then retiring on Day 3.

The schedule for the previous week:

1. In the Schedule Planner, load the previous schedule, select a set of employees, navigate to the GoTo control, and select Business Processes.

2. Select Copy Schedule from the Business Processes Library.

3. In the Copy Schedule panel, select Next Schedule Period from Target Schedule, and click tap the Copy Schedule button.

After the process completes, return to the Schedule Planner to view the results:

• Absence pay codes are removed and replaced with original schedules.

• Open shifts are created for the Sales Associate job, effective on the employee's retirement date.

The schedule for the following week:

Version history

Version	Description
1	Initial release.
1.1	Added support for accented characters.
1.2	Revised the business process to address some cases where shifts were copied to incorrect days.
1.3	Addressed an issue related to the 90-day target date range limit.
1.4	Addressed an issue when the extension initiator's locale policy was set to <None>.
1.5	Addressed an issue related to the 50-employee maximum.
2	The extension now allows shift labels and comments to be copied from the source to the target schedule.
3	The extension now allows business structure transfers from the source to target schedule when the transfer matches the employee's primary job.
3.1	The business process no longer displays an error message when updating an open shift corresponding to days with applied time off.
4	Enhanced the process to support Activiti 2.x.
4.1	Enhanced to support the upgraded Groovy version of Activiti v2.x.
4.2	The Copy Schedule business process caused a script execution failure when a custom date range was chosen by a user with the Swedish locale policy assignment.

Note: The process for configuring and deploying this and other Business Process Extensions is the same as all Business Process models.

1. Migrate the business process model to the tenant Migrate the Copy Schedule_v4.2 process model to the customer tenant using Setup Data Manager (SDM) Moves and manages configuration data across software and hardware environments. (SDM Setup Data Manager moves and manages configuration data across software and hardware environments.).

   1. Log in to the appropriate tenant.

   2. Go to Main Menu > Administration > Setup Data Manager.

   3. Select the Source tenant where the Process Model resides, and select the template to copy. It is a .zip file. A message appears in the Source column: Source: Import from <filename>.zip.

   4. Click Tap Review and Publish. The Publish Summary panel appears.

   5. Review the Publish Summary panel. It lists the items that were extracted from the migration file. If you approve, click tap Publish with Comment or just Publish.

   6. Click Tap Go to Publish History at the bottom of the panel to view the status of the data transfer. The Publish History page contains a table that lists the items you have published. If there were errors during the transfer, the button under the Errors column for that row is black.

   7. To view details, click tap the appropriate row and click tap View Selected.

   8. On the History for publish run page, click tap Show all to view the setup data that you published, and the errors that occurred, if any, listed by item type and name.

2. Configure the Copy Schedule decision tables

   Note: Decision tables are configurable based on user requirements and can be changed accordingly. These tables are dynamic and can be updated at any time without redeployment of the process model.

   1. Go to Main Menu > Administration > Application Setup > Business Process setup > Process Models.

   2. Select the Copy Schedule_v4.2 process and click tap Edit. The process model enters edit mode.

   3. Select the Decision Tables tab.

   4. Click Tap Everyone's, and then select a decision table.

   5. Click Tap Decision Table Editor to add or update the rows in the table.

   6. Click Tap Save and close.

   Caution:

   • Values entered in the decision tables are case-sensitive, and must match configured values in UKG Pro Workforce Management.

   • Do not remove variables, variable names, or variable types from any decision table.

3. Edit the following decision tables:
   • CopySchedule_v4.2_Parameters — controls the copy schedule process.

     Copy Schedule Parameters decision table

     Variable name	Type	Description
     Admin	Text	An internal Service Level user who runs the REST APIs. Do not change. Default = SERVICES-LEVEL3 Note: Because the Service Level user applies the tenant locale during the API calls, the customer tenant locale must match the locale assigned to the user of the copy schedule form.
     Timeframe	Text	Comma-separated list of time frame values. Default = Current Schedule Period,Next Schedule Period,Next Schedule Period + 1,Next Schedule Period + 2 Values must be entered using the same locale as the default tenant locale.
     OverrideExistingScheduledSelectedByDefault	Boolean	Determines the default value of the Override Existing Schedule check box in the Copy Schedule panel. No (default) indicates that schedules in the target period are not overwritten by the source schedule. Yes indicates that schedules in the target period are overwritten by the source schedule.
     CopyShiftLabelsSelectedByDefault	Boolean	Determines the default value of the Copy Shift Labels check box in the Copy Schedule panel. No (default) indicates that shift labels in the source are not copied to the target. Yes indicates that shift labels in the source are copied to the target.
     CopyShiftCommentsSelectedByDefault	Boolean	Determines the default value of the Copy Comments check box in the Copy Schedule panel. No (default) indicates that comments in the source are not copied to the target. Yes indicates that comments in the source are copied to the target.

     Note:

     In this extension, the Service Level user executes the backend REST APIs. Because the Service Level user depends on the customer tenant locale during API calls, the locale of the Timeframe values in the target schedule drop-down list in the user form must match the locale used by the customer tenant.

   • CopySchedule_v4.2_Locale — Allows customization of the text in the workflow form and notifications for different locales.

     Copy Schedule Locale decision table

     Variable name	Type	Description
     Key	Text	Placeholders for messages.
     Locale	Text	Locale policy used for customized message.
     Message	Text	Customized message.
     Description	Text	(Optional) Customized description.

     Note:

     • Localization of business process workflows remains optional, but is supported.

     • The decision table 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 decision table. Text within tags ("<>") must not be changed.

     • Names of the parameters in the decision table 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 decision table with the appropriate Locale Policy, and then add the localized values in the Message column.

     • The last row in the decision table must remain empty ("!=empty".)

     Copy Schedule Locale sample content

     Key	Description
     _MessageTimePeriod Exceeded	Message that displays when the selected time-period exceeds 90 days. The selected period has exceeded the last 90 days.
     _MessageEmployeeCountExceeded	Message that displays when more than 50 employees are selected. More than 50 employees selected.
     _MessageTimePeriodandEmployeeCount	Message that displays when the selected employees and time-period exceeds limits. The number of employees has exceeded 50 and the selected period has exceeded 90 days.
     _MessageScriptError	Message that displays when the workflow script fails. Script execution failure. Please contact system administrator.
     _Message1	Message that displays when a failure occurs. Contact the system administrator.
     _Message2	The error headline. Error is mentioned below.
     _MessageErrorFormHeader	The error form header. Error
     _MessageAPIError	Message that displays when the API call fails in the workflow. Rest API Connector failure. Please contact system administrator.
     _MessagePasteEndDate	Message that displays when the past end date is less than the past start date. Past End Date is less than Past Start Date.
     _MessageSelected	The selected schedule label. Selected Schedule
     _MessageTarget	The target schedule label. Target Schedule
     _MessageOverride	The override existing schedule label. Override Existing Schedule
     _MessageStartDate	The start date label. Start Date
     _MessageEndDate	The end date label. End Date
     _MessageCommentOverride	The include comments checkbox label. Include Comments
     _MessageNoteOverride	The include shift labels checkbox label. Include Notes

4. Deploy Process Model

   Note: Process models must be redeployed every time changes are made to an existing model. Re-deployment is not required for decision table changes.

   Follow these steps to deploy the process model. For detailed information, see the online help topic Deploy Business Process Models.

   1. Go to Main Menu > Administration > Application Setup > Business Process Setup > Process Models.
   2. Select the CopySchedule_v4.2 model and click tap Deploy .
   3. On the Business Process page, configure the required parameters and deployment dates.
      • (Optional) In Description, enter Copy Schedule.
      • In Display Name, enter CopySchedule_v4.2.
      • In Start Effective, select the effective start date.
      • In End Effective, select Forever to make the Business Process available indefinitely.
      • In Status, select Active.
      • In Action List, select Hide.
      • In Tile A container that provides navigation or action from its summary view. List, select Hide.
      • In GoTo List, select Show.
      Caution: Do not make a selection from the Template Categories list.
   4. Click Tap Save and then Return.
   5. Add the process model to the required process profile.
   6. Assign the process profile to employees by way of People Information.