Introduction

I. Purpose

akaBot Studio is one of 3 components of akaBot suite.

akaBot Studio is a solution for application integration, business processes automation. It provides a wide range of activities to model almost of the business processes within one organization – from simple to complex.

The tool pre-builds hundreds of activities to perform the actions of automations on web, on desktop, working with data base, generating the PDF files, sending emails…

This document aims to guide you how to use the akaBot Studio.

II. Audience

This document targets to the developers who will use the akaBot Studio to develop the automating business process.

image-20220506161325-1.png

akaBot Studio User Interface

akaBot Studio contains multiple panels which allows you to easily access to specific functionalities as below:

#PanelDescription
1FileDisplay the functionalities which you can use to operate on the file.
2HomeDisplay the functionalities which you can use to work on the automation projects.
3ActitvitiesShow all available activities which can be added to your automation projects. The activities are grouped into different categories such as: Excel, XML, ControlFlow, Primitives, Care, HTTP...
4DesignerDisplay you automation projects in a visual manner. It allows you to access, configure the variables, value inside the activities to make them do the automation actions.
5PropertiesDisplay the properties of current focused activities, enable you to change the value of properties and automatically save new value when focusing out.
6Workflow OutlineDisplay the project hierarchy of current project.
7Error ListDisplay the error list with error details while running the project.
8OutputDisplay the output of the project.
9DebugDisplay the variable values and other debugged information.

I. File Panel

To access the File panel, click File at the top left corner of the screen:
The User Interface of File panel is as below:

image-20220506161341-2.png

The File panel allows you to perform some below actions:

#TabDescription
1NewCreate a new workflow project.
Refer to section: 2.2.1 Create a new workflow project for detailed user guide.
2OpenOpen an existed workflow project.
Refer to section: 2.2.2 Open a project for detailed user guide.
3OptionsChange some configuration parameters related to: Debugging, References Directories.
Refer to section: 2.2.3 Change configuration options for detailed user guide.
4AboutView the version details of akaBot Studio
Refer to section: 2.2.4 View version details for detailed user guide.
5ExitClose akaBot Studio
Refer to section: 2.2.5 Close akaBot Studio for detailed user guide.

1. Create a new workflow project.

Each business process may be represented by an akaBot project which enables you to automate rule- based processes, by giving you full control of the execution order and the relationship between a set of predefined activities in akaBot Studio.

To create a new workflow project, you should follow below actions:
Step 1: Click ‘New’
Step 2: Choose type workflow: Blank or General Business Process

image-20220506161355-3.png

Step 3: Enter name project
Step 4: Click button ‘Create’ to finish.

image-20220506161409-4.png

After clicking, by default a sequence activity will be shown up in the Designer panel allowing you to start developing your project.

image-20220506161420-5.png

2. Open a Project

To open an existed workflow project, you can follow below actions:

Step 1: Click Open

image-20220506161431-6.png

Step 2: Choose file with format file is *.xaml
Step 3: Click button ‘Open’

image-20220506161441-7.png

3. Change configuration options

This window to support them setup: Debug mode, and add references Directories
Debug
Step 1: Click ‘Options’

image-20220506161453-8.png

Step 2: Press to up or down size milliseconds between debug ste Step 3: Press button ‘Ok’ to submit the change configuration / ‘Cancel’ to close this window
and cancel this process.

image-20220506161506-9.png

4. References Directories
Step 1: Click ‘Options’

image-20220506161542-11.png

Step 2: Choose tab ‘References Directories’
Step 3: Click button ‘Add’

image-20220506163530-12.png

Step 4: Click ‘Ok’ to choose a folder

image-20220506163624-13.png

Step 5: Press button ‘Ok’ to submit the change configuration / ‘Cancel’ to close this window and cancel this process.

image-20220506163635-14.png

4. View the version details

You can view the version of akaBot Studio by click in tab ‘About’:

image-20220506163647-15.png

About akaBot Studio screen will be previewed Product details as below:

image-20220506163706-16.png

5. Close akaBot Studio

When click Exit, akaBot Studio will be closed.

image-20220506163718-17.png

II. Home Panel

To access the Home panel, click Home at the top of the screen:

image-20220506163730-18.png

The Home panel allows you to perform some below actions: New, Save, Start, Debug, Stop, Open Logs, Publish, Add activity

image-20220506163802-19.png

#ItemDescriptionMore Details
1NewCreate new sequence, flowchart, State Machine2.2.1 New
2SaveSave project2.2.2 Save
3StartRun BOT2.2.3 Start
4DebugDebugging is the process of identifying and
removing errors from a given project
2.2.4 Debug
5StopStop BOT when it’s running2.2.5 Stop
6Open LogsOpen folder that have log file2.2.6 Open Logs
7PublishPublishing automation project2.2.7 Publish
8Add activityAdding a activity2.2.8 Add activity
9Show or hide toolsShow or hide the functions window2.2.9 Show or hide
tools

1. New

There are 3 main types of projects:

  • Flowcharts - suitable to a complex business logic which needs to integrate decisions and connect activities by using multiple branching logic operators.
  • Sequences - suitable to defined linear processes from one activity to another without cluttering your project.
  • State Machines – suitable for very large projects which have number of states triggered by a transition condition.

In this item, you can create new these three types
 

a. State machine diagram

  • Step 1: Choose New + State machine diagram

image-20220506163819-20.png

  • Step 2: Enter name diagram
  • Step 3: Click button ‘Create’

image-20220506163830-21.png

b. Flowchart

  • Step 1: Click 'new' > Flow Chart

image-20220506163843-22.png

  • Step 2: Enter name flowchart diagram
  • Step 3: Click button ‘Create’

image-20220506163854-23.png

c. Sequence

  • Step 1: Click 'new' > Sequence

image-20220506163903-24.png

  • Step 2: Enter name flowchart diagram
  • Step 3: Click button ‘Create’

image-20220506163912-25.png

2. Save

  • Step 1: Edit activity, control flow,… in project
  • Step 2: Click 'Save' > Save if only save changes or Click Save as if save with different *.xaml file.

image-20220506163922-26.png

  • Step 3: Enter name *.xaml file > click button Save

image-20220506163935-27.png

3. Start

Click button

image-20220506164345-28.png

to run BOT. Wait a few minutes for the BOT to finish and see result in Output Window
 

4. Debug
Click

image-20220506164355-29.png

to identify and remove errors from a given project. Coupled with logging, it becomes a powerful functionality that offers you information about your project and step-by-step highlighting, so that you can be sure it is error-free.
 

5. Stop
When starting or debugging the process, you can click

image-20220506164407-30.png

to stop this process.
 

6. Open Logs
Click

image-20220506164423-31.png

to open folder have log file - display details about what is happening in your project

7. Publish

  • To publish an automation project:
  • Step 1: Create / Open a new project.
  • Step 2: In the Home ribbon tab, click Publish. Theo Publish project window opens
  • Step 3: In the Publish Location category, set the project to be published to Orchestrator

8. Add Activity

  • To add activity
  • Step 1: In the akaBot Studio click File menu, chose Options.
  • Step 2: In the table Options, click References Directories tab, click Add button and chose directory containing the activity library (.dll Files) to load activities.
  • Step 3: In the akaBot Studio click Add Activities. , chose activities from the list and press Add.

9. Show or hide tools

  • Check or uncheck box to show or hide tool in screen of akaBot Studio.

image-20220506164436-32.png

III. Activities

This panel displays all the built-in activities which aid in the creation and the execution of automation projects. These activities enable robots:

  • Manipulate the data by adding/extracting/reading information.
  • Directly interaction with websites, windows applications…to simulate the human actions.

image-20220506164447-33.png

The activities are grouped in different categories such as: Flow chart, Control Flow, Primitives, Core, Excel, XML, Browser…
You may quickly add an activity into the project workflow by searching by activity name and drag the activity in the Designer panel.

Please refer to section III. akaBot Studio Activities for details of each activity.

IV. Designer

The Designer panel allows you to design your automation projects by designing the workflow, defining logic, creating variables/arguments or importing the namespaces.

image-20220506164458-34.png

You may design the workflow or defining business logic of the workflow by using activities in Activities panel then connect these activities by the arrow.
To connect activity A to activity B, you need to click to activity A, hold the mouse and drag to the activity B to create a link (represented by an arrow) between these 2 activities.

You may set what activities will be the starting point by connecting Start activity to selected one.
Depending on the activity, you may place an activity inside another activity such as: Parallel, If, Flowchart, Sequence…

1. Create a variable

To create a variable, follow below steps:

  • Step 1 - Click Variables tab.
  • Step 2 – Fill variable properties.

image-20220506164513-35.png

Variable Properties:

#PropertyDesrciption
1NameVariable name
2Variable TypeThe type of variable: String, Int32, Boolean…
3ScopeScope of variable defines where the variable works in.
4Default ValueDefault value of variable.

2. Create an argument

To create an argument, please follow below steps:

  • Step 1 – Click Arguments tab
  • Step 2 – Click Create Argument option.
    The new argument will be displayed with all default values. You may customize these values for the created argument.

image-20220506164526-36.png

3. Import a namespace

To import a namespace, please follow below steps:

  • Step 1 – Click Imports tab
  • Step 2 – Find the namespace you want to import
  • Step 3 – Double click the namespace to import.

image-20220506164536-37.png

V. Properties

This panel is contextual and enables you to view and change the properties of a selected activity.

  • Step 1: Double click an activity in Designer panel.
    Properties of that activity will be showed in Properties panel.

image-20220506164546-38.png

  • Step 2: Change the properties

VI. Workflow Outline

This panel display the hierarchy of the workflow listing all the used activities and their connection.

You can double click on an activity to quickly open it.

image-20220506164556-39.png

VI. Verify output, error, debug

1. Verify output

When run akaBot Studio, you can see result in each step.

  • Step 1: Click 'Start' to run akaBot Studio
  • Step 2: Click the “Output” button at bottom left to see.

image-20220506164607-40.png

2. Verify error

Click the “Error List” button at bottom left

image-20220506164616-41.png

3. View debugging information

  • Step 1: Choose “Debug” when running
  • Step 2: Check the debugging information in the Debug tab as below:

image-20220506164626-42.png

Akabot Studio Activities

I. Core actitivies

1. Message Box

The Message Box* activity allows you to display a message in e debug dialog box.
Property Column:**

image-20220506164638-43.png

#PropertyDescription
1ButtonsThe buttons to be included in the message box that appears.
2CaptionThe text to be displayed as the title of the message box. It is a string, so it
has to be encased in quotation marks. E.g. “Title”.
3TextThe text to be displayed in the message box. It is a string, so it has to be
encased in quotation marks. E.g. “Hello World”.
4Display NameThe name of this activity. You can edit the name of the activity to organize
and structure your code better.
5Top MostThis property allows you to choose whether to focus on the message box
when it appears. By default, it is set to True.
6Chosen ButtonThis returns the string of the button selected by the user.

2. Path Exists

The Path Exists activity checks whether a exists or not

image-20220506164648-44.png

Property Column

#PropertyDescription
1PathThe full path to be checked.
2Path TypeSpecifies if the destination is a file or a folder.
3Display NameThe name of this activity. You can edit the name of the activity to organize
and structure your code better.
4ExistsStates whether the path is found. It only supports Boolean variables.

3. Select File

image-20220506165024-45.png

The Select File activity lets the user select a file. The full path of the file will then be returned as a string variable.
Properties Column:

#PropertyDescription
1FilterAllows the developer to filter the types of file that the user can select.
2Display NameThe name of this activity. You can edit the name of the activity to organize
and structure your code better.
3Selected FileThe full path of the selected file.

4. Select Folder

image-20220506165035-46.png

The Select Folder activity allows the user to select a folder. The full path of the folder will then be returned as a string variable.
Property Column

#PropertyDescription
1Display NameThe name of this activity. You can edit the name of the activity to organize
and structure your code better.
2Selected FolderThe full path of the selected folder.

5. Comment

The Comment activity allows the developer to insert comments or notes into the coding of the program.
Properties Column:

image-20220506165046-47.png

#PropertyDescription
1Display NameThe name of this activity. You can edit the name of the activity to organize
and structure your code better.
2TextComments to be shown in the Comment activity.

6. Comment Out

The Comment Out activity allows the developer to ignore, effectively skipping, any activities that are placed inside the Comment Out activity.

image-20220506165057-48.png

Properties Column:

#PropertyDescription
1Display NameThe name of this activity. You can edit the name of the activity to organize
and structure your code better.

7. Append Line

The Append Line activity enables you to append a line of text to a file

image-20220506165108-49.png

Properties Column:

#PropertyDescription
1EncodingThe encoding type to be used by this activity. If the field is left blank, the
activity will search for the file's Byte Order Marks to decide the type of encoding to be used. If no Byte Order Marks are detected, the system ANSI code page will be selected. It is a string, so it has to be encased in quotation marks.
2File NameThe full path or relative path from the Main.xaml to the selected file.
3TextThe text to be appended into the file. It is a string, so it has to be encased
in quotation marks. E.g. “Append this line”.
4Display NameThe name of this activity. You can edit the name of the activity to organize
and structure your code better.

8. Read Text File

The Read Text File activity allows you to extract the texts inside a text file and store it in a string variable.

image-20220506165118-50.png

Properties Column:

#PropertyDescription
1EnCodingThe encoding type to be used by this activity. If the field is left blank, the
activity will search for the file's Byte Order Marks to decide the type of encoding to be used. If no Byte Order Marks are detected, the system ANSI code page will be selected. It is a string, so it has to be encased in quotation marks.
2File NameThe full path or relative path from the Main.xaml to the selected file.
3Display NameThe name of this activity. You can edit the name of the activity to organize
and structure your code better.
4ContentThe string of text that is returned from the activity.

9. Write Text File

The Write Text File activity allows you to overwrite a text file. If the destination path does not exist, it will be created by this activity.

image-20220506165132-51.png

Properties Column:

#PropertyDescription
1EnCodingThe encoding type to be used by this activity. If the field is left blank, the
activity will search for the file's Byte Order Marks to decide the type of encoding to be used. If no Byte Order Marks are detected, the system ANSI code page will be selected. It is a string, so it has to be encased in quotation marks.
2File NameThe full path or relative path from the Main.xaml to the selected file.
3TextThe comments you want to assign into this activity.
4Display NameThe name of this activity. You can edit the name of the activity to organize
and structure your code better.

10. Copy File

The Copy File activity allows you to copy a file from one locale to another.

image-20220506165142-52.png

Property Comlumn:

#PropertyDescription
1Continue On ErrorThis is a Boolean variable and it is used to allow the rest of the process to
continue execution if there is an error with this activity. If it is set to True, the program will continue execution even if an error is encountered. By default, it is set to False.
2PathThe full path or relative path from the Main.xaml to the selected file.
3Display NameThe name of this activity. You can edit the name of the activity to organize
and structure your code better.
4OverwriteA Boolean variable that decides whether you want to overwrite a file with
the same name in the destination path. By default, it is set to False and will not overwrite the file in the destination path.
5DestinationThe full path, or relative path from the Main.xaml to the desired destination
for the file to be copied to.

11. Move File

The Move File activity allows you to move a file from one locale to another.

image-20220506165153-53.png

Properties Column:

#PropertyDescription
1Continue On ErrorThis is a Boolean variable and it is used to allow the rest of the process to
continue execution if there is an error with this activity. If it is set to True, the program will continue execution even if an error is encountered. By default, it is set to False.
2PathThe full path or relative path from the Main.xaml to the selected file.
3Display NameThe name of this activity. You can edit the name of the activity to organize
and structure your code better.
4OverwriteA Boolean variable that decides whether you want to overwrite a file with
the same name in the destination path. By default, it is set to False and will not overwrite the file in the destination path.
5DestinationThe full path, or relative path from the Main.xaml to the desired destination
for the file to be copied to.

12. Get Files

The Get Files activity allows you to retrieve the data of multiple files.

image-20220506165550-54.png

Properties Column:

#PropertyDescription
1Create Time (From)This property lets you choose to filter the earliest creation date and time of
the files to be selected.
2Create Time (To)This property lets you choose to filter the latest creation date and time of
the files to be selected.
3DirectoryThe full path of the directory to obtain the files from.
4FilterAllows the developer to filter the types of file that the user can select.
5Search OptionTop Directory Only – Sets the search option to only select the best
matching directory searched for in (4).

All Directories – Sets the search option to select all the directories that matches the directory searched for in (4).
6Display NameThe name of this activity. You can edit the name of the activity to organize
and structure your code better.
7FilesThis property returns all the data of the files that the Get Files activity
obtains. This property only supports FileData[] (Array of FileData) type.

13. Create Directory

The Create Directory activity allows you to create a new directory.

image-20220506165601-55.png

Properties Column:

#PropertyDescription
1Continue On ErrorThis is a Boolean variable and it is used to allow the rest of the process to
continue execution if there is an error with this activity. If it is set to True, the program will continue execution even if an error is encountered. By default, it is set to False.
2PathThe full path or relative path from the Main.xaml to the selected file.
3Display NameThe name of this activity. You can edit the name of the activity to organize
and structure your code better.

II. Window actitivies

1. Open Window

Open Window is a container that opens an application that allows numerous of activities to be written in the Do section.

image-20220506165623-56.png

A pathway to the application must be written in the file path in order for this activity to open the application.

image-20220506165634-57.png

Open Window Properties:

#PropertyDescription
1Continue On ErrorThis property only accepts Boolean values, true or false. By default, it is
already false. If this option has been changed to true and the program has an error in between the multiple activities, the program would continue running otherwise it would stop.
2Timeout MSDefault timeout for all activities within the scope.
3File NameThe full path to your file.
4Display NameThe name on top of the activity.
5ArgumentsThe parameters that can be passed to the application at startup.
6Automation BaseSpecify the version of Automation library. This option goes together with Process argument.
7Working DirectoryThe path to the working directory, only accept in strings.
8Output WindowOutput of type WindowApp. Output variable can be used in another Window Scope or Use Window property of other Window Activities.

2. Window Scope

Window scope is a container that allows you to attach it to an already opened window. It allows you to do numerous of activities alongside with the Open Window.

image-20220506165658-58.png

image-20220506165711-59.png

Window Scope Properties:

#PropertyDescription
1Continue On ErrorThis property only accepts Boolean values, true or false. By default, it
is already false. If this option has been changed to true and the program has an error in between the multiple activities, the program would continue running otherwise it would stop.
2Timeout MSDefault timeout for all activities within the scope.
3ProcessInput Process for the Window Scope to attach.
4Window (Input)Input WindowApp for the Window Scope to attach.
5Display NameThe name on top of the activity.
6Automation BaseSpecify the version of Automation library. This option goes together with Process argument (UIA2 or UIA3).
7Output Window AppOutput of type WindowApp. Output variable can be used in another Window Scope or Use Window property of other Window Activities.

Note: If this is placed in a try and catch and the Continue On Error is true, the try and catch would not produce any errors even if the program has errors.

3. Click
Allows you to click a specific interface in your program, eg: a button, textboxes etc

image-20220506170406-60.png

image-20220506170426-61.png

Click Properties:

1Continue On ErrorThis property only accepts Boolean values, true or false. By default, it
is already false. If this option has been changed to true and the program has an error in between the multiple activities, the program would continue running otherwise it would stop.
2Click Type4 options are available, a normal left click, right click, double left
clicks and double right clicks. By default, it is a left click.
3ElementInput of type AutomationElement. If this field is provided, operations would be executed on the input Element.
4From Desktop RootSpecifies whether the automation element is searched for from the Desktop Root Element.
5Get Top Level WindowsSpecifies whether all windows with same level of the root would be searched.
6Timeout MSTimeout for activity to find the search for the element before throwing an exception.
7Use WindowSpecifies the scope of the activity to search for the element.
8Display NameThe name on top of the activity.
9Key ModifierAllows you to add a key modifier, there are 4 key modifiers.
Alt, Ctrl, Shift and Win.
10SelectorString variable to specify which element to find. Selector can be generated using “Pick Target Element” button on the Activity Designer.

Note: If this is placed in a try and catch and the Continue On Error is true, the try and catch would not produce any errors even if the program has errors.

4. Type Into
Type Into sends keystrokes to a editable field, special keys can also be used in the dropdown box.

image-20220506170447-62.png

image-20220506170457-63.png

#PropertyDescription
1ClickSpecifies whether target field would be clicked before typing.
2Double ClickSpecifies whether target field would be double clicked before typing.
3Empty FieldSpecifies whether target field would be cleared before typing.
4Set FocusSpecifies whether Target Field would be focused before typing.
5Continue On ErrorThis property only accepts Boolean values, true or false. By default, it is already false. If this option has been changed to true and the program has an error in between the multiple activities, the program would continue running otherwise it would stop.
6ElementInput of type AutomationElement. If this field is provided, operations would be executed on the input Element.
7From Desktop RootSpecifies whether the automation element is searched for from the Desktop Root Element.
8TextThe text you want to write in the target field.
9Timeout MSTimeout for activity to find the search for the element before throwing an exception.
10Use WindowSpecifies the scope of the activity to search for the element.
11Display NameThe name on top of the activity.
12Get Top Level WindowsSpecifies whether all windows with same level of the root would be searched.
13SelectorString variable to specify which element to find. Selector can be generated using “Pick Target Element” button on the Activity Designer.

Note: If this is placed in a try and catch and the Continue On Error is true, the try and catch would not produce any errors even if the program has errors. Strings must be placed in between quotation marks.

5. Send Hot Key

Send Hot Key triggers keyboard shortcuts.

image-20220506170515-64.png

If you click on any of the key property, the robot would act accordingly to it.

image-20220506170523-65.png

Send Hot Key Properties:

#PropertyDescription
1Display NameThe name on top of the activity.
2ElementChoose the element you want to send a hot key to.
3KeyHot Key to send to the input element. If no
element is provided, keys would be sent to current cursor position.
4Alt/Ctrl/Shift/WinKey Modifier to use additionally.

III. System activities

1. While

The While activity allows you to execute a specific process repeatedly, while a specific condition is met. In the While activity, the condition is reviewed before the sequences in the loop is executed.
Properties Column:

image-20220506170535-66.png

#PropertyDescription
1ConditionThe condition to be met in order for the loop to repeat.
It can be any expression, however the final value of the expression must be of Boolean type. E.g. x > 5 which can either be True or False.
2Display NameThe name of this activity. You can edit the name of the activity to organize
and structure your code better.

2. Do While

The Do While activity allows you to execute a specific process repeatedly while a condition is met. When the specified condition is no longer being met, the program exits the loop. In the Do While activity, the sequences in the loop is executed before the condition is reviewed.

image-20220506170545-67.png

Properties Column:

#PropertyDescription
1ConditionThe condition to be met in order for the loop to repeat.
It can be any expression, however the final value of the expression must be of Boolean type. E.g. x > 5 which can either be True or False.
2Display NameThe name of this activity. You can edit the name of the activity to organize
and structure your code better.

3. For Each

The For Each activity allows you to step through arrays, lists, data tables, dictionaries or other types of collections, so that you can skim through the data and process each piece of information individually.

image-20220506170556-68.png

Properties Column:

#PropertyDescription
1Display NameThe name of this activity. You can edit the name of the activity to organize
and structure your code better.
2Type ArgumentType of the item inside the collection.
3ValuesData collection input.

4. Sequence

The Sequence activity allows you to transition from one activity to another easily. It executes the activities inside the sequence in a linear fashion and the sequence can also be easily manipulated to chain multiple sequences together.

image-20220506170607-69.png

Properties Column:

#PropertyDescription
1Display NameThe name of this activity. You can edit the name of the activity to organize
and structure your code better.

5. Flowchart

image-20220506170616-70.png

Flowcharts can be used in a variety of situations and is much more versatile than a sequence. The most prominent feature of flowcharts is that they present multiple branching logical operators that enable you to create complex business processes and connect activities in a multitude of ways that a sequence just can’t do.
Properties Column:

#PropertyDescription
1Display NameThe name of this activity. You can edit the name of the activity
to organize and structure your code better.
2Validate Unconnected NodesThis is a Boolean variable. If it is set to True, it will check for errors
in all the sequences and activities, even those not connected to  the start node. If set to False, it will only check for errors in all the  sequences and activities connected to the start node. By  default, it is set to False.

6. If

The If activity is used to make decisions. It the condition is met, “Then” would be executed while “Else” would be ignored. However, if the condition is not met, “Else” would be executed while “Then” is ignored.

image-20220506170626-71.png

Properties Column:

#PropertyDescription
1ConditionThe condition to be met for the program to proceed to the “Then” route. If this condition is not met, the program will execute the “Else” route. It can  be any expression. However, the final value of the expression must be of  Boolean type. E.g. x > 6 which can be True or False.
2Display NameThe name of this activity. You can edit the name of the activity to organize and structure your code better.

7. Switch

The Switch activity enables you to select one route for the process to execute, out of multiple possible routes, based on the value of a specified expression.

image-20220506170635-72.png

Properties Column:

#PropertyDescription
1Display NameThe name of this activity. You can edit the name of the activity to organize and structure your code better.
2ExpressionThe argument expression to be evaluated.
3Type ArgumentType of the value to be evaluted by the Switch Activity.

8. Assign

The Assign activity is a vital activity that allows you to assign a value to a variable.

image-20220506170644-73.png

Properties Column:

#PropertyDescription
1Display NameThe name of this activity. You can edit the name of the activity to organize
and structure your code better.
2ToThe variable to assign a value to.
3ValueThe value to be assigned to the variable listed in To

9. Invoke Workflow File

The Invoke Workflow File activity is used to invoke a workflow file with an XAML extension. Arguments can be passed in or out the workflow using the “Import Arguments” tab.

image-20220506170656-74.png

image-20220506170708-75.png

Properties Column:

#PropertyDescription
1Continue On ErrorThis is a Boolean variable and it is used to allow the rest of the process to continue execution if there is an error with this activity. If it is set to True, the program will continue execution even if an error is encountered. By default, it is set to False.
2ArgumentsTo access the arguments, click on the “Edit Arguments” or “Import
Arguments” button on the activity.
3Workflow File NameThe destination of the Workflow File to be invoked. You can use absolute path or relative path.
4Display NameThe name of this activity. You can edit the name of the activity to
organize and structure your code better.

10. Delay

The Delay activity enables you to pause the automation for a custom period of time. This is useful in getting certain timing-based automation right.
Properties Column:

image-20220506170730-76.png

#PropertyDescription
1Display NameThe name of this activity. You can edit the name of the activity to organize and structure your code better.
2DurationThe amount of time to pause the automation for. It uses a hh:mm:ss format.

IV. Browser activities

1. Open Browser

image-20220506170836-77.png

The Open Browser activity allows you to navigate to a specific Url by launching a specified browser.
Properties Column:

#PropertyDescription
1Continue On ErrorThis is a Boolean variable and it is used to allow the rest of the process to continue execution if there is an error with this activity. If it is set to True, the program will continue execution even if an error is encountered. By default, it is set to False.
2Browser TypeThe choice of browser for this activity to use. There are four choices: Chrome, Firefox, IE, Other.
3Timeout MSTimeout for the page to load. If the timeout has expired, the page would not be loaded further.
4UrlStarting URL when the browser is opened.
51.HttpProxyIP address of the site you’re trying to access. It is a string, so it has to be encased in quotation marks. E.g. “127.0.0.0”
62.UserNameUsername of the user account used to access the proxy. It is a string, so it has to be encased in quotation marks.
73.PasswordPassword of the user account used to access the proxy. It is a string, so it has to be encased in quotation marks.
8Display NameThe name of this activity. You can edit the name of the activity to
organize and structure your code better.
9Maximizehis is a Boolean variable and it is used to maximize the browser window when the browser first starts up. If it is set to True, the browser window will be maximized. By default, it is set to False.
10Output BrowserOutput type of Browser that is wrapper for the Web Driver of the Scope.
11Ensure Clean SessionSpecifies whether the session would be cleaned before opening browser. Default Value is false.
12Hide Command Prompt WindowHide Command Prompt window of the Web Driver. Default value is true.
13Quit Browser on Completed or FaultedSpecifies whether the browser is closed when execution is finished or faulted. Default value is true.

2. Browser Scope

The Browser Scope activity creates a container that lets you to attach to an already opened Browser
and execute actions within the Browser.

image-20220506170850-78.png

Properties Column:

#PropertyDescription
1Continue On ErrorThis is a Boolean variable and it is used to allow the rest of the process to continue execution if there is an error with this activity. If it is set to True, the program will continue execution even if an error is encountered. By default, it is set to False.
2BrowserInput of type Browser. The input can be gotten from the output of the Open Browser activity.
3Timeout MSTimeout for the page to load. If the timeout has expired, the page would not be loaded further.
4Display NameThe name of this activity. You can edit the name of the activity to
organize and structure your code better.
5Output BrowserOutput type of Browser that is wrapper for the Web Driver of the Scope.
6Browser TypeThe choice of browser for this activity to use. There are four choices: Chrome, Firefox, IE, Other.
7Quit Browser on Completed or FaultedSpecifies whether the browser would close when execution is completed or faulted. Default value is true.

3. Navigate To

The Navigate To activity allows you to navigate to another website on the current tab.

image-20220506170905-79.png

Properties Column:

#PropertyDescription
1Continue On ErrorThis is a Boolean variable and it is used to allow the rest of the process to continue execution if there is an error with this activity. If it is set to True, the program will continue execution even if an error is encountered. By default, it is set to False.
2UrlURL of the website that you want to navigate to. It is a string, so it has to be encased in quotation marks.
3Display NameThe name of this activity. You can edit the name of the activity to
organize and structure your code better.

4. Switch To

The Switch To activity allows you to switch between different UI Elements within a browser.

image-20220506170916-80.png

#PropertyDescription
1Continue On ErrorThis is a Boolean variable and it is used to allow the rest of the process to continue execution if there is an error with this activity. If it is set to True, the program will continue execution even if an error is encountered. By default, it is set to False.
2Switch To TypeType of HTML element to switch to
FRAME – An iframe. DEFAULT_CONTENT – Main webpage.
PARENT_FRAME – To be used if there is a nested iframe. WINDOW – To switch between tabs.
3Switch To ValueFRAME – Id or name attribute of the iframe tag.
DEFAULT_CONTENT – Text must be quoted.
PARENT_FRAME – Id or name attribute of the parent iframe tag. WINDOW – Text must be quoted.
4Display NameThe name of this activity. You can edit the name of the activity to
organize and structure your code better.
5Timeout MSTimeout for the Web Driver to try finding the element to switch to.

5. Click

The Click activity is used to send a click action into the webpage.

image-20220506170928-81.png

Properties Column:

#PropertyDescription
1Continue On ErrorThis is a Boolean variable and it is used to allow the rest of the process to continue execution if there is an error with this activity. If it is set to True, the program will continue execution even if an error is encountered. By default, it is set to False.
2Timeout MSThe amount of time, in milliseconds, to wait for the activity to run before an exception is thrown.
3Click TypeCLICK_SINGLE – A single click.
CLICK_DOUBLE – Two clicks in quick succession.
CLICK_DOWN – A click where you hold down the mouse button. CLICK_UP – A click where you release the mouse button.
4Mouse ButtonChooses between Left or Right click.
MOUSE_LEFT will set the action to click using the left mouse button while MOUSE_RIGHT will set the action to click using the right mouse button.
5SelectorString variable to specify which element to find. Selector can be generated using “Pick Target Element” button on the Activity Designer.
6Wait VisibleThis is a Boolean variable. When set to True, the automation will wait for the target to be visible before executing the activity. By default, it is set it False.
7Display NameThe name of this activity. You can edit the name of the activity to
organize and structure your code better.

6. Type Into

The Type Into activity allows you to type texts into any text field within the webpage.

image-20220506170939-82.png

Properties Column:

#PropertyDescription
1Continue On ErrorThis is a Boolean variable and it is used to allow the rest of the process to continue execution if there is an error with this activity. If it is set to True, the program will continue execution even if an error is encountered. By default, it is set to False.
2Timeout MSThe amount of time, in milliseconds, to wait for the activity to run before an exception is thrown.
3SelectorString variable to specify which element to find. Selector can be generated using “Pick Target Element” button on the Activity Designer.
4TextThe text to type into. It is a string, so it has to be encased in quotation
marks. E.g. “I am very happy today!”
5Wait VisibleThis is a Boolean variable. When set to True, the automation will wait for the target to be visible before executing the activity. By default, it is set it False.
6Display NameThe name of this activity. You can edit the name of the activity to
organize and structure your code better.

7. Wait Element Exist

The Wait Element Exist activity waits for a selected element to appear in the webpage.

image-20220506170951-83.png

Properties Column:

#PropertyDescription
1Continue On ErrorThis is a Boolean variable and it is used to allow the rest of the process to continue execution if there is an error with this activity. If it is set to True, the program will continue execution even if an error is encountered. By default, it is set to False.
2Timeout MSThe amount of time, in milliseconds, to wait for the activity to run before an exception is thrown.
3SelectorString variable to specify which element to find. Selector can be generated using “Pick Target Element” button on the Activity Designer.
4Wait VisibleThis is a Boolean variable. When set to True, the automation will wait for the target to be visible before executing the activity. By default, it is set it False.
5Display NameThe name of this activity. You can edit the name of the activity to
organize and structure your code better.
6Found ElementThis will return a Boolean variable. When the target elements vanishes

8. Wait Element Vanish

The Wait Element Vanish activity waits for a selected element to disappear from the webpage.

image-20220506171007-84.png

Properties Column:

#PropertyDescription
1Continue On ErrorThis is a Boolean variable and it is used to allow the rest of the process to continue execution if there is an error with this activity. If it is set to True, the program will continue execution even if an error is encountered. By default, it is set to False.
2Timeout MSThe amount of time, in milliseconds, to wait for the activity to run before an exception is thrown.
3SelectorString variable to specify which element to find. Selector can be generated using “Pick Target Element” button on the Activity Designer.
4Display NameThe name of this activity. You can edit the name of the activity to
organize and structure your code better.
5VanishedThis will return a Boolean variable. When the target elements vanishes
before the timeout, it will return True. However, when the target element does not vanish before the timeout, it will return False.

9. Get Web Attribute

The Get Web Attribute activity allows you to get the value of an attribute that belongs to a UI element

image-20220506171017-85.png

Properties Column:

#PropertyDescription
1Continue On ErrorThis is a Boolean variable and it is used to allow the rest of the process to continue execution if there is an error with this activity. If it is set to True, the program will continue execution even if an error is encountered. By default, it is set to False.
2Timeout MSThe amount of time, in milliseconds, to wait for the activity to run before an exception is thrown.
3Attribute NameThe expression of the attribute to be selected from. It is a string, so it has to be encased in quotation marks. E.g. “//*[@id=’main’]/div[3]”
4Wait VisibleThis is a Boolean variable. When set to True, the automation will wait for the target to be visible before executing the activity. By default, it is set it False.
5SelectorString variable to specify which element to find. Selector can be generated using “Pick Target Element” button on the Activity Designer.
6Display NameThe name of this activity. You can edit the name of the activity to
organize and structure your code better.
7Output ValueThe web attribute that will be outputted.

10. Select Item

The Select Item activity allows you to select an item from a combo box or list box.

image-20220506171027-86.png

Properties Column:

#PropertyDescription
1Continue On ErrorThis is a Boolean variable and it is used to allow the rest of the process to continue execution if there is an error with this activity. If it is set to True, the program will continue execution even if an error is encountered. By default, it is set to False.
2Timeout MSThe amount of time, in milliseconds, to wait for the activity to run before an exception is thrown.
3Select TypeSelec Type (By Index, Value or Text).
4Select ValueThe value, based on the type of selection you want to use. It is a string, so
it has to be encased in quotation marks.
5SelectorString variable to specify which element to find. Selector can be generated using “Pick Target Element” button on the Activity Designer.
6Wait VisibleThis is a Boolean variable. When set to True, the automation will wait for the target to be visible before executing the activity. By default, it is set it False.

V. Excel activities

1. Build Data Table

This activity allows you to create a data table according to a specific schema in a visual manner.

image-20220506171038-87.png

You may customize the data table to be created by clicking DataTable button. After clicking, the Build Data Table windows is opened as below:

image-20220506171046-88.png

There are two columns and two rows by default. The default column titles and variable types cannot be edited. Instead, the columns may be removed and then replaced by new ones.
To add a column into your table, click + icon. A pop up window is displayed to customize the properties as below:

image-20220506171055-89.png

Column Properties:

#PropertyDescription
1Column NameThe title of the column. Only strings are allowed.
2Data TypeThe type of values that the new column is going to accept.
There are many types of values such as: Boolean, String, Int32, Object, Array of [T] or a .Net type.
3Allow NullIf selected, null values can be added to the rows of this column.
4Auto IncrementOnly available if Data Type = Int32.
If selected, the value of this column will be automatically incremented by 1 when a new row is added.
5Default ValueDefault value when a new row is added.
6UniqueIf selected, all the rows in this column need to have unique values
7Max LengthBy default, -1 means that you do not set the max length for value of column.
Otherwise, the number of accepted characters will be value of this property.

Click OK button at New Column window to attach the column into table.
To remove a column, click x icon beside the column name. To remove a row, click x icon at the beginning of the row.

Click OK button to save the new data table or abort it by clicking Cancel button.

2. Read Range

Read Range reads the value of an Excel range and stores it in a DataTable variable. Read Range can only be used in an Excel Application Scope activity. If a range is not specified, the whole excel sheet would be read. However, if a cell number is specified it would read from the cell number to the rest of the sheet. Otherwise, a range is specified as per example given below, it would read from the specific range.

image-20220506171107-90.png

A workbook path means the excel file has to be inserted in this activity. The sheet you want the read range to read has to be specified as per in your excel file.

image-20220506171114-91.png

Read Range Properties:

#PropertyDescription
1RangeThe numbers of rows or cells to be specified in order to be read.
2Sheet NameThe sheet name you want the Read Range to read.
3Workbook PathThe path to the Excel file.
4Display NameDisplay name on top of the activity.
5Add HeadersIf this button is checked, the Read Range activity will include the headers to be read.
6Data TableOutput into a DataTable variable.

Note: Strings must be placed in between quotation for Range, Sheet Name and Workbook Path.

3. Write Range

Write Range writes value into an excel sheet by using a DataTable variable. It has to be in an excel application scope.

image-20220506171124-92.png

If the starting cell is not specified, it would write starting from the A1 cell and would be overwritten if there were some previous texts. If the sheet name is not specified, the activity would be create a new spreadsheet with the sheet name as mentioned.

image-20220506171131-93.png

Write Range Properties:

#PropertyDescription
1Data TableThe data table you want to write into.
2Sheet NameThe sheet name you choose to be written or create a new one.
3Starting CellThe range you choose to write into.
4Display NameDisplay name on top of the activity.
5Add HeadersIf this button is checked, the Write Range activity will include the headers to be written.

Note: Strings must be placed in between quotation for Sheet Name and Starting Cell.
###3.5.4 Append Range
Append Range Activity Add the input data after the last line of the excel file.

image-20220506171200-94.png

image-20220506171212-95.png

Append Range Properties

#PropertyDescription
1Data TableThe data table you want to append to.
2Sheet NameThe sheet name you choose to append or create a new one.
3Display NameDisplay name on top of the activity.

Note: Strings must be placed in between quotation mark for the Sheet Name.

5. Output Data Table
Output Data Table writes a data table to a string into a csv scheme.

image-20220506171232-96.png

Output Data Table Properties:

#PropertyDescription
1Data TableThe data table you want to convert to a string. [DataTable] variable]
2Display NameDisplay name on top of the activity.
3Output TextWrite your DataTable variable here as it is already converted into a
string.

6. Add Data Row

Add Data Row adds another row to a Data Table.

image-20220506171347-97.png

If you use an Array Row then the Data Row can be ignored, vice versa.

image-20220506171358-98.png

Add Data Row Properties:

#PropertyDescription
1Array RowAn array of [T] to be added into the row that matches the corresponding columns.
2Data RowThe DataRow object to be added in the row.
3Data TableThe data table you want to add rows to.

7. For Each Row

For Each Row Activity performs an action for each row in a specified DataTable variable.

image-20220506171413-99.png

image-20220506171421-100.png

For Each Row Properties:

#PropertyDescription
1Data TableThe data table you want to perform an action on each row.
2Display NameDisplay name on top of the activity.

8. Get Row Item

Get Row Items gets a value from a DataRow variable from a specified column.

image-20220506171448-101.png

If the Column Name is set, the Column Index can be ignored. If the Column is set, the Column Name
and Column Index can be ignored.

image-20220506171456-102.png

Get Row Item Properties:

#PropertyDescription
1ColumnThe data column for the object to be set to retrieve the row.
2Column IndexColumn Index of Row Item.
3Column NameColumn Name of the Row Item.
4RowInput Data Row to get Row Item from.
5Display NameThe name on top of the activity.
6ValueValue of the row item to be retrieved.

VI. Word activities

1. Word Application Scope

Word Application Scope opens up a word document or creates a new document if there is no document found. It also acts as a scope for other word activities. If the word activity ends, so does the document and word application.

image-20220506171507-103.png

This activity only works if Microsoft Word is installed on your computer.

image-20220506171517-104.png

Word Application Scope Properties:

#PropertyDescription
1File PathFull path to the document or if the word file is in a folder, a relative path can be used. [String variables and Strings are supported]
2Display NameThe name on top of the activity.

Note: All strings has to be placed in between quotation marks.

2. Read Text
Read Text reads off a text from a word document and stores it in a string variable. It can only be used in a Word Application Scope activity.

image-20220506171547-105.png

image-20220506171553-106.png

Read Text Properties:

#PropertyDescription
1Display NameThe name on top of the activity.
2TextThe text extracted from the word document. [String variable]

3. Append Text

Append Text adds text at the end of the word document. It can only be used in a Word Application Scope activity.

image-20220506171608-107.png

image-20220506171617-108.png

#PropertyDescription
1NewLineBeforeIf this is false, the sentence will continue from the last sentence of your word document. Else, it would have a new line from the last sentence write it below.
2TextThe text you want to input at the end of the word document.
3Display NameThe name on top of the activity.

Note: Strings must be placed between in quotation marks.

4. Replace Text

Replace Text activity replaces a string in the word document with another string. It can only be used in a word application scope activity.

image-20220506171632-109.png

image-20220506171638-110.png

Replace Text Properties:

#PropertyDescription
1ReplaceThe string you want to replace with.
2SearchThe string you are searching to get replaced.
3Display NameThe name on top of the activity.
4FoundA Boolean to show whether the text was found or not.

Note: All strings must be placed in between quotation marks.

5. Add Image

Activity used to add images from your computer to insert in the word document. It can only be used in word application scope activity.

image-20220506171655-111.png

image-20220506171701-112.png

Get Images Properties:

#PropertyDescription
1OutputFolderThe folder path where you want to retrieve your images.
2Display NameThe name on top of the activity.
3ImagesFile NameThe output variable of the image you have gotten. It should be in List

Note: All strings must be placed in between quotation marks.

6. Export to PDF

Export To PDF converts a word document into a PDF document. It can only be used in a word application scope activity.

image-20220506171718-113.png

image-20220506171725-114.png

Export To PDF Properties:

#PropertyDescription
1File PathThe file path to the PDF document you want to save in.
2PasswordIf you want to add a password to your PDF file to create a safer place. You could do it with this option.
3Display NameThe name on top of the activity.

Note: All strings must be placed in between quotation marks.

VII. Email activities

1. Send Mail

Send Mail sends email messages using the SMTP protocol.

image-20220506171739-115.png

image-20220506171745-116.png

Send Mail Properties:

#PropertyDescription
1AttachmentsIf you want to add attachments to the email along with a message.
2Timeout MSThis property means accepts only milliseconds, therefore if a number is put in. This property would wait for the amount of seconds before throwing an error.
3BodyWhat you want to write in the body of the email.
4SubjectSubject name
5Mail MessageThe message that is to be forwarded.
6PortThe port that the email message is sent through
7ServerThe email server that is to be used
8EmailThe email used to send the message.
9PasswordThe password to the email to log in.
10Display NameThe name on the top of the activity.
11Is Body HtmlIf this checkbox is checked, the email will be formatted into a HTML style.
12Secure ConnectionSpecifies the SSL and/or TLS encryption to use for the connection.
13BCCThe hidden recipients of the email message
14CCThe secondary recipients of the email message.
15ToThe main recipients of the email message.
16FromEmail address of the sender
17NameThe name of the sender.

Note: All strings must be placed in between quotation marks.

2. Send Outlook Mail

Send Outlook Mail sends an email from Outlook itself.

image-20220506171801-117.png

image-20220506171834-118.png

Send Outlook Mail Properties:

#PropertyDescription
1AttachmentsIf you want to add attachments to the email along with a message.
2Timeout MSThis property means accepts only milliseconds, therefore if a number is put in.
This property would wait for the amount of seconds before throwing an error.
3BodyWhat you want to write in the body of the email.
4SubjectSubject name
5Mail MessageThe message that is to be forwarded.
6AccountThe account you want to use to send the message.
7Display NameThe name on the top of the activity.
8Is Body HtmlIf this checkbox is checked, the email will be formatted into a HTML style.
9Is DraftIf this checkbox is checked, the email will be saved as draft too.
10BCCThe hidden recipients of the email message
11CCThe secondary recipients of the email message.
12ToThe main recipients of the email message.

Note: All strings must be placed in between quotation marks.

3. Get Outlook Mail Messages

Get outlook mail messages allows you to fetch messages from outlook.

image-20220506172003-119.png

image-20220506172009-120.png

Get Outlook Mail Messages Properties:

#PropertyDescription
1Timeout MSThis property means accepts only milliseconds, therefore if a number is put in. This property would wait for the amount of seconds before throwing an error.
2AccountThe account you want to use to send the message.
3Mail FolderThe mail folder you want to fetch messages from.
4Display NameThe name on the top of the activity.
5FilterIf you want to retrieve a certain message you can use this filter box.
6Mark As ReadIf this checkbox is checked, once the message has been retrieved, it
would be marked as read.
7Only Unread MessagesIf this checkbox is checked, this activity would fetch unread messages.
8TopThe number you put in this property would allow you to fetch the
number of emails starting from the top.
9MessagesOutput of the messages retrieved.

Note: All strings must be placed in between quotation marks.

VII. Error handling activities

1. Try and Catch, Throw and Rethrow

Try and Catch allows you to catch a certain specified type of exception and shows you the type of error or it could also be dismissed to continue the program.

image-20220506172025-121.png

he program that you want to find the bug should be placed into the Try Section while under the Catch Section, you have got to mention the type of exception you are looking for.

image-20220506172233-122.png

image-20220506172240-123.png

Throw Property allows you to throw and find an exception providing you enter the type of exception.

image-20220506172251-124.png

Under the ReThrow property, it would allow you to re-throw the type of bug you are finding for if it does not pop out the first time.

Tags:
 
Navigation