Evse REST (Connector) Data Source

Last modified on 2023/07/17 16:38

Apps - Datasource - EvSE REST Connector icon.png This data source belongs to the Online category in the data source library. It uses a connector to access a service (websites or third-party products) in order to retrieve dynamic content using REST API HTTP request methods.


==> Thanks to REST architecture, the position of the ISS can be displayed using a Google Maps widget without requiring user authentication.

  • Retrieve elements from a Trello table, e.g. cards and the detailed information in each card.
  • Retrieve elements from a wiki website like EasyVista, e.g. a specific page or section based on a keyword.
  • Display different views of corporate data for users from Salesforce, e.g. lists of customers, prospects, projects or sales employees.


     Open url.png See General remarks on data sources

List of properties


Evse Connector: REST connector linking Service Manager and the monitoring tool, used by the data source for accessing the service and its resources.

Resource: List of resources available for the service, i.e. resources predefined by EasyVista and manually added resources.

  • You must first create the resources in Service Manager by selecting Administration > REST > Resources in the menu. Open url.png See Configuration of REST action types
  • The default resource defined in the connector is proposed.

Custom Params: List of fields where contextual values can be applied.

  • Context Key: Available fields that are automatically retrieved from Service Manager. These are variables specified in the connector and in the resource.Open url.png See Configuration of REST action types
             Example Custom Params - Parameters in Service Manager.png
    • Static mode option (default option): Used to apply a fixed value or a string of characters that may vary based on the user language, through the use of the Translation Tags Picker. Click Multilingual labels icon.png to access the tool.
               Example Custom Params - Parameters in Service Apps - Option Static mode.png
    • Select an app data source: Used to apply the value of a column from an app data source.
               Example Custom Params - Parameters in Service Apps - Option Datasource.png

Configure Field Types: Used to open the field editor that enables you to select data source fields and specify the type of each field, e.g. date, integer, etc. when this is not automatically detected.

  • The Apps - datasources Properties - Preview button.png button below the property shows the number of rows (max. 15) and columns extracted. Click to open the editor.
  • The button will display No data available as long as you have not selected any of the mandatory elements for the data source.
  • In edit mode, only the first 15 data source records are displayed.
  • In execute mode, all of the data source records are displayed.
  • Data in static data sources comes from the last file upload.
  • Data in dynamic data sources is refreshed when you open the app in edit mode.

Select First Row As Current Record: Used to indicate if the first record of the data source, when displayed in widgets, is selected by default (box is checked) or not (box is not checked).


No Data Message: This message is displayed when the data source does not contain any data.

  • Enter the code directly in the field or click Apps - Edit Html icon.png to open the text editor

Auto Refresh (Note: Only for dynamic data sources): Used to indicate the automatic refreshment interval for data from the data source in hours/minutes.

  • Data is automatically refreshed each time the app is run and each time the page is redisplayed, regardless of whether it is in execute mode or edit mode.

Caution: The updating of data requires additional activity on the Service Apps platform.

Best Practice icon.png  

  • You should define an automatic refreshment interval only if the app is required to constantly display real-time data for long periods of time on screen.

example  View dashboard data

  •  You should not specify an automatic refreshment interval if the app is only used for displaying a snapshot of data.

example  Display a portal where catalogs can be consulted



Master Datasource: In a master-detail relationship, this is the name of the master data source linked to the current data source.

Master Field: Name of the primary key in the master data source used to establish the link with the current data source.

  • As a general rule, it is the PK (Primary Key) column in the Service Manager) table.

Detail Field: Name of the EasyVista data source column identifying the key in the Service Manager table.

  • As a general rule, it is the column whose prefix is FK (Foreign Key).

example  You want to display all actions (detail data source) associated with an incident (master data source):

  • Master Datasource = Incidents data source defined using the Operation > Incidents > All Incidents parent query.
  • Master Field = PK identifying the Incident_ID column in the Incidents table.
  • Detail Field = FK_AM_ACTION_REQUEST_ID identifying the action number related to the incident.

Procedure: How to create and use an Evse REST (Connector) data source

Step 1: Configure the elements required by the Evse REST connector in Service Manager

     Open url.png See Configuration of REST action types

1. Log in to Service Manager.

   You must use an administrator profile.

2. Select Administration > REST > Connections in the menu and configure the connector required between Service Manager and your monitoring tool.

3. Select Administration > REST > Resources in the menu and configure the operations that can be performed on resources by the REST API of your monitoring tool.

Step 2: Create the Evse REST (Connector) data source

1. Click Apps - Add datasource icon.png Add Data Source in the Objects pane.

2. Select the data source type, Apps - Datasource - EvSE REST Connector icon.pngEvse REST (Connector) (Online  category).

Step 3: Define the properties of the new data source

1. Select the Evse REST connector you created earlier in Service Manager, to which the data source will point.

2. Select the resource created in Service Manager, to be accessed by the data source.

3. Specify the contextual values to be passed as parameters in the Custom Params property. Open url.png See the description

4. Specify the other properties of the data source.

Step 4: Add the widget to display data from the data source

1. Click Apps - Add widget icon.png Add Widget in the Objects pane.

2. Select the type of widget you want.

3. Configure it to point to the Evse REST (Connector) data source you previously configured.

4. Specify the other properties.

Step 5: Test the app

1. Click EVApps - GUI - Execute icon.png to run the app.

The app will appear in a new Web browser tab.

2. Check that data from the resource is correctly displayed.


About the use of the software companies API REST

   Caution : The possible cost of the use of the third-parties API REST via Service Apps is not taken care by EasyVista.

  • Numerous software companies limit the access to the API REST of their software, generally by basing itself on a number of calls by hour/day/month.
  • Only specific editions of their software can be eligible in the use of the API REST (with or without additional cost).
  • Some software companies set up plans, e.g., Classic, Professional, Enterprise, for which the number of possible calls to the REST API or even to specific resources (i.e. endpoints) can be more or less numerous.
Powered by XWiki © EasyVista 2022