Generating a Connection Parameter File

You must create a connection parameter file on the 3DEXPERIENCE Platform client machine, to setup X-PDM Gateway for exchanging Engineering data. The connection parameter file is used by the Gateway Server for 3DEXPERIENCE Platform to execute XPDMImportExportBatch.

The connection parameter file is required for the following cases:

  • When data is transferred from X-PDM to 3DEXPERIENCE Platform.
  • When data is transferred from 3DEXPERIENCE Platform to X-PDM using either of the following:
    • Share > Export... > XPDM...
    • Through a Business Rule for server opening.
Note: The connection parameter file for the above scenarios should always be generated using the Export tab of the XPDMImportExportBatch.

Before you begin: Login to a 3DEXPERIENCE Platform session as Administrator.
Note: The users with Leader role are recommended to generate connection parameter file for a data exchange between X-PDM and baseline behavior environment.
  1. From the secondary area of Tools section of the action bar, click Utility.....
    The Batch Monitor dialog box appears.
  2. Double-click XPDMImportExportBatch from the list.
    The XPDMImportExportBatch dialog box appears.
  3. In the Selected Operation area, select the Export tab.

    The corresponding export options appear.

  4. In the Export Project list, select an appropriate mapping context of the X-PDM system.

    For more information about mapping context configuration, see Identify the Exchange Channel.

  5. Click Advanced Options....

    The Advanced Options dialog box appears.

  6. In the Export Scope Options area, select the appropriate options.

    For more information refer Using XPDMImportExportBatch to Export.

  7. In the Report area, enter the following details:

    OptionsDescription
    Report directory Browse and select a directory. All the transaction reports and logs are generated.
    Report name Enter a name for the report.

  8. Click Save.

    Save the xml file in directory.

    ${ClientInstallation}\${OS}\reffiles\XPG\config\client

    The file name must be BatchInputTemplate_<SiteID>_<Option String>.xml

    where,

    • BatchInputTemplate is a mandatory prefix.
    • <SiteID> corresponds to the Export Project field and should also correspond to site id defined in site-ids-config.xml file in Gateway Server for X-PDM environment.
    • <Option String> corresponds to the Option box selected in the Share > Export... > XPDM... option. The Option box is used to define different sets of transfer options stored in different connection parameter files. The Option names can incorporate separators such as a space, underscore or hyphen characters. Other special characters are not allowed. The following table lists sample values for <Option String>:
      <Option String>In the Selected Operation area
      OptionValue
      As_ Specifications CATIATarget FormatCATIAV5-6R2015
      Light Representationclear
      light CATIATarget Format Any CATIA format
      Light Representation select
      STEPTarget Format STEP
      Target Drawing FormatAny CATIA format
      Light Representation clear

    Create a default connection parameter file, BatchInputTemplate_<Site ID>.xml with BatchInputTemplate_<Site ID>_<Option string>.xml.

    The default connection parameter file is used during for the following transfers:

    • Transfer from X-PDM to 3DEXPERIENCE platform.

    • Transfer from 3DEXPERIENCE platform to X-PDM, when the Option box is empty. For more information, see Transferring in Interactive Mode.

    Note: The batch input XML file contains batch parameters as defined in UI when generating the file. It is possible to modify these parameters or add some more by editing this file. For more details about the xPDM transfer batch parameters, see CAA Documentation: Vertical Integration | X-PDM .