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

A.1.2 Execution Parameter Explanation

Conductor

This parameter specifies server information for the conductor. Specify values for this parameter in the following order:

• Conductor identifier
• The host name or IP address allocated to the conductor
• The port number for receiving requests

Specify the port number for receiving requests from Shunsaku APIs.

Specify this port number with Shunsaku APIs. Refer to Creating the System Environment File in the Installation Guide for more information.

This parameter is mandatory.

• Specify the conductor identifier using up to eight alphanumeric characters.
• For the port number for receiving requests, specify a port number that is not used by any other services.
• Each conductor on a single server must have a unique conductor identifier.

• If the Management Console is to be used, do not specify the loopback address 127.0.0.1 or a host name representing 127.0.0.1 (usually "localhost") for the host name or IP address allocated to the conductor. Specify a host name or IP address other than the loopback address.

Sorter

This parameter specifies server information for the sorter. Specify values for this parameter in the following order:

• Sorter identifier
• The host name or IP address allocated to the sorter
• The port number for receiving sort requests from the conductor

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

This parameter is mandatory.

• Specify the sorter identifier using up to eight alphanumeric characters.
• Each sorter on Shunsaku system must have a unique sorter identifier.

• If the Management Console is to be used, do not specify the loopback address 127.0.0.1 or a host name representing 127.0.0.1 (usually "localhost") for the host name or IP address allocated to the sorter. Specify a host name or IP address other than the loopback address.

Director

This parameter specifies server information for the director. Specify values for this parameter in the following order:

• Director identifier
• The host name or IP address allocated to the director
• The port number for issuing search requests to searchers
• The port number for issuing update requests to searchers
• The port number for receiving requests

  Specify the port number for receiving requests.

  Refer to the Installation Guide for more information on port numbers.

• Director number

  The number corresponding to the specified director identifier

  A unique number between 1 and 255 inclusive

  The director number can be used if the StartPoint parameter in the conductor environment file is used, but can be omitted otherwise.

This parameter must be specified over more than one line if multiple directors are to be allocated. Up to 255 directors can be defined.

This parameter is mandatory.

• Specify the director identifier using up to eight alphanumeric characters.
• The director number can be omitted.
• Each director within a single Shunsaku system must have a unique director identifier.
• Each director on Shunsaku system must have a unique director identifier.

• If the Management Console is to be used, do not specify the loopback address 127.0.0.1 or a host name representing 127.0.0.1 (usually "localhost") for the host name or IP address allocated to the director. Specify a host name or IP address other than the loopback address.

Searcher

This parameter specifies server information for the searcher. Specify information in the following order:

• Searcher identifier
• The host name or IP address allocated to the searcher
• The port number for receiving requests from directors. Refer to the Installation Guide for more information about defining port numbers.
• The director identifier for the director that the searcher is connected to.

This parameter must be specified over more than one line if multiple searchers are to be allocated. Up to 20 searchers can be defined for each director.

This parameter is mandatory.

• Specify the searcher identifier using up to eight alphanumeric characters.
• For the searcher port number, specify a port number that is not used by any other services.
• Within a single Shunsaku system, searchers with the same searcher identifier can be allocated, as long as they are allocated to different search servers.
• Each searcher on a single server must have a unique searcher identifier.

• If the Management Console is to be used, do not specify the loopback address 127.0.0.1 or a host name representing 127.0.0.1 (usually "localhost") for the host name or IP address allocated to the searcher. Specify a host name or IP address other than the loopback address.

AlternativeSearcher

This parameter specifies server information for alternative searchers. Specify values for this parameter in the following order:

• Searcher identifier
• The host name or IP address allocated to the alternative searcher
• The port number for receiving requests from directors. Refer to the Installation Guide for more information on port numbers.
• Director identifiers for the directors that the alternative searcher can connect to.

  Specify these identifiers to restrict the directors that an alternative connection can be made to.

  Multiple director identifiers can be specified. If no director identifiers are specified, the alternative searcher can receive connections from all of the directors specified in the system environment file.

This parameter must be specified over more than one line if multiple alternative searchers are to be allocated. The maximum number of searchers that can be registered with a single director is 20, including alternative searchers that omit the director identifier.

If this parameter is omitted, degradation operations will take place when searcher abnormalities occur.

• Specify the searcher identifier using up to eight alphanumeric characters.
• For the port number for alternative searchers, specify a port number that is not used by any other services.
• Searchers or alternative searchers with the same searcher identifier can be allocated within a single Shunsaku system, as long as they are allocated to different search servers.
• Searchers or alternative searchers with the same searcher identifier cannot be created on a single system.

• If the Management Console is to be used, do not specify the loopback address 127.0.0.1 or a host name representing 127.0.0.1 (usually "localhost") for the host name or IP address allocated to the alternative searcher. Specify a host name or IP address other than the loopback address.

CharacterCode

This parameter specifies the character code for the data to be searched.

If this parameter is omitted, it defaults to UTF-8.

[Table A-1 Character Code Settings]

Setting	Meaning
UTF-8	For UTF-8
SHIFT-JIS	For Shift-JIS (Japanese)
EUC	For EUC-JP (Japanese)
GB18030	For GB18030 (Chinese)
GB2312	For GB2312 (Chinese)
big5	For Big5 (Chinese)
KSC5601	For KSC5601 (Korean)

Register lookup data using the character code specified by the CharacterCode parameter.

ANKmix

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

0: Match case
1: Do not match case

If this parameter is omitted, it defaults to 0.

[Table A-2 ANKmix Settings]

Search keyword	String being searched	0: Match case	1: Do not match case
ab	ab
	AB	x
	aB	x
	Ab	x
AB	ab	x
	AB
	aB	x
	Ab	x

:Hit
x:Miss

• This parameter is valid with patterns and for string complete matches.
• This parameter is invalid with the application 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.

0: Match case
1: Do not match case.

If this parameter is omitted, it defaults to 0.

[Table A-3 KNJmix Settings]

Search keyword	String being searched	0: Match case	1: Do not match case
a b	a b
	A B	x
	a B	x
	A b	x
A B	a b	x
	A B
	a B	x
	A b	x

:Hit
x:Miss

• 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.

• 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 invalid with the application 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 (" ").

This parameter can be omitted.

More than one character can be specified in this parameter, provided that each string is separated by a comma (,).

Specify characters (other than control characters, the linefeed character, or horizontal tab) for the SkipChar parameter.

If this parameter is omitted, all characters will become the search target.

• This parameter is valid with pattern string searches and for string complete matches.
• This parameter is invalid with the application that specified Direct Access key.
• When specifying any character not shown below for this parameter, express the value using the character code specified in the CharacterCode parameter. Note that skip characters are case sensitive.

single-byte space	\s
multi-byte space	\S
Linefeed	\n
Horizontal tab	\t

Example

An example of specifying the following characters in this parameter is shown below:

Single-byte space, multi-byte space, horizontal tab, @(multi-byte character), @(single-byte character), , and linefeed character

Character code specified	UTF-8	SHIFT-JIS	EUC	Chinese			Korean
				GB18030	GB2312	big5	KSC5601
Single-byte space	\s	\s	\s	\s	\s	\s	\s
Multi-byte space	\S	\S	\S	\S	\S	\S	\S
Horizontal tab	\t	\t	\t	\t	\t	\t	\t
@(multi-byte)	\EF \BC \A0	\81 \97	\A1 \F7	\A3 \C0	\A3 \C0	\A2 \49	\A3 \C0
@(single-byte)	\40	\40	\40	\40	\40	\40	\40
Linefeed	\n	\n	\n	\n	\n	\n	\n

Entry examples are shown below:

Character code specified in CharacterCode		Entry example
UTF-8		\s,\S,\t,\EF \BC \A0,\40,\n
SHIFT-JIS		\s,\S,\t,\81 \97,\40,\n
EUC		\s,\S,\t,\A1 \F7,\40,\n
Chinese	GB18030	\s,\S,\t,\A3 \C0,\40,\n
	GB2312	\s,\S,\t,\A3 \C0,\40,\n
	big5	\s,\S,\t,\A2 \49,\40,\n
Korean	KSC5601	\s,\S,\t,\A3 \C0,\40,\n

The difference between specifying a space (\s) and a multi-byte space (\S) as the skip character

Search keyword	String being searched	When \s and \S are not specified in SkipChar	When \s and \S are specified in SkipChar
JohnSmith	JohnSmith
	John Smith	x
	JohnSmith	x
John Smith	JohnSmith	x
	John Smith
	JohnSmith	x
JohnSmith	JohnSmith	x
	John Smith	x
	JohnSmith

:Hit
x:Miss

ExtendedQuery

This parameter specifies whether to use compatible format queries. The compatible format queries means to specify escape characters and use ellipse searches in the same way as under 6.0.

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

If this parameter is omitted, it defaults to 0.

SeparateChar

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

This parameter can be omitted.

Multiple characters can be specified for the SeparateChar parameter. In this case, separate each string with a comma (,).

Specify an ASCII character (other than control characters, the linefeed character, or horizontal tab) for the SeparateChar parameter.

If the following characters are specified for the SeparateChar parameter, they must be preceded by the escape character. The escape character is "\".

Delimiter	Specification method
Space	\s
Linefeed	\n
Horizontal tab	\t
Comma	\,
Double quote	\"
Back slash	\\

If this parameter is omitted, the following 'delimiters' are regarded as having been specified.

Default Delimiters

\t	\n	\s	!	\"	#
$	%	&	'	(	)
*	+	\,	-	.	/
:	;	<	=	>	?
@	[	\\	]	^	_
`	{	|	}	~

SearcherFailureEscalation

This parameter specifies the scope that the director will regard as abnormal if a searcher abnormality is detected on a search server where multiple searchers have been allocated.

0: Regard only the target searcher as abnormal
1: Regard the entire search server where the target searcher is allocated as abnormal

If value "1" is specified, all of the searchers allocated to the search server will be regarded as abnormal when a searcher abnormality is detected. If alternative searchers have been specified, the searchers regarded as abnormal will failover. Otherwise, degradation will be performed.

If this parameter is omitted, it defaults to 0.

Any searchers connected to another director but allocated to the same search server will not be included in the scope that is regarded as abnormal, even if "1" is specified for this parameter.

MonitoringStyle

This parameter specifies the output format for monitoring.

0: The w option will be regarded as having been specified if none of the options w, p, i, or c are specified with the shuncstate, shunostate, shundstate, or shunsstate commands.

1: Information will be displayed using the output format for V6.0 if none of the options w, p, i, or c are specified with the shuncstate, shunostate, shundstate, or shunsstate commands.

If this parameter is omitted, it defaults to 0.

Refer to Monitoring and Logging in Chapter 6, Maintenance for more information on the new output format for monitoring.

SearchAttribute

This parameter specifies whether to search the attribute value.

0: Search the attribute value
1: Do not search the attribute value

If this parameter is omitted, it defaults to 0.

Refer to Notes on XML Format in the Application Development Guide for more information on the notes on searching attribute value.

DegradableSearcherCnt

This parameter specifies the number of searchers that is degradable when the searcher 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 the directors specified in the system environment file. However, specify to each director environment file if multiple directors are used and numbers of searcher in each director are different.

If this parameter is omitted in both system environment file and director environment file, the degradation will not take place.

• 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.