Command Line Parameters and Configuration File Keys

The tables in this section describe the command line parameters and configuration file keys that can be used in the Batch Client.

Table 17. General Commands

Key

Parameter

Description

Required

Operation

/op=

Specifies the operation to perform:

Y

UserName

/u=

Specifies the Data Relationship Management user name for login.

Y

Password

/pw=

Specifies the Data Relationship Management password for login.

Y

URL

/url=

Specifies the URL (including the port number) for the Engine 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/Engine

Y

LogFileName

/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.

Caution!

To run multiple Batch Client processes concurrently, you must specify a unique log name for each process.

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.

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

N

N/A

/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.

Y, if using a configuration file

N/A

/h[elp] | /?

Displays a list of command-line parameters.

N

TimezoneOffset

/timezoneid

Local minutes offset from GMT. For example, U.S. CST offset minutes from GMT is -360. Used for rendering of dates/times in output.

The default is the culture used by the server.

N

CultureName

/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.

The default is the culture used by the server.

N

ObjectAccess

/objectaccess

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

The default is Standard.

N

Table 18. Action Script

Key

Parameter

Description

Required

InFile

/infile=

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

Y

Delimiter

/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).

The default is Tab.

N

ColumnOrder

/cols=

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

N

StripQuotedStrings

/stripq=

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

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

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

The default is True.

N

PropertyRefByLabel

/propertyrefbylabel

To look up property references by label (instead of name), specify one of the following values:

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

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

Default is True.

N

Encoding

/encoding

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

The default is UTF8.

N

Table 19. Backup Version To File

Key

Parameter

Description

Required

VersionAbbrev

/vabbrev=

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

Y

Connection

/conn=

Specifies the name of the external connection.

Y

Filename

/filename=

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

Y

Delimiter

/delim=

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

N, unless vabbrev is a list of versions

Table 20. Blend

Key

Parameter

Description

Required

BlendName

/bl=

Specifies the name of blender to run.

Y

SourceVersionAbbrev

/sver=

Specifies the name for the source version to blend.

Y

TargetVersionAbbrev

/tver=

Specifies the name for the target version to blend.

Y

NewVersionAbbrev

/nvera=

Specifies the name for the new version to create.

N

NewVersionDescription

/nverd=

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

N

AutoSave

/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 is False. For information on saving versions, see Saving Versions in the Batch Client.

N

BlendLogFileName

/blendlog=

Specifies the name of the blend log file (not the same as the Batch Client log file). The default value is stored in the blend profile.

Y

RunTimeParameters

N/A

Specifies a comma-delimited list of runtime parameters. An example of the format is: RuntimeParameters=City=Dallas,State=Texas,ZipCode=75234.

If the value contains a delimiter such as a comma, special characters, or double quotes then enclose the value in double quotes.

Note:

[CR/LF], [CR], [LF] are not allowed as part of the value.

N

Table 21. Close Version

Key

Parameter

Description

Required

VersionAbbrev

/abbrev=

Specifies the name for the version to close.

Y

Table 22. Delete Version

Key

Parameter

Description

Required

VersionAbbrev

/vabbrev=

Specifies the name for the version to delete.

Y

Table 23. Export

Key

Parameter

Description

Required

ExportType

/xtype

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

  • E[xport]

  • B[ook]

Y

ExportName

/xname=

Specifies the name of the saved export to run.

Y if running a single report

OutFile

/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 here.

Y

CurrentVersionAbbrev

/cver=

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

Y, if no version variable is saved with the export

PrevVersionAbbrev

/pver=

Specifies the name for the previous version. Used for Hierarchy Compare and Hierarchy Difference exports. If not specified, the system uses the value of the DefaultPreviousVersion system preference.

Y, for Compare and Difference exports if no version variable is saved with them

CurrentVersionType

/cvertype=

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

  • A[s Of]

  • N[ormal]

The default is N[ormal].

N

PrevVersionType

/pvertype=

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

  • A[s Of]

  • N[ormal]

The default is N[ormal].

N

CurrentAsOfDate

/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.

Y, when version type is AsOf

PrevAsOfDate

/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.

Y, when version type is AsOf

BookName

/bk=

Specifies the name of the saved book to run. It is recommended that you put the value in double quotes.

Y if exporting a book

CombineExportOutput

/bkcmb=

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

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

  • N[o], F[alse], or 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 /outfileor OutFile. The default value is stored in book.

N

PreFileName

/prefile=

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

N

PostFileName

/pstfile=

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

N

FromHierarchy

/fhier=

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

N

ToHierarchy

/thier=

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

N

FromTopNodeAbbrev

/fabbrev=

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

N

ToTopNodeAbbrev

/tabbrev=

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

N

Hierarchyn

/hier=

Specifies the name for the hierarchy to export where n is a number (1 through HierarchyCount) identifying the current hierarchy/top node pair (for example, TopNodeAbbrev1). Must match Hierarchyn. Used for Hierarchy Export and other similar exports, but not used for Hierarchy Compare and Hierarchy Difference exports.

N

TopNodeAbbrevn

/nabbrev=

Specifies the name of the top node to export where n is a number (1 through HierarchyCount) identifying the current hierarchy/top node pair (for example, TopNodeAbbrev1). Must match Hierarchyn. Used for Hierarchy Export and other similar exports, but not used for Hierarchy Compare and Hierarchy Difference exports.

N

Encoding

/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.

N

HierarchyCount

/hier

Specifies the number of hierarchy/top node pairs defined.

N

HierarchyGroupPropFromParam

N/A

Specifies whether to get the hierarchy group property name from a parameter or a specified hierarchy group property. Specify one of the following values:

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

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

If True, specify a parameter name for HierarchyGroupProperty; if False, specify a hierarchy group property name for HierarchyGroupProperty. The default value is False.

N

HierarchyGroupProperty

N/A

Specifies a parameter name or a hierarchy group property name. If HierarchyGroupPropFromParam is True, a parameter name is expected; if False, a hierarchy group property name (including its namespace) is expected.

N

HierarchyGroupFromParam

N/A

Specifies whether to get the hierarchy group value from a parameter or a specified hierarchy group. Specify one of the following values:

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

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

If True, specify a parameter name for HierarchyGroup; if False, specify a hierarchy group name for HierarchyGroup. The default value is False.

N

HierarchyGroup

N/A

Specifies a parameter name or a hierarchy group name. If HierarchyGroupFromParam is True, a parameter name is expected; if False, a hierarchy group name is expected.

N

RunTimeParameters

N/A

Specifies a comma-delimited list of runtime parameters. An example of the format is: RuntimeParameters=City=Dallas,State=Texas,ZipCode=75234.

If the value contains a delimiter such as a comma, special characters, or double quotes then enclose the value in double quotes.

Note:

[CR/LF], [CR], [LF] are not allowed as part of the value.

N

FromDate

/fdate=

Specifies the From date/time for transaction log exports

Note:

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

N

ToDate

/tdate=

Specifies the To date/time for transaction log exports

Note:

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

N

Table 24. Import

Key

Parameter

Description

Required

InFile

/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.

Caution!

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

Y, if importing from a client file

ImportAbbrev

/iabbrev=

Specifies the name for the import to run.

Y

ImportLogFileName

/implog=

Specifies the path and file name of the import log file (not the same as the Batch Client log file.) The default file name is DRM_Batch_ClientMMDDYYYY.log, where MM = month, DD = day, YYYY = year.

Y

VersionAbbrev

/vabbrev=

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

N

VersionDescription

/vdescr=

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

N

AutoSave

/save=

Specifies whether to save the imported 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 is False. For information on saving versions, see Saving Versions in the Batch Client.

N

RunTimeParameters

N/A

Specifies a comma-delimited list of runtime parameters. An example of the format is: RuntimeParameters=City=Dallas,State=Texas,ZipCode=75234.

If the value contains a delimiter such as a comma, special characters, or double quotes then enclose the value in double quotes.

Note:

[CR/LF], [CR], [LF] are not allowed as part of the value.

N

Table 25. Multiple

Key

Parameter

Description

Required

OperationCount

N/A

Specifies the number of operation sections in the file. Specify an integer greater than 0.

Y

OperationN

N/A

Specifies the label for an operation section where N is a number between 1 and the OperationCount value.

Y

Table 26. Open Version

Key

Parameter

Description

Required

VersionAbbrev

/vabbrev=

Specifies the name of the version to open.

Y

Table 27. Refresh Version

Key

Parameter

Description

Required

VersionAbbrev

/vabbrev=

Specifies the name of the version to refresh (close and re-open).

Y

Table 28. Request

Key

Parameter

Description

Required

WorkflowModel

/WorkflowModel=

Specifies the name of a workflow model

Y

RequestTitle

/RequestTitle=

Specifies a request title

Y

Version

/vabbrev=

Specifies the name of a version

Y, if no version variable is specified on the workflow model

WorkflowTask

/WorkflowTask=

Specifies the name of a workflow task. Must be a task assigned to the Submit stage of the request.

Y

Hierarchy

/hier=

Specifies the name of a hierarchy.

Y, if not defaulted using hierarchy group

Connection

/conn=

Specifies the name of the external connection. Must refer to a server file connection accessible via the batch client user’s object access groups.

N

FileName

/filename=

Specifies the name of the file to locate using the external connection. If Server File Connection Name is specified, then this parameter refers to a file available to the server connection

Y if Connection is specified

InFile

/infile=

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

Y, if Connection is not specified

Delimiter

/delim=

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

N

StripQuotedStrings

/StripQuotedStrings=

Specifies whether to remove quoted strings from data values found in the file. Specify one of the following values:

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

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

The default is True.

N

AllowBlankOverrides

/AllowBlankOverrides=

Specifies whether to allow blank overrides. Specify one of the following values:

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

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

N

BlankValueIndicator

/BlankValueIndicator=

Specify text value to indicate to indicate blank values in the file.

N

DeleteOnSubmitFailure

/DeleteOnSubmitFailure=

Specifies whether to delete the request if the submit is not successful. Specify one of the following values:

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

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

Default value is False.

N

Encoding

/encoding

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

The default is UTF8.

N

Table 29. Restore Version From File

Key

Parameter

Description

Required

Connection

/conn=

Specifies the name of the external connection.

Y

Filename

/filename=

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

Y

SourceVersionAbbrev

/sver=

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

Y

TargetVersionAbbrev

/tver=

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

Y

Delimiter

/delim=

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

N, unless sver or tver are specified as list of versions

AutoSave

/save=

Save versions after restoring:

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

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

N