Execute a project

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 shortcut.

Start a project via the development dashboard

The development plugin must be installed before you can use this dashboard. Once the plugin is installed navigate to http://HOSTNAME:PORT/Runtime/server/dev/vaadin/dashboard. The following dashboard should appear:

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

• Select settings
• Select the development tab
• Select Studio projects
• The following screen should appear
  
   
   
• Select method of authentication 
• Enter the URL of the Studio Management Service
• Enter username and password
• Press check connection to see if the connection is working
• Press save and close window
• Your Studio projects should be visible in the development dashboard

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

• Select settings
• Select the general tab
• Press the add button
• A pop up window will appear
  
  
  
  
• Select the project, branch, flow, language, UI and theme
• Enter a shortcut name
• Select add
• Select save
• You can now test your shortcut with the following URL: http://HOSTNAME:PORT/server/start/SHORTCUTNAME

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>