Directory Configuration

This topic describes the directory configuration command-line syntax and keywords.

Syntax

Use the following command-line syntax.

General

PR0CNFG [ /NOLOGO ] /FILE={ filename | 
   /AUTORUN={ TRUE | FALSE | ON | OFF | YES | NO }  
      /GRANTAUTHID={ userid | PUBLIC }
      [/RESPONDFILE=filename ]
   [ /IGNORE ] 

Optim Directory

   /PSTDIRNAME={ pstdirname | currentdir } 
   /PSTDIRID=pstdirid  
   /PSTDIRCONNECTSTR=dbmscnctionstr  
   /PSTDIRPASSWORD=password  
   /PSTDIRUSERID=userid 

DB Alias

   /DBAACTION={ CreateNew | UseExisting }
   /DBANAME=dbaliasname  
   /CONNECTSTR=dbmscnctionstr  
   /PASSWORD=password  
   /PASSWORDREQUIRED={ TRUE | FALSE | ON | OFF | YES | NO }
   /USERID=userid 
   /ACCOUNTID=[Teradataaccountid] 
   /DBMSTYPE={ MVSDB2 | INFORMIX | ORACLE | SYBASE | SQLSERVER |
                           TERADATA | UDB | NETEZZA | POSTGRESQL | HIVE }
   /DBMSVERSION={ versionnum | NA }
   /DBQUALIFIER=databasequal
   /SPSHARE={ TRUE | FALSE | ON | OFF | YES | NO }
   /DESCRIPTION=description/UNICODEDB={ TRUE | FALSE | ON | OFF }
   /MULTIBYTEDB={ TRUE | FALSE | ON | OFF }

Optim Directory or DB Alias

   { /SPACTION | /BINDACTION }={ CreateNew | UseExisting }
   { /SPQUALIFIER | /COLLECTIONNAME }=name  

Task

   TASK={ DB | MAINTPST | MAINTCAT } } 

Keywords

You can specify the following keywords in the syntax.

General

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

/NOLOGO
Suppress the splash logo.

/FILE=
The source of parameters or the parameters.
filename
The fully qualified path and name of a text file that contains parameters for one or more tasks. If the file name includes blanks, you must the file name in quotation marks.
parameters
As follows.

/AUTORUN=
Level of user intervention when the program is running.
TRUE, ON, or YES
Run the Configuration program in AUTORUN mode, hiding dialogs unless user intervention is required to correct or cancel the task. If an error cannot be corrected, the error message is displayed on the Log dialog. This setting is the default for a parameter file.
FALSE, OFF, or NO
Run the Configuration program normally, displaying all dialogs. This setting is the default for parameters from the command line.

/GRANTAUTHID=
Identifier for authorized users. Specify a user ID or group name, or specify PUBLIC if all users can run the Optim solution.

/RESPONDFILE=
The source of default values for Message IDs when AUTORUN=ON.
filename
The fully qualified path and name of a text file. A sample file, RESPOND.PST, in the RT/BIN directory can be modified and used as necessary. You must enclose a file name that includes blanks in quotation marks.

/IGNORE
Begin a comment or disregard parameters. All parameters that follow and are on the same line have no effect on processing.

Optim Directory

/PSTDIRNAME=
Optim Directory for the task.
pstdirname
Name of the Optim Directory.
currentdir
The current Optim Directory (default).

/PSTDIRID=
Identifier that prefixes Optim Directory table names.
pstdirid
Schema Name, Creator ID, or Owner ID for the Optim Directory tables.

/PSTDIRCONNECTSTR=
Connection to the Optim Directory.
dbmscnctstr
Name that is used to access the database that contains the Optim Directory.

/PSTDIRPASSWORD=
Password for connection.
password
A value is required if the Always Prompt for Password option is active for the Optim Directory.

/PSTDIRUSERID=
User account with DBMS permission to connect.
userid
If /TASK=MAINTPST, the user account must have the authority, through System Privileges or Roles, to create the tables and to catalog the packages, plans, or procedures under the appropriate table identifier.

DB Alias

/DBAACTION=
Processing indicator for the DB Alias.
CreateNew
Create a DB Alias that is named by DBANAME.
UseExisting
Use the existing DB Alias indicated by DBANAME.

/DBANAME=
Name of DB Alias.
dbaliasname
Required if /TASK=DB or /TASK=MAINTCAT.

/CONNECTSTR=
Connection string for the database that is associated with the DB Alias.
dbmscnctstr
Required if /TASK=DB or /TASK=MAINTCAT.

/PASSWORD=
Password for connection.
password
Required if the Always Prompt for Password option is active for the DB Alias or if you are creating a DB Alias by using /TASK=DB.

/PASSWORDREQUIRED=
Always Require Password option for a new DB Alias (/TASK=DB). Keyword is ignored for an existing DB Alias.
TRUE, ON, or YES
Always require a password.
FALSE, OFF, or NO
Save the password in the registry.

/USERID=
User account with DBMS permission to connect to database associated with the DB Alias. Required if the Always Prompt for Password option is active for the DB Alias or if you are creating a DB Alias by using /TASK=DB.
userid
If /TASK=DB and you are creating a new DB Alias or if /TASK=MAINTCAT, the user account must have the authority, through System Privileges or Roles, to create the tables and to catalog the packages, plans, or procedures under the appropriate table identifier.

/ACCOUNTID=
If the specified /USERID is for a Teradata database user, you can optionally specify the Teradata Account ID associated with that /USERID.

/DBMSTYPE=
The DBMS associated with the DB Alias. Required if /TASK=DB.
DBMS type Used for
HIVE Hive (for Hadoop)
INFORMIX Informix®
MVSDB2 DB2® for z/OS®
NETEZZA Netezza®
ORACLE Oracle
POSTGRESQL PostgreSQL
SQLSERVER SQL Server
SYBASE Sybase
TERADATA Teradata
UDB DB2 for Linux, UNIX, and Windows

/DBMSVERSION=
The version of the DBMS associated with the DB Alias. Required if /TASK=DB, except in the case of PostgreSQL and Hive. When required, the /DBMSVERSION must be specified after the /DBMSTYPE.
versionnum
Specify the version number for the DBMS associated with the DB Alias, unless the /DBMSTYPE is PostgreSQL or Hive.
NA
If the /DBMSTYPE is PostgreSQL or Hive, you can omit the /DBMSVERSION, or you can specify /DBMSVERSION=NA for not applicable.

/DBQUALIFIER=
Database name.
databasequal
Required if /TASK=DB and DBMS is Sybase ASE, SQL Server, or Informix.

/SPSHARE=
Indicator for sharing Stored Procedures for multiple Sybase ASE or SQL Server DB Aliases when /TASK=DB.
TRUE, ON, or YES
Stored procedures are shared. For Sybase, the special Sybase ASE database sybsysprocs is used to store stored procedures. For SQL Server, stored procedures are stored in the MASTER database. Microsoft SQL Server documentation contains a cautionary statement about creating stored procedures in the MASTER database. Consider the implications of sharing stored procedures for SQL Server before proceeding.
FALSE, OFF, or NO
Stored procedures are not shared.

/DESCRIPTION=
Optional description for DB Alias when /TASK=DB.
description
1 - 40 characters, delimited by double quotation marks.

/UNICODEDB=
Store Optim Directory data in Unicode format.
TRUE or ON
Store data in Unicode format.
FALSE or OFF
Do not store data in Unicode format.

/MULTIBYTEDB=
Use multibyte encoding for the DB Alias.
TRUE or ON
Use multibyte encoding.
FALSE or OFF
Do not use multibyte encoding.

Optim Directory or DB Alias

The following keywords are interchangeable, and are not DBMS-dependent.

{ /SPACTION | /BINDACTION }=
Indicator for Optim Stored Procedures or Optim Bind Files.
CreateNew
Create new Stored Procedures or Bind Files.
UseExisting
Use previously loaded Stored Procedures or Bind Files.

{ /SPQUALIFIER | /COLLECTIONNAME }=
name
Schema Name or Owner ID of the Stored Procedures, or Plan Name of the Bind Files.

Task

The TASK keyword identifies the task to be done. If a task is entered on the command line, you must provide the parameters on the same line. When you are using a parameter file, the TASK keyword signals the end of a list of parameters for a task. Keywords on the lines that follow a TASK keyword are processed in the next task, if any, or are ignored if no new TASK keyword is found.

TASK=
The task identifier, as follows:
DB
Create or update a single DB Alias.
MAINTPST
Apply maintenance to a single Optim Directory.
MAINTCAT
Apply maintenance to a single DB Alias.


Feedback