Resources
Overview
In the Resources area you can configure how your App sends and retrieves data.
You can create the following types of resource:
- Plain object
- HTTP
- ERPx Public API
- Flow
You can create multiple resources for your App according to your requirements to send and retrieve data for the various components in your App.
Each Resource has a short Tag name. This tag can be used within components (App Studio Canvas > Select module > Properties panel) to use the data from the matching resource.
Plain Object Resources
Plain objects wrapped in {}
are great for storing simple data sets.
NOTE: It is also possible to use arrays
[]
at the root of a plain object.
NOTE: App Studio does not support Templating in plain object resources.
HTTP Resources
Configuration
An HTTP Resource has the following fields:
NOTE: Only HTTPS URLs are allowed.
The available REST methods are: GET
, POST
, DELETE
, PUT
, PATCH
.
The available authentication types are: NONE
, BASIC
, BEARER
, U4Ids
(Unit4 Identity Services).
If you select BASIC
or BEARER
authentication types you are prompted to select which Credentials you want to use. For more information on how to save your Credentials in App Studio see App Studio credentials.
Content definition
The HTTP resource supports the usage of both JSON and multipart/form-data content type when sendiing a file. For JSON you specify the content type as shown in the example below:
For Form Data you can add the form data items by specifying the file type, key and value. The value for File is the template ID of a File uploader component you have added to the Canvas. The value for Text is any string, typically hardcoded or coming from a field.
ERPx Public API
This allows easy integration with the available ERPx public APIs. Here you define the ERPx endpoint, the method and which version of the API to use (the highest available version is selected as default). The available parameters depend on the endpoint chosen.
The Parameters section contains the available query and path parameters which depend on the endpoint chosen. The parameter fields can be expanded and templating is supported.
The Content definition section is defaulted with the Model schema and is disabled if the method is set to GET or DELETE.
Flow
The Flow resource allows you to integrate your App with a Flow in Extension Kit to obtain data from the Flow. This allows you to hand off logic such as data retrieval, data transformation or encryption to an Extension Kit Flow and then have the result of this Flow supplied back to the App. You can trigger a Flow from an App using Button components and respond according to the Flow result in the App.
The available Flows are configured using the App (v1) trigger in Extension Kit.
An App Result action can be configured within a Flow in Extension Kit containing the necessary logic to provide the data to your App.
​Currently a maximum of five Flows are supported per App.