Element Mapping
Defines the mapping from Windchill native element (or attribute) to other formats. There are two kinds of mappings: element and attribute. Element mapping can contain element_mapping or attribute mapping as sub elements.
Parent Name : element_mapping
Name
Type
Data Type
Req?
Description
element
element
element
Yes
Root element mapping
root_tag_name
attribute
string
Yes
Local name of the root element.
id_tag
attribute
string
No
Attribute name whose type is xsd:ID.
ref_tag
attribute
string
No
Attribute name whose type is xsd:IDREF, which is used globally.
required_attributes
attribute
string
No
Required attributes of the root element, separated by comma (,).
Parent Name : element
Name
Type
Data Type
Req?
Description
element
element
element
No
Sub element mapping
attribute
element
element
No
Attributes mapping under current element
name
attribute
string
Yes
Element name of Windchill native format.
mapped_name
attribute
string
Yes
Mapped element name.
reuse
attribute
boolean
No
Defines whether the element should be retrieved from previous exported ones instead of creating new one, used with use_for_reuse in attribute mapping together to find exported element
default_mapped_name_for_attributes
attribute
string
No
Mapped element name (with attribute element name and value element name) which is used to store the attributes which do not have explicit mappings. This should be the name of a value reference mapping.
required_attributes
attribute
string
No
Attributes of the element which are required but cannot be set during export, separated by a comma (,). It can hold relative path, alias path and value reference path.
type
attribute
string
No
Windchill attribute name to be used to identify a different alias or value reference.
mapped_tag_name
attribute
string
No
Element name and value to identify current Windchill element. It is used if one AP214 AIM element is used to represent multiple Windchill elements.
import_context
attribute
string
No
Decide Windchill element name by value of parent element, mapping between element name and value of parent element should be one-one.
add_current_element_to_parent_by
attribute
string
No
The path used to add current element to parent one. It can hold relative path, alias path and value reference path. This will be used for sub element only.
connect_reference
attribute
string
No
The sub element which will be used to be added to parent element, used with add_current_element_to_parent_by together
Parent Name : attribute
Name
Type
Data Type
Req?
Description
exceptions
element
element
No
Used to hold different attribute mapping by different attribute value.
name
attribute
string
Yes
Element name of Windchill native format.
mapped_name
attribute
string
Yes
Mapped element name. It can be relative path, alias path and value reference path. Separated by a comma (,).
append
attribute
boolean
No
Defines whether to append to the existing value with defined separator, default value is false. For example, this can be used to append the iteration number to the version (A.5, where the value 5 is appended to A with a period [.] separator).
seperator
attribute
string
No
Separator for append. For example, this can be used to concatenate the iteration number to version (A.5, where the value 5 is appended to A with a period [.] separator).
add_to_element
attribute
string
No
Define the path which current element should be added after finding a previously exported element. It can be relative path, alias path and value reference path. Used for link element only.
use_for_reuse
attribute
boolean
No
Defines whether the attribute should be used to find previously exported element, used with reuse in element mapping together.
connect_reference
attribute
string
No
The sub element which will be used to be added to parent element, used with add_current_element_to_parent_by together
reference_to
attribute
string
No
Defines the sub element used as reference. Used for link element only. Default value is false.
identifier
attribute
string
No
Attribute name which is used to retrieve value from default_mapped_name_for_attributes configuration. If this is configured, mapped_name will not be used during import.
reuse
attribute
boolean
No
Define whether the attribute value can be multiple. If set to false, multiple values can be retrieved during import. Must be used when mapped_name is not configured. Default value is false.
value
attribute
string
No
This is used to represent a constant value, which will be set during export and can be fetched during import
required_attributes
attribute
string
No
Attributes which are required for current element, separated by a comma (,).It can be relative path, alias path and value reference path.
add_current_element_to_parent_by
attribute
string
No
The path used to add current element to parent one. It can hold relative path, alias path and value reference path. This will be used for sub element only.
required_attributes_for_parent
attribute
string
No
Attributes which are required for parent element, separated by a comma (,).It can be relative path, alias path and value reference path.
Works with add_current_element_to_parent_by together to set attributes basing on different attribute value
use_parent_object
attribute
boolean
No
Define whether to use parent element as reference to find related element and store/retrieve attribute value. Default value is false.
index
attribute
int
No
Define the index to get value from a list value.
Parent Name : exceptions
Name
Type
Data Type
Req?
Description
value
attribute
string
Yes
Value of parent attribute
mapped_value
attribute
string
No
Mapped value for original value, it should be one-one mapping.
attribute_name
attribute
string
No
Element name which is used to store the attribute value. It can be relative path, alias path and value reference path. Will not set attribute when mapped_element_name is configured
mapped_element_name
attribute
string
No
Element name which is used to identify original value, it should be one to one mapping, used for import only
required_attributes
attribute
string
No
Attributes which are required for current element, separated by a comma (,).It can be relative path, alias path and value reference path.
add_current_element_to_parent_by
attribute
string
No
The path used to add current element to parent one. It can hold relative path, alias path and value reference path. This will be used for sub element only.
required_attributes_for_parent
attribute
string
No
Attributes which are required for parent element, separated by a comma (,).It can be relative path, alias path and value reference path.
Works with add_current_element_to_parent_by together to set attributes basing on different attribute value
connect_reference
attribute
string
No
The sub element which will be used to be added to parent element, used with add_current_element_to_parent_by together
use_parent_object
attribute
boolean
No
Define whether to use parent element as reference to find related element and store/retrieve attribute value. Default value is false.
Was this helpful?