There are some differences in how you set up Standard and Header Detail integration tables:

Standard data import integration table configuration

Standard integration tables should adhere to the following standards.

Create a table and use the following naming standard: <table name>Integration. For example, the TuitionAssistanceHeaderIntegration table is used to integrate external data into the Nextworld Main table, TuitionAssistanceHeader. 

Select type Main as your Type.

Table fields

You must add the following fields to the integration table:

FieldRequired?Notes
nwImportRunNumberYes

This field's value is automatically assigned to every record imported by the Data Import Definitions. It refers to a common batch number for all imported records and acts as a reference to how the transaction was processed into Nextworld, either migrated or integrated. 

If this field is blank or not populated, then the record was created within Nextworld.

IntegrationStatusNoThis list lookup value is assigned to every record imported by the Data Import Definitions. It identifies the current disposition of each record in the integration table.
  • Processed—The record has been successfully imported into the destination table.
  • Error—An attempt was made to import the record in the destination table, but failed.
  • New—The record import has not yet been attempted.
IntegrationActionYes

Used when processing an integration table record to identify the action (create/update/delete) to be performed.

*Currently, Create is the only option.

IntegrationsErrorLogNo

This is a subtable that stores all processing errors that may have been encountered during the import processing of each record. This table already exists and is used by the IntegrationsErrorLog application.

PurgeProcessedNo

This field is a user-selected processing option to purge (or not) successfully processed records from the integration table. This data item should be configured as Work Field.

SourceSystemNo

This field should be added to the integration and destination tables that hold transactional data. It is not needed in the integration or destination tables that store master data or setup data.  This field enables users to pass miscellaneous information from the integration table to the destination header table. The data item references the Source System list lookup which allows customers to create their own values.

This field should never be coded aganist or used in logic, other than passing it. Do not use this field to determine if data is coming from an external source.  

If applicable, you can optionally add the following fields to the integration table:

FieldRequired?Notes
nwExternalIdNoUsed when integrating records that must contain the record's unique identifier used by its external source.

Logic Blocks

It is not recommended to include any Action Blocks or Triggers on the integration table itself. When certain conditions are met, data imports can leverage a "copy" command in the database instead of importing rows line by line. Using a logic block on the integration table will disable this ability.

Table indexes

Include the following index in your integration table:

Index nameTypeFields
A
nwImportRunNumber (DESC), IntegrationStatus

Audit

Do not select the Create Audit check box for integration tables as the data is processed into its final table.  

Org Unit Security Field

When this field is specified, Org Security is enabled for the table.  The user must be given access to the organization to have access to the record in the table based on the org field that is specified. If the table being integrated to is also using org unit security, it is recommended to use this field on the integration table.

Multi-table data import integration table configuration

Multi-table integration tables, such as Header Details and tables with subtable, should adhere to the following standards.

Create a table and use the following naming standard: <hd table name>Integration or <subtable name>Integration. For example, the BillsOfMaterialIntegration table is used to integrate external data into the Nextworld header detail table, BillsOfMaterial. 

Select type Main as your Type.

Table fields

You must add the following fields to the integration table:

FieldRequired?Notes
nwImportRunNumberYes

This field's value is automatically assigned to every record imported by the Data Import Definitions. It refers to a common batch number for all imported records and acts as a reference to how the transaction was processed into Nextworld, either migrated or integrated. 

If this field is blank or not populated, then the record was created within Nextworld.

This field must be integrated to the header and detail tables.

IntegrationStatusNoThis list lookup value is assigned to every record imported by the Data Import Definitions. It identifies the current disposition of each record in the integration table.
  • Processed—The record has been successfully imported into the destination table.
  • Error—An attempt was made to import the record in the destination table, but failed.
  • New—The record import has not yet been attempted.
GroupLevel1Yes

This field's value is used for grouping and sorting records to be processed as a group.

IntegrationActionYes

This field's value is used when processing the Header Detail table to identify the action (create/update/delete).

*Currently, Create is the only option.

Fields integrated to the header tableNoAll of the fields that are being integrated into the header table. 
Fields integrated to the detail tableNoAll of the fields that are being integrated into the detail table.
nwImportRowNumberYes

This field's value is automatically assigned to every record imported by the Data Import Definitions. This refers to a unique number for each line and can be used for sorting.

IntegrationsErrorLogNo

This is a subtable that stores all processing errors that may have been encountered during the import processing of each record. This table already exists and is used by the IntegrationsErrorLog application.

PurgeProcessedNo

This field is a user-selected processing option to purge (or not) successfully processed records from the integration table. This data item should be configured as Work Field.

SourceSystemNo

This field should be added to the integration and destination tables that hold transactional data. It is not needed in the integration or destination tables that store master data or setup data. This field enables users to pass miscellaneous information from the integration table to the destination header table. The data item references the Source System list lookup which allows customers to create their own values.

This field should never be coded aganist or used in logic, other than passing it. Do not use this field to determine if data is coming from an external source.  

If applicable, you can optionally add the following fields to the integration table:

FieldRequiredNotes
IntegrationDetailActionYes

This field's value is used when processing the Header Detail to identify the action (create, update) that needs to be taken against the detail records when updating the header. When creating the header, the details must all be Create as well. When Deleting the header, the details are ignored and deleted with the header.

*Currently, Create is the only option.


nwExternalDetailIdNoThis field's value is used when processing a Header Detail to identify the External Id of the detail records.
HeaderOnlyNoThis field's value is used when the HeaderDetail table you are integrating too handles a header with no details. Use this field to determine whether the integration should try and insert a detail into the HD Structure.

Logic Blocks

It is not recommended to include any Action Blocks or Triggers on the integration table itself. When certain conditions are met, data imports can leverage a "copy" command in the database instead of importing rows line by line. Using a logic block on the integration table will disable this ability.

Table indexes

Include the following indexes in your integration table:

Index nameTypeFields
A
nwImportRunNumber (DESC), GroupLevel1, nwImportRowNumber
B
nwImportRunNumber, IntegrationStatus, GroupLevel1, nwImportRowNumber
CUniquenwImportRunNumber, nwImportRowNumber

Audit

Do not select the Create Audit checkbox for integration tables as the data is processed into its final table.

Org Unit Security Field

When this field is specified, Org Security is enabled for the table.  The user must be given access to the organization to have access to the record in the table based on the org field that is specified. If the table being integrated to is also using org unit security, it is recommended to use this field on the integration table.