ARCRET Syntax

Specifies the INI file to use. If you omit this option, the utility uses the FSIUSER.INI file as the default.

Defines the sequential row or record number to begin processing. The default is one.

Tells the utility to stop after retrieving this number of sequential rows or records. The default is to retrieve all rows.

Sets the number of records to include in a set or batch. The default is one transaction per set.

Tells the utility to pause between sets.The default is off.

Selects rows/records with a RUNDATE before this date (YYYYMMDD). The date you specify is not included in the set.

Selects rows/records with a RUNDATE after this date (YYYYMMDD). The date you specify is not included in the set.

Changes the date comparison to mean before or after as opposed to the default before and after.

Specifies a script file the utility should run to determine if a row/record is included in a set.

Tells the utility not to compile the DAL script. DAL scripts are compiled by default to improve performance.

Dumps debug information as the script runs. When you include this parameter, use a small set (/S) size.

Keeps all intermediate files by renaming them instead of deleting them. Using this option can leave numerous files that you will have to remove manually.

Tells the utility to process the archives in reverse order. The last record is read first and the first record is read last. This only applies to xBase databases.

This parameter lets you filter archive records by examining the fields in the loaded form set using a DAL script. You can update the ARCRET record members passed to DAL as the script executes.

The /LOAD parameter names a script the system will execute after the form set is retrieved from archive and loaded. DAL had the ability to query form set field values as well as other form set members. Any changes the script makes to the loaded document are temporary, as the actual archived document cannot be changed. However, the script can change ARCRET member values, which represent the archive index record used to identify the document.

By allowing DAL to update the ARCRET record members, the script can change the current record values that will be written to the output files generated by ARCRET. This may later influence any plug-in functions called via ARCRET.

Lets the user to specify a field to use instead of RUNDATE. The format of the field you designate should be YYYYMMDD.

Identifies the date format used within the RUNDATE field. If you omit this parameter, the utility assumes the RUNDATE field is stored in the typical YYYYMMDD format.

The DATEFMT must be specified using a standard internal FAP date format. Additionally you can use the format X to indicate that the RUNDATE field is stored using the Hex Time format.

If a PPS user has an archive that doesn’t specify a RUNDATE field but instead uses the WIP CreateTime as the date field, it is usually stored in a Hex Time format. To do a retrieval from this archive, you would specify a command line with these parameters:

ARCRET /RUNDATE=CreateTime /DATEFMT=X

The /RUNDATE parameter is an existing parameter that identifies an alternative field to use as the RUNDATE. The /DATEFMT parameter indicates how to interpret the date information in the specified RUNDATE field.