Command Line Syntax

The Batch Client can be used with the command-line parameters described below. Bracketed values ( [ ] ) are optional extensions provided for clarity. Both shorter and longer versions of the value are supported. Commands and parameters are not case-sensitive.

Caution!

For all parameters, version names containing a space must be in quotes, for example, “April – Production”.

The following table describes the command-line parameters for all operations.

Table 15. All Operations

Parameter

Description

/op=

Specifies an operation to perform:

  • ActionScript

  • BackupVersionToFile

  • Blend

  • CloseVersion

  • Export

  • Import

  • Multi

  • OpenVersion

  • RefreshVersion

  • RestoreVersionFromFile

  • DeleteVersion

This parameter is required

/u=

Specifies the Data Relationship Management user name for login.

/pw=

Specifies the Data Relationship Management password for login.

/url=

Specifies the URL (including the port number) for the Process Manager application in the Data Relationship Management server processes. This URL is configured and is available in the Data Relationship Management configuration console. For example, "net.tcp://localhost:5210/Oracle/Drm/ProcessManager"

This parameter is required.

/log=

Specifies the path and file name for the log file. If the file exists, the log is appended to the end of the existing file. It is recommended that you put the value in double quotes.

Note:

The specified log file may not be created if the /log parameter is placed after a problematic parameter such as a parameter with a missing or invalid value. To ensure that the specified log file is created, the /log parameter should be placed as the first parameter.

This parameter is optional. If not specified, the following name is used: DRM_Batch_ClientMMDDYYYY.log, where MM = month, DD = day, YYYY = year

/cfgfile=

Specifies the path and file name of the configuration file describing desired options. It is recommended that you put the value in double quotes.

/h[elp] | /?

Displays a list of command-line parameters.

/timezoneid

Used for rendering of dates/times in output.

This parameter is optional. The default is the server's time zone.

/culturename

Local culture name, in the format: languagecode-country/regioncode where languagecode is a lowercase two-letter code derived from ISO 639-1 and country/regioncode is an uppercase two-letter code derived from ISO 3166. For example, U.S. English is en-US.

This parameter is optional. The default is the server's culture.

/objectaccess

Object access method for accessing import, export, and blender objects. Valid values are Standard, System, or User or custom group.

This parameter is optional. The default is Standard.

The following tables describe the command-line parameters that can be used with each operation.

Table 16. Action Script Parameters

Parameter

Description

/infile=

Specifies the path and file name for the input file. It is recommended that you put the value in double quotes. This parameter is required.

/delim=

Specifies the delimiter. Specify one of the following values:

  • Tab

  • Comma

  • #nnn

where #nnn represents any valid 3-digit ASCII character value (0–255).

Tab is the default value.

/cols=

Specifies the column order. If supplied, must contain all column identifiers. A12345 is the default value.

/stripq=

Specifies whether to remove quoted strings. Specify one of the following values:

  • Y[es]

  • N[o]

  • T[rue]

  • F[alse]

  • 1

  • 0

The default value is True.

/propertyrefbylabel

Look up property references by label (instead of name). Specify one of the following values:

  • Y[es]

  • N[o]

  • T[rue]

  • F[alse]

  • 1

  • 0

/encoding

Character encoding of input file as either an encoding name or encoding code page number. This parameter is optional.

The default is UTF8.

Table 17. Blend Parameters

Parameter

Description

/bl=

Specifies the name of blender to run. This parameter is required.

/sver=

Specifies the name for the source version to blend. This parameter is required.

/tver=

Specifies the name for the target version to blend. This parameter is required.

/nvera=

Specifies the name for the new version to create.

/nverd=

Specifies a description for the new version. You must enclose the value in double quotes.

/save=

Specifies whether to save the blended version or leave it detached. Specify one of the following values:

  • Y[es], T[rue], or 1

  • N[o], F[alse], or 0

The default value is False. For information on saving versions, see Saving Versions in the Batch Client.

/blendlog=

Specifies the name of the blend log file (not the same as the Batch Client log file).

Table 18. Close Parameters

Parameter

Description

/abbrev=

Specifies the name for the version to close. This parameter is required.

Table 19. Export Parameters

Parameter

Description

/xtype

Specifies the type of export: individual export or book. Specify one of the following values:

  • E[xport]

  • B[ook]

This parameter is required.

/fdate=

Specifies the From date/time for transaction log exports (Optional)

Note:

Date/time formats are determined by the regional settings on the client computer.

/tdate=

Specifies the To date/time for transaction log exports (Optional)

Note:

Date/time formats are determined by the regional settings on the client computer.

/outfile=

For exports configured to output to a client file, this parameter specifies the path and file name for the output file. If the output file exists, it is overwritten. It is recommended that you put the value in double quotes. If this parameter is specified and the export is configured to send output to an external server connection, this parameter overrides the external server connection and the export is written to the file specified with /outfile.

/xname=

Specifies the name of the saved export to run. This parameter is required if running a single export.

/cver=

Specifies the name for the current version. This parameter is optional. If not specified, the system uses the value of the DefaultCurrentVersion system preference.

/pver=

Specifies the name for the previous version. This parameter is optional. If not specified, the system uses the value of the DefaultPreviousVersion system preference.

/cvertype=

Specifies the version type for the current version. Valid values are:

  • A[s Of]

  • N[ormal]

N[ormal] is the default.

/pvertype=

Specifies the version type for the previous version. Valid values are:

  • A[s Of]

  • N[ormal]

N[ormal] is the default.

/casofdate=

Specifies the As Of Date/Time to use when creating an As Of Version for the current version for the export.

Note:

Date/time formats are determined by the regional settings on the client computer.

/pasofdate=

Specifies the As Of Date/Time to use when creating an As Of Version for the previous version for the export.

Note:

Date/time formats are determined by the regional settings on the client computer.

/bk=

Specifies the name of the saved book to run. This parameter is required if exporting a book. It is recommended that you put the value in double quotes.

/bkcmb=

Specifies whether to combine the export output into the file named in /outfile. Specify one of the following values:

  • Y[es]

  • N[o]

  • T[rue]

  • F[alse]

  • 1

  • 0

If this parameter is False, each export is saved in the file name stored in its export profile. Exports for which the file name in the export profile is invalid or for which Output is set to a value other than File are combined into the file named in /outfile. The default value is stored in book.

/prefile=

Specifies the path and file name to prepend to a combined export book. The default value is stored in book.

/pstfile=

Specifies the path and file name to append to a combined export book. The default value is stored in book.

/fhier=

Specifies the From (Previous) Hierarchy. Used for Hierarchy Compare and Hierarchy Difference exports.

/thier=

Specifies the To (Current) Hierarchy. Used for Hierarchy Compare and Hierarchy Difference exports.

/fabbrev=

Specifies the name for the top node of the From (Previous) hierarchy. Used for Hierarchy Compare and Hierarchy Difference exports.

/tabbrev=

Specifies the name for the top node of the To (Current) hierarchy. Used for Hierarchy Compare and Hierarchy Difference exports

/hier=

Specifies the name for the hierarchy to export. Used for Hierarchy Export and other similar exports, but not used for Hierarchy Compare and Hierarchy Difference exports.

/nabbrev=

Specifies the name of the top node to export. Used for Hierarchy Export and other similar exports, but not used for Hierarchy Compare and Hierarchy Difference exports.

/encoding

Character encoding of file as either an encoding name or encoding code page number. This parameter is optional.

If an encoding is specified, it overrides the encoding saved with the export or book being run. The specified encoding also applies to the batch client's available local prefile and postfile options.

Note:

If a book is run, the encoding does not override the encoding of the exports within the book, only the encoding setting of the book itself.

The default is UTF8.

Table 20. Import Parameters

Parameter

Description

/infile=

For imports configured to import from a client file, this parameter specifies the path and file name for the input file. It is recommended that you put the value in double quotes. This parameter is only required for imports configured to import from a client file.

Caution!

Do not use this parameter for imports configured to use an input file from an external server connection, otherwise an error occurs.

/iabbrev=

Specifies the name for the import to run. This parameter is required.

/implog=

Specifies the name of the import log file (not the same as the Batch Client log file.) This parameter is required.

/vabbrev=

Specifies the version name to be created by import. The default value is stored in the import profile.

/vdescr=

Specifies the description of the version to be created by import. The default value is stored in the import profile.

/save=

Specifies whether to save the imported version or leave it detached. Specify one of the following values:

  • Y[es]

  • N[o]

  • T[rue]

  • F[alse]

  • 1

  • 0

The default value is False.

For information on saving versions, see Saving Versions in the Batch Client.

Table 21. Open Parameters

Parameter

Description

/vabbrev=

Specifies the name of the version to open. This parameter is required.

Table 22. Refresh Parameters

Parameter

Description

/vabbrev=

Specifies the name of the version to refresh (close and re-open). This parameter is required.

Table 23. Delete Parameters

Parameter

Description

/vabbrev=

Specifies the name for the version to delete. This parameter is required.

Table 24. Restore Version from File Parameters

Parameter

Description

/filename=

Specifies the name of the file to locate using the external connection (/conn).

/conn=

Specifies the name of the external connection.

/sver=

Specifies the names of versions in the source file to restore; delimited by /delim if there are multiple versions.

/tver=

Specifies the names of new versions, correlating to the /sver parameter; delimited by /delim if there are multiple versions.

/delim=

Printable delimiter character. Uses a single character such as colon (:), comma (:), dash (-), and so on.

/save=

Save versions after restoring - Y: Yes, N: No, T: True, F: False, 1, 0

Table 25. Backup Version to File Parameters

Parameter

Description

/vabbrev=

Specifies the names of versions to backup; delimited by /delim if there are multiple versions.

/conn=

Specifies the name of the external connection.

/filename=

Specifies the name of the backup file to create using the external connection (/conn).

/delim=

Printable delimiter character. Uses a single character such as colon (:), comma (:), dash (-), and so on.