Page History

Table of contents

Subpages

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 only use a shortcutcan 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 plugintools component must be installed before you can use this dashboard. Once the plugin is installed navigate to http://HOSTNAME:PORT/Runtimeruntime/server/dev/vaadin/dashboard. The -dashboard/ the following dashboard should appear:

Image Removed

To start a project

• Select the project
• Select the branche
• Select the flow
• Select the language
• Select the UI (default is MVC)
• Select the Theme (default is forms)
• Press start

A new tab or window should appear with the selected projects

After installation the runtime will contain two example projects. You can configure a connection to Studio to load and test your development projects

Configure Studio connection

todo

Development dashboard

You can define a studio connection via the settings menu of the development dashboard

...

Image Added

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.

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.

User-friendly URL

To create more user friendly URLs you can also define a shortcut (Create a shortcut in the Runtime).

Java development.properties

You can configure a Studio connection via the development.properties file. This file is located in your Aquima home directory. 

### Studio connectivity Studio 8+ ###
# Authentication can be NTLM, NTLM_CUSTOM or BASIC
studio8.description=Studio Projects
studio8.prefix=Studio
studio8.authentication=BASIC
studio8.url=http://localhost:8097/aquima/studio/ManagementService
studio8.domain=
studio8.username=admin
studio8.password=welcome

.NET web.xml

You can configure a Studio connection via the web.xml. This file is located in your wwwroot directory.

<dataSource name="studio" type="studio" prefix="studio">
        <parameters>
          <parameter name="url" value="http://localhost:8097/aquima/studio/ManagementService"/>
          <parameter name="authenticationtype" value="basic"/>
          <parameter name="user" value="admin"/>
          <parameter name="password" value="welcome"/>
        </parameters>
      </dataSource>

Start a project via a shortcut

Shortcuts can be used for running a project with specific settings with a user friendly URL. A shortcut usually refers to a project export that is available at runtime, it can also refer to a project in Studio. The following chapters will describe how you can export your project manually and create a shortcut. Projects can also be exported via the publisher

Create a shortcut

There are multiple ways to configure a shortcut.

Development dashboard

You can configure a shortcut via the settings menu of the dashboard

...

Java aquima.properties

You can configure a shortcut via the aquima.properties file. This file is located in your Aquima home directory. The properties contain the name of the shortcut

### Shortcuts - Shortcuts can be started via the url: http://YOURSERVER:PORT/ROOT/server/start/SHOTCUTNAME ###
production.shortcutsOnly=false
shortcut.ChildSupport.flow=Start
shortcut.ChildSupport.languageCode=en-GB
shortcut.ChildSupport.project=export-Kinderbijslag
shortcut.ChildSupport.theme=forms
shortcut.ChildSupport.ui=mvc
shortcut.ChildSupport.version=0.0-Wetwijziging

.NET web.xml

You can configure a shortcut via the web.xml. This file is located in your wwwroot directory.

Export a project

You can export a project to an XML file in Studio. 

• Open a project in Studio
• Select the File tab
• Select export
• Check the Encrypt box if the XML must be encrypted
• Save the project export

Java aquima.properties

Exported projects can be placed in the exports directory in the Aquima home folder. You can also configure the location of the exports directory via the aquima.properties file.

 ### Exports ###
exportsR8.description=Studio Exports
exportsR8.prefix=export
exportsR8.folder=exports
exportsR8.files=

.NET web.xml

Exported projects can be placed in the exports directory located in the Aquima home folder. You can configure the exports location via the web.xml. This file is located in your wwwroot directory.

 <!-- DataSources -->
    <dataSources>
      <dataSource name="xml" type="xml" prefix="xml">
        <parameters>
          <parameter name="folder" value="aquima:Exports\"/>
        </parameters>
      </dataSource>