Hours and Dollars Allocation

In organizations where two accrual types — Hours and Dollars — represent an employee’s entitlement balance, the Hours and Dollars Allocation extension ensures synchronization between these balances. When an employee’s time-off request is approved, the extension automatically and simultaneously deducts both the hour and money amounts associated with the request.

Note: This extension, a combined integration and workflow model, is developed outside the normal release schedule to meet specific customer needs. To request one of these extensions, you must submit a Salesforce Service Request to UKG. After the extension is delivered to your tenant, you can edit it accordingly.

Upon approval of a time-off request, the Hours and Dollars Allocation workflow is triggered. This real-time process calculates the corresponding money paycode-taking amount by multiplying the requested accrual hours by the appropriate wage calculation model in effect for the leave date.

The Boomi™ integration continuously monitors relevant employee data changes, including:

Base wage updates
Leave request duration changes
Leave request cancellations

Scheduled to run daily, the integration reviews future-dated periods and automatically adjusts any previously generated money paycodes, ensuring data accuracy and alignment with the latest employee information.

The extension provides multiple configurable models for determining money paycode equivalents, offering flexibility to meet various organizational policies and pay practices. Administrators can enable one or more of the following calculation models:

Base Wage Calculation: Uses the employee's base wage on the leave day.
Fixed Average Calculation: Uses a fixed average rate derived from historical accrued hours and money amounts, typically from the previous year.
Rolling Average Calculation: Uses a dynamic average rate calculated by dividing the Money Balance by the Hours Balance as of the leave day.
Vacation Pay Rate Calculation: Uses the employee's designated vacation pay rate.

Considerations and limitations

Employees must have a base wage assignment that exceeds zero (0).
The extension processes only hour and money accruals; it ignores day-based accruals.
Sufficient balances must exist for both the hours and money accruals.
Accrual policies must be defined with the appropriate taking paycode.
The Fixed Average Calculation model ignores the accrual reset action; it only considers grants that are made during the reference period.
When the Vacation Pay Rate Calculation model is in use,
- Do not assign overlapping Vacation Pay Rate Certificates in the employee's people record.
- You must define each of the following fields and values in the Skills and Certifications section of the employee's people record:
  - Certification: Certificate name
  - Number: Employee wage (This value can optionally contain a decimal point or comma, but it must not contain a currency symbol.)
  - Grant date: Certificate start date
  - Expiration date: Certificate expiration date
As a best practice, schedule the Hours and Dollars Allocation integration to run daily during off-business hours.
When approving multiple requests from an employee on the same day, managers can ensure that balances are processed correctly by briefly pausing between subsequent request approvals.

User experience

The following examples demonstrate how Canadian employers may apply each of the available vacation dollar-calculation models. In all scenarios, assume that each employee has sufficient vacation accrual balances to cover the requested hours.

When a manager approves a vacation request, the workflow:

Calculates the dollar equivalent of the vacation hours based on the calculation model applicable on the date of the taking.
Adds the corresponding money-taking paycodes to the employee's timecard (details and totals add-on).
Displays hour deductions in the timecard totals add-on using paycodes from the entitlement cascade, indicating how hours are drawn from each year's accrual balance.

Important:

Users of this business process can take advantage of the enhanced cancellation request states.

Organizations that have enabled the UseNewRequestCancelSubmittedStatuses feature switch will see new states:

Cancel Approved — the employee's request to cancel a previously approved request is approved.
Cancel Refused — the employee's request to cancel a previously approved request is refused.

Existing Canceled and Approved states remain, and retain their original use.

Base Wage Calculation

In this default model, the system uses the employee's current base hourly wage on the day of the taking.

Example

Employee A has a base wage of CAD $15.00 per hour and requests 8 hours of vacation.

Calculation:

Money-taking paycode amount = Hours taken × Base wage

= 8 × 15.00

= CAD $120

Fixed Average Calculation

This model uses a fixed average rate based on a defined historical reference period.

Example

Employee B accrued the following during the reference period:

Money accrued: CAD $1,500
Hours accrued: 80 hours

Calculation:

Fixed average rate = Money accrued ÷ Hours accrued

= 1,500 ÷ 80

= CAD $18.75 per hour

Money-taking paycode amount = Hours taken × Fixed average wage

= 8 × 18.75

= CAD $150

Rolling Average Calculation

This model determines the rate based on the employee's current balances as of the request date.

Example

As of the vacation request date, Employee C has:

Current money balance: CAD $700
Current hours balance: 40 hours

Calculation:

Rolling average rate = Current money balance ÷ Current hours balance

= 700 ÷ 40

= CAD $17.50 per hour

Money-taking paycode amount

= 8 × 17.50

= CAD $140

Vacation Pay Rate Calculation

This model uses the employee's assigned vacation pay rate certificates. The system determines which certificate applies based on the taking date.

Example Employee D has two certificates:

Effective Date Range	Vacation Pay Rate
Jan 1 – Apr 30	CAD $10.00/hour
May 1 – onward	CAD $12.00/hour

Employee D takes 8 vacation hours on March 16 and May 1.

Calculations:

March 16: 8 × 10.00 = CAD $80
May 1: 8 × 12.00 = CAD $96

Note: When entering vacation pay certificates on the employee's People Record, do not include the currency symbol. Enter only the numeric rate (e.g., 10.00, 12.00).

Base Wage Change Recalculation

When an employee requests future vacation using their current year's accrual balance, the system calculates a planned money deduction in the timecard based on the employee's base wage at the time of approval. If the employee's base wage increases before the vacation occurs, the original deduction no longer reflects the updated wage.

The next time the integration runs, it:

Detects the change in the employee's base wage.
Adds a money-taking pay code to the timecard Details and Totals Add-On sections to apply the necessary wage adjustment.

Note: We recommend scheduling the Hours and Dollars integration to run daily to ensure timely detection and adjustment of base wage changes.

Hours and Dollars Allocation business process

Before you start — Hours and Dollars Allocation business process

Before you configure the Hours and Dollars Allocation process model, you must configure the following:

Employees must be assigned a base wage that exceeds zero.
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.
Caution: Hours and Dollars Allocation does not support days-based paycodes.
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 accrual profiles that includes all accrual policies that need to be assigned to the employee. See the Accrual profiles topic.

Workflow notifications: Configure generic workflow notifications to support the Hours and Dollars Allocation business process. See the Configure Notifications for Business Processes topic.

Workflow notification examples include:

Name: Time-off request — Employee — Submission Notification.

Subject: <Employee Name>, your request for <Request Subtype> is submitted.

Long Message: Your request for <Request Subtype> has been submitted, and is pending approval.

Select Notification Recipient List and Do not suppress duplicates.

Control center fields

Field	Label	Value
1	`Requested Period`	`<Requested Period>`
2	`Approver Name`	`<Approver Name>`

Name: Time-off request — Manager — Submission Notification.

Subject: Request submitted by <Employee Name> for <Request Subtype>.

Long Message: Request submitted by <Employee Name> for <Request Subtype. Please review the details and approve or reject.

Select Recipient List will be supplied at runtime, Notification Recipient List, and Do not suppress duplicates.

Control center fields

Field	Label	Value
1	`Requested Period`	`<Requested Period>`
2	`Status`	`<Status>`

Name: Hours and Dollars Allocation — Employee Notification.

Subject: Hours and Dollars Allocation Employee Notification

Long Message: The time-off request submitted for <Start Date> and <End Date> has been <Approval Status>.

Select Recipient List will be supplied at runtime and Do not suppress duplicates.

Select Trigger Business Process.

Select HoursAndDollarsAllocation_v2 from Template.

Select System User from Business Process will run as.

Control center fields

Field	Label	Value
1	`Approval Status`	`<Approval Status>`
2	`Start Date`	`<Start Date>`
3	`End Date`	`<End Date>`

Name: Hours and Dollars Error Notification.

Subject: Hours and Dollars Error Notification.

Long Message: Please contact your system administrator.

Select Recipient List will be supplied at runtime, Send to Employee's Manager, Notification Recipient List, and Do not suppress duplicates.

Control center fields

Field	Label	Value
1	`Person Number`	`<Person Number>`
2	`Start Date`	`<Start Date>`
3	`End Date`	`<End Date>`
4	Error	`<error>`
5	Execution Status	`<executionStatus>`

Request subtype: Configure time-off request subtypes to initiate the business process. Select the previously configured employee, manager, and recipient workflow notifications during configuration. See the Configure Request Subtypes topic.

Configure the Hours and Dollars Allocation business process model

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

Migrate the Hours and Dollars Allocation process model to the customer tenant.
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 Hours and Dollars Allocation 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.

Go to Main Menu > Administration > Application Setup > Business Process setup > Process Models.
Select the HoursAndDollarsAllocation_v2 process and click tap Edit. The process model enters edit mode.
Select the Decision Tables tab.
Click Tap Everyone's, and then select the decision table to edit.
Click Tap Decision Table Editor to add or update the rows in the table.

Click Tap Save and close.

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.

Edit the following decision tables:

HoursAndDollarsAllocation_v2_Variables— holds process parameters.

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`

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

Caution: Values entered in the Absence Lookup decision table are case-sensitive and must match configured values in the application.

Hours and Dollars Allocation — Absence Lookup decision table structure

Variable name	Description
S No.	Identifies the row using a sequential value, beginning with 1.
Pay Code	Contains the hours-based or cascading taking paycode used for the requested time off. Important: When the Pay Code column contains an hours-based paycode, you must add a money-based paycode in the Allocated Paycode – Money Paycode column. If you want the workflow to process a cascading accrual profile, add a row for each cascading paycode. Then enter the cascading paycode in the Pay Code column and the string `Cascading` in the Allocated Paycode – Money Paycode column.
Allocated PayCode – Money Paycode	Identifies the money paycode used to hold the dollar equivalent of the time-off request.
Accrual Code	An accrual code that exists in the corresponding Accrual Profile. Important: When the Accrual Code column contains an hours-based accrual code, you must add a money-based paycode in the Associated Accrual Code – Money Paycode column.
Associated Accrual Code – Money Paycode	Money-based accrual code that exists in the corresponding Accrual Profile.
Accrual Profile	The employee's accrual profile assignment that contains accrual policies that identify the taking paycodes.
Model Type	Specifies the model that the workflow processes. Acceptable values include: Base Wage Calculation Vacation Pay Rate Calculation Fixed Average Calculation Rolling Average Calculation Note: When left blank, the workflow defaults to the base wage calculation model.
Model Effective Date	The model effective date. Caution: The value must adhere to the dd/mm/yyyy format.

Note:

A 1-to-1 mapping between Accrual Code and Associated Payout – Money Payout must exist for each row in AbsenceLookup decision table.

HoursAndDollarAllocation_v2_Parameters — holds the value of VacationPayrateCertification for Vacation Pay Rate Calculation and the start and end date of duration check grants awarded to employee for Fixed Average Calculation.

Variable name	Description
S.No.	Identifies the row using a sequential value, beginning with 1.
Parameter Name	Parameter name.
Parameter Value	Parameter value.

HoursAndDollarAllocation_v2_Parameters — Sample content

S.No.	Parameter Name	Parameter Value
1	VacationPayRateCerificateName	Vacation Pay Rate
2	FixedAverageCalculationPeriodStartDate	01/01
3	FixedAverageCalculationPeriodEndDate	31/12

HoursAndDollarAllocation_v2_Locale — contains configurable labels and messages to support Hours and Dollar Allocation.

Name	Description
Locale Parameter Name	Parameter name.
Locale Policy	Name of the locale policy for which the label applies. When the label applies to all locales, retain the empty value.
Locale Description	(Optional) Additional information.

Name

Description

Locale Parameter Name

Parameter name.

Locale Policy

Name of the locale policy for which the label applies.

When the label applies to all locales, retain the empty value.

Locale Description

(Optional) Additional information.

Note:

Localization of business process workflows remains optional, but is supported.
You can translate some or all messages by adding lines to the table in their preferred translation for specific locales. Decision tables are scanned from top to bottom; therefore, place messages for the most commonly used Locale Policy at the top of the decision table and less-restrictive locale policies at the bottom.
Text within tags ("<>") must not be changed.
The decision table holds all messages represented with standard English labels; these apply to all locales when the Locale Policy is set to !=empty.
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 !=empty Locale Policy, add a new row to the decision table with the appropriate Locale Policy, and then add the localized value in the Message column.
Decision tables support operators like "Contains," "Starts with," "Ends with," and "Is Not Empty." You can achieve your preferred results by following these examples:
- To match any non-empty or any string (like *), use the "Is Not Empty" operator.
- To match a string starting with "ABC" (like "ABC*"), use the "Starts with" operator and set the value to "ABC".
- To match a string containing "English" as substring, use the "Contains" operator with the value "English".

HoursAndDollarAllocation_v2_Locale — Sample content

Locale Parameter Name	Locale Policy	Locale Value
== "Label_ModelType"	!= empty	Model Type
== "Label_ReferenceRange"	!= empty	Reference range
== "Label_AccrualCode"	!= empty	Accrual code
== "Label_Earnings"	!= empty	Earnings
== "Label_Balance"	!= empty	Balance
== "Label_AllocatedAccrualCode"	!= empty	Allocated Accrual code
== "Label_AverageWageRate"	!= empty	Average Wage Rate
== "Label_FixedAverageCalculation"	!= empty	Fixed Average Calculation
== "Label_VacationPayRateCalculation"	!= empty	Vacation Pay Rate Calculation
== "Label_RollingAverageCalculation"	!= empty	Rolling Average Calculation
== "Label_BaseWageCalculation"	!= empty	Base Wage Calculation
== "Comment Note"	!= empty	Paycode Edit
== "Label_EffectiveWageError"	!= empty	Effective wage is 0 or Null, Please check
== "Label_effectiveDate"	!= empty	<start> to <end>
== "Label_Semicolon"	!= empty	:
== "Label_SubmissionDate"	!= empty	Submission Date
== "Label_BalanceInHours"	!= empty	hrs

Deploy the updated Hours and Dollars Allocation business 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 HoursAndDollarsAllocation_v2 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.

APIs — Hours and Dollars Allocation business process

API details

API name	Type	Resource path	Description
Retrieve Timecard Data for Multiple Employees	POST	/v1/timekeeping/timecard_metrics/multi_read	Retrieve all process segments and associated durations.
Delete Paycode Edits by ID	POST	/v1/scheduling/schedule/pay_code_edits/multi_delete	Delete timecard paycode edits.
Create Paycode Edits	POST	/v1/scheduling/schedule/pay_code_edits/multi_create	Create or add timecard paycode edits.
Retrieve Schedule	POST	/v1/scheduling/schedule/multi_read	Retrieve employee schedules.
Retrieve Time Off Request by ID as Manager	POST	/v1/scheduling/timeoff/{timeOffRequestId}	Retrieve employee time-off details.

Version history — Hours and Dollars Allocation business process

Version

Description

Initial release.

1.1

Enhancement.

The Hours and Dollars Allocation workflow allows users to take advantage of the enhanced cancellation request states.

The Hours and Dollars Allocation workflow introduces new calculation models, including:

Vacation Pay Rate Calculation
Fixed Average Calculation
Rolling Average Calculation

Hours and Dollars Allocation integration

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.

Get the URL, User, and Password for the APIGatewayServer.
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 > 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 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 .
Configure the Hours and Dollars Allocation 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: Hours And Dollars Allocation > HoursAndDollarsAllocation_iPack_v2.

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.

Select Connection Settings.

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

Connection Settings

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.

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.

Configure process properties

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.

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.

Process properties

Process property name	Column header value
HoursAndDollarsAllocation_iPack_v2_AbsenceLookupCRT	S No,Pay Code,Associated Payout - Money Payout,Accrual Code,Associated Accrual Code - Money Payout,Accrual Profile,Model Type,Model Effective Date
_HoursAndDollarsAllocation_iPack_v2_Locale_CRT	Parameter Name,Locale Policy,Value,Description

Configure the Hours and Dollars Allocation 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 — Hours and Dollars Allocation integration

Configure Access to Integrations.
Configure the following:
- 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.

Cross reference tables — Hours and Dollars Allocation integration

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.

HoursAndDollarsAllocation_iPack_v2_AbsenceLookup_CRT — Used by the integration to evaluate the need to update the money paycode.

Caution: Values entered in the Absence Lookup CRT are case-sensitive and must match configured values in the application.

Hours and Dollars Allocation — Absence Lookup CRT

Column name	Description
S No	Identifies the row using a sequential value, beginning with 1.
Pay Code	Contains the hours-based or cascading taking paycode used for the requested time off. Important: When the Pay Code column contains an hours-based paycode, you must add a money-based paycode in the Associated Payout – Money Payout column. If you want the integration to process a cascading accrual profile, add a row for each cascading paycode. Then enter the cascading paycode in the Pay Code column and the string `Cascading` in the Associated Accrual Code – Money Payout column.
Associated Payout – Money Payout	Identifies the money paycode used to hold the dollar equivalent of the time-off request.
Accrual Code	An accrual code that exists in the corresponding Accrual Profile. Important: When the Accrual Code column contains an hours-based accrual code, you must add a money-based paycode in the Associated Accrual Code – Money Payout column.
Associated Accrual Code – Money Payout	Identifies the money accrual code used to hold the dollar equivalent of the time-off request.
Accrual Profile	The employee's accrual profile assignment that contains accrual policies that identify the taking paycodes.
Model Type	Specifies the model that the integration processes. Acceptable values include: Base Wage Calculation Vacation Pay Rate Calculation Fixed Average Calculation Rolling Average Calculation Note: When left blank, the integration defaults to the base wage calculation model.
Model Effective Date	The model effective date.

Note:

A 1-to-1 mapping between Accrual Code and Associated Payout – Money Payout 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

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

Parameter Name	Locale Policy	Message	Description
CommentNote	*	Paycode Edit:
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_AccrualCode	*	Accrual Code:
Label_AddedSchedulePaycodeEdits	*	Added Schedule Paycode Edits
Label_AllocatedAccrualCode	*	Allocated Accrual Code:
Label_AverageWageRate	*	Average Wage Rage:
Label_Balance	*	Balance:
Label_BaseWageCalculation	*	Base wage calculation
Label_CertificateError	*	Certificate error.
Label_DeletedSchedulePaycodeEdits	*	Deleted Schedule Paycode Edits
Label_Earnings	*	Earnings:
Label_EffectiveWageError	*	Effective wage is 0. Please check.	Effective wage is 0 for person number <PersonNumber> on <LeaveDate> for <ModelType>.
Label_FixedAverageCalculation	*	Fixed average calculation
Label_FixedAverageDateConcatenateSymbol	*	To
Label_FixedAverageStartNEndDateEmpty	*	The Average Calculation Period start and end dates are empty.	Please provide start and end dates for the Fixed Average Calculation.
Label_HoursSymbol	*	Hrs
Label_IntegrationType	*	Integration Type
Label_IntegrationTypeValue	*	Import
Label_InvalidEmployees	*	Invalid Employees
LabelMessage_PersonNoAccrualProfile	*	Employee does not have an Accrual Profile assignment.
Label_ModelType	*	Model Type:
Label_PersonNumber	*	Person Number
Label_ProcessedEmployees	*	Processed Employees
Label_ReferenceRange	*	Reference Range:
Label_RollingAverageCalculation	*	Rolling Average Calculation
Label_SubmissionDate	*	Submission Date:
Label_UpdatedSchedulePaycodeEdits	*	Updated Schedule Paycode Edits
Label_VacationPayRateCalculation	*	Vacation Pay Rate calculation
Message_AccrualProfileCRTNoMatch	*	Accrual Profile match not found in the CRT.	No accrual profile match for <PersonNumber> from <StartDate> to <EndDate> in CRT.
Message_AccrualProfileEmpty	*	Accrual Profile not found.	No AccrualProfile for <PersonNumber> from <StartDate> to <EndDate>.
Message_AdditionalDetails	*	Process completed with transaction errors. Additional details, such as disqualifications, may be accessible using the button below.
Message_CertificateEmpty	*	Certificate not found.	Please provide certificate for <PersonNumber> from <StartDate> to <EndDate>.
Message_CertificateOverlap	*	Certificate date overlap	Certificate date overlap found for Certificate Name <CertName> from <StartDate> to <EndDate> for person <PersonNumber>.
Message_HourBalanceZeroOrNull	*	Hour amount is either null or zero.	Hour amount is either null or zero for person number <PersonNumber> on <LeaveDate> for <ModelType>.
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_NoActiveCertificateFound		Active certificate not found.	No Active Certificate found for person <person number> from <StartDate> to <EndDate>.
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

Tag	Description
<`CertName`>	Certificate name.
<`Comment Name`>	Comment integration parameter.
`<employee number>`	Employee's ID number.
<`employee date>`	Date that employee's accrual balance was updated.
<`EndDate`>	End date of the reference period.
<`LeaveDate`>	Leave date.
<`ModelType`>	Model name.
<`PersonNumber`>	Employee's person number.
<`StartDate`>	Start date of the reference period.

Install the Hours and Dollars Allocation 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.

Select Main Menu Administration > Application Setup > Integrations Setup > Install Integrations.
Click Tap Create .
In Integration Name enter a unique name, such as HoursAndDollarsAllocation_iPack_v2.
(Optional) Enter a Description.
Note: Do not select API Integration.
In File Access, select None to not select a connection.
(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.
(Optional) Select Re-Run to allow repeated runs of the integration with the same parameter values as the previous run.
(Optional) Configure Email Notifications:
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.
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.

Configure Integration template and parameters:

In Integration Template, select HoursAndDollarsAllocation_iPack_v2.
Click Tap Assign .
In Integration Parameters, you can override default settings. Click Tap Create.
Complete the configuration for each integration parameter value.

Click Tap Save.

Repeat this step for each integration control parameter that supports the Hours and Dollars Allocation process.

Integration Parameters

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 = Yes 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
VacationPayRateCertificateName	A semicolon-separated (;) list of certificates that the Vacation Pay Rate model references during processing. User prompt = No Mandatory = Yes	Vacation pay rate	Text
FixedAverageCalculationPeriodStartDate	Identifies the start day and month of the previous year for which the Fixed Average Calculation model references to calculate grants. User prompt = No Mandatory = Yes Caution: The value must adhere to the Dd/mm format.	Dd/mm	Text
FixedAverageCalculationPeriodEndDate	Identifies the end day and month of the previous year for which the Fixed Average Calculation model references to calculate grants. User prompt = No Mandatory = Yes Caution: The value must adhere to the Dd/mm format.	Dd/mm	Text

Make sure that the generic data access profiles (GDAP) allow access by the people who need to run the installed integrations.

See Configure Access to Integrations .

Run and test the Hours and Dollars Allocation integration

Run integrations to test that the configuration is set up correctly.

Run the integration
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.
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 — Hours and Dollars Allocation integration

API details

API name	Type	Resource path	Description
Retrieve Comments as Manager	GET	/v1/commons/comments	Retrieve all comments in the system.
Retrieve User Preferences for Current User	GET	/v1/commons/user_preferences/locale_policy	Retrieve locale for system user.
Retrieve All Extensions	POST	v1/commons/persons/extensions	Retrieve all employee information.
Retrieve Time Off Requests as Manager	POST	/v1/scheduling/timeoff/multi_read	Retrieve all time-off details.
Retrieve Schedule	POST	/v1/scheduling/schedule/multi_read	Retrieve all schedule details.
Retrieve Timecard Data for Multiple Employees	POST	/v1/timekeeping/timecard_metrics/multi_read	Retrieve all process segments and associated durations.
Delete Paycode Edits by ID	POST	/v1/scheduling/schedule/pay_code_edits/multi_delete	Delete paycode edit in timecard.
Create Paycode Edits	POST	/v1/scheduling/schedule/pay_code_edits/multi_create	Create or add paycode edit in timecard.
Update Paycode Edits	POST	/v1/scheduling/schedule/pay_code_edits/multi_update	Update paycode edit in timecard.
Certification Assignment	POST	/v1/commons/persons/certifications/multi_read	Retrieve an employee's Skills and Certification.
Retrieve Timecard Data for Multiple Employees	POST	/v1/timekeeping/timecard_metrics/multi_read	Retrieve an employee's accrual transaction details.

Version history — Hours and Dollars Allocation integration

Version	Description
1	Initial release.
1.1	Enhancement. The Hours and Dollars Allocation integration allows users to take advantage of the enhanced cancellation request states.
1.2	Correction. The create, update, and delete paycode edit APIs were replaced to support partial success.
iPack_v2	The Hours and Dollars Allocation integration delivery is now by way of an iPack.
iPack_v2	The Hours and Dollars Allocation workflow introduces new calculation models, including: Vacation Pay Rate Calculation Fixed Average Calculation Rolling Average Calculation In addition, the iPack now sends API errors to Transaction Assistant.