Platform Tour
This document provides an insight into the basics of Platform UI. It describes all the items of the Navigational Menu from top to bottom.
Menu Header
At the top of our Navigational Menu you can find Contract name (1) and status (2). Also there is the Workspace switch (3), where you can select the Workspace you need to work with, and create new Workspaces (4).
Analyze
This menu section includes the following items:
Dashboard
The Dashboard (1) item opens the default page that you see when you open the Platform. On this page you can see the daily statistics diagram (2). The tabs below provide you with the lists of past executions (3) and errors (4). Also, there is an Add new flow button (5) that initiates Flow creation.
Executions
The Executions (1) item opens our Executions Page. Here you can find a list of executions (2) that you can sort with filters (3).
Logs
The Logs (1) item opens our Logs Page. Here you can find a list of logs (2) that you can sort with filters (3). You can also go to Executions Page by clicking on “Thread’s detais” (4).
Integrate
This menu section includes the following items:
Flows
You can manage your integration Flows here (1). Navigation through your Flow list is simplified with search and filters (2). You can open (3) each Flow for details and management, and see Flow status (4). Also, part of the management is done here, for example: starting (5), deleting (6), running (7) or stopping (8).
For more information please visite our Managing Flows page.
Credentials
This page (1) contains a list of Components that may require Credentials to work. In order to manage Credentials, select one of the Components (2). The green circle with a number (3) represents the number of valid Credentials you have for a certain Component.
For more information please visite our Managing Workspaces page.
Agents
This is the VPN Agent management page (1). Here you can manage your Local Agents (2), and request them (3).
Topics
This is the Topics management page (1). Here you can manage your Topics (2) or create a new one (3).
Organize
This is the page where you can manage your Workspace (1). This includes changing Workspace name (2), adding members (3), and checking member list where you can edit or delete (5) members. Additionally, here you can delete (6) the Workspace itself.
For more information please visite our Managing Workspaces page.
Contract Settings
This menu section includes the following items:
Quota Usages
This item opens the Quota page (1) that contains all the information on the used and available resources, and a detailed report (2). It is beneficial for limited Workspaces.
Developer Teams
Here you can manage your Developer Teams (1). Each team’s details (2) can be opened on this page. Also, you can add new teams via the corresponding button (3).
Members
This item brings you to the Members page (1), where you can manage Contract Members (2).
For more information please visite our Managing user roles page.
Documentation
Documentation presents two links: to docs and to API docs.
Support
Support presents links to support helpdesk or built-in intercom.
Profile Information
To find your profile information click to open the profile menu (1) and select the profile name (2). Here you can do the following actions:
- Edit your profile (3)
- Change your password (4)
- Enable or disable Two-factor (2FA) authentication (5)
- Copy or regenerate your personal API Key (6)
- Delete your account (7)
Edit your profile
Here you can edit the name and email address associated with your account. Just be careful to safe this in your records to not get locked out of the platform.
Change your password
Here you can change your password which you use to login to the platform - not your API Key. Please follow the instructions to generate secure password.
Two-factor authentication
We use Google 2FA to provide additional layer of security. Here you can enable the two-factor authentication. You would need Google Authenticator to read the generated QR-code:
Open your Google Authenticator and scan this QR-code to get the code:
After this the 2FA will be enabled, but before navigating away you better copy, download or print the recovery codes:
When everything is successfully enabled you will get the following screen:
Here you can either close this window and you will get a prompt to use your Google Authenticator along with your username/password pair to enter the platform UI.
You can also disable the 2FA from here by pressing Disable button and when system will confirm with the following message:
To enable the 2FA again you must repeat all previous steps.
Manage your API Key
Every platform user has a dedicated API Key to work with our REST API to automate many actions to include in your own workflows. Here you can copy your API Key which is purposefully obfuscated. Just click on the API key.
If you suspect your API Key might be compromissed (you gave to somebody and forgot about it) or you would like to just re-generate it you can do it here. Click on Generate new API Key button to get the following prompt:
You are warned to consider this action:
Please Note Generating a new API key will replace the existing API key. If a new API key is generated, then API calls made with the old API key will fail. Are you sure that you wish to proceed?
Delete your account
You can delete your account by pressing this button. Please note this process is not reversible.
Identity Keys
If you open the section (1) and click this item (2), you will reach your SSH keys list, which you can manage from here.
Sign Out
This item signs you out of the profile.
