Command Line Export

You can use the Command Line to export object definitions. This command line processing is available in the Windows, UNIX, and Linux® environments.

Guidelines

The following guidelines apply:

EXPORT must be prefixed by a forward slash (/) or dash (-). Other keywords may be prefixed by a forward slash (/) or a dash (-) but a prefix is not required. For example, PST, /PST, and -PST are equally valid as keywords.
Keywords may be entered in mixed case and in any order, but must be separated by one or more spaces. Do not use commas.
Keywords must be separated from arguments by an equal sign (=) or a colon (:).
An argument that includes spaces must be enclosed in single or double quotes.
An argument that includes a macro must be enclosed in double quotes.
Comments must begin on a separate line and start with two forward slashes (//).
You can include all keywords and arguments for an EXPORT task in a text file, and reference this parameter file on the command line.

Syntax Conventions

The syntax conventions used to describe the command line export are:

KEYword: Uppercase letters indicate the minimum abbreviation for a keyword, while lowercase letters indicate the optional portion. In practice, a command line keyword can be specified in UPPER, lower or MiXed case.
text: Variable text is shown in lowercase italics.
( ): Statement delimiter to group a series of qualifiers for a parameter.
[ ]: Indicates an optional parameter.
{ }: Indicates a choice of two or more settings from which one (and only one) must be selected.
|: Separates options.

Export Syntax and Keywords

Use the following command line syntax to export Optim Directory object definitions.

Note: If viewing this document in Portable Document Format (PDF), you can select a keyword in the following syntax to navigate to the explanatory text. Use Go To Previous View to return to the syntax on this page.


PR0CMND /EXPORT { @parameterfilename | 
   [ { PSTdirectory= | DIRectory=} pstdirectory ]  
   [ Output=rptfilename[ + | – ]
   [ SUBordinates[ + | – ] ] [ CONTinueonerror[ + | – ] ]
   TYpe=objtype
   NAme=obj.name 
   File=expfilename[ + | - ]}

PR0CMND

Type PR0CMND to initiate command line processing. Note that the character following PR is the number 0 (zero).

/EXPORT

Command to run the Export Process. Specify /EXPORT or –EXPORT.

@parameterfilename

The name of an optional parameter file containing all remaining parameters, as follows. All keywords and arguments in the parameter file must be on a single line.

PSTdirectory= | DIRectory=

The Optim Directory from which objects are exported. The current Optim Directory is the default.

pstdirectory: Name of the Optim Directory for the request.

Output=

The Export Process report.

rptfilename

Name of the file for the process report. Provide the full directory path to save the file in a directory other than the default Data Directory (specified in Personal Options). You may append one of the following to the file name.

+: Option to append the report to an existing file.
–: Option to overwrite an existing file (default).

SUBordinates

Option to export definitions of objects subordinate to objects indicated by TYPE and NAME.

+: Export subordinate objects. See Export subordinate definitions for a list of subordinate objects.
–: Do not export subordinate objects (default).

CONTinueonerror

Option for continued processing upon an error condition.

+: Continue processing upon an error condition.
-: Stop processing upon an error condition (default).

TYpe=

Type of object(s). Export all object definitions of the indicated TYPE that match the NAME parameter.

All: All object types.
ACcessdefinition | AD: Access Definitions.
AFC | COLLection: Archive File Collections
ARCHive: Archive Request Definitions.
CALendar: Calendar Definitions.
COLMAP | CM: Column Map Definitions.
COLMAPProc | CMProc: Column Map Procedure Definitions.
COMPare: Compare Request Definitions.
CONvert: Convert Request Definitions.
CURrency: Currency Definitions.
DBAlias: DB Alias Definitions.
DELete: Delete Request Definitions.
EDit: Edit Request Definitions.
EXtract: Extract Request Definitions.
LOad | LD: Load Request Definitions.
PRImarykey | PRIMKEY | PK: Optim Primary Key Definitions.
RELationship | RL: Optim Relationship Definitions.
STOrageprofile | SP: Storage Profile Definitions.
TABlemap | TM: Table Map Definitions.
UPin | UPdate |INserT: Insert Request Definitions.
REPort | REPT | RPT: Report Request Definitions.
REStore: Restore Request Definitions.

NAme=

Name(s) of object(s) to export.

obj.name: Object name. Provide the full name or a pattern, using wild cards. When using a pattern, the naming convention must match that of the objects you wish to export.
For example, specify TYPE=ALL NAME=PSTDEMO.% to export all Access Definitions, Table Maps, Column Maps, Column Map Procedures, Table Maps, and Process Request definitions with names qualified by PSTDEMO. DB Aliases, Primary Keys, Relationships, etc. must be exported in separate processes, using NAME criteria appropriate to the naming conventions for these objects.

File=

Name of file for exported objects.

expfilename

Name of new or existing file. Provide full path if file is not in the default Data Directory specified in Personal Options.

If you provide the name of an existing file, you can append one of the following to the file name:

+: Append definitions to the file.
-: Overwrite any data in the file (default).