Running the VPLMPosExport Batch

This section explains how to run the VPLMPosExport batch tool.

You need to have VPLM administrator rights to be authorized to run the VPLMPosExport batch tool.

Keep in mind that you must specify using the -context parameter a security context referencing the VPLMAdmin role, for example VPLMAdmin.MyCompany.Default.

On Windows

Go the installation folder:

INSTALL_PATH\server\win_b64\code\command

then run the following command with the appropriate command-line parameters:

VPLMPosExport.bat

On UNIX

Go the installation folder:

INSTALL_PATH/server/scripts

then run the following command with the appropriate command-line parameters:

VPLMPosExport.sh

Command-Line Parameters

This is the full list of command-line parameters:

Parameter Description
-user userid P&O user identifier to be used in order to connect to the VPLM repository (mandatory); this parameter should only be specified when executing VPLMPosExport as a Java batch.
-password password User password to be used in order to connect to the VPLM repository (mandatory); this parameter should only be specified when executing VPLMPosExport as a Java batch.
-context contextid P&O context identifier to be used to connect to the ENOVIA V6 repository (optional; the default is VPLMAdmin.MyCompany.Default)
-server url

URL of the ENOVIA V6 server (mandatory), for example:

http://localhost:7023/ematrix

This parameter should only be specified when executing VPLMPosExport as a Java batch.

-all Instructs the export engine to export all P&O objects, i.e. all contexts, organizations, persons, projects and roles. This makes it possible to extract all P&O data from the VPLM repository at once, without having to specify a particular object. This parameter cannot be used with parameter-object
-object objecttype:objectid Instructs the export engine to export a particular P&O object. The latter is specified by a couple objecttype, which specifies the type of the object, and objectid, which specifies its identifier.

Below is the list of supported object types and the corresponding P&O Security objects:


  • context: P&O context (e.g. VPLMAdmin.MyCompany.Default)
  • organization: P&O organization
  • person: P&O person
  • role: P&O role.

Parameter -object can be specified several times in a single command-line so as to export several objects;.

-file exportfile Full path & name of the output import file (mandatory); the specified file path must be writable by the batch program; the file is created if necessary, and overwritten if it already exists.
-no-abort-on-error Have the export engine resume execution upon error (optional; the default behavior is to abort the execution as soon as an error is encountered).
-report reportfile Full path and name of the output report file (optional); if specified, the execution status of all import commands is written to the report file.
-h Display help (optional)

Limitations

This section describes limitations.

Syntax Support for Previous Releases

Older P&O and Security import files (that is, files generated from the old P&O and Security model prior to this release) are partly supported by the import batch.

Previous P&O and Security import syntaxes are supported as far as V5R16, so import files from these releases can be processed by batch VPLMPosImport. Older syntaxes are not managed and will result in execution errors if used.

All security commands from previous releases are ignored in this release, since no mapping exists between older security models and the security model in this release.

The command *SKILL is ignored in this release, since P&O object "skill" was removed later.

Previous P&O and Security customization (i.e. definition of new attributes on existing objects or whole new objects) - and the corresponding import syntax - is not supported in this release. Trying to import files containing custom keywords using the import batch tool will result in execution errors.

In addition, certain object attributes from previous releases may not be supported in this release because they were removed from the P&O and Security model, such as the usage of object Context.

Such attributes will not be taken into account by the import engine when processing files from previous releases. Please note that a difference exists between the scope of syntaxes that can be parsed by the import batch (that is, all syntaxes since V5R16) and the scope of commands that can actually be processed by the batch and the underlying P&O and Security model (that is, all commands since V5R16 except all security commands, the skill command and custom commands).

Commands that can be parsed but not processed are simply ignored, so it is possible to import older import files as is, without having to remove any unsupported content beforehand.

Older import files may be imported using the batch import tool, as long as they include an adequate version command, e.g.: *VERSION 204

All unsupported commands from previous releases (apart from custom commands) are automatically skipped and reported as such by the import batch, without triggering an error.

Note: version command was optional in all previous release syntaxes. It is mandatory so specific release data may not be imported if the version is not explicitly specified.

P&O Person Object Deletion Support

Only the deletion of P&O person objects is supported in this release. The deletion of all other P&O objects is not supported in this release: only creation and update capabilities are provided.

Note: As the Security model is fully based on the ENOVIA V6 model and infrastructure, which provides full authoring capabilities, deletion of security data is supported in this release.

P&O Multi-Valuated Attribute Support
The management of multi-valuated attributes is not supported in this release because of a lack of capabilities in the underlying ENOVIA V6 infrastructure.
PLM Provider Connectivity
As opposed to import/export batch tools provided in earlier releases, those provided by this highlight are dedicated to ENOVIA V6 and shall not be used with any other type of provider.
Data Access Control

In this release, only persons and organizations (that is companies, business units and departments) are modeled as ENOVIA V6 business objects - the others being modeled directly as administrative objects.

Read and write access to P&O and Security data is not controlled by any dedicated mechanism. This means that data is only secured by standard ENOVIA V6 mechanisms:


  • P&O business objects are secured by the default policy governing their type (e.g. "Person" for person objects)
  • administrative objects are secured by administration accesses.

Please refer to ENOVIA V6 administration documentation for details concerning the scope of default policies and administration accesses.

Attribute Commands Support

In this release, only persons and organizations (that is companies, business units and departments) are modeled as ENOVIA V6 business objects - the others being modeled directly as ENOVIA V6 administration objects.

As a consequence, commands +ATTRIBUTE and -ATTRIBUTE can only be applies to person and organization commands. They will be extended to other P&O commands once the corresponding objects are modeled as business objects.

Organization/Role/Project/Security Context/Person Duplicates

Because all organizations, roles, projects, security contexts, persons are all mapped into the same ENOVIA V6 administration type, there can be no duplicate identifiers between all these object types, e.g. there cannot be an organization and a project with the same identifier.

This limitation is permanent and will not be removed in later releases.

Parents of a Company

Setting the parent of a company is possible, when first creating the company, but once set at creation time the parent cannot be updated.