About the Import Format

This topic provides information about the format to use when creating files containing objects you want to import.

This page discusses:

See Also
Importing Packages

Reminder

This topic provides background information about the import.

  • A Data Model Customization metadata is an xml file.
  • The root element is a package.
  • The xsd is PLMDictionaryUnified.
  • Each element has a UUID specified by the Uuid tag. It can be generated using the uuidgen command under Windows. When assigned to an object, it must not be changed and can be used only once.
  • Elements are named by their full database name including the prefix entered in Data Model Customization. Before R2015x, the WIP admin objects were named using a prefix:
    • A package used to start with VPLMpac/.
    • A type used to start with VPLMtyp/.
    • An instance used to start with VPLMrel/.
    • An extension used to start with VPLMitf/.
    • An attribute used to start with VPLMatt/.
    Notes:
    • This name mapping was suppressed in R2015x.
    • Packages created or exported in previous versions are still supported.

Allowed Characters for Naming

Only alphanumeric characters are allowed.

\ indicates that the character that follows should be considered literally, not interpreted as a regex directive.

Example
This expression indicates that the name string must start with a single character taken from the list: A-Z , a-z , 0-9 , or _ and must be followed by at least one character in the list: A-Z , a-z , 0-9 , _ , , : , / or -.

Package

A package is declared using the Package tag.

Description Example
Name
  • Full name of the package
  • Must use allowed characters 
Name="<prefix><ShortName>"
Name="DemoProdPack1"
Uuid Uuid. Must be unique. 
Uuid="faa6e328-516b-4c40-86a3-a31220b6cfa6"
UseNames

Parent of the package: Package that contains the types that are specialized or extended.

  • Specialization package: One and only one DS package
  • Deployment package: several DS packages separated by a semi colon 

<father package>
UseNames="PRODUCTCFG"
ModelerType Type of the package:
  • "Specialization" for specialization package (Specialize Data Model)
  • "Deployment" for a deployment package (Model Customization) 
ModelerType="Specialization“
ModelerType="Deployment"
xmlns Name of the xsd 
PLMDictionaryUnified
CustoPrefix Prefix used by all elements. Each file element must start with this prefix.

A prefix must start with a letter, and be made up at least of three alphanumeric characters (including underscore). 

<Property Name="CustoPrefix" Value="Demo"/>
CustoExportVersion Version used to produce the package. Use to check compatibility at import. 
Xport_<VersionName>_<HF or FP>
<Property Name="CustoExportVersion"
 Value="Xport_R417.HF9999"/>
LastModified Date of last modification (in millisecond from 1970/01/01). It must be increased each time the content changes. 
<Property Name="LastModified"
 Value="1435769392666"/>

Example

<Package
  Name="DemoProdPack1"  
  Uuid="459260f1-0a45-4d33-aef0-8a8645f180fe"  
  UseNames="PRODUCTCFG"  
  ModelerType="Specialization"
  xmlns="PLMDictionaryUnified">  

<Property Name="CustoPrefix" Value="Demo"/>  
<Property Name="CustoExportVersion" Value="Xport_R417.HF9999"/>  
<Property Name="LastModified" Value="1435769392666"/>

Type

A type is declared in a package using the Class tag.

Description Example
Name
  • Full name of the type.
  • Must use allowed characters. 
Name="<Prefix><LongName>"
Name="DemoAttOnAbstractRef"
Uuid Uuid. Must be unique. 
Uuid="faa6e328-516b-4c40-86a3-a31220b6cfa6"
SuperName

Parent of the type: Can be a DS type in the parent package or another type in the current package.

When the parent type is in the current package, it must be defined before the current one. 

SuperName="<father type name>"
SuperName="VPMReference"
Abstract

Indicates if the type is abstract or concrete.

Example to set a Type or an Extension to "not abstract". 

Abstract="false"
CreateInstName

Name of the instance to be used when an object is created. Instances must be in the same package. Names are separated using a pipe (|).

Prefix must not be specified. 

CreateInstName=<Short Instance Name1>
CreateInstName="Instance1"
IsAnInstance

Must be set to ‘Yes” if the Class is an instance.

Must not be defined if the Class is not an instance. 

IsAnInstance="Yes"

Example 1 

<Class
        Name="DemoAbstractReference" 
        SuperName="VPMReference" 
        Abstract="Yes"    
        Uuid="4a6dec80-8428-4d21-92dd-65c3c2863759"

Example 2

<Class
    Name="DemoInstance1"
    SuperName="VPMInstance"
    Uuid="715ba403-795e-4028-922f-d7e206e156a2"    
    IsAnInstance="Yes"

Attribute

An attribute is declared in a type or in an extension using the Simple tag.

Description Example
Name

  • Full name of the attribute.
  • Must use allowed characters. 

<ShortName>
Uuid Uuid. Must be unique. 
Uuid="faa6e328-516b-4c40-86a3-a31220b6cfa6"
Type Type of the attribute. 
String | Double| Integer | Boolean | Date
Type="Double"
MaxLength

Optional: Optional: For String type only. Maximum size of the value.

ResetOn[Clonning][Version]

Indicates if the value must be reset to the default value when the object is Cloned or Versioned. 

Yes | No
ResetOnCloning="Yes"
DefaultValue

Optional: Default value. If a range was defined, the default value must be between the range values. 

DefaultValue="Hello"
Range

Optional: Authorized values for the attribute. 

<Range> <Equal>Bonjour</Equal> 
<Equal>guten Tag</Equal> <Equal>Hello</Equal> </Range>
UIAccess Maximum access mode. Renamed in UIAccess in 2016x and is now a tag. 
ReadWrite | ReadOnly | None
UIAccess="ReadWrite"
V6Exportable Indicates if the attribute must be exchanged. 
TRUE | FALSE
<Property Name="V6Exportable" Value="TRUE"/>
SIXW

Optional: Name of the predicate where the attribute should be indexed. 

ds6w:<name of the predicate>
<Property Name="SIXW" Value="ds6w:what"/>
Indexation

Optional: TRUE indicates that the attribute will be indexed.

Do not set or declared this information if the attribute is not indexed 

TRUE | FALSE
<Property Name="Indexation" Value="TRUE"/>
Magnitude Name of the magnitude. 
<Magnitude name>
Magnitude="LENGTH"
ManipulationUnit

Optional: Name of the manipulation unit. 

<Unit symbol>
<Property Name="ManipulationUnit"> Value="MM"/>
Multivaluated

Optional: Indicates if the attribute can hold several values. 

Yes|No
Multivaluated="Yes"

Example: Attribute with a Magnitude

<Simple
Name="DemoAttLength"
Type="Double"
Magnitude="LENGTH"
ResetOnCloning="Yes"
ResetOnNewVersion="Yes"
UIAccess="ReadWrite"
DefaultValue="0.0054"
Uuid="80332749-9a22-484a-a152-5749a9501d8b"
>

<Property Name="ManipulationUnit" Value="MM"/>
<Property Name="V6Exportable" Value="TRUE"/>
<Property Name="Indexation" Value="TRUE"/>

Example: Multi valuated Attribute

<Simple
      Name="DemoAttExtDepl1"
      Type="String"
      ResetOnCloning="Yes"
      ResetOnNewVersion="Yes"
      MultiValuated="Yes"
      DefaultValue="Hello"
      Uuid="32440cc7-d0d3-4776-b4a9-c6e51646d047">

      <Property Name="CustoUserAccess" Value="ReadWrite"/>
      <Property Name="V6Exportable" Value="TRUE"/>
    </Simple>

Extension

In specialization packages, extensions are declared using the CustomerExtension tag. In deployment packages, extensions are declared using a Extension tag.
Name
  • Full name of the extension
  • Must use allowed characters 
<ShortName>
SuperName

Optional: Full name of the parent extension. If omitted, it is a root.

CustomerExtension.When specified, the extension must be in the parent package or in the current one.

Note: Supported only for customer extensions.
Abstract

Indicates if the type is abstract or concrete. Deployment Extension cannot be abstract. The default value is set to concrete. 

Abstract="Yes"
ScopesNames

Optional: List of the types that can be extended. They must belong to the parent packages (UseNames tag).

-
Note: The packages exported by the interactive tools contain some undocumented extra tags: PLMImpacting, Protection, and Abstract. You can remove them or keep them. If you keep them do not change their value.

Example 1

<CustomerExtension
    Name="DemoRootCustExt"
    ScopeNames="VPMReference;Relation.VPMInstance;"
    Uuid="d42c2e47-08a5-44a4-80be-9625819f986c"
>

Example 2

<Extension
    Name="DemoExtDepl1"
    ScopeNames="RFLVPMLogicalReference;VPMReference;"
    Uuid="ec260c8f-d8f1-47b0-81f0-d1614fa923d8"
>