Integration channel types

Location path

Path in the build directory

/era_env/priv/sys_metadata/solutions/<SOLUTION>/webservices.json (where SOLUTION: master or era)

Overview

Descriptor of specific integration channel types – access points to external services. Forms the types of available integration points for domains of a specific type and defines the protocol adapter scripts used for each of them.

Also available for the master domain (/era_env/priv/sys_metadata/solutions/master/webservices.json).

Format:
[
  {
    "type": str,
    "recv_svcscriptcode": str,
    "recv_svcscriptcode_ws": str,
    "recv_timeout": int,
    "send_svcscriptcode": str,
    "send_svcscriptcode_ws": str,
    "url": "https://...",
    "issync": true | false
  },
  ...
]
  • type – arbitrary type name.

  • recv_svcscriptcode – code of the service adapter script handling http messages received as HTTP hooks from the external system or web service.

  • send_svcscriptcode – code of the service adapter script handling a message sent to the external system or web service.

  • recv_svcscriptcode_ws – (optional) code of the service adapter script handling messages received via websocket connections from the external system or web service.

  • send_svcscriptcode_ws – (optional) code of the service adapter script handling a message sent to the external system or web service via an existing websocket connection.

  • url – URL of the connection point to the web service or its adapter.

  • issync – switch for synchronous processing mode in the script of a message received from the external system as a hook.

  • recv_timeout – maximum execution time of the recv_svcscript script in seconds. The default value (0) means the value defined by the web server will be applied (10 sec.). The maximum allowed value is 60 sec.

Integration point entities created with specific types cannot change the parameters mentioned in the metadata: scripts, url, etc.

Script content for such configuration is formed separately and is located among the assets.

Example

Defines three integration point types, and for each defines the address and hidden scripts.

Example:
[
  {
    "type": "telegram",
    "recv_svcscriptcode": "webservice_telegram_recv",
    "send_svcscriptcode": "webservice_telegram_send",
    "url": "https://149.154.167.40:443/",
    "issync": false
  },
  {
    "type": "vk",
    "recv_svcscriptcode": "webservice_vk_recv",
    "send_svcscriptcode": "webservice_vk_send",
    "url": "http://127.0.0.1:12345/api/vk/v1/webservice?mode=sync",
    "issync": true
  },
  {
    "type": "subscr",
    "recv_svcscriptcode": "webservice_subscr_recv",
    "recv_svcscriptcode_ws": "webservice_subscr_recv",
    "send_svcscriptcode": "webservice_subscr_send",
    "url": "http://127.0.0.1:12345/api/subscr/v1/webservice?mode=sync",
    "issync": true
  }
]