9.3.1 Common specifications

1

Error

E

Need to manage by representation user or system administrator.

Processing of the data transfer command cannot be continued because of the following cause.

• The problem of execution environment such as network environment.

• The problem of the input parameter of the data transfer command.

This failure is required to manage by representation user. Management by a system administrator may be required. In this case, the return code 16 or 8 is outputted to log files.

Yes

2

Warn

W

Temporary failures

When you execute the data transfer command, the abnormal event has occurred. Processing of the data transfer command is continued. In this case, the return code 4 is outputted to log files.

Alternative

3

Info

I

Usual events

This log level indicates processing is executing normally.

No

1

File format

Text format

2

Character code

UTF-8

3

Newline code

CR+LF

1

Date

10

yyyy/MM/dd

• yyyy : 4 figures of A.D.

• MM : 2figures of month

• dd : 2figures of day

2

Delimiter

1

T

3

Time

12

HH:mm:ss.SSS

• HH : 2figures of time (24hours)

• mm : minute

• ss : second

• SSS : millisecond

In addition, the output time is the time of client.

4

Version

8

02-07

Left-justification, and right-hand side is filled up with space.

5

Log level

5

Log level. This is left-justification. For more information, refer to 9.3.1(4) (a) Log level.

6

Message ID

10

ID to specify the messages.

XXXXYYYY_Z

• XXXX : Product code

• YYYY : Message number

• Z : ID of the log level (I : Info, W : Warn, E : Error)

7

Message text

Variable length

The contents of message

Newline may be included when it includes the stack trace information on Java.

1

File format

XML format

2

Character code

UTF-8

3

Newline code

CR+LF

1

Connection server URL

serverUrl

Specify URL of the connection server.

(Example) https://jp1dh-hitachi.co.jp/

N/A

2

User ID

userId

Specify the User ID for login to the connection server.

When you specify "Login by Certification" as Authentication method, you can omit to specify this setting item. When you specify "Login by Password" as Authentication method, you must specify this setting item.

(Example) user@company

N/A

3

Password

password

Specify the Password for login to the connection server.

Authentication system of the login user appoints a password registered with a directory server of the connection at the time of "LDAP authentication system".

When you specify "Login by Certification" as Authentication method, you can omit to specify this setting item. When you specify "Login by Password" as Authentication method, you must specify this setting item.

Specify the password character string^#1 by plain text, or specify the digest^#2 of the password character string by the hexadecimal format. Use "LDAP authentication" for authentication system, cannot appoint the digest form.

Example of the specification in plain text : password

When you specify this setting item by the digest, the digest character string of 40 characters is filled in after "text:HEX:". The digest character string portion does not have distinction of a capital letter and a small letter.

The digest can be specified what is displayed on the password area at exporting.

Example of the specification in the digest : text:HEX:5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8

In addition, you cannot specify the character string which starts in "text:HEX:" as the password character string of plain text.

(Example) password

N/A

4

Authentication method

authenticationMethod

Specify the authentication method. When you omit to specify this setting item, "Login by Password" is applied.

• PASSWORD : Login by Password

• CERTIFICATION : Login by Certification

PASSWORD

5

Path of the certificate file

certificatePath

Specify the path of the certificate file with an absolute path. When you specify "Login by Password" as Authentication method, you can omit to specify this setting item. When you specify "Login by Certification" as Authentication method, you must specify this setting item.

N/A

6

Password of the certificate file

certificatePassword

Specify the password of the certificate file.

When you specify "Login by Password" as Authentication method, you can omit to specify this setting item. When you specify "Login by Certification" as Authentication method, you must specify this setting item.

N/A

7

Proxy use flag

useProxy

Specify whether the command uses the proxy server.

• When the command uses the proxy server : true

• When the command does not use the proxy server : false

This setting item does not distinguish a capital letter and a small letter.

(Example) true

false

8

Hostname of the proxy server

proxyHost

Specify the hostname or IP address of the proxy server.

(Example1) Proxyserver

(Example2) 192.168.0.1

N/A

9

Port number of the proxy server

proxyPort

Specify the port number of the proxy server. This item can be specified with the range of 0 to 65535.

(Example) 3128

N/A

10

Authentication ID of the proxy

proxyId

Specify the Authentication ID of the proxy server.

(Example) user

N/A

11

Authentication password of the proxy

proxyPassword

Specify the Authentication password of the proxy server.

(Example) password

N/A

12

Need of command-error email notifications

errorNotice

Specify whether to send an email notification of an error when it occurs during command execution.

To enable notifications: true

To disable notifications: false

This item is not case-sensitive. If you specify a value other than specifiable values, an error occurs. If the item itself is omitted, it is set to false.

If more than one tag is present, the value in the last tag will be effective.

(Example) true

false

13

Message subject of command-error email notifications

errorMailSubject

Specify the message subject of command-error email notifications with no more than 128 characters.

If you specify a value for this item, the subject of notifications is created with a product name added to the specified subject value.

If this tag is omitted, the system's default message subject is used to send error notification messages.

You can use characters that are available for message subjects in general.

Note that if the subject contains any &, <, or > characters, you must enter them in the form of XML escape characters, as listed in Table 9-10. If you specify a value other than specifiable values, an error occurs.

If more than one tag is present, the value in the last tag will be effective.

N/A

14

Message body of command-error email notifications^#3

errorMailMessage

Specify the message body of command-error email notifications with no more than 512 characters.

If this tag is omitted, the system sends error notification messages with no body text.

You can use characters that are available for the message body in general.

Note that if the message body contains any &, <, or > characters, you must enter them in the form of XML escape characters, as listed in Table 9-10. If you specify a value other than specifiable values, an error occurs.

If more than one tag is present, the value in the last tag will be effective.

N/A

15

Need of error notification messages to senders or recipients of delivery

notificationToCompanion

Specify whether to send error notification messages upon command execution to recipient users of delivery for sending errors, or to sender users for reception errors.

Note that this tag is not for data transfer management commands.

• To enable notifications: true

• To disable notifications: false

This item is not case-sensitive. If you specify a value other than specifiable values, an error occurs. If the item itself is omitted, it is set to false.

If more than one tag is present, the value in the last tag will be effective.

(Example) true

N/A

1

<

&lt;

2

>

&gt;

3

&

&amp;

4

"

&quot;

5

'

&apos;