2.2 Property file (config_user.properties)

This is the definition file used for various JP1/AO settings such as logs, tasks, and JP1 events.

Format

specification-key-name=setting

Installation folder

For non-cluster systems:: JP1/AO-installation-folder\conf
For cluster systems:: shared-folder-name\jp1ao\conf

Trigger for applying definitions

Restarting the service (HAutomation Engine Web Service)

Description

One specification key and setting can be specified per line. Note the following points when coding the property file.

Lines that begin with a hash mark (#) are treated as comments.
Blank lines are ignored.
The encoding is ISO 8859-1.
The entries are case sensitive.
To specify a backslash (\) in a character string, two backslashes (\\) must be entered.

In this case, assume two backslashes as one byte to calculate the size.
If an invalid value is entered for a setting, it is set to its default value, and the KNAE02022-W message is output to the integrated trace log and public log.
If the same specification key is entered multiple times in a file, the last one that is specified will take effect.

Settings

Table 2‒2: Settings in the property file
Classification	Key name	Settings	Specifiable values	Default value
Logs^#1	logger.sysloglevel	Specifies the threshold for event log output.	0: Messages whose output level is 0 are output. 10: Messages whose output level is 0 and 10 are output.	0
	logger.message.server.MaxBackupIndex	Specifies the maximum number of log backup files for a server.	1-16	7
	logger.message.server.MaxFileSize	Specifies the maximum log file size (KB) for a server.	4-2,097,151	1,024
	logger.message.command.MaxBackupIndex	Specifies the maximum number of log backup files for a command.	1-16	7
	logger.message.command.MaxFileSize	Specifies the maximum log file size (KB) for a command.	4-2,097,151	1,024
	logger.TA.MaxFileSize	Specifies the maximum log file size (KB) for a task.	4-2,097,151	1,0240
Task management	task.ajs.IPBindhost	Specifies the JP1/AO host name or IP address (0-255 bytes) when the JP1/Base communication protocol is set to the IP binding method.	Character string that can be specified for host names or IP addresses	" " (null character)
	tasklist.autoarchive.taskRemainingPeriod	Specifies the period (days) that tasks whose execution has terminated are retained in the task list.	1-90	7
	tasklist.autoarchive.executeTime	Specifies the time at which the following processing is executed: Automatic archive of tasks Automatic deletion of history entries Automatic deletion of debug tasks Invalid regions in the database are also released at this time.	00:00:00-23:59:59	04:00:00
	tasklist.autoarchive.maxTasks	Specifies the maximum sum of the number of tasks that can be kept in the task list and the number of debug tasks that can be kept in the debug task list.	100-5,000	5,000
	tasklist.autodelete.maxHistories	Specifies the maximum number of history entries that can be retained.	100-30,000	30,000
	task.details.jobnet.status.visible	Specifies whether the step list in the Task Details dialog box displays the status in the task-processing engine or the status of steps.	true: Display the status in the task-processing engine false: Display the status of steps	false
Service management	packagemanager.extraPresets.maxFiles	Specifies the maximum number of preset property definition files that can be added to one service template.	5-100	5
JP1 event notifications	notification.jp1event	Specifies whether to send JP1 events in the notification function.	true: Send false: Do not send	true
Repeats	foreach.max_value	Specifies the maximum number of concurrent tasks that can be executed by a Repeated Execution Plug-in.	1-99	3
Remote connection port number	ssh.port.number	Specifies the SSH port number of the operation target device.	0-65535	22
Remote connection port number	telnet.port.number	Specifies the Telnet port number of the operation target device.	0-65535	23
Terminal connection	plugin.terminal.prompt.account	Specifies a regular expression pattern (1-1,024 characters) used to detect the user ID waiting state. To establish a Telnet connection with the operation target device, if the standard output and standard error output match the specified regular expression, the terminal connect plug-in determines that a user ID must be entered. Then, this plug-in enters a user ID.	Character string that can be used in regular expression patterns	login\|Login Name\|Username\|UserName
	plugin.terminal.prompt.password	Specifies a regular expression pattern (1-1,024 characters) used to detect the password waiting state. To establish a Telnet connection with the operation target device, if the standard output and standard error output match the specified regular expression, the terminal connect plug-in determines that a password must be entered. Then this plug-in enters a password.	Character string that can be used in regular expression patterns	password\|Password\|PassWord
	telnet.connect.wait	Specifies the waiting time (seconds) until the standard output is returned after a Telnet connection is established with the operation target device.	1-600	60
	ssh.privateKeyFile	Specifies the absolute path of the private key file if public key authentication is used for SSH connections.	Character string of 0-255 characters	" " (null character)
Remote command	plugin.remoteCommand.executionDirectory.wmi	If the OS of the operation target device is Windows, this property specifies the path to the execution directory used to execute a content plug-in. Note that the execution directory must be created in advance. If the execution mode of the content plug-in is Script, make sure that the total length (character count) of the value specified here and the script file name does not exceed 140 characters. If the total length exceeds 140 characters, forwarding of the script file might fail. We recommend that the value specified here is 50 or less characters because the script file name is specified using 90 or less characters.	Character string of 0-128 characters	" " (null character)
	plugin.remoteCommand.executionDirectory.ssh	If the OS of the operation target device is UNIX, this property specifies the path to the execution directory used to execute a content plug-in. Note that the execution directory must be created in advance.	Character string of 0-128 characters	" " (null character)
	plugin.remoteCommand.workDirectory.ssh^#2	If the OS of the operation target device is UNIX, this property specifies a work folder^#3 used to execute file-forwarding plug-ins and content plug-ins. Enter a folder or symbolic link, using an absolute path of 1-128 characters. Symbolic links can be included in a layer of paths.	Single-byte alphanumeric characters, and the following symbols: / (used as a path separator), -, _, .	/tmp/Hitachi_AO
Retry remote host connection	ssh.connect.retry.times	Specifies the number of retries, in the event of a failed SSH connection to the operation target device.	0-100	3
	ssh.connect.retry.interval	Specifies the interval (seconds) between retries, in the event of a failed SSH connection to the operation target device.	1-600	10
	wmi.connect.retry.times	Specifies the number of retries, in the event of a failed WMI connection to the operation target device.	0-100	3
	wmi.connect.retry.interval	Specifies the interval (seconds) between retries, in the event of a failed WMI connection to the operation target device.	1-600	10
	telnet.connect.retry.times	Specifies the number of retries, in the event of a failed Telnet connection to the operation target device.	0-100	3
	telnet.connect.retry.interval	Specifies the interval (seconds) between retries, in the event of a failed Telnet connection to the operation target device.	1-600	10
Retry remote file operation	plugin.remoteFileAccess.retry.times	Specifies the number of retries for a file manipulation command executed internally by a content plug-in or file-forwarding plug-in. The retry interval is fixed at 100 ms. If a temporary file access error occurs, retrying the command might result in successful operation. However, if the file access error is not recovered, extra time is required for retries until the plug-in terminates. Specify this property in an environment in which file access errors occur even if there are no problems with disks.	0-100	0
Retry email sending	mail.notify.retry.times	Specifies the number of retries, in the event of a failure of the notification function to send an email.	0-100	3
	mail.notify.retry.interval	Specifies the interval (seconds) between retries, in the event of a failure of the notification function to send an email.	1-600	10
	mail.plugin.retry.times	Specifies the number of retries, in the event of a failure of the Email Notification Plug-in to send an email.	0-100	3
	mail.plugin.retry.interval	Specifies the interval (seconds) between retries, in the event of a failure of the Email Notification Plug-in to send an email.	1-600	10
Audit log	logger.Audit.enable	Specifies whether to output the audit log.	0: Do not output 1: Output	0
	logger.Audit.path	Specifies the output destination path of the audit log, using 1-244 bytes.	Single-byte alphanumeric characters, single-byte spaces, and the following symbols: !, #, $, &, (, ), +, ,, -, ., ;, =, @, [, ], ?, _, `, {, }, ~	`JP1/AO-installation-folder`\logs^#4
	logger.Audit.MaxBackupIndex	Specifies the maximum number of log backup files for the audit log.	1-16	7
	logger.Audit.MaxFileSize	Specifies the maximum log file size (KB) for the audit log.	4-2,097,151	1,024
	logger.Audit.command.useLoginUserID^#5	Specifies whether to output the JP1/AO login user ID, in place of the user ID, to the subject identification information for the audit log when a command is executed.	true: Output the JP1/AO login user ID to the subject identification information. false: Output the Windows user ID to the subject identification information.	false
Window refresh	client.events.refreshinterval	Specifies the refresh interval (seconds) for events.	0-65,535	5
Link&Launch function	linkandlaunch.hcs.enabled	Specifies whether to display links to the Hitachi Command Suite products in the Tools menu.	true: Display links. false: Do not display links.	false
Editor	client.editor.upload.maxfilesize	Specifies the maximum file size (MB) that can be specified when a file is uploaded by using the Editor window. The file size can be specified for each of the following files: Plug-in icon file Script file executed by a plug-in Plug-in resource file Service resource file Window custom file	1-10	3
	server.editor.step.perTemplate.maxnum^#6	Specifies the maximum number of steps per service template.	320-40,000^#7	320
	server.editor.step.perLayer.maxnum^#6	Specifies the maximum number of steps per layer.	80-10,000^#7	80
	client.editor.canvas.maxwidth^#6	Specifies the maximum width (unit: px) of the operational region in the Flow view. The estimate expression is as follows: Width (px) = (number-of-steps-to-be-deployed-horizontally + 1) x 90 (px)	3,600-10,000	3,600
	client.editor.canvas.maxhigh^#6	Specifies the maximum height (unit: px) of the operational region in the Flow view. The estimate expression is as follows: Height (px) = number-of-steps-to-be-deployed-vertically x 300 (px)	2,400-30,000	2,400
Debug	tasklist.debugger.autodelete.taskRemainingPeriod	Specifies the period (days) that debug tasks whose execution has terminated are retained in the debug task list.	1-90	7
	client.debugger.tasklog.maxfilesize	Specifies the size of task logs (KB) displayed in the Task Log tab.	4-10,240	1,024
	logger.debugger.TA.MaxFileSize	Specifies the maximum log file size (KB) for a debug task.	4-2,097,151	10,240
Task monitor	client.monitor.tasklog.maxfilesize	Specifies the size of task logs (KB) displayed in the Task Log dialog box.	4-10,240	1,024
	client.monitor.tasklog.refresh.interval	Specifies the automatic refresh interval (seconds) of the Task Log dialog box.	30-300	30
	client.monitor.status.interval	Specifies the automatic refresh interval (seconds) of the task monitor.	30-300	30

#1

The log output threshold for tasks can be set in the Service Share Properties.

#2

Do not specify the path specified for this property or its parent folder's path for the source or destination folder for a file-forwarding plug-in. If you specify such a folder, the property is not supported by the product.

#3

The work folder must have read, write, and execution permissions for the connected user.
If the path specified for the work folder does not exist when a file-forwarding plug-in or content plug-in is executed, a work folder is created during execution of the plug-in. The created work folder is assigned access permission 777 (that is, access permission is given to all users). If an attempt to create the work folder fails, execution of the plug-in terminates abnormally.

#4

The name of an output file is Audit[n].log, where an integer indicating the number of files is displayed in [n].

#5

The user ID to be output to the subject identification information for the audit log can be changed when one of the following commands is executed:

deleteservicetemplate command
importservicetemplate command
listservices command
listtasks command
stoptask command
submittask command

#6

These properties are defined to provide compatibility with JP1/AO 10-00.

#7

Edit these definitions only when all the conditions shown below exist. Note that the definitions must be edited before you duplicate or edit a service template.

You are going to edit a service template created in JP1/AO 10-00.
The total number of steps in the service template to be edited exceeds 320, or the number of steps per layer exceeds 80.

Example definitions

logger.sysloglevel = 0
logger.message.server.MaxBackupIndex = 7
logger.message.server.MaxFileSize = 1024
logger.message.command.MaxBackupIndex = 7
logger.message.command.MaxFileSize = 1024
logger.TA.MaxFileSize = 10240
task.ajs.IPBindhost = 
tasklist.autoarchive.taskRemainingPeriod = 7
tasklist.autoarchive.executeTime = 04:00:00
tasklist.autoarchive.maxTasks = 5000
tasklist.autodelete.maxHistories = 30000
task.details.jobnet.status.visible = false
packagemanager.extraPresets.maxFiles = 5
plugin.remoteCommand.workDirectory.ssh = /tmp/Hitachi_AO
notification.jp1event = true
foreach.max_value = 3
ssh.port.number = 22
telnet.port.number = 23
plugin.terminal.prompt.account = login|Login Name|Username|UserName
plugin.terminal.prompt.password = password|Password|PassWord
telnet.connect.wait = 60
ssh.connect.retry.times = 3
ssh.connect.retry.interval = 10
wmi.connect.retry.times = 3
wmi.connect.retry.interval = 10
telnet.connect.retry.times = 3
telnet.connect.retry.interval = 10
mail.notify.retry.times = 3
mail.notify.retry.interval = 10
mail.plugin.retry.times = 3
mail.plugin.retry.interval = 10
logger.Audit.enable = 0
logger.Audit.path = C:\\Program Files (x86)\\Hitachi\\JP1AO\\logs
logger.Audit.MaxBackupIndex = 7
logger.Audit.MaxFileSize = 1024
logger.Audit.command.useLoginUserID = false
client.events.refreshinterval = 5
linkandlaunch.hcs.enabled = false
client.editor.upload.maxfilesize = 3
server.editor.step.perTemplate.maxnum = 320
server.editor.step.perLayer.maxnum = 80
client.editor.canvas.maxwidth = 3600
client.editor.canvas.maxhigh = 2400
tasklist.debugger.autodelete.taskRemainingPeriod = 7
client.debugger.tasklog.maxfilesize = 1024
logger.debugger.TA.MaxFileSize = 10240
client.monitor.tasklog.maxfilesize = 1024
client.monitor.tasklog.refresh.interval = 30
client.monitor.status.interval = 30

Related topics

2.1 Procedure for setting the JP1/AO environment

To Page Top