Hours and Dollars Allocation

Configure Access to Integrations.

• Comments: Create a comment, such as Adjusted by Hours and Dollars Allocation. The pay codes category must be selected during configuration. This comment must be used exclusively by the Hours and Dollars Allocation extension. See the Comments topic.

• Paycodes: Configure cascading hours and money paycodes dedicated for use by time-off requests and corresponding monetary deduction. See the Paycode definition topic.

• Accrual codes: Configure hours and money type accrual codes dedicated for use by the integration. See the Accrual codes topic.

• Accrual policies: Configure accrual policies corresponding to the accrual codes. See the Accrual policies topic.

• Accrual profiles: Configure an accrual profile that includes all accrual policies that need to be assigned to the employee. See the Accrual profiles 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 Hours and Dollars Allocation 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: Hours And Dollars Allocation > HoursAndDollarsAllocation_iPack_v2.

1. Select Connection Settings.

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

   Connection Settings

   Connection Settings for the integration

   Setting	Required	Actions
   HoursAndDollarsAllocation_iPack_v2_APIGatewayServer	Required	To change the default API gateway server: Clear Use Default. Enter the URL to the server. Example: <tenantURL>/api
   HoursAndDollarsAllocation_iPack_v2_AbsenceLookup_CRT	Required	Enable Override.
   HoursAndDollarsAllocation_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 HoursAndDollarsAllocation_iPack_v2_CRTConfig to set process properties that must be configured before the integration can run. This main process starts the integration process and handles errors.

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 dropdown list, select the HoursAndDollarsAllocation_iPack_v2 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.
5. Repeat the steps for each of the HoursAndDollarsAllocation tables.
   • HoursAndDollarsAllocation_iPack_v2_AbsenceLookup— Used by the integration to evaluate the need to update the money paycode.

     Hours and Dollars Allocation — Absence Lookup CRT

     Hours and Dollars Allocation — Locale CRT

     Column name	Description
     SNo.	Identifies the row using a sequential value, beginning with 1.
     RequestPaycode	Identifies the hours and cascading paycodes used in time-off requests. Note: Any cascading paycodes entered in the column must contain "Cascading" as part of the paycode name. Every hours-type paycode entered in the RequestPaycode column must be mapped to a corresponding money paycode in the MoneyPaycode column. The case-sensitive values must be configured in the application.
     MoneyPaycode	Identifies the money paycode used to hold the dollar equivalent of the time-off request. Note: The case-sensitive value must be configured in the application.

     Note:

     A 1-to-1 mapping between RequestPaycode and MoneyPaycode must exist for each row in AbsenceLookup_CRT.

   • HoursAndDollarsAllocation_iPack_v2_Locale_CRT— Allows translation of messages and labels into different languages.

     Hours and Dollars Allocation — Locale CRT structure

     Hours and Dollars Allocation — Locale CRT structure

     Column name	Description
     Parameter Name	Key for which localization is defined.
     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.
     Message	Message shown in Additional Details, or value of the label defined in the Run Summary section. Example: Comment was not provided.
     Description	The description that is shown in Additional Details. Example: 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	Message	Description
     Error_BlankDraftStatus	*	Draft Status was not provided.
     Error_BlankHoursAndDollarsComment	*	Hours and Dollars Comment was not provided.
     Error_EmptyDaysDuration	*	Number of Days was not provided.
     Error_InvalidHoursAndDollarsCommentCategory	*	Comment is not configured with the paycode category.
     Error_NoEmployeeIDandHyperfind	*	Hyperfind or individual employee ID not provided.
     Label_AddedSchedulePaycodeEdits	*	Added Schedule Paycode Edits
     Label_DeletedSchedulePaycodeEdits	*	Deleted Schedule Paycode Edits
     Label_IntegrationType	*	Integration Type
     Label_IntegrationTypeValue	*	Import
     Label_InvalidEmployees	*	Invalid Employees
     Label_ProcessedEmployees	*	Processed Employees
     Label_UpdatedSchedulePaycodeEdits	*	Updated Schedule Paycode Edits
     Message_AdditionalDetails	*	Process completed with transaction errors. Additional details, such as disqualifications, may be accessible using the button below.
     Message_InvalidCommentNoteLength	*	Comment Note cannot exceed 250 characters.
     Message_InvalidDayDuration	*	The Number of days passed exceeds 365-day threshold limit.
     Message_InvalidEmployee	*	Invalid Employee.	Employee with ID <employee number> does not exist.
     Message_InvalidHoursAndDollarsComment	*	Hours and Dollars Comment <Comment Name> not found.
     Message_PartialFailedEmployee	*	Paycode Edit failed.	Employee ID <employee number> on <employee date> does not have a sufficient accrual balance.
     Message_TerminatedEmployee	*	Terminated Employee.	Employee <employee number> is not active in the application.
     Message_WithErrors	*	Integration completed with errors.
     Message_WithoutErrors	*	Integration completed without errors.

     Custom tags

     Custom tags

     Tag	Description
     <employee number>	The employee's ID number.
     employee date>	The date that employee's accrual balance was updated.
     < Comment Name>	The Comment integration parameter.

(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 HoursAndDollarsAllocation_iPack_v2.
2. Click Tap Assign .
3. In Integration Parameters, you can override default settings.
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 Hours and Dollars Allocation process.

   Integration Parameters

   Hours and Dollars Allocation - Control Properties

   Parameter name	Description / Default value / User prompt	Template parameter	Parameter type
   Hyperfind	The default Hyperfind or Location query that contains the active employees for whom the integration is run. Default = All Home User prompt = No Mandatory = Yes	HyperfindAndLocation	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 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	EmployeeIDs	Text
   Number of Days	The number of days, beyond the signed-off day plus one day, during which the employee’s data can be processed. Default = 120 User prompt = No Mandatory = Yes	NumberOfDays	Number
   Comment	Comment added to the paycode edit in the timecard. Default = Adjusted by Hours and Dollars Allocation User prompt = No Mandatory = Yes	Comment	Text
   Comment Note	Note added to the paycode edit in the timecard. User prompt = No Mandatory = Optional	CommentNote	Text
   Locale	Locale for error messages. User prompt = No Mandatory = Yes	Locale	Text
   Draft Status	The draft status symbolic ID, such as draft. Default = draft User prompt = No Mandatory = Yes	DraftStatus	Text

See Configure Access to Integrations .

1. Select the integration:
   1. Select Main Menu Maintenance > Integrations.
   2. Click Tap Run an Integration .
   3. Select the HoursAndDollarsAllocation_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:
   • Individual Employee ID: 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

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.

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.

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

2. Select the HoursAndDollarsAllocation_v1.1 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 the 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.

7. Edit the following decision tables:
   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.

   • HoursAndDollarsAllocation_v1_1_Variables— holds process parameters.

     Hours and Dollars Allocation — Variables decision table structure

     Hours and Dollars Allocation Variables decision table structure

     Variable name	Description
     Workflow Notification	Notification initiated on error. Default = Hours And Dollars Error Notification
     Totalization Wait Time	Wait time, in seconds, for timecard data totalization. Default = 30
     Approved Status	Comma-separated list of system status names representing approved time-off requests. Default = Approved
     Cancelled Status	Comma-separated list of system status names representing canceled time-off requests. Default = CancelApproved,Canceled
     Admin	Internal user; do not change. Default = SERVICES-LEVEL3
     RequestId	Time-off request. Default = RequestId_1
     Comment	Comment used for paycode edit. Default = Adjusted by Hours and Dollars Allocation
     Comment Note	Note used for paycode edit. Default = Paycode Edit

   • HoursAndDollarsAllocation_v1_1_AbsenceLookup— defines the 1-to-1 mapping between request paycodes and money paycodes.

     Hours and Dollars Allocation — Absence Lookup decision table structure

     Hours and Dollars Allocation Absence Lookup decision table structure

     Variable name	Description
     SNo.	Identifies the row using a sequential value, beginning with 1.
     RequestPaycode	The cascading or hour paycode used for time-off requests.
     MoneyPaycode	The money paycode that corresponds to the time-off paycode. Note: When the RequestPaycode is set to a cascading paycode, the corresponding MoneyPaycode must be configured as a cascading paycode.

     Note:

     • The RequestPaycode column must contain hours and cascading paycodes.

     • An hour-based RequestPaycode value must have a corresponding money-based paycode configured in the MoneyPaycode column.

     • It is recommended to include "Cascading" in the name of the cascading-type RequestPaycode.

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 HoursAndDollarsAllocation_v1.1 model.

3. Click Tap Edit, and then configure the required parameters and deployment dates. Select Notification Templates from the Template Categories list.

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