Pstlocal Configuration File for the Command Line Utility

Unless a command line process is directed to a server, the process is executed locally and the settings in pstserv.cfg do not apply. Use the pstlocal configuration file to provide settings for these local processes. An example of pstlocal.cfg is in the /etc subdirectory to the PSTHOME directory.

Before using the command line utility, modify the following parameters to reflect your requirements, as applicable. In the following syntax, defaults are shown in bold text:

   [ customerid [ n | 000000 ] ]
   [ customername [ name | xxxxxxx ] ]
   [ license [ license key | 000000 ] ]
   tempdir directory
   datadir directory
   [ archivedir [ directory  | datadir ] ]
   [ archivediridx [ directory | archivedir ] ]
   [ archivebroidx [ directory | archivedir ] ]
   [ tracedays [ n | 5 ] ]
   [ server ( name address port userid { password | ? } domain ) ]
      pstdir ( name dbmstype dbmsver dbqual connectstring 
      { dbname | * userid { password | ? } } )
   dbalias ( pstdir name { connectstring | * [userid { password | ? }] })
   [ loader ( { ( pstdir dbalias ) | (*  dbmstype ) }
     pathtoloaderexcptntblcid ]]
   [ teraloader{ * | pstdir dbalias } dbmstype loader-program-full-path
      {(mload) | (fastload) | (bteq) | NULL } rowcntgle n]
   [ teradataconfig { * | pstdir dbalias } tdatasvr userid password  ]
   [ teratemptbloption { Never | When_Possible } ]
   [ teratempdb dbname ]
   [ teratptoption { Never | When_Possible } [ teratptsessmax n ] | [ teratptsessmin n ]
     | [ teratptsleep n ] | [ teratpttenacity n ]
   [ auditfacility { true | false}] [ Audit OptimDirName1 {enabled | disabled } ]
     [ retention-days n] [ Audit RecordLimit n]
     [ <FailureAction> { CONTINUE | STOP }]
   [ allowlocktbls [ 0 | 1 ] ]
   [ cmmaxshuffleretries [ n | 10 ] ]
   [ codepage [ codepgenum | db2default ] ]
   [ dbconnections  [ 0 | 1 n | 1 maximum ] ]
   [ formatnumerics [ 0 | 1 ] ]
   [ maxcommitfreq [ n | 200 ] ]
   [ maxextractrows [ n | 100000 ] ]
   [ onlyidxsearch [ 0 | 1 ] ]
   [ orausearraydelete [ 0 | 1 ] ]
   [ DMLOprByRowID { never | dynamic | always | user-defined }
   [ reviewdelafterarchive [ 0 | 1 ] ]
   [ reportdir [ directory | unixtempdir ] ]
   [ reportlevel [ 0 | n ] ]
   [ centeraallowaltret [ 0 | 1 ] ]
   [ centeraavail [ 0 | 1 ] ]
   [ centeraretention [ none | default | interval | infinite ] ]
   [ centeradays [ 0 | n ] ]
   [ centerayears [ 0 | n ] ]
   [ networkeravail [ 0 | 1 ] ]
   [ tivoliavail [ 0 | 1 [ userid {  password | ? } ] ] ]
   [ rmfixedsegsize [ 0 | n ] ]
   [ rmremsegsize [ 10 | n ] ]
   [ scriptmaxlines [ 500 | n ] ]
   [ scriptprefixout [ 0 | 1 ] ]
   [ scriptshowfullcol [ 0 |  1 4 4  |  1 ln rn ] ]
   [ scriptshowfulltbl [ 0 |  1 4 4  |  1 ln rn ] ]
   [ scriptwarnmissing [ 0 | 1 ] ]
   [ wormdeviceallowaltret { 0 | 1 } ]
   [ wormdeviceretention { none | interval | maximum } ]
   [ wormdevicedays [ 0 | n ]
   [ wormdeviceyears [ 0 | n ]
   [ sybaseunchain { active | inactive | defaultactive | defaultinactive } ]
   [ uncommittedread { active | inactive | defaultactive |
      defaultinactive } ]

Keywords

customerid
Company identifier.
n
Unique six-digit company ID provided with Optim™.
000000
The Optim demonstration ID. (Default)
customerid  000000
customername
Customer name.
name
Company name provided with company ID and license key. (Up to 40 characters)
xxxxxxx
The demonstration name. (Default)
customername  xxxxxxx
license
The license key.
Note: The license key is saved in the registry. This registry entry is replaced if you connect to an Optim directory with a more recent key. Therefore, you can remove this keyword after you start pr0svce the first time.
license key
The five-part license key provided by IBM®.
demonstration key
The demonstration key, shown in the following example. (Default)
license  000000-000000-000000-000000-000000
tempdir
Directory for temporary work and trace files.
directory
Name of the directory for temporary work and trace files. The directory must exist before starting the Optim daemon.
tempdir  ${PSTHOME}/temp
datadir
Directory for extract, compare, control, export, and other process files for which a complete path is not provided. The directory must exist before starting the Optim daemon.
directory
Name of the directory for extract, compare, control, export, and other process files.
datadir  ${PSTHOME}/data
archivedir
Directory for archive files for which the process request does not provide a complete path. Archive files are stored in the data directory (datadir) by default. The directory must exist before starting the Optim daemon.
archivedir  ${PSTHOME}/archive
archivediridx
Directory for archive index files for which a complete path is not provided. Index files are stored in the archive directory (archivedir), or the data directory (datadir), by default. The directory must exist before starting the Optim daemon.
archivediridx  ${PSTHOME}/archiveidx
archivebroidx
Directory for browse index files for which a complete path is not provided. To expedite the retrieval of data, an index file is created when you browse archived data and joins tables. By default, browse index files are stored in the archive directory (archivedir) or the data directory (datadir). The directory must exist before starting the Optim daemon.
archivebroidx  ${PSTHOME}/archivebro
tracedays
Number of days to retain trace files in the temporary work directory.
n
A value from 2 to 30. The default is 5. Consider storage space limitations when deciding the number of days to retain the files.
tracedays 5
server
Connection for command line processes that are not executed locally but, instead, are targeted to a server. You can omit this keyword if, for the targeted server, file access is limited to a specific Windows user account or the filelogon value is server or local.
name
Name of the server. The target server must support a tcp/ip connection.
address
The tcp/ip network address for the target server, in the form 1.1.1.1.
port
The numeric tcp/ip port number for the target server, as a value from 1 to 65534.
userid password
User ID and password needed to logon to a target server set up to receive file logons from “client” or for which the filelogon keyword in pstserv.cfg is set to client.

Specify “?” as the password when a secure password is supplied in a password file. (See Securing the Configuration Files for more information.) To use OS Authentication for Oracle, specify a forward slash (/) for userid and do not provide a password.

domain
Domain needed to validate User ID and password for access to a server on Windows.
Note: If the user is validated as a local user on a server, enter the server name.
server optuser 172.16.8.76 1024 rt password test.dom
pstdir
Connection information for an Optim directory. Use pstdir for each directory that can be accessed for processing initiated from the command line. The directory is created from a Windows machine by using the configuration program. The connection to the directory is not verified until required by a client.
name
Name of the Optim directory.
dbmstype
Database Management System as DB2®, Oracle, Sybase, or Informix®.
dbmsver
DBMS version in the form n.n.
dbqual
Creator ID, Schema Name, or Owner.
connectstring
Information defined to the DBMS client to connect to the database.
dbname
Name within connection. (Provide name if DBMS is Informix or Sybase ASE and pstlogon is client or specify ‘*' if pstlogon is server.)
userid password
User ID and password for DBMS logon. (Provide this information if pstlogon is server.)

Specify “?” as the password when a secure password is supplied in a password file. (See Securing the Configuration Files for more information.) To use OS Authentication for Oracle, specify a forward slash (/) for userid and do not specify a password.

pstdir ORA806 Oracle 8.0 OPTUSER DO806 * rt password
dbalias
DB alias information. Use dbalias for each DB alias that the server can access for command line processes. A DB alias is created from a Windows machine by using the configuration program. The DB alias information is not verified until a connection is required in a process.
pstdir
Name of the Optim directory that includes the DB alias. A pstdir entry for the referenced directory is required.
name
Name of the DB alias.
connectstring
Information needed by the DBMS to connect to the database (typically, the system name and port ID).

(Enter ‘*' if the database designated by the DB alias includes the Optim directory.)

userid password
User ID and password for DBMS logon. (Provide this information if dbaliaslogon is server.)

Specify “?” as the password when a secure password is supplied in a password file. (See Securing the Configuration Files for more information.) To use OS Authentication for Oracle, specify a forward slash (/) for userid and do not specify a password.

dbalias ORACLE806 ORACLE806 DO806 rt password
loader
The location of the DBMS loader for a command line process. You can specify a loader for a specific Optim directory and DB alias, or specify a default loader be used for any DB alias within a DBMS.
pstdir
The loader is for a specific DB alias. Enter the name of the Optim directory that includes the DB alias. The directory must be referenced in a pstdir entry. A pstdir entry requires a dbalias entry.
dbalias
The loader is for a specific DB alias. Enter the name of the DB alias. The DB alias must be referenced in a dbalias entry. A dbalias entry requires a pstdir entry.
*
The loader is the default for a DBMS. You must also provide a value for dbmstype.
dbmstype
DBMS type. Enter Oracle, Sybase, Informix, or Teradata.
pathtoloader
Path to the executable loader file.
excptntblcid
Default CID for creating an exception table.
teraloader
Use the teraloader parameter to specify a Teradata loader for an Optim directory and DB alias, or as the default loader for any DB alias or the specified DBMS type. For native access to Teradata (Optim 8.1 or later), use the teraloader parameter. For access using Federation Server (Optim 7.3.1 or later), use teraloader and teradataconfig parameters. Specify:
*
The Teradata loader is the default for the Optim directory and DB alias referenced in the loader parameter.
pstdir
Name of the Optim directory.
dbalias
DB alias for the directory.
dbmstype
DBMS type. Enter Teradata for native access or DB2 for Federation Server access.
loader-program-full-path { (mload) | (fastload) | (bteq) | NULL }
Full directory path to the loader executable for Teradata Multiload, FastLoad, or the Basic Teradata Query facility (BTEQ). This parameter requires a value in all three positions. NULL indicates no support.
path/loader/exec(mload)NULL NULL
path/loader/exec(mload)path/loader2/exec(fastload)NULL
path/loader/exec(mload)path/loader2/exec(fastload)path/loader3/exec(bteq)
rowcntgle n
Row count to determine whether Teradata FastLoad or MultiLoad is used. Allowable values are 0 - 999,999,999. Specify 0 or do not specify a value to use MultiLoad. Otherwise FastLoad is used if the row count of the load file is greater than the rowcntgle value you specify.
teradataconfig
Use this parameter to specify Teradata configuration parameters for Federation Server access.
*
The Teradata loader is the default for the Optim directory and DB alias referenced in the loader parameter.
pstdir
Name of the Optim directory.
dbalias
DB alias for the Optim directory.
tdatasvr
Name of the Teradata server.
userid
User ID for the Teradata server.
password
Password for the Teradata server.
For a particular Optim directory and DB alias:
teradataconfig pstdir dbalias tdatasvr userid password rowcntgle n 
For any DB alias:
teradataconfig * tdatasvr userid password rowcntgle n
teratemptbloption
Determines whether temporary tables are created during an extract or archive process to improve the performance of archives and extracts of related Teradata tables. If you enable this feature, the solution will create temporary tables in Teradata during an archive or extract process. The temporary tables are used to store key values to join with related tables. Select:
  • Neverto not allow the solution to create temporary tables during an extract or archive process.
  • When_Possible to allow the solution to create temporary tables when possible during an extract or archive process. This setting will improve performance during an extract or archive process.
teratempdb
If appropriate, type the name of the database in which you want temporary tables created. If a database name is not specified, the tables will be created in the same database as the reference tables. (The user must have CREATE TABLE, INSERT, and DROP TABLE privileges for the database to create temporary tables.)
teratptoption
Determines whether Teradata Parallel Transporter (TPT) is available for extract and archive requests. Specify:
  • Neverto never allow the use of TPT for extract and archive requests.
  • When_Possible to use TPT when possible for extract and archive requests, otherwise allow attachments to "step down" to CLIv2 (Call-Level Interface v2).
teratptsessmax n
Specify the maximum number of sessions to log on. Allowable values are 0 - 1000. The maximum value cannot be more than the number of AMPS available.
teratptsessmin n
Specify the minimum number of sessions required for a TPT job to continue. Allowable values are 0 - 1000. This entry must be greater than or equal to 1 and less than or equal to the maximum number of TPT sessions.
teratptsleep n
Specify the number of minutes the TPT should pause before attempting to log on when the maximum number of load and export operations are already running on the Teradata database. Allowable values are 0 - 1000.
teratpttenacity n
Specify the number of hours the TPT should attempt to log on if the maximum number of load and export operations are already running on the Teradata database. This entry must be greater than zero to enable the Tenacity feature. Specify zero to disable the Tenacity feature. Allowable values are 0 - 1000.
auditfacility
Enable or disable the audit facility for all Optim directories. This overrides any specification for individual directories.
true
Enable the Audit Facility.
false
Disable the Audit Facility. This is the default.
auditfacility true
Audit OptimDirName1
Enables or disables the Optim audit facility for the directory specified as OptimDirName1.
enabled
Enable auditing for this directory.
disabled
Disable auditing for this directory. This is the default.
retention-days
Number of days for audit records to be retained.
n
Value in the range 1 - 999,999,999,999. The default value is 2,555 days (seven years).
Audit RecordLimit
Sets the maximum for number of audit records maintained at any time.
n
Value in the range 100 - 999,999,999,999. The default value is 100,000.
<FailureAction>
Action to be performed when the Audit RecordLimit is exceeded.
continue
Optim continues to generate audit records. The oldest audit records are purged to keep the total number of audit records under the limit. This is the default.
stop
Optim does not generate audit records for processes.
allowlocktbls
Allow users to lock tables.
0
Do not allow users to lock tables.
1
Allow users to lock tables. (Default)
allowlocktbls 1
codepage
Code page for System 390 access.
codepgenum
Valid code page settings are 37, 273, 277, 278, 280, 284, 285, 297, 500, and 871.
db2default
The DB2 default setting. (Default)
codepage 871
cmmaxshuffleretries
Default number of times the Column Map Shuffle Function refetches a replacement value until a value that does not match the source row is found (a “retry”). The Shuffle Function retry parameter overrides this default.

Using a high retry value with columns that contain many duplicate values increases the processing time. For these columns, it might be best to use a retry value of zero.

n
Enter a value from 0 - 1000. Enter 0 to allow a replacement value to match the source. The default is 10.
cmmaxshuffleretries 10
dbconnections
Number of database connections for Archive, Delete, or Extract Processing. Multiple database connections allow processing of multiple rows concurrently to improve performance when processing large quantities of data. Valid entries are:
0
Use one database connection for processing. (Default)
1 n
Use the specified number (from 2 to 32) of database connections.
1 maximum
Use the maximum number of connections supported by the server.
dbconnections 1 maximum
formatnumerics
Format of numeric values displayed in process reports.
0
Do not format numbers in process reports (i.e., display as nnnnnn). (Default)
1
Format numbers in process reports (i.e., display as nnn,nnn).
formatnumerics 0
maxcommitfreq
System-wide commit frequency.
n
A number from 1 to 999,999.
200
Default setting.
maxcommitfreq 200
maxextractrows
Maximum number of rows to extract.
n
A number from 1 to 999,999,999.
100000
Default setting.
maxextractrows 100000
onlyidxsearch
Use of Archive Indexes in Search and Restore processes. Valid entries are:
0
Search Archive indexes first and native file system, if necessary.
1
Search Archive indexes only. (Default)
onlyidxsearch 1
orausearraydelete
Use the Oracle array delete feature with a Delete Process. When the feature is used, rows not found are listed as deleted in the Delete Process Report. Valid entries are:
0
Do not use Oracle array delete.
1
Use Oracle array delete. (Default)
orausearraydelete 1
DMLOprByRowID
For Oracle only. Allow users to extract the Oracle row ID for Extract or Archive Process.
Never
Do not allow users to extract the Oracle row ID. This is the default.
Dynamic
Allow Optim to evaluate the row to be extracted or archived. Optim extracts the row ID only if there is no unique index for the row.
Always
Optim extracts or archives the row ID for every row and every table.
User-defined
Optim uses the value specified for Extract RowID for each table in the Access Definition.
DMLOprByRowID never
reviewdelafterarchive

Allow users to list rows to be deleted after Archive Process.
0
Do not allow users to list rows to be deleted after Archive Process.
1
Allow users to list rows to be deleted after Archive Process. (Default)
reviewdelafterarchive 1
reportdir
Directory or location for saved reports.
directory
As you must use a Window workstation to view reports, specify a path accessible from such a workstation.
unixtempdir
The UNIX or Linux temporary directory. (Default)
reportdir /users/RTuser/DDRIVE/OUTDIR/REPORTS
reportlevel
Maximum number of reports to retain for each type of process (for example, Extract Processes, Archive Processes). Valid entry is 0 - 200. A value of 0 (default) disables the report retention feature.
0
Do not retain reports. (Default)
n
The number of reports retained for a particular process (up to 200) Once the number of retained reports equals this amount, the oldest report is deleted as the current report is saved.
reportlevel 0
centeraallowaltret
Indicator for minimum Centera retention settings.
0
Use the Centera default. Any Storage Profile or centeraretention settings for retention causes the process to fail.
1
Use centeraretention settings or overriding Storage Profile settings for minimum Centera retention. (Default) If centeraavail is 0, the Archive Process will fail.
centeraallowaltret 1
centeraavail
Indicator for the use of a Centera device.
0
Centera device is not used. (Default)
1
Centera device is available for use. This setting is required in order to copy an Archive File to a Centera device or process such a file.
centeraavail 0
centeraretention
Default minimum retention setting for Archive Files copied to Centera.
none
No minimum retention period. (Default)
default
The Centera default applies.
interval
Use any centeradays and centerayears settings or overriding Storage Profile settings for minimum Centera retention.
infinite
Retain the file on Centera forever; the file cannot be deleted.
centeraretention none
centeradays
The number of days to retain an Archive File copied to Centera. This value and the centerayears value determine the retention period when the centeraretention parameter or overriding Storage Profile setting indicates an interval for Centera File retention.
0
Default. The file can be deleted from Centera at any time.
n
Number of days (up to 18300) to retain the file.
centeradays 250
centerayears
The number of years to retain an Archive File copied to Centera. This value and the centeradays value determine the retention period when the centeraretention parameter or overriding Storage Profile setting indicates an interval for Centera File retention.
0
Default. The file can be deleted from Centera at any time.
n
Number of years (up to 100) to retain the file.
centerayears 10
networkeravail
Indicator for the use of a NetWorker system.
0
NetWorker is not used. (Default)
1
NetWorker is available for use. This setting is required in order to copy an Archive File to NetWorker or to process such a file.
networkeravail 0
tivoliavail
Indicator for the use of a Tivoli® device.
Note: To use a Tivoli device, you must install the Tivoli client and API support on the machine where the Optim server runs.
0
Tivoli is not used. (Default)
1
Tivoli is available for use. This setting is required in order to copy an Archive File to Tivoli or to process such a file.
userid password
Tivoli is available for use with the specified User ID and password. This setting is required in order to copy an Archive File to Tivoli or to process such a file.
Note: If this setting is used, pr0svce must be started under root authority. See Securing the Products.
tivoliavail 1
rmfixedsegsize
The default maximum segment size for Archive Files on fixed drive (in other words, a hard disk).
0
Fixed drive software determines default segment size. (Default)
n
Size in megabytes (up to 9999 MB).
rmfixedsegsize 0
rmremsegsize
The default maximum segment size (in megabytes) for Archive Files on a removable device (for example, floppy disk, zip drive).
10
Default
n
Size in megabytes (up to 9999 MB).
rmremsegsize 10
scriptmaxlines
Maximum number of lines in a Column Map Procedure that are included in the Process Report.
500
Include up to 500 lines. (Default)
n
Maximum number of lines to include (up to 9999 lines).
scriptmaxlines 500
scriptprefixout
Option for Column Map Procedure name in Process Report.
0
Do not include name.
1
Include Column Map Procedure name. (Default) If a Local Column Map Procedure is used in process, a name is generated in the form tablename.columename.n to be included in the report. Use scriptshowfullcol and scriptshowfulltbl to format the generated name.
scriptprefixout 1
scriptshowfullcol
Format for column name used to generate name for local Column Map Procedure.
0
Use full column name.
1 4 4
Use first four characters and last four characters in column name. (Default)
1 ln rn
Use indicated number of characters from beginning (ln) and end (rn) of column name.
scriptshowfullcol 1 3 3
scriptshowfulltbl
Format for table name used to generate name for local Column Map Procedure.
0
Use full table name.
1 4 4
Use first four characters and last four characters in table name. (Default)
1 ln rn
Use indicated number of characters from beginning (ln) and end (rn) of table name.
scriptshowfulltbl 1 6 6
scriptwarnmissing
Report option for missing Column Map Procedures.
0
Exclude warning of missing Column Map Procedure.
1
Include warning of missing Column Map Procedure. (Default)
scriptwarnmissing 1
wormdeviceallowaltret
Indicator for minimum WORM device retention settings. Indicates whether users can override configuration specifications for a WORM device by using a Storage Profile.
0
Use the WORM device default. Any Storage Profile or wormdeviceretention settings for retention causes the process to fail.
1
Use wormdeviceretention settings or overriding Storage Profile settings for minimum WORM device retention. (Default)
wormdeviceallowaltret 1
wormdeviceretention
Default minimum retention setting for Archive Files copied to a WORM device.
none
No minimum retention period. (Default)
interval
Use any wormdevicedays and wormdeviceyears settings or overriding Storage Profile settings for minimum WORM device retention. The retention interval cannot exceed the WORM device maximum date of 01/17/2071.
maximum
The WORM device maximum retention date, 01/17/2071, applies.
wormdeviceretention none
wormdevicedays
The number of days to retain an Archive File copied to a WORM device. This value and the wormdeviceyears value determine the retention period when the wormdeviceretention parameter or overriding Storage Profile setting indicates an interval for WORM device file retention.
0
Default. The file can be deleted from the WORM device at any time.
n
Number of days (up to 999) to retain the file.
wormdevicedays 60
wormdeviceyears
The number of years to retain an Archive File copied to a WORM device. This value and the wormdevicedays value determine the retention period when the wormdeviceretention parameter or overriding Storage Profile setting indicates an interval for WORM device file retention.
0
Default. The file can be deleted from the WORM device at any time.
n
Number of years to retain the file.
wormdeviceyears 20
sybaseunchain
Optim normally runs in chained mode. However the connection must be in unchained mode to accommodate a Sybase ASE stored procedure that runs in unchained mode, if the stored procedure is triggered in a command line process to Insert, Restore or Delete Sybase ASE data.
active
Processes must run in unchained mode.
inactive
Processes must run in normal (chained) mode. (Default)
defaultactive
The Run in Unchained Mode check box in Personal Options is available and selected, by default. Insert, Restore, and Delete Processes run in unchained mode unless the Run in Unchained Mode check box in Personal Options is cleared.
defaultinactive

The Run in Unchained Mode check box in Personal Options is available and cleared, by default. Insert, Restore, and Delete Processes run in normal mode unless the Run in Unchained Mode check box in Personal Options is selected.
sybaseunchain active
uncommittedread
Option to enable extracting of uncommitted rows from the database during an Archive or Extract Process. You can extract uncommitted rows from specific tables in the Access Definition or all tables. Selecting this option for tables with known performance problems might increase the speed of your Archive or Extract Processes.
active
Automatically extract uncommitted rows from each table in the Access Definition during all Archive or Extract Processes.
inactive
Automatically extract only committed rows from each table in the Access Definition during all Archive or Extract Processes. (Default.)
defaultactive
The Uncommitted Read option on the Access Definition Editor is available and selected by default. Uncommitted rows are extracted unless this option is cleared.
defaultinactive
The Uncommitted Read option on the Access Definition Editor is available and cleared by default. Uncommitted rows are not extracted unless this option is selected.
uncommitedread inactive


Feedback