cust-STEP-mapping.xml Configuration File for STEP PDM

This section explains the global structure of the file cust-STEP-mapping.xml and its content.

To integrate your company’s customized data model in STEPPDM exchanges using ISO STEP AP242 XML, it is possible to configure a mapping in a file called cust-STEP-mapping.xml.

An example of object and attribute mappings of a sample customized 3DEXPERIENCE platform data model is provided with an installation in the directory <Installation path>\reffiles\STEPPDM\config\client.

The structure of file cust-STEP-mapping.xml is a list of <Object> xml tags inside the <ObjectsConfig> xml container element:

<STEPAP242XMLCustConfig …>
  <ObjectsConfig>
       <Object …>
          <attribute …>
          <attribute …>
           …
           </Object>
           <Object …>
           <attribute …>
           <attribute …>
           
            …
      </Object>
     …
  </ObjectsConfig>
</STEPAP242XMLCustConfig>

Each <Object> xml element corresponds to the declaration of a mapping between a STEPPDM entity and object type of the 3DEXPERIENCE platform data model. Each <Object> xml element contains declarations for attribute mapping. The format of <Object> xml element is as following:

<Object Type_STEPAP242XML="…" Type_3DEXPERIENCE="…" CustomizedType_STEPAP242XML="…">

where,

  • Type_STEPAP242XML: STEP AP242 XML entity name (xml tag, for example: Part, Document).

  • Type_3DEXPERIENCE: 3DEXPERIENCE platform entity type (existing or customized).

  • CustomizedType_STEPAP242XML: User defined name corresponding to the classification of the Part or Document object elements in the STEPAP242XML file.

For each object an attribute mapping should be provided. The attribute mapping is defined into an <attribute> element. The format of the <attribute> xml element is as following:

<attribute Name_STEPAP242XML ="…" Name_3DEXPERIENCE ="…" type="…" >

where,

  • Name_STEPAP242XML: Name of the STEP AP242 XML PropertyValue.
  • Name_3DEXPERIENCE: Name of 3DEXPERIENCE platform attribute to be exchanged.

    It must correspond to an attribute declared on the 3DEXPERIENCE platform object type.

  • type: Attribute data type.

    Some of the possible values are boolean, double, integer, string, dateTime.

    Refer cust-STEP-mapping.xsd file, for a complete list of possible values.

Notes:
  • You cannot map attribute names, if no mapping is defined for the object type.
  • You cannot map attribute names, if no mapping is defined for the object type.
  • You cannot import engineering exchanges data, when you define mappingtype in XPDMXML and pdm-cust-config is not available or that mappingtype is not defined in pdm-cust-config.
  • When you are importing a data with custom attributes having range values in the database, you can use only the authorized values (range values) in XPDMXML for import. You cannot replace authorized values with NLS values even if they have the same meaning in a different locale. If the NLS value is different, then the actual value present in the database is expected in the XPDMXML. For more information, see Installation and Setup | Customize | 3DEXPERIENCE Platform | 3DSpace Data Model | Data Model Customization | Manage NLS
  • When you are exporting a data with custom attributes such as String, Integer, Real, and Boolean, these attributes are exported with the following values:
    • The String attribute is exported as StringValue.
    • The Integer attributes are exported as NumericalValue with the unit equals to theinteger representation.
    • The Real attributes are exported as NumericalValue with the unit equals to real representation.
    • The Boolean attributes are exported as NumericalValue with the unit equals to boolean representation.
  • When you are importing a data with custom attributes the unit is used to define the type of attribute. The value of a StringValue is not used to define the type of attribute.
  • To define the type of attribute using the value of a StringValue, specify the variable as
    set STEPPDM_InterpretStringValueType=1
    .