Configuration File Syntax

In addition to using command-line parameters, the Batch Client can be run with a configuration file. Configuration files are formatted like INI files, with sections, keys, and values. There is a General section and an additional section for the specific operation. Section names are enclosed in brackets ( [ ] ) and can be any string value but must match the value specified by the operation key. Lines within each section are formatted in key=value pairs.

Below is an example configuration file.

[General]
Operation=Export
UserName=mylogin
Password=mypassword
URL=net.tcp://localhost:5210/Oracle/Drm/ProcessManager
LogFileName=C:\Oracle\Data Relationship Management\rdsc.log

[Export]
ExportType=Export
ExportName=WeeklyExport
OutFile= C:\Oracle\Data Relationship Management\export_data.txt
CurrentVersionAbbrev=COA Current
PrevVersionAbbrev=COA Previous

A configuration file can include multiple operations. Each operation is contained in a separate section with a unique label. A special section labeled [Operations] is used to specify the number of operation sections in the file and the label for each. The operations are performed in the order listed.

Below is an example of a configuration file with multiple operations. Note that when using multiple operations, the operation key, for example Operation=Import, must be included in each section.

Note:

Sections, keys, and values are not case sensitive.

[General]
Operation=Multiple
UserName=mylogin
Password=mypassword
URL=net.tcp://localhost:5210/Oracle/Drm/ProcessManager
LogFileName=C:\Oracle\Data Relationship Management\rdsc.log

[Operations]
OperationCount=3
Operation1=Weekly_Import
Operation2=Update_CostCenters
Operation3=Merge_Data

[Weekly_Import]
Operation=Import
InFile="COA_data.txt"
ImportAbbrev="RDSC Import"
ImportLogFileName="C:\Oracle\Data Relationship Management\Batch Client\import_log.txt"
VersionAbbrev="COA Current"
VersionDescription="COA for this month"

[Update_CostCenters]
Operation=Action Script
InFile=CostCenter_changes.txt
StripQuotedStrings=True
Delimiter=comma

[Merge_Data]
Operation=Blend
Blendname="COA Blender"
SourceVersionAbbrev="COA Current"
TargetVersionAbbrev="COA Previous"
NewVersionAbbrev="COA Blended"
NewVersionDescription="Current and Previous COA"

The following tables describe the keys that can be used in each section of the configuration file.

Table 26. General Section of Configuration File

Key

Description

Operation

Specifies the operation to perform. Specify one of the following values:

  • ActionScript

  • BackupVersionToFile

  • Blend

  • CloseVersion

  • Export

  • Import

  • Multi

  • OpenVersion

  • RefreshVersion

  • RestoreVersionFromFile

  • DeleteVersion

This key is required

UserName

Specifies the Data Relationship Management user name for login. This key is required.

Password

Specifies the Data Relationship Management password for login. This key is required.

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.

Note:

It is recommended that you put the value in double quotes.

This key is required.

LogFileName

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.

The default file name is DRM_Batch_ClientMMDDYYYY.log, where MM = month, DD = day, YYYY = year

TimezoneOffset

Local minutes offset from GMT. For example, U.S. CST offset minutes from GMT is -360.

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.

Table 27. Multiple Section of Configuration File

Key

Description

OperationCount

Specifies the number of operation sections in the file. Specify an integer greater than 0. This key is required.

OperationN

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

Table 28. Action Script Section of Configuration File

Key

Description

InFile

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

StripQuotedStrings

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.

Delimiter

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.

ColumnOrder

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

Table 29. Blend Section of Configuration File

Key

Description

BlendName

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

BlendLogFileName

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.

SourceVersionAbbrev

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

TargetVersionAbbrev

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

NewVersionAbbrev

Specifies the name for the new version to create.

NewVersionDescription

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

AutoSave

Specifies whether to save the blended 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 30. Close Section of Configuration File

Key

Description

VersionAbbrev

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

Table 31. Export Section of Configuration File

Key

Description

ExportType

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

  • E[xport]

  • B[ook]

This key is required.

OutFile

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. This key is required.

ExportName

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

CurrentVersionAbbrev

Specifies the name for the current version. If not specified, the name of the default version is used.

PrevVersionAbbrev

Specifies the name for the previous version. If not specified, the name of the default version is used.

BookName

Specifies the name of the saved book to run. This key is required if exporting a book. Enclosing value in double quotes is recommended.

CombineExportOutput

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.

PreFileName

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

PostFileName

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

FromHierarchy

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

ToHierarchy

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

FromTopNodeAbbrev

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

ToTopNodeAbbrev

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

HierarchyCount

Specifies the number of hierarchy/top node pairs defined.

Hierarchyn

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

TopNodeAbbrevn

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.

FromDate

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

ToDate

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

CurrentVersionType

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

  • A[s Of]

  • N[ormal]

The default is N[ormal].

CurrentAsOfDate

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

PrevVersionType

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

  • A[s Of]

  • N[ormal]

The default is N[ormal].

PrevAsOfDate

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

Table 32. Import Section for Configuration File

Key

Description

InFile

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

ImportAbbrev

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

ImportLogFileName

Specifies the path and file name of the import log file. This is not the same log file as defined by the LogFileName key in the [General] section.) The default file name is DRM_Batch_ClientMMDDYYYY.log, where MM = month, DD = day, YYYY = year

VersionAbbrev

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

VersionDescription

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

AutoSave

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 33. Open Section for Configuration File

Key

Description

VersionAbbrev

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

Table 34. Refresh Section of Configuration File

Key

Description

VersionAbbrev

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

Table 35. Delete Section of Configuration File

Key

Description

VersionAbbrev

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