Configure the Prorated Accruals Integration
Prorated Accruals distribute accruals entitlements proportionally on the date of hire or termination, or a change to employment contract based on the number of remaining days in the reference accruals period.
Note: For more information, see the Prorated Accruals Overview.
Before you configure this integration, you must do the following:
- Review the Prorated Accruals Overview.
- Configure the GDAP and FAP for the people who will configure the integration: Configure Access to Integrations.
- Configure the following:
- Accrual codes — Set Type to Hour or Day. Select Allow Manual Edits. In Reporting Period, specify the period start and stop dates for the accrual code (use the selected date pattern).
- Accrual dates — Site-wide and person-specific reference dates determine when to credit or verify accrual balances.
- Date patterns — Predictable sequences of dates govern when to increment accrual balances. Examples: the first day of every year, Monday of each week. Set Frequency to Yearly, Monthly, Weekly, or Daily.
Note: This integration does not support pay periods in date patterns.
- Accrual limits — Set the following:
Carryover limit may use — Carryover limits govern how accruals can limit the number of days, hours, or both to carry over between intervals. This integration supports carryover limits only at a yearly frequency. This integration processes only Hour and Day types of accrual code.
Earning Amount Limit may use — The Earning Amount Limit limits the amount of accrued time or money regardless of earnings. This integration processes only Hour and Day types of accrual code.
Example: The amount of annual leave that can accrue within six months is 40 hours, so an employee can take a maximum of 40 hours within six months.
(Optional) You can set the following if needed:
- Check Limit over a seasonal time period — The system checks the accrual balance over a seasonal time period from one date to another date. Example: December 1 to December 31.
- Check Limit continuously over a rolling time period — The system checks the accrual balance continuously over the previous days, weeks, months, or years.
Note: This integration does not support pay periods in accrual limits.
- Check Limit on date pattern — The system checks the accrual balance at times specified by a predefined date pattern. Example: A monthly date pattern.
- Accrual grants — The Prorated Accruals integration supports fixed-type accrual grants with the following options for full-time equivalent (FTE) adjustments: Adjust grant according to FTE or Do not adjust grant according to FTE.
- Date patterns — The date pattern starts must be Start of Reference Date or Start on or before Reference Date with no offset value.
- Accrual policies — Configure the accrual policy Defines how and when balances for accrual codes are credited and debited. for the accrual code as follows:
Make sure that Adjust balance on FTE change is not selected.
(Optional) Length of Service Reference: If accruals grants increase based on length of service, select the Length of Service Reference date that specifies when milestones occur and grant amounts, carryover limits, and earning amount limits change. Length of service frequency can be Yearly, Monthly, Weekly, Daily, or None.
Grants: You can configure multiple grants or multiple entries with the Length of Service reference setup which allows the grant amount to be different or the same. Supported grant amounts include Days, Weeks, Months, and Years. Multiple grants for a single accrual policy are not supported, except for length-of-service multiple grants.
Payout Pay Code: Enable to use an accrual payout when an employee is terminated. Then, the integration initiates payouts for employees whose termination date falls during the period from the Sign-off date + 1 day to the integration run date.
(Optional) Disallow Overdraft Amount.
- Accrual profiles
Note: The Prorated Accruals integration ignores money-type accrual policies in accrual profiles.
- Employment Terms — Use employment terms to group employees who share accrual profiles.
(Optional) You can assign an accrual profile to employment terms, and multiple employment terms can have different accrual profiles. If an employment term is assigned an accrual profile, Prorated Accruals considers the accrual profile for the configured period.
Example: One employment terms specifies Vacation + Education from 2024-01-01 to 2025-07-15, and another specifies Vacation + Training + Education from 2025-07-16 to Forever.
- Translation - Setup Data — For Accrual Codes, Paycodes A category of time or money that employees earn, for example, Regular Hours, Bonus, or Sick., and Comments.
- Locale Policy — The Prorated Accruals integration publishes across all regions (Global), and you can use any date format, number format, and language in a locale profile. Locale profiles affect date, number, amount, name, key, status, and default values.
- Configure the following in People Information for each person:
- Employment Status — Identify dates of hire, rehire, and termination.
- Person Dates — Use the same length of service date pattern as the accrual policies configuration.
- Locale Policy
- Employment Terms
- Accrual Profile — Assign none or more accrual profiles. Accrual profiles contains accrual policies and have effective dates. Check start and end dates of the assignments to find time gaps between accrual profile assignments.
- Full-Time Equivalency (FTE) — FTE is a percentage (greater than 0 and less than or equal to 100) or a ratio of Employee Hours to Full-Time Hours that the system uses to calculate accruals. FTE has an effective date.
- Get the URL, User, and Password for the APIGatewayServer.
For more information, see the Deploy Integrations topic.
-
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.
-
Make sure that the Account is correct. If not, select the right account.
- Select the Deploy tab > Integration Packs.
- From the list in the left column, search for and select the Pro WFM Prorated Accruals Extension integration.
Note: If not found, select Browse Integration Packs to search for the integration.
- From Unattached Environments, select the environment in which to deploy the integration process for the selected integration. Click Tap the double-left arrows button .
- From the list in the left column, search for and select the Pro WFM Prorated Accruals Extension integration.
Select the environment
- Select the Manage tab > Atom Management.
- Select your environment.
Select environment extensions
- In Administration, click tap Environment Extensions.
- In Process Filter, click tap the magnifying glass . It can take several seconds before the button becomes active.
- Scroll to and select the integration pack: Prorated Accruals > ProratedAccruals_iPack_v5.
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 ProratedAccruals_iPack_v5_APIGatewayServer Required To change the default API gateway server:
- Clear Use Default.
- Enter the URL to the server.
Example: <tenantURL>/api
ProratedAccruals_iPack_v5_SFTPServer Required The SFTP server setting defines the connection to the file that contains the records. Integrations access only the internal SFTP account.
To change the default SFTP server parameters:
- For each field, clear Use Default.
- Enter the following values:
Enter the name of the internal Host.
Enter the number of the Port for the internal SFTP account.
In User, enter the username for the internal SFTP account.
In Password, select <Encrypted>. Enter the new password for the internal SFTP account.
Click Tap Apply.
ProratedAccruals_iPack_v5_Locale_CRT Required Enable Override. ProratedAccruals_iPack_v5_RoundingRules_CRT Required Enable Override. ProratedAccruals_iPack_v5_DataBaseServer Required The database server setting defines the connection to the file that contains the records.
To change the default server parameters:
- For each field, clear Use Default.
- Enter the following values:
In User, enter the username for the server.
In Password, select <Encrypted>. Enter the password for the server. Click Tap Apply.
Enter the Class Name.
Enter the Connection URL for the database server.
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 ProratedAccruals_iPack_v5 to set process properties that must be configured before the integration can run. This main process starts the integration process and handles errors.
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.
Process Properties Property Required Actions ProratedAccruals_iPack_v5_CRTConfig Required For ProratedAccruals_iPack_v5_Locale_CRT:
- Clear Use Default.
- Enter Parameter Name, Locale Policy, Value, Description.
For ProratedAccruals_iPack_v5_RoundingRules_CRT:
- Clear Use Default.
- Enter Accrual Policy, Round Rounding is a way to simplify payroll accounting and reporting, and to enforce shift start and end times. Punch rounds divide hours into equal segments of an hour. (In Decimal), Grace Graces determine when shift start and end times round to the previous increment and when they round to the next increment. (In Decimal).
Configure cross-reference tables
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.
- 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.
- Select Cross Reference.
-
From the Cross Reference dropdown list, select the following cross-reference tables:
ProratedAccruals_iPack_v5_Localization_CRT — This table stores customized labels, messages, and error key configurations for the Prorated Accruals integration, and follows the locale policy in the employee's preferred language. Insert data in chronological order and pre-configure default values.
Column headers:
Parameter Name,Locale Policy,Value,Description
- Parameter Name = The name of the parameter.
- Locale Policy = The name of the locale policy. You can use an asterisk (*) as a wildcard.
- Value = The message that is shown in Additional Details or the label in the Run Summary.
- Description = The brief description that is shown in Additional Details.
- Repeat for each parameter.
- Repeat the parameters for each locale policy.
Example Localization_CRT Parameter Name
Locale Policy
Value Description Error_MessageSFTPConfigError * Check the SFTP Host, Username, or Password for any errors and confirm that the SFTP host is accessible. SFTP configuration error Error_MessageExtensionTableConfigError * Check the Extension Table Host, Username, or Password for errors and confirm that the Extension Table was created. Extension table configuration error Error_MessageValidationHeader * Validation errors: {parameterList} Required parameters failed Error_MessageAccrualBalUpdateError * An Unsuccessful Response code was received while updating the accrual balance. Unsuccessful Response Disqualify_MessageInconsistentHireTermination * The Hire or Termination Dates are not consistent. Inconsistent Hire or Termination Dates Error_MessageVersionEffectiveDate * The VersionEffectiveDate uses an incorrect date format. VersionEffectiveDate not found Error_MessageOverDraftPayCodeInvalid * The OverdraftPayCode is missing or has an invalid name. OverdraftPayCode not found Error_MessageOverDraftCommentInvalid * The OverdraftComment is missing or has an invalid name. OverdraftComment not found Error_MessageInfoNonCarriedOverHoursCodeInvalid * NonCarriedOverHours is missing or has an invalid name. NonCarriedOverHours not found Error_MessageInfoNonCarriedOverDaysCodeInvalid * NonCarriedOverDays is missing or has an invalid name. NonCarriedOverDays not found Error_MessageInfoPayCodeInvalid * The InformationalPayCode is missing or has an invalid name. InformationalPayCode not found Error_MessageInfoCommentInvalid * The InformationalComment is missing or has an invalid name. InformationalComment not found Label_RunSummarySuccessfulPayCodeEdits * Number of successful paycode edits: {number} Successful paycode edits Label_RunSummarySuccessfulAccrualUpdates * Number of successful accruals updates: {number} Successful accruals updates Disqualify_MessageRerunNotRequired * A rerun is not required. Rerun not required Label_PersonRerunInValid * The person record is updated already, and no changes are detected to start a rerun. Record already updated Label_PersonRerunValid * Rerun the integration. Rerun required Label_RunSummaryProcessEmployees * Number of employee records processed: {number} Employee records processed Label_MessageIntegrationFailedWithDisqualify * The integration failed because of errors among the records. Check Additional Details for more information such as disqualified records. Integration run failed Label_MessageIntegrationSuccessWithDisqualify * The integration completed but with errors among the records. Integration ran successfully but records have errors Label_AdditionalDetailPersonNumber * Person number: {number} Person number Message_TerminationOverdraftCommentNote * On {EventDate}, Overdraft {ActualOverdraftAdjustment} is not adjusted for {AccrualCode} upon termination. Use the following keys as placeholders:
- {EventDate}
- {AccrualCode}
- {GrantStartDate}
- {GrantEndDate}
- {CalculatedAdjustment
- {ActualAccrualAdjustment}
- {ActualOverdraftAdjustment}
Message_APChangeOverdraftCommentNote * On {EventDate}, Overdraft {ActualOverdraftAdjustment} is not adjusted for {AccrualCode} upon profile change. Use the following keys as placeholders:
- {EventDate}
- {AccrualCode}
- {GrantStartDate}
- {GrantEndDate}
- {CalculatedAdjustment
- {ActualAccrualAdjustment}
- {ActualOverdraftAdjustment}
Message_NewHireOverdraftCommentNote
*
On {EventDate}, Overdraft {ActualOverdraftAdjustment} is not adjusted for {AccrualCode} when a new employee is hired.
Use the following keys as placeholders:
- {EventDate}
- {AccrualCode}
- {GrantStartDate}
- {GrantEndDate}
- {CalculatedAdjustment
- {ActualAccrualAdjustment}
- {ActualOverdraftAdjustment}
Message_FTEChangeOverdraftCommentNote
*
On {EventDate}, Overdraft {ActualOverdraftAdjustment} is not adjusted for {AccrualCode} when an employee has an FTE contract change.
Use the following keys as placeholders:
- {EventDate}
- {AccrualCode}
- {GrantStartDate}
- {GrantEndDate}
- {CalculatedAdjustment
- {ActualAccrualAdjustment}
- {ActualOverdraftAdjustment}
Message_EarningAmountCommentNote
*
On {EventDate}, {AccrualCode} was adjusted by {CalculatedAdjustment} for the earning amount limit.
Use the following keys as placeholders:
- {EventDate}
- {AccrualCode}
- {GrantStartDate}
- {GrantEndDate}
- {CalculatedAdjustment
- {ActualAccrualAdjustment}
- {ActualOverdraftAdjustment}
Message_CarryoverCommentNote
*
On {EventDate}, {AccrualCode} was adjusted by {CalculatedAdjustment} for the carryover limit.
Use the following keys as placeholders:
- {EventDate}
- {AccrualCode}
- {GrantStartDate}
- {GrantEndDate}
- {CalculatedAdjustment
- {ActualAccrualAdjustment}
- {ActualOverdraftAdjustment}
Message_TerminationCommentNote
*
On {EventDate}, {AccrualCode} was adjusted by {ActualAccrualAdjustment} when an employee is terminated.
Use the following keys as placeholders:
- {EventDate}
- {AccrualCode}
- {GrantStartDate}
- {GrantEndDate}
- {CalculatedAdjustment
- {ActualAccrualAdjustment}
- {ActualOverdraftAdjustment}
Message_NewHireCommentNote
*
On {EventDate}, {AccrualCode} was adjusted by {ActualAccrualAdjustment} when a new employee is hired.
Use the following keys as placeholders:
- {EventDate}
- {AccrualCode}
- {GrantStartDate}
- {GrantEndDate}
- {CalculatedAdjustment
- {ActualAccrualAdjustment}
- {ActualOverdraftAdjustment}
Message_FTEChangeCommentNote
*
On {EventDate}, {AccrualCode} was adjusted by {ActualAccrualAdjustment} when an employee had an FTE contract change.
Use the following keys as placeholders:
- {EventDate}
- {AccrualCode}
- {GrantStartDate}
- {GrantEndDate}
- {CalculatedAdjustment
- {ActualAccrualAdjustment}
- {ActualOverdraftAdjustment}
Message_APChangeCommentNote
*
On {EventDate}, {AccrualCode} was adjusted by {ActualAccrualAdjustment} for the accrual profile change.
Use the following keys as placeholders:
- {EventDate}
- {AccrualCode}
- {GrantStartDate}
- {GrantEndDate}
- {CalculatedAdjustment
- {ActualAccrualAdjustment}
- {ActualOverdraftAdjustment}
Error_MessageAccrualProfileInvalid
*
The Accrual Profile is not valid or not defined.
Accrual Profile not found
Disqualify_MessageEarningAccrualProfileInvalid
*
The Accrual Profile is not effective.
Accrual Profile not effective
Error_MessageInvalidPersonNumber
*
The Person Numberis not valid or not defined.
Person Number not valid
Label_RunSummaryIntegrationTypeValue
*
The value of the Integration Type: {value}
Integration Type
Label_RunSummaryIntegrationTypeKey
*
The key of the Integration Type: {keyName}
Integration Type Key
Label_MessageIntegrationFailed
*
The integration failed because of errors among the records. Check Additional Details for more information such as disqualified records. Integration run failed Label_MessageIntegrationSuccess
*
The integration ran successfully without errors.
Integration ran successfully
Label_RunSummaryIntegrationExecutionId
*
Integration Execution ID: {ID}
Integration Execution ID
Error_MessageHyperfindNotFound
*
The Hyperfind A search engine that filters and selects groups of employees through queries that specify conditions or locations (criteria). query is missing, not valid, or not defined.
Hyperfind not found
Disqualify_MessageEarningAdjustmentNotRequired
*
FTE is at 100%, so accruals earnings do not need to be adjusted.
Earnings adjustment not done
Error_MessageFileNotFound
*
The message file or directory is missing: {FileName}
Message file not found
Label_RunSummaryFailedPayCodeEdits
*
Number of failed paycode edits: {number}
Failed paycode edits
Label_RunSummaryFailedAccrualUpdates
*
Number of failed accruals adjustments: {number}
Failed accruals adjustments
Error_MessageDefaultError
*
An error occurred during the integration run. Refer to Process Reporting for more details.
Integration run error
Error_MessageEnableTermination
*
EnableTermination is missing or not defined.
EnableTermination not found
Error_MessageEnableFTEChange
*
EnableFTEChange is missing or not defined.
EnableFTEChange not found
Error_MessageEnableEarningAmountLimit
*
EnableEarningAmountLimit is missing or not defined.
EnableEarningAmountLimit not found
Error_MessageEnableCarryoverLimit
*
EnableCarryoverLimit is missing or not defined.
EnableCarryoverLimit not found
Error_MessageEnableAccrualsPayout
*
EnableAccrualsPayout is missing or not defined.
EnableAccrualsPayout not found
Error_MessageEnableAccrualProfileChange
*
EnableAccrualProfileChange is missing or not defined.
EnableAccrualProfileChange not found
Message_NoChangeInRerun
*
The employee record is updated already, and no changes are detected to start a rerun. Record already updated Disqualify_MessageEmploymentStatusInvalid
*
The employee's employment status is not valid.
Employment status not valid
Disqualify_MessageAccrualFTEInvalid
*
The employee's Accrual Profile or FTE data is not valid.
Accrual Profile or FTE data is not valid
Label_RunSummaryDisqualifyEmployees
*
The number of employees who are disqualified: {number}
Disqualified employees
Error_MessageEnableHireRehire
*
EnableNewHire is missing or contains a value that is not valid.
EnableHireRehire not found or not valid
Error_MessageForAPIError
*
The integration run failed because of an API error.
API error
Disqualify_MessageInvalidPersonAccrualProfile
*
One or more Accrual Profiles for employees are missing.
Accrual Profiles not found
Disqualify_MessagePersonAccrualProfileConfigError
*
One or more Accrual Profiles for employees are not configured or are not valid.
Accrual Profiles not configured or not valid
Disqualify_MessageInconsistentPersonAccrualProfile
*
One or more Accrual Profiles for employees are not consistent.
Accrual Profiles not consistent
Error_MessageAccrualProfileConfigError
*
An Accrual Profile is not configured or is not valid for prorated accruals adjustment.
Accrual Profile not configured or not valid
Disqualify_MessageAccrBalRollBackFail
*
An accrual balance has a rollback error. Investigate and resubmit the integration in Transaction Assistant Corrects transaction errors in integrations without the need to resubmit entire projects..
Accrual balance rollback error
Error_MessageRerunLookForwardDays
*
LimitsLookForwardDays is not defined or the value is outside the range of 1—366 days.
LimitsLookForwardDays not found or not valid
ProratedAccruals_iPack_v5_RoundingRules_CRT — Get the accrual policies and define the rounding rules for prorated calculations.
When a calculation results in a fractional amount, rounding rules adjust the results to align with the accruals balances and takings policies.
Example: Vacation can be taken only in full or half days. However, an FTE change results in an adjustment of 20 days of vacation entitlement to 15.27 days. Rounding rules can adjust this value down to 15.0 days, up to 15.5 days, or up to 16.0 days, depending on the policy.
Note: For details about rounding and graces, see the Punch Round Rules topic.
The RoundingRule cross-reference table can apply different rounding rules to different combinations of accrual profile and accrual policy.
Example: Unionized employees can have different rounding rules from non-unionized and management-level employees.
- By default, no rounding applies.
- You can use wildcards if similar rounding rules apply to different accrual policies that are assigned to employees.
Column headers:
Accrual Policy,Round (in decimal),Grace (in decimal)
- Accrual Policy = The name of the accrual policy to use to calculate accrual grants. You can use an asterisk (*) as a wildcard.
- Round = Enter a value from 0.01—1.00.
- Grace = Graces determine when shift start and end times round to the previous increment and when they round to the next increment.
Enter a grace value that is equal to or less than the corresponding round amount.
- 0.5 indicates a half day for a day-based accrual and 30 minutes for an hour-based accrual.
- 1.0 represents a full day for a day-based accrual and 1 hour for an hour-based accrual.
- If Round = 1.0 and Grace = 0.49, the rounding is as follows:
An adjustment amount of 10.65 days rounds to 11.0 days.
An adjustment amount of 3:30 hours rounds to 4:00 hours.
An adjustment amount of 5:15 hours rounds to 5:00 hours.
- Repeat for other accrual policies.
-
Select Override to:
- Download the tables when you run the integration
- Edit the table cells in Extensions
- When you finish, click tap OK.
This integration uses an extension table to store accrual adjustments for each employee. During subsequent runs, this integration validates the employee records; if there is no change in an employee's record, that employee's record is not updated in that run.
Create a ProratedAccrualsDB extension table that specifies the DDL commands for the integration template as follows:
Note: For more information, see the Extension Tables topic.
- Click Tap Main Menu
> Administration > Application Setup > System Configuration > Extension Tables. - Click Tap Create
. - In DDL Command Name, enter ProratedAccrualsDB. This name must be unique.
- Enter the following command:
CREATE TABLE ProratedAccrualsDB (
Column1 VARCHAR(255), Column2 VARCHAR(255),
Column3 text, Column4 text, Column5 text,
Column6 text, Column7 text, Column8 text,
Column9 text, Column10 text );
- Click Tap Execute.
This integration exchanges Accrual Codes, Grants, Date Patterns, Accrual Policies, and Accrual Limits for the employees by way of 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.). You upload the SDM file manually and only during the initial run of the integration, or if the accrual setup data has additions or modifications. Otherwise, do not upload the SDM file during subsequent integration runs.
Use SDM to import the accruals data from a compressed file on the SFTP server and export the adjusted accruals data to a comma-separated values (.csv) file on the SFTP server.
- See the Copy Setup Data (Tenant to Tenant) topic.
- See the Export Setup Data (Tenant to File) topic.
- Click Tap Main Menu
> Administration > Setup Data Manager. - From Source, select the tenant.
- In Target, select Create a File.
- In Format, select zip.
- From the left column, select Accrual Codes, Accrual Policies, Date Patterns, Dates, Grants, and Limits.
Caution:
When you select the required Accrual Policies, select Find Dependencies to automatically include all connected building blocks in the export.
- Select only the Accrual Policies that need to be prorated.
- Do not select the entire Accrual Policies category unless all Accrual Policies need to be prorated.
- Click Tap Review and Publish.
- In the Publish Summary, do the following:
- Review the items that will be published to the file.
- Click Tap Publish.
- To monitor the status of the data transfer, click tap Go to Publish History.
- To download the data files, do the following:
- Select the row and click tap View Selected.
- In Target, click tap Download File.
- Navigate to the location on the SFTP server to store the compressed (.zip) file.
- When you finish, click tap Main Menu
> Home.
Note: For more information, see the Configure the SFTP Connection topic.
- Select Main Menu
> Administration > Application Setup > Integrations Setup > Connections. - Click Tap Create
. - Enter the Connection Name.
Example: Prorated Accruals SFTP Server.
- Enter the internal Host.
- Enter the Port for the SFTP account.
- In User, enter the username for the account.
- Enter the Password for the account.
- Click Tap Save.
- Test the connection as follows:
- Select the connection to the SFTP server.
- Click Tap Test
. - Wait for the status message.
The Prorated Accruals integration supports only Hours type paycodes. Create the Hourly Adjustment and Hourly Overdraft paycodes as dummies to use as paycode edits.
Note: For more information, see the Paycode definition topic.
- Select Main Menu
> Administration > Application Setup > Pay Policies > Pay Codes > Pay Code Definition. - Click Tap New.
- In Name, enter Hourly Adjustment.
- In Type, select Standard.
- Select Hours pay codes.
- Click Tap Save & New.
- In Name, enter Hourly Overdraft.
- In Type, select Standard.
- Select Hours pay codes.
- Click Tap Save & Return.
Comments are short, predefined descriptions that are required in prorated accruals. Assign comments to paycode categories.
Note: For more information, see the Paycode definition topic.
- Select Main Menu
> Administration > Application Setup > Common Setup > Comments. - Click Tap New.
- Enter the comment in the Comment Text field.
- In Categories, select Paycodes from Available Categories and move it to Selected Categories.
- Click Tap Save & Return.
This integration uses SDM to do the following:
- Import the accruals data from a compressed file on the SFTP server.
- Export the adjusted accruals data to a comma-separated values (.csv) file on the SFTP server.
Source file properties
- File Type: SDM Export File
- File Name: {configurableFileName}
- File Extension: .zip
- Source Directory: Inbound/*
Target file properties
- File Names: AccrualCodes, Dates, DatePatterns, AccrualLimits, AccrualGrants, AccrualPolicies
- File Extension: .csv
- Delimiter: comma (,)
- Source Directory: Outbound/*
- Header: Yes
- Footer: No
Sample file content
File Name: AccrualCodes.csv
File data:
- Accrual Name: Vacations
- Accrual Type: Days
- Manual Edit: Yes
- Tracking Period: Default Reporting Period
- Is Valid: Yes
- Reason: (Optional)
- Accrual Name: Education
- Accrual Type: Hours
- Manual Edit: Yes
- Tracking Period: Default Reporting Period
- Is Valid: Yes
- Reason: (Optional)
- Accrual Name: Annual Bonus
- Accrual Type: Money
- Manual Edit: Yes
- Tracking Period: Default Reporting Period
- Is Valid: No
- Reason: Unsupported: Money-type accrual codes are ignored by the integration.
File Name: AccrualGrants.csv
File data:
- Grant Name: 1st of Every Month
- Grant Type: Fixed
- Date Pattern: Monthly First
- Award Grant: Repeatedly
- Expiration: Does not expire
- Full Time Equivalents: Adjust grant according to FTE
- Accrual Qualifier: No
- Is Valid: Yes
- Reason: (Optional)
- Grant Name: 6-Month Education Hours
- Grant Type: Fixed
- Date Pattern: Annual DOH
- Award Grant: Repeatedly
- Expiration: Does not expire
- Full Time Equivalents: Do not adjust grant according to FTE
- Accrual Qualifier: No
- Is Valid: No
- Reason: Unsupported: The Full Time Equivalents type is not supported.
- Grant Name: Accruals—Monthly
- Grant Type: Fixed
- Date Pattern: Accruals — Monthly
- Award Grant: Repeatedly
- Expiration: Does not expire
- Full Time Equivalents: Adjust grant according to FTE
- Accrual Qualifier: No
- Is Valid: Yes
- Reason: (Optional)
File Name: AccrualLimits.csv
File Data:
- Limit Name: Taking Limit
- Limit Type: Taking Limit
- Check: Continuous
- Start Month: (Optional)
- Start Day: (Optional)
- End Month: (Optional)
- End Day: (Optional)
- Frequency: 1 Year
- Date Pattern: (Optional)
- Max Limit: (Optional)
- Forgiven Balance: (Optional)
- Is Valid: No
- Reason: Unsupported: Limit type is not supported.
- Limit Name: Annual Carryover January 1st
- Limit Type: Carryover Limit
- Check: (Optional)
- Start Month: (Optional)
- Start Day: (Optional)
- End Month: (Optional)
- End Day: (Optional)
- Frequency: (Optional)
- Date Pattern: Yearly
- Max Limit: (Optional)
- Forgiven Balance: false
- Is Valid: Yes
- Reason: (Optional)
File Name: AccrualPolicies.csv
File Data:
- Accrual Policy Name: 6-month
- Accrual Code: Education hours
- Adjust Balance On FTE Change: Yes
- Grant: 6monthEducation hours
- Length Of Service Reference: (Optional)
- Overdraft Error: (Optional)
- Overdraft Warning: (Optional)
- Future Overdraft Error: (Optional)
- Future Overdraft Warning: (Optional)
- Is Valid: No
- Reason: Unsupported: Grant is not supported or invalid.
- Accrual Policy Name: Education
- Accrual Code: Education
- Adjust Balance On FTE Change: Yes
- Grant: Annually on January 1st
- Length Of Service Reference: (Optional)
- Overdraft Error: 0
- Overdraft Warning: (Optional)
- Future Overdraft Error: 0
- Future Overdraft Warning: (Optional)
- Is Valid: Yes
- Reason: (Optional)
File Name: DatePatterns.csv
File Data:
- Date Pattern Name: 6-month
- Reference Date: Date of Hire
- Frequency: 6 Months
- Pattern Start: Start of Reference Date
- Offset Date Name: Days from Rehire
- FTE Expected Hours: 0:00
- Is Valid: No
- Reason: Unsupported: Offset configuration is not supported.
- Date Pattern Name: 90 days from DOH
- Reference Date: Accruals Date of Hire
- Frequency: 90 Days
- Pattern Start: Start of Reference Date
- Offset Date Name: (Optional)
- FTE Expected Hours: 0:00
- Is Valid: Yes
- Reason: (Optional)
File Name: Dates.csv
File Data:
- Date Name: 1-Jan
- Site Wide: Yes
- Reference Date: 1970-01-01
- Date Name: Accruals Date of Hire
- Site Wide: No
- Reference Date: (Optional)
- Date Name: April 1
- Site Wide: Yes
- Reference Date: 2000-04-01
- Date Name: Biweekly
- Site Wide: Yes
- Reference Date: 2015-02-01
API Title |
URI | Method | Description |
---|---|---|---|
Retrieve Person Extensions Data |
/v1/commons/persons/extensions/multi_read |
POST |
This operation returns multiple person records based on search criteria. |
Accrual Payouts |
/v1/timekeeping/accruals/payouts |
POST |
This operation performs a bulk accrual payout. |
Execute Hyperfind |
/v1/commons/hyperfind/execute |
POST |
This operation executes a Hyperfind query by ID or qualifier and returns the result. |
Retrieve Tenant Default Locale |
/v1/commons/user_preferences/locale_ policy?tenantDefault=true |
GET |
This operation returns the default locale of the tenant. |
Retrieve Employment Terms |
/v1/timekeeping/setup/employment_terms/multi_read |
POST |
This operation returns all employment terms that are available on the tenant. |
Retrieve Locale Policy |
/v1/commons/user_preferences/locale_policy |
GET |
This operation returns the user’s locale policy. |
Paycode Edit Create |
/v1/timekeeping/pay_code_edits/import |
POST |
This operation creates the paycodes. |
Delete PayCode Edits |
/v1/timekeeping/pay_code_edits/multi_delete |
POST |
This operation deletes the paycodes. |
Retrieve Timecard Details |
/v1/timekeeping/timecard_metrics Measures and tracks workforce performance by comparing planned with actual workload or coverage, or by showing variances at any organizational level./multi_read |
POST |
This operation returns the timecard details of the employees. |
Retrieve Setup Pay Codes |
/v2/timekeeping/setup/pay_codes |
GET |
This operation returns all paycodes that are available on the tenant. |
Apply Update |
/v1/timekeeping/accruals/updates |
POST |
This operation updates the accruals data of the employee. |
Retrieve Comments |
/v1/commons/comments |
GET |
This operation returns all comments that are available on the tenant. |
Retrieve Accrual Profiles |
/v2/timekeeping/setup/accrual_profiles |
GET |
This operation returns all accrual profiles that are available on the tenant. |
Retrieve Accrual Codes |
/v2/timekeeping/setup/accrual_codes |
GET |
This operation returns all accrual codes that are available on the tenant. |
Retrieve Base Person |
/v1/commons/persons/base_persons/multi_read |
POST |
This operation returns the details of the person number. |
Accrual Balance Move |
/v1/timekeeping/accruals/moves |
POST |
This operation moves the accruals data from one accrual code to another. |
Fetch User Locales |
/v1/commons/locale_policies/multi_read |
POST |
This operation returns the details about the locale policies. |
Next