Configure the Payroll Import for Healthcare Productivity
The Payroll Import integration imports transactional payroll records automatically from a comma-separated values (CSV) file that you generate from an external payroll system. Use it for ongoing data transfers and to map payroll data to .
Caution: Do not include payroll data for agency employees in the payroll file, include data only for regular employees. For agency employees, see Configure the Agency Export and Import for Healthcare Productivity.
Get the data for the Payroll Import feed
- Export a Payroll*.csv file from the payroll system so that it contains the payroll data exactly as follows:
Caution: - Values in the table cells are enclosed within double quotation marks ("_") in the CSV file; this allows values to include commas (,). Excel filters out these quotation marks, so to see the quotation marks, open the file in Notepad++.
- To avoid errors in Excel, make sure that no table cells contain values that include double quotation marks (") or asterisks (*). Example: If the last character in a data column is a double quotation mark ("), Excel merges the data with data in the next column.
Caution: Import integrations accept only UTF-8 encoded input files.
Note: Multiple files are not supported for this integration, that is, it can run only one file at a time from the SFTP server.
- EMP_NBR (Required): Employee Number
Must be unique across all payroll source files from which data is loaded. Example: 54321
Data type: Character
Maximum length: 15
- EMP_NAM (Optional but helpful for validation or troubleshooting): Employee Name
Example: LastName, FirstName
Data type: Character
Maximum length: 70
- HM_FCLTY_COD (Required): Home Facility Code
Employee's work location based on the business structure
Example: Fac_1
Data type: Character
Maximum length: 50
- HM_DEPT_COD (Required): Home Department Code
Must contain a distinct value for each employee and pay period combination. Example: Dept_01
Employee's department code based on the business structure; you can map the department to the Cost Center and level.
Data type: Character
Maximum length: 50
- JOB_COD (Required): Job Code
Examples: RN, CN
Data type: Character
Maximum length: 50
- STD_HRS (Required): for the
pay period
Cannot be empty; must contain a distinct value for each employee and pay period combination.
If this field does not apply to a record, use 0 for the value.
Example: The number of hours the employee was hired for a pay period. Typically for a biweekly pay period, the standard hours for a full time employee is 80 hours.
Maximum length: 20 digits.
Data type: Number(16:6)
Maximum:
- 10 digits before the decimal
and
- 6 digits after the decimal
Caution: If the imported data contains more than 6 digits after the decimal, an exception occurs and an error message is shown.
Note: If the imported data contains 3 to 6 digits after the decimal, the data is valid. If you open the file in Excel, you may not see all of the decimal values. Instead, open the file in Notepad to confirm that the actual values were imported.
- PAYROLL_EMPLMT_STAT_COD (Required): Payroll Employment
Status Code
Examples: FT, PT
Data type: Character
Maximum length: 30
- PAY_RATE_AMT (Required): Pay Rate
Cannot be empty.
If this field does not apply to a record, use 0 for the value.
Data type: Number(16:6)
Maximum:
- 10 digits before the decimal
and
- 6 digits after the decimal
Caution: If the imported data contains more than 6 digits after the decimal, an exception occurs and an error message is shown.
Note: If the imported data contains 3 to 6 digits after the decimal, the data is valid. If you open the file in Excel, you may not see all of the decimal values. Instead, open the file in Notepad to confirm that the actual values were imported.
- FCLTY_COD (Required): Worked Facility Code
Example: Fac_3
Data type: Character
Maximum length: 50
- DEPT_COD (Required): Worked Department Code
Example: Dept_02
Data type: Character
Maximum length: 50
- PAYROLL_PAYCD (Required): Payroll Paycode
Examples: REG, OT
Data type: Character
Maximum length: 32
- PAYROLL_PAYCD_HRS (Required): Payroll Paycode Hours
Cannot be empty.
If this field does not apply to a record, use 0 for the value.
Data type: Number(16:6)
Data type: Number(16:6)
Maximum:
- 10 digits before the decimal
and
- 6 digits after the decimal
Caution: If the imported data contains more than 6 digits after the decimal, an exception occurs and an error message is shown.
Note: If the imported data contains 3 to 6 digits after the decimal, the data is valid. If you open the file in Excel, you may not see all of the decimal values. Instead, open the file in Notepad to confirm that the actual values were imported.
- PAYROLL_PAYCD_AMT (Required): Payroll Paycode Amount
Cannot be empty.
If this field does not apply to a record, use 0 for the value.
Data type: Number(16:6)
Data type: Number(16:6)
Maximum:
- 10 digits before the decimal
and
- 6 digits after the decimal
Caution: If the imported data contains more than 6 digits after the decimal, an exception occurs and an error message is shown.
Note: If the imported data contains 3 to 6 digits after the decimal, the data is valid. If you open the file in Excel, you may not see all of the decimal values. Instead, open the file in Notepad to confirm that the actual values were imported.
- ASSGND_SHIFT_NAM (Optional): Assigned Shift Name
Examples: DAY, EVE, NIGHT
Data type: Character
Maximum length: 50
- PRI_JOB_COD (Required): Primary Job Code
Must contain a distinct value for each employee and pay period combination.
Examples: RN, CN
Data type: Character
Maximum length: 50
- HIRE_DAT (Optional): Employee Hire Date
Data type: Date
Use the format MM-DD-YYYY.
Maximum length: n/a
- TERM_DAT (Optional): Employee Termination
Date
Data type: Date
Use the format MM-DD-YYYY.
Maximum length: n/a
- PPEND_DAT (Required): Pay Period End
Date
Data type: Date
Use the format MM-DD-YYYY.
Maximum length: n/a
- SRC_COD (Required): Payroll Source Code
Must be a unique code that identifies the payroll source file.
Data type: Character
Maximum length: 40
- Save the file to the folder on the SFTP server.
- Run the payroll import integration as follows:
Note: For detailed instructions and use cases, see the Run and Test Integrations for Healthcare Productivity topic > Payroll Import section.
- Select Main Menu > Maintenance > Integrations.
- Click Tap Run an Integration .
- Select the Payroll Import integration. Click Tap Select.