7.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 7‒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>
</property >

The following table describes the setting items.

Table 7‒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 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, by using a character string^#. For standard password authentication, you must always specify this item. Note that you cannot specify a string starting with `text:HEX` for the password. 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

#

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

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

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.

Table 7‒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>
</property >

To Page Top