Portal
In this section of the documentation, you will learn all about the portal and its functionality
Last updated
In this section of the documentation, you will learn all about the portal and its functionality
Last updated
Authorization space
Here you will find all the information related to your account such as login, logout, password reminder, etc.
On this screen, after entering your email and password, you can log into the portal. In addition, on this screen, you can also perform several additional actions by clicking the following buttons located at the bottom of the form whose description is below.
At this screen, you can reset your password. After entering your email and clicking the button, you will receive an email with the information needed to reset your password.
Here you can resend the email with instructions. After entering your email and clicking the button, you will receive an email with the necessary information.
On this screen, you can resend the email with unlock instructions. After entering your email and clicking the button, you will receive an email with the necessary information.
To log out of the portal, you must click on the drop-down list in the upper right corner located under your email and then click sign out.
In this section, we see current statistics including the number of bots, successful jobs, failed jobs, and waiting jobs. In addition, below you will find a list of our workflows, an abbreviated list of bots, and a calendar with our scheduled jobs.
Information on bots can be found in Bots and on workflows can be found in Workflows.
Here you will find a graphic representation of your scheduled work in the calendar.
On this screen, you can find all your created workflows.
The first thing you may notice is the background color that corresponds to the status of the last execution. Where green means success, red means failure, and blue means work in progress.
In addition, you can see that clicking on individual elements of a particular flow triggers actions and these are:
Name - takes you to the details of a particular workflow.
Bots - takes you to the details of a particular bot.
Jobs - takes you to the jobs tab with a selected filter for jobs that used chosen workflow.
Enabled - allows you to turn a particular workflow on or off.
Play button - allows you to start a given flow.
This screen displays all started jobs with their current status.
In addition, there is an option to filter the results which allows you to filter by:
their current status:
waiting - waiting for a start.
canceled - job manually stopped.
running - job in progress.
failed - failed to perform the job, some problem occurred.
completed - job ended correctly.
retried - if the workflow has the retry option set, this status replaces the running status to show that the Job has already failed at least once and automatically restarted.
creation date.
used workflow in a given job.
Here you can find and manage all of your created bots.
When you click on the bot's name, you will be taken to a page with detailed statistics for that bot.
The important thing is the bot's secret, which you need to connect the runner to the portal so that the portal recognizes a given computer as a given bot.
On this page, you can check currently created projects and delete them.
A very important part of the portal is the Create button which is located at the top of the application.
There are 4 options that allow you to create a new workflow, bot, job, and project.
After selecting the workflow option, we will be taken to the form that we need to fill out to create a new workflow.
Name - you should enter the name of your new workflow here.
Bots -A drop-down list from which you should select on which bot a given workflow should be executed.
Stuck after - Number of minutes after which the job status should change to "failed".
Hourly rate equivalent - an estimate of how many hours it would take for a human to complete this task.
Limit number of jobs in queue to - how many instances of this workflow can be in the queue.
Retry - check this box if you want the workflow to restart after a failed job.
Genre - from what source the work is to be done, if you choose the file based you will have to upload a file, and in the case of project-based, you will have to choose a project from previously created projects.
Parameters - parameters that the script may expect.
After selecting the bot option, we will be taken to the single field form where you need to fill out the field with a new bot name to create a new bot.
After typing the name and clicking Create, you will be taken to the edit bot page where you can see the secret of this bot, rename this bot, delete this bot, or add or remove notifications associated with this bot.
To create a new job, you must select a previously created workflow, specify parameters if needed, and select priority.
To create a new project you will need the address of a project from a git repository that uses ssh and the name of that project.
To enter the admin panel you must click on your email in the upper right corner and then select Admin.
On the organization page, you are to see the list of organizations on a given portal and edit or delete individual organizations.
To create a new organization check Create organization.
On the users page, you will find a list of users with their details and the option to edit the selected user or delete it.
To create a new user check Create user.
You can find your keys on the SSH-keys page.
The keys found in this step are needed, for example, to create a project so that the portal can read the repository.
In the settings section, you can find an option for how long workflows logs should be kept.
In order to create a new organization you must click Create and then select organization.
Then you need to enter the name of your organization and click create.
In order to create a new user or add a user to the organization you must click Create and then select user.
Then you need to fill in all the fields with the data of the user you want to add, select his role and choose which organization you would like to add him too.
After clicking create, the user should get an email with further instructions and their account should be added to the organization.
- takes you to the settings of a particular workflow.
