Configuring the Import Map Header

This is the name of the file that you are importing. The file name should include the file extension (commonly CSV). A best practice is to add an asterisk before the file extension to account for variations in the file name.

If the import runs automatically, in which order should the files import? It is important to set this appropriately if you have multiple dependent imports, such as an Employee Import, which depends on the Client Import executing first.

When the imported records are saved, which pipeline will execute? This determines which rules are applied when the data is saved. Selecting Import, for example, runs the business rules, triggers email templates, and triggers workflows with the import pipeline selected.

Note: If you are using the Pipeline Linking table to manage Pipeline Behaviors and you are configuring a new import record, the pipeline assigned a behavior of Default will auto-fill the Execution Pipeline field. If you are editing an existing import record, the Execution Pipeline entry remains intact until edited. If you change the entry, it is validated against the Pipeline Linking table. For instance, if a pipeline has been assigned a behavior of Allow or Default and you remove it, you will still be able to select it from the Execution Pipeline list. If the same pipeline is assigned a behavior of Disallow, you will not be able to add it again.

See Configuring Pipeline Linking.

Options include:

• Nightly: Imports run from uploaded files created from reporting either manually through Admin Settings or automatically from a Windows schedule on the Server. In most situations, this option is not available. For assistance, log an Extranet case.
• API: Imports run using direct connection to an external system by a scheduled process. When API is selected, API Path is available on the Import Map Detail form (see Configuring the Import Map Detail). Currently, the only import configured in this way is the PrismHR API. For assistance, log an Extranet case.
• Scheduled Process: Imports run from the Process Scheduled Imports scheduled process. Files in Ready for Import status of this type are automatically imported when the scheduled process kicks off.

Options include:

• Insert: Only insert new records. Does not update existing records.
• Update: Only update existing records. Does not insert new records.
• Both: Insert new records and Update existing records.

This field is only used if there is a specialized import code written by ClientSpace. Log an Extranet case if you have questions.

When selected (enabled), any Workflows, Email Templates, Hard Errors, or Business Rules configured in the Execution Pipeline fire on save of the data into ClientSpace. Soft errors on the pipeline are ignored. Hard errors create Log Entries, and the associated record is not imported.

Provide a brief description of the import. It is useful to use this area to distinguish the purpose of the import and where the data to be imported originates.

When selected (enabled), only a developer user can configure the Import Map Header and Fields. From the Import Map Header Search dashboard, when this option is enabled, Add and Delete are not available for global administrators.

This field is used to identify how many rows in the file will be processed before splitting a large file into smaller pieces. This can eliminate "timeout" issues with large uploaded files.

Only used for PrismHR technology custom import code.

This is the field on the selected Dataform (in the General fieldset) for locating the record. Select ImportID or ID (Record Primary Key).

Specify the name of the column in the import file that contains the value of the Record Type Field. The column name is used to match the ClientSpace record you want to update. This is always compared to the ImportID on the record to be updated. Cannot be identical to the Workspace Identifier.

Specify the type of information on the Workspace Source Dataform to locate the workspace. The administrator can configure an import to select the appropriate workspace when inserting a row of data based on the following:

• ID (Record Primary Key): Inserts/updates the record in the workspace where the dataform of that type and RecordID matches the Workspace Source Column from the source file.
• ImportID: Inserts/updates the record in the workspace where the dataform of that type and the ImportID matches the Workspace Source Column from the source file.
• ProjectID: Inserts/updates the record in the workspace where the WorkspaceID matches the Workspace Source Column from the source file.

This is the column name on the import file that matches the Workspace record in ClientSpace. Information in this field/column is compared to the Workspace Source Field of the Workspace Source Dataform. Cannot be identical to the Records to Update.

This is the dataform name that has the field to which you will match the Workspace Source Column. The Workspace Source Field of this dataform is matched against the Workspace Identifier column in the imported file to select the appropriate workspace in which to put the data.

This is how you add dataform fields to your configuration. See Configuring the Import Map Detail.