Totalizer Extensibility Setup

Note: This business process An organized flow of activities or tasks that achieves a business goal. An automated business process minimizes the amount of paperwork and manual tasks to complete that process by way of automatic actions, online forms, and automatically generated messages. is an extension model that is developed outside the normal release schedule to meet specific customer needs. To request one of these models, you must submit a Salesforce Service Request to UKG. After the model is delivered to your tenant, you can edit it to meet your needs.

The Totalizer Extensibility Setup workflow acts as a step-by-step configuration aide to specifically support Totalizer extensibility.

During standard processing, the Totalizer proceeds through a sequence of phases. Each phase processes a specific calculation, such as checking premium zones or overtime rules.

Totalizer extensibility allows injection of custom scripting code (JSON) either before or after a process which permits manipulation of engine-produced data and influences remaining Totalizer engine processes.

This setup tool removes the necessity of JSON coding expertise by generating appropriate JSON code in the backend.

Before implementing a Totalizer extension point, certain supporting requirements must be configured from the Setup tool.

Define custom zones that represent employee overtime policy using terminology familiar to the organization. These zones, referenced by the Totalizer, cannot be created with standard work rule building blocks. Examples include: Time for Time; Money; and Time and Money.

An administrator launches the Totalizer Extension Setup tool from My Business Processes.

When the Totalizer Extension Setup pane displays, the administrator selects Overtime Preferences from the list, and then proceeds through each step to create, update, or delete overtime display names. Upon completion, the names display in combination rule configuration and employee overtime preference selection.

Note:

The system prevents deletion of any custom zone that is in use by a combination rule or paycode A category of time or money that employees earn, for example, Regular Hours, Bonus, or Sick. distribution.

  • You must enable the Totalizer Extensibility feature switch before configuring and utilizing the Totalizer Extensibility Setup process.

Before you configure this business process, you must do the following:

  • Feature switch: Enable the Totalizer Extensibility feature switch. See the Feature Switch topic.

Version Description
1

Initial release.

Migrate the business process model to the tenant

Migrate the Totalizer Extensibility Setup 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.

Configure the decision tables

Configure the Totalizer Extensibility Setup decision tables.

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

  2. Select the TotalizerExtensibilitySetup_v1 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 to edit.

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

  6. Click Tap Save and close.

Repeat the step for each Totalizer Extensibility Setup decision table.

Caution:

  • Values entered in the decision tables are case-sensitive, and must match configured values in the application

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

TotalizerExtensibilitySetup_v1_InternalParameters — Controls internal Totalizer validation parameters.

Totalizer Extensibility Setup — Internal Parameters decision table structure
Parameter name Description
Admin

Internal user; do not change.

Default = SERVICES-LEVEL3

Note:

When the workflow is calling APIs and Admin = blank, the process checks the permissions in the function access profile assigned to the user who is executing the workflow.

TotalizerExtensibilitySetup_v1_Locale — Allows customization of the text in the workflow form and notifications for different locales.

Totalizer Extensibility Setup — Locale decision table structure
Parameter name Description
Locale Parameter Name Internal field; do not change.
Locale Policy

Locale policy for which the text applies.

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.
Locale Parameter Value Text displayed in the workflow form or notification.
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".)

Sample Locale decision table content
Locale Parameter Name Locale Policy Locale Parameter Value
Error_API !=empty API error occurred. Please check Activiti Tenant Admin page for details. The custom zone could be in use.
Error_Default !=empty Error occurred. Please check Activiti Tenant Admin page for details.
Error_DistinctCustomZoneNameRequired !=empty Duplicate Custom Zone Name not allowed.
Error_ExtensionNameInUse !=empty Duplicate Names are not allowed.
Error_ExtensionNameRequired !=empty Custom Zone Name not configured.
Label_Action !=empty Action
Label_ActionDelete !=empty Delete
Label_ActionUpdate !=empty Update
Label_ButtonClose !=empty Close
Label_ButtonCreate !=empty Create Custom Zones
Label_ButtonNext !=empty Next
Label_ButtonUpdate !=empty Update
Label_CustomZoneSetupHeader !=empty Custom Zone Setup
Label_ErrorFormHeader !=empty Error
Label_ExistingCustomZones !=empty Select Custom Zones
Label_ExtensionListHeader !=empty Select Extension
Label_ExtensionListOvertimePreference !=empty Overtime Preference
Label_Options !=empty Options
Label_OvertimePayChoice !=empty Overtime Pay Choice
Label_PurposeMoney !=empty Pay Choice Money
Label_PurposeTime !=empty Pay Choice Time for Time
Label_PurposeTimeAndMoney !=empty Pay Choice Time and Money
Label_SetupOptionsCreateNew !=empty Create Zones
Label_SetupOptionsManageExisting !=empty Edit Zones
Label_UpdateCustomZoneName !=empty Updated Name
Message_CreateCustomZoneHeader !=empty Enter Customer Zone Display Name.
Message_CreatedSuccessfully !=empty Zone Created successfully.
Message_CurrentCustomZoneHeader !=empty Custom Zone details.
Message_CurrentCustomZoneName !=empty Name: <CurrentCustomZoneName>
Message_CurrentCustomZoneType !=empty Type: <CurrentCustomZoneType>
Message_DeletedSuccessfully !=empty Zone deleted successfully.
Message_NoExtensionFound !=empty No Custom Zones found.
Message_UpdatedSuccessfully !=empty Zone Updated successfully.

Deploy the updated business process model

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

  3. Click Tap Edit, and then configure the required parameters and deployment dates.

  • (Optional) In Description, enter Totalizer Extensibility Setup.
  • In Display Name, enter TotalizerExtensibilitySetup_v1.
  • 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 Show.
  • In GoTo List, select Hide.
    • Caution: Do not make a selection from the Template Categories list.

  1. Click Tap Save, and then select Return to deploy.

  2. Add the process model to the required process profile.

  3. Assign the process profile to employees by way of People Information.