status (connectors)

The "status" property is an optional string enum that sets or returns the running status of an input or output. It defaults to "active". It has the following values:

"active" means an input or output process is running and collecting or delivering data.

• Only a user activates a connector.
• The purpose is to start collecting or delivering data.
• The server sets "stopCode" to 0 and "stopReason" to "" unless OPC UA sets them to other values.

"connectorError" means an input or output process is running but not collecting or delivering data because of a connector error. 

• Only the FairCom connector sets the status to "connectorError". It does so when it cannot connect to the device.
• The server sets the "stopCode" and "stopReason" properties to the most appropriate OPC UA quality codes.
  • The server may enhance the OPC UA "stopReason" description to help the user fix the connection error.
• The server periodically attempts to resolve the problem and restart data collection or delivery.

"deviceError" means an input or output process is running but not collecting or delivering data because the protocol reported a device error.

• Only the protocol puts the connector in the device error state.
  • The protocol can only do this if the connector is successfully connected to the device.
• The purpose is to signal that a device has an issue. 
  • A device error supersedes a "connectorError" state because the device is communicating the cause of the error. 
• As of the 26.10 release, only the OPC UA protocol can set the device status to "deviceError".
  • If OPC UA sets its quality code to a value < 16384, then the server sets the device status to "active".
  • If OPC UA sets its quality code to a value >= 16384, then the server sets the device status to "deviceError".
  • OPC UA sets the "stopCode" and "stopReason" values when the status is "active" or "deviceError".

"userError" means an input or output process is not running and not collecting or delivering data because a user reported an error.

• Only a user puts a connector in the user error state.
• The purpose is to let the user signal that a device has an issue and the user wants to stop data collection or delivery until it is resolved. 
• A user error supersedes the "deviceError" and "connectorError" states because a user specifies the cause of the failure. 
  • The connector must not overwrite the "stopCode" and "stopReason" specified by the user.
  • The connector remains in "deviceError" until the user changes the status.
• The user can set the values of the "stopCode" and "stopReason" properties to any desired number and text to indicate the device's problem.
  • If the user does not set the "stopCode" value, it defaults to 32925.
  • If the user does not set the "stopReason" value, it defaults to "No data is being collected due to a user-specified error.".

"paused" means an input or output process is not running and not collecting or delivering data because the user paused it. 

• Only a user pauses a connector.
• The purpose is to temporarily pause data collection or delivery.
  • Unlike "userError", "deviceError", and "connectorError", the device and connector do not have a problem.
• The server sets "stopCode" to 165 and "stopReason" to "No data is being collected/delivered because a user paused it.".

"inactive" means an input or output process is not running and not collecting or delivering data because the user has decommissioned it. 

• Only a user deactivates a connector.
• The purpose is to disable or "soft delete" the connector because the device is no longer in use or will be out of commission for a long time. 
  • An inactive connector's information is retained for historical reporting.
  • An inactive connector can be reactivated.
• The server sets "stopCode" to 32925 and "stopReason" to "No data is being collected/delivered because a user deactivated it.".

Tip You can also permanently delete a connector instead of making it "inactive". 

• It cannot be permanently deleted if devices or data reference the connector.
• Once permanently deleted, it is no longer associated with the device and data that it collected or delivered.
• It is no longer available in any lists.

Note this property is unrelated to "immediatelyCollectDataOnStart", which controls whether an input connector immediately gathers data when it becomes "active" or waits until scheduled to collect data.