Verj.io JavaScript API

DataConnectors

The DataConnectors API provides the functionality to create, namespace and configure com.ebasetech.xi.api.connectors.DataConnectors#createRESTDataConnector(String).

The com.ebasetech.xi.api.connectors.RESTDataConnector are wrapped inside a JavaScript object that are namespaced into one of two locations:

  1. com.ebasetech.xi.api.connectors.DataConnectors#getVerjio(): The namespace location to store Data Connectors that have been downloaded from the Verj.io Materials and downloaded from the Resource Hub
  2. com.ebasetech.xi.api.connectors.DataConnectors#getDataconnectors(): The namespace location to store customized Data Connectors that have been created in the workspace
Namespacing the Data Connector allows the com.ebasetech.xi.api.connectors.RESTDataConnector to be used in any JavaScript event, for example, a button click.

The DataConnectors API provides a function to retrieve the com.ebasetech.xi.api.connectors.DataConnectors#getConfig(String) from the Server Administration Application

Further documentation.

DataConnectors Functions

createRESTDataConnector DataConnectors.createRESTDataConnector( baseUri ) Creates a RESTful Data Connector constructed with a base URI that provides the following functionality:
  • Direct communication with a REST service without having to call com.ebasetech.xi.services.RestServices API helper functions.
  • Customisable headers are sent with all REST calls.
  • Authentication can be sent with all REST calls.
  • Error handling for typical HTTP error codes.
  • Response handling for Data Connector REST calls.
getDataconnectors DataConnectors.getDataconnectors( ) Namespaced map of REST Data Connectors prefixed with connectors.dataconnectors.
getErrors DataConnectors.getErrors( ) The com.ebasetech.xi.services.Errors is a server side JavaScript object that contains functions that allows the creation of customizable error handling functionality specifically for the HTTP error response status returned from the server, for example a 404 Not Found error.
getConfig DataConnectors.getConfig( name ) Returns the Data Connector Configuration configured using the Server Administration Console.
getVerjio DataConnectors.getVerjio( ) Namespaced map of REST Data Connectors prefixed with connectors.verjio.