Created
October 5, 2018 17:00
-
-
Save chrissmith-mcafee/8dd87ed2a79a6a6cffa81efa0488d581 to your computer and use it in GitHub Desktop.
This Node-RED flow invokes and displays the results of a `system.findTag` remote command via the ePO DXL service.
This file contains 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
| [ | |
| { | |
| "id": "a6c49432.25d5b8", | |
| "type": "tab", | |
| "label": "ePO Remote Command Example", | |
| "disabled": false, | |
| "info": "This sample invokes and displays the results of a `system.findTag` remote\r\ncommand via the ePO DXL service. The results of the find command are displayed\r\non the Node-RED `debug` tab.\r\n\r\n### Prerequisites\r\n\r\n* The samples configuration step has been completed (see\r\n [Client Configuration](https://opendxl.github.io/node-red-contrib-dxl/jsdoc/tutorial-configuration.html)).\r\n* A ePO DXL service is running and available on the DXL fabric. If version 5.0\r\n or later of the DXL ePO extensions are installed on your ePO server, an ePO\r\n DXL service should already be running on the fabric. If you are using an\r\n earlier version of the DXL ePO extensions, you can use the\r\n [ePO DXL Python Service](https://github.com/opendxl/opendxl-epo-service-python).\r\n* The DXL client associated with the `Find tags in ePO` node is authorized to\r\n invoke the ePO DXL service, and the user that is connecting to the ePO server\r\n (within the ePO DXL service) has permission to execute the `system.findTag`\r\n remote command (see\r\n [Client Authorization](https://opendxl.github.io/opendxl-epo-client-python/pydoc/authorization.html)).\r\n\r\n### Setup\r\n\r\n* If more than one ePO service is available on the DXL fabric that the DXL\r\n client is connecting to, edit the `Find tags in ePO` node and set the `ePO Id`\r\n property to that of the ePO service through which the remote command should be\r\n performed. By default, the `ePO Id` property is empty, in which case the\r\n client attempts to dynamically determine the id of the ePO service to\r\n communicate with.\r\n* Edit the `Set search text` node and modify the `Payload` property with the\r\n search text to use for the system find tag command. For example:\r\n\r\n ```json\r\n {\"searchText\":\"broker\"}\r\n ```\r\n\r\n* To deploy the flow, press the `Deploy` button in the upper-right corner of the\r\n screen. If Node-RED is able to properly connect to the DXL fabric, a green dot\r\n with the word `connected` should appear under the `Find tags in ePO` node.\r\n\r\n### Running\r\n\r\nTo exercise the flow, double-click the button on the left side of the\r\n`Set search text` node.\r\n\r\n### Output\r\n\r\nThe following output should appear in the Node-RED `debug` tab:\r\n\r\n```\r\n? [ object ]\r\n```\r\n\r\nAfter clicking on the right arrow button to expand the contents of the object,\r\noutput similar to the following should appear\r\n\r\n```\r\n? 0: object\r\n tagId: 3\r\n tagName: \"DXLBROKER\"\r\n tagNotes: \"DXL Broker\"\r\n```\r\n\r\n### Details\r\n\r\nThe flow exercises the nodes below.\r\n\r\n#### Set search text\r\n\r\nThis is an `inject` input node which starts the flow. This node injects a new\r\nmessage with a JSON-formatted document as the `payload`. The document\r\nspecifies the parameters to use for the ePO remote command. The parameters for\r\nthe \"system.findTag\" command include a `searchText` key with a corresponding\r\nvalue to be used as the text for the search.\r\n\r\nTo see the full list of remote commands and parameters that the ePO server\r\nsupports, a node which invokes the `core.help` remote command with an\r\nempty JSON document `{}` as the `payload` parameter could be included in a flow.\r\n\r\n#### Find tags in ePO\r\n\r\nThis is an `epo remote command` node. This node connects to the DXL fabric and\r\nsends a DXL `Request` message to the ePO service.\r\n\r\nThe `Command` property specifies the target remote command as `system.findTag`.\r\n\r\nThe DXL request message contains parameters set in the `payload` by the\r\n`Set search text` node.\r\n \r\nThe `Return` property is set to \"a parsed JSON object\" and the `Format` property\r\nis set to \"JSON\" to indicate that the payload for the response should be\r\nadded to the output message as a JavaScript object decoded from JSON.\r\n\r\n#### Output tags\r\n\r\nThis is a `debug` output node. This node outputs the `payload` set on\r\nthe message by the `Find tags in ePO` node. The output should include the\r\nresponse received from the DXL fabric for the `system.findTag` command.\r\n" | |
| }, | |
| { | |
| "id": "f8520e86.9988a", | |
| "type": "dxl-epo-remote-command", | |
| "z": "a6c49432.25d5b8", | |
| "name": "Find tags in ePO", | |
| "command": "system.findTag", | |
| "client": "dc14e134.3cbdc", | |
| "returnType": "obj", | |
| "x": 330, | |
| "y": 100, | |
| "wires": [ | |
| [ | |
| "9f57edf.3a8841" | |
| ] | |
| ] | |
| }, | |
| { | |
| "id": "946b44fc.150d48", | |
| "type": "inject", | |
| "z": "a6c49432.25d5b8", | |
| "name": "Set search text", | |
| "topic": "", | |
| "payload": "{\"searchText\":\"<specify-search-text>\"}", | |
| "payloadType": "json", | |
| "repeat": "", | |
| "crontab": "", | |
| "once": false, | |
| "onceDelay": 0.1, | |
| "x": 140, | |
| "y": 100, | |
| "wires": [ | |
| [ | |
| "f8520e86.9988a" | |
| ] | |
| ] | |
| }, | |
| { | |
| "id": "9f57edf.3a8841", | |
| "type": "debug", | |
| "z": "a6c49432.25d5b8", | |
| "name": "Debug: Output tags", | |
| "active": true, | |
| "tosidebar": true, | |
| "console": false, | |
| "tostatus": false, | |
| "complete": "payload", | |
| "x": 530, | |
| "y": 100, | |
| "wires": [] | |
| }, | |
| { | |
| "id": "160fe741.ab7209", | |
| "type": "comment", | |
| "z": "a6c49432.25d5b8", | |
| "name": "Supply the tag search text to use in the 'Set search text' node ", | |
| "info": "", | |
| "x": 260, | |
| "y": 40, | |
| "wires": [] | |
| } | |
| ] |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment