2.4.7 Setting for improving performance when outputting the user trace file

(1) Summary

A user trace file is a file output with a specified Target_File as the first argument of the Message command. As user trace files are controlled by a trace management file that maintains file names, write locations, and other such information, they inhibit script execution performance under the following circumstances:

• When creating a large number of user trace files with unique file names

  This causes the trace management file to grow in size, increasing the amount of time it takes to reference or update the trace management file.

• When executing many instances of the Message command at the same time

  This causes congestion in accessing the trace management file, resulting in wait times.

Enabling the setting to improve execution performance when outputting the user trace file excludes the user trace file from being managed by the trace management file and stops the trace management file from being accessed when outputting the user trace file. This setting helps to limit the increase in the trace management file size and improve script execution performance when performing operations involving the use of many Message commands (with a specified Target_File).

Changes in the specifications of the user trace file when enabling this setting are outlined in the following table.

Table 2‒4: User trace file specification changes

Item	When setting is disabled (Default)	When setting is enabled
Maximum number of lines in the user trace file	Log output is wrapped when the maximum number of lines is exceeded (content overwritten from the first line and output).	Log output is not wrapped when the maximum number of lines is exceeded (the maximum number of lines setting is ignored). This increases the size of the user trace file monotonically.
Behavior when the maximum number of lines or columns changes from the previous value when outputting to an existing user trace file	Recreates a new file, and outputs with the maximum number of lines and columns specified from the beginning of the file.	Outputs with the maximum number of columns specified from the end of the existing file.
Referencing the user trace file in the Trace Viewer	Possible. However, previous trace files cannot be referenced after the trace management file has been deleted.	Not possible.

To Page Top

(2) Settings procedure

Configure the following registry value settings to improve execution performance when outputting user trace files.

Registry key

HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Hitachi\JP1/Script\SPTX

Value name

UserTraceUnmanaged

Value datatype

REG_DWORD

Value

Specify whether to manage the user trace file with the trace management file.

0: Disable (Default)

Manage the user trace file with the trace management file (acts in the same way as versions earlier than 12-00-01).

1: Enable

This excludes the user trace file from being managed by the trace management file. The trace management file will not be accessed when executing the Message command to output the user trace file. This effectively limits trace management file size increases and improves script execution performance.

If a value is not set, or if any value other than the above is set, the default value of 0 will be used.

To reference the user trace file in the Trace Viewer, or repeatedly output to the same user trace file, set this value to 0.

To output to a different user trace file each time the Message command that is executed frequently is used, set this value to 1.

When the setting takes effect

The next time the script file is executed

Setting effective range

This setting applies to all scripts run on computers with this registry value setting.

Note that when calling scripts on other computers using the NetExec command, the settings applied on the called computer will be followed.

To Page Top

(3) Notes

The following notes apply to the use of the setting to improve execution performance when outputting user trace files (hereafter referred to as this setting).

• When changing this setting from disabled to enabled, it is recommended that you delete the trace management file. This is to improve script execution performance when outputting analysis trace files and execution trace files by removing unnecessary user trace file information contained within the trace management file. To delete the trace management file, first stop JP1/Script service, Script Launcher, Script Launcher service, and JP1/Script processes running.

• To confirm whether this setting has been correctly applied, check whether a user trace file output with a new file name appears in the Trace Viewer.

• When this setting is enabled, the user trace file cannot be referenced in the Trace Viewer. To reference the user trace file, reference it directly in a text editor.

• When this setting is enabled, the user trace file size will increase monotonically. When repeatedly outputting to the same user trace file, consider saving the user trace file in a different folder and deleting it on a regular basis.

• Output results are not guaranteed after changing this setting from enabled to disabled and outputting additional information to a user trace file that was initially output with this setting enabled (the contents of the file may become corrupted due to the inability to control the writing position). As such, when changing this setting from enabled to disabled and outputting to a user trace file in the same file path, make sure to either delete the relevant user trace file or save it to another location before outputting.

To Page Top