Engine Cockpit

The Engine Cockpit is the application to administrate your engine.

Warning

Please be aware, that this tool is in a development stage. That means not every part is fully functional and can change before its release.

Opening the tool

After you have successfully started the Axon.ivy Engine, you can launch the engine cockpit tool.

To do so, start your preferred web browser and open the address: http://ServerName:Port/ivy/faces/view/system/engine-cockpit/dashboard.xhtml

Tip

You can launch the engine cockpit over the Axon.ivy Engine info page as well. To do so, open the address: http://ServerName:Port/ivy in your browser and click on the Cockpit tab

Note

For the usage of this tool, you will need a valid user with enough rights for the login.

Dashboard

The dashboard provides you a quick overview of your running engine. There are real time information about open sessions, user count, working tasks and deployed applications. In addition it will show you information about your system where the engine is running on. If you have a EMail Server configured you can test it by clicking on the Send button and send a test mail. On the licence panel you have the possibility to upload a licence. To do so click on the Upload Licence button.

../../_images/engine-cockpit-dashboard.png

Applications

On the applications page you have a list with each application which is running on the engine. You can start, stop or lock these applications. Every application has its process models and process model versions. Those can be started and stopped too. You can add a new application by clicking on the Add button. By clicking on a application, you switch to the Application detail view.

For deployment of a new version of an app, you can click on the Deployment button to open the Deployment Dialog. Have a look at the Application detail view for more information.

../../_images/engine-cockpit-applications.png

Application detail

The application detail page gives you similar information like the dashboard but specific for the chosen application. In addition you can change the active environment, start or stop the application. On the Security System panel you have the possibility to change your security system. You can choose every system you have configured in your ivy.yaml file.

If you want to deploy an Axon.ivy project, click on the Deployment button and select your .iar or .zip file. For the deployment you can set additional deployment options. For more information have a look at Deployment Options. For the usage of this feature the Deployment feature needs to be enabled (Optional features).

Note

For CI/CD pipelines deployment visit the Deploying chapter.

../../_images/engine-cockpit-application-detail.png

Security

Security System

The security system page will give you an overview about every running application and the security system it is using. In addition you have the possibility to trigger the synchronization directly over the UI. After the sync process is finished you will see the log about what has been done.

Note

Only external security systems (Microsoft Active Directory and Novell eDirectory) can be synchronized.

You can edit a configured external security system (not ivy Security System) directly in your ivy.yaml file or you can click on the name of the system to open the Security System detail view.

../../_images/engine-cockpit-security-system.png

Security System detail

On the security system detail view you have the possibility to change a configured security system. The settings is read directly from the ivy.yaml file. Every change you make and save will be written directly back to the yaml file. The placeholder in the empty fields are the default values from the system. So you don’t need to define those if they are the same.

If you want the know more about how to configure a security system, have a look at the ivy.securitysystem.yaml file.

Note

If you had something configured and you delete this entry, the entry will be removed from the ivy.yaml file.

../../_images/engine-cockpit-security-system-detail.png

Users

On this page you see all users per application. You can change the application over the tabs on the top of the view. The table shows you basic information about the user and if they have an open session. You can add a new users too. To do so, click on the New button and fill in the dialog. The name is required and needs to be unique.

Warning

You can’t add a new user to a chosen application, if the application is connected to an external active directory.

To get more information about a user or change some settings, you can click on one user to go to the User detail view.

../../_images/engine-cockpit-users.png

User detail

On the detail view of a user you can change information and settings. The Information panel shows you the attributes of the user. You can change all of them except the name. It’s also possible to delete the user here. The Email Notification Settings panel shows the notification settings for the user. The Roles panel shows you a tree with all roles. The user is a direct member of a role, if the role has a black check. When the check is grey, then the user inherits the membership from a child or member role. On the Permissions panel you can see if the user has all permissions of a group, if the check is black, or some of them when it’s grey. The user can have permissions directly granted / denied or over a role. If the permission is granted or denied from a role you can override it for this user.

Additional user properties can be configured manually (over the buttons Add, Edit and Delete) or they can be read from a Security System. To do so, the user needs to be synced from a security system with Additional LDAP Attributes configured. If this is the case, properties (e.g. phone number) should be appearing here. Be aware of that this properties can only be edited on your security system.

../../_images/engine-cockpit-user-detail.png

Roles

The Roles page gives you a tree of all roles per application. You can change the selected application on the tabs at the top of the view. In addition you can see here, if a role has a role member (role icon with a plus). For the detailed view of a role you can click on the role name. Then you switch to the Role detail page.

../../_images/engine-cockpit-roles.png

Role detail

On the Role Detail view you can change Information and settings and edit them. The Information panel gives you the possibilities to change the display name, description or link the role to an external security name. On the Users panel you can add users to this role or remove them. The Member panel shows you all roles, which are members of this role. You can add more or remove a role here. The Permission panel has the same functionalities, as the one you can find in the User detail view.

You can add additional properties to a role over the buttons Add, Edit and Delete on the panel Properties.

../../_images/engine-cockpit-role-detail.png

Configuration

Global Variables

The view Global Variables shows you all global variables which are defined for every application. They can be configured on the project or set in the app.yaml file. You can switch the environment at the top. To add a new variable or edit one click on the New or Pencil button. If you do so your change will be written to the app.yaml file. You can reset a global variable to its environment value by clicking on the Reset button.

../../_images/engine-cockpit-configuration-variables.png

Business Calendar

The Business Calendar view allows you to see all configured business calendars. This overview shows you the hierarchical order of each calendar.

../../_images/engine-cockpit-configuration-businesscalendar.png

By clicking on one of the calendars you get redirected to its actual configurations. The panel Week configuration shows you the calendar configuration while the other three panels show you the registered free days.

../../_images/engine-cockpit-configuration-businesscalendar-detail.png

Services

Email

In the email section you can change the default email notification settings for each application.

../../_images/engine-cockpit-email.png

External Databases

The external databases view gives you an overview over your configured external databases inside your project. You can switch to the desired application over the tabs at the top. If you want to show a different environment, you can change it at the top right. To get more information over a database click on one to go to the External Database Detail view.

Note

If you want to add a new external database configuration, please have a look at Designer Guide.

../../_images/engine-cockpit-external-databases.png

External Database Detail

In the external database detail view, you can see all configurations from the selected external database. You can test if the configuration works and a connection to this database can be established, when you click on the Arrow button. You can change the most important information directly here too. If you click on the Reset button the database will be reset to the original setting. In this view you can see information about the last 200 executed SQL queries and used connections too.

Note

Not every value can be modified here yet. But you can override them in the app.yaml file.

../../_images/engine-cockpit-external-database-detail.png

Web Services

The web services page lists all defined web services. Change the application or environment at the top to get your desired services. For a detailed view of the service click on one entry to switch to the Web Service Detail view.

Note

If you want to add a new web service, please have a look at Designer Guide.

../../_images/engine-cockpit-webservice.png

Web Service Detail

On this view all configurations from a web service will be shown. You can change the credentials or the endpoints here. Or you can reset them to their original setting by clicking on the Reset button. To test if an endpoint is accessible press on the Arrow button next to it. Please be aware that only HttpBasic authentication will be supported and the request is an empty POST message, which means depending on implementation of the web service the status code can be different.

Note

If you wish to change a value which is not supported by this editor you can do so by modify the app.yaml file.

../../_images/engine-cockpit-webservice-detail.png

Rest Clients

The rest clients view gives you an overview over all rest clients which are configured on this system. You can change the application or environment at the top. Click on one rest client to get all configurations on the Rest Client Detail page.

Note

If you want to add a new rest client, please have a look at Designer Guide.

../../_images/engine-cockpit-rest-clients.png

Rest Client Detail

On the rest client detail page all configurations for this service are shown. Some of those configurations can be modified directly here in this editor. You can reset your changes by clicking on the Reset button. If you want to test your configuration, click on the Arrow button. This will start a HEAD request with the given authentication credentials.

Note

If you wish to change a value which is not supported by this editor you can do so by modify the app.yaml file.

../../_images/engine-cockpit-rest-client-detail.png

System Configuration

On the system configuration page you will have an overview about all your configurations defined in your running engine. Configurations which are grey, are default values. If you click on the New button, you can add new configurations. If you want to edit an existing configuration, click on the Pencil button. If you click on the button More, you have the possibility to reset a configuration or view the configuration file.

Warning

Application configurations are not shown on this view. You can see defined application configurations on the Application detail view.

Note

For more information about the configuration, please have a look at the Configuration section.

../../_images/engine-cockpit-system-config.png

Monitor

The engine cockpit gives you the possibility to monitor your system where your engine is running on. On the monitor page you will have an overview about cpu load, memory load, network traffic and disk read write. The memory monitor shows you in addition the max and usage of the jvm.

../../_images/engine-cockpit-monitor.png

Logs

The logs view shows you the latest entries of the console.log, config.log and ivy.log. Simply click on the + to show the log or the - to hide it. If you want to see the logs of an other day, you can change the date at the top right.

../../_images/engine-cockpit-logs.png