Interstage Shunsaku Data Manager Operator's Guide - Microsoft(R) Windows(R) 2000/ Microsoft(R) Windows Server(TM) 2003 - - UNIX -

A.2.2 Execution Parameter Explanation

This section explains the meaning of the conductor environment execution file.

LogFileFolder

This parameter specifies the absolute path of the directory for storing error messages output by the conductor, and the files to which notification information is output.

The files below will be created under this directory and the log file will switch according to the value specified at the LogFileSwitch parameter. This cycle will continue for the same number as specified in the LogFileBackup parameter. In addition, during the operation, the file also switches when the file size is more than the value specified at the LogFileSize parameter.

If LogFileSwitch parameter is not specified

• conductor identifier.log
  This is the current conductor log file.
• conductor identifier_generation number_old.log
  The conductor log file that has generation number before the one displaying

If LogFileSwitch parameter is specified

• conductor identifier_0_YYYYMMDDhhmm.log
  This is the current conductor log file.
• conductor identifier_generation number_old_YYYYMMDDhhmm.log
  The conductor log file that has generation number before the one displaying

The file will be overwritten if the conductor identifier_generation number_old.log has already existed.

• Multi-byte characters cannot be specified in directory names.
• Specify the paths for directory names using up to 220 characters.

• Specify a folder on the local disk in this parameter.
• If the folder name contains blank spaces or the hash character "#", enclose the entire folder name in double quotes.
• To increase the level of security for the system to be constructed, set up the access privileges to the folder specified by this parameter so that only users belonging to the Administrators group have full control.

  The procedure for setting up the access privileges to this folder is shown below.

  • For Windows 2000:
    1. Select the Security tab of the Properties dialog box for the folder whose access privileges are to be set up.
    2. Clear the Allow inheritable permissions from parent to propagate to this object checkbox.
    3. Delete the Everyone group from the permissions list.
    4. Add access permissions to the Administrators group, giving this group full control.
  • For Windows Server 2003:
    1. Select the Security tab of the Properties dialog box for the folder whose access privileges are to be set up.
    2. Select the Set Details button.
    3. Clear the Allow inheritable permissions from parent to propagate to this object and all its child objects and include them into the objects explicitly defined here checkbox in the Set Details dialog box.
    4. Delete the Everyone group from the permissions list.
    5. Add access permissions to the Administrators group, giving this group full control.

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

LogFileSize

This parameter specifies the size at which the conductor log file will switch over. Specify a value between 0and 500 inclusive. The unit of the number is megabyte. If this parameter is omitted, it defaults to 100.

If 0 is specified, the log will not be collected.

LogFileBackup

This parameter specifies the number of conductor backup log file.

The log file currently in use is not counted in the number of backup file.

Specify a value between 1 and 100 inclusive. If 0 is specified, the backup file will not be created and only the file currently in use exists. The file before switch will be deleted after switching the file.

LogFileSwitch

This parameter specifies the number of days at which the conductor log file will switch over.

Specify a value between 1 and 100 inclusive.

If 0 is specified, the log file will be switch according to the file size specified at the LogFileSize parameter. If 1 or more is specified, the file will be switched at 0 am during the operation or when the process starts and the date of the last log file that has been switched is different.

However, if the file size has exceeded the size specified at the LogFileSize parameter, the file will be switched regardless of the specified number of days.

If this parameter is omitted, it defaults to 0.

The name of the conductor log file is as follows:

Example 1

Specify "LogFileBackup: 2", "LogFileSwitch: 1"
The following log file name will be displayed when start the Shunsaku system after 0 am in 22 April, 2006.

shunc_0_200604211235.log

Rename the file currently in use, and then create the backup file that contains data up to 22 April, 2006.

shunc_0_200604220000.log
shunc_1_old_200604211235.log

If start Shunsaku system after 0 am in 23 April, 2006, the file name will be as follows:

shunc_0_200604230000.log
shunc_1_old_200604220000.log
shunc_2_old_200604211235.log

If start Shunsaku system after 0 am in 24 April, 2006, the number of backup file is more than 2, therefore, the oldest file will be deleted as follows:

shunc_0_200604240000.log
shunc_1_old_200604230000.log
shunc_2_old_200604220000.log

Example 2

If the file size has exceeded the size specified in the LogFileSize parameter, the file name will be as follows:

shunc_0_200604230000.log

If the log file has been switched because the file size has exceeded the size specified in the LogFileSize parameter, the file name will be switch to the name below after the schedule is passed (23 April,2006 0:34 am)

shunc_0_200604231234.log
shunc_1_old_200604230000.log

Example 3

If the LogFileSwitch parameter is not used, the file name will be switched as follows:

shunc.log

If the file size has exceeded the value specified in LogFileSize parameter, the generation number will be added.

shunc.log
shunc_1_old.log

PfmFileFolder

This parameter specifies the storage directory of the conductor performance log file in absolute path.

The files below will be created under this directory and the log file will switch according to the value specified at the PfmFileSwitch parameter. This cycle will continue for the same number as specified in the PfmFileBackup parameter.

In addition, the file will be switched when the size of the file using is over the size specified at the PfmFileSize parameter.

If the PfmFileSwitch parameter is not specified

• conductor identifier_pfm.log
  This is the current performance log file.
• conductor identifier_pfm_generation number_old.log
  The performance log file that has generation number before the one displaying.

If the PfmFileSwitch parameter is specified

• conductor identifier_pfm_0_YYYYMMDDhhmm.log
  This is the current performance log file.
• conductor identifier_pfm_generation number_old_YYYYMMDDhhmm.log
  The performance log file that has generation number before the one displaying.

The file will be overwritten if the conductor identifier_pfm _generation number_old.log has already existed.

• Multi-byte characters cannot be specified in directory names.
• Specify the paths for directory names using up to 220 characters.

• Specify a folder on the local disk in this parameter.
• If the folder name contains blank spaces or the hash character "#", enclose the entire folder name in double quotes.
• To increase the level of security for the system to be constructed, set up the access privileges to the folder specified by this parameter so that only users belonging to the Administrators group have full control.

  The procedure for setting up the access privileges to this folder is shown below.

  • For Windows 2000:
    1. Select the Security tab of the Properties dialog box for the folder whose access privileges are to be set up.
    2. Clear the Allow inheritable permissions from parent to propagate to this object checkbox.
    3. Delete the Everyone group from the permissions list.
    4. Add access permissions to the Administrators group, giving this group full control.
  • For Windows Server 2003:
    1. Select the Security tab of the Properties dialog box for the folder whose access privileges are to be set up.
    2. Select the Set Details button.
    3. Clear the Allow inheritable permissions from parent to propagate to this object and all its child objects and include them into the objects explicitly defined here checkbox in the Set Details dialog box.
    4. Delete the Everyone group from the permissions list.
    5. Add access permissions to the Administrators group, giving this group full control.

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

PfmFileSize

This parameter specifies the size at which the conductor performance log file will switch over.

Specify a value between 1 and 500 inclusive. The unit of the number is megabyte.

If this parameter is omitted, it defaults to 100.

If 0 is specified, the performance log will not be collected.

PfmFileBackup

This parameter specifies the number of conductor backup performance log file.

The performance log file currently in use is not counted in the number of backup file.

Specify a value between 1 and 100 inclusive. If 0 is specified, the backup file will not be created and only the file currently in use exists. The file before switch will be deleted after switching the file.

The file before switching will be deleted after switching the file.

If the number of backup performance log file exceeds the value specified in this parameter, the oldest backup file will be deleted.

If this parameter is omitted, the system will hold only the first generation backup file.

PfmFileSwitch

This parameter specifies the number of days at which the conductor performance log file will switch over.

Specify a value between 1 and 100 inclusive. If 0 is specified, the log file will be switch according to the file size specified at the PfmFileSize parameter. If 1 or more is specified, the file will be switched at 0 am during the operation or when the process starts and the date of the last performance log file that has been switched is different.

However, if the file size has exceeded the size specified at the LogFileSize parameter, the file will be switched regardless of the specified number of days.

If this parameter is omitted, it defaults to 0.

The name of the conductor performance log file is as follows:

Conductor identifier_pfm_0_YYYYMMDDhhmm.log: The performance log file currently in use
conductor identifier_pfm_1_old_YYYYMMDDhhmm.log: One generation before the current performance log file
conductor identifier_pfm_2_old_YYYYMMDDhhmm.log: Two generations before the current performance log file

The time when the performance log file has switched will be displayed as YYYYMMDDhhmm (YYYY: Year, MM: Month, DD: Day, hh: Hour, mm: Minute)

CoreFileFolder

This parameter specifies the absolute path of the directory where the core file will be output if an abnormality occurs with the conductor.

The size of the core file that is output is the same as the amount of memory that the conductor uses.

This parameter is mandatory.

• Multi-byte characters cannot be specified in directory names.
• Specify the absolute path for directory names using up to 220 characters.

• Specify a folder on the local disk in this parameter.
• If the folder name contains blank spaces, enclose the entire folder name in double quotes (" ").
• To increase the level of security for the system to be constructed, set up the access privileges to the folder specified by this parameter so that only users belonging to the Administrators group have full control.

  Refer to the notes above for the LogFileFolder parameter in the conductor environment file for more information on how to set up the access privileges to this folder.

• Directory names cannot include spaces.

AnsMax

This parameter specifies the maximum number of matching XML documents that can be returned from a search request from an application.. Specify a value between 1 and 100000 inclusive.

If this parameter is omitted, it defaults to 100.

StartPoint

This parameter is used to specify the order in which search results are returned to directors.

If Shunsaku File is not used:

Specify the first director in the sequence for returning search results to the application. This parameter can be specified only if a director number has been allocated to all directors. Specify values for this parameter in the following order:

• The number of the director where the search starts

  The number corresponding to the specified director identifier. A unique number between 1 and 255 inclusive

If Shunsaku File is used:

Specify the first director in the specified File in the sequence for returning search results to the application. This parameter can be set only if a director number has been allocated to all directors in the specified File. Specify values for this parameter in the following order:

• The number of the director where the search starts

  The number corresponding to the specified director identifier. A unique number between 1 and 255 inclusive

• File name

If this parameter is specified, search results will be returned to those directors whose director number is greater than or equal to the specified number, in ascending order of director numbers. Search results will then be returned to those directors whose director number is less than the specified number, in ascending order of director numbers.

InsertPoint

If Shunsaku File is not used:

This parameter specifies the director where data will be inserted from the application. Specify information in the following order:

• Director identifier for the insertion destination director

  "_LAST_" can be set for this parameter if a director number has been allocated to all directors. In this case, the last director in the search result return sequence becomes the data insertion destination.

If Shunsaku File is used:

This parameter specifies the director in a particular File where data will be inserted from the application. If there are multiple Files, separate settings must be made for each File. Specify information in the following order.

• Director identifier for the insertion destination director

  "_LAST_" can be set for this parameter if a director number has been allocated to all directors in a particular file. In this case, the last director in the search result return sequence becomes the data insertion destination.

• File name

• Specify the director identifier using up to eight alphanumeric characters.
• This parameter can be omitted if the data insertion destination is decided uniquely. In other words, this parameter can be omitted if no Shunsaku File is used in the environment, and there is only one director in the Shunsaku system. Similarly, this parameter can be omitted if Shunsaku File is used in the environment, and a File includes only one director. This parameter cannot be omitted if there are two or more directors.

MaxConnection

This parameter specifies the maximum number of simultaneous connections to the conductor. Specify a value between 1 and 30000 inclusive.

If this parameter is omitted, it defaults to 1000.

If the number of simultaneous connections to the conductor exceeds the number specified by this parameter, an error message will be output to the log or log file shown below and an error will be returned to the application.

• Application log (event log)
• The conductor log file

• System log (syslog)
• The conductor log file

File

This parameter specifies the file information when Shunsaku File is used. Specify information in the following order:

• File name
• The director identifiers for the directors registered with the File (more than one director identifier can be specified)

This parameter must be specified over more than one line if multiple Files are to be allocated.

The Shunsaku File function cannot be used if this parameter is omitted.

Refer to 7.2 Creating and Deleting Shunsaku Files for more information on the Shunsaku File.

Specify a string of up to 32 characters. Only alphanumeric characters can be used.

Domain

This parameter specifies the scope that can be accessed by grouping multiple Files. Specify information in the following order.

• Domain name
• Name of the File registered with the Domain (more than one file can be specified)

This parameter must be specified over more than one line if multiple Domains are to be allocated.

The Domain function cannot be used if this parameter is omitted.

Specify a string of up to 32 characters. Only alphanumeric characters can be used.

DefaultFile

This parameter specifies the Shunsaku File that sets the scope of access permitted when applications are executed without a Shunsaku File specified. Specify the following information:

• File name or Domain name

If this parameter is omitted, the Shunsaku File to be accessed must be specified explicitly for APIs.

SystemName

This parameter specifies the Shunsaku system name.

This parameter must be specified if the startup commands for V6.0 and earlier (shuncstart, shundstart, shunsstart, and shunostart) are used.

If this parameter is omitted, the startup commands for V6.0 and earlier (shuncstart, shundstart, shunsstart, and shunostart) cannot be used.

This parameter does not need to be specified if only the V8.0 startup command (shunsysstart) is used.

Specify the Shunsaku system name using up to eight alphanumeric characters.