4.14.1 Notifications by TELstaff
Function
This plug-in implements notification by TELstaff on an execution-target Windows server.
This plug-in assumes the following server:
- Execution-target server
The execution-target server refers to the server on which this plug-in is executed.
The script in this plug-in executes the following processing:
- The script runs the following command:
teldial
-ni <network-ID> ' TELstaff.contactNetworkID property
[-fm <email-notification-text-file>] ' TELstaff.notificationFileMail property
[-fv <telephone-notification-text-file>] ' TELstaff.notificationFileVoice property
[-u <user-added-information>] ' TELstaff.UserInformation property
The teldial command does not output any data to the standard output or standard error output. Also, the return code output by the teldial command does not indicate whether a notification has succeeded, but only indicates whether the command has been accepted.
Therefore, to check whether a notification has succeeded, you must use the log viewer of TELstaff or another method.
If the teldial command is executed continually, the command might return a non-zero value because of the calling restriction function of TELstaff. Because this plug-in does not reference the value returned by the teldial command, no error is caused by the calling restriction function even when the teldial command is executed continually. To check how the calling restriction has been applied, use the log viewer of TELstaff.
For details about the teldial command, see the relevant manual for TELstaff.
Use situation
Use this plug-in when you need to notify system failures to the operator.
Prerequisites
For the latest support information about [Required product for the system]/[Required product for the system executing the service template]/[Prerequisite product OS running in the system executing the service template], see the Release Notes.
[Required product for the system]
- JP1/Automatic Operation 11-00 or later
[Required product for the system executing the service template]
- JP1/TELstaff 11-00 or later
[Prerequisite product OS running in the system executing the service template]
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
(4) Windows Server 2019 Standard/Datacenter
Cautions
(1) Do not use a character string that includes a double quotation mark (") or single quotation mark (') in a property of this plug-in.
(2) For other points to be noted, see the notes on the corresponding command in the relevant manual for TELstaff.
Execution privilege
The user must belong to the Administrators group.
Version
02.01.00
Plug-in tags
Control JP1,TELstaff,Windows
Plug-in name displayed in the task log
TELstaffDial
Return code
0: Normal
21: Error (invalid environment) Command cannot be found (error detected in the plug-in script)
41: Error (error detected in plug-in) Missing property (error detected in the plug-in script)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
TELstaff.contactNetworkID |
Network ID |
Specify a network ID defined by TELstaff. |
-- |
Input |
R |
|
TELstaff.notificationFileMail |
Email notification text file |
Specify the full path name of the email notification text file (containing the message text to be transmitted by email) on the execution-target server. If this parameter is omitted, the standard notification text file provided is used. |
-- |
Input |
O |
|
TELstaff.notificationFileVoice |
Telephone notification text file |
Specify the full path name of the telephone notification text file(containing the message text to be transmitted by telephone) on the execution-target server. If this parameter is omitted, the standard notification text file provided is used. |
-- |
Input |
O |
|
TELstaff.UserInformation |
User-added information |
The value specified in this parameter replaces the value of the UserInformation variable in the notification text file (message text to be transmitted as a notification). You can divide the information into multiple lines by using a semicolon (;). |
-- |
Input |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |