2.1.1 Samples of Operational Content

(a) Separator line (line.png)

Example of using the image in the samples of Operational Content:

This image is used to separate general descriptions from detailed descriptions, so as to make the explanatory text easy to read.

Example of application:

You can use this image also as an underline to emphasize headings and important sections of the text.

(b) Background (background.png)

Example of using the image in the samples of Operational Content:

This image is used to make explanatory text easy to read (by giving the text a colored background).

(c) Triangular icon (icon_branch.png)

Example of using the image in the samples of Operational Content:

This image is used to indicate a branch condition.

Example of application:

You can use this image also as icons for the items in a list.

(d) Balloon icon (icon_talk.gif)

Example of using the image in the samples of Operational Content:

This image is used to indicate contact information.

(e) Emphasis icon (icon_point.gif)

Example of using the image in the samples of Operational Content:

This image is used to indicate a point to be checked.

(f) File icon (icon_doc.gif)

Example of using the image in the samples of Operational Content:

This image is used to indicate a system or document.

(g) Heading icon (icon_button.png)

Example of using the image in the samples of Operational Content:

This image is used to indicate items other than contact information and the point to be checked.

Example of application:

You can use this image also as icons for the items in a list.

(h) Balloon (balloon1.png and balloon2.png)

Example of using the images in the samples of Operational Content:

The two images are combined to form a balloon that is used to make the tips on Operational Content creating stand out.

Example of application:

You can also use the balloon1.png image alone as a background image.

(a) Character string concatenation sample content

This sample content concatenates parameter input strings and outputs them to connected Guide Parts.

Input parameter

InputData1 to InputData10: Concatenated string input parameters

Output parameter

Output: Concatenated string output parameter

Usage

This sample content concatenates strings input in the input parameters of the StringConcat JavaScript Plugin when transitioning between windows, and outputs them to the Guide Part connected to the output parameter.

In this explanation, the guide window for string input prior to the screen transition is referred to as window A, and the guide window for outputting the concatenated strings after the screen transition is referred to as window B.

Editor operations

1. If necessary, copy and paste the StringConcat JavaScript Plugin on window A into your Operational Content.

2. If necessary, copy and paste the Guide Part connected to the StringConcat JavaScript Plugin input parameter on window A into your Operational Content. Alternatively, select a Guide Part.

3. Connect the Guide Part with the input parameter.

4. If necessary, copy and paste the StringConcat JavaScript Plugin on window B into your Operational Content.

5. Similarly, copy and paste the Guide Part connected to the StringConcat JavaScript Plugin input parameter on window B into your Operational Content. Alternatively, select a Guide Part.

6. Connect the Guide Part with the output parameter.

7. If necessary, add the StringConcat JavaScript Plugin input parameter. When adding, edit the StringConcat JavaScript Plugin source code.

   Example: When adding InputData11 to the input parameter, add InputData11 to the part of the source code where InputData1 to InputData10 are concatenated.

   var sumStr = InputData1 + InputData2 + InputData3 + InputData4 + InputData5 + InputData6 + InputData7 + InputData8 + InputData9 + InputData10 + InputData11;

Operator tasks

1. Execute the Operational Content, and enter the string on window A.

2. Transition to window B.

3. The concatenated string will be output on window B. Use this string by copying and pasting it into an email, or another such application.

Error list

When provided, this sample content does not display error messages.

Restrictions

• Editing the StringConcat JavaScript Plugin source code in a manner other than that described here has not been tested to work.

• StringConcat JavaScript Plugin input parameters do not accept ASCII codes 0x00 to 0x08, 0x0B to 0x0C, and 0x0E to 0x1F.

(b) Command execution sample content

This sample content is used to verify standard output, standard error output, return values, and other results of commands executed on the Navigation Platform server.

Input parameter

The following table shows the input parameters of the CommandExec JavaScript Plugin.

Parameter name	Parameter description	Part connection	Available values
commandName	Parameter for entering the command name	Required	Environmental variables cannot be specified.
arg1 to arg10#	Parameter for entering the command arguments	Optional	No restrictions.
syncOption	Parameter for switching between synchronous and asynchronous execution	Required	To use synchronous execution, specify the character string true in single-byte lower case letters.
encoding	Parameter for specifying the encoding for standard output and standard error output acquisition	Required	Either Shift-JIS or UTF-8
timeOutSec	Parameter for specifying the timeout duration when executing synchronous commands (Unit used for timeout duration: Seconds)	Optional	Either of the following: - Not specified - A number equal to or greater than 0 If not specified, or set to a number lower than 0, Navigation Platform will wait until the command execution completes without timing out commands. If a timeout value is not set, or is set to a large value, Navigation Platform may become unresponsive if commands take a long time to execute.

#: When adding parameters, add in order, such as arg11, arg12...

Output parameter

The following table shows the output parameters of the CommandExec JavaScript Plugin.

Parameter name	Parameter description
standardOutput	The standard output parameter
standardErrorOutput	The standard error output parameter
returnCode	The return value output parameter
errMessage	The parameter for outputting error occurrence and conditions, and troubleshooting measures when an error occurs
stackTrace	The parameter for outputting a stack trace when an error occurs

Usage

In this sample content, the CommandExec JavaScript Plugin executes commands when a screen transition occurs.

In this explanation, the guide window for entering commands, arguments, synchronous execution options, encoding for standard output and standard error output acquisition, and the timeout duration for synchronous execution prior to the screen transition is referred to as window A, and the guide window for outputting the execution results after the screen transition is referred to as window B.

Editor operations

1. Copy and paste the CommandExec JavaScript Plugin on window A into your Operational Content.

2. If necessary, copy and paste the Guide Part connected to the CommandExec JavaScript Plugin input parameter on window A into your Operational Content. Alternatively, select a Guide Part.

3. Connect the commandName, arg, syncOption, encoding, and timeOutSec input parameters with a Guide Part. If necessary, set the default values for the Guide Parts connected to the syncOption, encoding, and timeOutSec input parameters.

4. Copy and paste the CommandExec JavaScript Plugin on window B into your Operational Content.

5. If necessary, copy and paste the Guide Part connected to the CommandExec JavaScript Plugin output parameter on window B into your Operational Content. Alternatively, select a Guide Part.

6. Connect the standardOutput, standardErrorOutput, returnCode, errMessage, and stackTrace output parameters to a Guide Part.

7. If necessary, add the input parameters (arg1 to arg10) for entering the command arguments for the CommandExec JavaScript Plugin. When adding, also add the command argument array element in the CommandExec JavaScript Plugin source code.

   Example: When adding arg11 to the input parameters, add it within the inputValuesArray brackets ([]), separating the parameters with a single-byte comma (,).

   // To increase the number of input parameters, add them to the following array element.

   var inputValuesArray = [arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11];

Operator tasks

1. Execute the Operational Content, and enter commands and strings on window A.

2. Proceed to window B.

3. When synchronous execution is not in use, the command execution results will not be displayed on window B. If the editor has configured the Operational Content so that command execution results can be output on window B, and an error does not occur during synchronous command execution, the execution results will be output to window B. If the editor has configured the Operational Content so that command execution results can be output on window B, and an error occurs during synchronous command execution, the execution results will still be output to window B.

Error list

No.	Cause	Message	Screen transition	Countermeasure
1	An error occurred during command execution.	Error: Command failed to execute because the sub-process could not be created.	Yes	Respond according to the exception details provided.
2	An I/O error occurred during command execution.	Error: Command failed to execute because an I/O error occurred.	Yes	Respond according to the exception details provided.
3	An invalid command (commandName) was executed.	Error: Invalid command string.	Yes	Respond according to the exception details provided.
4	An error occurred during command execution because the command executed does not exist.	Error: Command string not found.	Yes	Respond according to the exception details provided.
5	The command name (commandName) was left blank.	Error: The command name cannot be omitted. Enter the command name.	No	Enter the command name, and try executing the command again.
6	Command execution did not complete within the allotted timeout duration (timeoutSec).	Error: Command execution did not complete within the allotted timeout duration.	Yes	Change the specified timeout duration, and try again.
7	An unsupported encoding setting (encoding) was specified for standard output and standard error output acquisition.	Error: An unsupported encoding setting was specified for standard output and standard error output acquisition.	No	Specify either Shift-JIS or UTF-8, and try again.
8	An I/O error occurred during standard output and standard error output acquisition.	Error: Failed to acquire standard output and standard error output.	Yes	Respond according to the exception details provided.
9	An error occurred while acquiring standard output and standard error output.	Error: A thread interrupt occurred while acquiring standard output and standard error output.	Yes	Respond according to the exception details provided.
10	Failed to acquire return value.	Error: Failed to acquire the return value.	Yes	Respond according to the exception details provided.

Restrictions

• Specify one argument for each input parameter. Do not specify multiple arguments for a single input parameter by separating them with spaces, or "".

• Do not use environmental variables in executed commands.

• The JavaScript Plugin source code for executed commands only permits changes to the number of elements in inputValuesArray, which is used to store input values from the input parameter.

• Only Shift-JIS and UTF-8 can be specified as the character encoding when reading standard output and standard errors. Other character encoding formats have not been tested.

• Outputting standard output and standard errors to a binary file is not recommended as the output character strings may be corrupted.

• When the size of standard output and standard error output exceeds 6 MB, a runtime error or a display error may occur. In addition, when using a text box as the output destination part, standard output and standard error strings may not be displayed properly in the text box if the standard output or standard error output size exceeds 4 MB.

(c) File upload sample content

This sample content is used to upload files or clipboard images to the parameter-specified path when executing.

Input parameter

- parentDir

Type: String

Content: Upload destination folder. The %environmental-variable% part will be converted to the environmental variable value.

- fileHtmlPart

Type: HTML part

Content: HTML parts with the following elements.

• Hyperlink to /ucnp/template/sampleFileUploader.html: For displaying the file upload page

• <input type="text" name="fileName"> element: For storing the file name

  If the fileName element is invalid (when including \ or /) when executing content, an Invalid filename. error will occur, and the part connected to fileHtmlPart will be highlighted in a red frame.

• <textarea name="fileContent" style="display:none" /> element: For storing file content

  If a file is not specified by the fileContent element when executing content, a No file is specified. error will occur. If data is invalid, an Invalid content. error will occur. In addition, the part connected to fileHtmlPart will be highlighted in a red frame.

- errorMessage

Type: String

Content: The default error message.

Output parameter

- uploadPath

Type: String

Content: The upload destination folder with %environmental-variable% converted to the environmental variable value.

- fileName

Type: String

Content: The name of the uploaded file. When pasting an image, the file name will be pastedimage0.extension. The extension is the character string following the image/ element set as the image mediatype.

Example: For image/png: The extension is png.

Example: For image/gif: The extension is gif.

- errorMessage

Type: String or exception object

Content: If an error or exception does not occur, the input parameter errorMessage value is output. If an exception occurs, the exception object is output.

Usage

With this sample content, a file is uploaded during screen transitions.

In this explanation, the guide window prior to the screen transition is referred to as window A, and the guide window after the screen transition is referred to as window B.

Editor operations

1. If necessary, copy and paste the FileUpload JavaScript Plugin on window A into your Operational Content.

2. If necessary, copy and paste connected Guide Parts in window A into your Operational Content.

3. Connect Guide Parts with the upload destination folder string specified to the parentDir input parameter.

4. Connect HTML parts containing the element specified in the fileHtmlPart input parameter.

5. If necessary, copy and paste the FileUpload JavaScript Plugin on window B into your Operational Content.

6. Similarly, copy and paste the Guide Part connected to the FileUpload JavaScript Plugin output parameter on window B into your Operational Content.

7. Connect the output destination Guide Part to output parameters uploadPath, fileName, and errmsg.

Operator tasks

1. Execute the Operational Content, and click the hyperlink on window A to open the File Upload window.

2. On the File Upload window, either select the file to upload, or paste an image.

3. Return in window A, and then click the Next button to proceed to window B.

4. The file will be uploaded, and will appear on window B.

Error list

No.	Cause	Message	Screen transition	Countermeasure
1	The fileName element value in fileHtmlPart is invalid.	Invalid fileName.	No	This is caused by an incorrect operation. Restart the upload process.
2	The fileContent element value in fileHtmlPart has not been specified.	No file is specified.	No	This occurs when the Next button is clicked without selecting a file from the File Upload window. Restart the upload process.
3	The fileContent element value in fileHtmlPart is invalid.	Invalid content.	No	This is caused by an incorrect operation. Restart the upload process.
4	An exception occurred during the file upload process.	Exception content	Yes	Respond according to the exception details provided.

Restrictions

• Uploading clipboard images is only supported in Microsoft Edge and Google Chrome.

• Do not change the Do not modify. #NP comment part of the File Upload window HTML code.

• As this sample allows operators to freely upload files, it is hidden under the design templates folder by default after the setup process is complete.

• Files up to 10 MB in size can be uploaded with this sample.