4.2.10 Terminal disconnect plug-in
Function
This plug-in terminates a connection established with an operation target device by a terminal connect plug-in.
Prerequisites for execution
-
The plug-in uses the protocol specified in the protocol property of the terminal connect plug-in to communicate with the JP1/AO server. For details, see the description of the protocol property in 4.2.8 Terminal connect plug-in.
-
For details about operation target devices that can be used as connection destinations, see A.1(3) Operation target devices usable as connection destinations.
Cautionary note
-
If execution of a task is stopped during plug-in execution, the status of the task becomes Failed or Completed when the processing of the terminal disconnect plug-in has finished. The status of steps and tasks after plug-in execution has finished depends on the return code of the step and the condition for executing subsequent steps. You can set Subsequent-step Execution Condition in the Create Step dialog box or the Edit Step dialog box.
-
If you forcibly terminate a task during plug-in execution, reading from standard output and prompt detection are canceled and the task enters Failed status. The session and token are then discarded. In this case, a return code of 80 appears for the step in the Flow area of the Tasks window. The return code output to the task log depends on the timing with which the task was forcibly terminated.
Version
01.02.01
Tag
Terminal
Return codes
Return code |
Description |
---|---|
0 |
The plug-in ended normally. The plug-in ends normally even if the connection has already been closed. |
65 |
The connection with the JP1/AO server failed. For example, the JP1/AO server might have stopped while the plug-in was being executed. |
66 |
The following user is mapped to the JP1 user:
|
68 |
There is no information about the target job execution ID. |
69 |
An environment variable of the task-processing engine could not be acquired. |
80 |
Task execution has stopped. |
81 |
The plug-in was called in an invalid status. |
82 |
The request message from the task-processing engine could not be correctly parsed. |
83 |
The environment of the JP1/AO server is corrupted. |
84 |
Information about the specified plug-in could not be obtained. |
86 |
The specified property value is invalid. This includes situations in which the token input property is invalid. |
127 |
Another error has occurred. |
Property list
The following table describes the property.
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
---|---|---|---|---|---|
token |
Token |
Specify the value of the token property of the terminal connect plug-in. |
-- |
Input |
R |
Related topics