Contract Workforce Management

In accordance with legislation in India, the Contract Workforce Management extension provides a data storage and report generation mechanism for producing compliance reports that are necessary for submission to local authorities.

Note: This extension, which combines multiple integrations and BIRT reports, is developed outside the normal release schedule to meet specific customer needs; it must be installed by an Integration Consultant. To request one of these extensions, you must submit a request by way of the Gateway Request Portal for BITS, accompanied by a change order.
Organizations in India who employ contract or contingent workers must maintain compliance with the Contract Labour Regulation Act (CLRA). Terminology used in this topic references content in the CLRA.

The CLRA recognizes three primary stakeholders who engage in contract or contingent labor.

  • Principal employer (PE) — The PE retains contract or contingent workers. CLRA requires the PE to acquire a CLRA registration certificate and submit compliance reports regarding the contingent workforce.

  • Contractor — The licensed contractor employs contingent workers for the PE.

  • Contingent worker — The individual who performs the actual work based on skill or trade for the PE.

To meet CLRA requirements, the PE produces certain compliance reports centered on the contingent workforce.

This extension imports and exports data by way of customer provided CSV files stored in a customer managed SFTP folder. It then utilizes the data to fulfill reporting requirements.

Boomi™ integrations:

  • Import and Export: This integration focuses on entity data such as principal employer, contractor, wages, and deductions.

  • People Import: This integration creates or updates people in the application by importing detailed personal data such as name, address, skill, and trade. The integration then assigns system required fields, such as pay rule, license, and accrual profile, from cross-reference table data.

  • Reports: This integration gathers entity and people data to generate all mandatory CLRA reports.

BIRT Reports

Pre-configured mandatory CLRA reports that comply with government-defined standards include:

  • Annual Return

  • Muster Roll

  • Register of Contract Workmen Employed by Contractor

  • Register of Contractors

  • Register of Overtime

  • Register of Wage-Cum-Muster Roll

  • Register of Wages

  • Wage Slip

Each report has a fixed layout; however, you have the option to edit labels in the report properties file. The default branding capabilities in UKG Pro Workforce Management( UKG Pro WFM) provide the opportunity to add the company logo to report headers.

You must configure formulas and parameter values within the CWFM Reports integration to drive wage-specific reports. For example, you define integration parameter values and enter appropriate values within cross reference tables (CRT), like CWFM Report Wages Parameter CRT or CWFM Report Supervisor Overtime Rate CRT.

Wage calculation overview

Wages for contingent workers in India are typically paid on a monthly basis. The integration calculates the employee's wage by totaling each wage head.

  • Daily Wage Heads multiply the number of worked days by basic wages and daily allowances. For example, if the daily Dearness allowance is 50 Indian rupee (INR) and the employee works 26 days during the month, the Dearness allowance contributes (50 INR * 26 days) = 1300 INR to the employee's wage.

  • The types of Daily Wage Heads that you can configure include:

    • Dearness allowance (DA)
    • House Rental allowance (HRA)
    • Conveyance allowance
    • Special allowance
    • Uniform allowance

  • Paycode-driven Wage Heads total hourly or money-type paycodes from the Timecard. For example, when the employee works during the night shift, the corresponding number of worked night hours added by a paycode in the Timecard is multiplied by the hourly shift allowance and then added to the employee's wage.

  • The types of Paycode-driven Wage Heads that you can configure include:

    • Hardship allowance
    • Shift allowance
    • Other allowance
    • Overtime

  • Trade or Skill-driven Wage Heads depend on the skill level of the worker. For example, an amount equal to the daily skill allowance multiplied by the number of work days is added to the employee wage.

  • The types of Trade or Skill-driven Wage Heads that you can configure include:

    • Skill allowance

  • Workmen Type-driven Wage Heads utilize specific wage heads configured in the integration that apply to the employee based on their Workmen Type assignment. For example, if the employee's Workmen Type assignment = NAPS (National Apprenticeship Program Scheme), then the following are excluded from the employee's wage calculation: PF, ESIC, and Canteen deductions.

  • Earnings or Deductions utilize calculation-based wage heads configured in the integration.

  • The types of Earnings calculation-based wage heads include:

    • Advance Bonus
    • Leave with Wages
    • Attendance Award Hardship

  • The types of Deductions calculation-based wage heads include:

    • Provident Fund (PF)
    • ESIC
    • LWF
    • Professional Tax (PT)
    • Canteen Deductions
Note: To ensure success when importing earning and deduction configurations by way of the CWFM Import Export integration, each record must adhere to the format specified by the Earnings and Deductions source file layout. No restrictions exist on the number of earnings or deductions that you can configure in the integration.

Provident Fund (PF) calculation logic

To provide insight into the PF calculation logic, the integration follows this path:

Note: Note: Assume that the PFValue in the CWFM Reports – Wages Parameter CRT is configured as 15,000.
  1. If [(Basic wages + DA + (Earnings/Deductions heads)) <= 15,000], then PF = (12% * 15,000)
  2. If [(Basic wages + DA + (Earnings/Deductions heads)) > 15,000], then
    1. If [(Basic wages + DA) <= 15,000] AND [(Basic wages + DA + (Earnings/Deductions heads)) > 15,000], then PF = (12% * 15,000)
    2. If [(Basic wages + DA) > 15,000] AND [(Basic wages + DA + (Earnings/Deductions heads)) > 15,000], then PF = (12% * (Basic + DA))

Overtime Earnings calculation

To provide insight into the Overtime Earnings calculation, the integration determines the regular and overtime rates before ultimately calculating overtime. To illustrate:

  • Regular rate = [(Basic wage + DA + All paycode-driven wage heads) / 8]
  • Overtime rate = (Regular rate * Overtime multiplier)
  • Overtime earnings = (Overtime rate * Number of overtime hours worked)

Attendance Award calculation

Perfect attendance awards are given to employees who work for a full month, with the exception of holidays and weekly leave. Criteria can differ based on employee gender. This integration offers two variants that you configure in accordance with policy in your organization.

Attendance award calculation – Variant 1

Variant 1 attendance awards apply only when an employee maintains perfect attendance over contiguous months. If the employee fails to achieve perfect attendance for any given month, the award amount decreases to zero for that month and the perfect attendance counter resets, beginning on the first day of the next month.

CWFM Report Attendance Award Variant1 CRT defines the specific configuration for this award option.

Variant 1 – Male employees

When a male employee achieves a perfect attendance with no leave or unexcused absences within the first month, the attendance award is 400 INR.

During the second month, the attendance award increases to 600 INR.

When perfect attendance continues in the third and subsequent months, the maximum attendance award is achieved and the employee is given 800 INR each month.

If the employee takes one leave or has an unexcused absence, the attendance award is reduced to 300 INR in any month that follows a perfect attendance month.

Variant 1 – Female employees

When a female employee achieves a perfect attendance with one leave or unexcused absence within the first month, the attendance award is 400 INR.

During the second month, the attendance award increases to 600 INR.

When perfect attendance continues in the third and subsequent months, the maximum attendance award is achieved and the employee is given 800 INR.

If the employee takes two leaves of absence, or has two unexcused absences, or a combination of a leave and an unexcused absence, the attendance award is reduced to 300 INR in any month that follows a perfect attendance month.

Attendance award calculation – Variant 2

Variant 2 attendance awards apply only when an employee, regardless of gender, has perfect attendance with no leave or unexcused absences within the pay period.

When an employee achieves a perfect attendance within the first month, the attendance award is 500 INR.

Thereafter, in any month following a perfect attendance month, if the employee takes

  • one leave or unexcused absence, the award decreases to 400 INR.
  • two leaves or unexcused absences, the award decreases to 300 INR.
  • three leaves or unexcused absences, the award decreases to 200 INR.

If the employee takes more than three occurrences of leave or unexcused absences, no attendance award is given and the perfect attendance counter resets, beginning on the first day of the next month.

CWFM Report Attendance Award Variant2 CRT defines the specific configuration for this award option.

Paid or Unpaid Days calculation

CLRA Reports, such as the Muster Roll and Annual Return Reports, are governed by paycodes that are added to either the timecard or schedule to indicate employee attendance and wages. You define combinations of data elements within the CWFM Report Worked Hours CRT to identify display patterns that are added to the reports on an employee-by-employee basis. Employee status and display patterns that you must configure include:

  • Present (P): Driven by the Days Worked hours-based paycode in the timecard, the (P) status indicates that the employee is scheduled and punched In on the specified day.
  • Half Day Present (HD): Driven by the Days Worked hours-based paycode in the timecard, the (HD) status indicates that the employee is scheduled and punched In for half of the specified working day. A second display pattern on the same day accounts for the half day absence.
  • Weekly Off (WO): (WO) represents a scheduled day off; it is driven by an appropriate paycode in either the timecard or schedule.
  • Weekly Off Worked (WOW): When the employee works on a scheduled weekly off day, a paycode in the timecard drives the (WOW) status.
  • National Holiday (H): (H) represents a national holiday paycode that is entered in either the schedule or timecard; and applies across all states.
  • National Holiday Worked (HW): When the employee works on a national holiday, (HW) represents a specific paycode that is entered in the timecard.
  • Leave: When a leave paycode or a GTOR is applied to either the timecard or schedule, the appropriate short leave code is added to the report. Short leave codes include values, such as SL, CL, and EL.
  • Absent (A): When the employee is scheduled but fails to punch, an unexcused absence (A) is added to the report.
  • Public Holiday (PH): State-specific holidays (PH), indicate a paycode in either the timecard or schedule.
  • Public Holiday Worked (PHW): When the employee works on a state-specific holiday, (PHW) represents an explicit paycode that is entered in the timecard.
  • Unexcused Presence (UP): When an employee is not scheduled but punches In to work, the day is noted with (UP).
Note: Paycodes that you associate with each employee status and display pattern must be configured in UKG Pro Workforce Management. Select only those paycodes that represent working hours. For example, the paycode entered in the Timecard when an employee takes leave indicates non-working hours; do NOT select this paycode when constructing the CWFM Report Worked Hours CRT.

Considerations and limitations

  • Function access profiles assignments for those who operate the integrations must permit appropriate integration access.

  • You can restrict access to integration run details and data export files in the Run Summary so that people can view only the integrations and data that they run and not the integrations and data that other people run.

  • Access and maintenance of SFTP folder structure must be managed outside of the application.

  • Monitor the archive, error, and export SFTP file locations to ensure sufficient storage for essential files.

  • Files older than 30 days are automatically deleted.

  • Default, concurrent processing is limited to 15 integrations on the customer tenant.

  • Source files must adhere to certain specifications, such as:

    • Column order must adhere to the specified column sequence number.

    • Column headings must be separated with commas; spaces are not allowed.

    • Only files with CSV extensions are supported.

  • Import integrations generate archive files associated with each source file.

  • Import integrations can be configured to validate source data prior to import into the system. Error files capture incorrect data, which allows reimport after manual adjustment.

CWFM Import Export integration:

  • The CWFM Import Export integration parameter DateFormat specifies the format of dates in source files.

CWFM People Import integration:

  • Do not run the CWFM People Import integration as a system user.

  • The CWFM People Import integration parameter SourceDateFormat specifies the format of Dates in source files.

  • The people import integration automatically generates individual numbers when creating new employees if the CWFM People Import integration parameter CreateUniqueEmployeeID is Yes. This new person number appears in all CRLA reports. The new person number must be added to source data files for any subsequent imports that update or terminate employee records.

  • To ensure success, configure all necessary items before executing the people import integration.

  • The primary employer and contractor must be defined in the business structure prior to importing people data.

  • Gender, marital status, and blood group must match predetermined values.

  • Contractors are not permitted to hire more employees than is stated by their license capacity. The integration rejects people who exceed the contractor’s license capacity.

  • Formerly banned employees cannot be rehired.

  • Aadhaar number assignments are unique. When the import attempts to create a new employee with an Aadhaar number that is already assigned to an employee in the application, the integration rejects that record.

  • Basic and DA values in the WageDetails source file must be greater than or equal to Min Wage – Basic and Min Wage DA values in the MinimumWage source file.

CWFM Reports integration:

  • Do notrun the CWFM Reports integration as a system user.

  • All entities like principal employer, contractor, and people must be created before generating any CLRA reports.

  • The Wage Slip report is limited to 20 locations.

CWFM Reports

  • Report formats limit the maximum combination of employees and days that a report generates.

    Report limitations

    Report limitations

    Report format

    Maximum number of employees selected in the location

    Maximum number of days

    PDF

    <=10,000

    365

    PDF

    >10,000 <=25,000

    15

    Excel (XLSX)

    <=10,000

    365

User experience

A Human Resources (HR) Manager is responsible for maintaining entity and personal data related to the contractual or contingent workforce engaged at the company.

Data Import

CSV data files that contain entity related data are uploaded to the customer managed SFTP server.

The HR manager initiates the integration, and then selects the import option and multiple file types from the slider before proceeding.

When the integration completes, source files are moved to the archive folder, the run summary displays filenames and successful record counts. The integration lists files that are associated with data validation errors captured by the integration.

The HR manager reviews error files, corrects data errors, and then executes the import again.

Data Export

The HR manager acknowledges that over the course of time, changes were made to the entity related data. To acquire a clear understanding of the current state of the data, the HR manager exports the data using the integration.

When the integration finishes, the run summary displays the number of processed records for each record type. The HR manager downloads the CSV files and then analyzes them.

People Import

CSV data files that contain people related data are uploaded to the customer managed SFTP server.

The HR manager initiates the integration, and then selects the appropriate file from the slider before proceeding.

When the integration completes, source files are relocated to the archive folder, the run summary displays successful and disqualified record counts, as well as subsections that list related issues. Additional details display preloading validation and mandatory field checks performed by the integration.

The HR manager reviews the error file, corrects data errors, and then executes the import again.

Reports

The HR manager initiates the reports integration to initiate one or more CLRA reports. The manager selects a report, Hyperfind or location query, reporting period or date range.

When the integration finishes, the manager locates the Report Library page to download and view the completed report.

CWFM — Common Abbreviations

Refer to the table for common CWFM-related abbreviations.

CWFM — Common Abbreviations

CWFM — Common Abbreviations

Abbreviation

Definition

BOCW

Building and Other Construction Workers

CWFM

Contract Workforce Management

DA

Dearness Allowance — In India, Dearness Allowance (DA) is a cost-of-living adjustment paid by employers to employees and pensioners to mitigate the impact of inflation. DA is a percentage of the basic salary.

EPF

Employee Provident Fund

EPFO

Employees' Provident Fund Organization

ESI

Employee State Insurance

ESIC

Employee State Insurance Corporation — A statutory body that implements the provisions of the Employees' State Insurance Act, 1948, providing social security benefits to workers in certain contingencies such as sickness, maternity, temporary or permanent disablement, and death due to employment injury.

GSTIN

Goods And Services Tax Identification Number — A 15-digit alphanumeric code that serves as a unique identifier for businesses registered under the Goods and Services Tax (GST) regime.

HRA

House Rental Allowance — HRA is a component of an employee's salary that is provided by the employer to cover the cost of renting accommodation. It is a partially tax-exempt allowance under Section 10(13A) of the Income Tax Act.

ISMW

Interstate Migrant Worker

LL

Labor License

LWF

Labor Welfare Fund

The Labour Welfare Fund is a statutory contributory fund managed by the individual state governments in India to provide welfare benefits to workers.

The purpose of the LWF is to provide housing, medical care, educational, and recreational facilities to workers and their dependents to improve their working conditions and standard of living.

PE

Principal Employer

PF

Provident Fund — A mandatory retirement savings scheme for employees in India.

UAN

Universal Account Number — In India, the Universal Account Number (UAN) is a 12-digit unique identification number assigned to each salaried employee contributing to the Employee Provident Fund (EPF). It is issued by the Employees' Provident Fund Organization (EPFO) under the Ministry of Labour and Employment.

WC

Workmen Compensation — A non-contributory scheme that provides compensation to workers in case of workplace accidents or death, according to the Workmen Compensation Act, 1923.

CWFM Import Export integration

CWFM Import Export — 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.
  1. Get the URL, User, and Password for the APIGatewayServer.
  2. 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 Contract Workforce Management 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 Select items.

  3. Configure the CWFM Import Export 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 Search button. It can take several seconds before the button becomes active.

      3. Scroll to and select the integration pack: CWFM Import Export > CWFMImportExport_iPack_v1.

  4. 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.
    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

      CWFMImportExport_iPack_v1_APIGatewayServer

      Required

      To change the default API gateway server:

      1. Clear Use Default.
      2. Enter the URL to the server.
        Example: <tenantURL>/api

      CWFMImportExport_iPack_v1_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:

      1. For each field, clear Use Default.
      2. 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.
      CWFMImportExport_iPack_v1_ExtensionConnection Required

      Provide the connection details for Extension Table where data is stored:

      • User
      • Password
      • Class Name
      • Connection URL

      CWFMImportExport_iPack_v1_ImportValidation_CRT

      		Required Enable Override.

      CWFMImportExport_iPack_v1_SFTPParameter_CRT

      		Required Enable Override.

      CWFMImportExport_iPack_v1_Locale_CRT

      		Required Enable Override.
  5. Configure process properties
    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 CWFMImportExport_iPack_v1_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 properties

      Process property name

      Column header value

      _CWFMImportExport_iPack_v1__ImportValidation_CRT

      Validation Name,Is Applicable,Value

      _CWFMImportExport_iPack_v1_SFTPParameter_CRT

      Filename,Import File Name,Import Location,File Sequence,Export File Name,Export File Location,Archive File Location

      _CWFMImportExport_iPack_v1_Locale_CRT

      Parameter Name,Locale Policy,Message,Description

CWFM Import Export — Configure the 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.

CWFM Import Export — Application Setup

  1. Configure Access to Integrations.

  2. Configure the following:

    • Integration List Parameters: Create integration list parameters that identify the actions and contract workforce management files. See the Configure Integration List Parameters topic.

      Examples include:

    Name: ContractWorkForceManagement_ActionType

    Description: Action types applicable to Contract Workforce Management Import Export.

    Parameter values:

    Parameter values:

    Name

    Description

    Value

    Default value

    Export

    This parameter applies to export functionality.

    Export

    No

    Import

    This parameter applies to import functionality.

    Import

    Yes

    Name: ContractWorkForceManagement_Files

    Description: Files applicable to Contract Workforce Management Import Export.

    Parameter values:

    Parameter values:

    Name

    Description

    Value

    Default value

    Contractor Compliance

    Enables selection of the Contractor Compliance file.

    ContractorCompliance

    No

    Contractor Master

    Enables selection of the Contractor Master file.

    ContractorMaster

    No

    Deductions – Labor Welfare

    Enables selection of the LWF Deduction file.

    LWFDeduction

    No

    Deductions – Professional tax

    Enables selection of the PT Deduction file.

    PTDeduction

    No

    Deductions – SCC

    Enables selection of the Service Charge file.

    ServiceCharge

    No

    Earnings/Deduction – Master

    Enables selection of the Earnings Deduction file.

    EarningsDeduction

    No

    Minimum wage master

    Enables selection of the Minimum Wage file.

    MiniumWage

    No

    Principal Employer

    Enables selection of the Principal Employer file.

    PrincipalEmployer

    No

    Workmen Wage Details

    Enables selection of the Wage Detail file.

    WageDetails

    No

    Trade Skill Wages Detail

    Enables selection of the Trade Skill Wage Detail file.

    TradeSkillWagesDetail

    No

  • SFTP connection: Configure the SFTP Connection. See the Configure the SFTP Connection topic.

  • Extension tables: Configure the CWFM Import Export extension tables. See the Extension Tables topic.

    For each extension table, enter the following in the DDL Command Name and Commands for execution fields:

DDL Command Name: Principal Employer

Commands for execution:

CREATE TABLE principalemployertable
(
address VARCHAR(255),
bocwact VARCHAR(255),
district VARCHAR(255),              
esinumber VARCHAR(255),
factorylicensenumber VARCHAR(255),
factorymanageremailaddress VARCHAR(255),
factorymanagername VARCHAR(255),
ismwactapplicability VARCHAR(255),
lastmodifiedby VARCHAR(255),
lastmodifieddate VARCHAR(255),
lwfnumber VARCHAR(255),
maxnoofcontractemployees VARCHAR(255),
maxnoofworkmen VARCHAR(255),
occupiername VARCHAR(255),
pfcodepevalidation15 VARCHAR(255),
principalemployerid VARCHAR(255),
professionaltaxnumber VARCHAR(255),
state VARCHAR(255),
talukatehsil VARCHAR(255),
typeofbusiness VARCHAR(255),
unitname VARCHAR(255),
wcnumber VARCHAR(255)
);

DDL Command Name: Contractor Master

Commands for execution:

CREATE TABLE contractormastertable
(
contractoraddress VARCHAR(255),
contractorcode VARCHAR(255),
contractorname VARCHAR(255),
emailaddress VARCHAR(255),
lastmodifiedby VARCHAR(255),
lastmodifieddate VARCHAR(255),
managername VARCHAR(255),
mobileno VARCHAR(255)
);

DDL Command Name: Contractor Compliance

Commands for execution:

CREATE TABLE contractorcompliancetable
(
contractenddate VARCHAR(255),
contractorcode VARCHAR(255),
contractorcoverage VARCHAR(255),
contractstartdate VARCHAR(255),
effectivedate VARCHAR(255),
esinumber VARCHAR(255),
esivalidfrom VARCHAR(255),
esivalidto VARCHAR(255),
gstnumber VARCHAR(255),
ismwapplicability VARCHAR(255),
laborwelfarefund VARCHAR(255),
lastmodifiedby VARCHAR(255),
lastmodifieddate VARCHAR(255),
licensenumber VARCHAR(255),
lvalidityenddate VARCHAR(255),
lvaliditystartdate VARCHAR(255),
natureofwork VARCHAR(255),
peidvarchar VARCHAR(255),
pfapplydate VARCHAR(255),
pfnumber VARCHAR(255),
professionaltax VARCHAR(255),
totalstrengthcontractor VARCHAR(255),
wcno VARCHAR(255),
wcvalidfrom VARCHAR(255),
wcvalidto VARCHAR(255)
);

DDL Command Name: Service Charge

Commands for execution:

CREATE TABLE servicechargecontractortable
(
effectivedate VARCHAR(255),
"IN(%ORPERHEAD)" VARCHAR(255),
lastmodifiedby VARCHAR(255),
lastmodifieddate VARCHAR(255),
principalempid VARCHAR(255),
servicechargeonovertime VARCHAR(255),
servicechargeonsalary VARCHAR(255),
serviceprovidercode VARCHAR(255)
);

DDL Command Name: Earning Deduction

Commands for execution:

CREATE TABLE earningsdeductiontable
(
actualvalue VARCHAR(255),
calminwageorempwage VARCHAR(255),
dateapplicable VARCHAR(255),
earningordeduction VARCHAR(255),
lastmodifiedby VARCHAR(255),
lastmodifieddate VARCHAR(255),
monthlyordaily VARCHAR(255),
skill VARCHAR(255),
trade VARCHAR(255),
unitcode VARCHAR(255),
wagehead VARCHAR(255),
wageheadoramount VARCHAR(255),
wageheadpercentagecal VARCHAR(255),
"WORKMAN TYPE" VARCHAR(255)
);

DDL Command Name: Minimum Wage

Commands for execution:

CREATE TABLE minimumwagetable
(
"CATEGORY/SKILL" VARCHAR(255),
effectivedate VARCHAR(255),
lastmodifiedby VARCHAR(255),
lastmodifieddate VARCHAR(255),
minimumbasic VARCHAR(255),
minimumda VARCHAR(255),
minimumhra VARCHAR(255),
minimumothers VARCHAR(255),
trade VARCHAR(255),
unitsapid VARCHAR(255)
);

DDL Command Name: Wage Details

Commands for execution:

CREATE TABLE wagedetailstable
(
aadharnumber VARCHAR(255),
basic VARCHAR(255),
contractorcode VARCHAR(255),
conveyanceallowance VARCHAR(255),
da VARCHAR(255),
effectivedate VARCHAR(255),
employeeid VARCHAR(255),
hardshipallowance VARCHAR(255),
hra VARCHAR(255),
lastmodifiedby VARCHAR(255),
lastmodifieddate VARCHAR(255),
skillallowance VARCHAR(255),
specialallowance VARCHAR(255),
uniformallowance VARCHAR(255),
unitsapid VARCHAR(255),
washingallowance VARCHAR(255)
);

DDL Command Name: PT Deduction

Commands for execution:

CREATE TABLE ptdeductiontable
(
amount VARCHAR(255),
effectivedate VARCHAR(255),
endmonth VARCHAR(255),
gender VARCHAR(255),
lastmodifiedby VARCHAR(255),
lastmodifieddate VARCHAR(255),
maxgrosssalary VARCHAR(255),
mingrosssalary VARCHAR(255),
startmonth VARCHAR(255),
unit VARCHAR(255)
);

DDL Command Name: LWF Deduction

Commands for execution:

CREATE TABLE lwfdeductiontable
(
amount VARCHAR(255),
"AMOUNT/PERCENT" VARCHAR(255),
effectivedate VARCHAR(255),
empcontributionvalue VARCHAR(255),
frequency VARCHAR(255),
lastmodifiedby VARCHAR(255),
lastmodifieddate VARCHAR(255),
principalemployerid VARCHAR(255),
upperlimit VARCHAR(255)
);

DDL Command Name: Trade Skill Wages Detail

Commands for execution:

CREATE TABLE TradeSkillWagesDetailTable
(
UnitSapID VARCHAR(255),
Trade VARCHAR(255),
Skill VARCHAR(255),
Basic VARCHAR(255),
DA VARCHAR(255),
HRA VARCHAR(255),
ConveyanceAllowance VARCHAR(255),
SpecialAllowance VARCHAR(255),
SkillAllowance VARCHAR(255),
WashingAllowance VARCHAR(255),
UniformAllowance VARCHAR(255),
HardshipAllowance VARCHAR(255),
EffectiveDate VARCHAR(255),
lastmodifiedby VARCHAR(255),
lastmodifieddate VARCHAR(255)
);

CWFM Import Export — 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.

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.

CWFMImportExport_iPack_v1__ImportValidation_CRT: Identifies the verification requirements that entity data must meet before it is imported into the system.

CWFM Import Export — Import Validation CRT structure

CWFM Import Export — Import Validation CRT structure

Column name

Description

Validation Name

Name of the validation applied to imported data.

Supported values are limited to:

WageTypeValue

PFCodeLength

FrequencyValue

ESICNumberLength

EarningDeductionMasterValue

DAWage

BasicWage

AmountPercentMasterValue

Is Applicable

Boolean value that determines whether validation is required.

Value

Value for which validation is performed.

CWFM Import Export — Import Validation CRT sample content

CWFM Import Export — Import Validation CRT sample content

Validation Name

Is Applicable

Value

WageTypeValue

Yes

Earned / Employee wage / Minimum wage

PFCodeLength

Yes

15

FrequencyValue

Yes

Daily / Monthly / Yearly

ESICNumberLength

Yes

17

EarningDeductionMasterValue

Yes

Earning / Deduction

DAWage

Yes

>min DAWage

BasicWage

Yes

>min BaseWage

AmountPercentMasterValue

Yes

Amount / Percent

CWFMImportExport_iPack_v1_SFTPParameter_CRT: Controls the SFTP location and data file information.

CWFM Import Export — SFTP Parameter CRT structure

CWFM Import Export — Import Validation CRT structure

Column name

Description

File Name

Name of the file for which the location must be configured.

Supported values are limited to:

ContractorCompliance

ContractorMaster

PrincipalEmployer

WageDetails

MinimumWage

EarningsDeduction

LWFDeduction

PTDeduction

ServiceCharge

TradeSkillWagesDetail

Import File Name

Import file name.

Note: You can use an asterisk ( *) as a wildcard.

Import Location

Import file location.

File Sequence

Priority processing order of the associated file.

Export File Name

Export file name.

Export File Location

Export file location.

Archive File Location

Archive file location.

CWFMImportExport_iPack_v1_Locale_CRT: Allows translation of messages and labels into different languages.

CWFM Import Export — Locale CRT structure

CWFM Import Export — Locale CRT structure

Column name

Description

Parameter Name

Key for which localization is defined.

Locale Policy

Locale Policy.

Note:

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, or value of the label defined in the Run Summary section.

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").

CWFM Import Export — Locale CRT sample content

CWFM Import Export — Locale CRT sample content

Parameter Name

Locale Policy

Message

Description

Error_DeleteFileNotFound

*

Delete File name not found.

When DeleteFileName was not found in SFTP Lookup.

Error_DuplicateRecords

*

This record already exists in database.

Error_FileNameNotMatched

*

Selected List File does not match the File parameter name.

When selected List parameter does not match the text parameter.

Error_FileNotSelected

*

File name is not configured.

When a file was selected during configuration of the List parameter.

Error_InvalidAppendTimeStamp

*

Invalid AppendTimeStamp configured.

When an incorrect AppendTimeStamp is passed by the integration.

Error_InvalidDateFormat

*

Invalid DateFormat configured.

When an incorrect DateFormat is passed by the integration.

Error_PatternNotMatched

*

File pattern does not match the CRT definition.

When the text pattern passed does not match the CRT configuration for the respective file.

Error_SFTPConnecttionError

*

Unable to connect to SFTP.

Unable to connect to SFTP.

Label_ContractorComplianceProcessedRecords

*

Contractor Compliance Processed Records

Label_ContractorMasterProcessedRecords

*

Contractor Master Processed Records

Label_EarningsDeductionProcessedRecords

*

Earnings Deduction Processed Records

Label_ExportFiles

*

Export Files

Label_FailedExportFiles

*

Failed Export Files

Label_FailedImportFiles

*

Failed Import Files

Label_Importedfile

*

Imported file

Label_ImportFiles

*

Import Files

Label_IntegrationExecutionId

*

Integration Execution ID

Label_IntegrationTypeName

*

Integration Type

Label_LWFDeductionProcessedRecords

*

LWF Deduction Processed Records

Label_MinimumWageProcessedRecords

*

Minimum Wage Processed Records

Label_PrincipalEmployerProcessedRecords

*

Principal Employer Processed Records

Label_PTDeductionProcessedRecords

*

PTDeduction Processed Records

Label_ServiceChargeContractorProcessedRecords

*

Service Charge Contractor Processed Records

Label_TradeSkillWagesDetailDeletedRecords

*

Trade Skill Wage Detail Deleted Records

Label_TradeSkillWagesProcessedRecords

*

Trade Skill Wages Processed Records

Label_WageDetailsProcessedRecords

*

Wage Details Processed Records

Message_AdditionalDetailsWithErrors

*

Integration completed with errors.

Message_AdditionalDetailsWithoutErrors

*

Integration completed without errors.

Message_ContractorCodeNotPresentContractorMaster

*

ContractorCode not present in Contractor Master.

Message_IncorrectAmountPercent

*

Incorrect Percent/Amount Value Provided.

Message_IncorrectBasicDAWage

*

Incorrect DA Wage Provided (less than amount in minimum wage table).

Message_IncorrectBasicWage

*

Incorrect Basic Wage Provided (less than amount in Minimum Wage Table).

Message_IncorrectDateFormat

*

Incorrect Date Format in file.

Message_IncorrectEarningDeduction

*

Invalid value in "Earning or Deduction" column.

Message_IncorrectEffectiveDate

*

Effective Date range for this record cannot be found in Minimum Wage table.

Message_IncorrectESICNumber

*

Incorrect number of characters defined for the ESIC Number.

Message_IncorrectFrequencyValue

*

Incorrect Frequency Value defined.

Message_IncorrectPFCodeLength

*

Incorrect PF Code Length Provided.

Message_IncorrectWageType

*

Incorrect Value in "Minimum or Employee Wage" column.

Message_MandatoryFieldRequired

*

Empty mandatory field <FieldName>.

Message_PEandContractorNotFound

*

Principal Employer and/or Contractor not found in the system.

Message_PEIDNotPresentMinimumWage

*

This PE ID does not exist in the Minimum Wage table.

CWFM Import Export — Install the 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.
  1. Select Main Menu Administration > Application Setup > Integrations Setup > Install Integrations.
  2. Click Tap Create .
  3. In Integration Name enter a unique name, such as CWFMImportExport_iPack_v1.
  4. (Optional) Enter a Description.
    Note: Do not select API Integration.
  5. In File Access, select Source/Output Download to select a connection.
  6. (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.
  7. (Optional) Select Re-Run to allow repeated runs of the integration with the same parameter values as the previous run.
  8. (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.

  9. 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.
  10. Configure Integration template and parameters:
    1. In Integration Template, select CWFMImportExport_iPack_v1.
    2. Click Tap Assign .
    3. In Integration Parameters, you can override default settings. Click Tap Create.
    4. Complete the configuration for each integration parameter value.
    5. Click Tap Save.

      Repeat this step for each integration control parameter that supports the CWFM Import Export process.

      CWFM Import Export — Integration Parameters

      Integration Parameters

      Parameter name

      Description / Default value / User prompt

      Template parameter

      Parameter type

      ActionType

      List that contains the action choices.

      Parameter value = ContractWorkForceManagement_ActionType

      User prompt = Yes

      Mandatory = Yes

      ActionType

      Dropdown

      File(s)

      List that contains import and export files.

      Parameter value = ContractWorkForceManagement_Files

      User prompt = Yes

      Mandatory = Yes

      File(s)

      List

      DateFormat

      Date format to which all dates in the import and export files must adhere.

      Supported values include:

      MM/dd/yyyy

      MM-dd-yyyy

      dd/MM/yyyy

      dd-MM-yyyy (default)

      yyyy/MM/dd

      yyyy-MM-dd

      DateFormat

      Text

      AppendDateTimeStamp

      Date and time format to which the integration adheres when appending the date and time to archive and error files.

      Supported values include:

      dd-MM-yyyy'T'hhmmSSS (default)

      MM-dd-yyyy'ThhmmSSS

      User prompt = No

      Mandatory = Yes

      AppendDateTimeStamp

      Text

      DeleteFilePrefix

      Prefix that identifies import files which will be deleted.

      Default = DELETE

      User prompt = No

      Mandatory = Yes

      DeleteFilePrefix

      Text

      Principal Employer File Name

      Name used to identify the principal employer file.

      User prompt = Yes

      Mandatory = No

      PrincipleEmployerFileName

      Text

      Contractor Compliance File Name

      Name used to identify the contractor compliance file.

      User prompt = Yes

      Mandatory = No

      ContractorComplianceFileName

      Text

      Contract Master File Name

      Name used to identify the contract master file.

      User prompt = Yes

      Mandatory = No

      ContractMasterFileName

      Text

      Workman Wage Details File Name

      Name used to identify the workman wage details file.

      User prompt = Yes

      Mandatory = No

      WorkmanWageDetailsFileName

      Text

      Minimum Wages File Name

      Name used to identify the minimum wages file.

      User prompt = Yes

      Mandatory = No

      MinimumWagesFileName

      Text

      Deduction Labour Welfare Fund File Name

      Name used to identify the Deduction Labor Welfare Fund file.

      User prompt = Yes

      Mandatory = No

      DeductionLabourWelfareFundFileName

      Text

      Deduction Professional Tax File Name

      Name used to identify the deduction professional tax deduction file.

      User prompt = Yes

      Mandatory = No

      DeductionProfessionalTaxFileName

      Text

      Deduction Service Charge Con File Name

      Name used to identify the service charge con deduction file.

      User prompt = Yes

      Mandatory = No

      DeductionServiceChargeFileName

      Text

      Earning Deduction Master File Name

      Name used to identify the earning deduction master file.

      User prompt = Yes

      Mandatory = No

      EarningDeductionMasterFileName

      Text

      ErrorOutputDirectory

      Location where error files are generated.

      Default = /Outbound/Error

      User prompt = No

      Mandatory = Yes

      OutputDirectory

      Text

      SFTPAction

      SFTP Action to perform when files with the same name exist in the remote directory.

      Supported case-sensitive values include:

      Create New Name

      Append

      Overwrite (default)

      Error

      User prompt = No

      Mandatory = Yes

      Action

      Text

      IsNewWageDetailsApplicable

      Determines whether to import or export the trade skill wages detail table.

      Default = true

      User prompt = No

      Mandatory = Yes

      IsNewWageDetailsApplicable

      Text

      SupportUsers

      Semicolon-separated list of person numbers that identifies individuals who are allowed to export data.

      User prompt = No

      Mandatory = No

      SupportUsers

      Text

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

    See Configure Access to Integrations.

CWFM Import Export — Run and test the integration

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

  1. Run the integration
    1. Select the integration:
      1. Select Main Menu Maintenance > Integrations.
      2. Click Tap Run an Integration .
      3. Select the CWFMImportExport_iPack_v1 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:
      • Action Type: Select the action type to perform.
      • File(s): Chose the file or files for the import or export action.
      • Principal Employer File Name: Select the Principal Employer file.
      • Contractor Compliance File Name: Select the Contractor Compliance file.
      • Contract Master File Name: Select the file.
      • Workman Wage Details File Name: Select the Contract Master file.
      • Minimum Wages File Name: Select the Minimum Wages file.
      • Deduction Labour Welfare Fund File Name: Select the Deduction Labour Welfare Fund file.
      • Deduction Professional Tax File Name: Select the Deduction Professional Tax file.
      • Deduction Service Charge Con File Name: Select the Deduction Service Charge Con file.
      • Earning Deduction Master File Name: Select the Earning Deduction Master file.
    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.
  2. 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.

CWFM Import Export integration — Source file specifications

Contractor Compliance

Contractor Compliance — Source file overview

Contractor Compliance — Source file overview

Name

Value

File name

ContractorCompliance

File extension

CSV

Format

Comma-delimited

Source directory

/Inbound/ContractWorkforceManagement/ContractorCompliance

Header row

Yes

Header count

23

Footer row

No

Contractor Compliance — Source file layout

Contractor Compliance — Source file layout

Column sequence #

Name

Type

Description

Mandatory

1

PE ID

Alphanumeric

Identifies the principal employer.

Yes, must be configured in the application as a business structure node name.

2

Contractor Code

Alphanumeric

Identifies the contractor. For example, the vendor code defined in SAP/ERP.

Yes, must be configured in the application as a business structure node name.

3

License Number

Alphanumeric

Contractor labor license number.

Yes

4

License Validity Start Date

Date

LL validity start date.

Yes

5

License Validity End Date

Date

LL validity end date.

Yes

6

Contractor Coverage (Contractor license capacity)

Alphanumeric

Total coverage according to the labor license.

This represents the schedule coverage for a day; the contractor cannot deploy more than the coverage amount.

Yes

7

Total Strength

Alphanumeric

Total number of employees employed by the contractor.

No

8

Nature of Work

Alphanumeric

The type of work performed, such as housekeeping, security services, piece rates.

No

9

Contract Start Date

Date

Contract start date assigned to a contractor.

Yes

10

Contract End Date

Date

Contract end date assigned to a contractor.

Yes

11

ESI Number

Alphanumeric

The contractor's ESI or WC policy number.

Yes, either the ESI or WC number must be included in the source file.

12

WC/ESI Valid From

Date

ESI or WC policy start date.

No

13

WC/ESI Valid To

Date

ESI or WC policy end date.

No

14

WC Number

Alphanumeric

WC policy number.

Yes, either the WC or ESI number must be included in the source file.

15

WC Valid From

Date

WC start date.

No

16

WC Valid To

Date

WC end date.

No

17

PF Number

Alphanumeric

Contractor's PF policy number.

Yes, the policy number must contain 15 characters.

18

PF Apply Date

Alphanumeric

PF application date.

When the PF number is not completed, the PF application date is used.

No

19

Labour Welfare Fund

Alphanumeric

No

20

Professional tax

Alphanumeric

No

21

GST Number

Alphanumeric

No

22

ISMW applicability

Alphanumeric

No

23

Effective Date

Date

No

Note:

With the exception of Effective Date, the integration checks for and then rejects duplicate rows.

The Contractor Code is validated against the contractor code business structure node name. The integration rejects records without a match.

Each record must contain only one of the following: ESI Number, WC Number.

Records that contain both ESI Number and WC Number are rejected.

Records that contain ESI Number must contain ESI Valid From and ESI Valid To.

Records that contain WC Number must contain WC Valid From and WC Valid To.

Contractor Master

Contractor Master — Source file overview

Contractor Master — Source file overview

Name

Value

File name

ContractorMaster

File extension

CSV

Format

Comma-delimited

Source directory

/Inbound/ContractWorkforceManagement/ContractorMaster

Header row

Yes

Header count

6

Footer row

No

Contractor Master — Source file layout

Source file layout - Contractor Master

Column sequence #

Name

Type

Description

Mandatory

1

Contractor Code

Alphanumeric

Identifies the contractor. For example, the vendor code defined in SAP/ERP.

Yes, must be configured in the application as a business structure node name.

2

Contractor Name

Alphanumeric

Contractor name.

No

3

Contractor Address

Alphanumeric

Contractor address.

No

4

Mobile Number of the contractor

Alphanumeric

Contractor contact mobile number

No

5

Manager Name

Alphanumeric

Contractor manager name.

No

6

Email Address

Alphanumeric

Email address.

No

Note:

The integration checks for and then rejects duplicate rows.

The Contractor Code is validated against the contractor code business structure node name. The integration rejects records without a match.

Principal Employer

Principal Employer — Source file overview

Principal Employer — Source file overview

Name

Value

File name

PrincipalEmployer

File extension

CSV

Format

Comma-delimited

Source directory

/Inbound/ContractWorkforceManagement/PrincipalEmployer

Header row

Yes

Header count

20

Footer row

No

Principal Employer — Source file layout

Principal Employer — Source file layout

Column sequence #

Name

Type

Description

Mandatory

1

PE ID

Alphanumeric

Identifies the principal employer.

Yes, must be configured in the application.

2

PEName

Alphanumeric

Principal employer name.

No

3

Address

Alphanumeric

Principal employer address.

No

4

Taluka

Alphanumeric

Principal employer address — district subdivision.

No

5

District

Alphanumeric

Principal employer address — district.

No

6

State

Alphanumeric

Principal employer address — state.

No

7

Factory Manager Name

Alphanumeric

Factory manager name.

No

8

Manager Email Address

Alphanumeric

Factory manager address.

No

9

Occupier Name

Alphanumeric

Business owner name.

No

10

Type of Business

Alphanumeric

Type of business associated with the principal employer. For example, manufacturing plant, office, power transmission.

No

11

Max No. of Workmen

Numeric

Maximum number of workers approved to work for a plant.

No

12

Max No. of Contract Employees

Numeric

Maximum number of contract workers approved to work for a plant.

No

13

BOCW Act

Boolean

Determines whether BOCW applies to the PE.

No

14

ISMW Act applicability

Boolean

Determines whether ISMW applies to the PE.

No

15

License number

Alphanumeric

Principle employer license number.

No

16

PF Code

Alphanumeric

Principle employer PF code.

No.

17

ESI

Alphanumeric

Principal employer's ESIC number.

Yes, either the ESI or WC is mandatory.

18

WC Number

Alphanumeric

Principle employer's WC number.

Yes, either the ESI or WC is mandatory.

19

LWF Number

Alphanumeric

Principal employer's LWF number.

No

20

Prof Tax Number

Alphanumeric

Principal employer's Professional Tax number.

No

Note:

The integration checks for and then rejects duplicate rows.

The principal employer ID (PE ID) is validated against the principal employer business structure node name. The integration rejects records without a match.

For records that contain a PF Code, the value must contain 15 characters.

For records that contain an ESI, the value must contain 17 characters.

Wage Details

Wage Details — Source file overview

Wage Details — Source file overview

Name

Value

File name

WageDetails

File extension

CSV

Format

Comma-delimited

Source directory

/Inbound/ContractWorkforceManagement/Wage Details

Header row

Yes

Header count

14

Footer row

No

Wage Details — Source file layout

>Wage Details — Source file layout

Column sequence #

Name

Type

Description

Mandatory

1

PE ID

Alphanumeric

Business structure name

Yes, must be configured in the application as a business structure node name.

2

Contractor Code

Alphanumeric

Business structure name

Yes, must be configured in the application as a business structure node name.

3

Workmen ID

Alphanumeric

Employee ID

Yes

4

Aadhar Number

Alphanumeric

Yes

5

Basic

Numeric

Yes

6

DA

Numeric

Yes

7

HRA

Numeric

Yes

8

Conveyance Allowance

Numeric

Yes

9

Special Allowance

Numeric

Yes

10

Skill Allowance

Numeric

Yes

11

Washing Allowance

Numeric

Yes

12

Uniform Allowance

Numeric

Yes

13

Hardship Allowance

Numeric

Yes

14

Effective date

Date

Date

Yes

Trade Skill Wage Details

Trade Skill Wage Details — Source file overview

Trade Skill Wage Details — Source file overview

Name

Value

File name

TradeSkillWageDetail

File extension

CSV

Format

Comma-delimited

Source directory

/Inbound/ContractWorkforceManagement/TradeSkillWageDetail

Header row

Yes

Header count

13

Footer row

No

Trade Skill Wage Details — Source file layout

Trade Skill Wage Details — Source file layout

Column sequence #

Name

Type

Description

Mandatory

1

UnitSapID

Alphanumeric

Business structure name

Yes, must be configured in the application.

2

Trade

Alphanumeric

State published trade.

Yes, must be configured in the application.

3

Skill

Alphanumeric

State published skill.

Yes, must be configured in the application.

4

Basic

Numeric

Yes

5

DA

Numeric

Yes

6

HRA

Numeric

Yes

7

Conveyance Allowance

Numeric

Yes

8

Special Allowance

Numeric

Yes

9

Skill Allowance

Numeric

Yes

10

Washing Allowance

Numeric

Yes

11

Uniform Allowance

Numeric

Yes

12

Hardship Allowance

Numeric

Yes

13

Effective date

Date

Date

Yes

Note:

The integration checks for and then rejects duplicate rows.

Trade and Skill must be configured in the system.

Minimum Wage

Minimum Wage — Source file overview

Minimum Wage — Source file overview

Name

Value

File name

MinimumWage

File extension

CSV

Format

Comma-delimited

Source directory

/Inbound/ContractWorkforceManagement/MinimumWage

Header row

Yes

Header count

8

Footer row

No

Minimum Wage — Source file layout

Minimum Wage — Source file layout

Column sequence #

Name

Type

Description

Mandatory

1

PE ID

Alphanumeric

Identifies the principal employer.

Yes, must be configured in the application.

2

Effective Date

Alphanumeric

Date from which the minimum wage is effective.

Yes

3

Trade

Alphanumeric

State published trade.

Yes, must be configured in the application.

4

Skill

Alphanumeric

State published skill.

Yes, must be configured in the application.

5

Min Wage - Basic

Numeric

State published basic minimum wage.

Yes

6

Min Wage - DA

Numeric

State published DA minimum wage.

Yes

7

Min Wage - HRA

Numeric

State published HRA minimum wage.

Yes, but when no value is entered in the file, it will be considered as 0.

8

Min Wages Others

Numeric

State published Others minimum wage.

Yes, but when no value is entered in the file, it will be considered as 0.

Note:

The integration checks for and then rejects duplicate rows.

Trade and Skill must be configured in the system.

Earnings and Deductions

Earnings and Deductions — Source file overview

Earnings and Deductions — Source file overview

Name

Value

File name

EarningsDeduction

File extension

CSV

Format

Comma-delimited

Source directory

/Inbound/ContractWorkforceManagement/EarningsDeduction

Header row

Yes

Header count

12

Footer row

No

Earnings and Deductions — Source file layout

Earnings and Deductions — Source file layout

Column sequence #

Name

Type

Description

Mandatory

1

Unit Code

Alphanumeric

Identifies the principal employer.

Yes, must be configured in the application.

2

Contactor Code

Alphanumeric

Business structure name

Yes, must be configured in the application.

3

Wage Head Name

Alphanumeric

Name of the wage head that is paid or deducted.

Yes

4

Aadhar Number

Numeric

Yes

5

Percent/Amount

Alphanumeric

Identifies whether the record contains an Amount or a Percent of another wage column.

Yes

6

DA

Numeric

Yes

7

The actual value in decimals

Alphanumeric

Numeric or percentage value.

Yes

8

Conveyance Allowance

Numeric

Yes

9

Earning or Deduction

Alphanumeric

Identifies whether the record contains an Earning or a Deduction.

Yes

10

Skill Allowance

Numeric

Yes

11

Wage head on which the percentage is calculated upon

Alphanumeric

Identifies the wage head used in the percent calculation, such as Basic, Dearness Allowance.

Yes, when Percent/Amount= Percent.

12

Uniform Allowance

Numeric

Yes

Note:

Earning or Deduction must contain Earning or Deduction; otherwise the record is rejected.

Percent/Amount must contain Percent or Amount; otherwise the record is rejected.

Labor Welfare Fund Deduction

Labor Welfare Fund Deduction — Source file overview

Labor Welfare Fund Deduction — Source file overview

Name

Value

File name

LWFDeduction

File extension

CSV

Format

Comma-delimited

Source directory

/Inbound/ContractWorkforceManagement/LWFDeduction

Header row

Yes

Header count

7

Footer row

No

Labor Welfare Fund Deduction — Source file layout

Labor Welfare Fund Deduction — Source file layout

Column sequence #

Name

Type

Description

Mandatory

1

PE ID

Alphanumeric

Identifies the principal employer.

Yes, must be configured in the application.

2

Effective Date

Alphanumeric

Date from which the record is effective.

Yes

3

Amount/Percent

Alphanumeric

Identifies whether the record contains an Amount or a Percent.

Yes

4

Employee Contribution Value

Numeric

Yes

5

Frequency

Alphanumeric

Determines the frequency of the labor welfare fund deduction.

Supported values include:

Daily

Monthly

Quarterly

Half Yearly

Yearly

Daily and monthly frequency are treated similarly while yearly is applied only in the month of December.

Yes

6

Upper Limit

Numeric

Yes

7

Amount

Numeric

Yes

Note:

The integration checks for and then rejects duplicate rows.

Frequency must contain only one of the following values: Daily, Monthly, Quarterly, Half Yearly, Yearly.

Professional Tax Deduction

Professional Tax Deduction — Source file overview

Professional Tax Deduction — Source file overview

Name

Value

File name

PTDeduction

File extension

CSV

Format

Comma-delimited

Source directory

/Inbound/ContractWorkforceManagement/PTDeduction

Header row

Yes

Header count

8

Footer row

No

Professional Tax Deduction — Source file layout

Professional Tax Deduction — Source file layout

Column sequence #

Name

Type

Description

Mandatory

1

PE ID

Alphanumeric

Identifies the principal employer.

Yes, must be configured in the application.

2

Effective Date

Alphanumeric

Date from which the record is effective.

Yes

3

Min Gross

Numeric

Yes

4

Max Gross

Numeric

Yes

5

Start Month

Alphanumeric

Yes

6

End Month

Alphanumeric

Yes

7

Gender

Alphanumeric

Yes

8

Amount

Numeric

Yes

Note:

The integration checks for and then rejects duplicate rows.

Service Charge

Service Charge — Source file overview

Service Charge — Source file overview

Name

Value

File name

ServiceCharge

File extension

CSV

Format

Comma-delimited

Source directory

/Inbound/ContractWorkforceManagement/ServiceCharge

Header row

Yes

Header count

6

Footer row

No

Service Charge — Source file layout

Service Charge — Source file layout

Column sequence #

Name

Type

Description

Mandatory

1

PE ID

Alphanumeric

Identifies the principal employer.

Yes, must be configured in the application.

2

Effective Date

Alphanumeric

Date from which the record is effective.

Yes

3

Contractor ID

Alphanumeric

Yes

4

Service Charge on Salary (In % or per Head)

Numeric

Yes

5

Service Charge on Overtime (In % or per Head)

Numeric

Yes

6

Amount/Percent

Alphanumeric

Identifies the service charge type.

Supported values:

Amount

Percent.

Yes

CWFM Import Export integration — Target file specifications

Export file — CWFM Import Export integration

Export file structure is similar to the source files, but includes two extra columns:

  • Last Modified Date

  • Last Modified By

Export file — File overview

Export file — File overview

Name

Value

File name

Aligns with the user-selected entity and matches the Filename defined in the CWFMImportExport_iPack_v1_SFTPParameter_CRT.

File extension

CSV

Delimiter

Comma-delimited

Target directory

Aligns with the user-selected entity and matches the Export File Location defined in the CWFMImportExport_iPack_v1_SFTPParameter_CRT.

Header row

Yes

Footer row

No

Error files — CWFM Import Export integration

Error files capture invalid or duplicate data that already exists in the database. The file structure is similar to the source file, but includes one extra column:

  • Error Message

Error file — File overview

Error file — File overview

Name

Value

File name

Error_ <source filename> _ <timestamp>

File extension

CSV

Delimiter

Comma-delimited

Target directory

Aligns with the user-selected entity and matches the CWFM Import Export integration parameter ErrorOutputDirectory.

Header row

Yes

Footer row

No

Archive files — CWFM Import Export integration

Processed source files are moved to the archive folder.

Archive file — File overview

Error file — File overview

Name

Value

File name

Archive_ <source filename> _ <timestamp>

File extension

CSV

Delimiter

Comma-delimited

Target directory

Aligns with the user-selected entity and matches the Archive File Location defined in the CWFMImportExport_iPack_v1_SFTPParameter_CRT.

Header row

Yes

Footer row

No

CWFM Import Export integration — APIs

API details — CWFM Import Export integration

API details - CWFM Import Export integration

API name

Type

Resource path

Description

Retrieve Locations

POST

v1/commons/locations/multi_read

Fetch all location child nodes.

Retrieve User Preferences for Current User

GET

/v1/commons/user_preferences/locale_policy

Fetch user's or tenant's locale data.

Retrieve Manager Role Assignments

POST

v1/commons/persons/manager_role_assignments/multi_read

Fetch user’s assigned manager role assignment.

Retrieve Employee Group by ID

GET

/v1/commons/employee_groups/{id}

Fetch employee group data based on ID.

Retrieve Location Set by Name

GET

/v1/commons/location_sets

Fetch location assigned in organization set data-based on organization group name.

Retrieve Skills

POST

/v1/scheduling/skills/multi_read

Fetch all skills in the application.

Retrieve Proficiency Level by Name

GET

/v1/scheduling/proficiency_levels

Fetch all proficiency levels in the application.

Retrieve All Skill Assignments

POST

/v1/commons/persons/skills/multi_read

Fetch skill assigned to a person.

CWFM People Import integration

CWFM People Import — 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.
  1. Get the URL, User, and Password for the APIGatewayServer.
  2. 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 Contract Workforce Management 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 Select items.

  3. Configure the CWFM People Import 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 Search button. It can take several seconds before the button becomes active.

      3. Scroll to and select the integration pack: CWFM People Import > CWFMPeopleImport_iPack_v1.

  4. 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.
    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

      CWFMPeopleImport_iPack_v1_APIGatewayServer

      Required

      To change the default API gateway server:

      1. Clear Use Default.
      2. Enter the URL to the server.

        Example: <tenantURL>/api

      CWFMPeopleImport_iPack_v1_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:

      1. For each field, clear Use Default.
      2. 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.

      CWFMPeopleImport_iPack_v1_ExtensionConnection

      Required

      Provide the connection details for Extension Table where data is stored:

      • User

      • Password

      • Class Name

      • Connection URL

      CWFMPeopleImport_iPack_v1_Status_CRT

      Required

      Enable Override.

      CWFMPeopleImport_iPack_v1_CompoundKey_CRT

      Required

      Enable Override.

      CWFMPeopleImport_iPack_v1_PayPolicy_CRT

      Required

      Enable Override.

      CWFMPeopleImport_iPack_v1_License_CRT

      Required

      Enable Override.

      CWFMPeopleImport_iPack_v1_Accrual_CRT

      Required

      Enable Override.

      CWFMPeopleImport_iPack_v1_RoleManager_CRT

      Required

      Enable Override.

      CWFMPeopleImport_iPack_v1_Profile_CRT

      Required

      Enable Override.

      CWFMPeopleImport_iPack_v1_RoleEmployee_CRT

      Required

      Enable Override.

      CWFMPeopleImport_iPack_v1_BusinessStructure_CRT

      Required

      Enable Override.

      CWFMPeopleImport_iPack_v1_Schedule_CRT

      Required

      Enable Override.

      CWFMPeopleImport_iPack_v1_AttendanceLeave_CRT

      Required

      Enable Override.

      CWFMPeopleImport_iPack_v1_EmploymentTerm_CRT

      Required

      Enable Override.

      CWFMPeopleImport_iPack_v1_Work_CRT

      Required

      Enable Override.

      CWFMPeopleImport_iPack_v1_ RoleMgrAttributeExclusions_CRT

      Required

      Enable Override.

      CWFMPeopleImport_iPack_v1_ ExistingEmpDates_CRT

      Required

      Enable Override.

      CWFMPeopleImport_iPack_v1_CustomFields_CRT

      Required

      Enable Override.

      CWFMPeopleImport_iPack_v1_ImportValidation_CRT

      Required

      Enable Override.

      CWFMPeopleImport_iPack_v1_Timezone_CRT

      Required

      Enable Override.

      CWFMPeopleImport_iPack_v1_Locale_CRT

      Required

      Enable Override.

  5. Configure process properties
    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 CWFMPeopleImport_iPack_v1_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 properties

      Process property name

      Column header value

      _CWFMPeopleImport_iPack_v1_Status_CRT

      Source Status,Dimension Status

      _CWFMPeopleImport_iPack_v1_CompoundKey_CRT

      Key 1,Key 2,Key 3,Key 4,Key 5,Key 6,Key 7,Key 8,Key 9,Key 10,Compound Key

      _CWFMPeopleImport_iPack_v1_PayPolicy_CRT

      Key 1,Key 2,Key 3,Key 4,Key 5,Adjustment Rule,Emp Percent Allocation Rule

      _CWFMPeopleImport_iPack_v1_License_CRT

      Key 1,Key 2,Key 3,Key 4,Key 5,Employee Role,Manager Role,Timekeeping,Attendance & Leave,Scheduling,Analytics,Work

      _CWFMPeopleImport_iPack_v1_Accrual_CRT

      Key 1,Key 2,Key 3,Key 4,Key 5,Accrual Profile,Cascade Profile

      _CWFMPeopleImport_iPack_v1_RoleManager_CRT

      Key 1,Key 2,Key 3,Key 4,Key 5,Mgr Pay Code Edit Profile,Mgr Pay Code View Profile,Mgr Work Rule Profile,Mgr Reports Profile,Mgr Hyperfind Schedule Visibility Profile,Mgr Process Profile,Mgr Delegate Profile,GDAP Profile,MMR Symbolic Reviewer

      _CWFMPeopleImport_iPack_v1_Profile_CRT

      Key 1,Key 2,Key 3,Key 4,Key 5,Function Access Profile,Display Profile,Locale Profile,Notification Profile,User Logon Profile,Authentication Type,Access Method Profile

      _CWFMPeopleImport_iPack_v1_RoleEmployee_CRT

      Key 1,Key 2,Key 3,Key 4,Key 5,Emp Time Entry Method,Emp Pay Code Edit Profile,Emp Work Rule Profile,Emp Worker Type,Emp Device Group,Emp Device Profile,Emp Process Profile,Emp Attestation Profile,Emp Pay Code Values Profile,Reviewer Override|Reviewer List,Analytics Labor Type

      _CWFMPeopleImport_iPack_v1_BusinessStructure_CRT

      Key 1,Key 2,Key 3,Key 4,Key 5,Mgr Labor Category Profile,Mgr Emp Group,Mgr Job Transfer Set,Mgr Forecasting Category Profile,Emp Job Transfer Set,Emp Labor Category Profile,Mgr Hyperfind for Home Employees,Manager Additions Job Transfer Set,Manager Additions Labor Category Profile

      _CWFMPeopleImport_iPack_v1_Schedule_CRT

      Key 1,Key 2,Key 3,Key 4,Key 5,Mgr Sched Group Profile,Mgr Shift Template Profile,Mgr Pattern Template Profile,Emp Shift Template,Emp Schedule Group,Emp Schedule Rule Set,Minor Rule,Minor School Calendar

      _CWFMPeopleImport_iPack_v1_AttendanceLeave_CRT

      Key 1,Key 2,Key 3,Key 4,Key 5,Attendance Profile,Attendance Admin,Leave Profile,Leave Admin

      _CWFMPeopleImport_iPack_v1_EmploymentTerm_CRT

      Key 1,Key 2,Key 3,Key 4,Key 5,Employment Term

      _CWFMPeopleImport_iPack_v1_Work_CRT

      Key 1,Key 2,Key 3,Key 4,Key 5,Activity Tracking Status,Activity Profile,Default Activity,Idle Time,Meal,Paid Break,Auto Resolve

      _CWFMPeopleImport_iPack_v1_ RoleMgrAttributeExclusions_CRT

      Key 1,Key 2,Key 3,Key 4,Key 5,Person Number

      _CWFMPeopleImport_iPack_v1_ ExistingEmpDates_CRT

      Dimension Field,SetTo: 'CPPStart OR 'CurrentDate' OR 'File',

      _CWFMPeopleImport_iPack_v1_CustomFields_CRT

      Source File Field,Label Value

      _CWFMPeopleImport_iPack_v1_ImportValidation_CRT

      Validation Name,Is Applicable,Value

      _CWFMPeopleImport_iPack_v1_Timezone_CRT

      Source Time Zone,Dimension Status Time Zone

      _CWFMPeopleImport_iPack_v1_Locale_CRT

      Parameter Name,Locale Policy,Message,Description

CWFM People Import — Configure the 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.

CWFM People Import — Application Setup

  1. Configure Access to Integrations.

  2. Configure the following:

    • SFTP connection: Configure the SFTP Connection. See the Configure the SFTP Connection topic.

    • Extensions Tables: Create the People Import extension tables. See the Extensions Tables topic.

      Enter the following in the DDL Command Name and Commands fields for each extension table definition:

      Create TABLE AadharNumberCheckTable
(
  PersonNumber VARCHAR(255),
  PersonId VARCHAR(255),
  AadharNumber VARCHAR(255)
);
      Create TABLE BlacklistedEmployeeCheckTable
(
  PersonNumber VARCHAR(255),
  AadharNumber VARCHAR(255),
  lastmodifiedby VARCHAR(255),
  lastmodifieddate VARCHAR(255)
);

CWFM People Import — 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.

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.

CWFMPeopleImport_iPack_v1_Status_CRT: Identifies status mapping between the source file and the application.

CWFM People Import — Status CRT structure

CWFM People Import — Status CRT structure

Column name

Description

Source Status

Status value contained in the source file.

Dimension Status

Corresponding status value in the application.

CWFM People Import — Status CRT sample content

CWFM People Import — Status CRT sample content

Source Status

Dimension Status

Active

Active

Inactive

Inactive

Terminated

Terminated

CWFMPeopleImport_iPack_v1_CompoundKey_CRT: Controls the creation of compound keys.

CWFM People Import — Compound Key CRT structure

CWFM People Import — Compound Key CRT structure

Column name

Description

Key 1

Generic key that is set at runtime.

Key 2

Generic key that is set at runtime.

Key 3

Generic key that is set at runtime.

Key 4

Generic key that is set at runtime.

Key 5

Generic key that is set at runtime.

Key 6

Generic key that is set at runtime.

Key 7

Generic key that is set at runtime.

Key 8

Generic key that is set at runtime.

Key 9

Generic key that is set at runtime.

Key 10

Generic key that is set at runtime.

Compound Key

The compound key that is determined by the combination of one or more keys ( Key 1 — Key 10).

Compound keys provide restriction criteria during the import of people data.

CWFM People Import — Compound Key CRT sample content

CWFM People Import — Compound Key CRT sample content

Key 1

Key 2

Key 3

Key 4

Key 5

Key 6

Key 7

Key 8

Key 9

Key 10

Compound Key

Home Business Structure Level 5

Home Business Structure Level 6

Home Business Structure Level 7

Home Business Structure Level 8

Home Business Structure Level 9

Default

Minda Location

Minda Site A

9900

73733

Minda Unit A

Compound Key1

CWFMPeopleImport_iPack_v1_PayPolicy_CRT: Controls the pay policy rules for person assignment.

CWFM People Import — Pay Policy CRT structure

CWFM People Import — Pay Policy CRT structure

Column name

Description

Key 1

The compound key.

Key 2

Generic key that is set at runtime.

Key 3

Generic key that is set at runtime.

Key 4

Generic key that is set at runtime.

Key 5

Generic key that is set at runtime.

Pay Rule

Pay Rule that is assigned to a person.

Adjustment Rule

Adjustment Rule that is assigned to a person.

Emp Percent Allocation Rule

Percent Allocation Rule that is assigned to a person.

CWFM People Import — Pay Policy CRT sample content

CWFM People Import — Pay Policy CRT sample content

Key 1

Key 2

Key 3

Key 4

Key 5

Pay Rule

Adjustment Rule

Emp Percent Allocation Rule

*

MANUFACTURING inc.

India

1001

*

Basic + OT Approval

*

Aarti Industries

2402

404617

Full Time

CLRA Adjustment Rule

Two Forty Rule

CWFMPeopleImport_iPack_v1_License_CRT: Controls the entitlements for person assignment.

CWFM People Import — License CRT structure

CWFM People Import — License CRT structure

Column name

Description

Key 1

The compound key.

Key 2

Generic key that is set at runtime.

Key 3

Generic key that is set at runtime.

Key 4

Generic key that is set at runtime.

Key 5

Generic key that is set at runtime.

Employee Role

Employee Role that is assigned to a person.

Manager Role

Manager Role that is assigned to a person.

Timekeeping

Timekeeping license that is assigned to a person.

Attendance & Leave

Attendance & Leave license that is assigned to a person.

Scheduling

Scheduling license that is assigned to a person.

Analytics

Analytics license that is assigned to a person.

Work

Work license that is assigned to a person.

CWFM People Import — License CRT sample content

CWFM People Import — License CRT sample content

Key 1

Key 2

Key 3

Key 4

Key 5

Employee Role

Manager Role

Timekeeping

Attendance & Leave

Scheduling

Analytics

Work

*

MANUFACTURING inc.

India

1001

*

Employee

Manager

Hourly Timekeeping

Absence

Scheduling

Analytics

I

CWFM

2402

404617

Employee

Manager

Hourly Timekeeping

Absence

Scheduling

Analytics

CWFMPeopleImport_iPack_v1_Accrual_CRT: Controls the Accrual and Cascade Profiles for person assignment.

CWFM People Import — Accrual CRT structure

CWFM People Import — Accrual CRT structure

Column name

Description

Key 1

The compound key.

Key 2

Generic key that is set at runtime.

Key 3

Generic key that is set at runtime.

Key 4

Generic key that is set at runtime.

Key 5

Generic key that is set at runtime.

Accrual Profile

Accrual Profile that is assigned to a person.

Cascade Profile

Cascade Profile that is assigned to a person.

CWFM People Import — Accrual CRT sample content

CWFM People Import — Accrual CRT sample content

Key 1

Key 2

Key 3

Key 4

Key 5

Accrual Profile

Cascade Profile

*

MANUFACTURING inc.

India

1001

*

Manager + Accrual Pool

I

CWFM

2402

404617

6month

HD Cascade

CWFMPeopleImport_iPack_v1_RoleManager_CRT: Controls the manager profile assignments.

CWFM People Import — Role Manager CRT structure

CWFM People Import — Role Manager CRT structure

Column name

Description

Key 1

The compound key.

Key 2

Generic key that is set at runtime.

Key 3

Generic key that is set at runtime.

Key 4

Generic key that is set at runtime.

Key 5

Generic key that is set at runtime.

Mgr Pay Code Edit Profile

Pay Code Edit Profile that is assigned to a manager.

Mgr Pay Code View Profile

Pay Code View Profile that is assigned to a manager.

Mgr Work Rule Profile

Work Rule Profile that is assigned to a manager.

Mgr Reports Profile

Reports Profile that is assigned to a manager.

Mgr Hyperfind Schedule Visibility Profile

Hyperfind Profile that is assigned to a manager.

Mgr Process Profile

Process Profile that is assigned to a manager.

Mgr Delegate Profile

Delegate Profile that is assigned to a manager.

GDAP Profile

GDAP Profile that is assigned to a manager.

MMR Symbolic Reviewer

Symbolic Reviewer that is assigned to a manager.

CWFM People Import — Role Manager CRT sample content

CWFM People Import — Role Manager CRT sample content

Key 1

Key 2

Key 3

Key 4

Key 5

Mgr Pay Code Edit Profile

Mgr Pay Code View Profile

Mgr Work Rule Profile

Mgr Reports Profile

Mgr Hyperfind Schedule Visibility Profile

Mgr Process Profile

Mgr Delegate Profile

GDAP Profile

MMR Symbolic Reviewer

*

MANUFACTURING inc.

India

1001

Machine Shop

All Pay Codes - Cleaned

All Work Rules

ALL REPORTS

Retail Managers Delegate Profile

All Access - Cleaned

CWFMPeopleImport_iPack_v1_Profile_CRT: Controls profile assignments.

CWFM People Import — Profile CRT structure

CWFM People Import — Profile CRT structure

Column name

Description

Key 1

The compound key.

Key 2

Generic key that is set at runtime.

Key 3

Generic key that is set at runtime.

Key 4

Generic key that is set at runtime.

Key 5

Generic key that is set at runtime.

Function Access Profile

Function Access Profile that is assigned to a person.

Display Profile

Display Profile that is assigned to a person.

Locale Policy

Locale Policy that is assigned to a person.

Notification Profile

Notification Profile that is assigned to a person.

User Logon Profile

User Logon Profile that is assigned to a person.

Authentication Type

Authentication Type that is assigned to a person.

Access Method Profile

Access Method Profile that is assigned to a person.

CWFM People Import — Profile CRT sample content

CWFM People Import — Profile CRT sample content

Key 1

Key 2

Key 3

Key 4

Key 5

Function Access Profile

Display Profile

Locale Policy

Notification Profile

User Logon Profile

Authentication Type

Access Method Profile

Compound Key 1

CWFM

3002

Noida

500532

Education Manager

Austria Test Locale Profile

American English

E-mail Only

Default

Basic

CLRA Person Import

CWFMPeopleImport_iPack_v1_RoleEmployee_CRT: Controls employee role assignments.

CWFM People Import — Role Employee CRT structure

CWFM People Import — Role Employee CRT structure

Column name

Description

Key 1

The compound key.

Key 2

Generic key that is set at runtime.

Key 3

Generic key that is set at runtime.

Key 4

Generic key that is set at runtime.

Key 5

Generic key that is set at runtime.

Emp Time Entry Method

Time Entry Method that is assigned to a person.

Emp Pay Code Edit Profile

Pay Code Edit Profile that is assigned to a person.

Emp Work Rule Profile

Work Rule Profile that is assigned to a person.

Emp Worker Type

Worker Type that is assigned to a person.

Emp Device Group

Device Group that is assigned to a person.

Emp Device Profile

Device Profile that is assigned to a person.

Emp Process Profile

Process Profile that is assigned to a person.

Emp Attestation Profile

Attestation Profile that is assigned to a person.

Emp Pay Code Values Profile

Pay Code Values Profile that is assigned to a person.

Reviewer Override|Reviewer List

Reviewer List that is assigned to a person.

Analytics Labor Type

Analytics Labor Type that is assigned to a person.

Approval Method Name

Approval method that is assigned to a person.

CWFM People Import — Role Employee CRT sample content

CWFM People Import — Role Employee CRT sample content

Key 1

Key 2

Key 3

Key 4

Key 5

Emp Time Entry Method

Emp Pay Code Edit Profile

Emp Work Rule Profile

Emp Worker Type

Emp Device Group

Emp Device Profile

Emp Process Profile

Emp Attestation Profile

Emp Pay Code Values Profile

Reviewer Override | Reviewer List

Analytics Labor Type

Approval Method Name

*

MANUFACTURING inc.

India

1001

*

Hourly View

All Pay Codes - Cleaned

Full Time

Full Time

CWFMPeopleImport_iPack_v1_BusinessStructure_CRT: Controls manager business structure assignments.

CWFM People Import — Business Structure CRT structure

CWFM People Import — Business Structure CRT structure

Column name

Description

Key 1

The compound key.

Key 2

Generic key that is set at runtime.

Key 3

Generic key that is set at runtime.

Key 4

Generic key that is set at runtime.

Key 5

Generic key that is set at runtime.

Mgr Labor Category Profile

Labor Category Profile that is assigned to a manager.

Mgr Emp Group

Employee Group that is assigned to a manager.

Mgr Job Transfer Set

Manager Job Transfer Set that is assigned to a manager.

Mgr Forecasting Category Profile

Forecasting Category Profile that is assigned to a manager.

Emp Job Transfer Set

Employee Job Transfer Set that is assigned to a manager.

Emp Labor Category Profile

Employee Labor Category Profile that is assigned to a manager.

Mgr Hyperfind for Home Employees

Home Employees Hyperfind that is assigned to a manager.

Manager Additions Job Transfer Set

Additional Job Transfer Set that is assigned to a manager.

Manager Additions Labor Category Profile

Additional Labor Category Profile that is assigned to a manager.

CWFM People Import — Business Structure CRT sample content

CWFM People Import — Business Structure CRT sample content

Key 1

Key 2

Key 3

Key 4

Key 5

Mgr Labor Category Profile

Mgr Emp Group

Mgr Job Transfer Set

Mgr Forecasting Category Profile

Emp Job Transfer Set

Emp Labor Category Profile

Mgr Hyperfind for Home Employees

Manager Additions Job Transfer Set

Manager Additions Labor Category Profile

*

MANUFACTURING inc.

India

1001

*

All Organizational Groups

All Organizational Groups

CWFMPeopleImport_iPack_v1_Schedule_CRT: Controls Scheduling assignments to a person.

CWFM People Import — Schedule CRT structure

CWFM People Import — Schedule CRT structure

Column name

Description

Key 1

The compound key.

Key 2

Generic key that is set at runtime.

Key 3

Generic key that is set at runtime.

Key 4

Generic key that is set at runtime.

Key 5

Generic key that is set at runtime.

Mgr Sched Group Profile

Schedule Group Profile that is assigned to a person.

Mgr Shift Template Profile

Shift Template Profile that is assigned to a person.

Mgr Pattern Template Profile

Pattern Template Profile that is assigned to a person.

Emp Shift Template

Shift Template that is assigned to a person.

Emp Schedule Group

Schedule Group that is assigned to a person.

Emp Schedule Rule Set

Schedule Rule Set that is assigned to a person.

Minor Rule

Minor Rule that is assigned to a person.

Minor School Calendar

Minor School Calendar that is assigned to a person.

CWFM People Import — Schedule CRT sample content

CWFM People Import — Schedule CRT sample content

Key 1

Key 2

Key 3

Key 4

Key 5

Mgr Schedule Group Profile

Mgr Shift Template Profile

Mgr Pattern Template Profile

Emp Shift Template

Emp Schedule Group

Emp Schedule Rule Set

Minor Rule

Minor School Calendar

*

UNO Minda

Minda Region A

Minda District A

Minda B_Unit

Metro Hosp Group DAP

Hours And Dollars Allocation

Hours And Dollars Allocation

Hours And Dollars Allocation

CTP01

MRSP

US

CWFMPeopleImport_iPack_v1_AttendanceLeave_CRT: Controls Attendance and Leave assignments to a person.

CWFM People Import — Attendance Leave CRT structure

CWFM People Import — Attendance Leave CRT structure

Column name

Description

Key 1

The compound key.

Key 2

Generic key that is set at runtime.

Key 3

Generic key that is set at runtime.

Key 4

Generic key that is set at runtime.

Key 5

Generic key that is set at runtime.

Attendance Profile

Attendance Profile that is assigned to a person.

Attendance Admin

Attendance Admin that is assigned to a person.

Leave Profile

Leave Profile that is assigned to a person.

Leave Admin

Leave Admin that is assigned to a person.

CWFM People Import — Attendance Leave CRT sample content

CWFM People Import — Attendance Leave CRT sample content

Key 1

Key 2

Key 3

Key 4

Key 5

Attendance Profile

Attendance Admin

Leave Profile

Leave Admin

*

UNO Minda

Minda Region A

Minda District A

Minda B_Unit

Full Time Employee Profile

AHC01

DC Leave

AHC01

CWFMPeopleImport_iPack_v1_EmploymentTerm_CRT: Controls Employment Term assignments to a person.

CWFM People Import — Employment Term CRT structure

CWFM People Import — Employment Term CRT structure

Column name

Description

Key 1

The compound key.

Key 2

Generic key that is set at runtime.

Key 3

Generic key that is set at runtime.

Key 4

Generic key that is set at runtime.

Key 5

Generic key that is set at runtime.

Employment Term

Employment Term that is assigned to a person.

CWFM People Import — Employment Term CRT sample content

CWFM People Import — Employment Term CRT sample content

Key 1

Key 2

Key 3

Key 4

Key 5

Employment Term

*

UNO Minda

Minda Region A

Minda District A

Minda B_Unit

5 days averaging

CWFMPeopleImport_iPack_v1_Work_CRT: Controls Work assignments to a person.

CWFM People Import — Work CRT structure

CWFM People Import — Work CRT structure

Column name

Description

Key 1

The compound key.

Key 2

Generic key that is set at runtime.

Key 3

Generic key that is set at runtime.

Key 4

Generic key that is set at runtime.

Key 5

Generic key that is set at runtime.

Activity Tracking Status

Activity Tracking Status that is assigned to a person.

Activity Profile

Activity Profile that is assigned to a person.

Default Activity

Default Activity that is assigned to a person.

Idle Time

Idle Time that is assigned to a person.

Meal

Meal that is assigned to a person.

Paid Break

Paid Break that is assigned to a person.

Auto Resolve

Auto Resolve that is assigned to a person.

CWFM People Import — Work CRT sample content

CWFM People Import — Work CRT sample content

Key 1

Key 2

Key 3

Key 4

Key 5

Activity Tracking Status

Activity Profile

Default Activity

Idle Time

Meal

Paid Break

Auto Resolve

*

UNO Minda

Minda Region A

Minda District A

Minda B_Unit

CWFMPeopleImport_iPack_v1_RoleMgrAttributeExclusions_CRT: Controls manager role attribute exclusions from a manager.

CWFM People Import — Role Manager Attribute Exclusions CRT structure

CWFM People Import — Role Manager Attribute Exclusions CRT structure

Column name

Description

Key 1

The compound key.

Key 2

Generic key that is set at runtime.

Key 3

Generic key that is set at runtime.

Key 4

Generic key that is set at runtime.

Key 5

Generic key that is set at runtime.

Person Number

Person Number that is assigned to a person.

CWFM People Import — Role Manager Attribute Exclusions CRT sample content

CWFM People Import — Role Manager Attribute Exclusions CRT sample content

Key 1

Key 2

Key 3

Key 4

Key 5

Person Number

*

UNO Minda

Minda Region A

Minda District A

Minda B_Unit

CWM1234500

CWFMPeopleImport_iPack_v1_ExistingEmpDates_CRT: Controls entity assignment effective dates for a person.

CWFM People Import — Existing Employee Dates CRT structure

CWFM People Import — Existing Employee Dates CRT structure

Column name

Description

Dimension Field

Field that requires an effective date.

SetTo: 'CPPStart OR 'CurrentDate' OR 'File'

The effective date.

Supported values include:

CPPStart CurrentDate File

CWFM People Import — Existing Employee Dates CRT sample content

CWFM People Import — Existing Employee Dates CRT sample content

Column name

Description

Accrual Profile Eff Date

CPPStart

Adjustment Rule Eff Date

CPPStart

Analytics Labor Type Eff Date

CPPStart

Attendance Profile Eff Date

CPPStart

Badge Number Eff Date

CPPStart

Base Wage Eff Date CPPStart

CPPStart

Emp Attestation Profile Eff Date

CPPStart

Emp Job Transfer Set/Manager Additions Eff Date

CPPStart

Emp Percent Allocation Rule Eff Date

CPPStart

Emp Schedule Group Eff Date

CPPStart

Emp Schedule Rule Set Eff Date

CPPStart

Emp Time Entry Method Eff Date

CPPStart

Employment Term Eff Date

CPPStart

FTE 1 Eff Date

CPPStart

FTE 2 Eff Date

CPPStart

GDAP Eff Date

File

Mgr Emp Group Eff Date

CPPStart

Mgr Job Transfer Set Eff Date

CPPStart

Pay Rule Eff Date

CPPStart

Personal OT Eff Date

CPPStart

Primary Job/LC Eff Date

CPPStart

CWFMPeopleImport_iPack_v1_CustomFields_CRT: Controls custom field creation.

CWFM People Import — Custom Fields CRT structure

CWFM People Import — Custom Fields CRT structure

Column name

Description

Source File Field

Source file heading name.

Label Value

Custom field in the application.

CWFM People Import — Custom Fields CRT sample content

CWFM People Import — Custom Fields CRT sample content

Source File Field

Label Value

Custom Date 1

Custom Date 2

Custom Date 3

Custom Date 4

Custom Date 5

Custom Field 1

Custom Field 2

Custom Field 3

Custom Field 4

Custom Field 5

Custom Field 6

Custom Field 7

Custom Field 8

Custom Field 9

Custom Field 10

Custom Field 11

Custom Field 12

Custom Field 13

Custom Field 14

Custom Field 15

Custom Field 16

Custom Field 17

Custom Field 18

Custom Field 19

Custom Field 20

Custom Field 21

Custom Field 22

Custom Field 23

Custom Field 24

Custom Field 25

Custom Field 26

Custom Field 27

Custom Field 28

Custom Field 29

Custom Field 30

CWFMPeopleImport_iPack_v1_ImportValidation_CRT: Identifies the verification requirements that people data must meet before it is imported into the system.

CWFM People Import — Import Validation CRT structure

CWFM People Import — Import Validation CRT structure

Column name

Description

Validation Name

Validation that refines data in the files before import into the database.

Supported values are limited to:

PersonNumber length PFAccountNumber UAN Number Gender Marital status Blood group Trade/Skill Worker Type AadharNumber length

Is Applicable

Determines whether validation must be applied to the data.

Supported values include Yes and No.

Value

The value that is evaluated during validation.

CWFM People Import — Import Validation CRT sample content

CWFM People Import — Import Validation sample content

Validation Name

Is Applicable

Value

PersonNumber length

Yes

10

PFAccountNumber

Yes

xx/xxx/nn/nnnnnn

UAN Number

Yes

xx/xxx/nn/nnnnnn

Gender

Yes

Male,Female,Others

Marital status

Yes

SINGLE,MARRIED

Blood group

Yes

A+,B+,O+,AB+,A-,B-,O-,AB-

Trade/Skill

Yes

Worker Type

Yes

AadharNumber length

Yes

12

CWFMPeopleImport_iPack_v1_Timezone_CRT: Identifies time zone mapping between the source file and the application.

CWFM People Import — Time zone CRT structure

CWFM People Import — Time zone CRT structure

Column name

Description

Source Time Zone

Time zone value contained in the source file.

Dimension Status Time Zone

Corresponding time zone value in the application.

CWFM People Import — Time zone CRT sample content

CWFM People Import — Time zone sample content

Source Time Zone

Dimension Status Time Zone

Eastern

Eastern

Central

Central

Mountain

Mountain

Pacific

Pacific

India

India

CWFMPeopleImport_iPack_v1_Locale_CRT: Allows translation of messages and labels into different languages.

CWFM People Import — Locale CRT structure

CWFM People Import — Locale CRT structure

Column name

Description

Parameter Name

Key for which localization is defined.

Locale Policy

Locale Policy.

Note:

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, or value of the label defined in the Run Summary section.

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").

CWFM People Import — Locale CRT sample content

CWFM People Import — Locale CRT sample content

Parameter Name

Locale Policy

Message

Description

Error_InvalidAppendTimeStamp

*

Invalid TimeStamp provided.

Error_InvalidArchiveEnabled

*

Invalid selection for archive enabled.

Error_InvalidDateFormat

*

Invalid Date Format provided.

Error_InvalidEmployeeRehire

*

Invalid selection for employee rehires.

Error_InvalidErrorLogEnabled

*

Invalid selection for enable error log enabled.

Error_InvalidParallelProcessing

*

Invalid selection for parallel processing.

Error_InvalidPreviewMode

*

Invalid selection for preview mode.

Error_InvalidTranslatedStageFile

*

Invalid selection for enable translated stage file.

Error_InvalidTranslatedStageLogging

*

Invalid selection for enable translated stage logging.

Error_InvalidUniqueEmployeeID

*

Invalid selection for unique employee ID.

Error_MissingFileName

*

Blank selection for file name.

Error_MissingHeaderValue

*

Header value is blank.

Error_MissingPersonNumberPrefix

*

Blank value for enable person number prefix.

Label_AdjustmentRules

*

Count of AdjustmentRules

Label_AttendanceAdmins

*

Count of AttendanceAdmins.

Label_AttendanceProfiles

*

Count of Attendance Profiles.

Label_AttestationProfiles

*

Count of Attestation Profiles.

Label_CascadeProfiles

*

Count of Cascade Profiles.

Label_CompoundKey

*

Count of Compound Key.

Label_DisqualifiedRecords

*

Count of Disqualified Records.

Label_EmploymentTerms

*

Count of Employment Terms.

Label_ImportedTransactions

*

Count of Imported Transactions.

Label_IntegrationExecutionId

*

Integration Execution ID.

Label_IntegrationTypeName

*

Integration Type

Label_IntegrationTypeValue

*

Export

Label_LeaveAdmins

*

Count of Leave Admins.

Label_LeaveProfiles

*

Count of Leave Profiles.

Label_MinorRules

*

Count of Minor Rules.

Label_PayCodeValuesProfile

*

Count of Pay Code Values Profile.

Label_PercentAllocationRules

*

Count of Percent Allocation Rules.

Label_PersonalityData

*

Count of Personality Data..

Label_ProcessProfiles

*

Count of Process Profiles.

Label_ProcessedSourceRecords

*

Count of Processed Source Records.

Label_ReportsTo

*

Count of Reports To.

Label_ScheduleGroups

*

Count of Schedule Groups.

Label_ScheduleRuleSets

*

Count of Schedule Rule Sets.

Label_SecondaryAccrualProfile

*

Count of Secondary Accrual Profile.

Label_SourceRecords

*

Count of Source Records.

Label_SymbolicReviewer

*

Count of Symbolic Reviewer.

Label_TotalErrors

*

Count of Total Errors.

Message_AadharNumber

*

Invalid Aadhar Number

Message_AdditionalDetails

*

Integration has completed with errors.

Message_BadgeNumber

*

Invalid Badge Number
Message_BlacklistedEmployee*Blacklisted Employee

Message_Bloodgroup

*

Blood Group is incorrect.

Message_EmployeeRehire

*

Employee Rehire is not allowed.

Message_Gender

*

Gender is incorrect.

Message_InvalidDateFormat

*

Invalid date format for: <FieldName>

Message_LicenseCountExceeded

*

License count exceeded for the contractor.

Message_Maritalstatus

*

Marital Status is incorrect.

Message_MissingMandatoryField

*

Missing mandatory field: <FieldName>

Message_PersonNumberLength

*

Person Number length is invalid.

Message_PFAccountNumber

*

PFAccount Number is invalid.

Message_RehireWorkerType

*

For Rehire, status of WorkerType is incorrect.

Message_Skill_Trade

*

Trade/Skill is incorrect.

Trade/Skill is incorrect.

Message_SkillEffectDateSame*Skill with same effective date is already assigned to employee.

Message_UANNumber

*

UAN Number is invalid.

Message_WithoutErrors

*

Integration has completed without errors.

Message_WorkerType

*

Invalid Worker Type

CWFM People Import — Install the 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.
  1. Select Main Menu Administration > Application Setup > Integrations Setup > Install Integrations.
  2. Click Tap Create .
  3. In Integration Name enter a unique name, such as CWFMPeopleImport_iPack_v1.
  4. (Optional) Enter a Description.
    Note: Do not select API Integration.
  5. In File Access, select Source/Output Download to select a connection.
  6. (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.
  7. (Optional) Select Re-Run to allow repeated runs of the integration with the same parameter values as the previous run.
  8. (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.

  9. 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.
  10. Configure Integration template and parameters:
    1. In Integration Template, select CWFMPeopleImport_iPack_v1.
    2. Click Tap Assign .
    3. In Integration Parameters, you can override default settings. Click Tap Create.
    4. Complete the configuration for each integration parameter value.
    5. Click Tap Save.

      Repeat this step for each integration control parameter that supports the CWFM People Import process.

      Note: Template parameter names that begin with an underscore (_) are not extended to UKG Pro Workforce Management and can be configured at the Boomi Atom level.

      CWFM People Import — Integration Parameters

      CWFM People Import — Integration Parameters

      Parameter name

      Description / Default value / User prompt

      Template parameter

      Parameter type

      UsingUKGclock

      Identifies whether clocks are in use.

      Supported value =

      true

      false

      User prompt = No

      Mandatory = Yes

      UsingUKGclock

      Text

      Termination Payrule

      An 'empty' pay rule that is assigned to an employee after termination.

      User prompt = No

      Mandatory = Yes

      TerminationPayrule

      Text

      Termination Accrual Profile

      An 'empty' accrual profile that is assigned to an employee after termination.

      User prompt = No

      Mandatory = Yes

      TerminationAccrualProfile

      Text

      SourceDirectory

      Contract worker source file location.

      Default = /Inbound/ContractWorkforceManagement

      User prompt = No

      Mandatory = Yes

      SourceDirectory

      Text

      Source Date Format

      Date format to which all dates in the contract worker files must adhere.

      Supported values include:

      MM/dd/yyyy

      MM-dd-yyyy

      dd/MM/yyyy

      dd-MM-yyyy (default)

      yyyy/MM/dd

      yyyy-MM-dd

      SourceDateFormat

      Text

      SFTPAction

      SFTP Action to perform when files with the same name exist in the remote directory.

      Supported case-sensitive values include:

      Create New Name

      Append

      Overwrite (default)

      Error

      User prompt = No

      Mandatory = Yes

      SFTPAction

      Text

      Set Header Value

      Identifies the key header lookup.

      User prompt = No

      Mandatory = Yes

      SetHeaderValue

      Text

      Person Number Prefix

      Prefix that is added to the unique person number.

      User prompt = No

      Mandatory = Yes

      PersonNumberPrefix

      Text

      Filename

      Contract worker file name.

      User prompt = Yes

      Mandatory = Yes

      Filename

      Text

      ErrorDirectory

      Contract worker export error file location.

      Default = /Inbound/ContractWorkforceManagement/error

      User prompt = No

      Mandatory = Yes

      ErrorDirectory

      Text

      Default New Account Password

      Default password assigned to all new employees.

      User prompt = No

      Mandatory = Yes

      Default New Account Password

      Text

      CreateUniqueEmployeeID

      Determines whether the process assigns the employee ID from the file or creates a new ID.

      User prompt = No

      Mandatory = Yes

      CreateUniqueEmployeeID

      Text

      Contractor Code Level

      Identifies the business structure level that stores the contractor code. For example, 4.

      User prompt = No

      Mandatory = Yes

      ContractorCodeLevel

      Text

      ArchiveDirectory

      Contract worker export archive file location.

      Default = /Inbound/ContractWorkforceManagement/archive

      User prompt = No

      Mandatory = Yes

      ArchiveDirectory

      Text

      AppendTimestampToFile

      Identifies the timestamp to appended to error and archive file names.

      Default = dd-MM-yyyy'T'hhmmSSS

      User prompt = No

      Mandatory = Yes

      AppendTimestampToFile

      Text

      Preview Mode

      Allows viewing of the staged profile post-translation data without making API calls.

      Default = false

      User prompt = No

      Mandatory = Yes

      Note: This option is recommended before processing a large file.

      _PreviewMode

      Text

      Is Manadatory HomeLaborCategoryLevel6

      Determines whether HomeLaborCategoryLevel6 is mandatory.

      Default = no

      User prompt = No

      Mandatory = Yes

      _IsManadatoryHomeLaborCategoryLevel6

      Text

      Is Manadatory HomeLaborCategoryLevel5

      Determines whether HomeLaborCategoryLevel5 is mandatory.

      Default = no

      User prompt = No

      Mandatory = Yes

      _IsManadatoryHomeLaborCategoryLevel5

      Text

      Is Manadatory HomeLaborCategoryLevel4

      Determines whether HomeLaborCategoryLevel4 is mandatory.

      Default = no

      User prompt = No

      Mandatory = Yes

      _IsManadatoryHomeLaborCategoryLevel4

      Text

      Is Manadatory HomeLaborCategoryLevel3

      Determines whether HomeLaborCategoryLevel3 is mandatory.

      Default = no

      User prompt = No

      Mandatory = Yes

      _IsManadatoryHomeLaborCategoryLevel3

      Text

      Is Manadatory HomeLaborCategoryLevel2

      Determines whether HomeLaborCategoryLevel2 is mandatory.

      Default = no

      User prompt = No

      Mandatory = Yes

      _IsManadatoryHomeLaborCategoryLevel2

      Text

      Is Manadatory HomeLaborCategoryLevel1

      Determines whether HomeLaborCategoryLevel1 is mandatory.

      Default = no

      User prompt = No

      Mandatory = Yes

      _IsManadatoryHomeLaborCategoryLevel1

      Text

      Is Manadatory HomeBusinessStructureLevel9

      Determines whether HomeBusinessStructureLevel9 is mandatory.

      Default = no

      User prompt = No

      Mandatory = Yes

      _IsManadatoryHomeBusinessStructureLevel9

      Text

      Is Manadatory HomeBusinessStructureLevel8

      Determines whether HomeBusinessStructureLevel8 is mandatory.

      Default = no

      User prompt = No

      Mandatory = Yes

      _IsManadatoryHomeBusinessStructureLevel8

      Text

      Is Manadatory HomeBusinessStructureLevel7

      Determines whether HomeBusinessStructureLevel7 is mandatory.

      Default = no

      User prompt = No

      Mandatory = Yes

      _IsManadatoryHomeBusinessStructureLevel7

      Text

      Is Manadatory HomeBusinessStructureLevel6

      Determines whether HomeBusinessStructureLevel6 is mandatory.

      Default = no

      User prompt = No

      Mandatory = Yes

      _IsManadatoryHomeBusinessStructureLevel6

      Text

      Is Manadatory HomeBusinessStructureLevel5

      Determines whether HomeBusinessStructureLevel5 is mandatory.

      Default = no

      User prompt = No

      Mandatory = Yes

      _IsManadatoryHomeBusinessStructureLevel5

      Text

      Is Manadatory HomeBusinessStructureLevel4

      Determines whether HomeBusinessStructureLevel4 is mandatory.

      Default = no

      User prompt = No

      Mandatory = Yes

      _IsManadatoryHomeBusinessStructureLevel4

      Text

      Is Manadatory HomeBusinessStructureLevel3

      Determines whether HomeBusinessStructureLevel3 is mandatory.

      Default = no

      User prompt = No

      Mandatory = Yes

      _IsManadatoryHomeBusinessStructureLevel3

      Text

      Is Manadatory HomeBusinessStructureLevel2

      Determines whether HomeBusinessStructureLevel2 is mandatory.

      Default = no

      User prompt = No

      Mandatory = Yes

      _IsManadatoryHomeBusinessStructureLevel2

      Text

      ErrorLogEnabled

      Enables error logging.

      Default = true

      User prompt = No

      Mandatory = Yes

      _ErrorLogEnabled

      Text

      Enable Translated Stage Logging

      Logs the translated staging data.

      Default = false

      User prompt = No

      Mandatory = Yes

      Note: As a best practice, set this parameter to true during user acceptance testing.

      _EnableTranslatedStageLogging

      Text

      Enable Translated Stage File

      Creates a file on SFTP that contains translated staging data.

      Default = false

      User prompt = No

      Mandatory = Yes

      Note: As a best practice, set this parameter to true during user acceptance testing.

      _EnableTranslatedStageFile

      Text

      EnabledParallelProcessing

      Enables parallel processing.

      Default = true

      User prompt = No

      Mandatory = Yes

      _EnabledParallelProcessing

      Text

      EmployeeRehire

      Determines whether an employee with the same Aadhaar number can be rehired.

      Default = yes

      User prompt = No

      Mandatory = Yes

      Note: An employee must be assigned a termination date before rehire is allowed.

      _EmployeeRehire

      Text

      ArchiveEnabled

      Enables file archiving.

      Default = true

      User prompt = No

      Mandatory = Yes

      _ArchiveEnabled

      Text

      PEIDLevelBusiness structure level with which the PEID is associated. For example, 2.

      User prompt = No

      Mandatory = Yes

      		PEIDLevelText
      HyperfindThe Hyperfind, configured to include terminated employees, that the integration references when deleting database entries only when template parameter _EmployeeRehire is set as Yes.

      User prompt = Yes Mandatory = No

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

    See Configure Access to Integrations.

CWFM People Import — Run and test the 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 .
      3. Select the CWFMPeopleImport_iPack_v1 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. 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.
    3. Wait for the confirmation that the integration completed or failed. Close the panel.
    4. Click Tap Refresh .
    5. To see details, select the integration run. Select Run Summary.
  2. 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.

CWFM People Import integration — Source file specification

CWFM People Import — Source file overview

Labor Welfare Fund Deduction — Source file overview

Name

Value

File name

Defined in the CWFM People Import integration parameter Filename.

File extension

CSV

Format

Comma-delimited

Source directory

Defined in the CWFM People Import integration parameter SourceDirectory.

Header row

Yes

Header count

91

Footer row

No

CWFM People Import — Source file layout

CWFM People Import — Source file layout

Column Sequence #

Source file field name

People Information name

Comments

1

Person Number

Person Number

Employee identification number in the application. It could be named Employee ID or File Number in your HR system.

2

First Name

First Name

Employee first name.

3

Last Name

Last Name

Employee last name.

4

Middle Initial/Name

Middle Initial/Name

Employee middle initial.

5

Short Name

Short Name

Employee short name.

6

Badge Number

Badge Number

Leading zeros are not supported.

7

Hire Date

Hire Date

Employee's hire date. The original date of hire will not be updated by the import.

8

Birth Date

Birth Date

Employee's birth date.

9

Phone 1

Phone 1

Varies depending upon customerconfiguration. Often is the home phone number.

10

Phone 2

Phone 2

Varies depending upon customerconfiguration. Often is the mobile phone number.

11

Phone 3

Phone 3

12

Email

Email

Employee's email address. The entry must contain "@"; spaces are not allowed.

13

Address

Address

Employee's address.

14

City

City

Employee's city.

15

State

State

Employee's state.

16

Postal Code

Postal Code

Employee's postal code.

17

Country

Country

Employee's country.

18

Employment Status

Employment Status

Identifies the employee's employment status in the application. The value can be translated to a value defined in the CRT.

Translated status types include:

Active Inactive Terminated

19

Employment Status Effective Date

Employment Status Effective Date

Employment status effective date.

20

Reports to Manager

Reports to Manager

The person to whom the employee reports.

21

Worker Type (Blacklisted)

Worker Type (Blacklisted)

Identifies whether the employee is blocked.

Supported values include:

Yes

No

22

User Account Name

User Account Name

Can be mapped to the employee number.

23

User Account Status

User Account Status

Represents the employee's user status in the application. The value can be translated to a value defined in the CRT.

Translated status types include:

Active Inactive Terminated

24

User Password

User Password

Identifies the default password.

Set the value = Default New Account Password to ensure that the integration utilizes the default password defined in the CWFM People Import integration parameter Default New Account Password.

25

Home Business Structure Level 1

Home Business Structure Level 1

Level 1 of the home business structure assigned to the employee - varies based on configuration.

26

Home Business Structure Level 2

Home Business Structure Level 2

Level 2 of the home business structure assigned to the employee - varies based on configuration.

27

Home Business Structure Level 3

Home Business Structure Level 3

Level 3 of the home business structure assigned to the employee - varies based on configuration.

28

Home Business Structure Level 4

Home Business Structure Level 4

Level 4 of the home business structure assigned to the employee - varies based on configuration.

29

Home Business Structure Level 5

Home Business Structure Level 5

Level 5 of the home business structure assigned to the employee - varies based on configuration.

30

Home Business Structure Level 6

Home Business Structure Level 6

Level 6 of the home business structure assigned to the employee - varies based on configuration.

31

Home Business Structure Level 7

Home Business Structure Level 7

Level 7 of the home business structure assigned to the employee - varies based on configuration.

32

Home Business Structure Level 8

Home Business Structure Level 8

Level 8 of the home business structure assigned to the employee - varies based on configuration.

33

Home Business Structure Level 9

Home Business Structure Level 9

Level 9 of the home business structure assigned to the employee - varies based on configuration.

34

Home/Primary Job

Home/Primary Job

Employee's primary job assignment - Must match a valid job name in the application. The value can be translated to an accepted value using a CRT.

35

Home Labor Category Level 1

Home Labor Category Level 1

Must match a valid Labor Category Level 1 entry in the application.

36

Home Labor Category Level 2

Home Labor Category Level 2

Must match a valid Labor Category Level 2 entry in the application.

37

Home Labor Category Level 3

Home Labor Category Level 3

Must match a valid Labor Category Level 3 entry in the application.

38

Home Labor Category Level 4

Home Labor Category Level 4

Must match a valid Labor Category Level 4 entry in the application.

39

Home Labor Category Level 5

Home Labor Category Level 5

Must match a valid Labor Category Level 5 entry in the application.

40

Home Labor Category Level 6

Home Labor Category Level 6

Must match a valid Labor Category Level 6 entry in the application.

41

Home Job and Labor Category Effective Date

Home Job and Labor Category Effective Date

The effective date of the home job an labor category assignment to the employee. When not defined, it can be populated using one of the following values from the CRT:

Current Date Pay period start date

42

Custom Field 1

Gender

Additional information

43

Custom Field 2

Aadhar Number

Additional information

44

Custom Field 3

Name as Per Aadhar

Additional information

45

Custom Field 4

Father or Husband Name

Additional information

46

Custom Field 5

Permanent Address

Additional information

47

Custom Field 6

Permanent District

Additional information

48

Custom Field 7

Permanent State

Additional information

49

Custom Field 8

Permanent Pin code

Additional information

50

Custom Field 9

ID Mark

Additional information

51

Custom Field 10

UAN Number

Additional information

52

Custom Field 11

Marital Status

Additional information

53

Custom Field 12

Technical Qualification

Additional information

54

Custom Field 13

Academic Qualification

Additional information

55

Custom Field 14

Shoe Size

Additional information

56

Custom Field 15

Blood Group

Additional information

57

Custom Field 16

Workmen Type

Additional information

58

Custom Field 17

Nature Of Job/Work

Additional information

59

Custom Field 18

IP Number

Additional information

60

Custom Field 19

PAN Number

Additional information

61

Custom Field 20

PF Number

Additional information

62

Custom Field 21

Account Number

Additional information

63

Custom Field 22

Bank Name

Additional information

64

Custom Field 23

Future Use1

Additional information

65

Custom Field 24

Future Use2

Additional information

66

Custom Field 25

Future Use3

Additional information

67

Custom Field 26

Future Use4

Additional information

68

Custom Field 27

Future Use5

Additional information

69

Custom Field 28

Future Use6

Additional information

70

Custom Field 29

Future Use7

Additional information

71

Custom Field 30

Future Use8

Additional information

72

Custom Date 1

Future Use Date 1

Person's dates

73

Custom Date 2

Future Use Date 2

Person's dates

74

Custom Date 3

Future Use Date 3

Person's dates

75

Custom Date 4

Future Use Date 4

Person's dates

76

Custom Date 5

Future Use Date 5

Person's dates

77

Trade

Skill

Skill and certification

78

Skill

Proficiency Level

Skill and certification

79

Trade Skill Effective Date

Skill and Proficiency Level Effective Date

Skill and certification

80

Medical Certificate

Certification 1

Skill and certification

81

Medical Certificate Start date

Certification 1 Start date

Skill and certification

82

Medical Certificate End date

Certification 1 End date

Skill and certification

83

Skill Certificate

Certification 2

Skill and certification

84

Skill Certificate Start date

Certification 2 Start date

Skill and certification

85

Skill Certificate End date

Certification 2 End date

Skill and certification

86

Certification 3

Certification 3

Skill and certification

87

Certification 3 Start date

Certification 3 Start date

Skill and certification

88

Certification 3 End date

Certification 3 End date

Skill and certification

89

Certification 4

Certification 4

Skill and certification

90

Certification 4 Start date

Certification 4 Start date

Skill and certification

91

Certification 4 End date

Certification 4 End date

Skill and certification

CWFM People Import integration — Target file specifications

Error files — CWFM People Import integration

Error files capture invalid or duplicate data that already exists in the database. The file structure is similar to the source file, but includes one extra column:

  • Error Message

Error file — File overview

Error file — File overview

Name

Value

File name

Error_ <source filename> _ <timestamp>

File extension

CSV

Delimiter

Comma-delimited

Target directory

Aligns with the user-selected entity and matches the CWFM People Import integration parameter ErrorDirectory.

Header row

Yes

Footer row

No

Archive files — CWFM People Import integration

Processed source files are moved to the archive folder.

Archive file — File overview

Error file — File overview

Name

Value

File name

Archive_ <source filename> _ <timestamp>

File extension

CSV

Delimiter

Comma-delimited

Target directory

Aligns with the user-selected entity and matches the CWFM People Import integration parameter ArchiveDirectory.

Header row

Yes

Footer row

No

CWFM People Import integration — APIs

API details - CWFM People Import integration

API details - CWFM Import Export

API name

Type

Resource path

Description

Retrieve Locations

POST

/v1/commons/locations/multi_read

Retrieve the business structure.

Retrieve Timekeeping Pay Rules

POST

/v1/timekeeping/setup/payrules/multi_read

Retrieve pay rules.

Retrieve Pay Period Timespans

GET

/v1/commons/pay_period

Retrieve pay periods.

Retrieve Persons

POST

/v1/commons/persons/extensions/multi_read

Retrieve person extensions.

Execute Hyperfind Query

POST

/v1/commons/hyperfind/execute

Execute Hyperfind.

Create or Update Persons

POST

/v1/commons/persons/multi_upsert

Create and update a person.

Retrieve Base Person

POST

/v1/commons/persons/base_persons/multi_read

Retrieve base person.

Update Attendance Admin for Multiple Employees

POST

/v1/commons/persons/attendance_admin/multi_update

Assign an attendance administrator to a person.

Update Leave Admin for Multiple Employees

POST

/v1/commons/persons/leave_admin/multi_update

Assign a leave administrator to a person.

Update Leave Profile Assignments

PSOT

/v1/commons/persons/leave_profile/multi_update

Assign a leave profile to a person.

Create Adjustment Rule Assignments

POST

/v1/commons/persons/adjustment_rule/multi_create

Assign an adjustment rule to a person.

Update Attestation Profile Assignments by Person Number

POST

/v1/commons/persons/attestation_profile_assignments/multi_update

Assign an attestation profile to a person.

Assign Cascade Profiles to Multiple Employees

POST

/v1/commons/persons/cascade_profile/multi_update

Assign a cascade profile to a person.

Delete Cascade Profiles for Multiple Employees

POST

/v1/commons/persons/cascade_profile/multi_delete

Remove a cascade profile from a person.

Update Minor Rule and School Calendar Assignments

POST

/v2/commons/persons/minor_rules/multi_upsert

Assign a minor rule to a person.

Update Paycode Value Profile Assignments

POST

/v2/commons/persons/pay_code_value_profiles/multi_update

Assign a paycode value profile to a person.

Assign Percentage Allocation Rule to Multiple Employees

POST

/v1/commons/persons/percentage_allocation_rules/multi_create

Assign a percent allocation rule to a person.

Update Process Profile for Multiple Employees

POST

/v1/commons/persons/process_profiles/multi_update

Assign a process profile to a person.

Update Group Memberships-Multiple Employees

POST

/v1/commons/persons/schedule_groups/multi_upsert

Assign a schedule group to a person.

Update Rule Set Assignments for Multiple Employees

POST

/v1/commons/persons/schedule_rule_sets/multi_upsert

Assign a schedule rule set to a person.

Update Employment Term Assignments

POST

/v1/commons/persons/employment_terms/multi_upsert

Assign an employment term to a person.

Update Person TeleStaff Assignments for Multiple Employees

POST

/v1/commons/persons/telestaff_assignments/multi_update

Assign Workforce Management to a person.

Retrieve User Preferences for Current User

GET

/v1/commons/user_preferences/locale_policy

Retrieve current user or tenant locale.

CWFM Reports integration

CWFM Reports — 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.
  1. Get the URL, User, and Password for the APIGatewayServer.
  2. 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 Contract Workforce Management 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 Select items.

  3. Configure the CWFM Reports 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 Search button. It can take several seconds before the button becomes active.

      3. Scroll to and select the integration pack: CWFM Reports > CWFMReports_iPack_v1.

  4. 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.
    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

      CWFMReports_iPack_v1_APIGatewayServer

      Required

      To change the default API gateway server:

      1. Clear Use Default.
      2. Enter the URL to the server.

        Example: <tenantURL>/api

      CWFMReports_iPack_v1_DatabaseServer

      Required

      The database server setting defines the connection to the file that contains the records.

      To change the default server parameters:

      1. For each field, clear Use Default.
      2. 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.

      CWFMReports_iPack_v1_WorkedHours_CRT

      Required

      Enable Override.

      CWFMReports_iPack_v1_AttendanceAwardVariant1_CRT

      Required

      Enable Override.

      CWFMReports_iPack_v1_AttendanceAwardVariant2_CRT

      Required

      Enable Override.

      CWFMReports_iPack_v1_WagesParameter_CRT

      Required

      Enable Override.

      CWFMReports_iPack_v1_SupervisorOvertimeRate_CRT

      Required

      Enable Override.

      CWFMReports_iPack_v1_Locale_CRT

      Required

      Enable Override.

  5. Configure process properties
    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 CWFMReports_iPack_v1_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 properties

      Process property name

      Column header value

      _CWFMReports_iPack_v1_WorkedHours_CRT

      Employee Status,Display Pattern,Paid/Unpaid,Worked,Paycode Name

      _CWFMReports_iPack_v1_AttendanceAwardVariant1_CRT

      Variant 1,Values

      _CWFMReports_iPack_v1_AttendanceAwardVariant2_CRT

      Variant 2,Values

      _CWFMReports_iPack_v1_WagesParameter_CRT

      ParameterName,ParameterValue

      _CWFMReports_iPack_v1_SupervisorOvertimeRate_CRT

      Key 1,Key 2,Key3,Key 4,Key 5,Overtime Rate

      _CWFMReports_iPack_v1_Locale_CRT

      Parameter Name,Locale Policy,Message,Description

CWFM Reports — Configure the 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.

CWFM Reports — Application Setup

  1. Configure Access to Integrations.

  2. Configure the following:

    • Integration List Parameters: Create integration list parameters that identify the reporting periods and contract workforce management reports. See the Configure Integration List Parameters topic.

      Examples include:

    Name: CWFM Reporting Period

    Description: Reporting Periods applicable to Contract Workforce Management Report.

    Parameter values:

    Parameter values:

    Name

    Description

    Value

    Default value

    Current Month

    Timeframe for which the calculation must be completed.

    Current Month

    No

    Previous Month

    Timeframe for which the calculation must be completed.

    Previous Month

    Yes

    Current Year

    Timeframe for which the calculation must be completed.

    Current Year

    No

    Previous Year

    Timeframe for which the calculation must be completed.

    Previous Year

    No

    Name: CWFM Report List

    Description: Contract Workforce Management Reports.

    Parameter values:

    Parameter values:

    Name

    Description

    Value

    Default value

    Annual Return Report

    Enables selection of the Annual Return Report.

    CWFM-AnnualReturnReport

    No

    Muster Roll Report

    Enables selection of the Muster Roll Report.

    CWFM-MusterRollReport

    No

    Register of Contract Workmen employed by ContractorReport

    Enables selection of the Register of Contract Workmen employed by ContractorReport.

    CWFM-RegisterofContractWorkmenemployedbyContractorReport

    No

    Register of Contractors Report

    Enables selection of the Register of Contractors Report.

    CWFM-RegisterOfContractorsReport

    No

    Register of Overtime Report

    Enables selection of the Register of Overtime Report.

    CWFM-RegisterofOvertimeReport

    No

    Register of Wages Cum Muster Roll Report

    Enables selection of the Register of Wage-Cum-Muster Roll Report.

    CWFM-RegisterofWagesCumMusterRollReport

    No

    Register of Wages Report

    Enables selection of the Register of Wages Report.

    CWFM-RegisterOfWagesReport

    No

    Wage Slip Report

    Enables selection of the Wage Slip Report.

    CWFM-WageSlipReport

    No

  • Extension tables: Configure the CWFM Reports extension tables. See the Extension Tables topic.

    For each extension table, enter the following in the DDL Command Name and Commands for execution fields:

DDL Command Name: Annual Return Report

Commands for execution:

CREATE TABLE annualreturnreport
(
arrchangeinmanagementofestabilshment Varchar(255),
arrcontractorid Varchar(255),
arrcontractornameandaddress Varchar(255),
arrcontractperiodfrom Varchar(255),
arrcontractperiodto Varchar(255),
arremployeeexecuteddate Varchar(255),
arremployeerunby Varchar(255),
arrestablishmentdistict Varchar(255),
arrestablishmentpostaladdress Varchar(255),
arrexecutionid Varchar(255),
arrmanagerfullname Varchar(255),
arrmaxworkeremployedbycontractor Varchar(255),
arrmaxworkmenemployed Varchar(255),
arrnameofestablishment Varchar(255),
arrnatureofoperation Varchar(255),
arrnatureofwork Varchar(255),
arrnatureofworkcontractlabour Varchar(255),
arrnoofdaysworked Varchar(255),
arrnoofmandaysworked Varchar(255),
arrpersonnumber Varchar(255),
arrprincipalemployernameandaddress Varchar(255),
arrreportid Varchar(255),
arrserialno Varchar(255),
arrtotalcontractorduringyear Varchar(255),
arrtotaldaysbycontractorlabour Varchar(255),
arrtotaldaysdirectlabour Varchar(255),
arrtotalmandaysbycontractlabour Varchar(255),
arrtotalmandaysdirectworkmenemployed Varchar(255),
arryearending Varchar(255)
);

DDL Command Name: MusterRollReport

Commands for execution:

CREATE TABLE MusterRollReport
(
mrcontractornameandaddress VARCHAR(255),
mrdaterange VARCHAR(255),
mremployeeexecuteddate VARCHAR(255),
mremployeefathernameorhusbandname VARCHAR(255),
mremployeefullname VARCHAR(255),
mremployeemonthdate1 VARCHAR(255),
mremployeemonthdate10 VARCHAR(255),
mremployeemonthdate11 VARCHAR(255),
mremployeemonthdate12 VARCHAR(255),
mremployeemonthdate13 VARCHAR(255),
mremployeemonthdate14 VARCHAR(255),
mremployeemonthdate15 VARCHAR(255),
mremployeemonthdate16 VARCHAR(255),
mremployeemonthdate17 VARCHAR(255),
mremployeemonthdate18 VARCHAR(255),
mremployeemonthdate19 VARCHAR(255),
mremployeemonthdate2 VARCHAR(255),
mremployeemonthdate20 VARCHAR(255),
mremployeemonthdate21 VARCHAR(255),
mremployeemonthdate22 VARCHAR(255),
mremployeemonthdate23 VARCHAR(255),
mremployeemonthdate24 VARCHAR(255),
mremployeemonthdate25 VARCHAR(255),
mremployeemonthdate26 VARCHAR(255),
mremployeemonthdate27 VARCHAR(255),
mremployeemonthdate28 VARCHAR(255),
mremployeemonthdate29 VARCHAR(255),
mremployeemonthdate3 VARCHAR(255),
mremployeemonthdate30 VARCHAR(255),
mremployeemonthdate31 VARCHAR(255),
mremployeemonthdate4 VARCHAR(255),
mremployeemonthdate5 VARCHAR(255),
mremployeemonthdate6 VARCHAR(255),
mremployeemonthdate7 VARCHAR(255),
mremployeemonthdate8 VARCHAR(255),
mremployeemonthdate9 VARCHAR(255),
mremployeemonthwisedate1 VARCHAR(255),
mremployeemonthwisedate10 VARCHAR(255),
mremployeemonthwisedate11 VARCHAR(255),
mremployeemonthwisedate12 VARCHAR(255),
mremployeemonthwisedate13 VARCHAR(255),
mremployeemonthwisedate14 VARCHAR(255),
mremployeemonthwisedate15 VARCHAR(255),
mremployeemonthwisedate16 VARCHAR(255),
mremployeemonthwisedate17 VARCHAR(255),
mremployeemonthwisedate18 VARCHAR(255),
mremployeemonthwisedate19 VARCHAR(255),
mremployeemonthwisedate2 VARCHAR(255),
mremployeemonthwisedate20 VARCHAR(255),
mremployeemonthwisedate21 VARCHAR(255),
mremployeemonthwisedate22 VARCHAR(255),
mremployeemonthwisedate23 VARCHAR(255),
mremployeemonthwisedate24 VARCHAR(255),
mremployeemonthwisedate25 VARCHAR(255),
mremployeemonthwisedate26 VARCHAR(255),
mremployeemonthwisedate27 VARCHAR(255),
mremployeemonthwisedate28 VARCHAR(255),
mremployeemonthwisedate29 VARCHAR(255),
mremployeemonthwisedate3 VARCHAR(255),
mremployeemonthwisedate30 VARCHAR(255),
mremployeemonthwisedate31 VARCHAR(255),
mremployeemonthwisedate4 VARCHAR(255),
mremployeemonthwisedate5 VARCHAR(255),
mremployeemonthwisedate6 VARCHAR(255),
mremployeemonthwisedate7 VARCHAR(255),
mremployeemonthwisedate8 VARCHAR(255),
mremployeemonthwisedate9 VARCHAR(255),
mremployeepersonnumber VARCHAR(255),
mremployeeremarks VARCHAR(255),
mremployeerunby VARCHAR(255),
mremployeesex VARCHAR(255),
mremployeetotalpaiddays VARCHAR(255),
mrexecutionid VARCHAR(255),
mrforthemonthof VARCHAR(255),
mrhyperfindorlocation VARCHAR(255),
mrnameandaddressofestablishment VARCHAR(255),
mrnatureandlocationofwork VARCHAR(255),
mrprincipalemployernameandaddress VARCHAR(255),
mrreportid VARCHAR(255)
);

DDL Command Name: WorkmenEmployedByContractorReport

Commands for execution:

CREATE TABLE WorkmenEmployedByContractorReport
(
WECNameandaddressofContractor VARCHAR(255),
WECNatureandlocationofwork VARCHAR(255),
WECNameandaddressofPrincipalEmployer VARCHAR(255),
WECNameandaddressofestablishment VARCHAR(255),
WECSerialNo VARCHAR(255),
WECEmployeeNumber VARCHAR(255),
WECEmployeeFullName VARCHAR(255),
WECEmployeeAgeandSex VARCHAR(255),
WECEmployeeFatherNameandHusbandName VARCHAR(255),
WECEmployeeNatureofEmploymentandDesignation VARCHAR(255),
WECEmployeePermanentAddress VARCHAR(255),
WECEmployeeLocalAddress VARCHAR(255),
WECEmployeeDateofCommencement VARCHAR(255),
WECEmployeeSignature VARCHAR(255),
WECEmployeeDateofTermination VARCHAR(255),
WECEmployeeReasonofTermination VARCHAR(255),
WECEmployeeRemarks VARCHAR(255),
WECEmployeeRunBy VARCHAR(255),
WECEmployeeExecutedDate VARCHAR(255),
WECReportID VARCHAR(255),
WECExecutionID VARCHAR(255)
);

DDL Command Name: Register of Contractor

Commands for execution:

CREATE TABLE registerofcontractorreport
(
rccontractmaxemployee Varchar(255),
rccontractornameandaddress Varchar(255),
rccontractperiodfrom Varchar(255),
rccontractperiodto Varchar(255),
rcdaterange Varchar(255),
rcemployeeexecuteddate Varchar(255),
rcemployeerunby Varchar(255),
rcexecutionid Varchar(255),
rchyperfindorlocation Varchar(255),
rcnameandaddressoftheestablishment Varchar(255),
rcnatureoflocation Varchar(255),
rcnatureofwork Varchar(255),
rcpersonnumber Varchar(255),
rcprincipalemployernameandaddress Varchar(255),
rcreportid Varchar(255)
);

DDL Command Name: RegisterofOvertimeReport

Commands for execution:

CREATE TABLE RegisterofOvertimeReport
(
RORNameandadressofContractor VARCHAR(255),
RORNatureandlocationofwork VARCHAR(255),
RORNameandaddressofestablishment VARCHAR(255),
RORNameandaddressofPrincipalEmployer VARCHAR(255),
RORSerialNo VARCHAR(255),
ROREmployeePersonNumber VARCHAR(255),
ROREmployeeFullName VARCHAR(255),
ROREmployeeFatherNameandHusbandName VARCHAR(255),
ROREmployeeSex VARCHAR(255),
ROREmployeeNatureofEmploymentandDesignation VARCHAR(255),
ROREmployeeMonthDate1 VARCHAR(255),
ROREmployeeMonthDate2 VARCHAR(255),
ROREmployeeMonthDate3 VARCHAR(255),
ROREmployeeMonthDate4 VARCHAR(255),
ROREmployeeMonthDate5 VARCHAR(255),
ROREmployeeMonthDate6 VARCHAR(255),
ROREmployeeMonthDate7 VARCHAR(255),
ROREmployeeMonthDate8 VARCHAR(255),
ROREmployeeMonthDate9 VARCHAR(255),
ROREmployeeMonthDate10 VARCHAR(255),
ROREmployeeMonthDate11 VARCHAR(255),
ROREmployeeMonthDate12 VARCHAR(255),
ROREmployeeMonthDate13 VARCHAR(255),
ROREmployeeMonthDate14 VARCHAR(255),
ROREmployeeMonthDate15 VARCHAR(255),
ROREmployeeMonthDate16 VARCHAR(255),
ROREmployeeMonthDate17 VARCHAR(255),
ROREmployeeMonthDate18 VARCHAR(255),
ROREmployeeMonthDate19 VARCHAR(255),
ROREmployeeMonthDate20 VARCHAR(255),
ROREmployeeMonthDate21 VARCHAR(255),
ROREmployeeMonthDate22 VARCHAR(255),
ROREmployeeMonthDate23 VARCHAR(255),
ROREmployeeMonthDate24 VARCHAR(255),
ROREmployeeMonthDate25 VARCHAR(255),
ROREmployeeMonthDate26 VARCHAR(255),
ROREmployeeMonthDate27 VARCHAR(255),
ROREmployeeMonthDate28 VARCHAR(255),
ROREmployeeMonthDate29 VARCHAR(255),
ROREmployeeMonthDate30 VARCHAR(255),
ROREmployeeMonthDate31 VARCHAR(255),
ROREmployeeMonthwiseDate1 VARCHAR(255),
ROREmployeeMonthwiseDate2 VARCHAR(255),
ROREmployeeMonthwiseDate3 VARCHAR(255),
ROREmployeeMonthwiseDate4 VARCHAR(255),
ROREmployeeMonthwiseDate5 VARCHAR(255),
ROREmployeeMonthwiseDate6 VARCHAR(255),
ROREmployeeMonthwiseDate7 VARCHAR(255),
ROREmployeeMonthwiseDate8 VARCHAR(255),
ROREmployeeMonthwiseDate9 VARCHAR(255),
ROREmployeeMonthwiseDate10 VARCHAR(255),
ROREmployeeMonthwiseDate11 VARCHAR(255),
ROREmployeeMonthwiseDate12 VARCHAR(255),
ROREmployeeMonthwiseDate13 VARCHAR(255),
ROREmployeeMonthwiseDate14 VARCHAR(255),
ROREmployeeMonthwiseDate15 VARCHAR(255),
ROREmployeeMonthwiseDate16 VARCHAR(255),
ROREmployeeMonthwiseDate17 VARCHAR(255),
ROREmployeeMonthwiseDate18 VARCHAR(255),
ROREmployeeMonthwiseDate19 VARCHAR(255),
ROREmployeeMonthwiseDate20 VARCHAR(255),
ROREmployeeMonthwiseDate21 VARCHAR(255),
ROREmployeeMonthwiseDate22 VARCHAR(255),
ROREmployeeMonthwiseDate23 VARCHAR(255),
ROREmployeeMonthwiseDate24 VARCHAR(255),
ROREmployeeMonthwiseDate25 VARCHAR(255),
ROREmployeeMonthwiseDate26 VARCHAR(255),
ROREmployeeMonthwiseDate27 VARCHAR(255),
ROREmployeeMonthwiseDate28 VARCHAR(255),
ROREmployeeMonthwiseDate29 VARCHAR(255),
ROREmployeeMonthwiseDate30 VARCHAR(255),
ROREmployeeMonthwiseDate31 VARCHAR(255),
ROREmployeeTotalOvertimeworked VARCHAR(255),
ROREmployeeNormalrateofWages VARCHAR(255),
ROREmployeeOvertimerateofwages VARCHAR(255),
ROREmployeeOvertimeEarnings VARCHAR(255),
ROREmployeeDateOvertimePaid VARCHAR(255),
ROREmployeeRemarks VARCHAR(255),
ROREmployeeRunBy VARCHAR(255),
ROREmployeeExecutedDate VARCHAR(255),
RORReportID VARCHAR(255),
RORExecutionID VARCHAR(255)
);

DDL Command Name: WageCumMusterRollReports

Commands for execution:

CREATE TABLE WageCumMusterRollReports
(
wmremployeebasicwage VARCHAR(255),
wmremployeeda VARCHAR(255),
wmremployeedailyrateofwage VARCHAR(255),
wmremployeedaysworked1 VARCHAR(255),
wmremployeedaysworked2 VARCHAR(255),
wmremployeedaysworked3 VARCHAR(255),
wmremployeedaysworked4 VARCHAR(255),
wmremployeedaysworked5 VARCHAR(255),
wmremployeedaysworked6 VARCHAR(255),
wmremployeedaysworked7 VARCHAR(255),
wmremployeedaysworked8 VARCHAR(255),
wmremployeedaysworked9 VARCHAR(255),
wmremployeedaysworked10 VARCHAR(255),
wmremployeedaysworked11 VARCHAR(255),
wmremployeedaysworked12 VARCHAR(255),
wmremployeedaysworked13 VARCHAR(255),
wmremployeedaysworked14 VARCHAR(255),
wmremployeedaysworked15 VARCHAR(255),
wmremployeedaysworked16 VARCHAR(255),
wmremployeedaysworked17 VARCHAR(255),
wmremployeedaysworked18 VARCHAR(255),
wmremployeedaysworked19 VARCHAR(255),
wmremployeedaysworked20 VARCHAR(255),
wmremployeedaysworked21 VARCHAR(255),
wmremployeedaysworked22 VARCHAR(255),
wmremployeedaysworked23 VARCHAR(255),
wmremployeedaysworked24 VARCHAR(255),
wmremployeedaysworked25 VARCHAR(255),
wmremployeedaysworked26 VARCHAR(255),
wmremployeedaysworked27 VARCHAR(255),
wmremployeedaysworked28 VARCHAR(255),
wmremployeedaysworked29 VARCHAR(255),
wmremployeedaysworked30 VARCHAR(255),
wmremployeedaysworked31 VARCHAR(255),
wmremployeededuction VARCHAR(255),
wmremployeeexecuteddate VARCHAR(255),
wmremployeefullname VARCHAR(255),
wmremployeeinitialcontractor VARCHAR(255),
wmremployeemonthdate1 VARCHAR(255),
wmremployeemonthdate2 VARCHAR(255),
wmremployeemonthdate3 VARCHAR(255),
wmremployeemonthdate4 VARCHAR(255),
wmremployeemonthdate5 VARCHAR(255),
wmremployeemonthdate6 VARCHAR(255),
wmremployeemonthdate7 VARCHAR(255),
wmremployeemonthdate8 VARCHAR(255),
wmremployeemonthdate9 VARCHAR(255),
wmremployeemonthdate10 VARCHAR(255),
wmremployeemonthdate11 VARCHAR(255),
wmremployeemonthdate12 VARCHAR(255),
wmremployeemonthdate13 VARCHAR(255),
wmremployeemonthdate14 VARCHAR(255),
wmremployeemonthdate15 VARCHAR(255),
wmremployeemonthdate16 VARCHAR(255),
wmremployeemonthdate17 VARCHAR(255),
wmremployeemonthdate18 VARCHAR(255),
wmremployeemonthdate19 VARCHAR(255),
wmremployeemonthdate20 VARCHAR(255),
wmremployeemonthdate21 VARCHAR(255),
wmremployeemonthdate22 VARCHAR(255),
wmremployeemonthdate23 VARCHAR(255),
wmremployeemonthdate24 VARCHAR(255),
wmremployeemonthdate25 VARCHAR(255),
wmremployeemonthdate26 VARCHAR(255),
wmremployeemonthdate27 VARCHAR(255),
wmremployeemonthdate28 VARCHAR(255),
wmremployeemonthdate29 VARCHAR(255),
wmremployeemonthdate30 VARCHAR(255),
wmremployeemonthdate31 VARCHAR(255),
wmremployeenatureofemploymentanddesignation VARCHAR(255),
wmremployeenatureofpayment VARCHAR(255),
wmremployeenetamountpaid VARCHAR(255),
wmremployeeovertime VARCHAR(255),
wmremployeepersonnumber VARCHAR(255),
wmremployeerunby VARCHAR(255),
wmremployeesignature VARCHAR(255),
wmremployeetotal VARCHAR(255),
wmrexecutionid VARCHAR(255),
wmrnameandaddressofestablishment VARCHAR(255),
wmrnameandaddressofprincipalemployer VARCHAR(255),
wmrnameandadressofcontractor VARCHAR(255),
wmrnatureandlocationofwork VARCHAR(255),
wmrreportid VARCHAR(255),
wmrserialno VARCHAR(255),
wmrtotalattendance VARCHAR(255),
wmrwageperiodmonthandyear VARCHAR(255)
);

DDL Command Name: Registerofwagesreport

Commands for execution:

CREATE TABLE registerofwagesrepor
(
rwcontractornameandaddress VARCHAR(255),
rwdaterange VARCHAR(255),
rwemployeebasicwage VARCHAR(255),
rwemployeeda VARCHAR(255),
rwemployeedailyrateofwage VARCHAR(255),
rwemployeedaysworked VARCHAR(255),
rwemployeededuction VARCHAR(255),
rwemployeeexecuteddate VARCHAR(255),
rwemployeefullname VARCHAR(255),
rwemployeeinitialcontractor VARCHAR(255),
rwemployeenatureofemployment VARCHAR(255),
rwemployeenatureofpayment VARCHAR(255),
rwemployeenetamountpaid VARCHAR(255),
rwemployeeovertime VARCHAR(255),
rwemployeepersonnumber VARCHAR(255),
rwemployeerunby VARCHAR(255),
rwemployeesignature VARCHAR(255),
rwemployeetotal VARCHAR(255),
rwemployeeunitofwork VARCHAR(255),
rwexecutionid VARCHAR(255),
rwhyperfindorlocation VARCHAR(255),
rwnameandaddressofestablishment VARCHAR(255),
rwnatureandlocationofwork VARCHAR(255),
rwprincipalemployernameandaddress VARCHAR(255),
rwreportid VARCHAR(255),
rwwageperiodmonthandyear VARCHAR(255)
);

DDL Command Name: WageSlipReport

Commands for execution:

CREATE TABLE WageSlipReport
(
wscontractornameandaddress VARCHAR(255),
wsdaterange VARCHAR(255),
wsemployeedailyrateofwage VARCHAR(255),
wsemployeedaysworked VARCHAR(255),
wsemployeededuction VARCHAR(255),
wsemployeeexecuteddate VARCHAR(255),
wsemployeefatherorhusbandname VARCHAR(255),
wsemployeefullname VARCHAR(255),
wsemployeegrosswage VARCHAR(255),
wsemployeenetamountpaid VARCHAR(255),
wsemployeeovertimewage VARCHAR(255),
wsemployeereportrundate VARCHAR(255),
wsemployeerunby VARCHAR(255),
wsemployeeunitofwork VARCHAR(255),
wsexecutionid VARCHAR(255),
“WSFORTHEWEEK/FORTNIGHT/MONTHENDING” VARCHAR(255),
wshyperfindorlocation VARCHAR(255),
wsnameandaddressofestablishment VARCHAR(255),
wsnatureofworkandlocation VARCHAR(255),
wspersonnumber VARCHAR(255),
wsreportid VARCHAR(255)
);

CWFM Reports — 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.

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.

CWFMReports_iPack_v1_WorkedHours_CRT: Contains data used in the Muster Roll and Annual Return Reports.

CWFM Reports — Worked Hours CRT structure

CWFM Reports — Worked Hours CRT structure

Column name

Description

Employee Status

Status values that are contained in the Muster Roll Report.

Supported values are limited to:

Weekly off Worked

Weekly off

Unexcused Presence

Present

Leave

Holiday worked

Holiday

Half Day Present

Absent

Display Pattern

Display patterns corresponding to Employee Status values that are contained in the Muster Roll Report.

Supported values are limited to:

WOW

WO

UP

P

L

HW

H

HD

A

Paid/Unpaid

Determines whether the worked hours are counted as paid days.

Support values:

Yes

No

Worked

Determines whether the hours are treated as worked in the Annual Return Report.

Support values:

Yes

No

Paycode Name

Paycodes that used in conjunction with the status.

CWFM Reports — Worked Hours CRT sample content

CWFM Reports — Worked Hours CRT sample content

Employee Status

Display Pattern

Paid/Unpaid

Worked

Paycode Name

Weekly off Worked

WOW

Yes

Yes

Weekly off

WO

No

No

Unexcused Presence

UP

Yes

No

Present

P

Yes

Yes

Regular

Leave

L

Yes

No

Leave Paycode

Holiday Worked

HW

Yes

Yes

Half Day Present

HD

Yes

Yes

Regular

Absent

A

Yes

No

Absent

CWFMReports_iPack_v1_AttendanceAwardVariant1_CRT: Controls variant 1 attendance awards.

CWFM Reports — Attendance Award Variant1 CRT structure

CWFM Reports — Attendance Award Variant1 CRT structure

Column name

Description

Variant 1

Variable used in the calculation of an attendance award.

Supported values are limited to:

First Month Award

Second Month Award

Third Month Award

Following Month Award

Perfect Attendance Male

Perfect Attendance Female

Following Month Attendance Male

Following Month Attendance Female

Values

Attendance award value for the corresponding Variant 1.

CWFM Reports — Attendance Award Variant1 CRT sample content

CWFM Reports — Attendance Award Variant1 CRT sample content

Variant 1

Values

First Month Award

400

Second Month Award

600

Third Month Award

800

Following Month Award

300

Perfect Attendance Male

0

Perfect Attendance Female

1

Following Month Attendance Male

1

Following Month Attendance Female

1

CWFMReports_iPack_v1_AttendanceAwardVariant2_CRT: Controls variant 2 attendance awards.

CWFM Reports — Attendance Award Variant2 CRT structure

CWFM Reports — Attendance Award Variant2 CRT structure

Column name

Description

Variant 2

Variable used in the calculation of an attendance award.

Supported values are limited to:

Perfect Attendance Award

Perfect Attendance

Following Month 1 Leave Award

Following Month 2 Leave Award

Following Month 3 Leave Award

Values

Attendance award value for the corresponding Variant 2.

CWFM Reports — Attendance Award Variant2 CRT sample content

CWFM Reports — Attendance Award Variant2 CRT sample content

Variant 2

Values

Perfect Attendance Award

500

Perfect Attendance

0

Following Month 1 Leave Award

400

Following Month 2 Leave Award

300

Following Month 3 Leave Award

200

CWFMReports_iPack_v1_WagesParameter_CRT: Controls wage parameters.

CWFM Reports — Wages Parameter CRT structure

CWFM Reports — Wages Parameter CRT structure

Column name

Description

ParameterName

Wage parameter name.

Supported values are limited to:

CanteenFixRate DeductionCombinedPayCode GrossSalaryCalculation GrossSalaryCombinedPayCode HardshipAllowanceCombinedPayCode OvertimeCombinedMoneyPayCode OvertimeCombinedPayCode OvertimeMultiplier PFValue ShiftAllowanceCombinedPayCode ShiftAllowanceFixRate TotalEarningCombinedPayCode TotalEarningsCalculation NonConsideredWorkerTypesForDeduction Round Grace

ParameterValue

Wage value for the corresponding ParameterName.

Round and Grace parameters must be configured such that any decimal can be rounded up or down, but is restricted to the grace limit before rounding. For example:

Round and Grace scenarios

Round and Grace scenarios

Scenario

Round

Grace

Value

Output

Action

1

1

0.5

1.40

1

Round down.

2

1

0.5

1.51

2

Round up.

3

10

5

231

230

Round down.

4

10

5

236

240

Round up.

5

1

0.99

1.20

1

Round down.

6

1

0.01

1.20

2

Round up.

7

1

0.00

1.20

1.20

Do not round.

CWFM Reports — Wages Parameter CRT sample content

CWFM Reports — Wages Parameter CRT sample content

ParameterName

ParameterValue

AnyOtherWageHeadOvertime

CanteenFixRate

75

DeductionCombinedPayCode

CWFMDeductionCombinedPaycode

GrossSalaryCalculation

Basic,DA,HRA,conveyanceallowance,specialallowance,skillallowance,UniformAllowance,WashingAllowance,GrossSalaryCombinedPaycode

GrossSalaryCombinedPayCode

CWFMGrossSalaryCombinedPaycode

HardshipAllowanceCombinedPayCode

CWFMHardshipAllowanceCombinedPay

OvertimeCombinedMoneyPayCode

OvertimeCombinedPayCode

OvertimePayCode

OvertimeMultiplier

2

PFValue

15000

ShiftAllowanceCombinedPayCode

CWFMShiftAllowanceCombinedPaycod

ShiftAllowanceFixRate

20

TotalEarningCombinedPayCode

CWFMTotalEarningCombinedPaycode

TotalEarningsCalculation

basic,da,hra,conveyanceallowance,specialallowance,skillallowance,uniformallowance,washingallowance,Leave with Wages,Advance Bonus,Overtime,TotalEarningCombinedPaycode

NonConsideredWorkerTypesForDeduction

NAPS,NEEMS

Round

1

Grace

0.5

CWFMReports_iPack_v1_SupervisorOvertimeRate_CRT: Controls the supervisor overtime rate.

CWFM Reports — Supervisor Overtime Rate CRT structure

CWFM Reports — Supervisor Overtime Rate CRT structure

Column name

Description

Key 1

The compound key.

Key 2

Generic key that is set at runtime.

Key 3

Generic key that is set at runtime.

Key 4

Generic key that is set at runtime.

Key 5

Generic key that is set at runtime.

Overtime Rate

Overtime rate that is used to calculate the supervisor overtime.

Note:

  • The first row must contain the default value.

  • Wildcards (*) are supported in each of the Key columns.

  • Supported Key values include:

    • Location

    • Accrual

    • Pay Rule

    • Certification Name

    • Skill

    • Worker Type

    • Person ID

CWFMReports_iPack_v1_Locale_CRT: Allows translation of messages and labels into different languages.

CWFM Reports — Locale CRT structure

CWFM Reports — Locale CRT structure

Column name

Description

Parameter Name

Key for which localization is defined.

Locale Policy

Locale Policy.

Note:

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, or value of the label defined in the Run Summary section.

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").

CWFM Reports — Locale CRT sample content

CWFM Reports — Locale CRT sample content

Parameter Name

Locale Policy

Message

Description

Error_AllPayCodeAreInvalid

*

Configured paycode values are invalid.

Error_CompDate

*

Start Date must precede End Date.

Error_ContractorNode

*

Data type must be integer.

Error_EndDate

*

End Date must be selected.

Error_GrossSalaryCalcParameterBlank

*

Gross Salary Calculation field must be configured.

Error_HyperfindAndLocationSelector

*

Hyperfind or location must be provided.

Error_InvalidAnnualDate

*

The date range must not exceed 365 days.

Error_InvalidEmployee

*

Invalid employee provided.

Error_InvalidPayCode

*

Invalid paycode.

Error_NoEmployee

*

Employee not available.

Error_OvertimeCombinedPayCode

*

Combined overtime paycode not configured.

Error_OvertimeMultiplier

*

Overtime Multiplier not configured.

Error_OvertimePayCode

*

Overtime paycode not configured.

Error_PENode

*

Data type must be integer.

Error_ReportCommonMessage

*

Report could not be run.

Error_ReportCommonValue

*

Invalid parameters.

Error_ReportList

*

Report list cannot be blank.

Please select at least one report.

Error_ReportName

*

Report name not configured.

Error_ReportOutputFormatIncorrect

*

Incorrect report output format. Accepted values: PDF, CSV, XLXS

Error_ReportOutputFormatMissing

*

Report output format not configured.

Error_ReportStatus

*

Failed to run the report.

Error_StartAndEndDateInvalid

*

Start and End Dates must fall in the same month of a previous or current period.

Error_StartDate

*

Start Date must be selected.

Error_StartDateIsInFuture

*

Start Date must not be in the future.

Error_TimecardReport

*

Timecard Report failed to qualify the validation.

Error_TimePeriod

*

Time Period not configured.

Error_TotalSalaryCalcParameterBlank

*

Total SalaryCalculation field must be configured.
Error_WagesTabelData*Invalid data format in either the wage or deduction table. Please check.

Label_DisqualifiedReports

*

Disqualified Reports

Label_GeneratedReports

*

Generated Reports

Label_IntegrationExecutionId

*

Integration Run ID

Label_IntegrationType

*

Integration Type

Label_ReportLibraryLink

*

Report Library Link

Label_TotalReports

*

Total Reports

Message_BlankReport

*

No data found to generate the report.

Message_SuccessReportStatus

*

Please navigate to Report Library page to retrieve the report

CWFM Reports — Install the 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.
  1. Select Main Menu Administration > Application Setup > Integrations Setup > Install Integrations.
  2. Click Tap Create .
  3. In Integration Name enter a unique name, such as CWFMReports_iPack_v1.
  4. (Optional) Enter a Description.
    Note: Do not select API Integration.
  5. In File Access, select Source/Output Download to select a connection.
  6. (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.
  7. (Optional) Select Re-Run to allow repeated runs of the integration with the same parameter values as the previous run.
  8. (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.

  9. 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.
  10. Configure Integration template and parameters:
    1. In Integration Template, select CWFMReports_iPack_v1.
    2. Click Tap Assign .
    3. In Integration Parameters, you can override default settings. Click Tap Create.
    4. Complete the configuration for each integration parameter value.
    5. Click Tap Save.

      Repeat this step for each integration control parameter that supports the CWFM Reports process.

      CWFM Reports — Integration Parameters

      CWFM Reports — Integration Parameters

      Parameter name

      Description / Default value / User prompt

      Template parameter

      Parameter type

      HyperfindandLocation

      The default Hyperfind or Location query that contains the employees for whom the integration is run.

      User prompt = Yes

      Mandatory = Yes

      HyperfindandLocation

      Hyperfind

      EmployeeIDs

      A comma-separated list of specific employees for whom the integration is run.

      When no value is entered, the integration defaults to the HyperfindandLocation 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

      String

      ReportList

      Identifies the integration list parameter that defines the CWFM report list, such as CWFM Report List.

      User prompt = Yes

      Mandatory = Yes

      ReportList

      List

      ReportLibraryLink

      Identifies the Report Library page URL that displays in the Run Summary page.

      User prompt = No

      Mandatory = Yes

      ReportLibraryLink

      String

      StartDate

      Identifies the report start date.

      Must be populated in conjunction with the EndDate.

      User prompt = Yes

      Mandatory = Yes, when EndDate is populated.

      StartDate

      Date

      EndDate

      Identifies the report end date.

      Must be populated in conjunction with the StartDate.

      User prompt = Yes

      Mandatory = Yes, when StartDate is populated.

      EndDate

      Date

      DateFormat

      Date format applied to all dates in the generated reports.

      Supported values include:

      MM/dd/yyyy

      MM-dd-yyyy

      dd/MM/yyyy

      dd-MM-yyyy (default)

      yyyy/MM/dd

      yyyy-MM-dd

      User prompt = No

      Mandatory = Yes

      DateFormat

      String

      PENode

      Business structure level where the Principal Employer is defined.

      Default = 2

      User prompt = No

      Mandatory = Yes

      PENode

      String

      ContractorNode

      Business structure level where the Contractor is defined.

      Default = 4

      User prompt = No

      Mandatory = Yes

      ContractorNode

      String

      ReportingPeriod

      Identifies the integration list parameter that defines the CWFM symbolic reporting periods, such as CWFM Reporting Period.

      User prompt = Yes

      Mandatory = Yes

      Note: StartDate and EndDate, when populated, take precedence over ReportingPeriod.

      ReportingPeriod

      Dropdown

      IsAttendanceAwardApplicable

      Determines whether the attendance award applies.

      Supported values:

      true (default)

      false

      User prompt = No

      Mandatory = Yes

      IsAttendanceAwardApplicable

      Boolean

      AttendanceAwardVariant

      Identifies the attendance award variant processed by the integration.

      Supported values:

      Variant1 (default)

      Variant2

      User prompt = No

      Mandatory = Yes, when IsAttendanceAwardApplicable= true.

      AttendanceAwardVariant

      String

      YearStartDate

      Identifies the year start for annual reports.

      Default = 01/01

      User prompt = No

      Mandatory = Yes

      Caution: Only dd/MM format is supported.

      YearStartDate

      String

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

    See Configure Access to Integrations.

CWFM Reports — Run and test the integration

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

  1. Run the integration
    1. Select the integration:
      1. Select Main Menu Maintenance > Integrations.
      2. Click Tap Run an Integration .
      3. Select the CWFMReports_iPack_v1 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:
      • Hyperfind and Location: Select a Hyperfind or Location query of employees.
      • 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

      • Report List: Select one or more reports to run.
      • Start Date: Select the report start date.
      • End Date: Select the report end date.
      • Reporting Period: Select the CWFM Reporting Period.
    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.
  2. 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.

CWFM Reports integration — APIs

API details - CWFM Reports integration

API details - CWFM Reports integration

API name

Type

Resource path

Description

Execute Hyperfind Query

POST

/v1/commons/hyperfind/execute

Execute a Hyperfind query by ID or qualifier and returns the result.

Retrieve All Integration Executions

POST

/v1/platform/integration_executions/

Return a list of all integration runs including completed, in-progress, scheduled, and failed.

Retrieve User Preferences for Current User

GET

/v1/commons/user_preferences/locale_policy

Fetch user or tenant default locale data.

Retrieve Location Set by Name

GET

/v1/commons/location_sets

Return an Organizational Map group (location set) by name and system.

Update Integration Execution Details

POST

/v1/platform/integrations/update_status

Update and returns the callback instance against the provided integration execution details.

Save Report

POST

/v1/platform/reports

Generate and save report.

Retrieve User Preferences for Current User

GET

/v1/commons/user_preferences/locale_policy

Return user locale policy for the current user or tenant.

Retrieve Location by Path

GET

/v1/commons/locations

Return Organizational Map location information by location (node) path and date.

Retrieve Paycodes

POST

/v1/timekeeping/setup/pay_codes/multi_read

Fetch skill assigned to a person.

Retrieve Schedule

POST

/v1/scheduling/schedule/multi_read

Retrieve multiple schedules.

Retrieve Timecard Data for Multiple Employees

POST

/v1/timekeeping/timecard_metrics/multi_read

Return timecard data for a set of employees or locations.

Retrieve All Skill Assignments

POST

/v1/commons/persons/skills/multi_read

Return all of a person's skill assignments.

Retrieve Locations

POST

/v1/commons/locations/multi_read

 Returns one or more locations based on the specified criteria.

Retrieve Persons

POST

/v1/commons/persons/extensions/multi_read

Return multiple person records based on search criteria. Search criteria includes personid, personnumber, jobassignmentid, username, useraccountid, and badgenumber.

Retrieve All Certification Assignments

POST

/v1/commons/persons/certifications/multi_read

Return all of a person's certification assignments.

Retrieve Timecards as Manager

POST

/v1/timekeeping/timecard/multi_read

Return a list of timecards based on the employees or Hyperfind details provided.

CWFM Reports

CWFM Report configuration

  1. Customize the report labels.

    1. Unzip the shared .zip file.

    2. Navigate to the properties folder, and then open the properties file.

    3. Provide values for the report strings.

    4. Save the changes, and then add the updated file to the .zip file.

    5. Repeat these steps for each CWFM Report.

      • CWFM-AnnualReturnReport

      • CWFM-MusterRollReport

      • CWFM-RegisterofContractWorkmenEmployedbyContractorReport

      • CWFM-RegisterOfContractorsReport

      • CWFM–RegisterofOvertimeReport

      • CWFM-RegisterofWagesCumMusterRollReport

      • CWFM-RegisterOfWagesReport

      • CWFM-WageSlipReport

  2. Localize the report strings.

    1. Unzip the shared file.

    2. Navigate to the properties folder, and create a new properties file that adheres to the following naming convention:

      report_com.kronos.report.data.design.<reportName>_v<versionNumber>_strings_<languageCode>_<countryCode>.properties

      Example: report_com.kronos.report.data.design.ChileTimecardReport_v1_strings_fr_FR.properties

    3. Copy each key and value data pair from the strings properties file, and then paste the content into the new file.

    4. Replace all values after the "=" with required locale data, and then save the properties file.

    5. Zip the file after completing and then saving all localizations.

      Note:

      Refer to the table for appropriate character sequences to use in the properties file.

      Character sequence

      Character sequence

      Character

      Character sequence

      Space

      \

      Colon

      \:

      Semicolon

      \;

      Blank

      \t

    Note:

    • If you plan to test the report in your non-production (NPR) environment before implementation in your production (PRD) environment, you must complete each of the following UKG Pro WFM report configuration steps in both NPR and PRD environments.

    • Manage Read Only Reports must be enabled on the tenant in the NPR environment.

  3. Migrate the report data objects (RDO) configuration to the tenant Migrate each CWFM Report RDO .zip file to the customer tenant using Setup Data Manager (SDM).

    1. Log in to the appropriate tenant.

    2. Go to Main Menu > Administration > Setup Data Manager.

    3. Select the Source tenant where the RDO configuration 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.

    9. Repeat these steps for each CWFM Report.

      • CWFM-AnnualReturnReport_RDO.zip

      • CWFM-MusterRollReport_RDO.zip

      • CWFM-RegisterofContractWorkmenEmployedbyContractorReport_RDO.zip

      • CWFM-RegisterOfContractorsReport_RDO.zip

      • CWFM–RegisterofOvertimeReport_RDO.zip

      • CWFM-RegisterofWagesCumMusterRollReport_RDO.zip

      • CWFM-RegisterOfWagesReport_RDO.zip

      • CWFM-WageSlipReport_RDO.zip

  4. RDO Configuration Define the business objects for selection during report design.

    1. Go to Main Menu > Administration > Application Setup > Common Setup > Report Data Object Management > Add > Employee View.

    2. Enter the RDO Name in the Report Data Object Key.

      Caution: This unique identifier is a hidden key for the RDO. You cannot change the name after it is saved.

    3. Enter the Description.

    4. Select the Type checkbox in Custom Read Only.

    5. Click Tap Selected Time Period in Time Frame.

    6. Go to Main Menu > Administration > Application Setup > Common Setup > Unpublished Reports.

    7. Enter the following entities:

      RDO entities

      Entity

      Category

      Column Name

      Description

      Type

      Employee Details

      Employee

      Employee Full Name

      Employee Full Name

      String

      Employee Details

      Employee

      Employee ID

      Employee ID

      String

    8. Click Tap Save.

    9. Repeat these steps for each RDO Name:

      • CWFM-AnnualReturnReport

      • CWFM-MusterRollReport

      • CWFM-RegisterofContractWorkmenEmployedbyContractorReport

      • CWFM-RegisterOfContractorsReport

      • CWFM–RegisterofOvertimeReport

      • CWFM-RegisterofWagesCumMusterRollReport

      • CWFM-RegisterOfWagesReport

      • CWFM-WageSlipReport

  5. Deploy the CWFM Reports
    Note: The BIRT reports must be redeployed every time changes are made to existing report objects. Re-deployment is not required for integration process changes.

    1. Go to Main Menu > Administration > Application Setup > Common Setup > Manage Read-Only Report.

    2. Click Tap Create, and then select Choose File.

    3. Select a CWFM Report .zip file, and then click tap Upload.

    4. Click Tap Save after the upload completes.

    5. Go to Main Menu > Administration > Application Setup > Common Setup > Unpublished Reports.

    6. Select the CWFM Report, and then click tap Publish.

    7. Configure the report-specific fields:

      Report Name<Enter the CWFM Report name as it is configured in the integration list parameter, CWFM Report List.> Default Output Type: pdf Output formats: PDF, XLSX Category: Custom Reports

      Note: The value entered in Report Name must match the report name configured in the CWFM Report List integration control parameter.

    8. Click Tap Save to publish the report. See the Unpublished Reports topic.

    9. Repeat these steps for each CWFM Report zip file:

      • CWFM-AnnualReturnReport.zip

      • CWFM-MusterRollReport.zip

      • CWFM-RegisterofContractWorkmenEmployedbyContractorReport.zip

      • CWFM-RegisterOfContractorsReport.zip

      • CWFM–RegisterofOvertimeReport.zip

      • CWFM-RegisterofWagesCumMusterRollReport.zip

      • CWFM-RegisterOfWagesReport.zip

      • CWFM-WageSlipReport.zip

  6. Configure the logo

    Configure the branding logo that appears in the report header. After choosing the file, select Use this logo for all reports regardless of the active theme. Report logos are displayed on a white background. See the Themes topic.

    Note: By default, the system uses the logo specified in the active theme for reports. If you wish, you can designate that the logo specified in a different theme be used for all reports, even if that theme is not active.
  7. Approve the CWFM Reports

    1. Login to UKG Pro WFM as a Support User.

    2. Go to Main Menu > Administration > Application Setup > Common Setup > Manage Read-Only Report.

    3. Select a CWFM Report file, and then click tap Review.

    4. Select Approve, and then click tap Apply. This action changes the Approval Status from Pending to Approved.

    5. Repeat these steps for each CWFM Report.

      • CWFM-AnnualReturnReport

      • CWFM-MusterRollReport

      • CWFM-RegisterofContractWorkmenEmployedbyContractorReport

      • CWFM-RegisterOfContractorsReport

      • CWFM–RegisterofOvertimeReport

      • CWFM-RegisterofWagesCumMusterRollReport

      • CWFM-RegisterOfWagesReport

      • CWFM-WageSlipReport

  8. Configure access to the CWFM Reports

    Add each CWFM Report to the Report Data Access Profile assigned to individuals who run the report. See the Report Data Access Profiles topic.

Version history

CWFM Import Export integration

Version history — CWFM Import Export integration

Version

Description

iPack_v1

Initial release.

This integration imports and exports Contract Workforce Management data between SFTP and extension tables.

iPack_v1 (enhancement)

The Import Export integration now supports Level 3 admin access.

The Import Export integration logic now validates that the Basic and DA values in the WageDetails source file are greater than or equal to the Min Wage – Basic and Min Wage DA values in the MinimumWage source file.

The CWFM Import Export integration generated an error during import of:

  • the principal employer and contractor master files when a comma (,) was embedded in a data value.

  • the workmen wages file when an Effective Date value fell outside of the current period.

The CWFM Import Export integration now allows export file downloads from the Run Summary page.

The CWFM Import Export integration generated an "incorrect base value" error when attempting to import workmen wages.
The CWFM Import Export iPack failed during import and export actions when executed by a multiple assignment user with a role assignment that contained an empty job transfer set.

CWFM People Import integration

Version history — CWFM People Import integration

Version

Description

iPack_v1

Initial release.

This integration imports Contract Workforce Management (CWFM) workers into the application.

iPack_v1 (enhancement)

The CWFM People Import integration allows multiple date formats where masking is supported.

The CWFM People Import integration failed with a license error when the compound key returned with a blank value. The integration was updated to consider PE ID for the license count.

The CWFM People Import integration failed when run on tenants that are configured with fewer than six labor categories.
The CWFM People Import integration failed with a duplicate Aadhar error when importing rehired employees.
The CWFM People Import integration did not correctly compare the last effective wage; as a result, wage changes were not imported.
For contingent workers in India who are paid Trade or Skill-driven wages, the daily wage calculation relies on the active Skill or Proficiency assigned in the people record. When the Contract Workforce Management (CWFM) People Import was run to update the skill, it incorrectly added an additional active skill to the people record.

The CWFM People Import now end-dates and then inactivates the previous skill before adding the current-dated active skill.

The CWFM People Import now end-dates and then inactivates the previous skill before adding the current-dated active skill.

When the Contract Workforce Management (CWFM) People Import integration creates or updates people in the application, it requires mandatory validation on certain fields, such as gender, marital status, and blood group.

At termination time, the integration performs validation on the same fields; however, this action is not required.

For companies that employ contract or contingent workers, terminations are a frequent occurrence.

To simplify the contingent worker termination process, the CWFM People Import integration now requires validation for only a minimum selection of fields, including:

  • PersonNumber

  • Hire Date

  • Employment Status

  • Employment Status Effective Date

  • User Account Name

  • Home Business Structure Level 1

  • Home Business Structure Level 2

  • Home Business Structure Level 3

  • Home Business Structure Level 4

  • Home/Primary Job

  • Aadhar Number

  • Badge Number (Applicable only when UKG clocks are in use.)

  • Worker Type (Applicable only when the employee is blacklisted.)

During a bulk import, if the Contract Workforce Management People Import integration encountered a failure with a single employee record, none of the records in the file were imported into the application.

The Contract Workforce Management People Import integration encountered multiple issues when importing employee data.

  • The first integration run failed due to incorrect employee data.
  • Although the second integration run succeeded, Skills, Adjustment Rules, and Employment Terms were not updated.
  • During the third run, missing details were updated, but the effective date was incorrectly set to the first day of the next month instead of the actual hire date.

CWFM Reports integration

Version history — CWFM Reports integration

Version

Description

iPack_v1

Initial release.

This integration creates reports.

iPack_v1 (enhancement)

The CWFM Reports integration:

  • supports round and grace logic for wage values.

  • allows multiple date formats where masking is supported.

The CWFM Reports integration failed when running the Register of Wages Cum Muster Roll. The Commands for execution in the Extension tables definition must be updated in accordance with the example provided in CWFM Reports integration help topic.

  • The Muster Roll report failed when the CWFM Reports integration encountered an employee with multiple overtime paycodes and inconsistent status values on the same day.

  • The CWFM Reports integration failed to run multiple concurrent reports.

  • The CWFM Reports did not include terminated employees.

A new error message reports when data is formatted incorrectly.
The Register of Wages Report failed during processing because Gender values assigned to employees did not adhere to the designated case-sensitive format. The report no longer requires case-sensitive Gender values.
  • The Register of Overtime Report contained incorrect overtime amounts when the integration encountered null values.

  • The Muster Roll Report incorrectly reported:

    • employees with hire dates that occurred after the selected reporting period. For example, when an employee was hired during the month of April, that same employee was included in the Muster Roll Report when it was generated for the month of March.

      Employees with hire dates that fall after the reporting period are no longer included in the Muster Roll Report.

    • terminated employees when they were included in the Hyperfind.

      Terminated employees are now filtered from the report.

CWFM Reports

Version history - CWFM Report configuration

Version

Description

v1

Initial release.

Configurable BIRT reports that receive timecard data from the CWFM Reports integration.