Connector Functions

Introduction

The Connector Functions feature enables OpenGate users to define the manner in which data exchanged between the OpenGate platform and remote devices is processed. The following sections present an overview of the utilisation of the API Connector Functions REST API.

Connector Function specification

It is possible for API users to configure connector functions using the JSON format. Each function has a field labelled “JavaScript” which contains valid JavaScript code. This code adheres to the Connector Functions JS API and performs the necessary logic for the connector function. The REST API performs minimal JavaScript parsing when creating or updating Connector Functions.

Each connector function belongs only to a specific channel and its name must be unique in the channel.

OperationalStatus

This field is mandatory and indicates when the Connector function will be performed if the Connector function criteria are met.

  • DISABLED: OpenGate doesn’t use the connector function.
  • PRODUCTION’: OpenGate will use the connector function.

REQUEST Connector Functions

If a connector function is of REQUEST type, operationName is mandatory and the specified name must be a valid operation type for the user using the REST API.

In this instance, the northCriterias field is mandatory. It is not possible to define more than one Connector Function with the same list of northCriterias.

In this case, the southCriterias field must be null or not defined.

RESPONSE and COLLECTION Connector Functions

In the event that a given Connector Function is of the type RESPONSE or COLLECTION, it will be mandatory for the user to input the southCriterias. The southCriterias field may contain one or more URIs, but each URI can only be defined in a single Connector Function. Each URI must begin with the appropriate protocol specification, such as https://, mqtts://, wss://, snmps://, or dlms://, and it is possible to configure these valid protocols.

In this instance, it is necessary for both northCriteria and operationName to be set to null or not defined.

CRUD Api for Connector Functions management.

The function of the connector is to stipulate the manner in which data is to be processed between the Opengate platform and distinct devices. The following sections will elucidate the usage of the application programming interface (API).

Connector Function specification:

The specification of Connector Functions will be carried out using the JavaScript Object Notation (JSON) format. Each function will have a field labelled “JavaScript” which will contain valid JavaScript code that adheres to the Connector Functions JavaScript Application Programming Interface (API). When a new Connector Function is created or an existing one is updated, only minimal script parsing will be carried out. Connector functions are created for specific channels, and the “connectorFunctionName” must be unique within the channel.

OperationalStatus

This field is obligatory and serves to indicate whether the Connector function is disabled or how it may be employed.

  • DISABLED: The Connector Function is inoperable.
  • PRODUCTION: The Connector Function will be utilized exclusively for devices with this operational status.
  • TEST: The Connector Function will be employed exclusively for devices exhibiting the specified operational status.

REQUEST Connector Functions

In the event that a connector function is of the type REQUEST, it is imperative that the operationName be mandatory and that the specified name be a valid Operation Type for the current user.

In this instance, the northCriterias are a mandatory requirement. It is not possible to define more than one Converter Function with the same list of northCriterias.

In this instance, it is necessary for the variable southCriterias to be set to either null or not defined.

RESPONSE and COLLECTION Connector Functions

In the event that a given Connector Function is of the type RESPONSE or COLLECTION, it will be mandatory for the southCriterias to be defined. The southCriterias field may contain one or more URIs, but each URI can only be defined in a single Connector Function. Each URI must begin with the appropriate protocol specification, including https://, mqtts://, and wss://. In this case, the northCriteria and operationName fields must be null or not defined.

Permissions

  • CREATE, UPDATE, DELETE: users with admin, admin_domain, super_admin_domain or root profiles.
  • GET and GET List actions can be done by any profile.

Comprehensive API actions

Warning

As a consequence of the existence of multiple helper functions and objects for the development of new connector function scripts, there are certain terms that cannot be employed in order to circumvent potential conflicts. These include the following: cf, collection, response, snmp, utils, dlms.

Updating a connector function

It is possible to update the function of a connector in some fields. However, certain values cannot be modified, including the identifier and the type.

API specification