Making an entity or field available to import

The Import property designates whether an entity, field, or related entity can be imported using the application Record Import.

The import option must be set at several levels, the entity level, the field level, and the relationship level for related entities in order for data to be imported.

Note: The system administrator and users with the appropriate role can access these features. See What are Roles and Secured Actions?

To make an entity importable:

  • Access the Entity Manager view. See Using the Entity Manager
    1. Click the entity Name for the entity you require to set up for import. The Edit Entity field is displayed.
    2. Select Import.
    3. Select Match to use the entity as match criteria when searching for duplicate records during an import if required. You are required to specify at least one field as match criteria.
    4. Click OK.
  • On the Entity Manager view, with the entity from step 1 still selected, click the Fields tab.
    1. Select the field you require to import.
    2. Click Edit.
    3. Select Import in the Edit field. See Adding a Field
    4. Select Match to use the field as match criteria when searching for duplicate records during an import if required. The field is only used as match criteria if the entity is also designated as match criteria.
      Note: If an entity is selected as match criteria, then you also need to specify at least one field of that entity as match criteria.
    5. Click OK.
    6. Repeat steps 2a-2e for each field that you require to import.

To include related entities in an import:

  • On the Entity Manager view, select the main entity to be imported, and click the Relationships tab. Selecting Import allows the entity to be imported when the related entity is imported, but only if the Import option is selected at the entity level for both the parent and child entities.
    1. Select the relationship for the related entity you require to import.
    2. Click Edit.
    3. Select Import in the Edit Relationship field. See Adding relationships
    4. Select the Include field so that it is included in the code generated output.
    5. Click OK.
    6. Repeat steps 1a-1e for each related entity that you require to import.
  • For each related entity, click the entity Name in the Entity Manager list to view the Edit Entity field. See Modifying an entity
    1. Select Import.
    2. Select Match to use the related entity as match criteria when searching for duplicate records. You also need to specify at least one field as match criteria if required.
    3. Repeat 2a-2b for each related entity you want to be imported with the main entity.
  • On the Entity Manager view, with the entity from step 2 still selected, click the Fields tab.
    1. Select the field you require to import.
    2. Click Edit.
    3. Select Import in the Edit field.
    4. Select Match to use the field as match criteria when searching for duplicate records during an import. The field is only used as match criteria if the entity is also designated as match criteria if required.
    5. Click OK.
    6. Repeat steps 2a-2e for each field that you require to import.
  • Repeat steps 1-3 for each related entity you require to import.