UPDATEGATEWAYCAPABILITYCONF()`¶

About UpdateGatewayCapabilityConfiguration¶

Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway.

Important workflow notes:

Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability.

. The namespace follows the format service:capability:version, where:

service - The service providing the capability, or iotsitewise.
capability - The specific capability type. Options include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability.
version - The version number of the capability. Option include 2 for Classic streams, V2 gateways, and 3 for MQTT-enabled, V3 gateways.

After updating a capability configuration, the sync status becomes OUT_OF_SYNC until the gateway processes the configuration.Use DescribeGatewayCapabilityConfiguration to check the sync status and verify the configuration was applied.

A gateway can have multiple capability configurations with different namespaces.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_gatewayid` `TYPE /AWS1/IOSID` `/AWS1/IOSID`¶

The ID of the gateway to be updated.

`iv_capabilitynamespace` `TYPE /AWS1/IOSCAPABILITYNAMESPACE` `/AWS1/IOSCAPABILITYNAMESPACE`¶

The namespace of the gateway capability configuration to be updated. 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_capabilityconfiguration` `TYPE /AWS1/IOSCAPABILITYCONF` `/AWS1/IOSCAPABILITYCONF`¶

The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_iosupgwcapabilityco01` `/AWS1/CL_IOSUPGWCAPABILITYCO01`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_ios~updategatewaycapabilityconf(
  iv_capabilityconfiguration = |string|
  iv_capabilitynamespace = |string|
  iv_gatewayid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_capabilitynamespace = lo_result->get_capabilitynamespace( ).
  lv_capabilitysyncstatus = lo_result->get_capabilitysyncstatus( ).
ENDIF.

/AWS1/CL_IOS=>UPDATEGATEWAYCAPABILITYCONF()¶