1. Home
  2. FlexRule Server
  3. Workbench
  4. Introduction to Workbench

Introduction to Workbench

◷ Reading Time: 6 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 Packages and Services
  • Provide different access levels to users and applications
  • Manage Agents and related compatibility with Services and Jobs
  • Administer Licenses for Server and Runtime
  • See the health and logs of services
FlexRule Workbench application home view. Showing left side menu, quick stats table and health indicators of the Server components

These are the resources you can manage in the workbench:

  • Packages
  • Services
  • Workflows
  • Schedule Jobs
  • Accounts
    • Users
    • Applications
  • Roles
  • Agents
  • Event Groups
  • Licenses

Accessing 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. NOTE: the duration of the token is 24 hours.

FlexRule Workbench log in modal

Simply enter your username and 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.

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

Detail view of username display

To sign out, select the “Sign Out” button on the toolbar at the top right of the Workbench view, see below showing the button.

Detail view of the Workbench top right toolbar buttons. The logout button is highlighted.

Workbench Home

After you sign in to the system, you will see the home view of the Workbench including the following main sections.

  1. Navigation Menu
  2. Toolbar
  3. Summary
FlexRule Workbench application home view. Showing 3 key areas highlighted, Navigation Menu, Toolbar and Summary section

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

Workbench main navigation displaying in collapsed state

There are two main menu items in the navigation, Execution Server and Administration.

Execution Server

The Execution Server menu items are related to any execution of deployed services. Items include Packages, Services, Workflows, and Jobs.

Execution Server menu showing the expanded view displaying Packages, 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

This section is for administering all aspects of FlexRule Workbench.

Administration menu showing included items: Accounts, Roles, Agents Event Groups and Licenses

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.

Toolbar

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

Toolbar ribbon showing the FlexRule logo left and four buttons right

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. Notifications: This shows the notifications related to the workbench
Notification modal showing a 'Service Status Updated' success notification.
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 title, a date/time stamp and a 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 status and summary of FlexRule Master node(s) and Agent node(s) as well as License and database status.

There is also a Quick Stats table giving a summary count of a range of Agent, account and service deployments.

Updated on September 28, 2023

Was this article helpful?

Related Articles