Knox Portal 라이브러리

개요

개요

Knox Portal 라이브러리에서 제공하는 기능을 이용해 Knox Portal REST API 연계 기능을 사용할 수 있습니다. 이 라이브러리를 사용하기 위해서는 디자이너가 로그인 상태이여야 합니다.

Knox Portal 라이브러리에서 사용할 수 있는 기능은 다음과 같습니다.

Knox Portal 라이브러리에 대한 샘플을 디자이너 혹은 윈도 탐색기를 이용하여 참조할 수 있습니다.

• 디자이너 경로: > 도움말 > 샘플 > Sample > KnoxPortal

• 윈도 탐색기 경로: C:\Users\user\AppData\Roaming\Brity Works Designer\samples\KnoxPortal


[Knox Portal 샘플 프로젝트명과 관련 라이브러리]

Manage Schedule: CreateSchedule, DeleteSchedule, GetSchedulesInfo

SendKnoxMessage: SendKnoxMessage

Other Samples: GetApprovalStatus, GetDeptInfo, GetUserInfo, SendMail

Knox Portal 라이브러리 설치하기

Knox Portal 라이브러리 설치는 5. Add-In 라이브러리 설치하기 페이지를 참고 하십시요.

설치 전 BrityRPA Designer와 Bot을 모두 종료합니다.

공통 속성

공통 속성

MORE OPTIONS

MORE OPTIONS 카드 속성

속성

유형

필수여부

단위

자동입력여부

설명

On Error

콤보박스

N

-

N

오류 발생 시 처리 방법을 선택합니다.

- Ignore: 해당 오류를 무시하고 진행합니다.

- Retry: 해당 작업을 1회 재시도합니다.

- Goto: 해당 엑티비티가 실패한 경우 지정한 엑티비티로 이동하여 시나리오를 수행합니다.

- _Event: 프로젝트 내에 작성된 이벤트를 선택합니다.

DESCRIPTION

DESCRIPTION 카드 속성

속성

유형

필수여부

단위

자동입력여부

설명

DESCRIPTION

문자

N

-

N

해당 액티비티 카드에 대한 설명을 추가합니다.

Description이 입력되면 플로차트의 해당 액티비티 설명에 표시되고, Description이 없는 경우에는 대푯값이 해당 액티비티 설명에 표시됩니다.

GetUserInfo

GetUserInfo

개요

KnoxPortal ID 또는 메일 주소를 이용해 임직원 정보를 가져옵니다.

사용 절차

  1. [Output] UserInfo에 가져온 사용자 정보를 저장할 변수를 입력하세요.

  2. Allow NoResult에 검색된 정보가 없는 경우에 오류를 발생시킬지, 크기가 0인 배열을 반환할지 선택하세요.

  3. Type에 검색 조건 타입을 선택하세요.

  4. Search에 검색할 사용자 ID 또는 이메일 주소를 입력하세요.

카드 출력 속성

카드 속성

속성

리턴타입

리턴 추가설명

설명

결과 예시

UserInfo

1차원배열

class (임직원 정보)

  • UserId (KnoxPortal ID)

  • Name (임직원 이름)

  • EngName (임직원 영어 이름)

  • Department (부서 이름)

  • EngDepartment (부서 영어 이름)

  • DepartmentCode (부서 코드)

  • EmployeeNo (사번)

  • Title (직급명)

  • EngTitle (영어 직급명)

  • Mail (메일 주소)

  • Mobile (핸드폰 번호)

  • Telephone (전화번호)

검색 조건에 맞는 객체의 목록을 반환합니다.

[

{

UserId : 'gildong.hong',

Name : '홍길동',

EngName : 'Dong Gil Hong',

Department : 'Brity RPA 개발그룹',

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'

}

,...

]

카드 입력 속성

GetUserInfo 카드 속성

공통여부

속성

유형

필수여부

단위

자동입력여부

설명

N

Allow NoResult

토글버튼

Y

-

Y

검색된 정보가 없는 경우, 오류를 발생시키는 대신 크기가 0인 배열을 반환합니다.

- On: 검색된 정보가 없는 경우 크기가 0인 배열을 반환합니다.

- Off: 검색된 정보가 없는 경우 오류 발생시킵니다.

N

[USER] Type

콤보박스

Y

-

Y

사용자 ID 또는 이메일 등 검색 시 사용할 타입을 선택합니다.

N

[USER] Search

문자

Y

-

N

검색할 사용자 ID 또는 이메일을 입력합니다.

Y

MORE OPTIONS

-

-

-

-


Y

DESCRIPTION

-

-

-

-


활용 예시

Knox Portal에서 사용자 정보를 검색한 후 그 결과를 메시지 박스로 출력합니다.

GetUserInfo 활용 예시

예제 파일

사용된 변수

사용된 속성

연관/유사 액티비티

GetDeptInfo

GetDeptInfo

GetDeptInfo

개요

KnoxPortal ID 또는 메일주소를 이용해 임직원의 부서정보를 가져옵니다.

사용 절차

  1. [Output] Department Info에 가져온 부서 정보를 저장할 변수를 입력하세요.

  2. Allow NoResult에 검색된 정보가 없는 경우에 오류를 발생시킬지, 크기가 0인 배열을 반환할지 선택하세요.

  3. Type에 검색 조건 타입을 선택하세요.

  4. Search에 검색할 사용자 ID 또는 이메일 주소를 입력하세요.

카드 출력 속성

카드 속성

속성

리턴타입

리턴 추가설명

설명

결과 예시

Department Info

1차원배열

class (부서 정보)

  • DepName (부서명)

  • EngDeptName (영어 부서명)

  • DeptCode (부서 코드)

  • HighDeptName (상위 부서명)

  • EngHighDeptName (영어 상위 부서명)

  • HighDeptCode (상위 부서 코드)

  • Company (회사명)

  • EngCompany (영어 회사명)

  • ManagerId (부서장 Knox ID)

  • ManagerName (부서장 이름)

검색 조건에 맞는 부서 정보 객체의 목록을 반환합니다.

[

{

Department : 'Brity RPA 개발그룹',

EngDepartment : 'Brity RPA Dvelopment Group',

DeptCode : 'XXXXXX',

HighDeptName : '개발팀',

EngHighDeptName : 'Development Team',

HightDeptCode : 'XXXXXX',

Company : '삼성SDS',

EngCompany : 'SAMSUNG SDS',

ManagerId : 'xxxxxx.xxx',

ManagerName : 'XXX'

}

,...

]

카드 입력 속성

GetDeptInfo 카드 속성

공통여부

속성

유형

필수여부

단위

자동입력여부

설명

N

Allow NoResult

토글버튼

Y

-

Y

검색된 정보가 없는 경우, 오류를 발생시키는 대신 크기가 0인 배열을 반환합니다.

- On: 검색된 정보가 없는 경우 크기가 0인 배열을 반환합니다.

- Off: 검색된 정보가 없는 경우 오류 발생시킵니다.

N

[USER] Type

콤보박스

Y

-

Y

사용자 ID 또는 이메일 등 검색 시 사용할 타입을 선택합니다.

N

[USER] Search

문자

Y

-

N

검색할 사용자 ID 또는 이메일을 입력합니다.

Y

MORE OPTIONS

-

-

-

-


Y

DESCRIPTION

-

-

-

-


활용 예시

Knox Portal에서 사용자의 부서 정보를 검색한 후 그 결과를 메시지 박스로 출력합니다.

GetDeptInfo 활용 예시

예제 파일

사용된 변수

사용된 속성

연관/유사 액티비티

GetUserInfo

GetCalendarList

GetCalendarList

개요

KnoxPortal PIMS 일정에 있는 캘린더목록을 가져옵니다.

사용 절차

  1. [Output] CalendarList에 검색된 일정 캘린더목록을 저장할 변수를 입력하세요.

  2. Type에 검색 조건 타입을 선택하세요.

  3. Search에 검색할 사용자 ID 또는 이메일 주소를 입력하세요.

카드 출력 속성

카드 속성

속성

리턴타입

리턴 추가설명

설명

결과 예시

Calendar List

1차원배열

Dictionary<string, object>

캘린더 목록 배열을 반환합니다.

[

{

'defaultYn' : 'N',

'displayType' : 'VISIBLE',

color = '#98d24d',

...

}

,...

]

카드 입력 속성

CreateSchedule 카드 속성

공통여부

속성

유형

필수여부

단위

자동입력여부

설명

N

[PIMS] Type

콤보박스

Y

-

Y

사용자 ID 또는 이메일 등 검색 시 사용할 타입을 지정합니다.

N

[PIMS] Search

문자

Y

-

N

일정 등록할 사용자 ID 또는 이메일을 입력합니다.

Y

MORE OPTIONS

-

-

-

-


Y

DESCRIPTION

-

-

-

-


활용 예시

Knox Portal에서 지정한 사용자의 Calendar 목록을 가져와서 메시지박스로 정보를 출력합니다.

DeleteSchedule 활용 예시

예제 파일

사용된 변수

사용된 속성

CreateSchedule

CreateSchedule

개요

KnoxPortal PIMS 일정을 생성합니다. 일정 생성에 성공하면 일정 ID가 반환됩니다.

사용 절차

  1. [Output] Schedule에 생성한 일정 정보를 저장할 변수를 입력하세요.

  2. Type에 검색 조건 타입을 선택하세요.

  3. Search에 검색할 사용자 ID 또는 이메일 주소를 입력하세요.

  4. PIMS 그룹 속성에 등록할 일정의 제목, 내용, 장소, 시작 시간, 종료 시간 등을 설정하세요.

카드 속성

CreateSchedule 카드 속성

공통여부

속성

유형

필수여부

단위

자동입력여부

설명

N

[Output] Schedule ID

변수

N

-

Y

생성된 일정의 ID를 저장할 변수를 지정합니다.

N

[PIMS] Type

콤보박스

Y

-

Y

사용자 ID 또는 이메일 등 검색 시 사용할 타입을 지정합니다.

N

[PIMS] Search

문자

Y

-

N

일정 등록할 사용자 ID 또는 이메일을 입력합니다.

N

[PIMS] Subject

문자

Y

-

N

일정 제목을 입력합니다.

N

[PIMS] Contents

문자

N

-

N

내용을 입력합니다.

N

[PIMS] Place

문자

N

-

N

장소를 입력합니다.

N

[PIMS] StartTime

문자

Y

-

Y

시작 시간을 입력합니다.

N

[PIMS] EndTime

문자

Y

-

Y

종료 시간을 입력합니다.

N

[PIMS] IsAllDay

토글버튼

Y

-

Y

일정을 하루종일로 지정할지 선택합니다.

Y

MORE OPTIONS

-

-

-

-


Y

DESCRIPTION

-

-

-

-


활용 예시

Knox Portal에서 지정한 사용자의 일정을 등록한 후 그 결과를 메시지 박스로 출력합니다.

CreateSchedule 활용 예시

예제 파일

사용된 변수

사용된 속성

연관/유사 액티비티

DeleteSchedule, GetScheduleInfo

DeleteSchedule

DeleteSchedule

개요

KnoxPortal PIMS 일정을 삭제합니다. 삭제할 일정 ID와 사용자 ID가 필요합니다.

사용 절차

  1. Type에 검색 조건 타입을 선택하세요.

  2. Search에 검색할 사용자 ID 또는 이메일 주소를 입력하세요.

  3. Schedule ID에 삭제할 일정 ID를 입력하세요.

카드 속성

DeleteSchedule 카드 속성

공통여부

속성

유형

필수여부

단위

자동입력여부

설명

N

[PIMS] Type

콤보박스

Y

-

Y

사용자 ID 또는 이메일 등 검색 시 사용할 타입을 지정합니다.

N

[PIMS] Search

문자

Y

-

N

일정 삭제할 사용자 ID 또는 이메일을 입력합니다.

N

[PIMS] Schedule ID

문자

Y

-

N

삭제할 일정 ID를 입력합니다.

Y

MORE OPTIONS

-

-

-

-


Y

DESCRIPTION

-

-

-

-


활용 예시

Knox Portal에서 지정한 사용자의 일정을 조회한 후 그 결과를 메시지 박스로 출력합니다. 이후 해당 일정을 삭제합니다.

DeleteSchedule 활용 예시

예제 파일

사용된 변수

사용된 속성

연관/유사 액티비티

CreateSchedule, GetScheduleInfo

GetSchedulesInfo

GetSchedulesInfo

개요

지정한 사용자의 KnoxPortal 일정을 조회하여 일정 정보를 배열 변수로 반환합니다.

사용 절차

  1. [Output] Result에 조회한 일정 정보를 저장할 배열 변수를 입력하세요.

  2. Type에 검색 조건 타입을 선택하세요.

  3. Search에 검색할 사용자 ID 또는 이메일 주소를 입력하세요.

  4. Start TimeEnd Time에 일정을 조회할 시작 시간과 종료 시간을 입력하세요.

카드 출력 속성

카드 속성

속성

리턴타입

리턴 추가설명

설명

결과 예시

Schedule Info

1차원배열

class (일정 정보)

  • ScheduleId (스케줄 ID)

  • Subject (일정 제목)

  • Contents (일정 내용)

  • StartTime (시작 시각)

  • EndTiem (종료 시각)

  • AllDayYn (하루 종일)

  • Place (장소)

  • Attendees (참석자)

조회한 일정 정보를 반환합니다.

[

{

SchduleId : 'XXX',

Subject : 'Brity Works 교육',

Contents : 'Brity Works 교육',

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

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

AllDayYn : 'Y',

Place : '삼성 SDS',

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

}

,...

]

카드 입력 속성

GetScheduleInfo 카드 속성

공통여부

속성

유형

필수여부

단위

자동입력여부

설명

N

[PIMS] Type

콤보박스

Y

-

Y

사용자 ID 또는 이메일 등 검색 시 사용할 타입을 지정합니다.

N

[PIMS] Search

문자

Y

-

N

일정 조회할 사용자 ID 또는 이메일을 입력합니다.

N

[PIMS] StartTime

문자

Y

-

N

시작 시간을 입력합니다.

N

[PIMS] EndTime

문자

Y

-

N

종료 시간을 입력합니다.

Y

MORE OPTIONS

-

-

-

-


Y

DESCRIPTION

-

-

-

-


활용 예시

Knox Portal에서 신규 일정을 생성한 특정 사용자의 일정을 조회한 후 그 결과를 메시지 박스로 출력합니다. 이후 일정이 하나라도 있으면 Notepad 앱에 작성합니다.

GetScheduleInfo 활용 예시

예제 파일

사용된 변수

사용된 속성

연관/유사 액티비티

CreateSchedule, DeleteSchedule

SendKnoxMessage

SendKnoxMessage

개요

Konx 메신저로 메시지를 전달합니다. Orchestra 서버 연동이 필요한 항목이 있어 디자이너로 수행할 때는 시뮬레이션 결과 속성을 이용하여 동작됩니다. 서버 내보내기로 수행할 경우 메신저로 전달되는 것을 확인할 수 있습니다.

사용 절차

  1. [Output] Response에서 메시지 수신인의 응답 메시지를 저장할 변수를 입력하세요.

  2. Message Type에서 메시지 응답 대기 유형을 선택하세요.

  3. Receiver ID에 수신인 Knox ID를 입력하세요.

  4. Message에 상대방에게 보낼 메시지 내용을 입력하세요.

  5. Timeout(Sec)에 상대방의 응답을 기다릴 최대 시간을 초 단위로 입력하세요.

카드 속성

SendKnoxMessage 카드 속성

공통여부

속성

유형

필수여부

단위

자동입력여부

설명

N

[Output] Response

변수

N

-

Y

메시지 수신인의 응답 메시지를 저장할 변수를 선택합니다. Response Type에 따라 응답 메시지가 결정됩니다.

N

[KNOX MESSENGER] Message Type

콤보박스

Y

-

Y

메시지 전송 및 응답 대기 유형을 선택합니다. 선택된 유형에 따라 전송 방식과 Response의 내용이 결정됩니다.

N

[KNOX MESSENGER] Receiver ID

문자

Y

-

N

수신인의 Knox ID를 입력합니다. 세미콜론(;)으로 구분하여 Knox ID를 여러 개 입력할 수 있습니다.

N

[KNOX MESSENGER] Message

문자

Y

-

N

보낼 메시지 문자열을 입력합니다.

N

[KNOX MESSENGER] Items

문자

N

-

N

Message Type 이 Wait CustomItem 인 경우 추가로 설정하도록 표시되는 속성입니다. OK/Cancel과 같이 미리 정의된 목록이 아닌 사용자가 정의한 선택 목록을 전달할 수 있습니다. 전달할 목록은 ; 구분자를 이용하여 하나의 문자열로 입력합니다.

N

[KNOX MESSENGER] Path

문자

N

-

N

Message Type 이 No Wait (Image) 인 경우 추가로 설정하도록 표시되는 속성입니다. 이미지 파일의 경로를 입력하면 메신저로 이미지 파일을 전달할 수 있습니다. 이미지 파일은 jpg, jpeg, png, gif 포멧의 파일을 사용할 수 있습니다.

N

[KNOX MESSENGER] Timeout(Sec)

숫자

Y

Y

메신저 수신인의 응답에 대한 최대 대기 시간을 초 단위로 입력합니다.

Y

MORE OPTIONS

-

-

-

-


Y

DESCRIPTION

-

-

-

-


활용 예시

Knox Portal에서 지정한 사용자에게 메시지를 보내고 응답을 받습니다.

SendKnoxMessage 활용 예시

예제 파일

사용된 변수

사용된 속성

GetContactGroupList

GetContactGroupList

개요

KnoxPortal ID 를 이용해 PIMS에 저장된 연락처그룹 목록을 가져옵니다

사용 절차

  1. [Output] Group List에 가져온 연락처 그룹 리스트를 저장할 변수를 입력하세요.

  2. Knox ID에 검색할 사용자 ID를 입력하세요.

  3. PubType에서 연락처의 공개범위를 선택합니다(DEPARTMENT:부서공개, COMPANY:회사공개)

카드 입력 속성

GetUserInfo 카드 속성

공통여부

속성

유형

필수여부

단위

자동입력여부

설명

N

Scope of disclosure

콤보박스

N

-

Y

연락처의 공개 범위를 선택합니다

(DEPARTMENT:부서공개, COMPANY:회사공개)

N

Knox ID

문자

Y

-

N

검색할 사용자 ID를 입력합니다.

Y

MORE OPTIONS

-

-

-

-


Y

DESCRIPTION

-

-

-

-


활용 예시

Knox Portal에서 사용자의 연락처 목록을 검색한 후 그 결과를 메시지 박스로 출력합니다.

GetUserInfo 활용 예시

예제 파일

사용된 변수

사용된 속성

GetContactGroup

GetContactGroup

개요

KnoxPortal ID Group ID를 이용해 PIMS에 저장된 연락처그룹의 정보를 가져옵니다

사용 절차

  1. [Output] Group에 가져온 연락처 그룹 정보를 저장할 변수를 입력하세요.

  2. Knox ID에 검색할 사용자 ID를 입력하세요.

  3. OutputType에서 연락처 결과가 상세정보를 포함할지 메일정보만 나올지 선택합니다.

  4. Group ID에 검색할 연락처 그룹ID를 입력합니다.

카드 입력 속성

GetUserInfo 카드 속성

공통여부

속성

유형

필수여부

단위

자동입력여부

설명

N

OutputType

콤보박스

N

-

Y

연락처 결과가 상세정보를 포함할지 메일정보만 나올지 선택합니다.

(DetailInfo:상세정보 포함, MailList:메일정보만)

N

Knox ID

문자

Y

-

N

검색할 사용자 ID를 입력합니다.

N

Group ID

문자

Y

-

N

검색할 연락처 그룹ID를 입력합니다.

Y

MORE OPTIONS

-

-

-

-


Y

DESCRIPTION

-

-

-

-


활용 예시

Knox Portal에서 사용자의 연락처 목록을 검색한 후 그중에서 Group ID를 선택해 해당 그룹의 정보를 검색합니다.

GetUserInfo 활용 예시

예제 파일

사용된 변수

사용된 속성

SearchContactGroup

SearchContactGroup

개요

KnoxPortal ID 공개범위, 그룹이름을 이용해 연락처 그룹의 상세정보를 가져옵니다.

사용 절차

  1. [Output] Group List에 가져온 연락처 그룹 정보를 저장할 변수를 입력하세요.

  2. Knox ID에 검색할 사용자 ID를 입력하세요.

  3. PubType에서 연락처의 공개범위를 선택합니다(DEPARTMENT:부서공개, COMPANY:회사공개)

  4. Group name에 검색할 연락처 그룹이름을 입력합니다.

카드 입력 속성

GetUserInfo 카드 속성

공통여부

속성

유형

필수여부

단위

자동입력여부

설명

N

Scope of disclosure

콤보박스

N

-

Y

연락처의 공개범위를 선택합니다

(DEPARTMENT:부서공개, COMPANY:회사공개)

N

Knox ID

문자

Y

-

N

검색할 사용자 ID를 입력합니다.

N

Group name

문자

Y

-

N

검색할 연락처 그룹이름를 입력합니다.

Y

MORE OPTIONS

-

-

-

-


Y

DESCRIPTION

-

-

-

-


활용 예시

Knox Portal에서 사용자의 연락처 목록에서 Group name검색해 해당 그룹의 정보를 가져옵니다.

GetUserInfo 활용 예시

예제 파일

사용된 변수

사용된 속성