Creating an XML Scenario

This task explains how to create an XML scenario from the user interface.

Important: XML scenarios must be written in accordance with W3C standards.

You can find sample scenarios in the following directory:

$installpath/win_b64/resources/CATPLMTransfer/xml/samples

The parameters in the table below must be defined.

Notes:
  • If you need to add an SSL protocol to the 3DEXPERIENCE server i.e. https, the xml file must contain the additional parameter below: 
    <param name="Environment.ServerProtocol">https</param>
  • The XML scenario version is 1.6.
    <scenario_definition version ="1.6
xsi:schemaLocation="http://www.3ds.com/xsd/PLMTransferScenarios../xsd/TEScenarioDefinition_V1.6.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns=http://www.3ds.com/xsd/PLMTransferScenarios">

Parameter Name Defines ... Values
SourceProviderthe source provider
  • VPM1 (ENOVIAvpm)
  • VP5 (VPM V5)
  • MX1 (X-CAD Design Management)
  • SMT (SmarTeam)
TargetProviderthe target providerPLM1
Scenario name the name of the scenario as it appears in the user interface (selection box and message boxes) The name of the scenario as it appears in the user interface is a free choice but must be unique.

See Data Behaviors.

descriptionthe end user description of the given scenarioFree text
xsi:type the scenario type
  • Migration
  • CoexistenceV5V6
  • CoexistenceV6V5
Important: The Coexistence V6V5 value does not apply to SmarTeam.
(See Scenarios.)
TargetEnvironment the default PLM environment where data is written to the target

For more information, see Understanding PLM Environment in the CAA documentation under Infrastructure / VPM Multi-Discipline Collaboration / PLM Concepts.

An existing 3DEXPERIENCE PLM environment

See Process Behaviors.

StopRestart Sets the save frequency.

See Process Behaviors.

ContextSets the mapping context.

See Process Behaviors.

MultiPDMAllows reconciliation of data from several PDMs.

See Process Behaviors.

RefreshDataAllows a target data update whether the source data has been modified or not.On/Off

See Process Behaviors.

ModeDefines whether the source provider (TransferMe) or the target provider (UpdateMe) orders the transfer.TransferMe

See Process Behaviors.

CheckModeAllows you to check data integrity before launching the process.On/Off

See Process Behaviors.

ExecutionLogCreates an execution log (in CSV format) with stable information about the transfer.

For more information, see Launching the Resource Generator During Installation.

On/Off

See Process Behaviors.

MaturityTransfers maturity information.
  • On
  • Off
See Data Behaviors.
People and OrganizationTransfers People and Organization information.
  • On
  • Off
See Data Behaviors.
CustoAttributesProtectionPrevents Extended Enterprise attributes from being updated after running a Coexistence update.
  • On
  • Off
See Process Behaviors.
StreamsTransfer the data streams to be transferred VisualizationOnly / Upgrade / Downgrade

See Data Behaviors.

BLMandatoryStops the transfer if a problem occurs with BL execution.On/Off

See Process Behaviors.

The following is a sample scenario:

Note that the source provider parameters in the sample shown above apply to the ENOVIAvpm provider (VPM1). Such parameters differ depending on the connector concerned. Here is an example for ENOVIA SmarTeam V5: