earth_america
user_standard Log on
action_search_stroke
earth_america
Log on to rate and give feedback 1 2 3 4 5 Log on to rate
0
How to

How to


Products: AS-B, Edge Server, Enterprise Central, Enterprise Server, AS-P, Virtual Project Servers
Functionalities: Web Services
Product version: 2024
4/8/2024

Connecting to a Proxy Server

To be able to access an external site when your internet access setup is going through a proxy server, the connection to the proxy server must be configured in the SOAP Web Service interface or the Simple XML Web Service interface.

Show More
action_close

Web Services is a way to translate information in XML format so that it can be understood by EcoStruxure BMS servers and displayed in WorkStation. When you create a Web Service interface, you can add XML elements from the server providing the Web Service. The XML elements are then translated into values in an EcoStruxure BMS server.

When you create the Web Service interface, you can also select the content of the XML element, the attribute or the whole XML node. Selecting a node can be useful if you, for example, want to use a Script program to parse the XML code.

 
action_zoom_plus_stroke Web Service interface in the EcoStruxure Building Operation software

Web Service interface in the EcoStruxure Building Operation software

When the XML element is translated into an EcoStruxure Building Operation value, the value can be used as any other value in the EcoStruxure Building Operation software. The value can be connected to an alarm, it can be logged, it can be presented in a graphic or in at trend log list or a trend chart. The value can also have its unit changed and it can be forced.

 
action_zoom_plus_stroke An XML element translated into a value in the EcoStruxure Building Operation software

An XML element translated into a value in the EcoStruxure Building Operation software

There are three ways to translate the XML element, each with their own specific interface:

  • Simple XML Web Service

  • SOAP Web Service

  • Script Web Service

Script Web Services

Web Services are designed to support interoperable, machine-to-machine interaction over a network. As a result, it makes perfect sense to use a Web Service from a programming language, such as Script. For more information, see Script Web Services .

Simple XML Web Service

The Simple XML Web Service is used for REST and standard XML files. For more information, see Creating a Simple XML Web Service Interface .

SOAP Web Service

The SOAP Web Service interface in the EcoStruxure Building Operation software is used for SOAP. SOAP requires a URL to the Web Service itself and a WSDL file. The WSDL file defines the operation parameters in SOAP. For more information, see Creating a SOAP Web Service Interface .

Limitations

The XML response, that is the XML file information sent to the EcoStruxure Building Operation software, has some limitations:

  • The limit for the whole XML response is 100 kilobytes, which includes manually created values.

  • The limit for a string value is 10 kilobytes, which includes manually created values.

  • The maximum number of values created in the Web Service interface is 200.

  • The recommended limit for XML elements in the Web Service interface is 100 XML elements at a polling rate of 60 seconds.

Limitations regarding Simple XML Web Service

Only values within quotes in the XML file can be read by the Wizard. Values within angle brackets cannot be read by the Wizard.

For more information, see The Create Web Service Values Page in the Wizard is Empty .

Limitations regarding SOAP Web Service

Ensure the WSDL-file meets these criteria:

  • does not import other WSDL-files

  • is in DOC style (RPC is not supported)

  • does not contain array parameters.

For more information, see SOAP Web Service Interface Cannot be Created .

Manually Created Values

Even if the EcoStruxure Building Operation software automatically creates all the select values from the XML file on the server providing the Web Service it is sometimes necessary to create new values manually in the EcoStruxure Building Operation Web Service interface. For example, if the XML element presents a float value without any decimal separator, the EcoStruxure Building Operation software correctly interprets this as a multistate value.

However, if the value displays, for example a temperature, it is more convenient to have this as an analog value in the EcoStruxure Building Operation software. In this case you add a new analog value in the EcoStruxure Building Operation Web Service interface and connect it to the XML element using the XPath Editor.  For more information, see Adding a New Value to the Web Service Interface .

Note:

The manually created value will get a default value until the first polling.

Time Stamp Values

XML elements with text strings that are formatted according to ISO 8601 are translated to Time Stamp values if they are selected when you create the Web Service interface. The time stamp values can be used to show date and time, for example, in graphics that present other information from the server providing the Web Service.

Request Parameters

Request parameters can be separated from the Service URL.

This is done when you want to bind a variable on EcoStruxure Building Operation server to the request parameter on the Web Service server.

For example, you can use the current day as an input request parameter by binding the request parameter property to a variable that holds the current day.

For more information, see Configuring Request Parameters .

Proxy Servers

To be able to access an external site when your internet access setup is going through a proxy server, the connection to the proxy server must be configured in the SOAP Web Service interface or the Simple XML Web Service interface.

For more information, see Connecting to a Proxy Server .

To connect to a proxy server
  1. In WorkStation, in the System Tree pane, select the web service interface.

  2. On the File menu, click Properties .

  3. In the Use proxy server list, select Enable .

  4. In the Proxy adress box, type the address to the proxy erver.

  5. In the Proxy port box, type the port.

  • Web Services
  • Creating a Simple XML Web Service Interface
  • Creating a Simple XML Web Service Interface
  • Adding a New Value to the Web Service Interface
  • Changing the XPath for a Value