This document provides a quick tour of the Platform User Interface (UI) describing each item of the Navigation Menu from top to bottom in case of already established contract with working integration flows.
Menu structure:
Click through each menu section while you reading this tour since you might see slightly different picture based on your access level and the project stage in your contract.
At the top of our navigation menu you can find your contract name and the status. Contract status shows state of the contract - Active or Suspended.
If you have access to more than one contract on our platform you will also see the chevron icon which you can click on to open list of your contracts. Select the name to switch to a different contract.
This part of the menu shows the current workspace. Click on the chevron icon to open a sub-menu containing list of the workspaces you can access in the current contract. Select the name to switch to a different workspace.
The open workspaces sub-menu on the right shows the following details and menu items:
full
workspace used for production flows.limited
workspace used to develop integration flows and run tests.This menu section links pages to help you monitor and debug your integration flows.
The first page you land when navigate to your contract is the Dashboard page. It shows execution statistics, count of flows, count of messages in flows, container errors and memory usage.
The Executions menu item opens our Executions Page. Here you can find a list of executions based on a data transfer, sort them with filters to narrow down your search and navigate to the one you need.
The Containers menu item opens our Containers page. This page provides insights into containers and their components. By default, it displays today’s log information, but users can expand the date range using the filtering and search features.
Container logs are retained for up to 30 days. On the Containers page, you’ll encounter the following states:
To access specific information for a container, simply click on the ‘Step Name.’ On the individual container page, you will find the following details:
The Logs menu item opens our Logs Page. Here you can find the logs of all executions in your workspace. The view shows logs sorted by time. You can search and filter the logs you are looking for.
This menu section links the pages you need to build integration flows.
The Flows menu item opens the page where you can manage your integration Flows. From here you can start, stop and edit your existing flows. You can also create new flows either from scratch or by copying and editing the existing flows. From here you can also export flows into different workspaces or create flow recipes.
For more information please visit our Managing Flows page.
The Credentials menu item opens the page containing component credentials for each component to use for authentication with the 3rd party resources. Here you can create, edit and delete the credentials for each integration component.
Please Note you can also create credentials during the flow step configuration. These credentials will appear on the credentials page as well.
The Agents menu item links the VPN Agent management page where you can create, edit and delete the VPN Agents. You can use this feature to establish a secure VPN tunnel between your local resource and the platform. This enables a secure data exchange between your local system and the active integration flow.
The Topics menu item opens the Topics management page. Here you can create, edit and delete your Topics. You can use this feature to establish a publish-subscribe messaging pattern to exchange data between the integration flows.
The Recipes menu item opens the Recipes management page. Here you can activate and delete your Recipes. We also display the number of deployments of these recipes on each Recipe Card. Recipes allow users to share Flow templates with others without disclosing their non-shareable data (Credentials, Fields, Variables).
This menu section has one item - the Workspace which opens workspace management page. Each workspace has a separate page like this where you can rename it, manage members and delete it based on your access role.
While in workspace management page you can:
For more information please visit our Managing Workspaces page.
This menu section includes the following items:
The Quota Usages menu item opens our quota overview page. Here you can check the combined memory usage of flows in all your workspaces of the contract. From here you can drill-down the usage based on the workspaces and individual flows for the current month. If you have the memory quota limit set for your contract then you will see relationship of used and still remaining quota.
The Members menu item opens the contract Member management page. Here you can rename the contract, view and invite members, edit the member access roles or remove the member from the contract. From this page you can access Workspaces page as well.
You can do the following action if you have Owner
role in the contract.
You can access this page from the Workspaces tab of the Members page or from the View all workspaces menu link of the Workspaces name. Here you can manage the workspaces of this contract. You can create a new workspace, see all existing workspaces and navigate to each workspace if you have appropriate access and role in the contract.
For more information please cvisit our Managing workspaces page.
This menu section includes items for component developers. Here you have a link to the following pages:
The Developer Teams menu item opens the contract developer teams page. Here you
can manage your existing teams and integration components or
create a new ones if your have contract Admin
access role.
If you clicked on the team name, you will see the functionality to manage your team:
The Metadata Test Tool menu link opens a special tool our developers use to test and improve the component metadata structures. You can paste your metadata here to see how it renders on the platform UI.