Parameter Name

Description

Value

Default

Unique to ArchiveManager

–user_name <user name>

Clarify database username. This required parameter must be entered on the command line or stored in the clarify.env file. For more information, see the Entering User and Database Information section.

String

No

–password <password>

Clarify database password. This required parameter must be entered on the command line or stored in the clarify.env file.

For more information, see the Entering User and Database Information section.

String

No

–db_name <database name>

For SQL Server and Sybase databases, this is the name of the Clarify database.

For Oracle databases, this is the net service name as defined in the tnsnames.ora file.

This required parameter must be entered on the command line or stored in the clarify.env file.

For more information, see the Entering User and Database Information section.

String

No

–db_server <database server>

Name of the machine that the database resides on. This parameter is required for SQL Server and Sybase, but ignored on Oracle databases. If required, the server name must be entered on the command line or stored in the clarify.env file. For more information, see the Entering User and Database Information section.

String

No

–date_format <date format>

Supplies a date format to ArchiveManager.

String

%m/%d/%Y %H:%M:%S

Yes

–date_quiet

Turns off warnings that result from date conversion issues.

Boolean

No

Yes

–errors_max

Sets the maximum number of errors allowed before terminating the program. If it is set to zero, no termination will occur.

Integer

100

Yes

–help

Lists the command line parameters. When run, the program is not executed.

Boolean

No

Yes

–license <license key>

ArchiveManager license key. This key is stored in the database and only needs to be supplied the first time ArchiveManager is run. Upon the initial creation of a database, place the key in the file 'c:\TEMP\diet_license' for NT systems, or '/tmp/diet_license' for UNIX systems.

String

Read from DB

Yes

–log_file <filename>

Names a file to write general output notices to, instead of writing them as standard errors on screen. If the filename is 'mes_file', the message file is used for the log_file. If no filename is specified after –log_file, a date stamped file will be created.

String

Standard errors

Yes

–mes_file <filename>

Names a file to write errors and warnings to, instead of writing them as standard errors on screen. If the file name is 'log_file', the log file is used for the message file. If no filename is specified after –mes_file, a date stamped file will be created.

String

Standard errors

Yes

–notices_off

Progress notices will not be reported.

Boolean

No

Yes

–sqllog

<filename>

Prints the SQL commands generated by ArchiveManager into a file of your designation.

String

No log

No

–syntax_off

Minor syntax errors will not be reported.

Boolean

No

Yes

–timer

Turns on the internal code timers that report the timing of various ArchiveManager operations. When database timing is slow, this parameter can be used to help tune ArchiveManager runs.

Boolean

No

Yes

–warnings_off

Warning messages will not be reported.

Boolean

No

Yes

See Also

Command Syntax

Import Command Syntax

Export Command Syntax

Purge/Archive Command Syntax

Generate Command Syntax

Next

Import Command Syntax