Payroll data drop

The Payroll data drop feature, integrated into the Compensation Management module, enables you to configure and download payroll data files specifically tailored to external payroll systems. It becomes active after the compensation round is in progress, streamlining post-compensation workflows between the PaySuite platform and any third-party system you use for payroll processing.

This is a tip message.

Compensation rounds are available under Workbench > Compensation Management > Compensation Rounds. Access to Workbench depends on your role within the platform. This feature is available for users with the Configuration, Compensation Admin, and Global Compensation Admin professional roles.

To start your work with the Payroll data drop, proceed as follows:

1. Navigate to Workbench > Compensation Management > Compensation Rounds.

2. From the table, choose a compensation round you want to work with. Keep in mind that Payroll data drop is available only for comp rounds that are in the In progress state.

3. To open your round, use either of the following options:

   • Click the three-dot icon located at the far right of the table row corresponding to your chosen round. When the contextual menu appears, select Round Management, as presented below:

     

     Round Management entry point

   • Click the name of the compensation round directly.

4. You are redirected to the Round Management page, with the Overview, Statement generation, and Payroll data drop tabs. Choose Payroll data drop, as illustrated in the following picture:

   

   Payroll data drop tab with available actions

On this page, you can manage the payroll data drops that have already been created for your chosen compensation round.

Viewing payroll data drop rules

To view a payroll data drop rule, you can use any of the following methods:

• Click the three-dot icon located at the far right of the row corresponding to your chosen rule. When the contextual menu appears, select the View option.

• Click the name of the rule directly.

You will be redirected to the rule's view page.

Editing payroll data drop rules

To edit a payroll data drop rule, you can use any of the following methods:

• Click the three-dot icon located at the far right of the row corresponding to your chosen rule. When the contextual menu appears, select the Edit option.

• Open the rule's view page and click the Edit button in the upper-right corner.

You will be redirected to the Edit payroll data drop page, where you can make your changes and publish the updated rule by clicking Update in the upper-right corner.

Duplicating payroll data drop rules

To duplicate a payroll data drop rule, click the three-dot icon located at the far right of the row corresponding to your chosen rule. When the contextual menu appears, select the Duplicate option. A dialog box will be displayed, informing you about the successfully duplicated rule and letting you open it by clicking Open payroll data drop. The new rule will appear in the table with the name "Copy [name of the original rule]."

Deleting payroll data drop rules

To delete a payroll data drop rule, click the three-dot icon located at the far right of the row corresponding to your chosen rule. When the contextual menu appears, select the Delete option. In the confirmation dialog, click Delete to confirm. The rule will be removed from the list.

Creating a payroll data drop

To create a new payroll data drop, proceed as follows:

1. Click the Create payroll data drop button. The Create payroll data drop form will open, as shown below:

   

   Create payroll data drop form

2. Enter the Connection name and an optional Description for this outbound connection.

3. In the Worker selection section, click Add block to define a condition. Select a Criterion and Operator from the drop-down lists, and enter a Value. Click Add condition to add more conditions to the block. Use the icon in the upper-right corner of the section to copy a condition, or the icon to delete it. These condition blocks let you precisely control which workers are included in each export.

4. In the Data entities & sources section, define the entities and fields to appear in the model by checking the boxes next to the entity name. You may search for entities using the search bar at the top or narrow results using the available Category, Entity, and Type filter options. You can draw from both the compound data model and relevant compensation elements, and determine the precise field order to ensure alignment with your payroll system's requirements.

5. Click the Create button in the top-right corner of the creation form to finalize your payroll data drop, or click Save & exit to save a draft to return to later.

Downloading a payroll data drop file

This is an note/information message.

This action is available to Global Compensation Admins only.

Once a payroll data drop has been configured and saved with the Ready status, you can download the resulting payroll data file. To do so, view your payroll data drop and click the following Download file button in the top-right corner of the view page:

Payroll data drop file download feature

In the dialog box, you will be prompted to set a password for the file and confirm by clicking Download. The system uses password protection to ensure data confidentiality and compliance, keeping sensitive compensation information secure throughout the process.

The downloaded file reflects the field sets and worker filters defined during configuration, including worker details, compensation elements such as base pay and bonuses, and currency information. The figure below shows an example of an exported payroll data file:

Exported file example