Interstage Shunsaku Data Manager Application Development Guide - Microsoft(R) Windows(R) 2000/ Microsoft(R) Windows Server(TM) 2003 - - UNIX -

A.2 Meanings of Execution Parameters in API Environment File

Host

Specifies the host name or the IP address of the connection destination.

If this parameter is omitted, the specification defaults to "localhost".

Port

Specifies the port number of the connection destination.

If this parameter is omitted, the specification defaults to "33101".

ShunsakuFile

This parameter specifies a File name or Domain name for the connection destination Shunsaku File.

Specifications for the Shunsaku File have the following priority order.

1. The specification made by the ShunConnection class constructor, the Connect method in ShunService class or the ShunConnect function
2. The specification made by this parameter
3. The specification made by the DefaultFile parameter in the conductor environment file

WaitTimer

Specifies the maximum time (in seconds) to wait for a response from Shunsaku. Values between 0 and 3600 can be specified. If there is no response from Shunsaku after the specified waiting period has elapsed, a timeout will occur, an error will be notified to the application, and the connection will be closed automatically. If "0" is specified, no limit will be placed on the maximum response time and the system will continue to wait until a response is received.

If this parameter is omitted, the specification defaults to "0".

SnapLevel

Specifies the API snapshot output level.

[Table A-2 List of API Snapshots]

SnapLevel	Output content
0	Does not output API snapshots.
1	Outputs the API invocation sequence.
2	Outputs parameter information and data manipulation information when a method or function is executed, and level 1 information.

If this parameter is omitted, the specification defaults to "0".

When level 0 is specified, there is no need to specify the execution parameters LogFile, LogFileSize, LogFileBackup and PfmLog.

LogFile

Specifies the absolute path of the log file where the API snapshot is to be output.

The log file will be recycled when it reaches the size specified by LogFileSize.

This parameter must be specified when "1" or "2" is specified for SnapLevel. If this parameter is omitted, the API snapshot will not be output.

The API snapshot is created for each application process.

A process ID is added to the file name as shown in the following example.

Example

Absolute path specified in LogFile:

C:\api\api.log

Log file that is actually created:

C:\api\api_2435.log

Example

Absolute path specified in LogFile:

/api/api.log

Log file that is actually created

/api/api_2435.log

• Specify a folder on the local disk for this parameter.
• If the folder name contains blank spaces or the hash character "#", enclose the entire folder name in double quotes.

Directory names cannot include spaces or the hash character "#".

LogFileSize

Specifies the file size (in MB) that will trigger replacement of the log file where the API snapshot will be output. Values between 1 and 500 can be specified. If this parameter is omitted, the specification defaults to 100.

For example, if "1" is specified, a backup file will be created automatically when the size of the file exceeds 1 MB.

LogFileBackup

Specifies the number of backup files to be created for the API snapshot output log file. Values between 0 and 2147483647 can be specified. When the value specified by this execution parameter is exceeded, the contents of the oldest backup file will be overwritten.

For example, when "3" is specified for this parameter, three backup files named "api_2435.log.1", "api_2435.log.2" and "api_2435.log.3" will be created. When a further backup becomes necessary, the contents of "api_2435.log.3" will be lost.

When this parameter is omitted, the specification defaults to "1".

PfmLog

Specify whether to output the request number that is output in the performance log (The 8-bytes number from the conductor) in the API snapshot as the performance information.

0: Do not output the performance information in API snapshot
1: Output the performance information in API snapshot

When level 1 or 2 is specified in the SnapLevel, this parameter will be valid.

If this parameter is omitted, the specification defaults to "0".

Refer to Output Information of the Performance Log in the Operator's Guide for more information on the output of the performance log.