Advanced Customization > Business Logic Customization > Data Exchange using Standards in Windchill > Product Lifecycle Management Services, Version 2.0 > PLM Mapping Information > Details of the Mapping between Windchill and PLM Services
  
Details of the Mapping between Windchill and PLM Services
Alias Mapping
Defines alias for mapping path which can be used in mapped name and required attributes in element mapping section, we will use this to reduce duplicated mappings. This will be only relative path.
Parent Name
Name
Type
Data Type
Required?
Description
alias_mapping/alias
exceptions
element
element
no
Sub alias mapping, used with type attribute to provide different alias mapping by different attribute values.
name
attribute
ID
yes
Unique name of alias element.
path
attribute
string
no
Related path to store/retrieve value.
attribute
attribute
string
no
Attribute name for store/retrieve value, used with path together.
type
attribute
string
no
Windchill attribute name to be used to identify a different alias.
The following mapping will be mapping for exceptions:
Parent Name
Name
Type
Data Type
Required?
Description
exceptions
value
attribute
string
yes
The value of defined type attributes.
path
attribute
string
no
Related path to store/retrieve value.
attribute
attribute
string
no
Attribute name for store/retrieve value, used with path together.
Value Reference Mapping
Defines alias for mapping path which can be used in mapped name and required attributes in element mapping section, we will use this to reduce duplicated mappings. This will contain two kinds of path:
1. Element which hold a reference of current element, as following:
<Specific_item_classification uid="uid">
<Associated_item>ref_uid</Associated_item>
<Classification_name>assembly</Classification_name>
</Specific_item_classification>
<Item uid="ref_uid">
</Item>
2. Element which will be reference by current element, as following:
<Document_file uid="uid">
<File_format>ref_uid</File_format>
</Document_file>
<Document_format_property uid="ref_uid">
<Data_format>ApplicationData</Data_format>
</Document_format_property>
Parent Name
Name
Type
Data Type
Required?
Description
value_reference_mapping/value_reference
exceptions
element
element
no
Used with type attribute in element mapping to define different value reference mapping for different attribute value.
sub_value_reference
element
element
no
Sub value reference mapping, used for path No. 2 only.
name
attribute
ID
yes
Unique name of value reference element.
path
attribute
string
no
Related path to store/retrieve value, used for path No.1 only.
condition
attribute
string
no
Condition to filter the element, used for path No.1 only, support following pattern only: <key>=<value>
mapped_name
attribute
string
no
Parent element name for the path, used for path No.1 only.
type
attribute
string
no
For path No.1:The relative path to check if current element is a supported windchill tag. for example, Item_shape will also be used to represent representation and EPMDescribeLink.For path No.2:The element name which will be create as reference, this should be sub element.
ref_attribute
attribute
string
no
The relative path which keeps the object reference, used for path No.1 only.
connect_reference
attribute
string
no
The sub element which will be used as reference.
reuse
attribute
boolean
no
Defines if this element is reusable, work with locate_by attribute together to find previous created element instead of create new one all the time.
locate_by
attribute
string
no
Defines the attribute list of a reusable element, separated by a comma (,).
ref_type
attribute
string
no
The element name which will be create as reference, this should be root element, used for path No.2 only.
required_attributes
attribute
string
no
Attributes which are required for current element, separated by a comma (,).It can be relative path and alias path.
attribute_name
attribute
string
no
The relative path which will be used to hold reference or attribute value, used for path No.2 only. If identifier is configured, it will be used to store the name of attribute.
identifier
attribute
string
no
The relative path which will be used to hold attribute value, works with attribute_name together to store attribute name and value.
The following mapping will be mapping for exceptions:
Parent Name
Name
Type
Data Type
Required?
Description
exceptions
sub_value_reference
element
element
no
Sub value reference mapping, used for path No. 2 only.
attribute_name
attribute
string
no
The relative path which will be used to hold reference or attribute value, used for path No.2 only.
value
attribute
string
no
The attribute value to choose current exception configuration.
ref_type
attribute
string
no
The element name which will be create as reference, this should be sub element, used for path No.2 only.
type
attribute
string
no
The element name which will be create as reference, this should be root element, used for path No.2 only.
required_attributes
attribute
string
no
Attributes which are required for current element, separated by a comma (,).It can be relative path and alias path.
The following mapping will be mapping for sub_value_reference_type
Parent Name
Name
Type
Data Type
Required?
Description
sub_value_reference_type
add_to_element
element
element
no
Element mapping which current element will be added to.
reference_to
element
element
no
Element mapping which current element will reference it.
attribute_name
attribute
string
no
The relative path which will be used to hold reference or attribute value, used for path No.2 only. If identifier is configured, it will be used to store the name of attribute.
required_attributes
attribute
string
no
Attributes which are required for current element, separated by a comma (,).It can be relative path and alias path.
connect_reference
attribute
string
no
The sub element which will be used as reference.
ref_type
attribute
string
no
The element name which will be create as reference, this should be root element, used for path No.2 only.
unit_attribute_name
attribute
string
no
The relative path which will be used to hold unit attribute value. Used for path No.2 and global attribute only.
reuse
attribute
boolean
no
Defines if this element is reusable, work with locate_by attribute together to find previous created element instead of create new one all the time.
locate_by
attribute
string
no
Defines the attribute list of a reusable element, separated by a comma (,).
identifier
attribute
string
no
The relative path which will be used to hold attribute value, works with attribute_name together to store attribute name and value.
The following mapping will be mapping for add_to_element and reference_to:
Parent Name
Name
Type
Data Type
Required?
Description
add_to_element
name
attribute
string
yes
Path which is used to add current element to another element. It can be relative path and alias path.
value
attribute
string
yes
The value which will be used to find parent element.
reference_to
name
attribute
string
yes
Path which is used to reference another element. It can be relative path and alias path.
value
attribute
string
yes
The value which will be used to find another element.
connect_reference
attribute
string
yes
The sub element which will be used as reference
* 
Use following pattern to define value attribute:
{ROOT}/usedBy/ObjectReference/ufid, this means to get value of attribute named ‘usedBy/ObjectReference/ufid’ from current element.
Element Mapping
Define 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
Name
Type
Data Type
Required?
Description
element_mapping
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 (,).
The following will be mapping for element:
Parent Name
Name
Type
Data Type
Required?
Description
element
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 PLM 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 .
The fllowing will be mapping for attribute:
Parent Name
Name
Type
Data Type
Required?
Description
attribute
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.
Worked 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.
Following will be mapping for attribute exceptions:
Parent Name
Name
Type
Data Type
Required?
Description
exceptions
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.
Worked 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.