First Time Setup

Part 1. Setting up your account

As a first-time user, you will be presented with a 3-step process to set up your account. As shown below, the first step after successful authentication is to provide basic information about yourself and your company.

Provide the necessary information, read and accept the "AxonIQ Service Subscription Aggreement" and click the "Continue" button.

Screenshot of the first step form to set an AxonIQ Console account. In the top left corner the step number and the title can be seen: 'Step 1. Set up your account'. On the right half of the page, there is a form with five fields to enter your name, last name, e-mail, organization and role. Right after the last field, there is a message stating that 'By Clicking on the continue button, you agree to our Privacy Policy', providing links to the Privacy Policy. Lastly, at the bottom right part of the screen there is a big orange 'Create Account' button.

Once you have created your account, you will have the option to connect your own Axon application or, if you don’t have an Axon application ready to connect to AxonIQ Console, we also offer you the option to run our "Bike Rental Demo" application through a docker-compose file that is already configured to connect to and be monitored by AxonIQ Console. You can also learn a little bit more about the different tools that Axon provides and how they are related.

Screenshot of the Welcome to AxonIQ Console panel, which gives the user the oprotunity to learn about Axon and how or proceed to AxonIQ Console Dashboard.

Click on the "Connect My Application" button to continue setting up your account.

Part 2. Setting up your workspace

One of the most important aspects of AxonIQ Console is your Workspace. Workspaces are collections of users and environments that allow teams and departments to define an instance (or group of instances) of AxonIQ technologies.

You can start by creating a workspace using the name of your project.

[alt=

Part 3. Connect your application

After setting up your Workspace or project, the next step is to connect your Axon Framework-based application, so that it can be monitored by AxonIQ Console.

The process to connect your application built with Axon Framework and/or Axon Server depends a little bit on whether your application is built with Axon Framework using plain Java, or if you have an Axon Framework application built with Spring Boot.

Screenshot of the AxonIQ Console welcome panel that offers instructions for connecting the Axon Framework application. The pannel shows two different options for the installation method: on the left, a button to show the instructions to install an Axon Framework built with Spring Boot application; on the right side, there is a button to show the instructions to install an aplication built Axon Framework using plain Java Configuration.

Click on the option that matches your case and follow the instructions to configure your application. At the end you will be see a screen waiting for you to run your application and connect to AxonIQ Console.

Screenshot of the panel in the Welcome to AxoniQ Console page waiting for the application to be started and connect to Console.

After you run the application (or applications), you will see a page with the confirmation of the connected applications.

Screenshot of the final panel in the AxonIQ Console welcome page showing the list of connected applications.

Click on the 'Go to My Workspace' button to access the AxonIQ Console dashboard.