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

A.3.2 Execution Parameter Explanation

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

DataFileFolder

This parameter specifies the absolute path of the directory for storing the director data files.

A subdirectory with the same name as the director identifier will be automatically created under the directory specified by this parameter, and the director data files will be created in this subdirectory.

This parameter is mandatory.

Refer to D.3.1 The Size of Director Data Files for information on the amount of disk space that these files require.

• To back up director data files, use an operating system command to back up all of the files in the directory with the director identifier that was created under the directory specified by this parameter.
• Multi-byte characters cannot be specified in directory names.
• Specify the absolute 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.

  Refer to the notes 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 or the hash character "#".

MaxDataFileSize

This parameter specifies the maximum size of the director data file. Specify a value between 100 and 100,000,000 inclusive. The unit of the number is megabyte.

When updating data by command or application, if the director data file size is more than the value specified at this parameter, the command or the update process will fail and the transaction including the update process will be rolled back.

If this parameter is omitted, the size of the director data file will not be checked.

• Specify the maximum size of the director data file based on the usable disk size.
  Refer to D.3.1 Director Data File Size for more information on the size of the director data file.
• If the director data file size has exceeded the maximum value when start the director, after the director is started, the user will not be able to run the update process by command or application.

Refer to Handling an Insufficient on Capacity of the Disk in the Troubleshooting for more information on the action to avoid an insufficient on disk space when using this parameter.

WarningDataFileSize

This parameter specifies the alarm point of the director data file size. Specify a value between 50 and 100,000,000 inclusive. The unit of the number is megabyte.

When updating data by command or application, if the director data file size is more than the value specified at this parameter, the warning message (shn30395w) will be output at the system log in the server where the director is located.

If this parameter is omitted, the warning message will not be output.

• Design the alarm point of the director data file size based on the usable disk size.
  Refer to D.3.1 The Size of Director Data Files for more information on the size of the director data file.
• If the specified value is more than the maximum alarm point, the warning message will not be output.
• If the director data file size has exceeded the alarm point when start the director, the warning message will be output.

Refer to Handling an Insufficient on Capacity of the Disk in the Troubleshooting for more information on the action to avoid an insufficient on disk space when using this parameter.

LogFileFolder

This parameter specifies the absolute path of the directory for storing error messages output by the director, 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 switch when the file size is more than the value specified at the LogFileSize parameter.

If LogFileSwitch parameter is not specified

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

If LogFileSwitch parameter is specified

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

The file will be overwritten if the director 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.

  Refer to the notes 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 or the hash character "#".

LogFileSize

This parameter specifies the size at which the director log file will switch over. Specify a value between 0 and 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 director 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 director 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 director log file is as follows:

director identifier_0_YYYYMMDDhhmm.log: The log file currently in use
director identifier_1_old_YYYYMMDDhhmm.log: One generation before the current log file
director identifier_2_old_YYYYMMDDhhmm.log: Two generations before the current log file

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

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.

shund1_0_200604211235.log

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

shund1_0_200604220000.log
shund1_1_old_200604211235.log

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

shund1_0_200604230000.log
shund1_1_old_200604220000.log
shund1_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:

shund1_0_200604240000.log
shund1_1_old_200604230000.log
shund1_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:

shund1_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)

shund1_0_200604231234.log
shund1_1_old_200604230000.log

Example 3

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

shund1.log

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

shund1.log
shund1_1_old.log

PfmFileFolder

This parameter specifies the storage directory of the director 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

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

If the PfmFileSwitch parameter is specified

• director identifier_pfm_0_YYYYMMDDhhmm.log
  This is the current performance log file.
• director 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 director identifier_pfm _generation number_old.log has already existed.

• Multi-byte characters cannot be specified in directory names.
• Specify the absolute 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.
  Refer to the Notes of the "PfmFileFolder" in the conductor environment file for more information on how to set the access privileges to the folder.

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

PfmFileSize

This parameter specifies the size at which the director 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 director 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 director 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 director performance log file is as follows:

Director identifier_pfm_0_YYYYMMDDhhmm.log: The performance log file currently in use
director identifier_pfm_1_old_YYYYMMDDhhmm.log: One generation before the current performance log file
director 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 director.

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

This parameter is mandatory.

• Multi-byte characters cannot be specified in directory names.
• Specify the absolute 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.

  Refer to the notes 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 or the hash character "#".

OperationLogFolder

This parameter specifies the absolute path to the directory where operation log files are stored.

Files for storing information about operations on director data files will be created in the directory specified by this parameter.

This parameter cannot be omitted if recovery is performed using operation logs with the shundrecover command.

Refer to D.3.2 The Size of Operation Log Files, Estimating Resources for information on the amount of disk space that these files require.

• Place the storage directory for operation log files on a different disk to the storage directory for director data files.
• Multi-byte characters cannot be specified in directory names.
• Specify the absolute 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.

Refer to the notes 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 or the hash character "#".

MaxOperationLogSize

This parameter specifies the maximum size of the operation log file. Specify a value between 100and 100,000,000 inclusive. The unit of the number is megabyte.

When updating data by command or application, if the operation log file size is more than the value specified at this parameter, the command or the update process will fail and the transaction including the update process will be rolled back.

If this parameter is omitted, the size of the operation log file will not be checked.

• Specify the maximum size of the operation log file based on the usable disk size.
  Refer to D.3.2 The Size of Operation Log Files for more information on the size of the operation log file.
• If the operation log file size has exceeded the maximum value when start the director, after the director is started, the user will not be able to run the update process by command or application.

Refer to Handling an Insufficient on Capacity of the Disk in the Troubleshooting for more information on the action to avoid an insufficient on disk space when using this parameter.

WarningOperationLogSize

This parameter specifies the alarm point of the operation log file size. Specify a value between 50 and 100,000,000 inclusive. The unit of the number is megabyte.

When updating data by command or application, if the operation log file size is more than the value specified at this parameter, the warning message (shn30397w) will be output at the system log in the server where the director is located.

If this parameter is omitted, the warning message will not be output.

• Design the alarm point of the operation log file size based on the usable disk size.
  Refer to D.3.2 The Size of Operation Log Files for more information on the size of the operation log file.
• If the specified value is more than the maximum alarm point, the warning message will not be output.
• If the operation log file size has exceeded the alarm point when start the director, the warning message will be output.

Refer to Handling an Insufficient on Capacity of the Disk in the Troubleshooting for more information on the action to avoid an insufficient on disk space when using this parameter.

MaxStoredRecords

This parameter specifies the maximum number of records stored in a director. Specify a value between 10,000 and 10,000,000 inclusive.

When adding data using update process by command or application, if the number of records stored in a director is more than the value specified at this parameter, the command or the update process will fail and the transaction including the update process will be rolled back.

If this parameter is omitted, the maximum number of records will not be checked when adding the data

• Specify the maximum number of records that can be stored in a director based on the usable disk size.
  Refer to D.3.5 Memory Requirements for Directors for more information on the memory requirements for directors.
• If the number of records stored in a director has exceeded the alarm point when start the director, the warning message will be output.

WarningStoredRecords

This parameter specifies the alarm point of the number of records stored in a director. Specify a value between 5,000 and 10,000,000 inclusive.

When updating data by command or application, if the number of records stored in a director is more than the value specified at this parameter, the warning message (shn30392w) will be output at the system log in the server where the director is located.

If this parameter is omitted, the warning message will not be output.

• Specify the alarm point of the number of records that can be stored in a director based on the usable disk size.
  Refer to D.3.5 Memory Requirements for Directors for more information on the memory requirements for directors.
• If the operation file size has exceeded the alarm point when start the director, the warning message will be output.

AnsMax

This parameter specifies the maximum number of matching XML documents that can be returned for search requests from applications that are directly connected to the director. Specify a value between 1 and 100000 inclusive.

If this parameter is omitted, it defaults to 100.

MultiMax

This parameter specifies the maximum number of search requests that can be received concurrently. Specify a value between 1 and 255 inclusive.

If this parameter is omitted, it defaults to 100.

Too large a value may require a large amount of memory.

SearcherWTimer

Directors wait for responses from searchers. This parameter specifies longest time that a director should wait for a response. Specify a value between 1 and 3600 inclusive. The unit of the number is second.

If this parameter is omitted, it defaults to 180. If there is no response from a searcher within this time (starting from the time when the request is sent from the director to the searcher), the searcher is regarded as having an abnormality. If a searcher is found to be abnormal, the searcher will failover to an alternative searcher if one has been defined. If no alternative searchers have been defined, degradation will be performed.

ANKmix

This parameter specifies whether to distinguish upper and lower case for alphanumeric characters in the strings that will be searched in a director.

0: Match case
1: Do not match case

If both this parameter and the "ANKmix" parameter in the system environment file have been specified, the value of this parameter takes effect.

If this parameter is omitted, the value of the "ANKmix" parameter in the system environment file is used.

• This parameter is valid with patterns and for string complete matches.
• This parameter is not valid with API that specified Direct Access key.

KNJmix

This parameter specifies whether to distinguish between upper and lower case for multi-byte alphabetic characters in the strings that will be searched in the director.

0: Match case
1: Do not match case

If this parameter and the KNJmix parameter in the system environment file are both specified, the value of this parameter will take precedence.

If this parameter is omitted, the value for KNJmix in the system environment file will be used.

• This parameter is only valid for Japanese character codes.

  To use a Japanese character code, specify "UTF-8", "SHIFT-JIS" or "EUC" for the CharacterCode parameter in the system environment file.

• Multi-byte characters are distinguished from single-byte characters.
• This parameter is valid with pattern string searches and for string complete matches.
• This parameter is not valid with API that specified Direct Access key.

SkipChar

This parameter specifies which characters are to be treated as skip characters (not part of the search target). Enclose the characters being specified in double quotes (" ").

If both this parameter and the SkipChar parameter in the system environment file have been specified, the value of this parameter takes effect.

If this parameter is omitted, the value of the SkipChar parameter in the system environment file is used.

Refer to the "Note" and "Reference" in SkipChar in System Environment Files for more information on how to specify this parameter.

This parameter is not valid with API that specified Direct Access key.

ExtendedQuery

This parameter specifies whether to use compatible format queries

0: Do not use compatible format queries
1: Use compatible format queries

If both this parameter and the ExtendedQuery parameter in the system environment file have been specified, the value of this parameter takes effect.

If this parameter is omitted, the value of the ExtendedQuery parameter in the system environment file is used.

SeparateChar

This parameter specifies the entire delimiter (enclosed in double quotes (" ") ) when word searches are specified in search expressions.

If both this parameter and the SeparateChar parameter in the system environment file have been specified, the value of this parameter takes effect.

If this parameter is omitted, the value of the SeparateChar parameter in the system environment file is used.

Refer to SeparateChar in System Environment Files for more information on how to specify this parameter.

DirectKeyListFile

This parameter specifies the direct access definition file name.

If this parameter is omitted, the user will not be able to manipulate data by the direct access key.

Locate the direct access key definition file at the following directory.

Shunsaku installation folder\Shunsaku\etc\director\

/etc/opt/FJSVshnsk/etc/director/

The length of the direct access key definition file can be up to 32 bytes.
Multi-byte characters cannot be specified in direct access key definition file names.

The direct access key definition file name cannot include spaces or the has character "#".

Refer to direct Access Function in the Application Development Guide for more information on the direct access key.

DegradableSearcherCnt

This parameter specifies the number of searchers that is degradable when the search server abnormalities occur.

Specify a value between 1 and 19 inclusive. If 0 is specified, degradation operations will not take place even when the searcher abnormalities occur.

If this parameter is specified, this degradation function will be valid to all related directors.

If this parameter is omitted, the value of "DegradableSearcherCnt" in the system environment file will be used.

Refer to "DegradableSearcherCnt" in the system environment file for more information on how to specify is parameter.

• The value in this parameter cannot be more than The number of searchers connected to each director.
• If the SearcherFailureEscalation is 1, the range of the abnormal searchers will be the number of all searchers located in that search server. This number will be counted as the number of abnormal searchers.

Refer to Recovering from Searcher Failover in the Troubleshooting for more information on the action when the number of abnormal searchers exceeds the value specified in this parameter.

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.