Connecting to the X4 Server

To work with the X4 Designer, you must first start the X4 Server and connect the X4 Designer to the X4 Server. The X4 Server can be started in the console or as a Windows service.

Both options are explained below.

Starting X4 Server in the console

Prerequisite

The X4 Server and Keycloak are installed.

Proceed as follows to start the X4 Server in the console:

1. Navigate to your X4 installation folder.

2. To start the X4 Server, double-click on the start X4 Server shortcut.

   

   If you have activated the Create desktop icon for X4 Server, X4 Designer checkbox during installation, you can also start the X4 Server by clicking on the shortcut on your desktop.

3. To start the Keycloak, double-click on the start Keycloak shortcut. 

4. Wait until the SUCCESSFULLY message is displayed in the start X4 Server window: 
   

   

   
   When his message appears, the X4 Server has been started successfully and is ready to use.

Starting X4 Server as a Windows service

Prerequisite

The X4 Server has been installed as a Windows service. To do this, activate the Install X4 Server as Service checkbox during installation.

Proceed as follows to start the X4 Server as a Windows service:

1. Open the Windows app Services. To do this, simply search for “Services” in the search field in the Windows Start menu and open the app. A list of all Windows services running on your system is displayed in the Services dialog box. You will also see the X4 Server and X4AuthenticationProvider services in this list. Check the status of these two services.
   
   

   

   
   
   The status Running means that both the X4 Server and the authentication provider are running in the background and are ready for use. 
   If the Status column does not contain an entry, select the respective service and select the option to start the service. The service is started and is ready for use after a short loading time.

Connecting the X4 Designer to the X4 Server

Prerequisite

Keycloak has been started.
The X4 Server has been started.

Proceed as follows to connect the X4 Designer to the X4 Server:

1. Navigate to your X4 installation folder.

2. Double-click on the X4 Designer shortcut to start X4 Designer.

   

   If you have activated the Create desktop icon for X4 Server, X4 Designer checkbox during installation, you can also start X4 Designer by clicking on the shortcut on your desktop.

3. In X4 Designer, click on the

   

   icon in the toolbar to connect X4 Designer to the X4 Server. If a connection has not yet been established, this icon is the only icon displayed in the toolbar.
   X4 Designer is now connected to the X4 Server. The X4 Designer toolbar now contains additional icons:

Note:

You can call up information about your license via Help > About X4 BPMS > License Info and License Features. If your license expires in less than 30 days, you can see how long your license is valid in the status bar at the bottom of X4 Designer.

If you have not yet installed a license, the connection will not be established and you will be prompted to install a valid license. If you have already installed a license, you can continue with chapter (7.4.0-en) Anwendungsfälle.

Proceed as follows to install a license:

1. In the X4 License dialog box, select the Install license.... button.
2. Navigate to the directory in which you have saved your license file.
3. Select the file and select Open.

The X4 license is now installed and the X4 Designer is connected to the X4 Server.