Apps

Eliona offers various apps to implement data from third party systems into Eliona. You have the possibility to install any apps from our library.

Details about the individual apps can be found in the Eliona Apps section.

Configuration using Generic Frontend

To avoid having to develop a separate frontend for each app, a generic frontend can be used to configure each app in Eliona. The generic frontend is a client to a REST API provided by the apps and for most apps it should be used mostly for configuration.

This frontend design will only be used if no other is available.

  1. Description: Follow the link in description to get to app documentation. There you will find all app-specific configuration options with examples.

  2. Endpoint: Select the endpoint. By convention, /configs endpoint is used for configuration.

  3. Method: Specify what to do. For example, POST /configs creates a new configuration. GET /configs lists all configurations. /configs/{config-id} endpoints manipulate specific configs after creation (GET=read, DELETE=delete, PUT=modify).

  4. Parameters: If the endpoint requires some parameter, you can enter them here. Here you need to specify the ID of the config that you want to get updated. You can find the id in GET /configs request.

  5. Request: Write the request here. For most use-cases, you can copy and modify the example request in the aforementioned app documentation.

  6. Response status: The HTTP status code and description. Green means all went good, red means something went wrong.

  7. Response: Response of that request. If the request went well, you will find the requested information in this space.

The app then processes data for each enabled configuration. Creating redundant configurations may lead to unnecessary assets being created and also to hitting rate limits on provider's APIs or causing other problems.

Common configuration fields

The configuration usually contains following settings:

{
  -- app-specific config options, like API access, are on top 
  "enable": true, -- enable/disable this config
  "refreshInterval": 3600, -- how often should be new assets discovered [s]
  "dataPollInterval": 60, -- how often the app should poll for new data [s]
  "requestTimeout": 120, -- how long should the app wait on the provider's server to respond [s]
  "assetFilter": [], -- specifies which assets should be ignored by continuous asset creation. Leave empty for including all assets.
  "projectIDs": [
    "10" -- a list of project IDs this configuration should be created for; you can find the project ID in Engineering -> Projects section
  ]
}

It is advised to follow the example values provided in the app's documentation and modify these only if there is a need for it.

Last updated