Define the ODM Optim Connect Data Source

A data source definition is needed to access archived data. You can define a data source for each Archive File or Collection, or specify the Archive File or Collection in an ODBC or JDBC connection string.

Conventions

The following conventions used to describe these statements:

KEYWORD: Keywords are shown in uppercase for emphasis, but can be specified in lowercase or mixed case.
text: Variable text is shown in lowercase italics.
[ ]: An optional keyword or argument is shown in brackets.
{ }: A choice of settings from which only one must be selected is shown in curved brackets.
|: A vertical bar separates options.

Data Source Definition

A data source definition is expressed in XML as follows:

<DATASOURCE
    NAME='datasourcename' TYPE='PST_GDB' READONLY='true'>
    <CONFIG DB2SSN='db2subsystemname'
    PLAN='optimplanname'
    {ARCV_FILE='archivefilename' | ARCV_ID='n' |
     COLLECTION='archivefilecollection' }
      [PST_AF_SUBSET={ 'AF_IN(n,n,...)' |
      'AF_DATE_RANGE
      (yyyy-mm-dd-hh:mm:ss,yyyy-mm-dd-hh:mm:ss)' } ]
   [TRACEPARM='traceparms'
    TRACEOUT= ‘datasetname' | ‘SYSOUT=class' ] />
</DATASOURCE>

Syntax

Use the following syntax to define a data source:

<DATASOURCE>

Specifies the name and type of the data source and information required to connect to the data source.

NAME=‘datasourcename'

The data source name, which can be up to 32 characters and cannot include hyphens ("-").

TYPE=‘PST_GDB'

The data source driver. The value for the ODM driver is ‘PST_GDB'.

READONLY=‘true'

The value for an Archive File or Archive File Collection is ‘true.'

<CONFIG>

Specifies configuration properties of a data source.

DB2SSN=‘db2subsystemname'

The name of the DB2^® subsystem that includes the Optim Directory in which the Archive File or Archive File Collection is registered. The Optim Directory is read to validate Archive File names or Archive File Collection names. This parameter has a length of 4 bytes.

PLAN=‘optimplanname'

The Optim™ plan name. This parameter has a length of 8 bytes.

ARCV_FILE=‘archivefilename'

The fully qualified Archive File name. This parameter has a length of 44 bytes.

ARCV_ID=‘nn'

The Archive File ID number.

COLLECTION=‘archivefilecollection'

The Archive File Collection name.

PST_AF_SUBSET=‘AF_IN'|‘AF_DATE_RANGE'

Subsets an Archive File Collection to specific Archive Files. Use one of the following parameters:

‘AF_IN(n,n,...)': Archive Files to include, where n is an Archive File name or Archive File ID. If a specified Archive File cannot be found, the process will fail.
‘AF_DATE_RANGE(yyyy-mm-dd-hh:mm:ss,yyyy-mm-dd-hh:mm:ss)': A range of Archive File creation dates. You must include the time of day (hh:mm:ss). You can use zeros for the time (for example, 00:00:00).

TRACEPARM=‘traceparameters'

An optional attribute for turning on the Optim Trace file. This attribute should be used at the direction of Optim support. Do not use commas in the TRACEPARM attribute.

TRACEOUT=‘datasetname'|‘SYSOUT=class'

If the Trace file is used, indicate a preallocated z/OS^® dataset name or a SYSOUT class for the Trace file. You can also indicate the SYSOUT class in parentheses, for example, ‘SYSOUT(class)'.