Overview

The features provided by the Knox Portal Library can be used to implement the Knox Portal REST API integration features.
To use the library features, you must be logged in to the server on Designer.

The features provided by the Knox Portal library are as follows:

Message sending: SendKnoxMessage
Getting user and department information: GetUserInfo, GetDeptInfo
PIMS features: GetCalendarList, CreateSchedule, DeleteSchedule, GetSchedulesInfo

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

• On Designer: > Help > Sample > Sample > KnoxPortal

• On File Explorer: C:\Users\user\AppData\Roaming\Brity RPA Designer\samples\KnoxPortal

[Knox Portal sample project names and related activity cards]

• Manage Schedule: CreateSchedule, DeleteSchedule, GetSchedulesInfo

• SendKnoxMessage: SendKnoxMessage

• KnoxPortal_GetKnoxInfo: GetApprovalStatus, GetDeptInfo, GetUserInfo, SendMail

Installing the Knox Portal library

For Knox Portal library installation , please refer to Installing the Brity RPA Add-In Library

Close both Brity RPA Designer and Bot before installation.

Common Properties

MORE OPTIONS

MORE OPTIONS properties
Properties	Type	Required	Unit	Auto-setting	Description
On Error	Combination box	N	-	N	Specify an action to carry out when an error occurs at the time of execution. - --Ignore--: Ignore the error. - --Retry--: Try the activity one more time. - --Goto--: Try the scenario for the specified time if the activity fails. - _Event: Select an event created within the project.

DESCRIPTION

DESCRIPTION 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.

GetUserInfo

Overview

This activity card fetches employee information using the KnoxPortal ID or email address.

Application procedures

In the [Output] UserInfo field, enter the variable to store the fetched user information.
Set the Allow NoResult property to select whether to trigger an error or return an array whose size is “0” when the searched information cannot be found.
Set the Type property to select the type of search condition.
In the Search field, enter a user ID or email address to search for.

Card output properties

Property	Type	Additional comments	Description	Example
UserInfo	One-dimensional array	class (employee information) UserId (KnoxPortal ID) Name (Employee name) EngName (English name of the employee) Department (Department name) EngDepartment (English name of the department) DepartmentCode (Department code) EmployeeNo (Employee number) EngTitle (English title name) Title (Title name) Mail (Email address) Mobile (Mobile phone number) Telephone (Phone number)	Returns a list of objects that match the search criteria.	[ { UserId : 'gildong.hong', Name : 'Hong Gil-dong', EngName : 'Dong Gil Hong', Department : 'Brity RPA Development Group', EngDepartment : 'Brity RPA Dvelopment Group', DepartmentCode : 'XXXXXX', EmployeeNo : '00000', Title : 'Engineer', EngTitle : 'Engineer', Mail : 'gildong.hong@samsung.com', Mobie : '000-0000-0000', Telephone : '00-0000-0000' } ,... ]

Property

Type

Additional comments

Description

Example

UserInfo

One-dimensional array

class (employee information)

UserId (KnoxPortal ID)
Name (Employee name)
EngName (English name of the employee)
Department (Department name)
EngDepartment (English name of the department)
DepartmentCode (Department code)
EmployeeNo (Employee number)
EngTitle (English title name)
Title (Title name)
Mail (Email address)
Mobile (Mobile phone number)
Telephone (Phone number)

Returns a list of objects that match the search criteria.

[

{

UserId : 'gildong.hong',

Name : 'Hong Gil-dong',

EngName : 'Dong Gil Hong',

Department : 'Brity RPA Development Group',

EngDepartment : 'Brity RPA Dvelopment Group',

DepartmentCode : 'XXXXXX',

EmployeeNo : '00000',

Title : 'Engineer',

EngTitle : 'Engineer',

Mail : 'gildong.hong@samsung.com',

Mobie : '000-0000-0000',

Telephone : '00-0000-0000'

}

,...

]

Card input properties

GetUserInfo card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Allow NoResult	Toggle button	Y	-	Y	If no match could be found, return an array whose size is “0” instead of triggering an error. - On: Return an array whose size is “0” if no match could be found. - Off: Trigger an error if no match could be found.
N	[USER] Type	Combination box	Y	-	Y	Select a search type for a user ID or email address search.
N	[USER] Search	Text	Y	-	N	Enter a user ID or Email address to search for.
Y	MORE OPTIONS	-	-	-	-	Common property of the Knox Portal library.
Y	DESCRIPTION	-	-	-	-	Common property of the Knox Portal library.

Example of utilization

Search for user information on Knox Portal and output the result in a message box.

GetUserInfo 활용 예시

Sample file

Menu > Help > Sample > Sample > KnoxPortal > KnoxPortal_GetKnoxInfo > P_Knox_GetUserInfo

Used variables

getUserInfo = Array variable to store the searched user information
printUserInfor = Variable that stores user information sorted by item for the message box output

Used properties

[Output] UserInfo = this.getUserInfo
Allow NoResult = Off
Type = ID
Search = 'hy1031.kim'

Related/Similar activities

GetDeptInfo

Overview

This activity card fetches the department information of an employee using the KnoxPortal ID or email address.

Application procedures

In the [Output] Department Info field, enter the variable to store the fetched department information.
Set the Allow NoResult property to select whether to trigger an error or return an array whose size is “0” when the searched information cannot be found.
Set the Type property to select the type of search condition.
In the Search field, enter a user ID or email address to search for.

Card output properties

Property	Type	Additional comments	Description	Example
Department Info	One-dimensional array	Class (Department information) DepName (Department name) EngDeptName (English department name) DeptCode (Department code) HighDeptName (Higher department name) EngHighDeptName (English upper department name) HighDeptCode (Higher department code) Company (Company name) EngCompany (English company name) ManagerId (Department Head Knox ID) ManagerName (The name of the department head)	Returns a list of department information objects that match the search criteria.	[ { Department : 'Brity RPA Development Group', EngDepartment : 'Brity RPA Dvelopment Group', DeptCode : 'XXXXXX', HighDeptName : 'Development Team', EngHighDeptName : 'Development Team', HightDeptCode : 'XXXXXX', Company : 'Samsung SDS', EngCompany : 'SAMSUNG SDS', ManagerId : 'xxxxxx.xxx', ManagerName : 'XXX' } ,... ]

Property

Type

Additional comments

Description

Example

Department Info

One-dimensional array

Class (Department information)

DepName (Department name)
EngDeptName (English department name)
DeptCode (Department code)
HighDeptName (Higher department name)
EngHighDeptName (English upper department name)
HighDeptCode (Higher department code)
Company (Company name)
EngCompany (English company name)
ManagerId (Department Head Knox ID)
ManagerName (The name of the department head)

Returns a list of department information objects that match the search criteria.

[

{

Department : 'Brity RPA Development Group',

EngDepartment : 'Brity RPA Dvelopment Group',

DeptCode : 'XXXXXX',

HighDeptName : 'Development Team',

EngHighDeptName : 'Development Team',

HightDeptCode : 'XXXXXX',

Company : 'Samsung SDS',

EngCompany : 'SAMSUNG SDS',

ManagerId : 'xxxxxx.xxx',

ManagerName : 'XXX'

}

,...

]

Card input properties

GetDeptInfo card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Allow NoResult	Toggle button	Y	-	Y	If no match could be found, return an array whose size is “0” instead of triggering an error. - On: Return an array whose size is “0” if no match could be found. - Off: Trigger an error if no match could be found.
N	[USER] Type	Combination box	Y	-	Y	Select a search type for a user ID or email address search.
N	[USER] Search	Text	Y	-	N	Enter a user ID or Email address to search for.
Y	MORE OPTIONS	-	-	-	-	Common property of the Knox Portal library.
Y	DESCRIPTION	-	-	-	-	Common property of the Knox Portal library.

Example of utilization

Search for department information on Knox Portal and output the result in a message box.

GetDeptInfo 활용 예시

Sample file

Menu > Help > Sample > Sample > KnoxPortal > KnoxPortal_GetKnoxInfo > P_Knox_GetDeptInfo

Used variables

UserID = Variable that stores the user ID of the target user to search for (※ To execute the sample, set the Knox ID to the default value in advance.)
getDeptInfo = Array variable to store the department information of the searched department.
printDeptInfor = Variable that stores department information sorted by item for the message box output

Used properties

[Output] DeptInfo = this.getDeptInfo
Allow NoResult = Off
Type = ID
Search = Global.UserID

Related/Similar activities

GetUserInfo

GetCalendarList

Overview

Get the calendar list in KnoxPortal PIMS schedule.

Application procedures

In the [Output] CalendarList, enter a variable to save the retrieved calendar list.
Set the Type property to select a search condition.
In the Search field, enter the user ID or email address to search for.

Card output properties

Property	Type	Additional comments	Description	Example
Calendar List	One-dimensional array	Dictionary<string, object>	Returns an array of calendar lists.	[ { 'defaultYn' : 'N', 'displayType' : 'VISIBLE', color = '#98d24d', ... } ,... ]

Property

Type

Additional comments

Description

Example

Calendar List

One-dimensional array

Dictionary<string, object>

Returns an array of calendar lists.

[

{

'defaultYn' : 'N',

'displayType' : 'VISIBLE',

color = '#98d24d',

...

}

,...

]

Card input properties

CreateSchedule 카드 속성
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	[PIMS] Type	Combo box	Y	-	Y	Specify the type to use for scanning, such as user ID or email.
N	[PIMS] Search	Text	Y	-	N	Enter the user ID or email to register the schedule.
Y	MORE OPTIONS	-	-	-	-	Common property of the Knox Portal library.
Y	DESCRIPTION	-	-	-	-	Common property of the Knox Portal library.

Example of utilization

Search by user id and get calendar list from the Knox Portal and output the result in the message box.

Used variables

UserID = Variable that stores the user ID of the target user to search for (※ To execute the sample, set the Knox ID to the default value in advance.)
getCalendarList = Array variable to store the Calendar list of the searched user ID.

Used properties

[Output] Calendar List = this.getCalendarList
Type = ID
Search = Global.UserID

CreateSchedule

Overview

This activity card creates the KnoxPortal PIMS schedule. The schedule ID is returned if the schedule is created successfully.

Application procedures

In the [Output] Schedule field, enter the variable to store the created schedule.
Set the Type property to select the type of search condition.
In the Search field, enter a user ID or email address to search for.
Set the PIMS properties to specify the title, content, place, start time, and end time of the schedule.

Card properties

CreateSchedule card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	[Output] Schedule ID	Variable	Y	-	Y	Specify the variable to store the registered schedule ID.
N	[PIMS] Type	Combination box	Y	-	Y	Specify the type to use to search for a user ID or email address.
N	[PIMS] Search	Text	Y	-	N	Enter the user ID or Email address of the user to register the schedule.
N	[PIMS] CalendarID	Text	N	-	N	Enter the CalendarID.
N	[PIMS] Subject	Text	Y	-	N	Enter the title of the schedule.
N	[PIMS] Contents	Text	N	-	N	Enter the content.
N	[PIMS] Place	Text	N	-	N	Enter the location.
N	[PIMS] StartTime	Text	Y	-	N	Enter the start time.
N	[PIMS] EndTime	Text	Y	-	N	Enter the end time.
N	[PIMS] IsAllDay	Toggle button	Y	-	Y	Specify whether to set the schedule for all day.
Y	MORE OPTIONS	-	-	-	-	Common property of the Knox Portal library.
Y	DESCRIPTION	-	-	-	-	Common property of the Knox Portal library.

Example of utilization

Register the specified user’s schedule on Knox Portal and output the result in a message box.

CreateSchedule 활용 예시

Sample file

Menu > Help > Sample > Sample > KnoxPortal > Manage Schedule > P_Knox_CreateSchedule_Test

Used variables

UserID: Variable that stores the user ID of the target user to register the schedule (※ To execute the sample, set the Knox ID to the default value in advance.)
creChedule: Variable that stores the generated schedule ID information

Used properties

[Output] Schedule ID = this.creChedule
Type = ID
Search = Global.UserID
Subject = 'Brity RPA Learning'
Contents = 'Brity RPA Learning Schedule'
Place = 'Samsung SDS'
StartTime = '2020-11-25 09:00:00'
EndTime = '2020-11-25 18:00:00'
IsAllDay = ON

Related/Similar activities

DeleteSchedule, GetScheduleInfo

DeleteSchedule

Overview

This activity card deletes the KnoxPortal PIMS schedule. The schedule ID of the schedule to delete and the user ID is required.

Application procedures

Set the Type property to select the type of search condition.
In the Search field, enter a user ID or email address to search for.
In the Schedule ID field, enter the schedule ID to delete.

Card properties

DeleteSchedule card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	[PIMS] Type	Combination box	Y	-	Y	Specify the type to use to search for a user ID or email address.
N	[PIMS] Search	Text	Y	-	N	Enter user ID or Email address of the user to delete the schedule.
N	[PIMS] Schedule ID	Text	Y	-	N	Enter the schedule ID to delete.
Y	MORE OPTIONS	-	-	-	-	Common property of the Knox Portal library.
Y	DESCRIPTION	-	-	-	-	Common property of the Knox Portal library.

Example of utilization

Search for the specified user’s schedule on Knox Portal and output the result in a message box. Then, delete the searched schedule.

DeleteSchedule 활용 예시

Sample file

Menu > Help > Sample > Sample > KnoxPortal > Manage Schedule > P_Knox_DeleteSchedule_Test

Used variables

UserID = Variable that stores the user ID of the target user to delete the schedule (※ To execute the sample, set the Knox ID to the default value in advance.)
creChedule = Variable that stores the deleted schedule ID information

Used properties

Type = ID
Search = Global.UserID
Schedule ID = this.creChedule

Related/Similar activities

CreateSchedule, GetScheduleInfo

GetScheduleInfo

Overview

This activity card searches the Knox Portal schedule of the specified user and returns the schedule information to an array variable.

Application procedures

In the [Output] Result field, enter the array variable to store the searched schedule.
Set the Type property to select the type of search condition.
In the Search field, enter a user ID or email address to search for.
In the StartTime and EndTime fields, enter the start time and end time of the schedule to search for.

Card output properties

Property	Type	Additional comments	Description	Example
Schedule Info	One-dimensional array	Class (Schedule information) ScheduleId (Schedule ID) Subject (Title of the schedule) Contents (Content of the schedule) StartTime (Start time of the schedule) EndTime (End time of the schedule) AllDayYn (All-day schedule Y/N) Place (Place of the schedule) Attendees (Participants of the schedule)	Returns the searched schedule information.	[ { SchduleId : 'XXX', Subject : 'Brity Works Education', Contents : 'Brity Works Education, StartTime : '2021-01-02 09:00:00', EndTime : '2021-01-06 09:00:00', AllDayYn : 'Y', Place : 'Samsung SDS', Attendees : ['User1', 'User2', 'User3'] } ,... ]

Property

Type

Additional comments

Description

Example

Schedule Info

One-dimensional array

Class (Schedule information)

ScheduleId (Schedule ID)
Subject (Title of the schedule)
Contents (Content of the schedule)
StartTime (Start time of the schedule)
EndTime (End time of the schedule)
AllDayYn (All-day schedule Y/N)
Place (Place of the schedule)
Attendees (Participants of the schedule)

Returns the searched schedule information.

[

{

SchduleId : 'XXX',

Subject : 'Brity Works Education',

Contents : 'Brity Works Education,

StartTime : '2021-01-02 09:00:00',

EndTime : '2021-01-06 09:00:00',

AllDayYn : 'Y',

Place : 'Samsung SDS',

Attendees : ['User1', 'User2', 'User3']

}

,...

]

Card input properties

GetScheduleInfo card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	[PIMS] Type	Combination box	Y	-	Y	Specify the type to use to search for a user ID or email address.
N	[PIMS] Search	Text	Y	-	N	Enter the user ID or Email address of the user to view the schedule.
N	[PIMS] StartTime	Text	Y	-	N	Enter the start time.
N	[PIMS] EndTime	Text	Y	-	N	Enter the end time.
Y	MORE OPTIONS	-	-	-	-	Common property of the Knox Portal library.
Y	DESCRIPTION	-	-	-	-	Common property of the Knox Portal library.

Example of utilization

Search for the specified user’s schedule newly created on Knox Portal and output the result in a message box. Then, enter the scheduled events in Notepad if there are any.

GetScheduleInfo 활용 예시

Sample file

Menu > Help > Sample > Sample > KnoxPortal > Manage Schedule > P_Knox_GetScheduleInfo_Test

Used variables

UserID: Variable that stores the user ID of the target user to search for the schedule (※ To execute the sample, set the Knox ID to the default value in advance.)
getSche: Variable to store the searched schedule information.

Used properties

Result = this.getSche
Type = ID
Search = Global.UserID
StartTime = '2020-02-10 09:00:00'
EndTime = '2020-02-23 09:00:00'

Related/Similar activities

CreateSchedule, DeleteSchedule

SendKnoxMessage

Overview

This activity card sends messages using Knox messenger.
On Designer, this feature is operated by utilizing the simulation result property because the operation requires a connection to the Orchestra server.
When a transmission to a server is operated, you can see that the message is delivered to the messenger.

Application procedures

In the [Output] Response field, enter the variable to store the response message of the recipient.
Set the Response Type property to select the response type to wait for.
In the Recipient ID field, enter the Knox ID of the recipient.
In the Message field, enter the message to send to the recipient.
In the Timeout(Sec) field, enter the maximum wait time to wait for the recipient’s response in seconds.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	[Output] Response	Variable	Y	-	Y	Select the variable to store the response message from the recipient. The response message will be determined depending on the Response Type.
N	[KNOX MESSENGER] Response Type	Combination box	Y	-	Y	Select the standby type of the recipient. The response content will be determined depending on the selected type.
N	[KNOX MESSENGER] Recipient ID	Text	Y	-	N	Enter the recipient's Knox ID. Several Knox IDs can be input by separating them into semicolons (;).
N	[KNOX MESSENGER] Message	Text	Y	-	N	Enter the text string for the message to send.
N	[KNOX MESSENGER] Timeout(Sec)	Number	Y	Seconds	Y	Enter the maximum wait time to wait for the recipient’s response in seconds.
Y	MORE OPTIONS	-	-	-	-	Common property of the Knox Portal library.
Y	DESCRIPTION	-	-	-	-	Common property of the Knox Portal library.

Example of utilization

Sends a message to the specified user and receives a reply on Knox Portal.

SendKnoxMessage 활용 예시

Sample file

Menu > Help > Sample > Sample > KnoxPortal > SendKnoxMessage > SampleProcess

Used variables

UserID = Variable that stores the Knox ID of the message recipient.

Used properties

[Output] Response = RESULT
Response Type = No Wait
Receiver ID = this.UserID
Message = 'Test_NoWait'
Timeout(Sec) = 300

GetContactGroupList

Overview

This activity card gets a list of contact groups stored in PIMS using KnoxPortal ID

Application procedures

In the [Output] field, enter a variable to save the imported contact group list in Group List.
In the Knox ID field, enter the user ID to search for.
In the PubType field, select the scope of the contact's disclosure. (DEPARTMENT: Department Disclosure, COMPANY: Company Disclosure)

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	PubType	Combo box	N	-	Y	Select the scope of your contacts (DEPARTMENT: department disclosure, COMPANY: company disclosure)
N	Knox ID	Text	Y	-	N	Enter the user ID to search for.
Y	MORE OPTIONS	-	-	-	-	Common property of the Knox Portal library.
Y	DESCRIPTION	-	-	-	-	Common property of the Knox Portal library.

Example of utilization

The Knox Portal retrieves the user's contact list and outputs the result to a message box.

Getcontactgrouplist

Sample file

Menu > Help > Samples > Sample > KnoxPortal > Other Samples > P_Knox_GetContactGroupList

Used variables

groupList = Array variable to store searched contact group information

Used properties

[Output] Group List = this.groupList
PubType = DEPARTMET
Knox ID = 'knox.id'

GetContactGroup

Overview

This activity card retrieves contact group information stored in PIMS using KnoxPortal ID and Group ID

Application procedures

In the [Output] Group field, enter a variable to store the imported contact group information.
In the Knox ID field, enter the user ID to search for.
In the OutputType field, select whether contact results include detailed or only mail information.
Enter the contact group ID to search for in Group ID

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	OutputType	Combo box	N	-	Y	Select whether the contact result will include detailed information or mail information only. (DetailInfo: including detailed information, MailList: mail information only)
N	Knox ID	Text	Y	-	N	Enter the user ID to search for.
N	Group ID	Text	Y	-	N	Enter the contact group ID to search for.
Y	MORE OPTIONS	-	-	-	-	Common property of the Knox Portal library.
Y	DESCRIPTION	-	-	-	-	Common property of the Knox Portal library.

Example of utilization

After searching the user's contact list in the Knox Portal, select a Group ID from among them to retrieve information about that group.

Getcontactgroup

Sample file

Menu > Help > Samples > Sample > KnoxPortal > Other Samples > P_Knox_GetContactGroup

Used variables

groupList = Array variable to store searched contact group list
group = variable to store searched contact group information

Used properties

[Output] Group = this.group
OutputType = MailList
Knox ID = 'knox.id'
Group ID = 'this.groupList[0].groupId'

SearchContactGroup

Overview

This activity card gets contact group details using KnoxPortal ID, privacy, and group name.

Application procedures

In [Output] Group List , enter a variable to store the imported contact group information.
Enter the user ID to search for in Knox ID .
In the PubType field, select the scope of disclosure of the contact. (DEPARTMENT: Department Disclosure, COMPANY: Company Disclosure)
Enter the contact group name to search for in Group name.

Card properties

Common	Properties	Type	Required	Unit	Auto-setting	Description
N	PubType	Combo box	N	-	Y	Select the privacy of your contacts (DEPARTMENT: department disclosure, COMPANY: company disclosure)
N	Knox ID	Text	Y	-	N	Enter the user ID to search for.
N	Group Name	Text	Y	-	N	Enter the contact group name to search for.
Y	MORE OPTIONS	-	-	-	-	Common property of the Knox Portal library.
Y	DESCRIPTION	-	-	-	-	Common property of the Knox Portal library.

Example of utilization

Search for the Group name in the user's contact list to retrieve the group's information.

Searchcontactgroup

Sample file

Menu > Help > Samples > Sample > KnoxPortal > Other Samples > P_Knox_SearchContactGroup

Used variables

groupList = Array variable to store searched contact group list

Used properties

[Output] GroupList = this.group
PubType = DEPARTMENT
Knox ID = 'knox.id'
Group name = 'Contacts'