You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.
JWT Authentication
When using the Development Dashboard with the JWT Authentication Provider, all requests more go trough the Gateway Service instead of directly approaching the Runtime. More information can be found here.
The development-tools component must be installed before you can use this dashboard. Once the plugin is installed navigate to http://HOSTNAME:PORTNUMBER/runtime/server/dev-dashboard/. The following dashboard should appear:
Start a project via the development dashboard
To start a project
- Select the project in the branch that you are working in
- Select the flow
- Select the language
- Select the theme (default is forms)
- Optionally select a test path
- Optionally configure request parameters
- Press start
- A new tab or window should appear with the selected project
Exposed Blueriq webservices
You can view the WSDL file and endpoint of a Blueriq Webservice with this widget
- Select your repository
- Select the branch
- Select the project
- Select the service
- Press 'Copy service URL' to copy it directly to your clipboard
Exposed Blueriq functions
You can view the endpoint, input and output parameters of a function which is exposed as a webservice.
- Select your repository
- Select the branch
- Select the project
- Select the module
- Select the function
- Press 'Copy function URL' to copy it directly to your clipboard
Widgets state
Widgets can be turned on and off in the widgets state menu.
Widgets that can be added to the development dashboard are:
- Flow starter (default on)
- Project shortcuts
- Blueriq sessions
- Exposed Blueriq webservices
- Exposed Blueriq functions
- Runtime components
- Recently started
Change settings
There are many configuration settings available for the runtime. Some settings can also be edited via the settings menu in the development dashboard, found in the bottom left corner of the dashboard. In the dashboard settings the business engineer can find the specific configuration items that are needed during applications development, which are the shortcuts and the users settings. More technical configuration items are only accessible in the property files. All the settings you make are stored in the
spring.config.additional-location
Reload configuration
When the configuration of Blueriq has been changed, you will need to reload the configuration. The execution of this task has an impact for all projects and users on this server and can result in a temporary lack of server performance.
Reloading configuration
Only newly added an updated configurations are refreshed when reloading the configuration. Deleted configuration still remain active until the Runtime is restarted.
Starting custom Runtime theme
When running application from the development dashboard it possible to select themes which are provided by the Runtime. Starting from Blueriq 14.6 is it now possible to configure external theme's which are not hosting from within the runtime. By configuring the blueriq.external.themes property you are able to select and start applications from within the development dashboard. The external theme properties consists out of a baseUrl (the location where your custom is hosted) and three templates for the main entry points (flow, shortcut, session) of a Blueriq application.
These templates follow the RFC-6570 URI template standard, each template has it own variables which are expanded when building the URL to start or continue your application.
| Template | Variable | Explanation |
|---|---|---|
| flow | flow | Name of the flow to start |
| flow | project | Name of the project to be used |
| flow | version | Project version to be used |
| flow | languageCode | Code which correspondents with a language |
| shortcut | shortcut | Name of the shortcut to start |
| session | sessionId | Id of the session to continue |
Example
If you are hosting your custom theme on https://example.com and your application consists out of the following entry points:
- /flow/<projectName>/<flowName>/<projectVersion>/<languageCode>
- /shortcut/<shortcutName>
- /session/<sessionId>
You would configure the blueriq.external.themes property as followed.
blueriq.external.themes.custom.baseUrl = https://example.com
blueriq.external.themes.custom.template.flow = /flow/{project}/{flow}/{version}/{languageCode}
blueriq.external.themes.custom.template.shortcut = /shortcut/{shortcut}
blueriq.external.themes.custom.template.session = /session/{sessionId}
Starting a flow for the exported application MyFirstApplication with the flow Main and the version 0.0-Trunk for the language en-GB, the URL would be expanded to: https://example.com/flow/exports-MyFirstApplication/Main/0.0-Trunk/en-GB.
Starting a shortcut for with the name MyShortcut, the URL would be expanded to: https://example.com/shortcut/MyShortcut.
Continuing a session with the id 0a2611af-ec5a-4795-82b1-3594bd571525, the URL would be expanded to: https://example.com/session/0a2611af-ec5a-4795-82b1-3594bd571525.
Overview
Content Tools