Skip to content

/AWS1/CL_IOSGWCAPABILITYSUMM

Contains a summary of a gateway capability configuration.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_capabilitynamespace TYPE /AWS1/IOSCAPABILITYNAMESPACE /AWS1/IOSCAPABILITYNAMESPACE

The namespace of the capability configuration. For example, if you configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:3.

iv_capabilitysyncstatus TYPE /AWS1/IOSCAPABILITYSYNCSTATUS /AWS1/IOSCAPABILITYSYNCSTATUS

The synchronization status of the gateway capability configuration. The sync status can be one of the following:

  • IN_SYNC - The gateway is running with the latest configuration.

  • OUT_OF_SYNC - The gateway hasn't received the latest configuration.

  • SYNC_FAILED - The gateway rejected the latest configuration.

  • UNKNOWN - The gateway hasn't reported its sync status.

  • NOT_APPLICABLE - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.


Queryable Attributes

capabilityNamespace

The namespace of the capability configuration. For example, if you configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:3.

Accessible with the following methods

Method Description
GET_CAPABILITYNAMESPACE() Getter for CAPABILITYNAMESPACE, with configurable default
ASK_CAPABILITYNAMESPACE() Getter for CAPABILITYNAMESPACE w/ exceptions if field has no
HAS_CAPABILITYNAMESPACE() Determine if CAPABILITYNAMESPACE has a value

capabilitySyncStatus

The synchronization status of the gateway capability configuration. The sync status can be one of the following:

  • IN_SYNC - The gateway is running with the latest configuration.

  • OUT_OF_SYNC - The gateway hasn't received the latest configuration.

  • SYNC_FAILED - The gateway rejected the latest configuration.

  • UNKNOWN - The gateway hasn't reported its sync status.

  • NOT_APPLICABLE - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

Accessible with the following methods

Method Description
GET_CAPABILITYSYNCSTATUS() Getter for CAPABILITYSYNCSTATUS, with configurable default
ASK_CAPABILITYSYNCSTATUS() Getter for CAPABILITYSYNCSTATUS w/ exceptions if field has n
HAS_CAPABILITYSYNCSTATUS() Determine if CAPABILITYSYNCSTATUS has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_GATEWAYCAPABILITYSUMMARIES

TYPES TT_GATEWAYCAPABILITYSUMMARIES TYPE STANDARD TABLE OF REF TO /AWS1/CL_IOSGWCAPABILITYSUMM WITH DEFAULT KEY
.