Skip to main content

Import - Generic import overview

What is a generic import? A Generic Import type is an extremely powerful import that can be used to import or update records in most tables within Equus Platform using a CSV file with a specific heade

Updated over 2 weeks ago

What is a generic import?

A Generic Import type is an extremely powerful import that can be used to import or update records in most tables within Equus Platform using a CSV file with a specific header row. The header row can be used for one table at a time which can include a corresponding Custom_Field table. It is crucial to correctly define the generic import header row which consists of Command Action column and one or more data field columns. Using an import file with a poorly defined header row can cause multiple records to be updated intentionally.

Unlike standard (Fixed/Flexible Header) imports, most generic imports file templates are created from scratch and are often custom made to suit client needs. Please contact your Equus Client Solutions Manager (CSM) to discuss your import needs.

Prior to using receiving a generic import template file to use, your Equus CSM will provide detailed instructions on what data needs to go in each column of a generic import template file once the file template has been created and fully tested by Equus.

When are generic imports used?

Generic imports are used when data cannot be imported into Equus Platform using the Standard (Fixed / Flexible Header) Imports.

Examples of where a Generic imports are used:

  • Importing "drop down" values for fields such as: Segment Levels, Prefix, Suffix, Policy Types, gender, marital status, etc.

  • Bulk import of segment levels that feed the assignment file into Equus Platform. Segment levels are fields at the top of the assignment screen and are used determine the company, office location or cost center of an assignment.

  • Updating the fixed amounts for a large volume of compensation worksheet assignment line items for a new implementation and/or annual salary reviews

What are the limitations to using generic imports?

There are a number of limitations when using generic imports

  • Deletes are not supported

  • The import does not support inserting or updating "children" records

  • The file must be an csv file; Excel files are not supported

  • When updating and no record is found using the specified record identifiers, the record will be considered a success even though it did not actually do anything

  • When updating and multiple records are found using the specified record identifiers, all records will be updated but the count will report only one record was updated. Note that the UpdateOne and UpsertOne commands will error if multiple records would be updated

Things to Note

  • Importing data or updating value of ASSIGNMENT!INACTIVE field is not supported. This field can still be updated directly in the database by a developer and/or using the checkbox on the Assignment screen.

  • Any Advanced Audit Logging table (AAL_TABLENAME) cannot be targeted by any import process

Did this answer your question?