You can specify a parameter file name in a Data Source
and use the parameter file to define the criteria to select a unique
Archive File.
The advantage of using a parameter file
with a Data Source is that it allows you to create and employ a relatively
generic Data Source, and use the parameter file to comprehensively
define an Archive File for processing.
- A parameter file is a simple text file (created
in a text editor, such as Notepad) listing specifications to identify
an Archive File.
- You can specify criteria in a parameter file that
are beyond the scope of the criteria available in a Data Source.
- Each specification must contain an equal sign (=)
and be completed on one line.
- Specifications cannot wrap to the next line.
- You can use the % (percent) symbol and the _ (underscore)
as wildcards appropriate for the naming convention for a specification.
Use the % (percent) symbol to represent any number of characters,
or the _ (underscore) to represent a single character.
- Depending on your application, you can also specify
parameters on the connect string to override or complement parameters
specified in the Data Source.
Note: Specifications for selecting an Archive File are used as
follows: Criteria specified in the Data Source are superseded by criteria
specified on the connect string. Criteria specified on the connect
string are superseded by criteria specified in a parameter file.
- An Optim™ Directory
must be explicitly identified in the Data Source, in the connect string,
or in the parameter file.
Syntax
Use keywords
and values in a connect string (if your application allows), or in
a parameter file, as follows.
Note: When you specify an Archive
ID value, additional keywords and values are ignored.
DIRECTORY = pstdirectoryname
(ARCHIVEID = n | GUID = n |
FILE = archivefilename[SERVER = servername]
[GROUP = groupid]
[CREATOR = creatorid]
[TABLENAME = dbalias.creatorid.tablename]
[STARTDATE = startdate]
[ENDDATE = enddate]
[SELCRIT = tablename columnname relationaloperator value]
[COLCONN = tablename {AND|OR}]
[SQLTEXT = tablename SQLwhereclause]
[CONN = tablename {AND|OR}] )
Syntax Specifications
- DIRECTORY
- Specific Optim Directory.
- ARCHIVEID
- Archive File identifier (n).
The identifier must be a numeric value. The ARCHIVEID keyword
cannot be used when the FILE keyword is used,
and cannot be used with a SERVER keyword.
- GUID
- Globally Unique [Archive File] identifier (n).
The identifier must be a numeric value. The GUID keyword
cannot be used when the ARCHIVEID or FILE keyword
is used, and cannot be used with a SERVER keyword.
- FILE
- Specific Archive File name or a wildcard pattern.
- SERVER
- Optim Server
name or wildcard pattern.
- GROUP
- Group name associated with the Archive File, or
wildcard pattern.
- CREATOR
- Creator ID associated with the Archive File, or
wildcard pattern.
- TABLENAME
- Fully qualified table name, or wildcard pattern,
to narrow the focus to Archive Files containing the named table.
- STARTDATE
- Start date of range to limit Archive Files to those
created within a specific time frame. Date format must conform to
the setting chosen in the Windows Regional
Options.
- ENDDATE
- End date of range to limit Archive Files to those
created within a specific time frame. Date format must conform to
the setting chosen in the Windows Regional
Options.
- SELCRIT tablename columnname
relationaloperator value
- Selection criteria, to limit Archive Files to those
containing the named table, and the data specified. Use a fully qualified
table name (dbalias.creatorid.tablename)
for selection criteria. (Selection criteria must conform to SQL syntax
and must include a column name, relational operator, and a value.)
- COLCONN tablename {AND|OR}
- Column connector for multiple local selection criteria
applied to the named table.
- SQLTEXT tablename sqlwhereclause
- SQL WHERE clause, to limit Archive Files to those
containing the named table, and the data specified. Use the fully
qualified table name (dbalias.creatorid.tablename).
(The SQL WHERE clause (sql) must conform to SQL
syntax.)
- CONN {AND|OR}
- Table connector for SELCRITS or SQLTEXTfor
multiple tables.
Selection criteria and SQL WHERE clauses
are applied to Archive Indexes, if any exist. Depending on whether
the Only Use Index to Perform Search check
box on the Archive tab in Personal Options
is selected, criteria may also be applied to Archive File data to
identify the desired Archive File. (Refer to the Common Elements
Manual .)