Introduction to Workbench

◷ Reading Time: 5 minutes

FlexRule Workbench is a responsive web-based administration and management console for FlexRule Server.

You can use the workbench to perform the following tasks.

• Manage services
• Provide different access levels to users
• Provide different access levels to applications
• See the health and logs of services

These are the resources you can manage in the workbench:

• Packages
• Services
• Schedules jobs
• Accounts
  • Users
  • Applications
• Roles
• Agents

Open Workbench

Open your web browser and navigate to the address you defined during the workbench configuration step or in the FlexRule server configuration file (i.e., the default example is http://localhost:9010/).

Sign In/Out

Once you open the workbench, it will ask you to log into the system if you have not logged in already, or if your authentication token is expired.

Simply enter your username/password and press the “Sign In” button. The default login is “Admin” and you have already entered the password on configuring the Master Server during the installation process.

If you keep the “Stay signed in” checkbox ticked, you will not need to re-enter your credentials until your token is expired.

Once you have logged in, you will see your username.

To sign out, select the “Sign Out” button on the toolbar as shown below.

Workbench Window

After you sign in to the system, you will see the home of the Workbench below.

1. Toolbar
2. Summary
3. Navigation Menu

Toolbar

On the top of the screen, you will see a toolbar:

The toolbar has the following buttons:

1. Help website: This will take you to FlexRule Resource Hub which is the technical documentation of FlexRule
2. Fullscreen: Make the Workbench full screen in your Windows.
3. Sign Out: Sign out from the workbench.
4. Collapse: Hides the left-side navigation menu.
5. Notifications: This shows the notifications related to the workbench

More info about notifications

The Notification screen shows all the messages generated as a result of your activities. There are three types of messages found on the notification screen:
– Error
– Success
– Information



All messages usually have a:
– Code
– Title
– Description

The “Dismiss All” button clears the notification of window messages. Alternatively, you can click on the “X” button on the top-right corner of each message to remove a specific notice from the notification screen.

Summary

This will show the summary of FlexRule Master node(s) and Agent node(s) as well as services/ databases. You can have a quick look at the health of services and agents.

Navigation Menu

To navigate to different parts of the Workbench, use the left-hand side navigation menu:

Each part of the workbench is used to manage the services and users giving complete transparency to the running services.

Execution Server

To see the executing services, workflows, and jobs.

If you want to see the status of running services, workflows, and jobs and test them you can select the relevant options under this section. You can also edit the services and select which versions you want to run.

This is the most important section of the workbench as it has all the options to manage the executing services.
See Service Execution for more information.

Administration

To manage the users and roles.

If you want to add, remove, or edit the users, applications, agents and different roles select the relevant options in this section. You can have full control over providing access to different users or applications

See Access Permission to learn how to provide access to different packages and manage roles.