Skip to main content

Purpose

The purpose of this quick reference guide is to explain the end to end process that a 2cloudnine Payroll user will follow so that they can successfully import Timesheets or Pay Transactions.

Content covered

Overview

2cloudnine Payroll has a standard import visualforce page for interpreted and uninterpreted timesheet data using the Timesheet Import Tool Package that can be installed into any salesforce org with 2cloudnine Payroll and Time2Pay packages. The purpose of this package is to assist our clients that use 3rd party VMS systems that provide outputs of both interpreted and uninterpreted time can be uploaded using a csv file format into the Payroll system for interpretation and payment, or for payment only. Examples of providers include Comensura, Fieldglass, Timetarget and Beeline.

Prerequisites

Before proceeding with Importing Data please ensure that:
  1. 2cloundnine Payroll users must be in the ‘Salesforce Lightning Experience’ and not in the Salesforce Classic view mode.
  2. Have enabled a custom domain (My Domain) in order to see the Lightning Web Components (LWC) on the Page Layouts.
  3. Have installed the Timesheet Import Tool Package v1.15 or higher.
  4. Apply the ‘2cloudnine Timesheet Import’ Permission set to relevant users.

Configuration changes in v1.14 and v.1.15

New Import Status colour status field Uplift to Import UI look and feel with a processing status bar Cost Center details can be Imported via the Timesheet Import Tool New Assignment Import Tool Optional Column headings should remain and not be removed from the import file but can still be left blank

Configuration instructions

  • Navigate to Settings.
  • Select the Object Manger Tab.
  • In the Quick Find Search box search and select Imported Record.
  • On the Left hand panel choose Page Layout.
  • Select the TC9IMP Timesheet Import Layout.
  • Remove the Status field from the layout and replace this with the Import Status field.
  • Click on the App manager and search for Imported Records.
  • Change the List View to All.
  • Amend the List View to show the Import Status field instead of the Status field.

For the Assignment Import Tool

  1. External IDs have to be setup on the Contact, Account (Client Record Type), and the Payment Entity to reference in the csv import file.
  2. Salesforce IDs for the Pay Schedule, Public Holiday Calendar, Timesheet Calendar, Invoice Schedule, Invoice Tax ID records are also required to be referenced in the relevant columns for Assignments to be successfully created.
  3. Assignment Import Guide can be found here.
  4. Assignment CSV Import File can be found here.

For the Timesheet Import Tool

  1. External IDs have to be setup on the Contact and Assignment records to reference in the csv import file.
  2. For importing Timesheet Leave entries you can either reference the External ID on the Payee Leave Rule or the Payee Leave Rule Name in the import file.
  3. Ensure that the Payees, the Assignments and all of their associated records are complete to avoid intrusive errors.
  4. Timesheets have been generated for the related Assignments.
  5. Timesheet Import Guide can be found here.
  6. Timesheet CSV Import File can be found here.

For the Pay Transaction Import Tool

  1. External IDs have to be setup in the Contact, Assignment, Payment Entity, Pay Code and the Pay Schedule Records to reference in the csv import file and for Transactions to be successfully processed in a Pay Batch.
  2. External IDs additionally will have to be setup in the Invoice Tax Id and Invoice Schedule to be successfully processed in the Invoice Generation Manager.
  3. Ensure that the Payee, the Assignment and all of their associated records are complete to avoid intrusive errors.
  4. Pay Transaction Import Guide can be found here.
  5. Pay Transactions CSV Import File can be found here.

Assignment import template

Information

1. The Assignment Import Columns

Mandatory: The column in the csv upload should be populated with relevant data corresponding to the Field Mapping.Optional: These columns can be left blank.

Screen Shots

Assignment import spreadsheet columns A to F

How to import assignments via the Assignment Import Tool

1. Navigate to the ‘Assignment Import Tool’

The Assignment Import Tool can be accessed by searching for Import from the App Launcher and then:
  • Selecting the’ 2C9 Timesheet Import Tool’ App and then clicking on the ‘Assignment Import Tool’ tab.
  • Or by selecting the ‘Assignment Import Tool’ Item.
Assignment Import Tool validate file

2. Assignment Import Tool - Validate the File

After navigating to the Assignment Import Tool:
  1. Select the ‘Upload Files’ button or drop files.
  2. A dialog box will open allowing you to choose your file which must be a Comma Separated Values file.
  3. Select ‘Open’ once you have chosen your import file.
  4. Select ‘Validate’.
Assignment Import Tool file dialog

3. File Inserted Successful pop up message

After approximately 1-2 minutes if the following pop up message does not appear on the screen then reload / refresh the page.

You will be Navigated automatically to the Imported Record page.
File Inserted Successful pop up message

4. Imported Record Screen

Details Tab

Imported Record: Salesforce Record ID.

Record Type: For Assignment Imports the record type will display as ‘Assignment’.

Import Status: Shows the Status of the Import. The different values are:
  • New - Initial Status of the imported record when the batch is running.
  • Validation Failed - Data errors exist in some rows - Download the Feed_results file and then refer to the Troubleshooting section.
  • No Validation Errors - The Imported file contains no errors.
  • Failed - The import has failed - refer to the Troubleshooting section.
Records Attempted: Displays the number of Data rows that the import file contains.

Successful Records: Displays the number of Data rows the import will import.

Message: A message may appear “There were errors in the file . Kindly look at the debug header for more details” if the Import Status is Failed.

Files Lightning Web Component

There should be 2 files that are produced the Feed_Results (contain the Error/Warnings in column 2 to assist in troubleshooting data errors) and the ImportedTimesheetEntry (contains data matching to the file being imported).
Details Tab
Imported Record Screen details tab
Files - Lightning Web Component (LWC)
Imported Record files Lightning Web Component

5. Process the Import (Navigate to the Assignment Import Tool)

  1. Select the ‘Upload Files’ button or drop files.
  2. A dialog box will open allowing you to choose your file which must be a Comma Separated Values file.
  3. Select ‘Open’ once you have chosen your import file.
  4. Select ‘Process’.
Assignment Import Tool process file

6. File Inserted Successful pop up message

After approximately 1-2 minutes if the following pop up message does not appear on the screen then reload / refresh the page.

You will be Navigated automatically to the Imported Record page.
File Inserted Successful pop up message after processing

7. Imported Record Screen

Details Tab

Imported Record: Salesforce Record ID.

Record Type: For Assignment Imports the record type will display as ‘Assignment’.

Import Status: Shows the Status of the Import. The different values are:
  • New - Initial Status of the imported record when the batch is running.
  • Processed with Errors - Data rows have validation errors which were not able to be successfully imported. Download the Feed_results file and then refer to the Troubleshooting section.
  • Processed - The Data rows have been successfully imported.
  • Failed - The import has failed - refer to the Troubleshooting section.
Records Attempted: Displays the number of Data rows that the import file contains.

Successful Records: Displays the number of Data rows the import was able to import.

Message: A message may appear “There were errors in the file . Kindly look at the debug header for more details” if the Import Status is Failed.

Files Lightning Web Component (LWC)

There should be 2 files that are produced the Feed_Results (contain the Error/Warnings in column 2 to assist in troubleshooting data errors) and the ImportedTimesheetEntry (contains data matching to the file being imported).

Assignment Lightning Web Component (LWC)

Assignment related records will appear once the Import has been Processed.
Details Tab
Assignment processed imported record details
Files - Lightning Web Component (LWC)
Assignment files Lightning Web Component
Assignment Lightning Web Component (LWC)
Assignment Lightning Web Component

Timesheet import template

Information

1. The Timesheet Import Columns

Mandatory: The column in the csv upload should be populated with relevant data corresponding to the Field Mapping.Validation Controlled: These are to be populated according to the Timesheet Entry Format e.g. Start/End Times or Total Hours.Optional: These columns can be left blank.

Screen Shots

Timesheet import spreadsheet columns A to F

2. Notes and examples that you can use on the Employee/Assignment Record ‘External ID’ field

  • The External ID field is used to define the ID of the corresponding record in an external system that has been used to create/update the record.
  • External IDs are Text fields which allows you to enter any combination of letters, numbers, or symbols.
  • The maximum Field length is 50 characters.

Examples of External IDs

Examples of External IDs

How to import uninterpreted Timesheet data via the Timesheet Import Tool

When timesheet entries are imported into the system they should be loaded in with a status of “Approved” so that the transactions can be automatically created (if the scheduled job is enabled) or the user can select the ‘Process Transactions’ button.

1. Navigate to the ‘Timesheet Import Tool’

The Timesheet Import Tool can be accessed by searching for Timesheet Import from the App Launcher and then:
  • Selecting the’ 2C9 Timesheet Import Tool’ App and then clicking on the ‘Timesheet Import Tool’ tab.
  • Or by selecting the ‘Timesheet Import Tool’ Item.
Timesheet Import Tool validate file

2. Timesheet Import Tool - Validate the File

After navigating to the Timesheet Import Tool:
  1. Select the ‘Upload Files’ button or drop files.
  2. A dialog box will open allowing you to choose your file which must be a Comma Separated Values file.
  3. Select ‘Open’ once you have chosen your import file.
  4. Select ‘Validate’.
Timesheet Import Tool file dialog

3. File Inserted Successful pop up message

After approximately 1-2 minutes if the following pop up message does not appear on the screen then reload / refresh the page.

You will be Navigated automatically to the Imported Record page.
Timesheet File Inserted Successful pop up message

4. Imported Record Screen

Details Tab

Imported Record: Salesforce Record ID.

Record Type: For Timesheet Imports the record type will display as ‘Timesheet’.

Import Status: Shows the Status of the Import. The different values are:
  • New - Initial Status of the imported record when the batch is running.
  • Validation Failed - Data errors exist in some rows - Download the Feed_results file and then refer to the Troubleshooting section.
  • No Validation Errors - The Imported file contains no errors.
  • Failed - The import has failed - refer to the Troubleshooting section.
Records Attempted: Displays the number of Data rows that the import file contains.

Successful Records: Displays the number of Data rows the import will import.

Message: A message may appear “There were errors in the file . Kindly look at the debug header for more details” if the Status is Failed.

Files Lightning Web Component

There should be 2 files that are produced: the Feed_Results (contain the Error/Warnings in column 2 to assist in troubleshooting data errors) and the ImportedTimesheetEntry (contains data matching to the file being imported).
Details Tab
Timesheet imported record details tab
Files Lightning Web Component
Timesheet files Lightning Web Component

5. Process the Import (Navigate to the Timesheet Import Tool)

  1. Select the ‘Upload Files’ button or drop files.
  2. A dialog box will open allowing you to choose your file which must be a Comma Separated Values file.
  3. Select ‘Open’ once you have chosen your import file.
  4. Select ‘Process’.
Timesheet Import Tool process file

6. File Inserted Successful pop up message

After approximately 1-2 minutes if the following pop up message does not appear on the screen then reload / refresh the page.

You will be Navigated automatically to the Imported Record page.
Timesheet process success pop up

7. Imported Record Screen

Details Tab

Imported Record: Salesforce Record ID.

Record Type: For Timesheet Imports the record type will display as ‘Timesheet’.

Import Status: Shows the Status of the Import. The different values are:
  • New - Initial Status of the imported record when the batch is running.
  • Processed with Errors - Data rows have validation errors which were not able to be successfully imported. Download the Feed_results file and then refer to the Troubleshooting section.
  • Processed - The Data rows have been successfully imported.
  • Failed - The import has failed - refer to the Troubleshooting section.
Records Attempted: Displays the number of Data rows that the import file contains.

Successful Records: Displays the number of Data rows the import was able to import.

Message: A message may appear “There were errors in the file . Kindly look at the debug header for more details” if the Import Status is Failed.

Files Lightning Web Component (LWC)

There should be 2 files that are produced: the Feed_Results (contain the Error/Warnings in column 2 to assist in troubleshooting data errors) and the ImportedTimesheetEntry (contains data matching to the file being imported).

Timesheet and Timesheet Entries Lightning Web Component (LWC)

Timesheet and Timesheet Entries related records will appear once the Import has been Processed.
Details Tab
Processed timesheet details
Files Lightning Web Component (LWC)
Processed timesheet files Lightning Web Component
Timesheet and Timesheet Entries Lightning Web Component (LWC)
Timesheet and Timesheet Entries Lightning Web Component

Pay Transaction Import Template

When Pay Transactions are imported into the system they are transactions that can be included in a Pay Batch for Payroll processing or included in the Invoice creation through the Invoice Generation Manager.

1. The Pay Transaction Import Columns

Mandatory: The column in the csv upload should be populated with relevant data corresponding to the Field Mapping.Optional: These columns can be left blank.

Screen Shots

Pay transaction import spreadsheet columns A to F

How to import interpreted Timesheet data via the Pay Transaction Import Tool

1. Navigate to the ‘Pay Transaction Tool’

The Pay Transaction Import Tool can be accessed by searching for Import for e.g. from the App Launcher and then:
  • Selecting the’ 2C9 Timesheet Import Tool’ App and then clicking on the ‘Pay Transaction Import Tool’ tab.
  • Or by selecting the ‘Pay Transaction Import Tool’ Item.
Pay Transaction Import Tool validate file

2. Pay Transaction Import Tool - Validate the File

After navigating to the Pay Transaction Import Tool:
  1. Select the ‘Upload Files’ button or drop files.
  2. A dialog box will open allowing you to choose your file which must be a Comma Separated Values file.
  3. Select ‘Open’ once you have chosen your import file.
  4. Select ‘Validate’.
Pay Transaction Import Tool file dialog

3. File Inserted Successful pop up message

After approximately 1-2 minutes if the following pop up message does not appear on the screen then reload / refresh the page.

You will be Navigated automatically to the Imported Record page.
Pay Transaction File Inserted Successful pop up message

4. Imported Record Screen

Details Tab

Imported Record: Salesforce Record ID.

Status: Shows the Status of the Imported File. The different values are:
  • New - Initial Status of the imported record when the batch is running.
  • Validation Failed - Data errors exist in some rows - Download the Feed_results file and then refer to the Troubleshooting section.
  • No Validation Errors - The Imported file contains no errors.
  • Failed - The import has failed - refer to the Troubleshooting section.
Record Type: For Pay Transaction Imports the record type will display as ‘Pay Transaction’.

Records Attempted: Displays the number of Data rows that the import file contains.

Successful Records: Displays the number of Data rows the import will import.

Message: A message may appear “There were errors in the file. Kindly look at the debug header for more details” if the Import Status is Failed.

Files - Lightning Web Component (LWC)

There should be 2 files that are produced: the Feed_Results (contain the Error/Warnings in column 2 to assist in troubleshooting data errors) and the ImportedPayTransaction (contains data matching to the file being imported).
Details Tab
Pay Transaction imported record details
Files - Lightning Web Component (LWC)
Pay Transaction files Lightning Web Component

5. Process the Import

  1. Select the ‘Upload Files’ button or drop files.
  2. A dialog box will open allowing you to choose your file which must be a Comma Separated Values file.
  3. Select ‘Open’ once you have chosen your import file.
  4. Select ‘Process’.
Pay Transaction process import

6. File Inserted Successful pop up message

After approximately 1-2 minutes if the following pop up message does not appear on the screen then reload / refresh the page.

You will be Navigated automatically to the Imported Record page.
Pay Transaction process success pop up

7. Imported Record Screen

Details Tab

Imported Record: Salesforce Record ID.

Status: Shows the Status of the Imported File. The different values are:
  • New - Initial Status of the imported record when the batch is running.
  • Processed with Errors - Data rows have validation errors which were not able to be successfully imported. Download the Feed_results file and then refer to the Troubleshooting section.
  • Processed - The Data rows have been successfully imported.
  • Failed - The import has failed - refer to the Troubleshooting section.
Record Type: For Pay Transaction Imports the record type will display as ‘Pay Transaction’.

Records Attempted: Displays the number of Data rows that the import file contains.

Successful Records: Displays the number of Data rows the import was able to import.

Message: A message may appear “There were errors in the file. Kindly look at the debug header for more details” if the Impot Status is Failed.

Files - Lightning Web Component (LWC)

There should be 2 files that are produced: the Feed_Results (contain the Error/Warnings in column 2 to assist in troubleshooting data errors) and the ImportedPayTransaction (contains data matching to the file being imported).

Pay Transactions - Lightning Web Component (LWC)

Pay Transaction related records will appear once the Import has been Processed.
Details Tab
Processed pay transaction details
Files - Lightning Web Component (LWC)
Processed pay transaction files Lightning Web Component
Pay Transactions - Lightning Web Component (LWC)
Pay Transactions Lightning Web Component

Troubleshooting Error Messages

A guide to assist with Troubleshooting Validation Error Messages.

Timesheet Import Validation Error Messages

Pay Transaction Import Validation Error Messages

Debug Headers

Debug Header can be viewed from the Debug Header Tab.Common Reasons whereby an Import will Fail and a debug will be created:
  • You are trying to import a Pay Transaction file using the Timesheet Import Tool instead of the Pay Transaction Import Tool.
  • You are trying to import a Timesheet file using the Pay Transaction Import Tool instead of the Timesheet Import Tool.
  • Data entered for some columns might be in the wrong columns thus please check all the data is in the right columns.
  • Column Headings are the Api names instead of the field names e.g. tc9_et__Start_Date__c instead of Start Date.
Debug Headers tab