Skip to main content

Payroll System Contact Flexible CSV Import

The Payroll System Contact Flexible CSV Import enables inserting and updating payroll system contacts in your company through flexible CSV file uploads

The Payroll System Contact Flexible CSV Import is used to insert payroll system contacts and updating the primary payroll system contact.

This import is a flexible header import that will maintain data in the PAYROLL_SYSTEM_CONTACT table.

Overview

This is only available at the company level, and uses a CSV import format. To use the import, make sure the import is active. Standard conventions for this type of import apply, including (but not limited to):

  • This supports recordIdentifier=True

  • Everything is case insensitive

  • A blank column means “do not update value”. It does NOT mean “blank out the data”

  • Each row of data is processed in a separate transaction

  • If one row errors, execution proceeds to the next row

  • Validation errors will make a row fail, and the import will proceed to the next row

Specific Field Requirements/Sample File

Inserting a Payroll System Contact

Updating a Payroll System Contact

Command Action

  • This column is always required

  • This must always be the first column of the import

  • This controls what the import should do with the data. Each supported command has some special rules, as given here.

  • We recommend using Insert to add new contacts and Update to change resources. Sample files for inserting and updating are provided

    • Insert

      • Will insert a row of data

      • Columns marked with recordIdentifier=True in the header won’t have any special behavior, in this case. Their data will just be part of the insert as normal.

    • Update

      • This command will update the record when a record already exists.

      • The only updates this import will support is replacing an existing contact with a new contact. You cannot use PAYROLL_SYSTEM_CONTACT!PR_CONTACT_RESOURCE_COMPANY_ID as recordIdentifier to update if they are an internal or external contact, if the contact is the primary contact, if the contact will receive notifications, or to change the contact type.

      • If the recordIdentifier fields are insufficient (they filter the set down but find more than one matching record), the first record will be updated

Additional columns the import should support

  • PAYROLL_SYSTEM_CONTACT!PR_CONTACT_RESOURCE_COMPANY_ID

    • lookupValue=true will be the drop down display value like ‘John.Doe’

    • lookupValue=false will be the ID for John.Doe, ‘64’

  • PAYROLL_SYSTEM_CONTACT!PAYROLL_SYSTEM_ID

    • lookupValue=true will be the drop down display value like ‘United States’

    • lookupValue=false will be the ID for United States, ‘651’

  • PAYROLL_SYSTEM_CONTACT!IS_EXTERNAL

    • lookupValue=true will use Yes to check the box or No to leave box unchecked

    • lookupValue=false will be the code, EQTRUE will check the box and EQFALS will leave box unchecked

  • PAYROLL_SYSTEM_CONTACT!PRIMARY_CONTACT

    • lookupValue=true will use Yes to check the box or No to leave box unchecked

    • lookupValue=false will be the code, EQTRUE will check the box and EQFALS will leave box unchecked

  • PAYROLL_SYSTEM_CONTACT!SEND_NOTIFICATIONS

    • lookupValue=true will use Yes to check the box or No to leave box unchecked

    • lookupValue=false will be the code, EQTRUE will check the box and EQFALS will leave box unchecked

  • PAYROLL_SYSTEM_CONTACT!TYPE

    • lookupValue=true will be the drop down display value like ‘Comp Accumulation’

    • lookupValue=false will be the ID for Comp Accumulator, ‘EQPCCA’

Things to Note

  1. When inserting or updating, the following columns/fields are recommended:

    • Command Action

    • PAYROLL_SYSTEM_CONTACT!PR_CONTACT_RESOURCE_COMPANY_ID

    • PAYROLL_SYSTEM_CONTACT!PAYROLL_SYSTEM_ID

    • PAYROLL_SYSTEM_CONTACT!IS_EXTERNAL

    • PAYROLL_SYSTEM_CONTACT!PRIMARY_CONTACT

    • PAYROLL_SYSTEM_CONTACT!SEND_NOTIFICATIONS

    • PAYROLL_SYSTEM_CONTACT!TYPE

  2. Import does not support the undo feature, nor the delete command (the only way to undo the import is to access the Payroll System screen and manually delete the records).

  3. The first row of the import is the header row, and subsequent rows are data rows.

  4. The first column must always be the “Command Action” column; the other columns we would recommend always including in this order:

    • PAYROLL_SYSTEM_CONTACT!PR_CONTACT_RESOURCE_COMPANY_ID

    • PAYROLL_SYSTEM_CONTACT!PAYROLL_SYSTEM_ID

    • PAYROLL_SYSTEM_CONTACT!IS_EXTERNAL

    • PAYROLL_SYSTEM_CONTACT!PRIMARY_CONTACT

    • PAYROLL_SYSTEM_CONTACT!SEND_NOTIFICATIONS

    • PAYROLL_SYSTEM_CONTACT!TYPE

  5. If the PAYROLL_SYSTEM_CONTACT!PAYROLL_SYSTEM_ID row is NULL on the import, that row will fail

  6. After the “Command Action” column, each column in the header row should contain the unique name of the field that column will edit. The “unique name” is a combination of the full table name, an exclamation point, and then the full column name. Example: PAYROLL_SYSTEM_CONTACT!PAYROLL_SYSTEM_ID.

  7. Each header column can optionally accept additional information. To supply additional information, append a pipe character “|” followed by one of the additional options. Multiple options can be applied to a single column by separating them with more pipe characters.

    • Options include:

      1. recordIdentifier=True

        • Include this in any data column that should be used to determine which record the import should update. This has no impact when the row command is “Insert,” but is very important for updates or upserts. When the import goes to find a record to update, it will look for a record that has matching values for every column that has this specified in its header. PAYROLL_SYSTEM_CONTACT!PR_CONTACT_RESOURCE_COMPANY_ID does not support being the recordIdentifier. We recommend that if you use this import for update you make the following columns recordIdentifier: PAYROLL_SYSTEM_CONTACT!PAYROLL_SYSTEM_ID, PAYROLL_SYSTEM_CONTACT!IS_EXTERNAL, PAYROLL_SYSTEM_CONTACT!PRIMARY_CONTACT, PAYROLL_SYSTEM_CONTACT!SEND_NOTIFICATIONS, and PAYROLL_SYSTEM_CONTACT!TYPE

      2. lookupValue=True

        • Include this for any column that qualifies as a lookup. When this is specified, the data that the import should supply for the column should be the value displayed on the screen (and the database value will be looked up from that). If this header info is not specified, then the import will expect to receive the database value (i.e. the record ID or classification code) in the data row.

      3. Import should have same error handling as screen

        • One Primary Contact is required.

          • Line should fail if there is no primary contact and new record being added is not marked as primary

        • Only one Primary Contact can be selected.

          • Line should fail if there is already a primary contact

Did this answer your question?