4.16.2 Format of property files in key=value format
The format of a property file in key=value format is described below.
Enter properties in the format property-key=property value (line feed).
To specify a property without a property value, use the format property-key = (line feed).
UTF-8 must be used as the character encoding.
Each pair of a property key and the corresponding property value must occupy its own line in the file. Do not specify a line feed anywhere except at the end of a line.
On each line in the property file, the segment from the first character to the character before the equals sign is treated as the property key. The segment from the character after the equals sign to the end of the line is treated as the property value.
If a character string contains the character \, specify it as \ in the file.
You must specify a line feed at the end of each line that defines a property. You can use CR+LF or LF as the line feed.
Lines that start with a # character or do not contain an equal sign are treated as comments.
Properties and values are case sensitive.
Empty lines are ignored.
You do not need to specify a line feed at the end of the file.
The delimiting character used between property values depends on the service template on which the service is based.
In a property file, only specify the properties for which you want to set property values. Properties that are not present in a property file you import retain their existing values.
Make sure that the number of properties defined in a property file does not exceed the limit specified in the user-specified properties file (config_user.properties).
You can use any file extension except .json.
The property file can contain properties in the key@FILE=file-path and key=value formats.
The table below shows how the import process is affected when invalid items are defined in a property file in key=value format. Potential outcomes when you import a property file that contains invalid definitions include errors, and property values not being applied correctly.
Item with invalid definition |
Imported from Service Definition window or Submit Service dialog box |
Imported from Service Builder Debug window |
Imported using submittask command |
---|---|---|---|
The number of properties defined in the property file exceeds the limit specified in the user-specified properties file (config_user.properties) |
A |
A |
E |
A property defined in the file does not exist in the service |
S |
S |
E#1 |
The same property key is defined more than once |
A#2 |
A#2 |
E |
A value is specified that is not appropriate for a property (the value has the wrong data type or violates restrictions for the property) |
A#3 |
A |
E |
A line does not contain an equals sign (=) |
S |
S |
S |
- Legend:
A: The property value is applied. S: Processing is skipped without applying the property value. E: An error occurs.
- #1
An error occurs when you attempt to import a property whose visibility setting is Edit Window Only.
- #2
When the same property key is defined multiple times, the definition that appears last in the file takes effect.
- #3
If a value that cannot be set from the user interface is defined for a property whose data type is list or boolean, an empty value is applied to the property.