Define the Data Source on the ODM Optim Connect Server

A data source definition on the ODM Optim Connect Server is needed to access archived data.

You can define a data source for each Archive File and Archive File Collection or specify the Archive File or Archive File Collection in an ODBC or JDBC connection string. (See Runtime Connection Information.) Data sources can easily be defined using the wizard, as described in Using the Data Source Configuration Wizard.

Conventions

The conventions used to describe these statements are:

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

Data Source Definition

A data source definition is expressed in XML as follows:

<DATASOURCE  
        NAME='datasourcename'   
        TYPE='PST_GDB' READONLY='true'>
      <CONFIG DIRDB='pstdirectoryname' 
       {   ARCV_FILE='archivefilename' |
         ARCV_GUID='{guid}' | 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)' |
               'AF_ID_RANGE(x,y)' } ]      [   PSTTRACE=COMP (n n ...) [ COMP (n n ...) ] ] />
</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 a maximum of 32 characters in length and cannot include hyphens (“-”).
TYPE= ‘PST_GDB'
The data source driver. The value for the ODM Optim Connect 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.
DIRDB= ‘pstdirectoryname'
The name of the Optim Directory in which the Archive File or Archive File Collection is registered.

Standard Optim processing opens the Optim Directory, when reading a configuration file or obtaining Windows registry information. After the Optim Directory is open, the Archive File or Archive File Collection is validated.

ARCV_FILE= ‘archivefilename'
The fully qualified Archive File name.
ARCV_GUID= ‘{guid}'
The Archive File GUID. This value is expressed between curved brackets ‘{ }'.
ARCV_ID=‘n'
The Archive File ID number.
COLLECTION= ‘archivefilecollection'
The Archive File Collection name.
PST_AF_SUBSET= ‘AF_IN' | ‘AF_DATE_RANGE' | ‘AF_ID_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, GUID, 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 to specify the time (e.g., 00:00:00).
‘AF_ID_RANGE (x,y)'
A range of Archive File IDs, where x is the start and y is the end.
PSTTRACE= COMP (n n ...)
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 PSTTRACE attribute.


Feedback