Net library

Overview

Overview

You can control web page screen using the features provided by the Net library.
These features identify the UI object on the screen using the UI automation technology provided by Windows and find the target UI specified by the user to perform the specified actions.

The features provided by the Net library are as follows:

Use Designer or File Explorer to refer to the samples of the Net library.

• On Designer: Menu > Help > Sample > Sample > Web

• On Windows Explorer: C:\Users\user\AppData\Roaming\Brity RPA Designer\samples\Web

[Net sample project names and related activity cards]

• Mail Transfer: SendMail, ReceiveMail, DownloadMailAttachment

• Manager Browser: CloseBrowser, CloseBrowser

• Other Samples: SendRequest

Common Properties

Common Properties

TARGET

Card properties

Properties

Type

Required

Unit

Auto-setting

Description

Maximize

Toggle button

N

-

Y

Select whether to maximize the browser window.

CONNECTION

Card properties

Properties

Type

Required

Unit

Auto-setting

Description

Host Name

Text

Y

-

Y

Enter the host name of the email server (SMTP).

Port

Text

Y

-

Y

Enter email server port.

ID

Text

Y

-

N

Enter the email account of the sender.

Password

Text

Y

-

N

Enter the password of the sender’s email account. Set to Secure to encrypt the password.

Use SSL

Toggle button

Y

-

N

Specify whether to use SSL.

MAIL

Card properties

Properties

Type

Required

Unit

Auto-setting

Description

Number

Variable

Y

-

N

Specify numbers for the attachments to download.

Sender

Text

Y

-

Y

Enter the email address of the sender.

Receivers

Text

Y

-

Y

Enter the email address of the recipient.

CCs

Text

N

-

Y

Enter the email address of the CCs.

BCCs

Text

N

-

Y

Enter the email address of the BCCs.

Subject

Text

Y

-

Y

Enter the title of the email.

Body

Text

N

-

Y

Enter the body of the email.

Max Count

Number

N

EA

N

Enter the maximum number of emails to check.

Start No.

Number

N

-

N

Enter the starting number of emails to check.

With Contents

Toggle button

N

-

N

Select whether to include the email content (body and attachment) in the returned result.

Ignore HTML Tag

Toggle button

N

-

Y

Select whether to exclude the HTML tag in the body content.

Ignore Body Attachments

Toggle button

N

-

Y

Select whether to ignore the attachments in the body among the returned information.

Recent First

Toggle button

N

-

Y

Select whether to check the most recent email.

Check Undered List

Toggle button

N

-

N

Select whether to additionally check the unsorted messages, such as scheduled messages for sending, when checking the start/end times.

Attachments

Text

N

-

Y

SendMail activity: Enter the path for the attachment file.

DownloadMailAttachment activity: Enter the name of attached files to download.

Download

Text

N

-

Y

Specify the download path.

File Size (MB)

Number

N

MB

N

Set the size limit of the attachment file. An error is returned when the attachment size is greater than the limit.

IsHtml

Toggle button

N

-

N

Select whether to use the HTML format for the email body.

REST

Card properties

Properties

Type

Required

Unit

Auto-setting

Description

Method

Combination box

N

-

Y

Select the calling method.


※ Call types

- GET, POST, PUT, DEL

Content Type

Combination box

N

-

Y

Select the type of content to call.


※ Types

- Text, text/plain, application/json, application/xml, multipart/form-data

URL

Text

Y

-

N

Enter the address to call.

Authorization

Text

N

-

N

Enter the API key.

Headers

Text

N

-

N

Enter the header information.

Body

Text

N

-

N

Enter the body information.

MORE OPTIONS

MORE OPTION

Properties

Type

Required

Unit

Auto-setting

Description

On Error

Combination box

N

-

N

Select the processing method for occurred errors.

- --Ignore--: Ignore the error and proceed.

- --Retry--: Try the task one more time.

- --Goto--: Try the scenario for the specified activity if the activity fails.

- --Event--: Select an event created within the project.

GotoStep Relative Position

Number

N

-

N

Select the activity you want to move based on that activity. Check the activity number via Ctrl + F, and then enter the [Activity Number] - [Target Activity Number] value. (Default: 0)

GotoStep Retry Count

Combination box

N

-

N

If the activity fails, enter the maximum number of times to perform. (Default: 1)

DESCRIPTION

Card properties

Properties

Type

Required

Unit

Auto-setting

Description

DESCRIPTION

Text

N

-

N

Enter the description for the activity card.

The description entered in the DESCRIPTION field is used as the description of the activity. A representative value will be displayed in the absence of the DESCRIPTION input.

OpenBrowser

OpenBrowser

Overview

This activity card opens Internet Explorer. You can enter a URL to connect to the relevant web site.
After the execution, it returns the browser ID. You can use the returned ID with other activity cards.

Application procedures

In the URL field, enter the URL of the web site to access.

Card properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Output] Browser ID

Variable

Y

-

Y

Specify the variable to store the ID of the launched browser. (Default: RESULT)

N

URL

Variable

Y

-

N

Open the browser and enter the URL of the web site to access.

N

WaitTime(Sec)

Number

N

sec

Y

Set the duration of the waiting time until the browser is launched and appears on the screen. (Default: 10)

Y

TARGET

-

-

-

-

Common property of the Net library.

Y

MORE OPTIONS

-

-

-

-

Common property of the Net library.

Y

DESCRIPTION

-

-

-

-

Common property of the Net library.

Example of utilization

Run Internet Explorer, access "www.google.com," and store the returned browser ID in the RESULT variable. Then, close Internet Explorer three seconds later. Then, it closes Internet Explorer three seconds later.

Excel_NewExcel_1K

Sample file

Used variables

Used properties

Remarks

A browser has one ID in most cases. However, it may have multiple IDs in some cases, such as when pop-up windows are open.

Unlike the PID in the OpenApp activity card usage, the browser ID cannot be used with the CloseApp activity card because it is the ID of an app screen.

Related/Similar activities

CloseBrowser

CloseBrowser

CloseBrowser

Overview

This activity card closes the browser with the selected ID. You must store the ID returned by the OpenBrowser activity card to use this feature.

Application procedures

In the [Input] Browser ID field, enter the ID of the browser to close (ID returned by the OpenBrowser activity).

Card properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Input] Browser ID

Variable

Y

-

Y

Specify the variable that stores the ID of the browser to close.

N

ForceAll

Toggle button

Y

-

Y

Select whether to forcibly close the browser regardless of the browser status.

If it is set to "True (On)," the program is closed regardless of the browser status. If it is set to “False (Off),” the close command is sent to the program only once.

In this case, the browser may not close depending on the browser status.

Y

MORE OPTIONS

-

-

-

-

Common property of the Net library.

Y

DESCRIPTION

-

-

-

-

Common property of the Net library.

Example of utilization

Run Internet Explorer, open the “www.google.com” page and then store the returned browser ID in the "RESULT" variable. Then, three seconds later, close the Internet Explorer that matches the ID.

Excel_NewExcel_1K

Sample file

Used variables

Used properties

Related/Similar activities

OpenBrowser

CloseIETab

CloseIETab

Overview

This activity card exits the tab in the Edge browser that corresponds to the entered condition.

Application procedures

  1. In the Tab Title field, enter the tab information you want to exit.

  2. In the Tab Index field, enter the tab information you want to exit.

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

Title Search Type

ComboBox

N

-

Y

Choose how tab names are retrieved.

N

Tab Title

String

N

-

N

Enter the name of the tab you want to exit.

N

Tab Index

Number

Y

-

Y

Enter the tab number you want to exit. Tab numbers start at 1 on the left. LAST_TAB refers to the tab on the far right.

N

Timeout(Sec)

Number

Y

-

Y

Enter the number of seconds to find the target tab.

Y

MORE OPTIONS

-

-

-

-

Common property of the Net library.

Y

DESCRIPTION

-

-

-

-

Common property of the Net library.

Example of utilization

Access the naver.com, google.co.kr through the Edge browser, and exit each tab through the tab name, tab index.

CloseIETab

Sample file

Used properties

SendMail

SendMail

Overview

This activity card sends mail messages via SMTP (Simple Mail Transfer Protocol).

Application procedures

Ensure that the target mail server supports SMTP and the firewall between Designer, Bot, and the mail service is disabled.

  1. In the CONNECTION property fields, specify the SMTP connection information, including the host name, port number, and the sender’s mail service ID and password.

  2. In the MAIL property fields, enter the sender, recipient, CC, and BCC, and then specify the message subject, body content, and attachment path.

Card properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

Host Name

Variable

Y

-

N

Enter the name of the email server(SMTP) host. (Information obtained from the target mail service)

N

Port

Number

Y

-

N

Enter email server port. (Information obtained from the target mail service)

N

ID

Variable

Y

-

N

Enter the sender's mail service ID.

N

Password

Variable

Y

-

N

Enter the sender's mail service password.

- Normal: The password input is saved as a plain text.

- Credential: The password input is encrypted and retrieved from shared resources.

- Secure: The password input is encrypted for saving.

N

Use SSL

Toggle button

Y

-

Y

Specify whether to use SSL. (Information obtained from the target mail service)

N

Sender

Variable

Y

-

N

Enter the email address of the sender.

N

Receivers

Variable

Y

-

N

Enter the email address of the recipient. Multiple addresses can be entered by separating them with a semicolon (;).

N

CCs

Variable

N

-

N

Enter the email address of the CCs. Multiple addresses can be entered by separating them with a semicolon (;).

N

BCCs

Variable

N

-

N

Enter the email address of the BCCs. Multiple addresses can be entered by separating them with a semicolon (;).

N

Subject

Variable

Y

-

N

Enter the title of the email.

N

Body

Variable

N

-

N

Enter the body of the email.

N

Attachments

Variable

N

-

N

Enter the path for the attachment file. Multiple paths can be entered by separating them with a semicolon (;).

N

File Size (MB)

Number

N

MB

N

Set the size limit of the attachment file. An error is returned when the attachment size is great than the limit.

N

IsHtml

Toggle button

Y

-

Y

Select whether to compose the mail body in the HTML format.

Y

MORE OPTIONS

-

-

-

-

Common property of the Net library.

Y

DESCRIPTION

-

-

-

-

Common property of the Net library.

Example of utilization

On the SMTP server (v7smtp.samsung.com), send a mail message titled “SendMailTest.”

Excel_NewExcel_1K

Sample file

Used variables

Used properties

Related/Similar activities

ReceiveMail

ReceiveMail

ReceiveMail

Overview

This activity card receives a mail message and stores it in a variable.

Application procedures

Ensure that the target mail server supports POP3, and the firewall is disabled between Designer, Bot, and the mail service.

  1. In the CONNECTION property fields, specify the POP3 connection information, including the host name, port number, and the sender’s mail service ID and password.

  2. In the MAIL property fields, specify the conditions for reading the mail message, such as the delivery time, sender, message subject, body content, and attachment.

Card output properties

Property

Type

Additional comments

Description

Example

Mails

One-dimensional array

Object(Mail)

Returns mail information that meets the conditions.

[

{'Number' : 1,

'ID' : 'XXX@samsung.com',

'Subject' : 'Title',

...},

...

]

Card input properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

Host Name

Variable

Y

-

N

Enter the POP3 mail server host name. (Information obtained from the target mail service)

N

Port

Number

Y

-

N

Enter email server port. (Information obtained from the target mail service)

N

ID

Text

Y

-

N

Enter the sender's mail service ID.

N

Password

Text

Y

-

N

Enter the sender's mail service password.

- Normal: The password input is saved as a plain text.

- Credential: The password input is encrypted and retrieved from shared resources.

- Secure: The password input is encrypted for saving.

N

Use SSL

Toggle button

N

-

Y

Specify whether to use SSL. (Information obtained from the target mail service)

N

Begin Time

Variable

N

-

Y

Receive emails sent after the entered time.

N

End Time

Variable

N

-

Y

Receive emails sent before the entered time. If empty, check until the current time.

N

Sender

Variable

N

-

N

Enter the email address of the sender to search for.

N

Subject

Variable

N

-

N

Search for mail messages with subjects that include the entered text.

N

Body

Variable

N

-

N

Enter the body of the email.

N

Attachments

Variable

N

-

N

Enter the path for the attachment file. Multiple paths can be entered by separating them with a semicolon (;).

N

Max Count

Number

N

-

N

Enter the maximum number of emails to check. All mail messages will be searched if “0” is entered.

N

Start No.

Number

N

-

N

Enter the starting number of emails to check.

N

With Contents

Toggle button

N

-

Y

Determine whether to include the email content (body and attachment) in the returned result.

If verification of the content is not required, you can set this option to “False (Off)” to increase the execution speed.

N

Ignore HTML Tag

Toggle button

N

-

Y

Select whether to exclude the HTML tag in the body content.

N

Ignore Body Attachments

Toggle button

N

-

Y

Select whether to ignore the attachments in the body among the returned information.

N

Recent First

Toggle button

N

-

Y

Select whether to check the most recent email.

N

Check Unodered List

Toggle button

N

-

Y

Select whether to additionally check the unsorted messages, such as scheduled messages for sending, when checking the start/end times.

Y

MORE OPTIONS

-

-

-

-

Common property of the Net library.

Y

DESCRIPTION

-

-

-

-

Common property of the Net library.

Example of utilization

Read up to two mail messages titled "SendMailTest.” (The tags and attachments are excluded from the reading, and the latest mail message will be read first.) Then, output the read messages in a message box.

Excel_NewExcel_1K

Sample file

Used variables

Used properties

Related/Similar activities

SendMail, DownloadMailAttachment

DownloadMailAttachment

DownloadMailAttachment

Overview

This activity card saves the email attachment.

Application procedures

Ensure to read the mail object first with the ReceiveMail activity card.

  1. In the Number field, specify the number for the attachment file to download from the mail message (an array variable) searched by the ReceiveMail activity card.

  2. In the Attachments field, enter the name of the attachment file to download.

  3. In the Download field, specify the path for downloading the attachment file.

  4. Select whether to ignore attachments in the mail body with the Ignore Body Attachments item.

Card properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

Number

Variable

Y

-

Y

Enter the number for the attachment file to download.

N

Attachments

Variable

N

-

N

Enter the name of the attachment file to download. Setting this property value may slow down the execution speed.

N

Download

Variable

Y

-

Y

Enter the path for the download.

N

Ignore Body Attachments

Toggle button

Y

-

Y

Select whether to ignore the attachment file in the body among the returned information.

-True(On): Exclude attachment in the mail body

-False(Off): Include attachment in the mail body

Y

MORE OPTIONS

-

-

-

-

Common property of the Net library.

Y

DESCRIPTION

-

-

-

-

Common property of the Net library.

Example of utilization

Read up to two messages with subjects that include "SendMailTest." Then, save a file titled “IPA Test_AttachFile.txt” in the Global.ProjectDir/Download/ folder, excluding the mail attachment.

Excel_NewExcel_1K

Sample file

Used variables

Used properties

Related/Similar activities

ReceiveMail

SendRequest

SendRequest

Overview

This activity card calls a REST API.

Application procedures

Ensure that the API protocol has been defined with the opponent, and that the firewall has been disabled.

  1. In the [Output] Response field, specify the variable to store the call result.

  2. Specify information to request an API call (call type, call content type, call address, API key, and header and body information), according to the protocols specified by the REST properties. After the call, the remaining processes are performed based on the returned result.

Card output properties

Property

Type

Additional comments

Description

Example

Response

Object

Dictionary<string, object>

Returns the result of a REST API call.

{

'StatusCode' : 'OK',

'Content' : '(result of call)',

'Header' : '(Header content)'

}

Card input properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

Method

Combination box

Y

-

Y

Select the calling method.


※ Types

- GET, POST, PUT, DEL

N

ContentType

Combination box

Y

-

Y

Select the type of content to call.


※ Types

- Text, text/plain, application/json, application/xml, multipart/form-data, form-data(raw)

N

URL

Text

Y

-

Y

Enter the address to call.

N

Authorization

Text

N

-

N

Enter the API key.

N

Headers

Text

N

-

N

Enter the header information.

N

Body

Text

N

-

N

Enter the body information.

Y

MORE OPTIONS

-

-

-

-

Common property of the Net library.

Y

DESCRIPTION

-

-

-

-

Common property of the Net library.

Example of utilization

Call a REST API ('http://httpbin.org/get') and output the returned result in a message box.

Excel_NewExcel_1K

Sample file

Used variables

Used properties

OpenSSH

OpenSSH

Overview

This activity card connects to the server via SSH (Secure Shell).

Application procedures

  1. In the [Output] Connection field, enter the variable to store the connection information.

  2. In the Host field, enter the target IP.

  3. In the Id and Password fields, enter the account information.

  4. In the Port field, enter the port number.

Card properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Output] Connection

Variable

Y

-

Y

Enter the variable to store the connection information.

N

Host

String

Y

-

N

Enter the target IP address.

N

Id

String

Y

-

N

Enter the account ID.

N

Port

Number

Y

-

N

Enter the port number.

N

Password

String

Y

-

N

Enter the account password.

Y

MORE OPTIONS

-

-

-

-

Common property of the Net library.

Y

DESCRIPTION

-

-

-

-

Common property of the Net library.

Example of utilization

Enter the server address, username, password, and port number. Communicate with the server remotely via OpenSSH.

OpenSSH

Related/Similar activities

SendCommandSSH, CloseSSH

SendCommandSSH

SendCommandSSH

Overview

This activity card transmits a command to the server via an SSH connection.

Application procedures

Ensure that an OpenSSH connection with the server has been established.

  1. In the [Output] Result field, enter the variable to store the result of a command transmission.

  2. In the [Input] Connection field, enter the variable that stores the SSH connection information.

  3. In the Command field, enter the command to transmit.

  4. In the Timeout(Sec) field, enter the delay time for the response.

Card properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Output] Result

Variable

Y

-

N

Enter the variable to store the result of command transmission.

N

[Input] Connection

Variable

Y

-

Y

Enter the connection information required for the command transmission.

The connection information is specified in the [Output] Connection field of the OpenSSH activity card.

N

Command

String

Y

-

Y

Enter the command to transmit.

N

Timeout(Sec)

Number

N

Second

Y

Enter the delay time to wait for the response.

Y

MORE OPTIONS

-

-

-

-

Common property of the Net library.

Y

DESCRIPTION

-

-

-

-

Common property of the Net library.

Example of utilization

Enter the SSH handle value connected to SendCommandSSH and enter the command. The result is delivered by communicating with the remote server.

SendCommandSSH

Related/Similar activities

OpenSSH, CloseSSH

CloseSSH

CloseSSH

Overview

This activity card terminates the OpenSSH connection to the server.

Application procedures

Ensure that an OpenSSH connection with the server has been established.

In the [Input] Connection field, enter the variable that stores the SSH connection information.

Card properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Input] Connection

Variable

Y

-

Y

Specify the variable that stores the information of SSH connection to terminate.

The connection information is specified in the [Output] Connection field of the OpenSSH activity card.

Y

MORE OPTIONS

-

-

-

-

Common property of the Net library.

Y

DESCRIPTION

-

-

-

-

Common property of the Net library.

Example of utilization

To end SSH communication, you must call CloseSSH and terminate it. The input value of CloseSSH is the handle ID returned at the time of opening.

CLoseSSH

Related/Similar activities

OpenSSH, SendCommandSSH