Command Line

You can import and export packages from the command line using update.cockpit.commandLine.exe, located in the CRM.cockpit root directory.

The import and export settings (e.g. which processes and items) are defined in XML files. The included ExportConfigExample.xml and ImportConfigExample.xml files provide a basic package that you can extend as necessary.

The following parameters are supported:

--help (-?)

Outputs a list of supported arguments and a short description of each.

--import (-i)

Imports the package referenced by the specified XML file. You need to specify the XML configuration file containing the import settings using the --configuration parameter.

--export (-e)

Exports the package referenced by the specified XML file. You need to specify the XML configuration file containing the export settings using the --configuration parameter.

--configuration

Specifies the path and name of the configuration XML file (both relative and absolute paths are supported).

Example: update.cockpit.commandLine.exe --export --configuration MyExport.xml

--user (-u)

Specifies the user name used to log in to CRM.cockpit, e.g. "--user su". You do not need to specify the user when using single sign-in.

--password (-p)

Specifies the password of the user used to log in to CRM.cockpit, e.g. "--password MyPassword". You do not need to specify the user when using single sign-in. Omit this parameter if the specified user does not have a password.

--language (-l)

Specifies the language ID that cockpit should be started with. For a list of language IDs, >> Language IDs in the Appendix of the CRM.core Administrator Guide.

--exportDirectory (optional)

Specifies the target export directory (the default is \Export).

--importDirectory (optional)

Specifies the directory containing the zip file to be imported (the default is \Import).

--exportFileName (optional)

The name of the exported package file. Can be used in conjunction with --exportDirectory to specify the target path.

--importFileName

The name of the file containing the package to import. Can be used in conjunction with --importDirectory to specify the source path.

--deltabaseversion (-d)

Specifies the version number to use as the basis for an upgrade export, e.g. "-d 8.0.2.12" to export all items added or updated since the specified version number. The version takes precedence over the version specified in the XML file used by the export (DeltaBaseMode element, see Export Settings).

--templatenumber (-t)

Specifies the package version (the third digit in the version number) to be assigned to the exported package. If this parameter is not specified, the current cockpit package version number is used.

--exportnumber (-n)

The export number (the fourth digit in the version number) to be assigned to the exported package. If no number is specified, the current package number is incremented by 1 and that value is used.

--initial

When exporting a package, determine whether the initial package flag is set. This corresponds to enabling the This is an initial package option (see Exporting Packages ), and takes precedence over the entry in the configuration XML file.

--deployOfflineFiles

Include this parameter to deploy the offline files (those containing the '$WEB' placeholder) in the package to Aurea.CRM web offline's global patch directory. This option only applies when importing packages on the target station, see Deploying Offline Files .

Note: If items in the package are unavailable when exporting the package, no .zip file is generated. The log file contains information on which items could not be found.