Pstserv Configuration File

The pstserv configuration file is used to configure the system for running pr0svce, the server daemon. An example of pstserv.cfg is in the /etc subdirectory to the PSTHOME directory.

Before you run pr0svce, modify the following parameters to reflect your site requirements, as applicable. In the following syntax, defaults are shown in bold text:

   [ customerid [ n | 000000 ] ]
   [ customername [ custname | xxxxx ] ]
   [ license [ xxxxxx-xxxxxx-xxxxxx-xxxxxx-xxxxxx | 
      000000-000000-000000-000000-000000] ]
   [ rtservername [ servername | localcomputername ] ]
   tempdir directory
   datadir directory
   [ datadirclient [ 0 | 1 ] ]
   [ archivedir [ directory  | datadir ] ]
   [ archivediridx [ directory | archivedir ] ]
   [ archivebroidx [ directory | archivedir ] ]
   [ maxprocesses [ n | 48 ] ]
   [ tracedays [ n | 5 ] ]
   [ limitaccess [ 0 | 1 ] ]
   [ allowdir path ] ]
   [ pstlogon [ client | server ] ]
   [ dbaliaslogon [ client | server ] ]
   [ delfileinterval [ n | 10 ] ]
   [ filelogon {client | local | server ( userid { password | ? } ) } ] 
   [ filemode < ALL | RUSR | RGRP | ROTH | WUSR | WGRP |
      WOTH | RALL | WALL > | [ SYSTEM ] ] 
   [ endpoint [ tcpportnumber | 1024 ] ]
   pstdir ( name dbmstype dbmsver dbqual connectstring 
   {dbname | * userid { password | ? } } )
   dbalias ( pstdir name { connectstring | * [userid { password | ? }] })
   [ loader ( { ( pstdir dbalias ) | (*  dbmstype ) }
    pathtoloader [excptntblcid ]]
   [ 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 ]
     [ DMLOprByRowID { never | dynamic | always | user-defined }
   [ auditfacility  {true | false } [ Audit OptimDirName1 { enabled | disabled } 
     [ retention-days n] [ Audit RecordLimit n]
     [ <FailureAction> { CONTINUE | STOP} ]
   [ adminemailnotify ( emailaddress={ success | information |
     warning | error | exception } [ n | 7 ] [ 0 | 1 ]  [clear] ) ]
   [ archiveretentionpolicy ( { hh:mm | * } { pstdirectory | * } ) ]
   [ centeraavail [ 0 | 1 ] ]
   [ tivoliavail [ 0 | 1 ( nodename password ) ] ]

parameters

customerid
company customer identifier number assigned by IBM®.
n
Unique six-digit company ID provided with Optim™.
000000
The demonstration ID. (Default)
customerid 611239
customername
Customer name.
custname
Company Name provided with Company ID and license key. (Up to 40 characters)
cccccccc
The demonstration name. (Default)
customername cccccccc
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 parameter 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
rtservername
The name of the server daemon as declared to all client machines. Processes initiated from a client machine and directed to the server are executed if this name matches a name in the product configuration file used by the client or, for command-line processes that explicitly require the server, the server parameter in pstlocal.cfg.
servername
1- to 15-character name
localcomputer name
The computer name. (Default)
rtservername servername
tempdir directory
Temporary directory for temporary work and trace files. The directory must exist before starting the Optim daemon.
tempdir       ${PSTHOME}/temp
datadir directory
Data 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.
datadir       ${PSTHOME}/data
datadirclient
Indicator for creating data subdirectories for client data. Settings are:
0 or blank
Do not create client subdirectories. (Default)
1
Create client subdirectory as the default when a client first connects to the server.
datadirclient 1
archivedir directory
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
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
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
maxprocesses
Maximum number of processes that can run on the server simultaneously. When the server reaches the maximum, an error message (Server too Busy) is displayed. Specify:
n
A value from 10 to 48. Set the limit according to the capacity of the machine (CPU, disk space, network access speed, memory, and so on), noting that typically, a mirror validation process is created each time a client edits a process request that specifies the server. Both processes run simultaneously. (For example, if a workstation initiates two processes simultaneously, the server executes four processes.)
48
Default setting.
maxprocesses 48
tracedays
Number of days to retain trace files in the temporary work directory. Specify:
n
A value from 2 to 30. Consider storage space limitations when deciding the number of days to retain the files.
5
Default setting.
tracedays 5
limitaccess
Option to limit client access to data directories. Settings are:
0 or blank
Client can see all directories on this machine in Browse dialogs.
1
Limit client access to the temporary (tempdir), data (datadir), archive (archivedir), archive index (archivediridx), and archive browse index (archivebroidx) directories and any directories specified in the allowdir parameter. (Default)
limitaccess 0
allowdir
Option to add a directory to the limitaccess list. Use allowdir for each additional directory. Allowing access to the root directory is equivalent to setting limitaccess to 0. A valid entry is:
path
A full directory path (you need not create the directory first)
allowdir /dir/subdir
pstlogon
The source of DBMS user ID and password for Optim directory access. Valid entries are:
client
User ID and password for the delegating client (in other words, from the Server tab in Personal Options or /PSTDIRUSERID and /PSTDIRPASSWORD from the command line). (Default)
server
User ID and password provided with pstdir parameter.
pstlogon client
dbaliaslogon
The source of DBMS user ID and password for DB alias access. Valid entries are:
client
User ID and password for the delegating client (in other words, from the Server tab in Personal Options or /USERID and /PASSWORD from the command line). (Default)
server
User ID and password provided with dbalias parameter.
dbaliaslogon client
delfileinterval
The interval in minutes for deleting archive files with an expired retention period after being recalled from secondary media.
n
A value from 0 to 300. Specify 0 to prevent the deletion of recalled files.
10
Default setting.
delfileinterval 10
filelogon
The source of user ID and password for file access. Valid entries are:
local
User ID and password used to start pr0svce. (Default)
client
DBMS user ID and password for the delegating client (in other words, from the Server tab in Personal Options or the server parameter in pstlocal.cfg).
server userid password
The provided user ID and password apply for all delegated processes. Specify “?” as the password when a secure password is supplied in a password file. (See Securing the Configuration Files for more information.)
Note: If the client or server parameter is used, the pr0svce daemon must be started under root authority.
filelogon local
filemode
Access permissions for extract, archive, and control files. Use any combination of the following:
ALL
Read and write permission for all users.
RUSR
Read permission for user.
RGRP
Read permission for the group that includes user.
ROTH
Read permission for all users outside Group.
WUSR
Write permission for user.
WGRP
Write permission for the group that includes user.
WOTH
Write permission for all users outside group.
RALL
Read permission for all users.
WALL
Write permission for all users.
SYSTEM
The system default, typically read and write permission for the user, and read-only for group and other. (Default)
filemode system
  • When filelogon is local, the user account under which the pr0svce daemon is started is user.
  • When filelogon is client, the user that creates a file is user.
  • When filelogon is server, the explicitly supplied user account is user.
endpoint
The TCP port that pr0svce monitors for RPC connections from clients. Valid settings are:
tcpportnumber
A numeric value from 1024 to 65534.
1024
The default setting.
endpoint 6736
pstdir
Connection information for an Optim directory. Use pstdir for each directory that can be accessed on behalf of a client. The Optim 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 directory.
dbmstype
Database Management System as DB2®, Oracle, Sybase, or Informix®.
dbmsver
DBMS version in the form n.n, n.n.n, or ni, as appropriate to the DBMS.
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 OPTIMDIR Oracle 9i APPPROD * USERID ?
pstdir OPTIMDIR DB2 8.1 APPPROD
dbalias
DB alias information. Use dbalias for each DB alias that the server can access on behalf of a client. 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 by a client.
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 OPTIMDIR DBALIAS * USERID ?
dbalias OPTIMDIR DBALIAS DO805
dbalias OPTIMDIR DBALIAS * USERID PASSWORD
loader
The location of the DBMS loader for a delegated Load Request. You can identify a loader for a specific Optim directory and DB alias, or you can identify a default loader to 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 parameter. This setting requires a dbalias name.
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 parameter. This setting requires a pstdir name.
*
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.
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
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.
Audit OptimDirName1
Enables or disables the 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.
adminemailnotify
Option to email “logged” messages reported to the server syslog. Provide the email address and severity level. You can also provide options for resending messages.
emailaddress=
The email address to receive the message. If an address contains a space, the entire string for this attribute must be in quotes.
success
Send email notification for all processing messages including success. (For example, startup and termination.)
information
Send email notification for information or more severe messages.
warning
Send email notification for warning or more severe messages.
error
Send email notification for error or more severe messages. (Default.)
exception
Send email notification for exception messages.
n
A number of days, from 0 to 999, after which a message is resent for a persistent error or warning. Specify 0 to resend messages immediately.
0 or blank
Do not resend messages. (Default.)
1
Resend a notification for a persistent error or warning.
clear
Clear messages to be resent when the server starts.
adminemailnotify admin@company.net=error 0 false; admin2@company.net=success 7 true
archiveretentionpolicy
Option to scan directories for archive files with an expired retention period. If the retention period has expired, the server deletes the archive file, archive index file, browse index file, archive directory entry, and archive files on backup devices. To delete backup files, you must use the centeraavail or tivoliavail parameters. NetWorker backups cannot be deleted.
hh:mm
The time of day to scan the directories. Use 24-hour time format (for example, 1:30 p.m. is 13:30). Midnight is 00:00. Enter ‘*' to use the default, 00:01.
pstdirectory
The directories to scan. Separate multiple entries with a comma or space. Enter ‘*' for all Directories.
archiveretentionpolicy 01:00 pstdir1 pstdir2
archiveretentionpolicy 03:00 pstdir3 pstdir4
centeraavail
Use Centera with the Archive Retention Policy.
0 or blank
Do not delete backup files on Centera. (Default.)
1
Delete backup files on Centera.
centeraavail 1
tivoliavail
Use Tivoli® with the Archive Retention Policy. (To use a Tivoli device, you must install the Tivoli client and API support on the machine where the Optim server runs.)
0 or blank
Do not delete backup files on Tivoli. (Default.)
1
Delete backup files on Tivoli.
nodename
Identifier to access the Tivoli device.
password
Password to access the Tivoli device.
tivoliavail 0


Feedback