Full docs of the OPC UA public beta release #1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added Known limitation section Started updating first set of chapters (up to chapter 3.2.2.)
Add OPC UA subscription terminology Refactored chapter: subscription, pages: overview,new/edit,troubleshoot Added wording for ASU & BSD microflow Added limitation
|
Hi Jasper @jaspervanderhoek , I notice that there has been an accidental I look forward to hearing from you when this is ready to review, and let me know if there is anything I can help you with. |
Owner
Author
Unfortunately I made that change a while ago (I had some typos where I typed OPC US instead of UA) apparently I forgot to check the case sensitive option with the find/replace. I think I fixed all mistakes though. |
|
Thanks for resolving so quickly! Looks fine now. |
|
Hi Jasper, @jaspervanderhoek |
Owner
Author
|
Hi @MarkvanMents , yes it's ready to be merged. There are just 2 todo's left in the document, we need a new screenshot of the module in the project explorer. And I added a todo to do an in-page link to another chapter, I don't know how you write those links for our doc pages. |
MarkvanMents
approved these changes
Mar 23, 2021
MarkvanMents
left a comment
There was a problem hiding this comment.
Hi Jasper, @jaspervanderhoek
I've made suggestions which add in the links which were in your todos.
When you are ready, can you accept these (if you are happy) and remove the Draft status of the PR. Then I can merge it.
Then I can do a final review - it will be easier as I will be able to update the files directly instead of having to make suggestions.
|
|
||
| Once you have set up the server configuration, you can perform the following actions in your microflows. | ||
|
|
||
| #### 3.2.1 **Browse** a List of Nodes |
There was a problem hiding this comment.
Suggested change
| #### 3.2.1 **Browse** a List of Nodes | |
| #### 3.2.1 **Browse** a List of Nodes{#browse} |
| This displays the following data entry fields which can be used to control the tests. | ||
| * **Read** executes the Read action {{% todo %}}[Add a link to the read-action chapter]{{% /todo %}} | ||
| * **Write** executes the Write action {{% todo %}}[Add a link to the Write-action chapter]{{% /todo %}} | ||
| * **Browse** executes the Browse action {{% todo %}}[Add a link to the Browse-action chapter]{{% /todo %}} |
There was a problem hiding this comment.
Suggested change
| * **Browse** executes the Browse action {{% todo %}}[Add a link to the Browse-action chapter]{{% /todo %}} | |
| * **Browse** executes the [Browse action](#browse) |
| * Return Variable – The output of this action is the JSON string with all information about the requested nodes. This string can be parsed with the Import Mapping activity. | ||
|
|
||
|
|
||
| #### 3.2.2 **Read** the Value of a Node |
There was a problem hiding this comment.
Suggested change
| #### 3.2.2 **Read** the Value of a Node | |
| #### 3.2.2 **Read** the Value of a Node{#read} |
| * **Result** – the resulting JSON string from performing any of the four test actions. This shows the full response from the OPC UA Server, the connector might at relevant details in case of an error. | ||
|
|
||
| This displays the following data entry fields which can be used to control the tests. | ||
| * **Read** executes the Read action {{% todo %}}[Add a link to the read-action chapter]{{% /todo %}} |
There was a problem hiding this comment.
Suggested change
| * **Read** executes the Read action {{% todo %}}[Add a link to the read-action chapter]{{% /todo %}} | |
| * **Read** executes the [Read action](#read) |
| All values are read as strings, you will need to convert them if you need a numeric or date value. | ||
| {{% /alert %}} | ||
|
|
||
| #### 3.2.3 **Subscribe** to Updates of Data from a Node |
There was a problem hiding this comment.
Suggested change
| #### 3.2.3 **Subscribe** to Updates of Data from a Node | |
| #### 3.2.3 **Subscribe** to Updates of Data from a Node{#subscribe} |
| * **Write** executes the Write action {{% todo %}}[Add a link to the Write-action chapter]{{% /todo %}} | ||
| * **Browse** executes the Browse action {{% todo %}}[Add a link to the Browse-action chapter]{{% /todo %}} | ||
| * **Subscribe Simple** executes the Subscribe action {{% todo %}}[Add a link to the Subscribe-action chapter]{{% /todo %}}. Process response with microflow: SubscriptionIncomingData_Process_TEST. Check the log or put a breakpoint on this microflow to checkout the response messages. | ||
| * **Subscribe w/ Msg** executes the Subscribe action {{% todo %}}[Add a link to the Subscribe-action chapter]{{% /todo %}}. Process response with microflow: SubscriptionIncomingData_Process_wMessage_TEST. Check the log or put a breakpoint on this microflow to checkout the response messages. |
There was a problem hiding this comment.
Suggested change
| * **Subscribe w/ Msg** executes the Subscribe action {{% todo %}}[Add a link to the Subscribe-action chapter]{{% /todo %}}. Process response with microflow: SubscriptionIncomingData_Process_wMessage_TEST. Check the log or put a breakpoint on this microflow to checkout the response messages. | |
| * **Subscribe w/ Msg** executes the [Subscribe action](#subscribe). Process response with microflow: SubscriptionIncomingData_Process_wMessage_TEST. Check the log or put a breakpoint on this microflow to checkout the response messages. |
| {{% alert type="warning" %}} | ||
| Only one of these authentication methods should be enabled for each OPC UA server. This method must be matched by the OPC UA Client connector to ensure it can reach the correct endpoint. | ||
| {{% /alert %}} | ||
| Only one of the options can be in use any any time, which one will be determined by the OPC UA server that you are connecting too. The password from both the user and certificate are automatically encrypted when saving the server configuration using the Encryption module. |
There was a problem hiding this comment.
Suggested change
| Only one of the options can be in use any any time, which one will be determined by the OPC UA server that you are connecting too. The password from both the user and certificate are automatically encrypted when saving the server configuration using the Encryption module. | |
| Only one of the options can be in use any any time. Which one will be determined by the OPC UA server that you are connecting to. The password from both the user and certificate are automatically encrypted when saving the server configuration using the Encryption module. |
| * Encryption Module | ||
| * An OPC UA server – we assume that you are familiar with OPC UA and your OPC UA server(s), these instructions do not include information on how to set up your servers. | ||
|
|
||
| Recommended; Having an external OPC UA Client tool will make setup of the connection a lot easier. A commonly used client is the one from [Unified Automation](https://www.unified-automation.com/downloads/opc-ua-clients.html), with this (non-Mendix) tool you will be able to browse through the server and find the parameters needed to configure your connection. |
There was a problem hiding this comment.
Suggested change
| Recommended; Having an external OPC UA Client tool will make setup of the connection a lot easier. A commonly used client is the one from [Unified Automation](https://www.unified-automation.com/downloads/opc-ua-clients.html), with this (non-Mendix) tool you will be able to browse through the server and find the parameters needed to configure your connection. | |
| Recommended; Having an external OPC UA Client tool will make setup of the connection a lot easier. A commonly-used client is the one from [Unified Automation](https://www.unified-automation.com/downloads/opc-ua-clients.html). With this (non-Mendix) tool you will be able to browse through the server and find the parameters needed to configure your connection. |
| ### 2.1 Configuration: | ||
| 1. Add the **OpcUaServer_Overview** page to the navigation of the app, either through the **Navigation** settings, or by adding an **Open Page** button to a page which is already in the navigation (for example the home page). | ||
|
|
||
| 2. Looup the Constant: **UA_ApplicationName** in the **_USE_ME** folder and update these with the information specific to your Client. The application name must be unique to the OPC UA Server, the connector has no requirements to the contents of this constant. If you have a single Mendix application connecting to the server you could choose to leave the default value, if you have multiple Mendix applications connecting to the same server you **must** alter the name to be unique (as per the OPC UA spec). |
There was a problem hiding this comment.
Suggested change
| 2. Looup the Constant: **UA_ApplicationName** in the **_USE_ME** folder and update these with the information specific to your Client. The application name must be unique to the OPC UA Server, the connector has no requirements to the contents of this constant. If you have a single Mendix application connecting to the server you could choose to leave the default value, if you have multiple Mendix applications connecting to the same server you **must** alter the name to be unique (as per the OPC UA spec). | |
| 2. Find the constant: **UA_ApplicationName** in the **_USE_ME** folder and update this with the information specific to your Client. The application name must be unique to the OPC UA Server, the connector has no requirements to the contents of this constant. If you have a single Mendix application connecting to the server you could choose to leave the default value, if you have multiple Mendix applications connecting to the same server you **must** alter the name to be unique (as per the OPC UA spec). |
| 2. Looup the Constant: **UA_ApplicationName** in the **_USE_ME** folder and update these with the information specific to your Client. The application name must be unique to the OPC UA Server, the connector has no requirements to the contents of this constant. If you have a single Mendix application connecting to the server you could choose to leave the default value, if you have multiple Mendix applications connecting to the same server you **must** alter the name to be unique (as per the OPC UA spec). | ||
| *See the OPC UA Specification for more details, this setting is only used by the OPC UA Server.* | ||
|
|
||
| 3. Looup the Constant: **UA_ApplicationURI** in the **_USE_ME** folder and update these with the information specific to your Client. The application URI must be unique to the OPC UA Server, the connector has no requirements to the contents of this constant. If you have a single Mendix application connecting to the server you could choose to leave the default value, if you have multiple Mendix applications connecting to the same server you **must** alter the name to be unique (as per the OPC UA spec). |
There was a problem hiding this comment.
Suggested change
| 3. Looup the Constant: **UA_ApplicationURI** in the **_USE_ME** folder and update these with the information specific to your Client. The application URI must be unique to the OPC UA Server, the connector has no requirements to the contents of this constant. If you have a single Mendix application connecting to the server you could choose to leave the default value, if you have multiple Mendix applications connecting to the same server you **must** alter the name to be unique (as per the OPC UA spec). | |
| 3. Find the constant: **UA_ApplicationURI** in the **_USE_ME** folder and update this with the information specific to your Client. The application URI must be unique to the OPC UA Server, the connector has no requirements to the contents of this constant. If you have a single Mendix application connecting to the server you could choose to leave the default value, if you have multiple Mendix applications connecting to the same server you **must** alter the name to be unique (as per the OPC UA spec). |
|
@jaspervanderhoek Jasper, I still can't merge this as you still have it in draft. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added Known limitation section
Started updating first set of chapters (up to chapter 3.2.2.)