Server Administration Application – Configuring Data Connectors

Documentation home

 

Introduction. 1

Configuring Data Connectors 1

Data Connector Configuration. 2

Data Connector Properties 2

 

See also: Server Administration Application Home Page, Working with Data Connectors

 

Introduction

Data Connectors enable integration with a web service. These web services usually require some access credentials and some have different URLs for test and production environments. Hard coding these types of configuration information into the Data Connectors themselves makes them hard to move from a Test environment to a Production environment.

 

The Data Connector Configuration allows information about Data Connector’s connections to web services to be configured directly in the Verj.io Service Plan or On-Premises environment. This information can be looked up by Data Connectors and used to connect to the web service.

 

A Data Connector Configuration represents a name à value list of reusable properties that are specific for a Data Connector. The Data Connector configuration can be referenced from the Data Connector script using the JavaScript API, for example:

 

//get the Data Connector configuration for the VehicleEnquiryService

var config = connectors.getConfig("VehicleEnquiryService");

 

//get API key value

var apiKey = config.apiKey;

var baseURL = config.baseURL;

 

Data Connector Configurations are saved into the folder dataConnectors in the ebaseConf folder of the web application, e.g userdata/apps/<webappname>/ebaseConf/dataConnectors

 

Configuring Data Connectors

 

 

The meaning of the various columns shown above is explained in the next section.

 

Data Connector Configuration

The Data Connector configuration can be edited when either creating a new Data Connector configuration using the  icon or clicking on the name of an existing Data Connector configuration.

 

 

Name

The Data Connector configuration name. This is referred to in scripts that use the configuration.

Description

Meaningful information describing the Data Connectors purpose

 

Data Connector Properties

To add a Data Connector property click the  icon within the Data Connector Properties section

 

Property Name

The name of the Data Connector property. This name is used to reference the configuration value.

Property Value

The value for the property.