Split process

An archive file may need to be divided into separate files. For example, if an archive file contains data for a calendar year, you may choose to create separate archive files for each month. You can use the command-line Archive Split process to divide the file. Specify the criteria that you want to use to generate the new archive file. The original archive file remains intact and unchanged. Optim automatically generates a file for the data that does not meet the criteria.

Command file syntax for the Archive Split process is:

[//comment ]
[OPTIMDIR optimdirectory]
AF {arcservername | (local)} arcfilename
SPLITAF filename [ SPLITAFX filename]
DELTAAF filename [ DELTAAFX filename]
AD adname | { [ SQL dbalias.cid.tblname sql] [VAR variablename value] [ PNS pnsfile] }
{REGISTER {split | delta}{ (optimdirectory | * ) [GROUP groupidentifier][ DESC description]| NO}
             | DELETE }
[COLLECTIONS {split | delta} collection1,...,collectionn]
RUN ARCHIVESPLIT

//: At the beginning of a line, indicates that the text following the slashes is a comment. Enter comment text on one line, anywhere in the command file.
OPTIMDIR: Optim™ Directory for the archive files created by this process. The default is the Optim Directory where the source archive file resides.

AF

Name of the archive file that is the source for this process. This parameter is required. Specify:

arcservername: Name of the server for the source archive file.

(local): Specify (local) if the source archive file is not associated with a server.

arcfilename: Name of the source archive file. The archive file must be registered in the Optim Directory specified in the OPTIMDIR parameter.

SPLITAF

Name of the archive file to be created based on the split criteria. This parameter is required. The name you specify must not be an existing file name on the server.

SPLITAFX: Name of the archive index file this process creates. This parameter is optional. An archive index is created if the Access Definition being used defines indexes.

DELTAAF

Name of the archive file to be created for the data that did not meet the split criteria. This parameter is required. The name you specify must not be an existing file name on the server.

DELTAAFX: Name of the archive index file to be created for the DELTAAF. If the Access Definition used to create the original archive file defined indexes, the split process creates an index file.

AD

Name of an existing Access Definition in the Optim Directory. Selection criteria in this Access Definition is used by this process to create the new file. This parameter is optional. Specify:

adname: Name of an existing Access Definition. The criteria in this Access Definition is used to create the SPLITAF.

Note:

If you use the AD parameter, you cannot use SQL, VAR, or PNS.
This command process block must include the AD parameter or SQL, VAR, or PNS.

SQL

SQL that results in a valid WHERE clause to be executed against the Access Definition start table. This SQL is used instead of any SQL that exists in the Access Definition that was used to create the source AF. Specify:

dbalias.cid.tblname: DB alias, creator ID and table name that is the target of the WHERE clause.

VAR: Provide one or more values for substitution variables used in the SQL WHICH clause. The variables must exist in the Access Definition.

PNS: Name of a point-and-shoot file. Provide the name of a file local to the Optim server, that contains one or more start table key values. You can use this parameter as the only criteria for the expire process or in addition to SQL and VAR.

REGISTER

Option for registering the SPLITAF or DELTAAF. This parameter is required. Specify:

{split|delta}: Use split to register the SPLITAF or delta to register the DELTAAF.
Note: You cannot register the delta file and delete the delta file in the same process.

{optimdir| *}: Specify the name of the directory in which to register the file, or * to register the file in the same directory as the source AF.

GROUP: 1 to eight-character name of the group for the file.

DESC: Description to associate with the file registry entry.

NO: Do not register the file in a directory.

DELETE: Delete the DELTAAF after the process completes.
Note: You cannot register the delta file and delete the delta file in the same process.

COLLECTIONS: Specify this parameter to add the SPLITAF or DELTAAF to one or more collections. Collections must exist in the Optim Directory specified in the REGISTER parameter. COLLECTIONS parameter is valid only if the SPLITAF or DELTAAF is registered.