Import Template screen

Uploads an entity that uses an exported entity template from your local machine, and adds it to AgilePoint NX Data Entities.

Figure: Import Template screen

Import Template screen

Video: Data Entities Overview

Prerequisites

Good to Know

  • When you import an entity from a Microsoft Excel file, the column names for the entity are the values of the first row of the first Excel sheet in the workbook.
  • When you import an entity from a Microsoft Excel file, the entity name is the name of the first Excel sheet in the workbook.

How to Start

  1. Click App Builder.

    Build Apps screen
  2. On the App Explorer screen, click Data Entities.

    Click Data Entities Screen
  3. On the Data Entities Home screen, click Entities.

    Click Entities
  4. On the Entities screen, on the right side of the screen, click Ellipses (...) > Import Template.

    Click Import Template

Fields

Field Name Definition

Select File To Import

Function:
Specifies a file that contains the entity template to use.
Accepted Values:
  • An XML or JSON file that contains an exported entity template.
  • A Microsoft Excel file that was exported or created as an entity template.

Click the Select a file button to select a file from your local file system.

Default Value:
None
Example:
Refer to:
Limitations:

Support for Microsoft Excel files is available in these releases:

Selected File Type

Function:
Shows the type of file you selected in the Select File To Import field.
Accepted Values:
Read only.
Default Value:
None

Import With Data

Function:
Specifies whether to import records from an entity saved as an XML file, JSON file, or Microsoft Excel file from your local machine.
Accepted Values:
  • On - Import an entity, which includes both an entity template and records saved as an XML file, JSON file, or Microsoft Excel file.
  • Off - Import only the entity template as an XML file, JSON file, or Microsoft Excel file.
Default Value:
Off
Limitations:

This field is available in these releases:

Retain Record Field Value

Function:
Specifies whether to keep the value in the ID field from the records in an entity you import.

The ID field provides a unique identifier for each record.

Accepted Values:
  • On - Keeps the stored value in the ID field for each record from an entity you import.

    If you want to keep the value in the ID field for each record, turn on this field. This is the correct option if you move an entity from one environment to another environment.

  • Off - Replaces the value in the ID field for each record with a unique GUID that is generated by Data Entities.
Default Value:
Off
Limitations:
This field is available in these releases:

Import

Opens this Screen:
Entity Preview screen

This screen opens when you select a Microsoft Excel file to import.

When you select an XML or JSON file, this screen does not show.

Function of this Screen:
Shows a preview of the custom entity to make any changes.
Limitations:

Support for Microsoft Excel files is available in these releases: