Overrides For Archive, Delete, Report, and Restore Requests

Overrides allow you to override certain parameters in the Action Requests you run from the command line, and in the objects referenced by them.

Archive Process

The following overrides are available for the Archive Process.

SERVER
Override for the Optim™ Server specified in the Archive Request.

Using the SERVER override in conjunction with the SERVER keyword causes a fatal error.

servername
The name of an Optim Server that is referenced in the Product Configuration File.
(local)
Process on the local Server. (Default)
AFFILE
Override for the Archive File name in the Archive Request.
arcfilename.af
The name of the Archive File. Provide the full path if the file is not in the default Archive File Directory.
AFXFILE
Override for the Archive Index File name in the Archive Request.
idxfilename.afx
The name of the Archive Index File. Provide the full path if the file is not in the default Archive Index File Directory.
GROUP
Override for the group designation in the Archive Request.
groupidentifier
1- to 8-character name of the group for the Archive File. Group names can help qualify and categorize Archive Files and the corresponding archived data and can be referenced to locate one or more Archive Files for browsing or restoring data.
ADNAME
Override for the local or named Access Definition referenced in the Archive Request.
identifier.name
Two-part name of an existing Access Definition.
DEFQUAL
Override for the Default Qualifier in the Access Definition used for processing.
dbalias[.cid ]
One or two-part default qualifier for tables referenced in Access Definition.
PNSFILE
Override for Point and Shoot designation for the process.
pnsfilename.pns
The name of the Point and Shoot File. Provide the full path if the file is not in the default Archive File Directory.
STARTTAB
Override for the Start Table specification in the Access Definition used in the process.
[ [ dbalias. ] cid. ]tablename
One, two, or three-part Start Table name. If tablename is not fully qualified, the default qualifier is used.
ROWLIMIT
Override for maximum number of rows setting in the Archive Request.
n
0 (to use the maximum limit) or a number from 1 to the maximum limit specified in Product Options. If the row limit is reached, the Archive File is valid, but a Directory entry is not created.
TABROWLIM
Override for Start Table row limit setting in the Archive Request.
[ [ dbalias. ] cid. ]tablename
One, two, or three-part Start Table name. If tablename is not fully qualified, the default qualifier is used.
n
A number from 1 to 99999999 as the maximum number of rows to be extracted from the Start Table.
DEFERDAA
Override for Defer Delete after Archive setting in the Archive Request.
Y
Rows are not deleted in the Archive Process and must be deleted in a separate Delete Process.
N
Rows are deleted in the Archive Process
SEL
Override for, or addition to, selection criteria specification for Archive Process. Selection criteria must conform to SQL syntax. You can enter multiple SEL overrides in a command, but each SEL override must be on a separate line.
[ [ dbalias. ] cid. ]tablename
One, two, or three-part table name. If tablename is not fully qualified, the default qualifier is used.
columnname
Name of column to which criteria applies.
operator
Logical operator appropriate for your DBMS.
value
Value or list of values appropriate for the operator, expressed as literals or substitution variables (:variablename)
SQL
Override for SQL WHERE specification. You can enter multiple SQL overrides in a command, but each SQL override must be on a separate line.
[ [ dbalias. ] cid. ]tablename
One, two, or three-part table name. If tablename is not fully qualified, the default qualifier is used.
sqlwhereclause
The SQL WHERE clause.
VAR
Override for value in substitution variable used in the process.
variablename
Name of the substitution variable.
value
The corresponding value for the variable.

Delete Process

For a Delete Process, or Archive Process that includes an undeferred Delete Process, the following override parameters are available:

AFFILE
Override for the Archive File name in the Delete Request.
arcfilename.af
The name of the Archive File. Provide the full path if the file is not in the default Archive File Directory.
CFFILE
Override for the Control File name in the Archive or Delete Request.
confilename.cf
The name of the Control File. Provide the full path if the file is not in the default Data Directory.
COMMFREQ
Override for Commit Frequency setting for Delete processing.
n
Specify any number between 1 and the maximum set in Product Options.
LOCKTABS
Override for Lock Tables option for Delete processing.
Y
Lock tables during delete processing.
N
Do not lock tables.
DISROWLIM
Override for Discard Row Limit setting in the Archive or Delete Request.
n
0 (to impose no limit) or a number from 1 to 99999999 to stop processing after the specified number of rows are discarded and all rows in the array processed. You can Restart or Retry a process that stops because the limit is reached.

Report Processing

The following overrides are available for processes that include a Report Process.

General

For a Report Process or Archive Process that includes a Report Process, the following override parameters are available:

REPORTNAME
Override for the local or named Report Request referenced in an Archive Request. Do not use this keyword if running a standalone Report Request.
identifier.name
Two-part name of the Report Request.

Source File

For a Report Process for a Source File (for example, an Archive File), the following override parameters are available:

SOURCEFILE
Override for the Source File name in the standalone Report Request to be processed.
arcfilename.af
The name of an Archive File for the report. Provide the full path if the file is not in the default Archive File Directory.
TITLE
Override for report title.
string
Up to 40 characters to appear on each page of the report.
AUTOREPNEWTABLES
Override for the Automatically Report New Tables setting in the Report Request used for processing.
Y
Include all Source File tables in the report.
N
Include only tables in the original Source File in the report.

Archive Directory

For a Report Process for an Archive Directory, the following override parameters are available:

ARCHCRITDELIMITER
Override for the character used to separate criteria values. Recognized values are:
  • ,
  • ;
  • :
  • |
ARCHCRITVALUE
Override or addition to criteria in the Report Request. Criteria of the same type is overridden in the Report Request while criteria of a type that is not in the Report Request is appended to the end of the sort order. You can use one or more of the following:
SERVER
Optim Server(s) for Directory entries to be listed.
blank, (Local), or (None)
The local Server.
name
1 to 15 character name or pattern for the Server.
GROUP
Group(s) for Directory entries to be listed.
blank or (None)
Entries with no specified group name.
name
1 to 8-character name or pattern.
FILENAME
Name(s) of Archive File(s) for Directory entries to be listed.
name
Name or pattern for Archive File. (Required)
CREATOR
Creator ID(s) for Directory entries to be listed.
cid
1 to 26-character name or pattern. (Required)
CREATIONRANGE
Range of creation dates for Directory entries to be listed.
mm/dd/yyyy
Date after which Directory entry was created. (Required)
mm/dd/yyyy
Date before which Directory entry was created. (Required)
RETENTIONRANGE
Retention range for Directory entries to be listed.
A valid retention range of dates (for example, 01/01/2010 , 12/31/2010 to list entries for all files with retention period ending in 2010.) or number of days (for example, 1 , 365 to list all entries with retention period ending in next year.).
mm/dd/yyyy or days
Date after which the Archive File is to be deleted.
mm/dd/yyyy or days
Date before which the Archive File is to be deleted.
blank
Entries with no retention policy.
STORAGEPROFILE
Name(s) of the Storage Profile(s) associated with Directory entries to be listed.
blank or (None)
Entries with no specified Storage Profile.
name
Name or pattern for Storage Profile.
BACKUPDEVICE
Name(s) of the backup device(s) type for Directory entries to be listed.
blank or (No Device)
Archive Files that are not saved to a backup device.
Centera
Archive Files saved to Centera.
NetWorker
Archive Files saved to NetWorker.
Tivoli®
Archive Files saved to Tivoli.
DESC
Description for the Directory entries to be listed.
blank or (None)
Entries that do not have a description.
desc
1 to 40 character name or pattern of the description.
TABLENAME
Name(s) of table(s) referenced by the directory entries to be listed.
name
Name or pattern of the table. (required)
LITIGATIONHOLD
Litigation Hold status for Directory entries to be listed.
YES
Entries with Litigation Hold value of Yes on Centera..
NO
Entries with Litigation Hold value of No on Centera.
%
Entries with any value for Litigation Hold: Yes - value is Yes No - value is No Unavailable - attempt to connect to Centera failed or the Archive File entry is invalid (None) - Archive File is not stored on Centera and the archive criteria are combined with OR Centera Advanced Retention Management is not licensed - Centera is not licensed for Advanced Retention Management and archive criteria are combined with OR.
Separate multiple values using the delimiter specified in the Report Request or using the delimiter specified using the override.
DELETEHOLD
Delete Hold status for listed Directory entries of Archive Files residing on an Optim Server.
YES
Entries with Delete Hold value of Yes.
NO
Entries with Delete Hold value of No.
%
Entries with any value for Delete Hold: Yes - value is Yes; No - value is No; None - no setting for Delete Hold.
ARCHCRITSORT
Override that determines how Archive Directory Entries are listed in the Report.
criteria
The type of criteria that determines the order. Recognized criteria types are the same as that as the override: ARCHCRITVALUE.
ASCENDING
Arrange the criteria in ascending order.
DESCENDING
Arrange the criteria in descending order.
ARCHCRITCOMBINE
Override that determines how multiple criteria are combined for processing.
AND
An Archive Directory Entry must match all criteria.
OR
An Archive Directory Entry must match any criteria.

Restore Process

The Restore Process setting in the Restore Request determines whether archived data is restored using an Insert Process or a Load Process. Archived data is restored by matching the Archive File to the appropriate Insert or Load Request (from a list of requests referenced in the Restore Request) on the basis of the setting for Insert (or Load) Request Selection Mode. If desired, you can provide overrides for one or more settings in the Insert or Load Request selected at run time, using the following keywords.

General

DELARES
Override for Delete Subset Extract setting in the Restore Request used for processing.
Y
Delete Subset Extract Files at the successful conclusion of the Restore Process.
N
Retain Subset Extract Files.
CONONERR
Override for Continue Processing if Errors setting in the Restore Request used for processing.
Y
Continue the processing any unprocessed Archive File if an error occurs.
N
Stop the process on an error.
GLOCONN
Override for multiple table criteria connector.
AND
Data must match criteria for all tables.
OR
Data must match criteria for any table.
GLOSELCRIT
Override for all global selection criteria specifications for a table in a Restore Process. Criteria must conform to requirements described in SQL Grammar for Search and Restore, with global criteria overrides for each table and column in a separate statement.
[ [ dbalias. ] cid. ]tablename
One, two, or three-part table name. If tablename is not fully qualified, the default qualifier is used.
columnname
Name of column to which criteria applies.
operator
Logical operator.
value
Value or list of values appropriate for the operator, expressed as literals or substitution variables (:variablename)
GLOCOLCONN
Override for connector for all global selection criteria applied to a table.
[ [ dbalias. ] cid. ]tablename
One, two, or three-part table name. If tablename is not fully qualified, the default qualifier is used.
AND
Restore data that meets criteria for all columns in the table.
OR
Restore data that meets criteria for any columns in the table.
GLOSQLTEXT
Override for global SQL WHERE clause specifications for a table in a Restore Process. The WHERE clause must conform to requirements described in SQL Grammar for Search and Restore, with overrides for each table in a separate statement.
[ [ dbalias. ] cid. ]tablename
One, two, or three-part table name. If tablename is not fully qualified, the default qualifier is used.
sqlwhereclause
The SQL WHERE clause.
AUTOGENSUBXF
Override for Automatically Generate Subset Extract Files setting in the Restore Request used for processing.
Y
Generate a name in the form PSTnnn.xf for each Subset Extract File as needed.
N
Use the name provided in the Restore Request used for processing or with the override keyword SUBXFFILE.

Archive File

[AFn]
Override for Archive Files referenced in the Restore Request. You must use the AFFILE, AFID, or GUID keywords to identify the Archive File to be processed.
n
Sequential identifier, beginning with 1, for Archive File and any accompanying Insert or Load overrides that follow.
SERVER
The Server, if any, for the Archive File designated by the accompanying AFFILE override. If used, the SERVER override must be on the first line following the [AFn] keyword. If not, an error condition results.
servername
Name of the Server on which the Archive File resides.
(local)
The Archive File resides on the local Server. (Default)
AFFILE
The Archive File to be restored. The AFFILE override must be on the first line following the [AFn] or, if applicable, the SERVER keyword. If not, an error condition results.
arcfilename.af
The name of the Archive File. Provide the full path if the file is not in the default Archive File Directory.
AFID
The identifier for the Archive File to be restored. The AFID override must be on the first line following the [AFn] keyword. If not, an error condition results.
n
An integer that identifies the Archive File.
GUID
The Globally Unique Identifier (GUID) for an Archive File to be restored. The GUID override must be on the first line following the [AFn] keyword. If not, an error condition results.
string
A 38-character string that identifies the Archive File.
Note: At the time an Archive File is created, you can use a built-in variable with an Archive Action to obtain and record the Archive File identifier or the GUID. The recorded identifier is then available to an external application that builds a command line parameter file for restoring data. Refer to the Common Elements Manual for additional information about using built-in variables with Archive Actions.
STARTTAB
Override for the Start Table specification in the Access Definition used to create the Archive File.
[ [ dbalias. ] cid. ]tablename
One, two, or three-part Start Table name. If tablename is not fully qualified, the default qualifier is used.
ROWLIM
Maximum number of rows in the Archive File to process.
n
0 (to use the maximum limit) or a number from 1 to 99,999,999. Processing is terminated when this limit is reached
REF
Override for reference table designation in Archive File.
[ [ dbalias. ] cid. ]tablename
One, two, or three-part name of any table other than the Start Table. If tablename is not fully qualified, the default qualifier applies.
Y
Process table as a Reference Table.
N
Do not process the table as a Reference Table.
GLOSELSQL
Application of global criteria, defined in the Restore Request or with the GLOSELCRIT or GLOSQLTEXT keywords, to Archive File.
Y
Apply global selection criteria to Archive File.
N
Do not apply global selection criteria to Archive File.
LOCSELCRIT
Local selection criteria for a table in a Restore Process. Criteria must conform to requirements described in SQL Grammar for Search and Restore, with local criteria overrides for each table and column in a separate statement.
[ [ dbalias. ] cid. ]tablename
One, two, or three-part table name. If tablename is not fully qualified, the default qualifier is used.
columnname
Name of column to which criteria applies.
operator
Logical operator.
value
Value or list of values appropriate for the operator, expressed as literals or substitution variables (:variablename)
LOCCOLCONN
Override for connector for all local selection criteria applied to a table.
[ [ dbalias. ] cid. ]tablename
One, two, or three-part table name. If tablename is not fully qualified, the default qualifier is used.
AND
Restore data that meets criteria for all columns in the table.
OR
Restore data that meets criteria for any columns in the table.
LOCSQLTEXT
Local SQL WHERE clause specifications for a table in the Archive File. The WHERE clause must conform to requirements described in SQL Grammar for Search and Restore, with overrides for each table in a separate statement.
[ [ dbalias. ] cid. ]tablename
One, two, or three-part table name. If tablename is not fully qualified, the default qualifier is used.
sqlwhereclause
The SQL WHERE clause.
SUBXFFILE
The Subset Extract File generated if global or local selection criteria are applied to the Archive File to be restored. This keyword is an alternative to generating the name automatically on the basis of a setting in the Restore Request or an override for it.
extfilename.xf
The name of the Extract File. Provide the full path if the file is not in the default Directory. The name is ignored if not needed.
VAR
Value for substitution variable used to process the Archive File.
variablename
Name of the substitution variable.
value
The corresponding value for the variable.

Insert or Load

CFFILE
Override for the Control File name in the Insert or Load Request.
confilename.cf
The name of the Control File. Provide the full path if the file is not in the default Data Directory.
TMNAME
Override for the local or named Table Map referenced in the Insert or Load Request selected at run time.
identifier.name
2-part name of an existing Table Map.
COLMAPID
Override for default identifier for Column Maps referenced in the Table Map.
identifier
One to eight character identifier.
COLMAP
Override for Column Map designation for a destination table referenced in the Table Map.
[ [ dbalias. ] cid. ]tablename
One, two, or three-part table name. If tablename is not fully qualified, the default qualifier is used.
[ identifier. ] name
One or two-part Column Map name. If name is not fully qualified, the Column Map ID is used.
DESTQUAL
Override for Qualifier in the Table Map.
dbalias. [ cid]
One or two-part default qualifier for destination tables referenced in Table Map.
DESTTABNAME
Override for source to destination mapping in the Table Map.
[ [ dbalias. ] cid. ]
srctablename
One, two, or three-part name of a table in the Source File. If srctablename is not fully qualified, the default Qualifier applies.
[ [ dbalias. ] cid. ]
desttablename
One, two, or three-part destination table name. If desttablename is not fully qualified, the default Qualifier applies.

Insert

When the Restore Process mode is Insert, the following overrides pertain to the Insert Request that is matched with the Archive File.

COMMFREQ
Override for Commit Frequency setting.
n
Specify any number between 1 and the maximum set in Product Options.
PROCTYPE
Override for Process Option.
INS
Insert data.
UPDINS
Update and insert data.
UPDATE/INSERT
Update and insert data.
UPDATE ONLY
Update data only; do not insert.
LOCKTABS
Override for Lock Tables setting.
Y
Lock tables during insert processing.
N
Do not lock tables.
DISROWLIM
Override for Discard Row Limit setting in the Insert Request.
n
0 (to impose no limit) or a number from 1 to 99999999 to stop processing after the specified number of rows are discarded and all rows in the array processed. You can Restart or Retry a process that stops because the limit is reached.

Load

When the Restore Process mode is Load, the following overrides pertain to the Load Request that is matched with the Archive File.

MODE
Loader processing mode for the database.
dbalias
The DB Alias for the database.
INSERT
Insert rows into empty destination tables.
REPLACE
Delete all rows from destination before loading.
APPEND
Load rows into destination, discarding duplicate rows or inserting them into exception tables. (Oracle only.)
TRUNCATE
Delete all rows from destination before loading. (RI constraints must be disabled. Oracle only.)
PERFLOAD
Override for Perform Load setting in Load Request.
dbalias
The DB Alias for the database.
Y
Run the loader immediately after file conversion.
N
Do not run the loader.
DELONSUCCESS
Override for delete files option when the Load Process completes successfully.
dbalias
The DB Alias for the database.
Y
Delete files for the database referenced by dbalias.
N
Do not delete files.
DELONFAILURE
Override for delete files option when the Load Process fails.
dbalias
The DB Alias for the database.
Y
Delete files for the database referenced by dbalias.
N
Do not delete files.
WORKPATH
Override for temporary loader files directory path.
dbalias
The DB Alias for the database.
path
Path to location for files. Dive must be accessible to DBMS server and client, workstation and network server.
SERVPATH
Override for temporary loader files Server path. (DB2® only.)
dbalias
The DB Alias for the database.
path
Path to location for files. Drive must be accessible to DBMS server and client, workstation and network server.
END
End of overrides in parameter file.