Connect

Connect to your ReST API.

Your Application Programming Interface (API) will probably be engineered using the Representational State Transfer (ReST) protocols. This allows data to be Created, Read, Updated and Deleted (CRUD).

You connect each ReST API as a Flexiva data source using your security credentials, and test these to ensure that this works as expected in Flexiva.

Note that your ReST API is never accessed directly by the client-side application. It is only used via our Web API server-side proxy to ensure that all your data traffic remains secure by being hidden from prying eyes.

This is done by opening the App Studio and using the Data Sources configurator. Each of your ReST API CRUD endpoints should be used to create and test data source request so that data can be created, read, updated and deleted.

You will need ReST API endpoints for the following:

Search

The top toolbar has a search box. You will need a ReST API data source request which can take a text string and return a list of all matching records across all of your databases connected to this application. This allows end-users to easily locate records even with no training. Use this configurator to set this up.

Activity Metrics

Both the left navigation bar and the top right account summary drop down can show key performance indicators. You will need a ReST API data source request for each KPI you wish to display. This allows end-users to easily open groups of data even with no training. Use this configurator to set this up.

Custom Variables

In order to allow data to transfer between your front-end application and your back-end, you will need to define a custom variable for each field in each ReST API request for all CRUD methods. It is best to do these one entity at a time. Use this configurator to set this up.

Lookups

All lookup forms connect to a ReST API data source to return pages of records of a specific type. You will need one of these for each 'entity type' you wish to display before you create a lookup form to open from your navigation bar. Use this configurator to create your forms, and this configurator to link these to your navigation bar.

CRUD

In order to facilitate create, read, update and delete for each of your entity data types, you will need to configure a CRUD ReST API method so that you can bind these to a data entry form and design fields and components using the form designer to allow the user to drill down into these forms from lookup forms. You will also need custom variables to build your data dictionary to pass data between the front-end application and the back-end.

Once you have created and tested these data source requests for all necessary CRUD operations, you can now design your forms to start presenting this information for manipulation by your end-users.