User Guide Part 12 Service
Contents 1 OVERVIEW... 6 1.1 About the Service... 6 2 CREATING A DATA MAPPING CONFIGURATION... 7 2.1 Adding a Mapping Configuration... 7 2.1.1 Configuring a Data Provider... 7 2.1.2 Configuring a Status Server Connection... 11 2.1.3 Misc. Settings... 13 2.2 Setting up a Password... 14 2.3 Configuring Mappings... 15 2.3.1 Associate Mapping... 17 2.4 Testing Mapping Configurations... 19 2.5 Data Mapping Search and Filter Options... 20 2.5.1 Setting Default Update Rate... 20 2.5.2 Search and Replace... 20 2.5.3 Validating Mappings... 21 2.5.4 Mapping Filter... 21 3 DATA PROVIDERS... 23 3.1 Database... 23 3.1.1 Excel Data Provider... 23 3.1.2 ODBC Data Provider... 24 3.2 Misc... 27 3.2.1 Data Simulation Provider... 27 3.2.2 REST Data Provider... 29 3.2.3 Status Machine Edition Data Provider... 36 3.2.4 Stock Quote... 39 3.3 OPC... 39 3.3.1 OPCDA Data Provider... 39 3.3.2 OPCUA Data Provider... 43 3.4 PLC... 46 3.4.1 Allen Bradley Data Provider... 46 3.4.2 Siemens S7 Data Provider... 50 3.5 Protocol... 51 3.5.1 Modbus TCP Extended... 51 3.5.2 Modbus TCP Server Data Provider... 54 3.5.3 MQTT Broker Data Provider... 55 3.5.4 SNMP... 57 3.6 RFID... 59 3.6.1 Empress Data Provider... 59 3.7 Sensors... 60 3.7.1 B&B Smartworx... 60 3.7.2 Domoticz Data Provider... 62 3.7.3 Generic Sensor Data Provider... 63 3.7.4 Libelium Sensor Data Provider... 64 3.7.5 B-Scada Sensor Data Provider... 66 3.7.6 Monnit Data Provider... 67 3.8 Custom Data Provider... 68 4 REPORT SUMMARY... 69 5 ADDITIONAL INFORMATION AND SUPPORT... 71 1
Figures and Tables Figure 1 - Status... 6 Figure 2 - Server Settings... 7 Figure 3 - New Configuration Icon... 7 Figure 4 - Add New Dialog Box... 7 Figure 5 - Data Provider Type List... 8 Figure 6 - Browse Servers Button... 8 Figure 7 - Select Server Dialog Box... 9 Figure 8 - Populated Endpoint URL... 9 Figure 9 - Heartbeat... 10 Figure 10 - Heartbeat Configuration... 10 Figure 11 - Use Local Time... 11 Figure 12 - Status Server Configuration Tab... 12 Figure 13 - OPC UA Discovery Screen... 12 Figure 14 - Enter Optional URL Screen... 13 Figure 15 - Security Settings Panel... 13 Figure 16 - Miscellaneous Settings Panel... 13 Figure 17 - Passphrase... 14 Figure 18 - Connect Button... 15 Figure 19 - Disconnect and Configure Mappings Buttons... 15 Figure 20 - Mapping Configuration Dialog... 16 Figure 21 - Mapping Added... 16 Figure 22 - Associate Mappings... 18 Figure 23 - Associate Mappings Dialog... 18 Figure 24 - Save Icon... 19 Figure 25 - Output Window... 19 Figure 26 - Enable Verbose... 20 Figure 27 - Default Update Rate... 20 Figure 28 - Search and Replace... 20 Figure 29 - Validate Mappings... 21 Figure 30 - Validation Complete... 21 Figure 31 - Invalid Path... 21 Figure 32 - Mapping Filter Options... 21 Figure 33 - Show All Mapping Filter... 22 Figure 34 - Show Selected Mapping Filter... 22 Figure 35 - Excel Data Provider... 23 Figure 36 - Available Workbooks Configuration... 23 Figure 37 - Configure Range... 24 Figure 38 - ODBC Data Provider... 24 Figure 39 - System DSN... 25 2
Figure 40 - ODBC Data Provider and Display Name... 25 Figure 41 - Server DSN and Login Fields... 25 Figure 42 - Add Query... 26 Figure 43 - Query Builder Button... 26 Figure 44 - Query Builder... 26 Figure 45 - Queries... 27 Figure 46 - Data Simulation Provider... 28 Figure 47 - Data Simulator Data Provider and Display Name... 28 Figure 48 - Configurable Data Items... 28 Figure 49 - Configure Property... 29 Figure 50 - REST Data Provider... 29 Figure 51 - REST Data Provider and Display Name... 30 Figure 52 - Service Information... 30 Figure 53 - Add Item... 30 Figure 54 - REST Data Provider Basic Settings... 31 Figure 55 - REST Data Provider Advanced Settings... 31 Figure 56 - POST Advanced Settings... 32 Figure 57 - REST JSON Request Example... 33 Figure 58 - REST JSON Response Example... 34 Figure 59 - REST XML Request Example... 35 Figure 60 - REST XML Response Example... 36 Figure 61 - Status Machine Edition Data Provider... 37 Figure 62 - Status Machine Data Provider and Display Name... 37 Figure 63 - Status Machine Edition Browse Button... 37 Figure 64 - Machine Edition Server Browse... 38 Figure 65 - Populated Server Information... 38 Figure 66 - Connect Button... 38 Figure 67 - Server Node List... 38 Figure 68 - Server Node... 38 Figure 69 - Stock Quote Data Provider... 39 Figure 70 - Stock Quote Data Provider and Provider Name... 39 Figure 71 - OPCDA Client Provider... 40 Figure 72 - OPCDA Client Data Provider and Display Name... 40 Figure 73 - OPCDA Client Browse Button... 40 Figure 74 - DA OPC Foundation Data Provider... 41 Figure 75 OPC Foundation Data Provider and Display Name... 41 Figure 76 - Browse Button... 41 Figure 77 - Select Server Dialog Box... 42 Figure 78 - Endpoint URL... 42 Figure 79 - OPCUA Data provider... 43 3
Figure 80 - OPCUA Data Provider and Display Name... 43 Figure 81 - OPCUA End Point URL Browse Button... 43 Figure 82 - OPC UA Discovery Dialog Box... 44 Figure 83 - Remote Selection... 44 Figure 84 - Enter URL Dialog Box... 44 Figure 85 - OPCUA Security Settings... 45 Figure 86 - OPCUA Authentication Settings... 45 Figure 87 - OPCUA Misc Settings... 45 Figure 88 - Allen Bradley Data Provider... 46 Figure 89 - Allen Bradley... 46 Figure 90 - Add Transaction... 47 Figure 91 - Transaction Item Groups... 47 Figure 92 - Protocols... 47 Figure 93 - Parameters... 48 Figure 94 - Serial Protocol... 48 Figure 95 - Ethernet Protocol... 49 Figure 96 - Gateway Protocol... 49 Figure 97 - Siemens S7 PLC Data Provider... 50 Figure 98 - Siemens S7 PLC... 50 Figure 99 - PLC Configurations... 51 Figure 100 - Data Points... 51 Figure 101 - Modbus TCP Extended Data Provider... 52 Figure 102 - Modbus TCP Extended Data Provider and Display Name... 52 Figure 103 - Server Information... 53 Figure 104 Configuration... 53 Figure 105 - Data Points... 53 Figure 106 - Modbus Tag Table... 54 Figure 107 - Modbus TCP Server Data Provider... 54 Figure 108 - MQTT Broker Data Provider... 55 Figure 109 - MQTT Broker Data Provider and Display Name... 55 Figure 110 - MQTT Broker Information... 56 Figure 111 Add Subscription... 56 Figure 112 Subscriptions... 56 Figure 113 - SNMP Data Provider... 57 Figure 114 - SNMP Data Provider and Display Name... 57 Figure 115 - SNMP Peer Information... 58 Figure 116 - Object OID... 58 Figure 117 - Empress Data Provider... 59 Figure 118 - Empress and Display Name... 59 Figure 119 - Reader Information... 59 4
Figure 120 - Reader Settings... 60 Figure 121 - B&B SmartWorx Data Provider... 60 Figure 122 B&B SmartWorx Wzzard and Display Name... 61 Figure 123 - Server Information... 61 Figure 124 - Nodes... 61 Figure 125 - Domoticz Data Provider... 62 Figure 126 - Domoticz and Display Name... 62 Figure 127 - Domoticz Server Address and Login Credentials... 62 Figure 128 - Generic Sensor Data Provider... 63 Figure 129 - Generic Sensor Data Provider and Display Name... 63 Figure 130 - Generic Sensor Communication and Port... 63 Figure 131 - Adding Sensors... 64 Figure 132 - Libelium Sensor Data Provider... 64 Figure 133 - Libelium Sensor Data Provider... 65 Figure 134 - MQTT Server Information... 65 Figure 135 - Add Device button... 65 Figure 136 - Device Configuration... 65 Figure 137 - Add Sensor... 65 Figure 138 - Sensor Type... 66 Figure 139 - B-Scada Data Provider... 66 Figure 140 - B-Scada and Display Name... 67 Figure 141 - Base Address... 67 Figure 142 - Monnit Data Provider... 67 Figure 143 - Monnit Data Provider... 68 Figure 144 Monnit Server and Login Credentials... 68 Figure 145 - Default Update Rate... 68 Figure 146 - Report Summary... 69 Figure 147 - Rate Summary... 69 Figure 148 - Mapping Summary... 70 5
1 Overview This document outlines the purpose, configuration, and use of the Status Enterprise. For a list of frequently used terms, definitions, and abbreviations, see Part 1 Overview and Concepts. 1.1 About the Service The Service is a graphical user interface that connects live data from various sources (OPC UA, OPC DA, ODBC, and Custom) to properties on objects in the Status Object Model in the Status Server. Figure 1 - Status 6
2 Creating a Data Mapping Configuration A data mapping is creating a Status Server connection, a connection, and mappings between items that exist in both. As items change in one source they are updated in the other. Items can be updated in either direction. 2.1 Adding a Mapping Configuration First, select and connect to your Server. Figure 2 - Server Settings Once connected to the Server, select <New> on the toolbar or the File menu. Figure 3 - New Configuration Icon The Add New dialog box will appear. Create a name for your new Mapping Configuration and click <OK>. Figure 4 - Add New Dialog Box The name of your new configuration will appear in the Data Mapping Configurations window. Next, navigate to the Provider tab. Select a Data Provider from the 'Type' drop-down list in the 'Data Provider' section. Configure the Data Provider as desired. 2.1.1 Configuring a Data Provider Data Providers provide the raw data that will update property values on Assets in the Data Model. Changes in property values can also be configured to update values on items in the Data Provider. To configure a Data Provider, select the type of provider from the 'Provider Type' drop-down list. 7
Figure 5 - Data Provider Type List Different providers will have different configurations properties. For more information on the types of Data Providers see 'Data Providers' in section 4. Select a Data Provider, for example, OPCDA OPC Foundation Data Provider. Under Server Information type your Endpoint URL in the field provided, or click the 'Browse Servers' button to browse for an available server. Figure 6 - Browse Servers Button The Select Server dialog box appears. 8
Figure 7 - Select Server Dialog Box Select an OPC Server, for example, Matrikon.OPC.Simulation and then click <OK>. Figure 8 - Populated Endpoint URL Upon clicking the Connect button, the Heartbeat button becomes active. The Heartbeat can be used to show the connectivity of the to your Database. 9
Figure 9 - Heartbeat This is usually bound to an LED Light and will flash while you have connection. Click this button to browse your Model for a Boolean property. The Heartbeat must be used with a Boolean else it will not work. Figure 10 - Heartbeat Configuration 10
The Use Local Time Checkbox is used when users are polling for data. Check this box if you would like for your last value change to be given the Timestamp from your local computer instead of the Server Time. Figure 11 - Use Local Time Once you have configured your Data Provider, you will also need to configure your Status Server Connection. 2.1.2 Configuring a Status Server Connection Navigate to the Server tab. If you have connected to a Status Server previously, there should be a default configuration already provided. 11
Figure 12 - Status Server Configuration Tab You may accept the defaults, or edit the following fields: 2.1.2.1 Server Information Endpoint URL The Endpoint URL is the address of the Status Server. To override the default, click on the dropdown menu for options. Figure 13 - OPC UA Discovery Screen Double clicking in Remote will allow you to access another server. 12
Figure 14 - Enter Optional URL Screen 2.1.2.2 Security Settings Figure 15 - Security Settings Panel Security Policy and Message Security Mode Unless your network administrator advises, you may leave the Security Policy and Message Security Mode at their default values. 2.1.3 Misc. Settings Figure 16 - Miscellaneous Settings Panel 2.1.3.1 Keep Alive The Keep Alive setting counts the number of consecutive publishing cycles during which no notifications 13
have been reported to the client. If this maximum is reached while a subscription is still active, a Keep Alive message is sent to inform the client that the subscription is still active. 2.1.3.2 Default Session Timeout The number of milliseconds that a session will remain open without activity. 2.1.3.3 Operation Timeout The number of milliseconds that an operation will be attempted before it terminates. 2.1.3.4 Subscription Lifetime The Subscription Lifetime determines the number of times the publishing timer can expire without sending any notifications before the subscription assumes the client is no longer present and terminates. 2.1.3.5 Alternate Endpoint URL The Alternate Endpoint URL allows users to specify a different Status Enterprise Server(s) that the client can connect to if the main server goes down. For more information about setting up Alternate Endpoints, please refer to Client Server Redundancy found in Status Enterprise User Guide (Part 7) Status Server. Now, the Status is ready to accept new mappings. 2.2 Setting up a Password For additional security, you can set up a password for the. Open Status.DataConnector.Server.exe.config in notepad. This is located in Program Files\B- Scada\StatusEnterprise. Figure 17 - Passphrase 14
Type a password for the passphrase value (in between quotes) highlighted above. Restart the Data Connector service and the Status Enterprise service. 2.3 Configuring Mappings Once a Mapping Configuration is created, individual mappings need to be configured. Click the <Connect> button. Figure 18 - Connect Button Once connected, the <Connect> button will become grayed out and the <Disconnect> and <Configure Mappings> Buttons will all become selectable. Figure 19 - Disconnect and Configure Mappings Buttons Click the <Configure Mappings> button. The Mapping Configuration Dialog appears. 15
Figure 20 - Mapping Configuration Dialog Select a data item, property and attribute from your Status Server. Select a data item, property and attribute from your Data Provider. Click the <Add Mapping> button to create the mapping between the two items. The configured mapping will be highlighted below. Figure 21 - Mapping Added There are multiple options when it comes to handling the way mappings can be configured. The following is a brief overview of what each option does. 16
Mapping Modes None This is used if the entire mapping needs to be disabled temporarily. ToProvider This is used for writing data from the Server to the Data Provider only. ToServer This is used for writing data from the Data Provider to the Server only. TwoWay This is used if the need to read and write from both the Data Provider and Server is.required. ToServeronDemand This is used to activate the binding ONLY when there s a subscription running on that data item (e.g. viewing updates in the Data Model Browser or binding a control to that data item). Initial Value Data Provider The initial value on startup is set by the Data Provider. Server The Initial value on startup is set by the Server. None The values will be ignored until either the Server or the Data Provider send notification. Rate - This is how often the data is sent back and forth. Monitoring This is the how updates will be handled. Some providers will behave differently regardless of the selected monitoring. Disabled This will stop any updates for that mapping. Reporting When selected, it will only update when there is a change in the value. Polling When selected, it will continuously update whether the value is the same or not. Select the <Close Window> button to exit the Mapping Configuration Dialog. 2.3.1 Associate Mapping Another way of setting up a mapping is by using the Associate feature. This is helpful if you have data items in your provider that uses the same name most of the time. You can associate more than one mapping. In this example, we will be using the Battery and RSSI properties. Take note that this is case sensitive so the names should match for this to work. In the Status Server side, select the item where all your properties are located. Do the same in the Provider side. Right click and select Associate. 17
Figure 22 - Associate Mappings You will then be prompted to specify the mapping mode, rate, type of monitoring and where the initial value of the properties will come from. Once you are done customizing, click OK. You should be able to see your mappings created. Figure 23 - Associate Mappings Dialog 18
2.4 Testing Mapping Configurations Whenever you are finished adding new mappings, click the <Close Window> button to return to the main Configuration window. The Service will load and try to connect to the Status Server, and the Data Provider, and move live data between the Status Server and the Data Provider, based on the mapping configured. A change in property values from one will update the other. Select <Save> on the toolbar or from the File menu to save your new configuration. Figure 24 - Save Icon Select the Output tab to view the Output window. Figure 25 - Output Window To display information in the Output Window, enable Verbose. This will show specific information about your connection status, display a time stamp for when the mapping configuration was started, when a connection was established to the Status Server, when a connection was established to your Data 19
Provider, and a time stamp and code for any lost connections. The Output Window will also provide a running record of any value changes that are written to the server. Figure 26 - Enable Verbose Enable both Verbose and Generate Log File to create a log file. Log files are saved in the ProgramData\B-Scada\StatusEnterprise\DataConnector\LogFile. Note that configuring your data connector consumes one server connection. Running a test of the configuration starts the data connector service with your configuration and will consume a second connection. 2.5 Data Mapping Search and Filter Options The Search and Filter options are covered below. They are there to assist users in locating specific tags based off of name, or based off what tree view the tag resides in. 2.5.1 Setting Default Update Rate Figure 27 - Default Update Rate A default Server Update Rate and Provider Update Rate can be specified before adding a data mapping. This allows users the flexibility of adding different mappings with a set default values instead of manually changing the values for each mapping. 2.5.2 Search and Replace Figure 28 - Search and Replace Typing any characters in the search box and pressing the Find button on the screen or using the Enter key on your keyboard will result in the application searching for the string that was entered. If the application finds matching information it will highlight the first one that it comes to. If you hit enter again at this point it will move to the next one found in line. If no other matches are found, a dialog box informing the user that no more matches have been found will be displayed on screen as well as giving the user the option to start the search again from the top. 20
Replace is used together with Find. First, type any characters in the Search box to locate and then type what you want to change it into using the Replace box. This will search for the string that was entered in the Search box and once located, it will be replaced with the characters you have set in the Replace box. 2.5.3 Validating Mappings Figure 29 - Validate Mappings Clicking the Validate Mappings button will check and verify all your data mappings. A popup dialog box will appear to confirm completion. Figure 30 - Validation Complete If the path is invalid, it will change the color of the text to red. Figure 31 - Invalid Path 2.5.4 Mapping Filter Figure 32 - Mapping Filter Options There are two options with the filter, Show All and Show Selected. 21
Figure 33 - Show All Mapping Filter Show All will display all the mappings in the mapping configuration. Figure 34 - Show Selected Mapping Filter The Show Selected will show you the mappings associated with the selected item from the Status Server tree and lower. By looking at the above example, it only displayed the mappings listed from Mixed Air Temp and lower. 22
3 Data Providers There are seven Data Providers available to provide data to the Status Server. Custom Data Providers can also be created to supply data from any data source. Contact our support for more information on Custom Data Providers. 3.1 Database 3.1.1 Excel Data Provider A data driver that will read and write to a Microsoft Office Excel file. Microsoft Office must be installed on the same computer as the. Figure 35 - Excel Data Provider Under Database, select Excel from the Provider Type Combo Box. In the Data Provider Name section, the Display Name will show ExcelDataConfiguration. In the Available Workbooks, click the <Configure> button. Then in the Configuration Screen, click the <Add> button and select the Excel file you want to use. Figure 36 - Available Workbooks Configuration In the Name field, give the workbook a name. The Path will display the location of the file. If the file is password protected, specify a user name and password. Click the <Close Window> button to go back to the s main screen. 23
Figure 37 - Configure Range Click the <Configure Button> for Configure Ranges. In the Excel Data Configuration Window, click the <Add> button. Enter a Group Name and Range Name. To select a workbook, click the combo box and click the workbook you want to use. Do the same for Worksheet. In the Range field, enter a range of cells (i.e. A1:C1). Keep the default Update Rate or specify a new one in milliseconds. Click the <Close> button to go back to the main screen. 3.1.2 ODBC Data Provider Figure 38 - ODBC Data Provider ODBC data sources allow you to connect to different types of data sources using Windows ODBC drivers. Some common data sources would be Excel, Access, and MySQL. 24
Figure 39 - System DSN A System DSN needs to be created in the ODBC Data Source utility in the Windows Control Panel, under Administrator Tools. Figure 40 - ODBC Data Provider and Display Name Under Database, select ODBC from the Provider Type Combo Box. In the Server Name section, the Display Name will show ODBCProviderConfiguration. Figure 41 - Server DSN and Login Fields Under Server Information, select the DSN (data source name) of the ODBC driver and the server you will be connecting to. If you set up a Login and Password, you will need to enter it in the corresponding fields. 25
Figure 42 - Add Query Click the <Add> button in the 'Queries' section. Figure 43 - Query Builder Button Query1 is created. Click the <Query Builder> button in the same row as Query1. Figure 44 - Query Builder The Query Builder dialog box appears. Select the table and the column you wish to query. You can check the Include Views check box if you would like to view more tables. After typing your query, you can click <Test Query> button and the Value dialog box appears with the results. Once you are satisfied with your query click the <OK> button to save your query in the Read Query text box and exit the Query Builder. You can also enter your query in the Write Query text box. 26
Figure 45 - Queries You can rename your newly created query by selecting the text in the Query Name text box and entering a new name. To create more queries, click the <Add> button. To remove a query, click the <X> button adjacent to the query you wish to delete. Field Type Description Name* String Sets the name of the data source. DSN* String The name of the ODBC driver and server you will be connecting to. IsArray Boolean Will return an array of values if checked. Login Password Update Rate* Queries Query Name String String Double String String Only used if user was set up in the ODBC configuration. Only used if user was set up in the ODBC configuration. How often the client will query the ODBC Server for changes. The section where you will build your ODBC queries. The name of your query, this will also be the "tag or item" name. Query String The logic for your query. *Required 3.2 Misc 3.2.1 Data Simulation Provider 27
Figure 46 - Data Simulation Provider The Data Simulation Provider provides random data. Figure 47 - Data Simulator Data Provider and Display Name Under Misc, select Data Simulator from the Provider Type Combo Box. In the Data Provider Name section, the Display Name will show SimulationProviderConfiguration. Figure 48 - Configurable Data Items Configurable Data Items Section allows users to specify data items to be used in the Data Mapping. Select a Data Item from the List. Then, enter a Folder name. The Display Name is automatically 28
populated when you select the Data Item. You can leave it as is or change the name. Then, click the <Add> button. Figure 49 - Configure Property The Folder and its data item will be created in the document tree located on the left side of the screen. Expand the folder and select the Data Item. Depending on the Data Type, a set of options will be given to you to further configure the property. Then, click <Update Items> button to save the changes you have made. 3.2.2 REST Data Provider Figure 50 - REST Data Provider The REST Data Provider is a data mapping configuration that interfaces with a RESTful service over the HTTP protocol to allow the user to make API calls to the service. 29
Figure 51 - REST Data Provider and Display Name Under Misc, select REST Data Provider from the Provider Type Combo Box. In the Server Name section, the Display Name will show as RESTDataProviderConfiguration. Figure 52 - Service Information Under Service Information, enter the host address of the RESTful service and the Update Rate. By default, it is set as localhost with 1000ms update rate. Users can also define a username and a password for hosts that require login credentials. Under Data Item Descriptions, click the <Add> button to add a data item. Figure 53 - Add Item Under the Basic Settings, type a group and display name. Then, configure the following: Request Path A required field that specifies the path of the URL for a particular service feature. Verb A require field that specifies the method or action to perform. Response Format A required field that informs the provider the format of the expected response. Xml/JsonPath An optional field that will allow users to specify the part of the response data that the data item will store as its value. If unspecified, the entire response will be stored. 30
Figure 54 - REST Data Provider Basic Settings Under Advanced Settings, there are additional settings that can be configured. Headers Adding headers to the request is optional. Any specified custom headers will be sent with the HTTP request to the service. Query Parameters Adding query parameters is optional. Any specified parameters will be appended to the URL. This field allows the user to specify the scope and filtering of a request. Figure 55 - REST Data Provider Advanced Settings When POST is selected as the Verb, there are other fields that will be exposed apart from the Headers and Query Parameters. Content Type This is type of data of the message body of a POST request. PayLoad This is the message body sent in a POST request. 31
Figure 56 - POST Advanced Settings 3.2.2.1 Usage Examples Each API is different so the settings will vary. You may need to contact the owner of the API to make sure that you are using the correct syntax and parameters. Example 1: JSON In this example, we will be using Recipe Puppy s API service to request for omelet recipes that has garlic and onions as ingredients. We will be using the following request settings: 32
Figure 57 - REST JSON Request Example This is the JSON response that you will get: 33
Figure 58 - REST JSON Response Example Example 2: XML In this example, we will be using Google Map s API service to request information about Chicago. We will be using the following request settings: 34
Figure 59 - REST XML Request Example This is the XML response that you will get: 35
Figure 60 - REST XML Response Example 3.2.3 Status Machine Edition Data Provider 36
Figure 61 - Status Machine Edition Data Provider A Machine Edition Status Server Data Provider supplies data from a Status Machine Edition data server. Figure 62 - Status Machine Data Provider and Display Name Under Server Name, select Status Machine Edition from the Provider Type Combo Box. In the Server Name section, the Display Name will show StatusMachineEditionProviderConfiguration. Figure 63 - Status Machine Edition Browse Button Under the Server Information, click the <Browse Servers> button or manually enter the address for the Endpoint Url. 37
Figure 64 - Machine Edition Server Browse The Browse Servers dialog box will appear. Figure 65 - Populated Server Information Select an available Status Machine Edition Server, for example, Status Server and then click <OK>. The Endpoint Url will be populated. Figure 66 - Connect Button Click the <Connect> button. Figure 67 - Server Node List The Server Node drop-down list will be populated. Figure 68 - Server Node 38
Select a server node, for example, MatrikonOPCSimulation and then click the <Connect> button. You can check the User Secure Channel (WsHttp) check box if you would like to use a secure channel. 3.2.4 Stock Quote Figure 69 - Stock Quote Data Provider The Stock Quote Provider supplies stock quotes data. Figure 70 - Stock Quote Data Provider and Provider Name Under Misc, select Stock Quote from the Provider Type Combo Box. In the Data Provider Name section, the Display Name will show StockQuoteConfiguration. 3.3 OPC 3.3.1 OPCDA Data Provider An OPC DA Data Provider provides data from an OPC DA Server. There are two choices when requiring an OPCDA Data Provider. The two data providers are slightly different however, most of the functionality is the same. The Client Data Provider works a little better with some OPC Servers than the OPC Foundation Data Provider. 39
3.3.1.1 OPCDA Client Data Provider Figure 71 - OPCDA Client Provider Figure 72 - OPCDA Client Data Provider and Display Name Under OPC, select OPCDA Client from the Provider Type Combo Box. In the Server Name section, the Display Name will show OPCDAClientProviderConfiguration. Figure 73 - OPCDA Client Browse Button In the Server Information section, click the <Browse> button. Like the OPC Foundation Data Provider, the Select Server dialog box will appear. Once you have selected the server, both the Machine and OPC Server will be populated. 40
3.3.1.2 OPC Foundation Data Provider Figure 74 - DA OPC Foundation Data Provider Figure 75 OPC Foundation Data Provider and Display Name Under OPC, select OPCDA OPC Foundation from the Provider Type Combo Box. In the Server Name section, the Display Name will show OPCDAProviderConfiguration. Figure 76 - Browse Button Under Server Information, click the <Browse Servers> button to select an Endpoint Url. 41
Figure 77 - Select Server Dialog Box The Select Server dialog box appears. Figure 78 - Endpoint URL Select a server, for example, Matrikon.OPC.Simulation and then click <OK>. The Endpoint Url will be populated. 42
3.3.2 OPCUA Data Provider Figure 79 - OPCUA Data provider An OPC UA Data Provider provides data from an OPC UA Server. Figure 80 - OPCUA Data Provider and Display Name Under OPC, select OPCUA from the Provider Type Combo Box. In the Server Name section, the Display Name will show OPCUAProviderConfiguration. Figure 81 - OPCUA End Point URL Browse Button 43
Under Server Information section, manually enter the address or browse for the UA Server by clicking the <Browse Servers> button for the Endpoint Url. Figure 82 - OPC UA Discovery Dialog Box The OPC UA Discovery dialog box appears. Select an available OPC UA Server. Figure 83 - Remote Selection You can also connect to an OPC UA Discovery Server to locate available OPC UA Servers. Double-click on the 'Add Discovery Server' tree item. Figure 84 - Enter URL Dialog Box The Enter Url dialog box appears. Enter a Url and click <OK>. 44
Figure 85 - OPCUA Security Settings Select the Security Policy and the Message Security Mode if necessary. Figure 86 - OPCUA Authentication Settings Enter a username and password or select a certificate if your server requires authentication. Figure 87 - OPCUA Misc Settings Miscellaneous Settings: Keep Alive This is how often the client will ping the server to check if its online. Default Session Timeout This is the amount of time a session will stay connected after a period of inactivity. Operation Timeout This is the amount of time a connection will remain active when the server is taking too long to complete a command. Subscription Lifetime This is the amount of time to wait for new updates before the subscription is removed from the server. Data Change Trigger Status When selected, data will only update when there s a change in the quality. StatusValue When selected, data will only update when there s a change in the value. StatusValueTimestamp When selected, data will only update when there s a change in the server timestamp regardless if value stayed the same or has changed. 45
3.4 PLC 3.4.1 Allen Bradley Data Provider Figure 88 - Allen Bradley Data Provider The Allen Bradley Data Provider is used to connect to an Allen Bradley PLC device for monitoring data from various memory addresses on the device. It supports most models including Micrologix 1400. However, it does not currently support the Micro 820 models. Figure 89 - Allen Bradley Under PLC, select Allen Bradley Data Provider from the Provider Type Combo. 46
Figure 90 - Add Transaction Click <Add> button to add a new transaction. Figure 91 - Transaction Item Groups The transaction items are grouped by the type of protocol. Then, select the newly created transaction to edit additional settings. Assign the protocol for the corresponding PLC model. The Allen Bradley driver supports DF1 (serial-rs232), Ethernet/CIP and CLGateway (specifically for Control Logix 1756-DHRIO module). Figure 92 - Protocols By default, the Display name is set to TransactionItem. Below that is the Protocol list. There are three protocols to choose from: Serial, Ethernet and Gateway. 47
Depending on the combination of the selected protocol and device, different device settings and parameters will be displayed. All protocols will have the following parameters: Start Address Sets the starting PLC register address used for read/write operations. Data Length Sets the length of data to read or write. Bit Position Position of the bit within a data word that will be set or cleared. Timeout The length of time in milliseconds that the provider will wait for a communication response. Memory Type Specifies the data type of the memory address to use in the transaction. Additional fields will be displayed depending on the selected device. Figure 93 - Parameters 3.4.1.1 Serial Protocol Figure 94 - Serial Protocol 3.4.1.1.1 Device Settings PLC Model List of all supported devices that can communicate through a serial interface. PLC Node Address Sets the Data Highway address of the control on the network. This must be a value between 0 and 376 (inclusive). PLC Address Sets the address for the target Allen-Bradley device. Transmission Mode Sets the transmission mode to either Half or Full Duplex. Error Checking Sets the error checking method for the protocol to either BCC (block check character) or CRC (cyclic redundancy check) error checking. 48
3.4.1.1.2 Additional Parameter File Address Sets the address or file number of the data table file that is to be operated on in the transaction. 3.4.1.2 Ethernet Protocol Figure 95 - Ethernet Protocol 3.4.1.2.1 Device Settings PLC Model List all the devices supported with the Ethernet protocol. EIP Model Sets the Ethernet/IP device model. This setting is only available when EthernetIP has been selected as the PLC Model. Server Address Address of remote server or PLC device. Port Port number used to communicate with the specified server address. 3.4.1.2.2 Additional Parameter File Address - This parameter is only available when EthernetIP has been selected. 3.4.1.3 Gateway Protocol Figure 96 - Gateway Protocol 49
3.4.1.3.1 Device Settings Logix Device Model Displays the Logix device model. PLC Address Sets the address of the target Allen Bradley device. Channel Sets the channel on the 1756-DHRIO module that the PLC is attached to. Slot Sets the slot number of the 1756-DHRIO module in the device chassis. 3.4.1.3.2 Additional Parameters Tag Name Sets the tag to be read from or written into the PLC. Struct Length Sets the length of the structure. 3.4.2 Siemens S7 Data Provider Figure 97 - Siemens S7 PLC Data Provider The Siemens S7 Data Provider is used to connect and receive data from Siemens PLC Server. Figure 98 - Siemens S7 PLC Under PLC, select Siemens S7 PLC from the Provider Type Combo. 50
Figure 99 - PLC Configurations In the PLC section, the Display Name will show S7DataProviderConfiguration. Enter the location or IP address of the data provider in the Address field. Then, specify the CPU Type, Rack number and Slot number you want to connect to. The Siemens Data Provider supports S7 200, 300, 400, 1200 and 1500 series and accepts Ethernet connection. Figure 100 - Data Points Add Data Points by clicking the <Plus> button. Then, specify the Group, Name and Address of the Data Point. 3.5 Protocol 3.5.1 Modbus TCP Extended 51
Figure 101 - Modbus TCP Extended Data Provider The Status Enterprise Modbus TCP Extended is a data provider that allows the Status Enterprise to communicate with any device that implements a Modbus slave interface. It uses the Modbus / TCP protocol to communicate. Figure 102 - Modbus TCP Extended Data Provider and Display Name Under Protocol, select Modbus TCP Extended from the Provider Type Combo Box. In the Server Name section, the Display Name will show ModbusDataProviderConfiguration. 52
Figure 103 - Server Information In the Server Information, enter the IP address of the data provider that you wish to use with Modbus. Figure 104 Configuration Under Configuration, there is an option to use 32-bit boundaries which will allow querying a pair of registers. Below that are settings for byte and word ordering. Figure 105 - Data Points Add Data Points by clicking the <Add Data Points> button on the screen. With the newly created Data Point still selected, you can change its settings under Selected Mapping. The Modbus Simulator has 4 Types of Tags that can be bound too. They are found in the Table drop down box of the Data Points panel. Table Data Direction Type Beginning Address Asset property data type Coils Read / Write Digital 00000 Boolean 53
Discrete Inputs Read only Digital 10000 UInt Input Registers Read only Analog 30000 UInt Holding Registers Read / Write Analog 40000 Boolean Figure 106 - Modbus Tag Table These tags will need to be configured before use. The Table above will inform you what type of property can be bound to which tag. Properties MUST match the data type specified for each tag. If the Properties and the data types do not match, you will not get any data. 3.5.2 Modbus TCP Server Data Provider Figure 107 - Modbus TCP Server Data Provider The Modbus TCP Server Data Provider uses a Modbus TCP protocol to communicate. Its difference with the Modbus TCP Extended Data Provider is that it acts as a slave accepting multiple requests from different masters. 54
3.5.3 MQTT Broker Data Provider Figure 108 - MQTT Broker Data Provider MQTT Broker Data Provider interfaces with MQTT clients and allows publishing and subscribing to message topics. Users will be able to map data items to various message topics that can be bound to existing properties in the data model. Figure 109 - MQTT Broker Data Provider and Display Name Under Protocol, select MQTT Broker from the Provider Type Combo Box. In the Server Name section, the Display Name will show MqttBrokerConfiguration. 55
Figure 110 - MQTT Broker Information Set the port number that the server will run on. By default, it is set to 1883 which is the default port used by the MQTT messaging protocol. Set the Retain Period and enter a passphrase and secret, if necessary. Figure 111 Add Subscription Click the <Add> button to create a new subscription. Figure 112 Subscriptions Select the newly created subscription and type a category. Subscriptions with similar categories will be grouped together. Then, enter a name to identify the subscription and the message topic. 56
3.5.4 SNMP Figure 113 - SNMP Data Provider The SNMP Data source can be used to monitor devices on your Network. SNMP tags are bound to String Properties in Status Enterprise. Figure 114 - SNMP Data Provider and Display Name Under Protocol, select SNMP from the Provider Type Combo Box. In the Server Name section, the Display Name will show SnmpProviderConfiguration. 57
Figure 115 - SNMP Peer Information Enter an IP Address and its corresponding port. Check Enable Traps if you want to subscribe to the Trap Listener Service. Then, create a new Community called public in your SNMP Properties. It needs to have rights to Read and Write. The Poll Rate will allow you to define how often the data is updated. This is set in Milliseconds. Figure 116 - Object OID In the Objects section you define a name for your object and assign the correct OID number. This is done by right clicking and selecting Add. Also, there is a bindable flag in the SNMP Provider to determine if an SNMP device is in a reachable state. 58
3.6 RFID 3.6.1 Empress Data Provider Figure 117 - Empress Data Provider The Empress Data Provider is used to gather and interpret data from Empress RFID readers. Figure 118 - Empress and Display Name Under RFID, select Empress Data Provider from the Provider Type Combo Box. In the Data Provider Name section, the Display Name will show EmpressDataProviderConfiguration. Figure 119 - Reader Information Enter the address or location for the reader. Select the Connection Type whether its TCP or via a Serial Port. 59
Figure 120 - Reader Settings Under Reader Settings, users can configure the Antenna Gain, Frequency, Channel and Read Interval. 3.7 Sensors 3.7.1 B&B Smartworx Figure 121 - B&B SmartWorx Data Provider The B&B SmartWorx Data Provider is used to connect and receive data from B&B SmartWorx Web Server. SmartWorx tags can be bound to String properties in Status Enterprise. 60
Figure 122 B&B SmartWorx Wzzard and Display Name Under Sensors, select B&B SmartWorx Wzzard from the Provider Type Combo Box. In the Server Name section, the Display Name will show SmartWorxWzzardConfiguration. Figure 123 - Server Information Enter the address or location for the data provider and its corresponding port. Figure 124 - Nodes This area holds the nodes that your tags exist in. New Nodes can be added at any time as needed. These two Nodes are already configured for you and are ready to go. 61
3.7.2 Domoticz Data Provider Figure 125 - Domoticz Data Provider The Domoticz Data Provider gathers and interprets data from sensors and other devices that uses the Domoticz system. Domoticz is an open source home automation system that monitors and configures sensors and devices like lights and switches. Figure 126 - Domoticz and Display Name Select Domoticz Data Provider as the Provider Type. The Display Name will show DomoticzDataProviderConfiguration. Figure 127 - Domoticz Server Address and Login Credentials Enter the location of the Domoticz server in the Address and its corresponding Port. Then, enter the username and password for the server. 62
3.7.3 Generic Sensor Data Provider Figure 128 - Generic Sensor Data Provider The Generic Sensor Data Provider gathers data from sensors that connects to the network with its own IP address. It supports TCP/IP and HTTP communication. Figure 129 - Generic Sensor Data Provider and Display Name Under Sensors, select Generic Sensor from the Provider Type combo box. The default display name is SensorProviderConfiguration. Figure 130 - Generic Sensor Communication and Port Select the type of communication and then, specify the port that the sensor is using. It is set to 5562 by default. 63
Figure 131 - Adding Sensors Click the <Add> button to add a new sensor. Select the newly added sensor to configure. Type a name, IP address and Property ID. Write Options will only work if the sensor that you are using supports writing data. 3.7.4 Libelium Sensor Data Provider Figure 132 - Libelium Sensor Data Provider The Libelium Data Provider is a data mapping configuration that subscribes to an MQTT Broker for receiving Libelium sensor data. 64
Figure 133 - Libelium Sensor Data Provider Under Sensors, select Libelium Sensor Data Provider from the Provider Type Combo Box. Figure 134 - MQTT Server Information Enter the address or location for the data provider and its corresponding port. Figure 135 - Add Device button To add a device, click the <Add> button. Figure 136 - Device Configuration After adding the device, you can now enter a Display Name, Device ID and Secret Key. Figure 137 - Add Sensor Start adding sensors by clicking <Add Sensor> button. This will create a line item. 65
Figure 138 - Sensor Type Enter a Display Name for the sensor. You can specify the type of sensor by clicking on the sensor column. Once the sensor type is selected, it will automatically fill the Sensor ID. Once you are done adding sensors, click the Update button. 3.7.5 B-Scada Sensor Data Provider Figure 139 - B-Scada Data Provider B-Scada is a cloud based monitoring system which allows gathering and interpreting of data from B- Scada Sensors. 66
Figure 140 - B-Scada and Display Name Under Sensors, select B-Scada Provider from the Provider Type Combo Box. In the MST Connection section, the Display Name will show MSTDataProviderConfiguration. Figure 141 - Base Address Use Base Address to enter the location or IP address of the data connector. 3.7.6 Monnit Data Provider Figure 142 - Monnit Data Provider 67
Monnit Data Provider gathers the data coming from Monnit Sensors, B-Scada Sensors, and Phase 4 Sensors. These sensors can read Temperature, Voltage, Motion, etc. The Monnit data provider tags can be bound to String properties in Status Enterprise. Figure 143 - Monnit Data Provider Under Sensors, select Monnit from the Provider Type Combo Box. In the Data Provider Name section, the Display Name will show MonnitConfiguration. Figure 144 Monnit Server and Login Credentials Under Server, enter the location or address of the data provider. Then, assign your username and password that you created from the Monnit website. Figure 145 - Default Update Rate You can assign the Update Rate and the Poll History of the configuration. This is where you set up how often the Data will be updated. 3.8 Custom Data Provider Creating a custom data provider to your own data can be done by creating a.net assembly that implements a couple of simple interfaces. Contact us for sample code for a data provider, or for more information on having us write a data provider for you. 68
4 Report Summary The Report Summary provides an overview of the data mapping configurations. To access the Report Summary, click View and then select Summary. It has two tabs categorized as Rate and Mapping. Figure 146 - Report Summary The Rate tab has three columns: Update Rate, Tag Count and Demand Count. The Update Rate shows the Data Provider Update Rate, the Tag Count shows the number of mappings and the On Demand Count displays the number of mappings configured for On Demand as its mapping mode. Figure 147 - Rate Summary In the example above, it displays that there are two mappings with an update rate of 5000 (5s), one mapping with an update rate of 6000 (6s). In the last row, it shows that there s a total of two mappings with a 10000 (10s) update rate and one of which is on To Server On Demand mode. 69
Figure 148 - Mapping Summary In the example above, it displays there are two mappings found in the mapping configuration called excel. Additionally, the mapping configuration simulator has a total of three mappings and one of which is in To Server On Demand mode. 70
5 Additional Information and Support For more information in using Status Enterprise, please visit us at www.scadauniversity.com. This will give you access to instructional videos, documentation and our online forum. You can also email B- Scada support at support@b-scada.com. B-Scada, Inc. 9030 W. Fort Island Trail Building 9 Crystal River, FL 34429 USA +1 352-564-9610 www.scada.com 71