Introduction

The akaBot Center is a server-based application that lets you control and manage your Agents. It runs on a server and connects to all the Agents within the network and executes your repetitive workflow based on different requirements. It has a browser-based interface that enables the management of hundreds of Agents with just a few clicks.

The akaBot Center lets you manage the creation, monitoring, and deployment of resources in your environment, acting in the same way as an integration point with third-party applications.

This document aims to guide you on how to use the functionalities in the AkaBot Center. 

Using akaBot Center

1. Center Overview

1.1. The User Interface

image-20221026094656-1.png

NoPanelDescription
1Feature menuShow all the main functionality of akaBot Center
2Quick NavigationEasily navigate to page, package, agent, agent group, workflow, asset, queue, schedule,…
3Main screenDisplay the details of each functionality
4Quick createQuickly create a Task/ Schedule/Workflow/Trigger/Agent
5Organization
Unit Selection
Menu
Change the active Organization Unit
6LanguageChange the display language of Akabot Center. Support English, Korean,
Japanese, Vietnamese and Taiwanese.
7User MenuAccess the following options and pages:
Settings: On this page, you can change the user details such as First Name, Last Name, Email and the display language.
Password: On this page, you can change the password that used to log in to Center.
Sign out: Click here to sign out.
8VersionShow the version of akaBot Center

1.2. akaBot Center – Navigation

In the Feature menu, you can see all the functionality that akaBot provided. 

image-20221027172247-1.png

NoTabDescription
1HomeCharts and statistics for akaBot Center components
2AutomationInclude all the components related to automating activity.
3ResourcesInclude the list of Agent (Software agent that automates rule-based processes in the same
manner as humans do), group of Agent for deployment purposes.
4AssetShared variables or configurations that can be invoked in the design
processes by developers and used in your processes
5QueueWork queues are used to distribute work items to robot. Overview of
queues and transactions statuses, and SLA predictions.
6MonitoringPlace to control and track Agent's activities and view some reports.
13AdministrationUser Management
Role Management: Authorization based on access rights mapping
License: Activate, renew, remove, and allocate licenses and view historical licensing data.
Webhook: allow external systems to subscribe and listen to Akabot Center

1.3. Getting Started with akaBot Center

Before stating exploring all the main function of akaBot Center, please follow the instruction to install and Activate akaBot Center here

During the usage of akaBot Center, there are many instances where you need to input data to perform certain actions, such as Create/Edit or Filter for specific data. Below are different type of input data and method along with what they mean:

Type 
StringThis field accept text value
Int32This field only accept integers number. Int32 range is from - 2,147,483,648 to 2,147,483,647
BooleanThis field only accept 2 value: TRUE or FALSE
Date & TimeThis field only accept value reflected Date and Time. It could be manually inputted selected from a calendar.
Input searchingThis field allows user to search by inputting text value as well as select items from a list.
Drop down listA list in which the selected item is always visible, and the others are visible on demand by clicking a drop-down button.
Single ChoiceThis section have different choices but only users only allows to select one.
Multiple ChoiceThis section have different choices but users allows to select more than one options.

2. akaBot Operation Functions

2.1. Home

image-20221027173807-2.png

akaBot's home page is a dashboard that enables you to see all the statistical charts of a single Organizational Unit containing useful information for all the following components:

  • Number of Agent (Available, Busy, Disconnected, Nonresponse)
  • Number of Task (Successful, Running, Stopped, Faulted)
  • Schedule (Calculated by Hour, Day, Week and Month basis)
  • Package (Active, Inactive)
  • Task Statistics (Daily, Weekly, Monthly, Yearly view available)
  • Upcoming Tasks
  • Recent Tasks

image-20221028092757-2.png

You can filter the data based on the Agent Group and Agent Name

NoColumn/LabelDescriptionTypeMaximumInput Requirement
1Select Agent GroupSelect the agent group of
which you want to see
statistics
Input searchingNo limit
(2,147,483,647 char)
 
2Select AgentSelect the agent of which you
want to see statistics
Input searchingNo limit 

You can also view the Task Statistics by selecting the corresponding tab: Daily, Weekly, Monthly, Yearly.

image-20221028092657-1.png

NoColumn /LabelDescriptionTypeMaximumIs Mandatory ?Input Requirement
 Daily /
Weekly /
Monthly /
Yearly
Select the type you want
to see task statistics
Tab Yes 
 Choose DaySelect the day you want
to see task statistics
Date & Time YesOnly available if you chose daily
 Choose WeekSelect the week you want
to see task statistics
Date & Time YesOnly available if you chose daily
 Choose MonthSelect the month you want to see task statisticsDate & Time YesOnly available if you chose daily
 Choose YearSelect the year you want
to see task statistics
Date & Time YesOnly available if you chose daily

2.2. Automation

a. Task

A task is an execution instance of a process on one or multiple Agents. After creating a workflow (deploying a package to an agent group), the next step is to execute it with the assigned Agents. This can be done manually from the Tasks page or in a preplanned manner, from the Schedules page.

The Tasks page displays by default all the tasks that are running, and the ones placed in a pending state, regardless of whether they were started manually or through a schedule. On this page, you can also manually Create or Edit a task, Start or Stop a task, and display the logs generated by it with just a click of the button. More details can be shown in the Task Details window, to help you with troubleshooting faulted tasks. To access the Task page, you click the Task tab in the left menu. After clicking, the system shows the Task page listing all existed tasks as below:

image-20221028093344-4.png

NoColumnDescription
1Actions/ViewDepending on the status of the task, the system will allow you to perform
some actions to manage the tasks:
VIEW: to view the properties of a task and task log.
DELETE: Remove the task
CLONE: Create an identical task from the existing task
By selecting the Checkbox corresponding to each Task, the delete option will appear beside the Filter option and allow you to delete the Task from the Center.
! Selecting the Checkbox next to Action will select all Tasks in display and allow you to bulk delete selected them
2WorkflowThe name of the workflow which will be used to run the task
3VersionThe version of the Package that was published to akaBot Center.
4AgentThe Agent who the task will be executed.
5Agent GroupGrouping of Agent for deployment purposes where the Agent is located.
6StateCurrent status of the tasks. Available statuses are:
FAULTED: the tasks have encountered an error and have been stopped abruptly.
RUNNING: the task is running. You can stop or kill the task.
PENDING: the task has not been run. You can start to run it.
STOPPED: the task has been stopped.
* SUCCESSFUL: the task has been completed successfully. You can see the log to see the result.

Terminating: the task has been aborted and terminated.
7Start TimeIf a task has been started, the system will show up the start time for you to see.
8End TimeIf a task has been started and ended, the system will show up the end time for you to see.
9SourceTo indicate the source of the tasks.
Manual - the task has been created and configured from the Tasks/Schedule
pages, using the Create New/Clone button.
Agent - the task has been started in attended mode from the akaBot Agent.
Schedule –The task was initiated as a result of a trigger, which is utilized for
preplanned task execution.
10CommandThere are 4 commands user can send:
PENDING: When the task is scheduled to run but not yet run.
START: when the task is being initiated.
STOP: When the task is being stopped.
NONE: When the tasks have finished running
11ScheduleThe name of the Schedule which the task is being scheduled from. If the task is created manually, the Schedule field is empty.
12Task IDUnique ID of the execution instance of the mentioned workflow.
  • View a task

There are a few ways to view the details of the task:
From the Task page: This allows you to view all the created tasks. Click the View button on the left.

image-20221028103213-22.png

From the Workflow Details page: This allows you to view all the created tasks of a specific Workflow. Click the Workflow tab > Select the Workflow > Select the Task tab and select the task item.

image-20221028103341-23.png

From the Agent Details page: This allows you to view all the created tasks of a specific Agent. Click the Agent tab > Select the Agent > Select the Task tab at the bottom and select the task item.

image-20221028103513-24.png

From the Schedule Detail page: This allows you to view all the created tasks of a specific Schedule. Click the Schedule tab > Select the Schedule > Select the Task tab at the bottom and select the task item.

image-20221028103731-25.png

Once clicking, you will be redirected to the Detail page. Details can be viewed below:

image-20221028103810-26.png

Besides the General information which can also be found on the Listing page, the Task Details page also included special Parameters and Log Details of each task.

image-20220506153359-68.png

NoColumnDescription
1ActionAvailable actions to manage the Log of said Task. Included:
View: allows you to be redirected to the Log Detail page.
Delete: by selecting the Checkbox on each Log Item, the delete option will appear beside the Filter option and allow you to delete the Log Item.
! Selecting the Checkbox next to Action will select all Logs in display and allow you to bulk delete selected log items.
 TimestampThe exact time the action was executed at
 LevelThe severity level at which the message was logged. The following options are available: OFF, FATAL, ERROR WARNING, INFORMATION, DEBUG AND VERBOSE.
 MessageThe logged message. This can also be a message logged through the Log Message activity in Studio.
  • Search a task

akaBot Center allows you to search a task list by Free search box, Agent Name, State of Tasks

image-20221028104328-27.png

NoColumn /LabelDescriptionTypeMaximumInput Requirement
1Search boxSearch by the name of every item related to Task.Free text  
2AgentSelect the agent which is assigned to run the task you want to searchInput searchingNo limit 
3StateSelect the state of the task you want to searchInput searchingNo limit 
  • Create/Edit a task

There are three ways tasks can be created:

- When you create a Schedule on the Schedule page or executed an Agent locally, tasks will be created automatically.

- You can also manually create a task on the Tasks page.

- Clone an existing task.

To manually create a task:
Click Create New button on the top right of the page. The System will display the form for you to create the task.

image-20221028104844-28.png

image-20221028104910-29.png

NoColumn/LabelColumn/LabelTypeMaximumIs Mandatory?Input Requirement
 WorkflowSelect the workflow for the task you want to createInput
searching
No limitYes 
 SearchEnter the name of the agent you want to searchStringNo limitNo 
 AgentDepends on the workflow that you chose, select agents you want to run the task you are creating.CheckBox,
MultipleChoice
No limitYes 
 ParametersOther parameters  No 

Alternatively, you can click the Action button and select Clone option to create an identical task. This feature allows you to rapidly perform a task from the tasks list without having to go through the whole configuration process.

This process assumes you previously initiated a task that has already attained a final state. First, select Clone after clicking the corresponding Action button at the beginning of each task.

image-20221028105120-30.png

Once you click the option, the CLONE A TASK window appears, with the task's default parameters.

image-20221028105146-31.png

Feel free to make the necessary modifications and then Save your work by clicking the Save button. The CLONE A TASK window closes, and the execution begins.

Notes: After creating or cloning, the task is automatically deployed to the Agent and runs immediately. On the Tasks page, the status of each task is presented in real-time.

  • Delete a task

To delete a task, you click the Delete button of one task in the list.

image-20221028105307-32.png

Alternatively, you can select the checkbox before each Task and the Delete button will show up next to the Filter button. Tick the Checkbox next to Action will allow users to select all displayed Tasks for bulk delete.

image-20221028105402-33.png

The System will show a message to get your confirmation. Hit Confirm to remove the task.

image-20221028105416-34.png

.

b. Workflow

Workflow represents the association between a Package and an Agent Group. Each time a package is linked to an Agent Group, it is automatically distributed to all the Agent machines that belong to that Agent Group.

The Workflows page enables you to deploy an uploaded package to Agent Groups, manage previously created associations and keep all your workflows up to date. This helps you distribute packages on the Agent machines and execute works faster from the Tasks page. To access the Workflows page, you click the Workflow tab at the left menu. After clicking, the system shows the Workflow page listing all existed Workflow as below:

image-20221028093815-5.png

NoColumn/LabelDescription
1Action

Available actions to manage the Log of said Workflow. Includes:
* VIEW: allows you to be redirected to the Task Detail page.
* EDIT: allows you to edit the details of each Workflow
* DELETE: allows you to remove selected Workflow from Center

*START JOB: Quickly create a new Task related to this workflow.

*ADD SCHEDULE: Quickly add a schedule related to this workflow
By selecting the Checkbox corresponding to each Workflow, the delete option will appear beside the Filter option and allow you to delete the
Workflow
! Selecting the Checkbox next to Action will select all Workflow in display and allow you to bulk delete selected them

2Workflow NameThe name of the Workflow. For organization purposes, it is best to create Workflow Name with the format: Package Name_Agent Group Name.
3Package NameThe name of the Package that was published to akaBot Center
4Package VersionThe version of the package that was published to akaBot Center. The package version will be decided when you choose the publish option in akaBot Studio.
5Agent GroupAgent Group which the workflows will be deployed in
6DescriptionThe current version of Package’s published description
7Created byThe user who creates this Workflow.
  • View a Workflow

To view a workflow, you can click the eye button.

image-20221028095243-9.png

Besides all the general information displayed on the Workflow Listing page, the Workflow Details page also included Parameters and Machine Environment information generated when creating/editing the Workflow.

Furthermore, you can see the update history as well as a list of Tasks executed by said Workflow. Details regarding Tasks shall be explained in the Tasks section.

image-20221028094255-6.png

Here, you can search the Task list by  Time, Name, State, Agent of the tasks. 

image-20221028094515-7.png

Users can also delete executed instances of this Workflow by selecting the Checkbox at the beginning of each Task. The Delete button will show up.

image-20221028094854-8.png
 

  • Search a Workflow

image-20221028095456-10.png

NoColumn /LabelDescriptionTypeMaximumInput Requirement
1Search boxEnter the name of the workflow you want to searchStringNo limit 
2Agent GroupSelect the agent group that the workflow you want to search is attached toInput
searching
No limit 
3PackageSelect the package that the workflow you want to search is attached toInput
searching
No limit 
  • Create a workflow

To create a workflow, you click the “Create New” button at the top of the page.

image-20221028095700-11.png

After clicking, the system shows a form allowing you to create the workflow.

image-20221028100318-14.png

NoColumn /LabelDescriptionTypeMaximumIs Mandatory?Input Requirement
1Package NameSelect the package you want for the workflow you are creatingInput
searching
No limitYes 
2Package VersionDepends on the package that you chose above
Select the version of the package you chose
Dropdown
list
 Yes 
3Agent GroupDepends on the package version that you chose
Select the agent group that you want to attach the workflow that you are creating to
Input
searching
No limitYes 
4DescriptionEnter the description of the workflow you are creating/editingString255 charNo 

Once filled in all the General information, you can add further Parameters and Machine Environment variables to the Workflow. You can add multiple variables, but you can only add one by one.

image-20221028101129-17.png

NoColumn /LabelDescriptionTypeMaximumIs Mandatory ?Input Requirement
 Parameter
Name
Enter the name of the
parameter
String255 charYes 
 TypeSelect the type of the
parameter
Drop down
list
 Yes 
 ValueDepends on the type that
you chose
Enter/select the value of
the parameter
    
  If you chose stringString500 charYes 
  If you chose boolBoolean,
SingleChoice
 Yes 
  If you chose integerInt32500 charYes 

image-20221028101149-18.png

NoColumn /LabelDescriptionTypeMaximumIs Mandatory?Input Requirement
1Variable NameEnter the name of the variableString255 charYes 
2TypeSelect the type of the variableDropdown list Yes 
3ValueDepends on type that you
chose Enter/select the value of the variable
  Yes 
  If you chose stringString500 charYes 
  If you chose boolBoolean, SingleChoice Yes 
  If you chose integerInt32500 charYes 
  • Edit a workflow

To edit a workflow, you click the Three dots button, then click Edit.

image-20221028095829-12.png

After clicking, the system shows a form allowing you to edit the info of the workflow.

image-20221028100409-15.png

NoColumn /LabelDescriptionTypeMaximumIs Mandatory?Input Requirement
1Package VersionDepends on the package that you chose above
Select the version of the package you chose
Dropdown
list
 Yes 
2Agent GroupDepends on the package version that you chose
Select the agent group that you want to attach the workflow that you are creating to
Can not edit   
3DescriptionEnter the description of the workflow you are creating/editingCan not edit   

Once edit package version, you can edit further Parameters and Machine Environment variables to the Workflow. You can add multiple variables, but you can only add one by one (same as above).

  • Delete a workflow

To delete, you click the Three dots button, then click Delete.

image-20221028101551-19.png

Alternatively, you can select the checkbox before each Workflow and the Delete button will show up next to the Filter button. Tick the Checkbox next to Action will allow the user to select all displayed Agent for bulk delete.

image-20221028101717-20.png

After clicking, a system will show a confirmation message for you to confirm.

image-20221028101740-21.png

c. Schedule

Scheduling allows us to perform tasks in a preplanned way. You can execute tasks by commanding Agents to perform different schedules and times according to your needs. The Schedule page enables us to create new schedules. It also displays all previously created schedules, which can be further edited, enabled, or disabled. To access the Schedule page, click the Schedule tab in the left menu. After clicking, the system opens the Schedule Listing page that included all schedules we have created previously.

image-20221028105802-35.png

NoColumnDescription
1ActionOptions off all actions that can be performed on the schedule. This includes:
Enable: Enable the current schedule
Disabled: Disable the current schedule
* Delete: Delete the schedule.
By selecting the Checkbox corresponding to each Schedule, the delete option will appear beside the Filter option and allow you to delete the
Schedule.

! Selecting the Checkbox next to Action will select all Schedule in display and
allow you to bulk delete them.
 NameThe name of the schedule.
 Agent GroupGrouping of Agent for deployment purposes.
 WorkflowThe workflow that is going to be scheduled to execute.
 VersionThe version of the Package Repository that is published to akaBot Center shall be executed by the Schedule. For more details, visit the Package
Repository section.
 StatusStatus of the schedule. There are 3 common statuses:
SCHEDULED – When the schedule is set up but not yet executed.
DISABLED – When the schedule is being disabled
* COMPLETED – When the schedule has been executed successfully
 Start timeThe first time the schedule is executed.
 End timeThe final run time of the schedule.
 Next run timeThe next run time of the schedule.
 Last run timeThe last run time of the schedule.
 Trigger DetailsThe details of the recurrent time which the schedule will execute.
 Created byThe user who created the schedule.
  • View a schedule

image-20221028111221-36.png

Besides the General information above, the Details page also shows the Parameters and Holiday settings of said Schedule.

- Parameters:  From here, you can also see a list of Agents and Tasks associated with this Schedule. Details about Agents and Tasks shall be explained in their respective sections.

- Holiday settings: From here, you can see the holiday settings options for Agent: Run continuously/ Bypass holiday/ Postpone until the next work day.

  • Search Schedule

To search for the Schedule you need, you have some options as below:

image-20221028111813-37.png

NoColumn /LabelDescriptionTypeMaximumInput Requirement
1Search boxEnter any keyword related to the schedule you want to searchStringNo limit 
5AgentSelect the agent that is assigned to run the schedule you want to searchDropdown listNo limit 
6WorkflowSelect the workflow of the schedule you want to searchDropdown list  
  • Create/Edit a Schedule

To create a schedule, you click Create New button.

image-20221028112517-41.png

When you want to edit the Schedule information, click the Edit button in the Action column.

image-20221028112242-39.png

Alternatively, you can access the Details page of said schedule and select the Edit button.

image-20221028112318-40.png

When you click Create new/ Edit, a form will be shown up:

image-20221028112620-42.png

NoColumn /LabelDescriptionTypeMaximumIs Mandatory?Input Requirement
1NameEnter the name of the schedule you want to create/editString50 charYes 
2WorkflowSelect the workflow you want for the schedule you
are creating/editing
StringNo limitNo 
3Time ZoneSelect the time zone for the schedule.Dropdown
list
 No 
 Trigger     
6Start TimeSelect the time at which the schedule will startDate & Time Yes 
7End TimeSelect the time at which the schedule will endDate & Time No 
8RecurrenceSelect the cycle for the schedule: Minutes/ Hourly/ Daily/ Weekly/ Monthly/ AdvanceSingleChoice Yes 
If you chose Once      
9Start DateSelect the date at which the schedule will startDate Yes 
10AtSelect the specified time at which the schedule will startTime Yes 
11TooltipWhen will the sessions start? : See the result of scheduling    
If you chose Minutes      
12Start DateSelect the date at which the schedule will startDate  Yes 
13End DateSelect the date at which the schedule will EndDate  Yes 
14EverySelect the exact cycle for the schedule by minutesSingleChoice No 
15TooltipWhen will the sessions start? : See the result of scheduling    
If you chose Hourly      
16Start DateSelect the date at which the schedule will startDate  Yes 
17End DateSelect the date at which the schedule will EndDate  Yes 
18Every...hoursSelect the exact cycle for the schedule by hours Int3223 hoursNoGreater than 0
 TooltipWhen will the sessions start? : See the result of scheduling    
If you chose Daily      
19Start DateSelect the date at which the schedule will startDate  Yes 
20End DateSelect the date at which the schedule will EndDate  Yes 
21AtSelect the specified time at which the schedule will startTime23 hours, 59 minutesYes 
22TooltipWhen will the sessions start? : See the result of scheduling    
If you chose Weekly      
23Start DateSelect the date at which the schedule will startDate  Yes 
24End DateSelect the date at which the schedule will EndDate  Yes 
25Everyday atSelect the specified time at which the schedule will startTime23 hours, 59 minutesYes 
26

Every week on:

Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

Select the exact cycle for the schedule by hours,
minutes and days.
Multiple Choice No 
27TooltipWhen will the sessions start? : See the result of scheduling    
If you chose Monthly      
28Start DateSelect the date at which the schedule will startDate  Yes 
29End DateSelect the date at which the schedule will EndDate  Yes 
30AtSelect the specified time at which the schedule will startTime23 hours, 59 minutesYes 
31OnSelect exact day in a monthDateSingleChoiceYes 
32OfChoose exact months in a yearMonthMultiple ChoiceYes 
If you chose Advance      
33Cron ExpressionA string comprised of 6 or 7 fields separated by white space allows users to create a CronTrigger to trigger a
schedule that recurs based on calendar.
StringNo limitNoValid syntax of cron expression
Execution Target      
34SearchAllow you to search for a specific Agent to assign the Schedule to.StringNo limitNo 
35Execution TargetDepends on the workflow that you chose, all the Robots
that are related to the selected process are displayed by default.
If you search for a specific Agent, the result will be displayed.
MultipleChoice No 
36Parameters   No 

After filling the form, click the Save button to save it, and the schedule is created. You can also cancel the creation of the schedule by clicking the Cancel button.

  • Disable/Enable a Schedule

To disable a schedule, click corresponding Action button and then select Disable.

image-20221028143344-1.png

After clicking, the system will ask for your confirmation to switch status:

image-20221028143400-2.png

When the schedule is disabled, the status of said schedule changes to Disable.

Similarly, to enable a schedule, click the corresponding Action button and then select Enable.

image-20221028143503-3.png

  • Delete a Schedule

To delete, you need to click The Action button of the corresponding Schedule and select the Delete button.

image-20221028143538-4.png

Alternatively, you can hit the checkbox before each Schedule and the Delete option will appear next to the
Filter option at the top. Click the Checkbox next to Action will allow you to select all displayed Schedule
for delete.

image-20221028143725-5.png

After clicking, the system will allow you to delete and need your confirmation before deleting.

image-20221028143745-6.png

Hit Delete to complete the operation.

  • Holiday settings

Holiday setting allows us to set Holiday for agents.

image-20221028170141-8.png

After setting holidays, when you create a new schedule, in Holiday settings tab of this form, you can choose a running option in Holiday for agents as below: 

image-20221028170318-9.png

d. Package

Package page displays all the projects published from akaBot Studio, as well as the ones that were manually uploaded. A project becomes a package when it is published to akaBot Center.

To access the Package page, you click the Package tab in the left menu. After clicking, the system opens the Package Listing page that includes all Packages we have published to the Center.

image-20221028171907-10.png

NoColumnDescription
 NameThe name of the package that published to akaBot Center
 VersionThe latest version of the package that published to akaBot Center.
Package version will be decided when you choose the publish option in akaBot Studio.
 Tool versionThe version of the installed Studio from which the Package published
 Created DateThe date when the project is published
 StatusThe status of the newest version of the mentioned project. A package
version can have the following statuses:
ACTIVE - it is currently deployed to a process;
INACTIVE - it is not currently deployed to a process (only these can be deleted).
 DescriptionThe description that you created for your project.
 Release NoteThe note was added in the Studio for the respective Package version.
 Created byThe User/Agent who created the Package on Center
  • View a Package

To view the detail of a Package, the user can click the Eye button. On the detail page, you will see a list containing all versions of the selected package which were uploaded/published to the Center.

image-20221028172050-12.png

NoColumnDescription
 NameThe name of the package that published to akaBot Center
 StatusThe status of the package version. A package version can have the following
statuses:
Active - it is currently deployed to a process;
Inactive - it is not currently deployed to a process (only these can be deleted).
 Created DateThe date when the version is published
 VersionThe version of the package that was published to akaBot Center.
 Tool versionThe version of the installed Studio from which the Package published
 DescriptionThe description that you created for your project.
 Release NoteThe note added in Studio for the respective Package version when it is
published
 Created byThe User/Agent who created the Package on Center
  • Search Package

This option allows you to search the package by entering the package name.
 

image-20221028172147-13.png

  • Upload a Package

Typically, when you publish a workflow to the Center, a package will be uploaded to the Center automatically. However, you can also Manually upload a package to Center using the Create New button located at the top right of the Listing page.

image-20221028172417-14.png

The system will display the window for you to upload the Packages.

image-20221028172438-15.png

Click Choose File and select the packages (with the .nupkg extension) and hit Open.

Once you select the Package to upload from your local machine, hit Save to finish the upload, Cancel to terminate the operation.

  • Delete a Package

On the Packages Repository page, click on the Name of the package. The Package information and a list of all versions will be displayed.

image-20221028172537-16.png

Select Delete action corresponding with the version of the package you want to delete. A confirming popup will display. Hit Delete to complete the operation.

image-20221028172552-17.png

The selected package version is removed. If Delete related items? is selected, any Tasks, Log, Schedules and Workflow linked to this package shall also be removed.

2.3. Resources

a. Agent

An Agent is an execution host that runs processes that are built in akaBot Studio.

The Agents page allows you to add Agents, edit them, and examine their status as well as the change runtime settings and the Agent Group to which they are assigned.

Note: When the status of an Agent is busy (executing a process), you cannot edit the Username, Machine, or Type. To access the Agent page, click “Agent” tab in the left menu. After clicking, the system shows the Agent page listing all existed Agents as below.

image-20221031154319-2.png

NoColumn/LabelDescription
1ActionAvailable actions to manage the Agent. Includes:
Edit: allows you to edit the details of each Agent
Delete: allows you to remove selected Agent from the Center
By selecting the Checkbox on each Agent, the delete option will appear beside the Filter option and allow you to delete the Agent from the Center
! Selecting the Checkbox next to Action will select all Agents in display and allow you to bulk delete selected them.
2NameThe name of the Agent. You can click the name of the Agent the view its details.
 VersionThe installed version of the akaBot Agent tool in the local machine
 StatusThe current status of the Agent.
AVAILABLE - the Agent is connected to the Center, not running any
process and is free to be used
BUSY - the Agent is running a process.
DISCONNECTED- the Agent and Center have not communicated in
the last 10 seconds.
 Agent GroupThe Agent Group to which the Agent belongs.
 Machine nameThe name of the machine the Agent is registered on.
 Machine UsernameThe username used to log in to the Agent machine
 DescriptionDescription of the Agent
 Created byThe user who created the Agent
  • View an Agent

You can view the details of the Agent by clicking the eye button.

image-20221031154549-3.png

NoColumn/LabelDescription
1Agent GroupThe Agent Group to which the Agent belongs.
2NameThe name of the Agent. You can click the name of the Agent the view its details.
3Machine nameThe name of the machine the Agent is registered on.
4Machine UsernameThe username used to log in to the Agent machine
5TypeThe type of Agent. This can be only Development, Assistant, Staging, Production. It is possible to filter the page according to the Agent type.
6StatusThe current status of the Agent.
AVAILABLE - the Agent is connected to Center, not running any process
and is free to be used
BUSY - the Agent is running a process.
DISCONNECTED - the Agent and Center have not communicated in the
last 10 seconds.
7DescriptionDescription of the Agent
8VersionThe installed version of the akaBot Agent tool in the local machine
9Created byThe user which created the Agent.

Besides details regarding the Agent, all the tasks, logs, and connection verification status of the Agent can also be found here.

  • View an Agent’s tasks

At the bottom of the Details page, you can see a list of all the tasks that are executed by this specific Agent.

image-20221031154931-5.png

Details regarding Tasks shall be explained in the Task sections.

  • View an Agent’s log

To view the Agent’s logs from the Agent Details page, click the Log tab next to the Task tab to switch the view.

image-20221031155216-6.png

You can also Export Log for further investigation by clicking the Export Log option next to the Filter button. You can export all Logs or specific filtered Log Items.

image-20221031155405-7.png

  • Verify the Agent Connection

To make sure the Center and Agent are correctly connected with a valid username and password, you can click on the Verify button.

image-20221031155517-8.png

If the user clicks this button when the Agent is connected, an ID/Password authentication check will be performed to determine if the ID/Password is correct and can be logged in.

There are three possible verification task states:

  • PENDING: the verification task was created and waiting for verification from the agent
  • SUCCESSFUL: the agent was verified and the username password was correct
  • FAULTED: the agent was verified and the username password was incorrect

Verification tasks and verify button will be updated in real-time. When there is a pending verification task on the verification tab, verify button will be disabled.
When the user clicks on verify button, the verification tab will be opened automatically and there is also a "Verifying..." notification shown in the top right corner.

To view all the Verification requests created, go to the Agent tab > View agent detail > Select Verification tab.

image-20221031155727-9.png

  • Create/Update an Agent

The first step of connecting an Agent to the Center is to create an Agent in the Center.

Notes: You are unable to edit an Agent with status = BUSY (executing a task). To create a new Agent, you should click the “Create New” button on the top right corner of the screen

image-20221031155823-10.png

To edit an Agent, you should click the Edit button of one Agent in the list. Alternatively, you can click the Edit button on the Detail Page of the Agent.

image-20221031155905-11.png

After clicking, the system shows a popup allowing you to fill properties to create/edit a new Agent. You need to fill in all the necessary info in the form below.

image-20221031155928-12.png

Agent tab

NoColumn /LabelDescriptionTypeMaximumIs Mandatory?Input Requirement
1KeyThis is the identification of one agent. You will input this key into the Agent Key field in your local Agent.String50 charYesThis field is
auto-generated by the system
2NameEnter the name of the agent you want to create/editString50 charYes 
3Machine NameEnter the name of the computer on which the Agent is deployedString50 charYes 
4Machine UsernameEnter the username used to log in to the computer which is mentioned aboveString50 charNo 
5Machine PasswordEnter the password used to log in to the computer which is
mentioned above
String255 charNo 
6TypeSelect the type of the agent you want to create/edit. There are 4 different types you can
choose: DEVELOPMENT,
ASSISTANTSTAGING
and PRODUCTION.
Dropdown list, SingleChoice Yes 
7DescriptionEnter the description of
the agent you want to create/edit
String500 charNo 

Agent Settings Tab

NoColumn /LabelDescriptionTypeMaximumIs Mandatory?Input Requirement
1Console / RDPakaBot executes workflow in an interactive Windows session. There are two types of Windows sessions the Robot can start:
Console Session
RDP Session
SingleChoice Yes 
2Login To ConsoleThis option allows the Agent connects to a
Console session Only
available if you chose
RDP
Checkbox No 
3Font SmoothingThis option enhances text recognition. Only available if you chose RDPCheckboxNo limitOptional 
4Resolution Width / Height / DepthThis option allows users to set a custom resolution if the
automation process is required. Only available if you
chose rdp
Int32
(Number)
 OptionalGreater than 0
5OthersOther specific parameter for this AgentStringNo limitOptional 

After filling the form, you click the Save button to record the Agent to the system.
Follow the instruction to connect the Agent to the Center using the Agent Key to complete the connection.

  • Search for Agent

To search for the Agents you need, insert Agent name to search box of select Agent group, Status to find:

image-20221031160353-13.png

  • Delete an Agent

To delete, you need to click the Delete button.

image-20221031160620-14.png

Alternatively, you can select the checkbox before each Agent and the Delete button will show up next to the Create Newr button. Tick the Checkbox next to Action will allow users to select all displayed Agent for bulk delete.

image-20221031160701-15.png

b. Agent Group

An Agent Group is a grouping of agents that is used to deploy processes. The Agent Group page displays all previously created groups and enables you to manage Agents within them. The Agent Group page allows you to search and filter agent groups by name and description. 

image-20221031161241-16.png

NoColumn/LabelDescription
1ActionAvailable actions to manage the Agent Group. Included:
Edit : allows you to edit the details of each Agent Group
Delete: allows you to delete selected Agent Group
By selecting the Checkbox corresponding to each Agent, the delete option will appear beside the Filter option and allow you to delete the
Agent from Center

! Selecting the Checkbox next to Action will select all Agent Group in display and allow you to bulk delete selected them
2NameThe name of the Agent Group. You can click the name of the Agent Group the view its details
3DescriptionThe description of the Agent Group
4Created byYou can see the username that created the Agent Group

To view the details of the Agent Group, click eye button.

image-20221031161320-17.png

NoColumn/LabelDescription
1NameThe name of the Agent Group. You can click the name of the Agent Group the view its details
2DescriptionThe description of the Agent Group
3Created byYou can see the username that created the Agent Group
4AgentThis section will list all Agents that are assigned to this Agent Group.
Here, you can view details of each agent, including its version, status, machine name, machine username, type, description and the user who created it.
  • Create/Edit an Agent Group

To create a new agent group, you should click “Create New” button on the top right corner of the screen.

image-20221031161529-18.png

When you want to edit the Agent Group information, click the Edit button: 

image-20221031161612-19.png

When you click on Create New/Edit button, the system will show a form for you to fill in. Details are in the table below.

image-20221031161704-20.png

NoColumn /LabelDescriptionTypeMaximumIs Mandatory?Input Requirement
1NameEnter the name of the
agent group you want to create/edit
String100 charYes 
2DescriptionEnter the description of
the agent group you want to create/edit
String255 charNo 
3AgentSelect the agent you want
to add to the agent group
that you are
creating/editing.
You can click the bin icon
next to the Agent to
remove it if needed.
Input searchingNo limitYesYou can add many agents into agent group, but you can only add one by one

Once all information is filled, hit Save.

  • Remove Agent Group

To delete an agent group, you should click the Delete button of the agent group you want to remove from the Agent Group list.

image-20221031162101-21.png

Alternatively, you can hit the checkbox before each Agent and the Delete option will appear next to the Filter option at the top. Click the Checkbox next to Action will allow you to select all Agents for deletion.

c. Agent Pool

Agent Pool allows you to create a "pool" of Agents related to a workflow. Anytime when the workflow need to be executed, the available Agent in the pool at that time will automatically execute the workflow so that we can make the best use of Agents.

  • Create an Agent Pool

You need to complete some other tasks before creating an Agent Pool: Create an Agent Group -> Create a Workflow -> Create an Agent Pool. 

Step 1: Create an Agent group: Open Resources tab -> Click Agent Group tab -> Click Create new -> Fill form and Save

Step 2: Create a Workflow: Open Automation tab -> Click Workflow tab -> Create new workflow -> Fill the form with exact Agent Group you've created -> Save

Step 3: Create an Agent pool: Open Resources tab -> Click Agent Pool tab -> Click Create New (As the picture below):

image-20221031170544-22.png

Then a form will show up for you to fill:

image-20221031170959-23.png

NoColumn /LabelDescriptionTypeMaximumIs Mandatory?Input Requirement
1NameEnter the name of Agent poolString55Yes 
2DescriptionEnter the description of the workflow you are creating/editingString No 
3WorkflowChoose the workflow you have createdDropdown
list
 Yes 
4DescriptionEnter the description of the workflow you are creating/editingString255 charNo 

Next to general tab, there is Callback Setup. This feature allows you to send the output to a third party when the Agents in this pool complete a task. 

image-20221031171615-24.png

There are 3 sending options: 

No callback as default: Do not send the ouput

Restful API (POST Method): Send the output through the API you insert.

image-20221101104556-1.png

Webhook: Send the output to the Webhook address

image-20221101104633-2.png

2.4. Assets

Assets usually represent shared variables or credentials that can be used in different automation projects. They allow you to store specific information so that the Robots can easily have access to it.

Additionally, an extra level of security is provided, as all credentials stored here are encrypted with the AES 256 algorithm. They can be invoked by RPA developers when designing a process, but their values can be hidden from them. The Assets page enables you to create new assets. It also displays all previously created assets, which can
be edited or deleted.

To access the Asset page, you click Assets tab in the left menu. After clicking, the system opens an Asset Listing where all the Assets are located.

image-20221028172721-18.png

NoColumnDescription
1ActionAvailable actions to manage the Assets. Includes:
Edit: allows you to edit the details of each Assets
Delete: allows you to delete selected Asset
By selecting the Checkbox corresponding to each Asset, the delete option
will appear beside the Filter option and allow you to delete the Asset from the Center

! Selecting the Checkbox next to Action will select all Assets in display and allow you to bulk delete selected them
2NameThe name of the assets
3TypeMandatory. The following options are available:
Text - assets that can store string values. This is the default option.
Bool - assets that can store a true or false value. If you select this
option, the Value field displays two radio buttons (True, False).
Integer - assets that can store integers.
Credential - assets that can store credentials. If you select this option the Value field is replaced by two others: Username and Password.
4ValueThe value assigned to an asset:
Common Value - the default value received by every agent, unless a
specific value is assigned to an agent.

Value Per Agent - a value received only by the specified agent.
If Common Value is disabled, at least one agent value must be provided
5Created byThe user who created the Assets.
  • View an Asset

To view an Asset, you click Eye button:

image-20221028172822-19.png

The system shows the details of workflow as below:

image-20221028172847-20.png

  • Search Asset

This option allows you to search Asset by name, or select Asset type, kind of Asset:

image-20221028173019-21.png

NoColumn /LabelDescriptionTypeMaximumInput Requirement
1Search boxEnter the name of the asset you want to searchString  
2TypeSelect the type of the asset you want to searchDropdown list  
3KindSelect the kind of the asset you want to searchDropdown list  
  • Create/edit an Asset

In order to create an Asset, on the Assets page, click Create new.

image-20221028181706-22.png

When you want to edit an existing Asset, click the Edit button as below: 

image-20221101105055-5.png

Alternatively, you can access the Details page of said Asset and select the Edit button.

image-20221101105150-6.png

The system will display the form for you to create/ Edit an Asset:

image-20221101105313-7.png

NoColumn/ LabelDescriptionTypeMaximumIs Mandatory?Input Requirement
1NameEnter the name of the asset you want to create/editString255 charYes 
2TypeSelect the type of the asset you want to create/editDropdown list Yes 
3Common ValueThis means every agent can access the asset you are creating/editing    
4ValueDepending on the type you chose Enter/select the value of the assetString500 charYes 
   Bool YesBy default, True is selected.
   Int32500 charYes 
   Credentials YesBoth User and Password needed to be filled
5Value Per AgentThis means only agents that are chosen by you can access the asset you are creating/editing   You can add multiple choices, but you can only add one by
one
6AgentSelect the agent you want to give rights to access the asset you are creating/editingInput searchingNo limitYes 
7ValueDepends on the type you chose Enter/select the value of the asset you are creating/editingString500 charYes 
   Bool, SingleChoice Yes 
   Int32500 charYes 
   Credentials YesBoth User and Password needed to be filled
  • Delete an Asset

To delete a task, you click the Delete button of the corresponding Asset.

image-20221101104746-3.png

Alternatively, you can select the checkbox before each Asset and the Delete button will show up next to the Filter button. Tick the Checkbox next to Action will allow users to select all displayed Assets for bulk delete.

image-20221101104914-4.png

2.5. Queue

Queue in simple terms is a container that holds a set of items that you want to be processed by akaBot Agents. Queue items can store different types of data, such as customer details. This information can be processed in other systems - SAP or Salesforce, for instance.

Queues enable you to create large automation projects underlined by complex logic. New queues created in akaBot Center are empty by default. To populate queues with items, to change their status and process them, you have to use Studio activities. As soon as queue items are processed, they become transactions. To access the Queue page, you click Queue tab in the left menu. After clicking, the system opens Queue Listing Page where all the Queues are located.

image-20221101110036-8.png

NoColumnDescription
1ActionAvailable actions to manage the Queue. Includes:
Edit: allows you to edit the details of each Queue
Delete: allows you to remove selected Queue from Center.
By selecting the Checkbox corresponding to each Queue, the delete option will appear beside the Filter option and allow you to delete the Queue.

! Selecting the Checkbox next to Action will select all Queue in display
and allow you to bulk delete selected ones.
2NameMandatory. The name of the queue.
3DescriptionMandatory. The description of the queue.
4In progressThe item was processed with the Get Transaction Item or the Add Transaction Item activity; when an item has this status, your custom
progress status is also displayed, in the Progress column.
5RemainingThe number of queue items that have not been processed yet, and have a New status.
6Average timeThe average time that was required to process the queue items, was expressed in seconds.
7SuccessfulThe total number of transactions that were processed successfully.
8App ExceptionsThe total number of transactions that failed with an application exception.
9Biz ExceptionThe total number of transactions that failed with a business exception.
  • View a Queue

To view a Queue, you click Eye button.

image-20221101110141-9.png

The system shows the details of the queue as below:

image-20221101110211-10.png

NoColumnDescription
1NameThe name of the queue.
2DescriptionThe description of the queue.
3In progressThe item was processed with the Get Transaction Item or the Add Transaction Item activity; when an item has this status, your custom
progress status is also displayed, in the Progress column.
4RemainingThe number of queue items that have not been processed and have a New status.
5Average timeThe average time that was required to process the queue items, was expressed in seconds.
6SuccessfulThe total number of transactions that were processed successfully.
7App ExceptionsThe total number of transactions that failed with an application exception.
8Biz ExceptionThe total number of transactions that failed with a business exception.
  • Transaction

Once a Queue item was in proceed, it becomes a transaction. You can check the details of the processing
queue items in the details of the queue.

NoFieldDescription
1ActionAvailable actions to manage the Queue. Includes:
View: allows you to view information of each Transaction.
Edit: allows you to edit the details of each Transaction.
Clone: allow users to create an identical Transaction.
Delete: allows you to delete selected Transaction.
By selecting the Checkbox corresponding to each Queue, the delete option will appear beside the Filter option and allow you to delete the Queue from the Center.

! Selecting the Checkbox next to Action will select all Queue in display and allow you to bulk delete selected them
2StatusThese statuses let you know if an item has been processed or not, and the
stage of the process at a particular time. Queues items can have these
statuses:
NEW
IN PROGRESS
FAILED
SUCCESSFUL
ABANDONED
RETRIED
* DELETED
3ReferenceA custom identifier for a transaction or a group of transactions.

It supports all special characters, except double-quoted. This is set for the automation project, using the Add Queue Item or Add Transaction Item activity.
The reference can be unique, depending on what you chose in the Unique Reference field when you created the queue.
4RevisionThis allows you to know the status of the revision of those queue items that have been abandoned or have failed with an application or business
exception.
5PriorityThe processing priority level of the transaction item. This field is populated according to the priority level set in the Add Queue Item activity (Low, Normal, High), in Studio.
6DeadlineThe latest time at which the queue item should be processed. This field is populated according to how you configured the Deadline property of the Postpone Transaction Item activity, in Studio.
7PostponeThe earliest time at which the queue item is available for processing. This field is populated according to how you configured the Postpone property of the Postpone Transaction Item activity, in Studio.
8StartedThe amount of time that passed since the processing started.
9EndedThe amount of time that passed since the processing stopped.
10AgentThe name of the Agent that has processed a transaction.
11ExceptionThe type of exception that caused an item to fail. This is populated according to the error type selected in the Set Transaction Status activity in Studio.
12Specific dataJSON Schema data.
  • Create/Edit a Queue

In order to create a Queue, on the Queue Listing page, click Create new

image-20221101110414-11.png

To edit an existing Queue, select the Edit button corresponding to the Queue you want to edit:

image-20221101110501-12.png

The system will display the form for you to create/edit a Queue

image-20221101110535-13.png

NoColumn /LabelDescriptionTypeMaximumIs Mandatory?Input Requirement
1NameEnter the name of the queue you want to searchInput searching255 charYes 
2Unique ReferenceCheck the checkbox if you want to enforce unique references in all the transactions that are to be added to the queue.  NoThis option cannot be edited and displays if the current queue enforces unique references or not.
3Auto RetryIndicates if the Center should retry to process items in the queue when an Application Exception is encountered.  No 
4Maximum of retriesOnly appear if the Auto Retry option is selected.Int3250 charNoGreater than 0
5JSON SchemaWhen creating or editing a queue, you can upload a custom JSON.    
6Specific DataJSON schema for the specific data of all transactions in the queue. File size limited to 256kb by
default.
No 
7Output DataJSON schema for the output data of all transactions in the queue. File size limited to 256kb by
default.
No 
8Analytics DataJSON schema for the output data of all transactions in the queue. File size limited to 256kb by
default.
No 

After filling the form, click the Save button to save it, and the Queue is created. You can also cancel the creation of the queue by clicking the Cancel button.

  • Delete Queue

To delete a queue, you click the Delete button of the corresponding Queue.

image-20221101111838-14.png

Alternatively, you can select the checkbox before each Queue and the Delete button will show up next to the Filter button. Tick the Checkbox next to Action will allow users to select all displayed Queue for bulk delete.

image-20221101111942-15.png

2.6. Monitoring 

a. Productivity

This page allows you to make the best use of your Agents by tracking and monitoring Agent's activities on a Calendar. 

image-20221101151901-1.png

  • View Agents' activities.

To view Agent's activities, please click Monitoring tab from the main menu. After clicking, you immediately see the view by week of all Agents' activities.

image-20221101154859-5.png

NoButtonDescription
1TodayBack to the Today's activities view
2Forward/BackwardMove to the day before/ the day after view
3Month and dateIf you would like to show the activities in a time you consider, just click on the Date and Month button, then a small calendar will show up for you to choose the time you want.
4Day, week, monthchange the view into Day/Week/ Month
  • Filter Agents' Activities

You can view the exact activities of Agents you want by selecting Agents' name and machine name at the corner of the calendar.

image-20221101154015-3.png

  • Create a schedule

From here, you can see the free times of Agents. So you can quickly create a new schedule for an Agent by clicking on free time area on the calendar. Then, a form will show up for you to enter the necessary information. After clicking "Save" button, the new schedule will show up on the calendar.

image-20221101160835-6.png

b. Report

Report provides activity statistic information about the Agents & Workflows which are currently being connected to Center. Here, you can get information such as the number of successful tasks, a number of tasks that are running, stopped, or faulted. You can also check the total number of task that was run by the selected Agent or Workflows

You can get your reports by Agent and Workflow. To access the Report page, click on the Report tab in the left menu.

  • Report for Agent

Users can view Agent Report by going to Report tab > Select Agent tab.

image-20221101161308-7.png

NoColumnDescription
1Agent NameThe name of the Agent which activities is reported
2Workflow NameThe name of the Workflow which activities is reported
3Task SuccessfulThe total number of tasks that are successfully executed.
4Task RunningThe total number of tasks that are currently executing
5Task StoppedThe total number of tasks that have been stopped
6Task FaultedThe total number of tasks that experienced errors during execution
7TotalThe total number of tasks that are initiated until now.

To get the report, you can use the filter at the top of the page.

image-20221101161709-9.png

NoColumn /LabelDescriptionTypeMaximumInput Requirement
1Start DateFrom which date you want to get the agent’s activity statistics.Date & Time  
2End DateTo which date you want to get the agent’s activity statistics.Date & Time  
3Select Agent
Group
Select the agent group in which you want to see activity statistics.Input searchingNo limit 
4Select AgentSelect the agent of which you want to see activity statisticsInput searchingNo limit 
5View reportClick View for the report to be generated   
6ExportDownload the report   

The Report will be downloaded to your local machine and shall be open:

image-20220506154654-138.png

  • Report for Workflow

Similar to Agent Report above. Please scroll up to read. 

2.7. Administration

a. User Management

A user is an entity with access-dependent capabilities whose perspective and control of akaBot Center are contingent on the roles they have been designated. Users can be created in the Center.

This page displays all available users and allows admin to add or delete, as well as update users’ information.

After selecting the User management tab, the system displays the following page:

image-20221101163259-10.png

NoColumnDescription
1ActionAvailable actions to manage the User. Includes:
Edit: allows users to view the details of the User.
Delete: allows users to delete selected User.
2LoginThe username credentials that will be used to sign in.
3EmailThe email address of the user. Can be used to log in to akaBot Center.
4StatusThe status of the user. Can be Activated or Deactivated.
5LanguageThe display language of akaBot Center for user.
6ProfilesThe role(s) assigned to the user. There are 3 default roles:
ROLE_ADMIN
ROLE_USER
* ROLE_ROBOT
A user can have more than one role. Details about permission for each role will be explained in Role Management.
7Created dateThe date when the user is created
8Modified byThe last person who modified the user’s information
9Modified dateThe last date on which the user’s information was modified
  • View a User

To view a user’s details, click on the eye button.

image-20221101163356-11.png

image-20221101163519-12.png

NoColumnDescription
 LoginThe username credentials that will be used to sign in.
 StatusThe status of the user. Can be Activated or Deactivated.
 First nameThe first name of the user.
 Last nameThe last name of the user.
 EmailThe email address of the user. Can be used to log in to akaBot Center.
 LanguageThe display language of akaBot Center for each user.
 Created byThe user who created this user.
 Created dateThe date when the user is created.
 Modified byThe last person who modified the user’s information.
 Modified dateThe last date on which the user’s information was modified
 ProfilesThe role(s) assigned to the user. There are 3 default roles:
ROLE_ADMIN
ROLE_USER
* ROLE_ROBOT
A user can have more than one role. Details about permission for each role will be explained in the Role Management section.
  • Create/Edit a User

To create a new user, click the Create new at the top of the User page.

image-20221101163616-13.png

When you click on Create New/Edit button, the system will show a form for you to fill in. Details in the table below.

image-20221101163638-14.png

NoColumn /LabelDescriptionTypeMaximumIs Mandatory?Input Requirement
1LoginEnter the username used to log in to the system of the user you
are creating/editing
String50Yes 
2First NameEnter the first name of the userString50Yes 
3Last NameEnter the last name of the userString50Yes 
4EmailEnter the email of the userString100Yes 
5PasswordOnly available in create new
Enter the password of the user
String50Yes 
6Confirm PasswordOnly available in create new
Reenter the password of the
user
String50Yes 
7ActivatedSelect this if you want this user to be activated upon creationCheck
Box
 No 
8LanguageSelect the language of the userDropdown list,
SingleChoice
 Yes 
9ProfilesSelect roles for the userMultipleChoice Yes 

After filling the form, click the Save button to save it, and the User is created. You can also cancel the creation of the queue by clicking the Cancel button.

  • Delete a User

To delete a User, you click the Delete button of the corresponding User.

image-20221101163711-15.png

A confirming pop-up will display. Hit Delete to complete the operation.

b. Role Management

akaBot incorporates a role and permission-based access-control framework. Roles are sets of permission, which means that the permissions required to access and control specific Center resources are assigned to roles. In other words, Users were not given permission to certain resources but will get the permit through a role. Depending on their roles, users have access to the resources listed below:

NoResource
1ADMIN RESOURCE
2ENVIRONMENT RESOURCE
3ROBOT RESOURCE
4PACKAGE RESOURCE
5WORKFLOW RESOURCE
6JOB RESOURCE
7SCHEDULE RESOURCE
8ORGANIZATION UNIT RESOURCE
9ASSET RESOURCE
10QUEUE RESOURCE
11LOG RESOURCE
PermissionsCategory
NoneUsers won’t see the resource in the Center interface.
ViewUsers can see the resources but can’t interact with it.
EditUsers can see and edit the resources.
CreateUsers can see and create new resources.
DeleteUsers can delete the resources.

This Role Management page displays all available roles and allows admin to add or delete, as well as update roles’ information. After selecting the Role Management tab, the system displays the following page:

image-20221101164359-16.png

NoColumnDescription
1ActionAvailable actions to manage the User. Includes:
Edit: allows users to view the details of the Roles.
Delete: allows users to delete selected role
2NameThe title of the role
  • Default Roles

In akaBot Center, there are 3 default roles:

- ROLE_ADMIN

- ROLE_USER

- ROLE_ROBOT

ROLE_ADMIN
By default, the role has all the rights to all resources and this cannot be changed.

ROLE_USER
By default, the role has the following rights, but they can be edited.

image-20220506154907-150.png

ROLE_ROBOT
By default, the role has the following rights, but they can be edited:

image-20220506154916-151.png

  • Create/edit a Role

To create a new Role for your Center, click the Create New button at the top of the page:

image-20221101164549-17.png

To edit an existing Role, click the Edit button corresponding to the Role in the Action column.

image-20221101164638-18.png

When you click on Create New/Edit button, the system will show a form for you to fill in. Details in the table below

image-20220506154945-154.png

NoColumn /LabelDescriptionTypeMaximumIs Mandatory?Input Requirement
1NameEnter the role nameString100 charYes 
2ResourcesYou can only choose one
option for each row
Select the rights for the role
SingleChoice Yes 
  • Delete a role

To delete a role, you click the Delete button of the corresponding role.

image-20221101164723-19.png

A confirming pop-up will display. Hit Delete to complete the operation.

c. Organization Unit

Organization Units (OU) provide the separation of Orchestrator components into tenants for designated users. The user's perspective of akaBot Center is determined by the organization unit in which they are placed, as well as the role(s) appointed to them. The following categories of entities make up an organization unit: 

  • Agent group
  • Agents
  • Workflows
  • Tasks
  • Schedules
  • Packages Repository
  • Assets
  • Queue
  • Logs
  • Report
    ! Statistics are produced for each organizational unit and shown on the Dashboard.

Notes:
A user with no assigned Organization Unit does not have access to any type of resources.
The same agent cannot be provisioned on two different Organization Units. Resources cannot be moved from one organization unit to another.
A drop-down list displays all of the units assigned to a user located at the header of the page, available at all times. User can also use this to switch between OU.

image-20221101164936-20.png

To access the OU page, click on the Administration tab in the left menu, then click Organization Unit tab. All previously created OU shall be in display there as below:

image-20221101165208-21.png

As an Admin, you may view the details of specific OU, create, update, or remove or filter the OU, as well as manage the users that are allocated to them.

  • View an OU

In order to view all the details of an OU, you can click the eye button.

Once clicking, you will be redirected to the Details page.

image-20221101165318-22.png

NoColumn/LabelDescription
 NameThe name of the OU
 *DescriptionThe description of the OU
 UserThe list of all the Users assigned in this OU. This list included:
Username
Email
* Assigned roles
  • Create/edit an OU

To create a new organization unit, you click "Create New” button. If you want to edit an OU, select the edit option from Action next to the corresponding OU Name.

image-20221101165443-23.png

After clicking, the system shows a pop-up form for you to fill the information:

image-20221101165552-24.png

NoColumn /LabelDescriptionTypeMaximumIs Mandatory ?Input Requirement
1NameEnter the custom name
of the OU you want to create/edit
String255 charYes 
2DescriptionEnter the description of
the OU you want to create/edit
String1000 charNo 
3UserSelect user you want to
add into the OU that you are creating/editing
Input searchingNo limitYesYou can add many users, but you can only add one by one

If you want to unassign a user from an organization unit, open the Edit windows and hit the bin icon in the action field. Once all the information is filled/edited, hit Save. Your OU is created.

  • Remove an OU

Important!  Delete an Organization Unit will delete all resources within the unit. To remove an OU, click the corresponding Delete button next to the Organization Unit name on the Organization Unit page.Type your warning message here.

image-20221101165636-25.png

A confirmation pop-up will appear. Select Delete to finish the operation.

d. Webhook

Webhooks allow you to integrate your akaBot Platform with your whole application ecosystem more effectively. You may subscribe to Center events and forward them to any external DCM, BPM, or CRM solution to notify various users, such as when a new queue item is ready for processing, a trigger fails, or a process is changed.

Notes: Your application must be web-hooked and compatible with akaBot.

After selecting the Webhook tab, the system displays the following page.

image-20221101165929-27.png

NoColumnDescription
1ActionAvailable actions to manage the Webhook. Includes:
Edit: allows users to edit a particular webhook.
Delete: allows users to delete selected webhook
2URLThe URL of your application
3Subscribed EventThe events will be forwarded to your application.
4EnableThe status of the webhook. There are two possible statuses: Enabled or
Disabled

Create/edit a Webhook

To create a webhook

image-20221101165953-28.png

NoColumn /LabelDescriptionTypeMaximumIs Mandatory?Input Requirement
1URLEnter the url of the system that you want to give rights to subscribe and listen to akabot
center
String1000 charYes 
2EnabledTick this box if you want
for this Webhook to work
Check Box No 
3Choose All Events / Choose EventsAllow you to choose between send all events to your application or only send selected Events.SingleChoice Yes 
4FilterSelect the Events you
want to forward to your
application.
You can choose multiple
events from the list.
MultipleChoice YesOnly available if you select Choose Events option

e. License

Agent/Studio license is accessible on Organization Unit based on the License page in the Center. This allows you to accelerate deployment and manage activation from a single place. With the press of a button, you may activate, renew, or cancel licenses. You may also track license usage throughout the year.

After selecting the License Management tab, the system displays the following page:

image-20221101170138-29.png

  • Add license

https://docs.akabot.com/bin/view/akaBot%20Center/Center%20Installation/Activation/

  •  Renew license

https://docs.akabot.com/bin/view/akaBot%20Center/Center%20Installation/%5B4%5D%20License%20Renewal/

f. Token

Token page allows you simply create a new token to access the API without sending account and password to the third party.

  • View token

From the dash board, you click Administration tab, then choose Token tab. Once clicking, the list of created tokens will be shown. 

image-20221101170819-30.png

NoColumn /LabelDescription
1ActionAvailable actions to manage the Webhook. Includes:
Edit: allows users to edit a token.
Delete: allows users to delete selected token.
2Alias NameThe name of the third party that you will send the token to.
3NameThe name of token
4DescriptionEnter the description of
the OU you want to create/edit
5RolesThe roles who can access the token
Tags:
 
Navigation