UI Basics

The Mambu Process Orchestrator (MPO) UI allows you to manage users, create processes, and run tasks. In most cases, once processes are created in the UI, they are triggered using the MPO API.

Using the MPO UI requires a username and password, which you receive when you sign up for MPO or when one of the administrators of your instance creates an account for you. If your instance is in a shared environment, the URL may look like this: https://ireland2.mpo.mambu.com/. If you have a dedicated environment the url may look like this: https://TENANT_NAME.mpo.mambu.com/.

The MPO Workspace

The MPO Workspace

On the Workspace of MPO you can find all the processes, state diagrams, and dashboards that you have created or have been shared with you. These can be arranged into folders. On the left-hand side we have the Create button for creating processes, state diagrams, dashboards, folders and for importing processes. Below that are the folders you have access to. The top-bar holds options for the different sections of MPO:

  • Aliases: Shortcuts for processes and state diagrams. For more, read Aliases for Processes.
  • Workspace: The default home page of MPO where all processes, state diagrams and dashboards are displayed.
  • Activity Monitor: Basic analytics on the number of tasks run, state changes, and overall traffic.
  • Users & Groups: Where you can manage users and groups. For more, read Creating and Managing Users.
  • Docs: A link to the support documentation for MPO.

Importing and Exporting Processes

MPO objects are imported and exported as JSON objects. Both operations are done from the Workspace tab.

Importing into MPO

  1. In the Workspace tab, open the folder you would like to import your object into.
  2. Click the Create button.
  3. Select the From file… option in the dropdown menu.
  4. Select the JSON file you want to import or select a ZIP file to also import aliases.

Exporting from MPO

  1. In the Workspace tab, find the object you want to export.
  2. Right-click on the object and select Download.
  3. You can choose to download the object as a JSON file or zipped as a ZIP file. You may also include any linked aliases if you choose to download the ZIP file.
  4. When the download is ready, you will receive an email with a download link.

Creating Processes in Edit mode

To work on a process you need to work in edit mode. Start by clicking Create in the upper left-hand corner of the Workspace tab and selecting Process.

When the “New process” screen displays, enter a name for your new process. Click OK and the new process will open in a new tab in Edit mode.

New process in Edit mode

The Edit mode window contains a large central pane, which is the canvas for our new process, as well as a menu bar across the top and node logic pane along the left-hand side. The Start and Final nodes of the process are created automatically.

It is recommended that every process begins with a Start node and for every outcome to conclude with a Final node to avoid creating infinite loops.

If the example process above were to run in its current state, the task would be passed from Start to Final without any changes or redirection and without triggering any additional actions. To build out the process, we’ll need to add nodes.

Menu Bar

The menu bar contains three groups of buttons:

  • On the left side of the screen, under a dropdown menu, you can control the state of the process: Active, Paused, Debug or Blocked
  • The button next to the dropdown allows you to deploy the process and save your work.
  • In the center of the screen, you can switch between the three modes: View mode, Edit mode, and Debug mode.
Upper right-hand side of the interface showing navigation button and additional options

On the right side, from left to right, you can:

  • Undo and redo the 20 most recent actions.
  • View error descriptions of errors within your process.
  • Share your process.
  • Edit task parameters, where you can add variables that will be used in the process as key-value pairs - {{key}} : value.
  • View notifications.

The following additional options are available via the three-dots menu: History, Info, Add star, Move to…, Make a copy, Rename, and Download.Finally, you can click the user icon in the upper, right-hand corner to view more information about your MPO account.

Node Logic Pane

The Nodes Pane allows you to add actions to your process. Nodes are units of logic that help you build your process. For descriptions of each node type, please see Node Basics.

A process may be as simple as one condition or be as complex as a process with hundreds of nodes.

There are two methods to add a node to a process:

  • Drag and drop the node from the Node Logic pane to a blank space on the canvas or over a green line to add it between other nodes.
  • Clicking the plus icon (+) on the connector between two nodes.

Adding nodes to a process

Node Configuration Box

When you add a node to a process a configuration box will display on the right-hand side. This box usually allows you to add parameters (or variables), amongst other options.

Different nodes have different configuration options, but the consistent options that are available for all nodes are:

  • Adding a title
  • Adding a description
  • Copying the node
  • Removing the node
  • Removing connections to and from the node
  • Showing the Node’s ID
  • Display errors thrown by the node

We recommend always adding titles and descriptions to your nodes to make your processes easier to understand when they become complex.

Running Tasks in View mode

Before running a task you need to save and deploy the process by clicking Deploy in Edit mode. In order to run a task, select View mode in the menu tab.

To send a new task through the process, click + New task in the options below the main menu bar. The New Task pane will display on the left. In the pane you can new add parameters to be used in the task as key-value pairs. Then click Add task to run it.

Uploading a task in MPO

In the Final nodes you will see counters for the number of tasks that have reached each endpoint. Additional information is available when you click any Final nodes. The information panel on the right that pops up contains Statistics about all the tasks that have been run and an Archive of responses and errors that the task has returned.

A completed API Call with returned payload

Under the Archive tab you can export you can view responses and errors in JSON or as a table, which you can also export as a CSV. To reset the task counter for an endpoint click the three-dot menu and select Reset Counter.

Debugging Processes in Debug Mode

Before debugging a process it is recommended that you set the state of the process to Debug in the status menu dropdown in Edit mode. To start debugging go to Debug mode in the menu bar.

The MPO debug mode

On the left-hand side you will find the New Task panel, to start a new task, and in the sub-menu below the main menu bar you’ll find options to:

  • Add breakpoint: Change the end point of the process to isolate a section. To add a breakpoint drag Add breakpoint to where you want to pause the task.
  • Add start point: Change the start point of the process to isolate a section. To add a start point drag Add start point to where you want to pause the task.
  • Repeat: Repeat running the task.
  • Start / Stop: Start or stop the task. This runs the task normally and not step-by-step as with Step back and Step forward.
  • Step back: Move the task backward by one node to execute it manually node-by-node.
  • Step forward: Move the task forward by one node to execute it manually node-by-node.

The debug info box

When you run a task you’ll see an information box on the right-hand side, which contains parameter values at each step of the running task under Data task. If you use the Step back and Step forwards controls, you can also change parameter values under the Key-Value tab to fix or improve your task. To edit or view code you can click the Code editor tab.