Running the VPLMPosExport Batch Tool

Administrator users can run the VPLMPosExport batch tool.

You must use the -context parameter to specify a set of credentials referencing the VPLMAdmin role, for example VPLMAdmin.Company Name.Default. The Company Name that you provide here must be the name of the company and not the title.

See Also
About the Import and Export Batch Tools
Import / Export File Syntax
On Windows:
  1. Go the installation folder:

    INSTALL_PATH\server\win_b64\code\command

  2. Execute this command:

    VPLMPosExport.bat <PARAMETERS>

On UNIX:

  1. Go the installation folder:
    INSTALL_PATH/server/scripts
  2. Execute this command:
    VPLMPosExport.sh

Include the parameters required for this export:

Parameter Description Mandatory / Optional
-user <userid> The userID of the person who has administrator access to the repository. Mandatory
-password <password> User password for the above person. Mandatory
-context <contextid> Credentials identifier to be used to connect to the repository. If not specified, the default VPLMAdmin.Company Name.Default is used.

The Company Name that you provide here must be the name of the company and not the title.

Optional
-server <url> This parameter is deprecated and should not be used. Optional
-all Exports all contexts, organizations, persons, collaborative spaces, roles, and user groups. This parameter cannot be used with parameter -object.

The organization name exported using this option is the name of the organization and not the title.

Optional
-object <objecttype:objectid> Exports a specific object. You can export any of these object types:

  • businessunit
  • company
  • context
  • department
  • discipline
  • person
  • collaborative space
  • resource
  • role
  • group:GROUP_URI@MODE (to export a user group), where MODE is one of these:
    • GLOBAL exports these details:
      • Group definition (Group URI, Group Title, Group Description)
      • Group Members
      • Security Context (credentials) assigned to the group
      • Dependencies of the security context (company, collaborative space, and role)
      • Group Member/Person details (attributes, security context, admin, and membership with company)
    • PARTIAL: same as GLOBAL
    • LOCAL exports these group details:
      • Group definition (Group URI, Group Title, Group Description)
      • Group Members
      • Security Context (credentials) assigned to the group

To export multiple objects, include -object (and the required objectid) as many times on the command line as necessary.

Optional
-exportdatasetup Exports the product resource management data for any exported collaboration space. If you do not specify any collaborative spaces, either using -all or -object collaboration space <objectid>, the export includes details on all defined collaborative spaces. Optional
-exportlicenseassignment Exports license and credentials assignments.
-file <exportfile> Full path and name of the export file. The specified file path must be writable by the batch program. The file is created if necessary and overwritten if it already exists. Mandatory
-report <reportfile> Full path and name of the output report file. The report contains the execution status of all export commands. If not specified, no report is generated. Optional
-version

-v

Defines the version number of the software that generated the export file. Optional
-h Displays help. Optional