8.3.6 Command property file (property.xml)

The command property file is an XML file where information such as the user IDs and passwords for the users is written. Specify this file as an argument when executing a command. A password string is written as-is. Make an appropriate security setting for it such as setting access privileges. The following table describes the specifications for the command property file.

Table 8‒6: Command property file specifications
No.	Item	Format or value
1	File format	XML format
2	Character code	UTF-8
3	Line feed	CR`+`LF

Use the following format to write code in the command property file:

<?xml version="1.0" encoding="utf-8" ?>
<property>
    <serverUrl>value</serverUrl>
    <userId>value</userId>
    <password>value</password>
    <authenticationMethod>value</authenticationMethod>
    <certificatePath>value</certficatePath>
    <certificatePassword>value</certificatePassword>
    <useProxy>value</useProxy>
    <proxyHost>value</proxyHost>
    <proxyPort>value</proxyPort>
    <proxyId>value</proxyId>
    <proxyPassword>value</proxyPassword>
    <errorNotice>value</errorNotice>
    <errorMailSubject><![CDATA[value]]></errorMailSubject>
    <errorMailMessage><![CDATA[value]]></errorMailMessage>
    <notificationToCompanion>value</notificationToCompanion>
</property >

The following table describes the setting items.

Table 8‒7: Command property file setting items
No.	Setting item	Element name	Description	Initial value
1	URL of the server to connect to	`serverUrl`	Specify the URL of the server to connect to. Example: `https://jp1dh. hitachi.co.jp/`	None
2	User ID	`userId`	Specify the login user ID for the server to connect to. For electronic certificate authentication, you can omit specifying a value. For standard password authentication, you must always specify this item. Example: `user@company`	None
3	User password	`password`	Specify the login user password for the server to connect to. For the LDAP authentication system, specify the password that is stored in the directory server to connect to. For electronic certificate authentication, you can omit specifying a value. For standard password authentication, you must always specify this item. Specify the password character string^#1 in plain text, or specify the digest^#2 of the password character string in hexadecimal format. When the LDAP authentication system is used, you cannot specify the digest form. Example of the specification in plain text: `password` When you specify this setting item in digest form, type the digest character string of 40 characters after `text:HEX:`. The digest character string itself is not case sensitive. You can specify as the digest what is displayed in the password field during export. Example of the specification in the digest: `text:HEX:5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8` In addition, you cannot specify the character string which starts with `text:HEX:` as the password character string of plain text. Example: `password`	None
4	Authentication method	`authenticationMethod`	Specify the authentication method. If you omit specifying a value, operation is performed based on standard password authentication. `PASSWORD`: Standard password authentication `CERTIFICATION`: Certificate authentication	`PASSWORD`
5	Path of the certificate file	`certificatePath`	Specify the path to the certificate file in absolute path format. You can omit specifying a value when using the standard password authentication as the authentication method. To use the electronic certificate authentication, you must always specify this item.	None
6	Certificate file password	`certificatePassword`	Specify the password for the certificate file. You can omit specifying a value when using the standard password authentication as the authentication method. To use the electronic certificate authentication, you must always specify this item.	None
7	Proxy use flag	`useProxy`	Specify whether to use a proxy server. To use a proxy server: `true` Not to use a proxy server: `false` This setting is not case-sensitive. If you specify a value other than specifiable values, an error occurs. Example: `true`	`false`
8	Proxy server host name	`proxyHost`	Specify the host name or IP address of the proxy server. Example 1: `Proxyserver` Example 2: `192.168.0.1`	None
9	Proxy server port number	`proxyPort`	Specify the port number of the proxy server. You can specify a value in the range from `0` to `65535`. Example: `3128`	None
10	Proxy authentication ID	`proxyId`	Specify the authentication ID of the proxy server. Example: `user`	None
11	Proxy authentication password	`proxyPassword`	Specify the authentication password for the proxy server. Example: `password`	None
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 8-8. 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.	None
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 8-8. 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.	None
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`	None

#1

You can use alphanumeric characters and symbols in a given length as defined by authentication rules.

You can use the following symbols: !"#$%&'()*+,-./:;<=>?@{\}^_`{|}~.

#2

Digest authentication is a method that JP1/DH - Server uses to store a password in the database. When this method is used, the actual password string cannot be restored from the value output for digest authentication. Password information is output in the form of digest to the password item in an exported CSV file.

#3

An error notification message looks like as follows:

JP1/DH - Server
--------------------------------------------------------------------
Command error notification
--------------------------------------------------------------------
A command error occurred.
Executed by: name-of-the-user-who-executed-the-command (email-address-of-this-user)
Command type: type-of-the-command
message-body-specified-by-the-user
Note: This is an auto-generated message. Please do not reply to this message.
                                                        JP1/DH - Server

Most portions of the notification, except for the message body specified by the user, are based on the language set for the user who executed command (in Japanese, English, or Chinese).

Enter values according to the XML conventions. Specifically, be careful when using special symbols in XML. To use any of the following characters, either replace them with their corresponding entity reference (escape characters) or use a CDATA section. In addition, save the command property file in UTF-8 encoding. If the file is encoded in a different character set, the system may fail to read it.

Table 8‒8: XML escape characters
No.	Character	Entity-referenced notations
1	<	`<`
2	>	`>`
3	&	`&`
4	"	`"`
5	'	`'`

Note that a control character such as line feed might be displayed as an entity that follows the XML standards. For XML attributes, the order of appearance is irregular in accordance with the XML standards.

Data indicating date and time is expressed as YYYY-MM-DDThh:mm:ssTDZ in W3C-DTF format in accordance with ISO8601:2004. The time zone (TDZ) is based on the offset time according to the OS time zone. For Japan, it is +09:00.

A setting example is shown below.

<?xml version="1.0" encoding="utf-8" ?>
<property>
    <serverUrl>https://jp1dh.hitachi.co.jp/</serverUrl>
    <userId>user@company</userId>
    <password>password</password>
    <authenticationMethod>PASSWORD</authenticationMethod>
            ...
            ...
    <useProxy>true</useProxy>
    <proxyHost>proxyserver</proxyHost>
    <proxyPort>8080</proxyPort>
    <proxyId>proxyid</proxyId>
    <proxyPassword>proxypassword</proxyPassword>
    <errorNotice>true</errorNotice>
    <errorMailSubject><![CDATA[Error notification]]></errorMailSubject>
    <errorMailMessage><![CDATA[Check the command that caused the error.]]></errorMailMessage>
    <notificationToCompanion>true</notificationToCompanion>
</property >

To Page Top