Top
Systemwalker Runbook Automation Reference Guide
Systemwalker

3.4.24 Convert file character encoding

Description

This operation components converts the character code in files.

Options

Basic Options

(1) searchfile

Name (full path) of the file for which the character code is to be converted.

An argument error occurs if the file name is omitted.

The maximum length of the file name is 1,024 characters. An argument error occurs if this is exceeded.

(2) character_encoding

Character code after conversion.

Specify the character-code as follows. This option is not case sensitive.

Character-code

UTF-8

UTF-16

SJIS

EUC

An argument error occurs if the content of the character-code other than the above is specified.

An argument error occurs if the content of the character-code is omitted.

(3) outputfile

Name (full path) of the file that will output the result convert character code.

An argument error occurs if specify the same file name as searchfile.

Specify the file setting the writing authority, if the existing file is specified for outputfile option. The action is not guaranteed if the file that is not setting the writing authority is specified.

The maximum length of the file name is 1,024 characters. An argument error occurs if this is exceeded.

Advanced Options

(1) from_encoding

Character code before conversion.

Specify the character-code as follows. This option is not case sensitive.

Character-code

UTF-8

UTF-16

SJIS

EUC

An argument error occurs if the content of the character-code other than the above is specified.

The character-code of the file is distinguished automatically if the content of the character-code is omitted.

Specify the character-code if understand the character-code because the automated discrimination is not complete.

(2) overwrite

If the file name being output already exists, specify "on" or "off" for overwrite. This option is not case sensitive.

If "on" is specified, it overwrites when the file already exists.

If "off" is specified, the error is returned when the file already exists.

If the specification is omitted, specify 'off'.

(3) timeout

This is the completion timeout (seconds) for the execution of operation components.

Values between 300 and 86400 (1 day) can be specified.

For example: When timeout is to occur every 10 minutes: 600

When the execution of the operation components is not completed even if the specified time passes, the processing of the operation components is interrupted in return value 201.

(4) retry

This is the retry count for the execution of operation components.

When the operation components end in return value 161, the retry count is specified. Values between 0 and 5 can be specified.

As a result of retrying, if the operation components ended by the return values other than 161, the execution of the operation components ends even if it doesn't reach the specified retry count. The return values of the operation components become the value executed at the end.

For example: When retries are to be performed twice: 2

(5) retry_interval

This is the retry interval (seconds) for operation components.

When the operation components end in return value 161, the retry interval is specified. Values between 1 and 14400 can be specified.

For example: When retrying in 300 seconds: 300


If the specification of the timeout, retry and retry_interval is omitted, and a value beyond the limits of the above-mentioned is input, the value specified with the operation components definition file becomes effective. Refer to "2.5 Definition File for Operation Components" for details.

Return Values

Icon

Name

Return value

Description

Success

0

Character-code conversion of the file was successful.

Failure

161

Failed to convert the character-code of the file. Retried if a retry count has been specified.

177

Failed to access the file.

197

There is an error in the input information.

198

There is an error in the option content.

200

Character-code conversion of the file terminated abnormally.

-

-

201

Execution of operation component timed out.

202

The operation component was not executed. There is a problem in the setting to execute operation components.

203

Failed to execute the operation component. There is a problem in the Operation Automation Server environment.

205

The operation components were not executed. There is a problem in the specification of the input information of the operation components.

206

The operation components were not able to be executed normally. There is a problem in the specification of the output information of the operation components.

207

The operation components were not executed. There is a possibility that the operation components are not registered in the Management Server.

208

The Automated Operation Process has been canceled because the Automated Operation Process was recovered while the operation component was executing.

Output information

Variable

Description

message

This variable will be set to the following message if the character encoding for the file is converted successfully.

The operation component was successful.

If converting the character encoding for the file fails, the content of the error will be output as a string.

returnCode

This variable is set to the return value.

Notes