Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Shortcuts can be used for running starting a project with specific settings with a user friendly URL. A shortcut refers to a project that is available in the runtimeRuntime. The following chapter describes how to create a shortcut. 

Note

For security reasons we advise you to only use shortcuts in a production environment. This can be enabled via the blueriq.production.shortcuts-only in

Include Page
_PropertiesFileJava
_PropertiesFileJava
.

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

...

Dynamic shortcuts

When the dynamicVersion property is set to true, the version property is ignored, and the version of the project to be used is looked up by comparing the version of the AQ_Dashboard_ProjectWidget or AQ_StartProject to the version of the project of the current session. If so, that version will be used, otherwise the version set with the version property will be used.

Properties

You can configure a shortcut via the 

Include Page
_PropertiesFileJava
_PropertiesFileJava
 file. This file is located in your 
Include Page
_ConfigLocation
_ConfigLocation
 directory. The properties contain the name of the shortcut

Code Block
languagetext
titleapplication.properties
### Shortcuts - Shortcuts can be started via the URL: http://YOURSERVER:PORT/ROOT/server/start/SHOTCUTNAME ###
blueriq.production.shortcuts-only = false
blueriq.shortcut.ChildSupport.flow = Start
blueriq.shortcut.ChildSupport.languageCode = en-GB
blueriq.shortcut.ChildSupport.project = export-Kinderbijslag
blueriq.shortcut.ChildSupport.theme = forms
blueriq.shortcut.ChildSupport.ui = mvc
blueriq.shortcut.ChildSupport.version = 0.0-Wetwijziging
blueriq.shortcut.ChildSupport.dynamicVersion = true
blueriq.shortcut.ChildSupport.privateAccess = false
blueriq.shortcut.ChildSupport.securityEnabled = true

Dynamic shortcuts

When the dynamicVersion property is set to true, the version property is ignored, and the version of the project to be used is looked up by comparing the version of the Container type: AQ_Dashboard_ProjectWidget or Service call type: AQ_StartProject to the version of the project of the current session. If so, that version will be used, otherwise the version set with the version property will be used.

Development dashboard

You can configure a shortcut, and its test paths, via the settings menu of the dashboard

  • Select Settings
  • Select Shortcuts properties
  • Press the add (or delete) button
  • When adding a card will appear to add a new shortcut

    image2021-4-30_11-33-27.pngImage Added

  • Enter a shortcut name
  • Enter the necessary data
  • Click 'Save'
  • You can now test your shortcut with the following URL: http://HOSTNAME:PORT/runtime/server/start/SHORTCUTNAME

Anchor
testPaths
testPaths
Test Paths

Include Page
Test Paths
Test Paths


Tip

When working with shortcuts for the AQ_StartProject service, you need to think of security. On a production server you set the runtime to blueriq.production.shortcuts-only=true so that end users can not start any flow flows directly themselves. As you need to create a shortcut for the application to be calledstarted, you do not want that end users could guess the shortcut name and start the flow themselves. For this reason, you should set the property blueriq.shortcut.[name].privateAccess=true for the shortcuts that are only used for the AQ_StartProject service, and which are not directly started by end users.

UI Text Box
type
Info

It is possible to leave the version of the application out of the URL or shortcut, in which case the latest version of the application is started.

The latest version is determined as follows:

  • first the major version is compared

  • then the minor version

  • then the branch name

Example: 0.0-Wetwijziging

  • Major version: 0
  • Minor version: 0
  • Branch name: Wetwijziging

As Since for all studio exports always have the major and minor version equals always are equal to 0, only the branch name is the discriminating factor. It is sorted in ascending order, meaning that a branch name starting with 'z' is considered later as a branch name starting with 'a'. In order to make effective use of this mechanism, we advice to use branch names which start with numbers, e.g. 001_4_FeatureBranch.

UI Text Box
type
Info

It is possible to leave the name of the application out of the URL or shortcut, in which case the default application is started.

The default application is determined in Java by the Runtime, as being the shortcut that has the name 'default'.

Note

Only one default application should be created as multiple defaults could lead to unexpected behavior or errors.

...