Last revision: 11/3/2017
Our Wonderware HMI SCADA YouTube channel contains instructional and promotional videos on our various product lines. Please follow the links below:
Platform Connectivity and Device Integration Playlist
https://www.youtube.com/playlist?list=PLJq4rR8tWINwTpCnlHqjUUlysBClU-YqU
Wonderware HMI SCADA Channel Main Page
https://www.youtube.com/user/wonderwarehmi
The Wonderware Operation Integration - Supervisory WEBSVC OI Server is an information exchange system, that allows programs and application to communicate with each other over the network. It supports programs and applications built using different technologies, running on different platforms and frameworks, and, can be local, distributed, or web-based. It subscribes to data from web service(s) on internet or intranet, and operates in standalone mode. It provides the common functionality and behavior of the OI Core, including multi-instance and multi-version support.
This document contains important information about the WEBSVC OI Server. Review this document for known issues and changes to WEBSVC OI Server.
Centralized (Activation-Based) Licensing Support
The WEBSVC OI Server operates with activation based licensing. The Schneider Electric Licensing components (License Manager and License Server) are selectable features during the OI Core install. For additional information about centralized (activation-based) licensing, refer the OI Server Manager Help.
Support for Client Protocols
The WEBSVC OI Server supports communications with client web services over an HTTP/S network using the following communication protocols:
The support for SOAP or REST protocol depends on which connection the web services support. The client applications connect to the WEBSVC OI Server using OPC/SuiteLink or DDE/FastDDE protocols.
Supported Authentication Modes
The REST interface of the WEBSVC OI Server supports the following authentication modes, depending on the web service being connected.
Note: The WEBSVC OI Server does not support the authentication for SOAP-based web services at the time of this release.
Automatic and Trigger-based Polling for Data Requests
The WEBSVC OI Server supports both automatic (time-based) and trigger based (on demand) polling to trigger a data request.
In automatic polling, the WEBSVC OI Server automatically requests the data from the web service client it regular time intervals based on the configured polling period.The polling period should be set greater than the test response time to ensure that the runtime collects data from the driver after a trigger.
In trigger-based (on demand) polling, the WEBSVC OI Server requests the data from a web service client upon receiving a trigger (command). To perform trigger-based (on demand) polling, set the update interval time to zero to prevent automatic polling.
XML and JSON Payload support
The format of the result set received from the client depends on the connection supported by the web service.
These result sets are parsed by the WEBSVC OI Server and individual parameters are exposed as references that can be easily addressed individually.
Key Features of REST-based Web Service Connections
Some of the key features of REST-based web service connections are listed below:
Device-Time Mapping
Each payload from a web service has an associated time value, that shows the time of occurrence of an event. By default, the OI Server would time-stamp the references with the local time from the computer running the OI Server, and not the time the event occurred.To obtain an accurate timestamp value of a data field, the REST-based connections support the &T& syntax, that concatenates the data field and the time field.
<Value_Reference>&T&<Time_Reference>
If a value item is X and the time item is Y, the resulting read-only item X&T&Y displays the value X timestamped with the value of Y. For more information, see Item Syntax for VTQ Timestamp in the WEBSVC OI Server Help.
Exporting and Importing Data Items
You can export and import the OI Server item data to and from a CSV file after you configure the Device Items. This lets you perform an off-line, large-scale edit on the item data configured for a PLC and import that data back into the PLC configuration. During the import process:
For more information about exporting/importing data items, see the WEBSVC OI Server Help.
For a list of supported operating systems for OI Servers, refer to the Wonderware Compatibility Matrix, available at the Schneider Electric Global Customer Support website:
https://gcsresource.invensys.com/ProductCompatibility/HTMLClient
Enter the product name in the search box, select the product from the results, and then select the View Product icon to see product details.
To run an OI Server, the following hardware configurations are the minimum recommended:
Installation Checklist
The Wonderware Operations Integration Core (OI Core) must be installed prior to the installation of the OI Server.
Before installing the OI Server, it is strongly recommended that you exit all Wonderware programs, including executable (.EXE) files and services.
Installation Procedure
Download the OI Server from the Schneider Electric Software Global Customer Support website:
https://softwaresupportsp.invensys.com/Pages/NewProductHub.aspx
To install the OI Server, double-click Setup.msi. When setup is complete, the message "Setup was successful" is displayed.
The WEBSVC OI Server supports silent (command line) installation. This feature enables non-interactive installation of the WEBSVC OI Server.
Silent Installation Syntax
The basic syntax of the silent installation command consists of the full path to the setup.bat file (typically the DVD drive designation on your local computer), and the command line switch for silent installation/un-installation.
<DVD>: CD-WEBSVC>Silent_Install_Setup.bat /<argument>
The usage instructions can be retrieved by the following command line:
<DVD>: CD-WEBSVC>Silent_Install_Setup.bat /?
The above command line returns the supported operations - install and uninstall. The /install and /uninstall switches completely disable the graphical user interface of Setup.bat. There is no input from or feedback to the end user.
To install the WEBSVC OI Server (Silent Install)
C: CD-WEBSVC>Silent_Install_Setup.bat /install
To uninstall the WEBSVC OI Server (Silent Uninstall)
C: CD-WEBSVC>Silent_Install_Setup.bat /uninstall
There are no resolved issues in this release.
The following are the known issues in this release.
Query tags not updated on network disconnect |
If the network is disconnected before the OI WEBSVC is activated, the written input or query tags may not be read back by the client as an update. The written values are cached in the OI WEBSVC memory but will not be read by the client or used by the OI WEBSVC until the network is reconnected. |
Runtime activated without password or client secret |
In the REST editor, if an authentication is selected, and the password or client secret is entered, one or both of the following warning messages may appear in the logger when the runtime is activated. "Failed to retrieve password - Client does not have permission to access this secret" "Failed to retrieve client secret - Client does not have permission to access this secret" Workaround: Enter the password or client secret, save the configuration, and then deactivate and activate the runtime. |
The WEBSVC OI Server documentation set includes the following guides:
| Avantis | Industry Software Suites | OASyS | SimSci | SimSuite | Skelta | Wonderware | |
|
Copyright © 2017 Schneider Electric Software, LLC. | Contact Us |