You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.
Table of contents
Subpages
- Configure Studio server connection
- Create a shortcut in the Runtime
- Export a project
- Using the development dashboard
The runtime can run in production and development mode. While using the development mode you can start a project via the development dashboard. While using production mode you can start a project via a (user friendly) URL. After installation the runtime will contain some example projects. You can add projects by configuring a connection to Encore or add project exports to the Runtime.
Start a project via the development dashboard
The development tools component must be installed before you can use this dashboard. Once the plugin is installed navigate to http://HOSTNAME:PORT/runtime/server/dev-dashboard/ the following dashboard should appear:
The development dashboard has many more features which you can read in the following article: Using the development dashboard
Reloading
When making a change in Blueriq Encore, the runtime does not automatically reload the project. It still has the old version in its cache, and will start the old version if you do not manually trigger the reload. The runtime dashboard offers different options for reloading your application. These work as follows.
Reload Project
This option marks the current project in the cache as old, and it will be reloaded the next time when it is needed. When pressing the Reload Project button it is directly needed, as the exposed flows and validations are needed. Therefore, the project is reloaded directly.
Reload Projects
All projects in all projects are marked as old in the cache. They are not directly reloaded yet, but will do so when needed. The currently selected project is directly reloaded (see Reload Project), but the others are not. When reaching such a project in a different way, for example by the Service call type: AQ_StartProject or Container type: AQ_Dashboard_ProjectWidget, it is loaded into cache while the project is executed. This may lead to a slow response time during the first execution of your project. This is only a something you might experience in development environments.
Reload Branch
The reload branch lets you choose a branch and marks all projects in that branch as old. If you have the same branch name in different repositories, it marks each project in each of these branches as old. The same behavior as for the Reload Project is observed. When creating a new feature branch in Blueriq Encore, the branch name only is added to the drop-down when a reload has taken place. This can be a Reload Projects, but could also be a Reload Project if the selected project is in the new branch.
The dropdown filters in a case insensitive manner. When naming two branches with the same characters but in different cases, then only one of them is shown in the dropdown, and reloaded when pressed. It is therefore advisable to give each branch a different name.
Start a project via a URL
Runtime
In production mode you can start a project via the following URL http://YOURHOSTNAME:PORTNUMBER/server/start?project=YOURPROJECT&flow=FLOWNAME.
The following table describes all required and optional parameters that you can use to start a project.
| Parameter | Required | Description |
|---|---|---|
| project | Yes | the name of the project: SOURCE-PROJECTNAME for example: export-dcm or studio-dcm. |
| flow | Yes | the name of the exposed flow that is started. |
| version | No | Combination of version and branch: for example 0.0-Trunk. The version number is deprecated. By default this number is always 0.0. If no version number is entered, the runtime will automatically select a release using a numerical sorting algorithm. |
| languageCode | No | If no language code is selected, the default language will be started. |
| ui | No | The UI that should be used to render the page model. By default the Angular styling is selected. |
| theme | No | The Theme that should be used to render the page model. By default the material theme is selected. |
User-friendly URL
To create more user friendly URLs you can also define a shortcut (Create a shortcut in the Runtime).
Overview
Content Tools