Difference between revisions of "Script Adapter (Push)"

From Datonis
Jump to: navigation, search
(Created page with " Edge Gateway Home > '''OPC UA Adapter''' == OPC UA Protocol Connection == {| class="wikitable" | colspan="1" |server_url | colspan="1" |String | col...")
 
(Script Adapter changes)
Line 1: Line 1:
−
  [[Datonis Edge Gateway|Edge Gateway Home]] > '''OPC UA Adapter'''
+
  [[Datonis Edge Gateway|Edge Gateway Home]] > '''Script Adapter (Push)'''
  
 
== OPC UA Protocol Connection ==
 
== OPC UA Protocol Connection ==
 
{| class="wikitable"
 
{| class="wikitable"
−
| colspan="1" |server_url
+
| colspan="1" |Connect JS Script
 
| colspan="1" |String
 
| colspan="1" |String
 
| colspan="1" |URL address of the OPC UA server e.g. opc.tcp://localhost:12686/example
 
| colspan="1" |URL address of the OPC UA server e.g. opc.tcp://localhost:12686/example
 
|-
 
|-
−
| colspan="1" |is_secure
+
| colspan="1" |Disconnect JS Script
−
| colspan="1" |Boolean
+
| colspan="1" |String
 
| colspan="1" |Signifies whether the connection to OPC UA server is secure or not. If it is true then cert_alias option will be used
 
| colspan="1" |Signifies whether the connection to OPC UA server is secure or not. If it is true then cert_alias option will be used
 
|-
 
|-
−
|cert_alias
+
|Write Connection JS Script
 
|String
 
|String
 
|Alias of the client certificate used for secure communication with OpcUA server. The private and public key of the certificate in .pem format has to be
 
|Alias of the client certificate used for secure communication with OpcUA server. The private and public key of the certificate in .pem format has to be
 
updated via Settings→Device SSL Certificate. The alias mentioned for certificate must match with the one specified in config-json. A default alias named opcua is available, its certificate can be found at {install_location}\aliot-4.0\data\keystore\opcua.pem
 
updated via Settings→Device SSL Certificate. The alias mentioned for certificate must match with the one specified in config-json. A default alias named opcua is available, its certificate can be found at {install_location}\aliot-4.0\data\keystore\opcua.pem
 
|-
 
|-
−
| colspan="1" |discover_endpoints
+
| colspan="1" |Additional Java library URLs
−
| colspan="1" |Boolean
+
| colspan="1" |String
 
| colspan="1" |true value denotes that the connection endpoints will be discovered from the server_url and endpoint matching with security policy will be used for connection. 
 
| colspan="1" |true value denotes that the connection endpoints will be discovered from the server_url and endpoint matching with security policy will be used for connection. 
 
false value means the endpoint will be the same as server_url. Default value is true.
 
false value means the endpoint will be the same as server_url. Default value is true.
 
|-
 
|-
−
| colspan="1" |security_policy_uri
+
| colspan="1" |Tag JS Script
 
| colspan="1" |String
 
| colspan="1" |String
 
| colspan="1" |Possible values are http://opcfoundation.org/UA/SecurityPolicy#None, http://opcfoundation.org/UA/SecurityPolicy#Basic128Rsa15, http://opcfoundation.org/UA/SecurityPolicy#Basic256,
 
| colspan="1" |Possible values are http://opcfoundation.org/UA/SecurityPolicy#None, http://opcfoundation.org/UA/SecurityPolicy#Basic128Rsa15, http://opcfoundation.org/UA/SecurityPolicy#Basic256,
Line 27: Line 27:
 
|}
 
|}
  
−
== OPC UA Read Tag ==
+
== Script Tags ==
 
{| class="wikitable"
 
{| class="wikitable"
−
| colspan="1" |tag_id
+
| colspan="1" |executor_val
 
| colspan="1" |String
 
| colspan="1" |String
 
| colspan="1" |Unique tag id defined in the context of the current thing_config. This is used further in metric_mappings or derived_tags or scan_tag_ids or monitor_tag_ids to refer to this tag value.
 
| colspan="1" |Unique tag id defined in the context of the current thing_config. This is used further in metric_mappings or derived_tags or scan_tag_ids or monitor_tag_ids to refer to this tag value.
 
|-
 
|-
−
|node_id
+
|transient_val
 
|String
 
|String
 
|The OPC UA tag definition which is present at OPC UA server e.g. ns=2;s=Channel1.Machine1.Tag1 or ns=0;i=2259. The format for tag is as follows:
 
|The OPC UA tag definition which is present at OPC UA server e.g. ns=2;s=Channel1.Machine1.Tag1 or ns=0;i=2259. The format for tag is as follows:
Line 39: Line 39:
  
 
For example: ns=2;s=Channel1.Machine1.Tag1
 
For example: ns=2;s=Channel1.Machine1.Tag1
 +
|-
 +
|persistent_val
 +
|String
 +
|
 +
|-
 +
|kvstore_val
 +
|String
 +
|
 +
|-
 +
|logger_val
 +
|String
 +
|
 +
|-
 +
|reciever_val
 +
|String
 +
|
 +
|-
 +
|writer_val
 +
|String
 +
|
 +
|-
 +
|Alerter_val
 +
|String
 +
|
 +
|-
 +
|scan_val
 +
|String
 +
|
 +
|-
 +
|Tag_val
 +
|String
 +
|
 +
|-
 +
|Connection_val
 +
|String
 +
|
 
|}
 
|}
  
Line 54: Line 90:
  
 
== Launching OPC UA configuration screen ==
 
== Launching OPC UA configuration screen ==
−
 
−
[[File:ua-1.png|800x800px]]
 
  
 
== Noting OPC UA url ==
 
== Noting OPC UA url ==
−
 
−
[[File:Ua-2-new.png|800x800px]]
 
  
 
== Adding Edge certificate to the trusted list ==
 
== Adding Edge certificate to the trusted list ==
Line 65: Line 97:
  
 
In the OPC UA configuration window, select the Trusted Clients tab, you will find a new entry for 'OPC UA Adapter'. Right click it and select “Trust”. Disable and enable Gateway again.
 
In the OPC UA configuration window, select the Trusted Clients tab, you will find a new entry for 'OPC UA Adapter'. Right click it and select “Trust”. Disable and enable Gateway again.
−
 
−
[[File:ua-3.png|800x800px]]
 

Revision as of 14:05, 30 January 2020

Edge Gateway Home > Script Adapter (Push)

OPC UA Protocol Connection

Connect JS Script String URL address of the OPC UA server e.g. opc.tcp://localhost:12686/example
Disconnect JS Script String Signifies whether the connection to OPC UA server is secure or not. If it is true then cert_alias option will be used
Write Connection JS Script String Alias of the client certificate used for secure communication with OpcUA server. The private and public key of the certificate in .pem format has to be

updated via Settings→Device SSL Certificate. The alias mentioned for certificate must match with the one specified in config-json. A default alias named opcua is available, its certificate can be found at {install_location}\aliot-4.0\data\keystore\opcua.pem

Additional Java library URLs String true value denotes that the connection endpoints will be discovered from the server_url and endpoint matching with security policy will be used for connection. 

false value means the endpoint will be the same as server_url. Default value is true.

Tag JS Script String Possible values are http://opcfoundation.org/UA/SecurityPolicy#None, http://opcfoundation.org/UA/SecurityPolicy#Basic128Rsa15, http://opcfoundation.org/UA/SecurityPolicy#Basic256,

http://opcfoundation.org/UA/SecurityPolicy#Basic256Sha256. The uri ending with None means no security policy is applied. Default value is Basic128Rsa15 uri.

Script Tags

executor_val String Unique tag id defined in the context of the current thing_config. This is used further in metric_mappings or derived_tags or scan_tag_ids or monitor_tag_ids to refer to this tag value.
transient_val String The OPC UA tag definition which is present at OPC UA server e.g. ns=2;s=Channel1.Machine1.Tag1 or ns=0;i=2259. The format for tag is as follows:

ns=<namespace id>;s=<string identifier of the tag> OR ns=<namespace id>;i=<integer identifier of the tag>

For example: ns=2;s=Channel1.Machine1.Tag1

persistent_val String
kvstore_val String
logger_val String
reciever_val String
writer_val String
Alerter_val String
scan_val String
Tag_val String
Connection_val String

OPC UA Write Tag

tag_id String Unique tag id defined in the context of the current thing_config. This is used in Datonis instruction json to address this OPC UA tag.
node_id String The OPC UA tag definition which is present at OPC UA server e.g. ns=2;s=Channel1.Machine1.Tag1 or ns=0;i=2259. This tag must be writable i.e. Client Access property must be set to Read/Write. The format for tag is as follows:

ns=<namespace id>;s=<string identifier of the tag> OR ns=<namespace id>;i=<integer identifier of the tag> For example: ns=2;s=Channel1.Machine1.Tag1

Launching OPC UA configuration screen

Noting OPC UA url

Adding Edge certificate to the trusted list

On configuring the Datonis Edge Gateway, it will error out with a certificate error: ServiceResultException: Bad_CertificateInvalid (0x80120000) "The certificate provided as a parameter is not valid.

In the OPC UA configuration window, select the Trusted Clients tab, you will find a new entry for 'OPC UA Adapter'. Right click it and select “Trust”. Disable and enable Gateway again.

Retrieved from "https://docs.datonis.io/mediawiki/index.php?title=Script_Adapter_(Push)&oldid=1038"