2.2.13 Overview of shared built-in service properties
Shared built-in service properties are properties that are defined in advance in the JP1/AO system. Unlike other properties, shared built-in service properties are not tied to a specific service or task. JP1/AO functions that reference shared built-in service properties use the value assigned to the property when they execute.
You can also define a shared built-in service property as a Service Share Property of a service, and reference it from within a task. Services can reference the values of these properties in the same manner as other Service Share Properties.
You can define a shared built-in service property as a Service Share Property of a service in the Edit Service Definition dialog box. When you click the Select Service Share Property button in the Edit Service Definition dialog box, a list of shared built-in service properties appears.
The following table lists the shared built-in service properties provided in JP1/AO:
|
No. |
Property key |
Property name# |
Description# |
|---|---|---|---|
|
1 |
com.hitachi.software.dna.sys.mail.notify |
Email notification |
Enables or disables the email notification functionality. (Built-in shared service property) |
|
2 |
com.hitachi.software.dna.sys.mail.smtp.server |
SMTP server address |
Specifies the SMTP server address. The address can be specified as an IPv4 or IPv6 address, or as a host name. Only one of the above can be specified. Multiple addresses cannot be specified by separating them with commas. (Built-in shared service property) |
|
3 |
com.hitachi.software.dna.sys.mail.smtp.port |
SMTP server port number |
Specifies the SMTP server port number. (Built-in shared service property) |
|
4 |
com.hitachi.software.dna.sys.mail.smtp.userid |
SMTP server user ID |
Specifies the user ID of the user who logs in to the SMTP server. (Built-in shared service property) |
|
5 |
com.hitachi.software.dna.sys.mail.smtp.password |
SMTP server password |
Specifies the password of the user who logs in to the SMTP server. (Built-in shared service property) |
|
6 |
com.hitachi.software.dna.sys.mail.from |
Notification email sender |
Specifies the sender of notification emails. (Built-in shared service property) |
|
7 |
com.hitachi.software.dna.sys.mail.to |
Notification email recipients (To) |
Specifies the "To" recipients of notification emails. Multiple email addresses can be specified by separating them with commas. (Built-in shared service property) |
|
8 |
com.hitachi.software.dna.sys.mail.cc |
Notification email recipients (Cc) |
Specifies the "Cc" recipients of notification emails. Multiple email addresses can be specified by separating them with commas. (Built-in shared service property) |
|
9 |
com.hitachi.software.dna.sys.mail.bcc |
Notification email recipients (Bcc) |
Specifies the "Bcc" recipients of notification emails. Multiple email addresses can be specified by separating them with commas. (Built-in shared service property) |
|
10 |
com.hitachi.software.dna.sys.jp1.username |
JP1 user name |
Specifies the name of the JP1 user who executes services. (Built-in shared service property) |
|
11 |
com.hitachi.software.dna.sys.jp1.password |
JP1 user password |
Specifies the password of the JP1 user who executes services. (Built-in shared service property) |
|
12 |
com.hitachi.software.dna.sys.task.log.level |
Task log output level |
Specifies the level of messages output to the task log. (Built-in shared service property) |
|
13 |
com.hitachi.software.dna.sys.ssh.privatekey.passphrase |
Pass phrase of the private key (for SSH public key authentication) |
Specifies the pass phrase of the private key used for SSH public key authentication. (Built-in shared service property) |
- #
-
You can change the contents of the Service Definition dialog box and the Submit Service dialog box by entering a property name and description of your choice for the built-in shared service property. However, you cannot change the information displayed in the Service Share Properties view from its initial state at installation.
The following table shows detailed information about each property:
|
No. |
Property key |
Data type |
Default value |
Required? |
Length |
Specifiable characters |
Values in list |
|
|---|---|---|---|---|---|---|---|---|
|
Minimum |
Maximum |
|||||||
|
1 |
com.hitachi.software.dna.sys.mail.notify |
boolean |
false |
true |
-- |
-- |
-- |
-- |
|
2 |
com.hitachi.software.dna.sys.mail.smtp.server |
string |
-- |
false |
0 |
255 |
No restrictions |
-- |
|
3 |
com.hitachi.software.dna.sys.mail.smtp.port |
integer |
25 |
false |
-- |
-- |
-- |
-- |
|
4 |
com.hitachi.software.dna.sys.mail.smtp.userid |
string |
-- |
false |
0 |
255 |
No restrictions |
-- |
|
5 |
com.hitachi.software.dna.sys.mail.smtp.password |
password |
-- |
false |
0 |
1,024 |
No restrictions |
-- |
|
6 |
com.hitachi.software.dna.sys.mail.from |
string |
-- |
false |
0 |
255 |
No restrictions |
-- |
|
7 |
com.hitachi.software.dna.sys.mail.to |
string |
-- |
false |
0 |
255 |
No restrictions |
-- |
|
8 |
com.hitachi.software.dna.sys.mail.cc |
string |
-- |
false |
0 |
255 |
No restrictions |
-- |
|
9 |
com.hitachi.software.dna.sys.mail.bcc |
string |
-- |
false |
0 |
255 |
No restrictions |
-- |
|
10 |
com.hitachi.software.dna.sys.jp1.username |
string |
Value specified by user at installation |
true |
1 |
31 |
^[ a-z A-Z 0-9 !#\$%&\-\.@_`~]+$ |
-- |
|
11 |
com.hitachi.software.dna.sys.jp1.password |
password |
Value specified by user at installation |
true |
6 |
32 |
^[a-z A-Z 0-9 !#\$%&'\(\)\*\+,\-\.\/;<=>\?@\[\]\^_`\{\|\}~]+$ |
-- |
|
12 |
com.hitachi.software.dna.sys.task.log.level |
list |
10 |
true |
-- |
-- |
-- |
0,10,20,30,40 |
|
13 |
com.hitachi.software.dna.sys.ssh.privatekey.passphrase |
password |
-- |
false |
0 |
1,024 |
No restrictions |
-- |
- Legend:
-
--: Not applicable.