For Team IT-Operation
Use case 1: Create / Edit an OU
S1: To access the Organization Unit page, click on the Administration tab in the left menu, then click Organization Unit tab
S2: In order to view all the details of an OU, you can click the eye button
Then you will see the detail page
| Column/ Label | Description |
| Name | The name of the OU |
| User | The list of all the Users assigned in this OU. This list included: Username Email |
S3: To create/ edit OU
Click "Create New” button. If you want to edit an OU, select the edit option from Action next to the corresponding OU Name
S4: After clicking, a pop-up form shows up for you to fill in the information
| Column/ Label | Description |
| Name | Enter the custom name of the OU you want to create/edit |
| Description | Enter the description of the OU you want to create/edit |
| User | Select user you want to add into the OU that you are creating/editing Note: You can add many users, but you can only add one by one |
Use case 2: Remove an OU
In Organization Unitmenu > click Delete button next to the OU name on the page to remove an OU
Note: Delete an OU will delete all resources within the unit
Use case 3: Create/ edit a new Role
Roles are sets of permission, which means that the permissions required to access and control specific Center resources are assigned to roles
S1: In the menu, choose Administration, then choose Role Management tab to see the decentralization of each role.
S2: Click the Create New button at the top of the page to create new role
S3: Then a pop-up form will show up for you to fill in
S4: Tick in the box to give permission for your new role > then click Save
| Permissions | Category |
| None | Users won’t see the resource in the Center in interface |
| View | Users can see the resources but can’t interact with it |
| Edit | Users can see and edit the resources |
| Create | Users can see and create new resources |
| Delete | Users can delete the resources |
S5: To editan existing Role, click the Edit button corresponding to the Role in the Action column.
Use case 4: Remove role
S1: To delete a role, you click the Delete button of the corresponding role.
S2: A confirming pop-up will display > Click Delete to complete the operation.
Use case 5: View/ Edit/ Create a new account
S1: Click Administrationin the left menu > Choose Users tab, then you will see detail page as below:
S2: To view a user, click eye button
Then, screen will demonstrate as below:
| Column | Description |
| Status | The status of the user. can be Activated or Deactivated |
| Profiles | The 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 |
S3: To create/edit account, click create new on the right
When you click on Create New/Edit button, the system will show a form for you to fill in. Details in the table below
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
Use case 6: Delete account
To delete a User, you click the Delete button of the corresponding User.
A confirming pop-up will display. Hit Delete to complete the operation.
Use case 7: See overview of center in Homepage
S1: In the left menu, choose Homepage. This page shows you all information including:
- 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
S2: You can use Filter button to view the tasks based on Agent Group, Agent Name.
S3: To quickly create tasks, click this “Plus” button
Use case 8: Create / Edit Agent Group
Option 1:
S1: Choose Resource in the left menu > click Agent Group tab then screen will show as below
S2: Click “Create New” button on the right corner of the screen
Option 2: In case, you just want to edit Agent Group information, click Edit in Action column
S3: 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.
| Column | Description |
| Name | Enter the name of the agent group you want to create/edit |
| Description | Enter the description of the agent group you want to create/edit |
| Agent | Select 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. |
Use case 9: Remove Agent Group
S1:
Option 1: To remove Agent Group, click Delete button of the agent group you want to remove from the Agent Group list.
Option 2: 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
S2: To confirm your action > Hit Delete in pop-up windows
Use case 10: Monitor Agent’s status
S1: Click Resource in the left menu, then choose Agent tab, you can see the details of agent
| Column/Label | Description |
| Agent Group | The Agent Group to which the Agent belongs. |
| Name | The name of the Agent. You can click the name of the Agent the view its details. |
| Machine name | The name of the machine the Agent is registered on. |
| Machine Username | The username used to log in to the Agent machine |
| Type | The type of Agent. This can be only Development, Assistant, Staging, Production. It is possible to filter the page according to the Agent type. |
| Status | The current status of the Agent: AVAILABLEb- 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. |
| Description | Description of the Agent |
| Version | The installed version of the akaBot Agent tool in the local machine |
| Created by | The user which created the Agent. |
Use case 11: View/ Create / Edit Agent
S1: To view Agent, You can view the details of the Agent by clicking the eye button.
S2: You can see a list of all agent’s tasks at the bottom of the Details page,
S3: To view the Agent’s logs from the Agent Details page, click the Log tab next to the Task tab to switch the view.
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.
S4: To create/ edit an Agent, click Create New button on the right corner
Or you could choose edit button of one Agent in the list. Alternatively, you can click the Edit button on the Detail Page of the Agent.
S5: 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.
Use case 12: Remove Agent
S1:
Option 1: you need to click the Delete button.
Option 2: Alternatively, you can select the checkbox before each Agent and the Delete button will show up next to the Create New button. Tick the Checkbox next to Action will allow users to select all displayed Agent for bulk delete.
S2: A pop-up window appears to take your confirmation.
If you want to delete Agent information in Agent Group, Tasks, Schedule, Queue, and Logs > tick the box Delete related items > hit Delete
Use case 13: Change agent’s password
Option 1:
S1: From Agent in the left menu, choose agent name that you want to change passwork, then click Edit
S2: When the pop-up form appears > fill new password in Machine password > click Save (for more information, click here)
Option 2:
S1: In Asset tab, choose Name of agent you want to change password, then click Edit button
S2: Fill in the tab:
Type: choose CREDENTIAL
- Click OK
Use case 14: Add/ Renew/ De-active license
- Add license
S1: In Administration> Choose License tab> Click Add License>Fill in the License Key field with the license key you received from the licensing email
2. Renew license
S1: In Administration> Choose License in the left menu
S2: Click Renew license> Then enter your license key to renew
3. De-active license
In Administration> Choose License> Click Deactivate license to deactivate license
Use case 15: Run / Stop Bot
- Run Bot Manually (create new task, Clone)
Option 1:
S1: Click Automation in the leftmenu > Click Task tab
S2: Choose workflow that needs to run manually, then save
Option 2: Alternatively, you can click Action in Action column next to the task > Then a dropdown list is shown up > choose Clone> Click Save
- Run Bot Schedule (set up schedule, disable schedule)
2.1. Create / Edit Schedule:
S1: In menu choose Automation then click Schedule tab>Click Create New
S2: Fill in the pop-up form
- Name (*): Name of the schedule
- Workflow (*): Select the workflow you want to create schedule
- Time Zone (*): Select the time zone you want the schedule will follow
Trigger tab: - Recurrence: Select the cycle for the schedule: Minutes/ Hourly/ Daily/ Weekly/ Monthly/ Advance
- Start Date (*): select the time at which the schedule will start and
- End Date: select the time at which the schedule will end
Execution Target tab: depends on the workflow you chose, tick the suitable agent
Parameters tab:
Holiday settings tab: single choice - Run continuously (default)
- Bypass holiday
- Postpone until the next workday
Note: (*) is required
If you choose Once
| Column label | Description |
| Start Date | Select the date at which the schedule will start |
| At | Select the specified time at which the schedule will start |
If you choose Minutes
| Column label | Description |
| Start Date | Select the date at which the schedule will start |
| End Date | Select the date at which the schedule will end |
| Every | Select the exact cycle for the schedule by minutes |
If you choose Hourly
| Column label | Description |
| Start Date | Select the date at which the schedule will start |
| End Date | Select the date at which the schedule will end |
| Every … Hours | Select the exact cycle for the schedule by hours |
If you choose Daily
| Column label | Description |
| Start Date | Select the date at which the schedule will start |
| End Date | Select the date at which the schedule will end |
| At | Select the specified time at which the schedule will start |
If you choose Weekly
| Column label | Description |
| Start Date | Select the date at which the schedule will start |
| End Date | Select the date at which the schedule will End |
| Everyday At | Select the specified time at which the schedule will start |
| Monday Tuesday Wednesday Thursday Friday Saturday Sunday | Select the exact cycle for the schedule by hours, minutes and days. |
If you choose Monthly
| Column label | Description |
| Start Date | Select the date at which the schedule will start |
| End Date | Select the date at which the schedule will end |
| At | Select the specified time at which the schedule will start |
| On | Select exact day in a month |
| Of | Choose exact month in a year |
If you chose Advance
| Column label | Description |
| Cron Expression | A 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. |
2.2. Start / Stop a schedule
B1: To Force Start/ Stop a Schedule, you can click the Action button and select the Start Now button or Stop button if the Schedule is running
2.3. Disable / Enable a schedule:
S1: To disable a schedule, click corresponding Action button and then select Disable.
S2: After clicking, the system will ask for your confirmation to switch status:
When the schedule is disabled, the status of said schedule changes to Disable.
S3: to enable a schedule, click the corresponding Action button and then select Enable.
2.4. Delete a schedule:
B1: To delete, you need to click The Action button of the corresponding Schedule and select the Delete button.
- Stop Bot
S1: To stop a running Bot, in Task tab > click Action in Action column next to the task > Then a dropdown list is shown up > choose Stop
S2: The System will show a message to get your confirmation. Hit Confirm to remove the task.
