Connections
Under Connections, you have the option of adding and managing connections to external interfaces. For example, you can connect the iSE-COBRA operations control system to GroupAlarm via the WDX3 interface. A corresponding trigger is available in the flows, which can accept and process the data from the WDX3 interface.
Once connections have been created, they are displayed in the overview of connections.
1️⃣ Each connection can be switched on and off in the overview using the switch. The current status of the connection is displayed on the right-hand side.
2️⃣ The functions in the lower area of a connection allow you more in-depth monitoring and editing options for the respective connection.
The FILTER allows you to control the forwarding of incoming data records from your interface to sub-organisations. The input mask for the filter is described below.
PROTOCOL shows you the connection log of the connection. For example, when a connection was established or terminated.
You can access the edit view of the connection via EDIT. This is the same as the view when setting up a connection for the first time and allows you to change the password or replace the certificate, for example.
The LIVE view shows you in real time which data is being exchanged via the interface.
You can use DELETE to completely remove a connection that is no longer required.
If a connection is lost over time, the system attempts to re-establish the connection automatically up to 5 times. Data is not lost in such a case, but is delivered as soon as the connection is re-established.
The connection is also renewed every 24 hours in order to obtain a new valid token.
If you want to create a new connection, you will see the following input screen.
1️⃣ You can use the input fields for Name and Description to name the connection you are setting up and add a description. This will help you to identify the connection in the overview later if you set up several connections.
2️⃣ You can specify the type of connection in the selection field for Type. In the example shown, this is WDX3.
3️⃣ Username and Password are required for authentication with the server for a WDX3 connection. To display the password, you can click on the symbol with the eye on the right of the input field for the password. You can obtain this data from the server operator.
4️⃣ Enter the server you wish to address in the Server input field. You can also obtain the exact URL from the server operator.
5️⃣ In the input field for Certificate, enter the certificate that you have received from the operator of the WDX3 server. You can insert the certificate file directly using the symbol with the arrow on the right-hand side of the input field.
6️⃣ Similar to the certificate, you can enter the private key, which you also receive from the server operator, in the input field for the Private key. Here too, you can add the corresponding file directly using the symbol with the arrow on the right-hand side.
7️⃣ When all the entries are complete, you can set up the connection via CREATE CONNECTION. If the button is still greyed out, please check your entries.
The filter allows you to control the forwarding of data records to sub-organisations. Setting up the filter is optional.
1️⃣ In the input field for the Paths, you can define one or more paths to the fields of your JSON. These fields are then checked by the system for the values that you define in the Organisational assignment.
2️⃣ In the Organisational assignment, you define the respective organisations for which triggering of the flow should be permitted. And in addition, you define the value that must be contained in the field defined under Paths. If the value applies, the flow is allowed to be triggered for the respective sub-organisation. If no criterion is met, a corresponding error is displayed in the insights of the flow of the parent organisation that uses the connection.
💡 The Insights of unauthorised organisations do not receive any information on the data received.
Connections
Once connections have been created, they are displayed in the overview of connections.
1️⃣ Each connection can be switched on and off in the overview using the switch. The current status of the connection is displayed on the right-hand side.
2️⃣ The functions in the lower area of a connection allow you more in-depth monitoring and editing options for the respective connection.
The FILTER allows you to control the forwarding of incoming data records from your interface to sub-organisations. The input mask for the filter is described below.
PROTOCOL shows you the connection log of the connection. For example, when a connection was established or terminated.
You can access the edit view of the connection via EDIT. This is the same as the view when setting up a connection for the first time and allows you to change the password or replace the certificate, for example.
The LIVE view shows you in real time which data is being exchanged via the interface.
You can use DELETE to completely remove a connection that is no longer required.
If a connection is lost over time, the system attempts to re-establish the connection automatically up to 5 times. Data is not lost in such a case, but is delivered as soon as the connection is re-established.
The connection is also renewed every 24 hours in order to obtain a new valid token.
Create connection
If you want to create a new connection, you will see the following input screen.
1️⃣ You can use the input fields for Name and Description to name the connection you are setting up and add a description. This will help you to identify the connection in the overview later if you set up several connections.
2️⃣ You can specify the type of connection in the selection field for Type. In the example shown, this is WDX3.
3️⃣ Username and Password are required for authentication with the server for a WDX3 connection. To display the password, you can click on the symbol with the eye on the right of the input field for the password. You can obtain this data from the server operator.
4️⃣ Enter the server you wish to address in the Server input field. You can also obtain the exact URL from the server operator.
5️⃣ In the input field for Certificate, enter the certificate that you have received from the operator of the WDX3 server. You can insert the certificate file directly using the symbol with the arrow on the right-hand side of the input field.
6️⃣ Similar to the certificate, you can enter the private key, which you also receive from the server operator, in the input field for the Private key. Here too, you can add the corresponding file directly using the symbol with the arrow on the right-hand side.
7️⃣ When all the entries are complete, you can set up the connection via CREATE CONNECTION. If the button is still greyed out, please check your entries.
Filter
The filter allows you to control the forwarding of data records to sub-organisations. Setting up the filter is optional.
1️⃣ In the input field for the Paths, you can define one or more paths to the fields of your JSON. These fields are then checked by the system for the values that you define in the Organisational assignment.
2️⃣ In the Organisational assignment, you define the respective organisations for which triggering of the flow should be permitted. And in addition, you define the value that must be contained in the field defined under Paths. If the value applies, the flow is allowed to be triggered for the respective sub-organisation. If no criterion is met, a corresponding error is displayed in the insights of the flow of the parent organisation that uses the connection.
💡 The Insights of unauthorised organisations do not receive any information on the data received.
Updated on: 27/11/2024
Thank you!