Data Model Customizer Tool

Data Model Customizer tool

Customize the data model using DMC tool

3DS.COM
3DS.COM © Dassault © Dassault Systèmes
Systèmes

Version 2.0 - 5/27/2015

Written by: Julien LASSET

Edited by: Anne Marie Miller

V6R2013x
Data Model Customizer Tool

Executive Summary

Data Model Customizer is an interactive tool dedicated to the customization of

the ENOVIA V6 VPLM data Model.

It allows the administrator to customize the data model by creating new types,
attributes, environment, etc.

The goal is to have a data model closer to the business process of the
Company or Organization.

The goal of this paper is to detail the concepts and the procedures for
Administrator in order to facilitate the usage of the Data Model Customizer
Tool.

Intended Audience: Developers, Administrators, Support Team Members,

Services and Infrastructure Team Members and Customers

3DS.COM © Dassault Systèmes

2
Data Model Customizer Tool

Contents
1. Concept and terms......................................................................................................... 4
1.1. DMC use .................................................................................................................... 4
1.2. Key terms ................................................................................................................... 4
1.3. Schema ...................................................................................................................... 5
2. Launch and configure the DMC tool ............................................................................... 5
2.1. Launcher .................................................................................................................... 5
2.2. Configuration .............................................................................................................. 5
3. Create a customized data model.................................................................................... 6
3.1. Create the customization ............................................................................................ 6
3.2. Create the type ........................................................................................................... 7
3.3. Create the attributes for the type ................................................................................ 7
3.4. Define the identifier set for the type ............................................................................ 8
3.5. Save the customization .............................................................................................. 9
3.6. Create the environment .............................................................................................. 9

3DS.COM © Dassault Systèmes

4. Deploy the customized data model .............................................................................. 11
4.1. Generate .................................................................................................................. 11
4.2. Backup ..................................................................................................................... 12
4.3. Publish ..................................................................................................................... 12
4.4. WarUtil ..................................................................................................................... 13
4.5. Deploy on server ...................................................................................................... 13
4.6. Commit ..................................................................................................................... 14
4.7. Check the deployment .............................................................................................. 14
5. Export and import an existing customized data model.................................................. 15
5.1. Export the customized data model............................................................................ 15
5.2. Import the customized data model ............................................................................ 16
6. Summary ..................................................................................................................... 17
7. Related documentation ................................................................................................ 17
8. Document history ......................................................................................................... 17
Data Model Customizer Tool

1. Concept and terms

1.1. DMC use

Data Model Customizer (DMC) tool is used to customize the data model for the old typing.
That means DMC tool can be used on V6 releases, since V6R2011 to V6R2013x.

For the new Typing, since 3DEXPERIENCE R2014x, new tools have been deployed, named
ENOVIA Knowledge Standardization (KWD) and ENOVIA Data and Behavior Administration
(DMA)

With DMC tool, the Administrator creates a customized environment, containing customized
modelers, composed of customized types with customized Attributes.

1.2. Key terms

Type: Type of object. It contains a list of attributes.

Modeler: it consists of a list of types and relations.

3DS.COM © Dassault Systèmes

For example, PRODUCTCFG is the Product modeler containing the types
VPMReference, VPMInstance, VPMRepReference, VPMRepInstance,
VPMConnection and VPMPort.

Customization: it is a new package from a modeler. It contains the customized types,

derived from the type of the parent modeler. For example, PLMProductDS is the
name of the sample customization of the PRODUCTCFG modeler.

Environment: it is a set of customization, and must contain one authoring

customization for each modeler.

Identifier set: set of attributes that are used as a key for identifying the objects of a
type, and ensure the uniqueness.

4
Data Model Customizer Tool

1.3. Schema

3DS.COM © Dassault Systèmes

2. Launch and configure the DMC tool

2.1. Launcher

According the OS of the server, the path to launch DMC tool is not the same:

For UNIX, the launcher is:

[Server Install Path]/scripts/DMCTool.sh

For Windows, the launcher is:

[Server Install Path]\OS\code\command\DMCTool.bat

2.2. Configuration

When DMC is started, the first thing to do is to

configure it. For that, click on Tools > Options…

5
Data Model Customizer Tool

In the General tab, specify the

prefix. It is three letters used for
naming new customizations
and types.

Specify the working folder path.

It is the directory where all file
will be generated before to
deploy on the server.

In the ENOVIA VPM Server

Configuration tab, specify the
ENOVIA Live Collaboration server
path and the server url.

When the options are configured, it

is recommended to quit and restart

3DS.COM © Dassault Systèmes

DMC tool.

3. Create a customized data model

3.1. Create the customization

To create a new customization, click on File > New

customization…

In the creation panel, specify the name of

the customization. The name has to start
with an existing prefix (CUS in the example).

Avoid to use this characters: / \ | * ^ ( ) [ ] { }

= < > # $ % & ! ? “ ; : ,’as well as any
accented characters.

Select the modeler to customize in the list

(PODUCTCFG in the example). Then click
OK.

6
Data Model Customizer Tool

3.2. Create the type

The customization is created. All the types of the selected

modeler have to be derived in the customization. Right click
the customization and select Insert type…

Specify the name of the custom type (starting with the

prefix) and select in the list the type to derive.

For some types, Expose in 3D XML for Review

option allows to see the type in the 3D XML format.

The type is created under the customization.

Each time a type is derived, it is removed from the list. So the same type cannot be derived
twice in the same customization

3.3. Create the attributes for the type

3DS.COM © Dassault Systèmes

For each derived type, attributes can be added in order to
answer the business needs. Right click the derived type and
select Insert attribute…

Specify the name of the custo attribute (It must begin

with E_ to respect the naming convention).

Then select the type of the attribute. It could be

boolean, integer, string, double, date, enumeration or
magnitude.

According the selected type, some others options are

available:

Default value (excepted date and mulivaluated attributes): At the creation of the
object, the default value is automatically setted for the attribute
Protection flag:
User: The attribute cannot become a part of the identifier set (see 3.4)
Free: The attribute can be a part of the identifier set and API can get and set
its value.

7
Data Model Customizer Tool

Max length (string attribute only): specify the max length of the string attribute. If it is
not set, the max length is 32 characters.
Mandatory (string attribute only): the object creation is blocked if the mandatory
attribute is not specified.
Reset on new version: if the box is checked, when an object is versionned (New
Version command), the attribute is reset (eventually to the default value if exists)
Reset on cloning: if the box is checked, when an object is cloned (Duplicate or
Propagate as New commands), the attribute is reset (eventually to the default value
if exists)
Multivaluate: if the box is checked, the attribute is not a single value but a set of
values. The multivaluation type is:
List: Elements are identified by their position in the list. Duplicate values are
supported.
Set: Elements are identified by their value. Duplicate values are not
supported.
Enumeration: When the Attribute
type is enumeration, click on Select
/ Edit or create to define the
enumeration list.
In the enumeration panel, you can
add new value to the list and

3DS.COM © Dassault Systèmes

change the order of elements.
The value for the attribute will be
selected by the user on this list.

Magnitude: When the attribute type

is magnitude, select a magnitude
property from the drop-down list.

3.4. Define the identifier set for the type

For some types (the ones derived from VPMReference and VPMRepReference in the
example), you have to define the identifier set. It is an index key
used to uniquely identify objects associated with a type in the
database. It is composed of the values of one or more attribute
strings concatenated together.

8
Data Model Customizer Tool

Click on the identifier set under the derived

type, and specify its name. Then choose the
attributes that will be concateneted and click on
the arrow to add them to the identifier set.

DASSAULT SYSTEMES strongly recommends

to use PLM_ExternalID and V_version for all
modeler except for material, simulation, folder
and catalog.

3.5. Save the customization

Customization can be save only after all

types are derived and identifier set created.

To save the customization, click on File >

Save > Customization ‘Customization

3DS.COM © Dassault Systèmes

Name’.

3.6. Create the environment

To allow final user to access a customization

(and create derived type), the customization
must be declared in an environment.

The default environment delivered, named

VPM, is a specific environment that cannot be
modified (but it can be copied).

To create a new environment, select the Environments

node in the Environments tab, and click on Insert >
Environment…

9
Data Model Customizer Tool

First, specify the name for the new

environment.

Then, select in the first list the

customizations and add them as
authoring customizations. An
environment must contain one and
only one authoring customization
for each customizable modeler.

Then select in the second list the

customization to add as usable
customization. (authoring
customizations must be added as
usable customizations).

When the authoring and usable customization list are finished, click on create.

If some customization are missing (some modelers don’t have customization in the lists), the
following page is shown. The list of modelers without customization is shown, and the self-
completeness button allows to automatically fill the environmnet with missing
customizations (the sample DS customizations are added for missing modelers).

3DS.COM © Dassault Systèmes

Remark: The authoring and usable lists can also be copied from another existing
environment (like VPM for example) by using the Import from another environment…
command.

When the new environment is created, the environmnet tree is

updated, showing the list of authoring customization (orang
square box) and the list of usable customizations (semi filled
blue box) added to the new environment.

To save the environmnent, click on File > Save > Environment.

10
Data Model Customizer Tool

4. Deploy the customized data model

At this step, all the customized data model (environment,

customizations) are save locally in the working folder
directory.

A folder for each customization has been created, containing

the metadata file.

A file for each environment has been created in the

vplm/environment directory.

But the customized data model is not deployed on the server,

and final user cannot create customized object.

The deployment of the customized data model consists

of 6 steps:

Generate
Backup

3DS.COM © Dassault Systèmes

Publish
WarUtil
Deploy on server
Commit

4.1. Generate

In this step, the mql script for creating the

customizations in the database, mapping
and index files are generated. If needed,
mask can be generated in this step too.

Select Tools > 1) Generate… and select

one or several customizations.

Check the Generate mql, mapping and

index files box and click Generate.

The generated MQL scripts are located in

the
WorkingFolder/Customization.dmc/mql
directory.

11
Data Model Customizer Tool

4.2. Backup

In this step, a backup of all important files on the server/STAGING directories is made,
because the publish step will overwrites these files on the ENOVIA server installation.

Select Tools > 2) Backup… and click on Backup.

3DS.COM © Dassault Systèmes

4.3. Publish

In this step, files generated in the

working folder (metadata, mapping,
index and mql files for the
customization, environment file and
eventually mask files) are copied in
the ENOVIA server installation.

Select Tools > 3) Publish… and

select the environments and
customizations to publish (eventually
the compiled mask).

Check the box to Compile all

environments in administration
file on server (else your
environment will not be displayed
the next time you open DMC).

Then click on Publish to copy the

files on the server installation.

12
Data Model Customizer Tool

4.4. WarUtil

This step allows the generation of

the .war and .ear files (that will be
used for the application server
deployment).

Select Tools > 4) WarUtil… and

click Launch.

Then, specify the server directory,

the name of your web application
and eventually the documentation
installation path.

The .war and .ear file will be

generated on the server/distrib
directory.

3DS.COM © Dassault Systèmes

4.5. Deploy on server

This step has to be done manually. Click on Tools > 5) Deploy on server… to see the
instructions:

Deploy the war file in you Web Application Server: same procedure as for the
ENOVIA Unified Live Collaboration installation.
Execute all mql files located in ENOVIA Live Collaboration Server/DMCmql directory:
The administrator must execute all MQL scripts to create the customizations in the
database, using MQL console. For example:
<MQL>set context person MyAdministrator;
<MQL>set env VPMAdministrator MyAdministrator;
<MQL>run /server/DMCmql/CUS_MyProductCustomization.0.mql;

13
Data Model Customizer Tool

4.6. Commit

The final step will clean up the working

folder and the server/DMCmql folder.
This step completes the full deployment
process and clean up to prepare for a
future customization creation or update.

Select Tools > 6) Commit… and click on

Commit.

4.7. Check the deployment

At this step, the customized data model is

deployed and can be used by final user.

3DS.COM © Dassault Systèmes

To check the deployment, connect to the
server with the rich client. Then, go to Tools
> Options… > PLM Access >
Identification and select the new
environment for Preferred Environment.

Create a customized object (Product in the example).

The customized attributes should be available, and
the Propagate should be successful.

14
Data Model Customizer Tool

5. Export and import an existing customized data model

The new customized data model could be exported from the current server in order to deploy
the same in another server (from example from the development server to the test server, or
from the customer server to the support server).

The environment, customizations and eventually the mask can be exported, that allows to
not re-creating them manually but only run the deployment steps on the new server.

5.1. Export the customized data model

First, ensure that the working folder define in DMC options is

empty. If not, select an empty working folder in the options.

Then open DMC and click on File > Import from server...

3DS.COM © Dassault Systèmes

In the import panel, select the
customized environmnet to import the
dedicated file locally (in your working
folder directory). Then check the box
Import associated Customizations.
The customizations associated to the
environmnet are selected.

Eventually, chek the Import only

associated mask files box or the
Import all mask files box if masks has
to be exported to the other server.

The metadata, mapping, index file for

the customization and the environment
file are saved in the working folder. The
state of the working folder is exactly the
same as at the end of chapter 3 (Create
a customized data model).

The working folder can now be copied to

the new server.

15
Data Model Customizer Tool

5.2. Import the customized data model

The working folder has been copied to the new server and can now be used for the
deployment of the data model in this new server.

Launch DMC in the new server and specify the copied working folder, using Tools >
Options.

Close and restart DMC. A message is displayed to inform that the environment has been
found in the working folder and loaded. These environment need to be published.

Then the deployment of the customized data model can be done in this new server by
following exactly the same step as in Chapter 4 (Deploy the customized data model).

3DS.COM © Dassault Systèmes

16
Data Model Customizer Tool

6. Summary

In this paper, we have seen the concepts and the procedures to:

Configure the DMC Tool

Create the customized data model (customization, environment, etc.)
Deploy the customized data model to the server
Export the customized data model from a server to another one

7. Related documentation

In the DS documentation for V6R2013x, refer to the chapter ENOVIA Development and
Configuration | Unified Live Collaboration | Studio Modeling - VPM Data Model Configuration

In the knowledge base, refer to the QA00000033539 for the sharing of the customized data
model with support.

3DS.COM © Dassault Systèmes

8. Document history

Document
Revision Date Revised By Changes/Notes

1.0 04/07/2015 Original

2.0 V6R2013x level added on the cover

05/27/2015 VLR
page

17
 Data Model Customizer Tool

3DS.COM © Dassault Systèmes