Document number	Revision
DOCU13112	1

<data-import> Element - Schema Reference

<data-import> Element - Schema ReferenceDefinitionContent modelAttributesElementsSpecial elementsSamplesData import using column titles (title headers) for matching dataData import using numbered columns for matching dataRelevant tools and utilities

Definition

Parent element(s): <type>.

The Data Import functionality in Highstage enables users to update items and their associated data columns with contents from external Microsoft Excel documents.

Tip: You can create any number of Data Import profiles by creating additional <data-import> elements each with their own unique name.

Content model

The specification of what attributes, elements and data that are available and allowed within the <data-import> element.

Attributes

This section introduces you to the XML attributes and values that are available and can be included within the <data-import> element.

Attribute	Description	Example	Mandatory
name	Unique name of element.	`name="default"`	✔️
title	Profile title (displayed on button in the options section)	`title="Import Data"`	✔️
ignore-headers	Define a specific number of rows in the external Microsoft Excel document to be ignored when importing data.	Ignores the first row in the external Microsoft Excel document: `ignore-headers="1"`. Ignores the first three rows in the external Microsoft Excel document: `ignore-headers="3"`.	❌
matching	Define the column(s) in the external Microsoft Excel document that should be compared against Highstage data column(s) to identify matching item entries. Any number of data columns can be used simultaneously to identify matching entries (separated by `,`).	Matching (based on item ID) using header title row in the Excel document: `matching="{[item='fileitem']}"`. Matching (based on item ID) using column number in the excel document: `matching="{[item=1]}"`. Matching (based on item ID and* usestatus)* using a combination of header title row and column number in the excel document: `matching:="{[item='fileitem'],[usestatus=2]}"`	✔️
creating	Define which column(s) in the external Microsoft Excel document that should be inserted into specific Highstage data column(s) as data when creating new items from the list of unidentified items.	When creating unidentified items, update the workspace data column in Highstage with contents from the column in the external excel document with a header title of workspace: `creating="{[workspace='fileworkspace']}"`. When creating unidentified items, update the description data column in Highstage with contents from the column in the external excel document on the 5th column: `creating="{[description=5]}"`	❌
updating	Define which column(s) in the external Microsoft Excel document that should be inserted into specific Highstage data column(s) as data when importing.	Mapping columns from file against Highstage data columns using title headers: `updating="{[note='filenote'], [usestatus='fileusestatus'],[cost='filecost']}"` Mapping columns from file against Highstage data columns using numbered columns: `updating={[note=2],[usestatus=3],[cost=5]}`	✔️
basetype	Define the specific basetype of the items that is being updated with data.	`basetype="part"`	✔️
subtypes	Define which items of specific subtype(s) that must be updated with data from external Excel documents. Items with other subtypes will not be considered not updated with data from the external Excel document.	Consider all subtypes: `subtypes="*"`. Specific subtype: `subtypes="GD"`. Multiple subtypes: `subtypes="CMPN,ASM"`.	✔️
create	Controls whether users can create items directly from the list of unidentified items. Items created from the list of unidentified items will be populated with data that is defined in the `creating` attribute.	Enabled (allows for creation of items from the list of unidentified items): `create="1"`. disable (disables the possibility of creating items directly from the list of unidentified items): `create="0"`.	✔️
file-pattern	Define the naming conventions of the External Microsoft Excel file to be used for importing data.	Specific named file: `file-pattern="data.xlsx"`. First occurrence of file of specific type regardless of file name: `file-pattern="*.xlsx"`.	✔️

Elements

There are no elements available to be placed within the data-import element.

Special elements

There are no special elements available to be placed within the data-import element.

Samples

Data import using column titles (title headers) for matching data

The following sample illustrates how data is imported from DataImport.xlsx by matching data from the external Microsoft Office Excel file, using title headers, against items in Highstage:


x
    <type name="part">
        <data-import name="default"
            title="Data Import"
            ignore-headers="1"
            matching="{[item='fileitem']}"
            creating="{[type='filetype'],[workspace='fileworkspace'],[description='filedescription']}"
            updating="{[note='filenote'],[usestatus='fileusestatus']}"
            basetype="part"
            subtypes="*"
            create="1"
            file-pattern="DataImport.xlsx"
        ></data-import>
    </type>

The contents of the .xlsx file must adhere to the structure of the configured profile:

Resources: Click here to download a sample of the DataImport.xlsx file.

The configured profile does the following:

title="Data Import" Title of profile (will generate a new individual data import button in the advanced options section with the assigned title).
ignore-headers="1" The first title header row in the external Microsoft Excel file is ignored and omitted from being considered for import (as the row is being used for header titles for the individual columns).
matching="{[item='fileitem']}" Identifies matching entries based on the title header row in the .xlsx file and the item data column in Highstage. If a match exists, then data will be imported to the identified item.
creating="{[type='filetype'],[workspace='fileworkspace'],[description='filedescription']}" If there are unidentified entries in the .xlsx that does not match items in Highstage - then creating those items directly from Highstage will automatically paste the data into the newly created items in the create form.
updating="{[note='filenote'],[usestatus='fileusestatus']}" For all matched entries, the `note and usestatus data columns in Highstage will be updated with data from the matched rows in the external Excel document.
basetype="part" Only items of basetype part will be considered for import.
subtypes="*" Part items of any subtype will be considered for import.
create="1"
Adds an available create button on all unidentified entries from the external Microsoft Excel document allowing for those items to be created directly from Highstage.
file-pattern="DataImport.xlsx" Data will be imported from the file with the explicit name of DataImport.xlsx that is located directly in the folder associated with the item from where the Data Import is initiated.

Data import using numbered columns for matching data

The following sample illustrates how data is imported from DataImport.xlsx by matching data from the external Microsoft Office Excel file, using numbered columns, against items in Highstage:


xxxxxxxxxx
    <type name="part">
        <data-import name="default"
            title="Data Import"
            ignore-headers="0"
            matching="{[item=1]}"
            creating="{[type=4],[workspace=5],[description=6]}"
            updating="{[note=2],[usestatus=3]}"
            basetype="part"
            subtypes="*"
            create="1"
            file-pattern="DataImport.xlsx"
        ></data-import>
    </type>

The contents of the .xlsx file must adhere to the structure of the configured profile:

Resources: Click here to download a sample of the DataImport.xlsx file.

The configured profile does the following:

title="Data Import" Title of profile (will generate a new individual data import button in the advanced options section with the assigned title).
ignore-headers="0" No rows are omitted from import.
matching="{[item=1]}" Identifies matching entries based on the title header row in the .xlsx file and the item data column in Highstage. If a match exists, then data will be imported to the identified item.
creating="{[type=4],[workspace=5],[description=6]}" If there are unidentified entries in the .xlsx that does not match items in Highstage - then creating those items directly from Highstage will automatically paste the data into the newly created items in the create form.
updating="{[note=2],[usestatus=3]}" For all matched entries, the `note and usestatus data columns in Highstage will be updated with data from the matched rows in the external Excel document.
basetype="part" Only items of basetype part will be considered for import.
subtypes="*" Part items of any subtype will be considered for import.
create="1"
Adds an available create button on all unidentified entries from the external Microsoft Excel document allowing for those items to be created directly from Highstage.
file-pattern="DataImport.xlsx" Data will be imported from the file with the explicit name of DataImport.xlsx that is located directly in the folder associated with the item from where the Data Import is initiated.

Relevant tools and utilities

Click here to get started importing data in Highstage using the Data Import feature.

highstage_footer