Skip to content

Home

Introduction

Development

IDEs

Services

Service manager

API Explorer

Familiarizing with the user interface

There are three types of user interfaces you can use to interact with TORO Integrate. These are the Server Admin, Coder Cloud, and Coder Studio interfaces.

The Server Admin web interface is typically used by system administrators to configure the behavior of TORO Integrate instances, whilst Coder is used by developers to create and manage their organization's services, APIs, and other integrations.

Below are screenshots of commonly seen parts these interfaces, annotated and described so that you can easily identify widgets and their purpose.

User interface

  • 1 Quick Access

    Allows the user to open components easily (e.g. wizards, views, editors) based on a given text input.

  • 2 Coder Navigator view

    Displays existing database connection pools, reports, and connected TORO Integrate instances1 and their files. Right clicking on any of the items in the tree shows the list of possible actions which can be executed based on the current context. Double clicking, on the other hand, opens the editor for the selected file so that it can be modified using said editor.

  • 3 Toolbar

    Contains a variety of tools that help trigger actions such as, but not limited to:

    • Opening a wizard
    • Running or debugging the service in focus
    • Opening the Integrate service manager
    • Opening the Marketplace dialog, which can be used to download items from the TORO Marketplace
  • 4 Editor

    Coder contains multiple editors; which editor gets chosen to display the file depends on the type of file opened. For example, opening a Gloop file will open the Gloop service editor; a Flux file, the Flux service editor. Every time you open a file, a new tab for the file will be added, making it easier to shuffle between opened files.

    In most cases, a mini toolbar will also be visible; the tools available in this mini toolbar are intended to help you build the service, API, endpoint, or whatever type of component was opened.

    At the bottom of the editor, sometimes another set of tabs will be visible. These tabs help you switch between the available presentation views for the file.

  • 5 Properties view

    The Properties view typically only gets populated when certain items in the user interface are clicked or are in focus. For example, when a property is clicked (either from the Input/Output view or the Mapper view), the properties of that variable will appear on a table in the Properties view. When a service is in focus, the general properties of that service will appear in the Properties view.

  • 6 Mapper view

    The Mapper view is typically used in Gloop and Flux services to view and set "mappings". A mapping, simply put, is the setting of a variable or property's value. If you're viewing a Gloop service, click on any of its map steps or invoke steps and then switch to the Mapper view to see that particular step's mappings.

  • 7 Input/Ouput view

    The Input/Output view, like its name implies, shows the inputs and outputs of a service. In Gloop or Flux, these inputs or outputs can be strings, integers, models, and other Gloop data types.

  • 8 Console view

    The Console view shows the latest stream of logs from the TORO Integrate server. If you run a service which prints to the console, you should be able to see that service's logs in the Console view. This view is not visible by default; you can open it by right clicking on the instance whose logs you want to view > Open Integrate Console.

User interface

  • 1 Navigation menu

    The navigation menu is always shown on the left side of Coder Cloud. This menu can be used to navigate through Coder Cloud's perspectives. Using this menu, you can check TORO Integrate's logs, switch to the Debug perspective, manager users and groups, configure loggers, and others more.

  • 2 Coder Navigator view

    Displays existing database connection pools, reports, and the connected TORO Integrate instance's files. Right clicking on any of the items in the tree shows the list of possible actions which can be executed based on the current context. Double clicking, on the other hand, opens the editor for the selected file so that it can be modified using said editor.

  • 3 Toolbar

    Contains menu items for actions relevant to the currently opened file. For example, if you open a service, there will be buttons for saving, copying, deleting, debugging, or running the service. If you open an endpoint, there will only be buttons for saving, stopping, and starting the endpoint. This goes on for other types.

  • 4 Editor

    Coder contains multiple editors; which editor gets chosen to display the file depends on the type of file opened. For example, opening a Gloop file will open the Gloop service editor; a Flux file, the Flux service editor. Every time you open a file, a new tab for the file will be added, making it easier to shuffle between opened files.

    In most cases, a mini toolbar will also be visible; the tools available in this mini toolbar are intended to help you build the service, API, endpoint, or whatever type of component was opened.

    At the bottom of the editor, sometimes another set of tabs will be visible. These tabs help you switch between the available presentation views for the file.

  • 5 Properties view

    The Properties view typically only gets populated when certain items in the user interface are clicked or are in focus. For example, when a property is clicked (either from the Input/Output view or the Mapper view), the properties of that variable will appear on a table in the Properties view. When a service is in focus, the general properties of that service will appear in the Properties view.

  • 6 Mapper view

    The Mapper view is typically used in Gloop and Flux services to view and configure mappings. A mapping, simply put, is the setting of a variable or property's value. If you're viewing a Gloop service, click on any of its map steps or invoke steps and then switch to the Mapper view to see that particular step's mappings.

  • 7 Input/Ouput view

    The Input/Output view, like its name implies, shows the inputs and outputs of a service. In Gloop or Flux, these inputs or outputs can be strings, integers, models, and other Gloop data types.

  • 8 Console view

    The Console view shows the latest stream of logs from the TORO Integrate server. If you run a service which prints to the console, you should be able to see that service's logs in the Console view.

Familiarize with the user interface faster using Coder Cloud's guided tours

Interactive tours have been available for Coder Cloud since v1.5. There are four tours you can take: (1) User interface tour, (2) Flux tour, (3) Gloop tour, and (4) Groovy tour.

Coder's guided tours

User interface

  • 1 Main navigation menu

    This menu allows the user to visit the different pages of the Server Admin interface. It can be collapsed or uncollapsed using the menu icon at the top and on the left of the Tracker search bar.

  • 2 Tracker/Monitor search bar

    You can use this search bar to find Tracker or Monitor documents. You can either use just the text box or the advanced search form (opened by clicking on the inverse arrow at the left side of the search bar) to enter your query. Submitting your query should redirect you to the Tracker or Monitor documents page where matching documents will appear. An empty query will show all documents. You must select whether to query the Tracker search index or Monitor search index by clicking on the Tracker or Monitor label at the left side.

  • 3 Notifications

    Shows the notifications sent to your account; these notifications are typically from the TORO Marketplace and display your account or organization's activity.

  • 4 Extensions and plugins

    Shows the TORO Marketplace items you can download or have downloaded.

  • 5 Restart or shutdown

    A menu for restarting or shutting down your TORO Integrate instance. This button is not visible on instances running on TORO Cloud.

  • 6 Account information

    A menu item showing the status of the currently logged user. A green circle indicates that you are running TORO Integrate online; a red circle indicates the opposite. You can click your avatar and click Sign out to log out from your account.

  • 7 Page content

    Shows the content of the Server Admin page you are visiting.


  1. Coder Studio allows developers to connect to multiple TORO Integrate instances contrary to Coder Cloud which only displays the details of the instance it is coupled to.