Directory Maintenance

This section describes the directory maintenance command line syntax and keywords.

Syntax

Use the following command line syntax.

General

PR0CMND /DIRMAINT
	@[" ]command file name [" ] 
	[OUTPUT=report file name [+]]  

Process Blocks

Process blocks exist within the input file. Each process block might contain the following set of required and optional key value pairs. Each process block terminates with an action.

[OPTIMDIR 			optimdirectory ]
TYPE				type1 (name1 [ , name2, …])
[TYPE				type2 (name1 [ , name2, …])]
[PASSWORD			password]
[SECURITYFILE			<filename with full path>]
[CREATEBACKUP 			YES/NO]
[BACKUPFILE			<filename with full path>]
RUN 				REMOVE

In order to support bulk operations, the TYPE parameter must allow enough flexibility to perform mass operations by using the percent (%) symbol.

Keywords

This section defines the keywords that are specified in the syntax.

General

PR0CMND
Initiate command-line processing.
Note: The character that follows PR is the number 0 (zero).

/DIRMAINT OR /DM
Command to perform directory maintenance.

@
File containing commands (required).

OUTPUT
File for the process report (optional).

Process Blocks

OPTIMDIR
Name of the Optim directory from which the object is to be removed (optional). If not specified, the default Optim directory is selected.

TYPE
The object type, which includes predefined keywords for definitions and requests (required). This keyword supports a comma-separated list of object types. It also supports multiple instances of TYPE in the same process block, provided that each instance is on a new line.
Definition Types
AD - Access definition
AFC - Archive file collection
CALENDAR - Calendar
CM - Column map
CMPROC - Column map procedure
CURRENCY - Currency
REL - Optim relationship
PK - Optim primary key
STORPROF - Storage profile
TM - Table map
FAD - File access definition
ACD - Access control domain
Request Types
ARCH - Archive request
COMP - Compare request
CONV - Convert request
DEL - Delete request
ED - Edit request
EXTR - Extract request
UPIN - Insert request
LOAD - Load request
REPT - Report request
REST - Restore request

PASSWORD
The Password is required if the object to be deleted is a security object; for example, FAD or ACD. It supports the use of system variables with the following syntax OR direct text input: PASSWORD VAR(SYS_VARIABLE)

SECURITYFILE
A fully qualified file name into which the security details for the object to be removed is backed up. This file is secured by a password provided by the user (optional). If a file name is not provided, Optim generates a file name in the following format.
SECURITYFILE file format: { “OPTIM_Security_Object_Export"_<action_type>_<timestamp of execution>_<seq# of process block in batch> }
For example: OPTIM_Security_Object_Export_REMOVE_12182012_185242_1.TXT

CREATEBACKUP
A boolean that can have the values YES or NO. Use this keyword to let Optim know if it needs to back up the objects it removes.

BACKUPFILE
A fully qualified file name into which the export for the object to be removed is backed up (optional). If a file name is not provided, Optim generates a file name in the following format.
BACKUPFILE file format: { “OPTIM_Export_Objects"_<action_type>_<timestamp of execution>_<seq# of process block in batch> }
For example: OPTIM_Export_Objects_REMOVE_12172012_173202_001.TXT

RUN REMOVE
The REMOVE action removes objects from the Optim directory. You must specify the object type to be removed, as well as the name or name pattern of objects to be removed. The following syntax describes the REMOVE command process block. Each keyword must appear on a separate line in the command process block.
[ OPTIMDIR optimdirectory ]
TYPE type(name1 [ , name2, …] )
RUN REMOVE


Feedback