${solution_edition} ${last_modified} 매뉴얼버전 :

Transcription

1 ${solution_edition} ${last_modified} 매뉴얼버전 :

2 차례 차례 서문 ii iv 1. 개요 IPA 서버소개 IPA 서버구성요소 권장사양 2. 사전준비하기 3. 서버설치하기 설치파일준비하기 3.2 IPA 서버설치하기 서버 APP 패키지설치하기 웹포털패키지설치하기 DB 스키마생성하기 설치된서버확인하기 서비스관리하기 4.1 서비스시작하기 서비스시작하기 각모듈서비스시작하기 4.2 서비스상태확인하기 모든모듈서비스상태확인하기 서비스중지하기 모든모듈서비스중지하기 각모듈서비스중지하기 부록 A. tomcat 설치하기 부록 B. 부록 C. Java 설치하기 DBMS 설치하기 부록 D. Brity Works 연계가이드 D.1 각파라미터정의 D.2 프로세스카탈로그조회 (asset/api/v1/objects/type/process) D.3 프로세스실행 (/scheduler/api/v1/jobs) ii

3 차례 > D.4 프로세스수행결과전달방식 D.5 챗봇과 Brity Works 연계 iii

4 서문 법적고지사항 이매뉴얼을사용하기전에다음사항을읽어주십시오. 펴낸곳 삼성에스디에스주식회사 주소 서울특별시송파구올림픽로 35길 125 대표전화 전자메일 global.cs@samsung.com 홈페이지 이문서에서다루는내용은삼성에스디에스주식회사가제공하는신뢰할수있는정보입니다. 그러나부정확한내용이나오타로인해발생하는문제는삼성에스디에스주식회사에서책임지지않습니다. 이문서의내용과제품의사양은사전예고없이변경될수있습니다. 개정에관한상세한정보는삼성에스디에스주식회사의인터넷홈페이지 ( 에서확인할수있습니다. 이문서에대한저작권을포함한지식재산권은삼성에스디에스주식회사에있습니다. 삼성에스디에스주식회사의사전허가없이설명서내용의일부또는전부를무단사용하거나복제하는것은금지되어있으며, 이는삼성에스디에스주식회사의지식재산권침해에해당됩니다. Copyright Samsung SDS All rights reserved 사용대상 이매뉴얼은설치엔지니어를대상으로 Samsung SDS IPA( 이하 IPA) 솔루션의서버설치방법을설명합니다. 또한, 시스템운영자를대상으로 IPA 서버의실행및중지방법등을설명합니다. 설치엔지니어및시스템운영자가 IPA 서버운영환경을효과적으로구성하기위해서는다음과같은지식과경험이필요합니다. iv

5 서문 > 매뉴얼구성 시스템운영업무에대한기본적인지식 네트워크설정에대한기본적인지식 보안업무에대한기본적인지식 리눅스서버사용에대한기본적인지식 DB 운용및조작에대한기본적인지식 매뉴얼구성 이매뉴얼은다음과같은내용으로구성되어있습니다. 1장. 개요 IPA 서버의개요및설치환경을설명합니다. 2장. 사전준비하기 IPA 서버를설치하기전에필요한사전설치사항을설명합니다. 3장. 서버설치하기셸스크립트를사용하여 IPA 서버를설치하는방법을설명합니다. 4장. 서비스관리하기 IPA 서비스를시작하거나중지하고상태를확인하는방법을설명합니다. 부록 A. tomcat 설치하기 tomcat을설치하는방법을설명합니다. 부록 B. Java 설치하기 Java OpenJDK를설치하는방법을설명합니다부록 C. DBMS 설치하기 Maria DB를설치하는방법을설명합니다. 부록 D. Brity Works 연계가이드외부모듈인 Brity Works 연계를위한설정방법을설명합니다. v

6 서문 > 표기규약 표기규약 문서내용의이해를돕기위해다음과같은표기규약을사용합니다. 볼드체활자볼드체활자는그래픽유저인터페이스요소와메뉴와디렉토리등을표기할때사용합니다. 다만그래픽유저인터페이스중에서포털, 창, 팝업창, 마법사, 페이지는볼드체활자가아닌큰따옴표로표기합니다. 이탤릭체이탤릭체는사용자가입력해야하는변수나파라미터값을표기할때사용합니다. 고정폭활자고정폭활자는프로그래밍과관련된용어나코드를표기할때사용합니다. 본문에서언급할때는구분을위해명령어, 파라미터명, 레지스트리명, 스크립트명, 프로세스명등은고정폭활자볼드체로표기하고, 변수와파라미터값은고정폭활자이탤릭체로표기합니다. 부연설명및지침 제품을사용할때알아두면좋은팁이나예외사항, 제한사항등추가적인정보를제공할때 Note 를사용합니다. 프로젝트를생성하면자동으로빈프로세스가생성됩니다. 시스템, 데이터, 단말기등의손상가능성을알릴때 Attention 을사용합니다. 속성화면의입력값은실행시 JavaScript 로변환되므로 JavaScript 의문법에맞게입력해야합니다. 개정이력 솔루션버전매뉴얼버전매뉴얼변경일자매뉴얼변경사항 최초제정 vi

7 서문 > 개정이력 솔루션버전매뉴얼버전매뉴얼변경일자매뉴얼변경사항 vii

8 개요 > IPA 서버소개 1. 개요 IPA(Intelligent Process Automation) 는사람이수행하던표준화된업무를봇이대신처리하도록자동화하는솔루션입니다. 설치엔지니어및시스템운영자는 IPA 서버를설치하기전설치구조를개략적으로이해한후 IPA 서버의설치및관리방법을알수있습니다. " 개요 " 에서다루는내용은다음과같습니다. IPA 서버소개 IPA 서버구성요소 권장사양 1.1 IPA 서버소개 IPA 솔루션은 IPA Designer, IPA Bot, IPA 서버로구성되어있으며그구조는다음과같습니다. 이매뉴얼에서는 IPA 서버를설치하는방법을설명합니다. IPA 서버는서버모듈영역과 DB 영역으로구성되어 있습니다. 1

9 개요 > 권장사양 번호 항목 내용 1 서버모듈영역 총 7개모듈 (Administrator Portal, Asset, Authentication, Communication, API Gateway, Scheduler, Processflow) 2 DB 영역 서버관리 DB(Administrator Portal, Asset, Authentication, Scheduler) 1.2 IPA 서버구성요소 IPA 서버를설치하면총 7개의모듈이설치됩니다. 각모듈의역할은다음과같습니다. 모듈 모듈명 역할 Admin Portal admin 사용자, IPA Bot, IPA Designer의정보를등록하고모니터링합니다. Asset asset IPA Designer의프로젝트를관리합니다. Authentication auth 사용자의토큰을발급하고인증합니다. Communication comm IPA Bot 메시지를송수신하고 Job의실행, 중지, 결과및상태메시지를전달합니다. API Gateway gateway 요청한 URL의경로를설정하고허용합니다. Scheduler scheduler Job의일정을관리합니다. Processflow workflow 프로세스플로우를실행합니다. 1.3 권장사양 IPA 서버를설치하고실행하기위해권장되는하드웨어및소프트웨어사양은다음과같습니다. 항목 권장사양 CPU / 메모리 / 저장매체 x86 쿼드코어프로세서이상 / 16 GB RAM 이상 / HDD 300 GB 이상 OS Ubuntu Server LTS (64 bit) JRE Openjre 1.8 DBMS Maria DB 10.2 Browser Chrome 58 이상 2

10 사전준비하기 > 2. 사전준비하기 IPA 서버를설치하기전준비해야할사항을설명합니다. 사전에확인해야할사항은다음과같습니다. 순서 확인사항 1 서버관리자계정 IPA 서버설치시 sudo 권한이있는계정으로설치를진행해야합니다. IPA 솔루션은 3개의계정 (ipaadm, ipawas, ipadb) 생성을권장합니다. 2 JRE 설치여부 IPA 서버가설치될 OS 환경에 JRE가설치되어있어야합니다. 자세한내용은부록 B. Java 설치하기를참고하세요. 3 외부방화벽접근규칙공인망에서 IPA 서버로 8080, 8777, 9001 포트가허용되어있어야합니다. 4 내부방화벽접근규칙 IPA 서버에서 DBMS로 TCP/IP 4406 포트가허용되어있어야합니다. 5 libaio 설치여부 IPA DB가설치되는서버에는 libaio가설치되어있어야합니다. apt 설치명령어 : apt-get install libaio1 libaio-dev 3

11 서버설치하기 > 설치파일준비하기 3. 서버설치하기 IPA 서버를설치하고, 시작및중단하는방법을설명합니다. " 서버설치하기 " 에서다루는내용은다음과같습니다. 설치파일준비하기 서버설치하기 설치를위해다음의내용을순서대로진행합니다. 3.1 설치파일준비하기 IPA 서버를설치하기위한방법을설명합니다. 설치시배포되는파일목록은다음과같습니다. 파일 install.sh package.tgz Install_tomcat.sh rpa.war install_mariadb.sh /conf/createuser.sql /conf/initschema.sql /conf/mysqld.conf /conf/server.xml /conf/web.xml 내용 IPA 서버 APP 패키지설치스크립트 IPA 서버 APP 패키지파일 IPA 웹포탈패키지설치스크립트 IPA 웹포탈패키지 IPA Mariadb 설치스크립트 IPA DB 사용자생성 sql IPA 초기테이블스키마생성 sql DB 환경설정파일 tomcat 설정파일 tomcat 설정파일 해당파일들을각각설치할서버에업로드한후다음단계로이동하세요. WAS(tomcat 서버 ),DBMS(Maria DB) 는바이너리형태로다운로드스크립트와동일한위치에업로드 apache-tomcat tar.gz,mariadb linux-x86_64.tar.gz 4

12 서버설치하기 > IPA 서버설치하기 3.2 IPA 서버설치하기 IPA 서버는다음절차로설치를진행합니다. 서버 APP 패키지설치하기 IPA 서버설치파일 (install.sh) 을열어사용환경에맞게수정하고, 다음의명령어를입력하여서버에설치하세요. IPA 서버설치파일 (install.sh) 에서수정할수있는변수는다음과같습니다. vi install.sh #!/bin/sh ################################################## IPA_USER=ipaadm //ipa app 설치사용자 IPA_GROUP=ipaadm //ipa app 설치사용자그룹 INSTALL_PATH="/rpa" //ipa app 설치경로 GATEWAY_IP=" " //ipa 서버대표 IP app 서버를분리하지않는경우그대로둠 DB_IP=" " //ipa DB IP db 서버를분리하지않는경우그대로둠 DB_PORT=4406 //ipa DB 포트 PACKAGE_NAME="package" // 패키지파일이름 ################################################## 웹포털패키지설치하기 IPA 포털설치파일 (Install_tomcat.sh) 을열어환경에맞게수정한후아래의명령어를입력하여설치하세요. IPA 포털서버설치파일 (install_tomcat.sh) 에서수정할수있는변수는다음과같습니다. vi install_tomcat.sh #!/bin/sh ################################################# WAS_USER=ipawas //ipa 포탈사용자 WAS_GROUP=ipawas //ipa 포탈사용자그룹 5

13 서버설치하기 > IPA 서버설치하기 INSTALL_PATH="/rpa" //ipa 포탈설치경로 PACKAGE_NAME=apache-tomcat //tomcat 패키지이름 PACKAGE_FILE=apache-tomcat tar.gz //tomcat 패키지파일이름 ################################################# ipa$]./ Install_tomcat.sh DB 스키마생성하기 IPA DB 설치파일 (Install_mariadb.sh) 을열어환경에맞게수정한후아래의명령어를입력하여설치하세요. IPA DB 설치파일 (install_mariadb.sh) 에서수정할수있는변수는다음과같습니다. vi install_mariadb.sh #!/bin/sh ################################################# DB_USER=ipadb //ipa db 사용자 DB_GROUP=ipadb //ipa db 사용자그룹 DB_PORT=4406 //ipa db 포트 INSTALL_PATH="/rpa" //ipa db 설치경로 PACKAGE_NAME=mariadb linux-x86_64 //mariadb 패키지이름 PACKAGE_FILE=mariadb linux-x86_64.tar.gz //mariadb 패키지파일이름 DB_RPA_USERNAME=rpa DB_AUTH_USERNAME=auth DB_ASSET_USERNAME=asset DB_ADMIN_USERNAME=admin DB_SCHEDULER_USERNAME=scheduler DB_RPA_PASSWORD="rpa!23" DB_AUTH_PASSWORD="auth!23" DB_ASSET_PASSWORD="asset!23" DB_ADMIN_PASSWORD="admin!23" DB_SCHEDULER_PASSWORD="scheduler!23" DB_ROOT_PASSWORD='rpago!23' 6

14 서버설치하기 > IPA 서버설치하기 ################################################# ipa$]./install_mariadb.sh IPA 서버는 5 개 (asset, auth, rpa, stat, scheduler) 의스키마를사용합니다. 동일한이름의스키마가 mariadb 에존재하는경우다른 DB 서버에설치해야합니다. 설치된서버확인하기 설치가완료되면 /rpa 디렉토리로이동하여관련파일들이정상적으로생성되었는지확인하세요. 설치된서버의디렉토리정보는다음과같습니다. 디렉토리명 설명 /apps Asset, Authentication, Communication, Gateway, Scheduler, Processflow 등 IPA 서버가설치된디렉토리입니다. /certificate SSL 인증서, IPA 서버인증서가설치된디렉토리입니다. /logs IPA 서버, Admin Portal의로그가설치되는디렉토리입니다. /pkgs WAS와 DB 서버가설치되는디렉토리입니다. 7

15 서비스관리하기 > 서비스시작하기 4. 서비스관리하기 설치완료후 IPA 서비스를이용해서버를관리하는방법을설명합니다. 시스템운영자는서비스를시작및중지하고상태를확인하며 IPA 서버를더욱효율적으로운영할수있습니다. " 서비스관리하기 " 에서다루는내용은다음과같습니다. 서비스시작하기 서비스상태확인하기 서비스중지하기 4.1 서비스시작하기 IPA 서버관리방법을설명합니다. IPA 서버의개별서비스는모듈로구성되어있습니다. 관리명령어는모듈이름을지정하여실행할수있습니다. 개별모듈이름은 1.2 IPA 서버구성요소를참고하세요. 서비스시작하기 모든 IPA 서버모듈을실행하려면다음명령어를입력하세요. ipa$] /rpa/bin/run.sh // 전체서비스시작 8

16 서비스관리하기 > 서비스상태확인하기 각모듈서비스시작하기 IPA 서버모듈을각각실행하려면개별모듈이름을입력하세요. ipa$] /rpa/bin/run.sh 모듈이름 4.2 서비스상태확인하기 서비스를실행한후명령어를입력해 IPA 의서비스상태를확인할수있습니다. 모든모듈서비스상태확인하기 모든 IPA 서버모듈의상태를한번에확인하려면다음명령어를입력하세요. ~$ /rpa/bin/log.sh 모듈이름 4.3 서비스중지하기 서비스를실행한후명령어를입력해 IPA 서비스를중지할수있습니다. 모든모듈서비스중지하기 모든 IPA 서버모듈서비스를중지하려면다음명령어를입력하세요. ~$ /rpa/bin/stop.sh 9

17 서비스관리하기 > 서비스중지하기 각모듈서비스중지하기 IPA 서버모듈각각을중지하려면다음개별명령어를입력하세요. ~$ /rpa/bin/stop.sh 모듈이름 10

18 부록 A. tomcat 설치하기 IPA admin 서버를구동하기위해설치되는서버에 WAS(tomcat) 서버를설치합니다. 다음은 tomcat 8.5 버전을설치할때의예시입니다. 1. 설치파일 apache-tomcat tar.gz 을 /ipa/pkgs/tomcat/ 디렉토리에압축을해제하고, 아래의 명령어를입력하여소유자 (owner) 를 tomcat 전용계정 (ipawas) 으로변경하세요. ~$ cd /ipa/pkgs ~$ tar xvfz ~/apache-tomcat tar.gz ~$ mv apache-tomcat tomcat ~$ chown -R ipawas tomcat 2. 설정파일 /ipa/pkgs/tomcat/conf/server.xml 을다음과같이수정하세요. <Connector port="8080" scheme="https" secure="true" SSLEnabled="true" keystorefile="/ipa/certification/rpa_admin_server.jks" server="null" useserverciphersuitesorder="true" sslprotocol="tls" sslenabledprotocols="tlsv1,tlsv1.1,tlsv1.2" clientauth="false" ciphers="tls_ecdhe_rsa_with_aes_128_gcm_sha256, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_DHE_RSA_WITH_AES_128_GCM_SHA256, TLS_DHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_DHE_RSA_WITH_AES_128_CBC_SHA256, TLS_DHE_RSA_WITH_AES_128_CBC_SHA, TLS_DHE_RSA_WITH_AES_256_CBC_SHA256, TLS_DHE_RSA_WITH_AES_256_CBC_SHA, 11

19 tomcat 설치하기 > TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_GCM_SHA384, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_256_CBC_SHA, SSL_RSA_WITH_3DES_EDE_CBC_SHA" /> 3. 설정파일 /ipa/pkgs/tomcat/conf/server.xml 의 deploy director 와 access log directory 를다음과같이 설정하세요. <Engine name="catalina" defaulthost="admin"> <Host name="admin" appbase="/ipa/apps/admin" unpackwars="true" autodeploy="true"> <Context path="" docbase="." reloadable="true"/> <Valve classname="org.apache.catalina.valves.accesslogvalve" directory="/ipa/logs/admin" prefix="admin_access_log" suffix=".txt" pattern="%h %l %u %t "%r" %s %b" /> 4. /ipa/pkgs/tomcat/conf/logging.properties 설정의로그디렉토리위치를다음과같이변경하세요. ############################################################ # Handler specific properties. # Describes specific configuration info for Handlers. ############################################################ 1catalina.org.apache.juli.AsyncFileHandler.level = FINE #1catalina.org.apache.juli.AsyncFileHandler.directory = ${catalina.base}/logs 1catalina.org.apache.juli.AsyncFileHandler.directory = /ipa/logs/admin 1catalina.org.apache.juli.AsyncFileHandler.prefix = catalina. 1catalina.org.apache.juli.AsyncFileHandler.maxDays = 90 2localhost.org.apache.juli.AsyncFileHandler.level = FINE 2localhost.org.apache.juli.AsyncFileHandler.directory = /ipa/logs/admin 2localhost.org.apache.juli.AsyncFileHandler.prefix = localhost. 2localhost.org.apache.juli.AsyncFileHandler.maxDays = 90 3manager.org.apache.juli.AsyncFileHandler.level = FINE 3manager.org.apache.juli.AsyncFileHandler.directory = /ipa/logs/admin 3manager.org.apache.juli.AsyncFileHandler.prefix = manager. 3manager.org.apache.juli.AsyncFileHandler.maxDays = 90 12

20 tomcat 설치하기 > 4host-manager.org.apache.juli.AsyncFileHandler.level = FINE 4host-manager.org.apache.juli.AsyncFileHandler.directory = /ipa/logs/admin 4host-manager.org.apache.juli.AsyncFileHandler.prefix = host-manager. 4host-manager.org.apache.juli.AsyncFileHandler.maxDays = /ipa/pkgs/tomcat/bin/catalina.sh 를다음과같이변경하여 catalina.out 파일의위치를지정하세요. if [ -z "$CATALINA_OUT" ] ; then # CATALINA_OUT="$CATALINA_BASE"/logs/catalina.out CATALINA_OUT=/rpa/logs/admin/catalina.out fi 6. 아래의명령어를입력하여 /ipa/pkgs/tomcat/bin/setenv.sh 를다음과같이변경하세요. ipa$]cat setenv.sh export JAVA_OPTS="$JAVA_OPTS -Dspring.profiles.active=dev 13

21 부록 B. Java 설치하기 IPA 서버를구동하기위해설치되는서버에 OpenJDK 1.8 버전을설치합니다. 다음은 OpenJDK 1.8 버전을설치할때의예시입니다. 1. 아래명령어를입력하여 OpenJDK 1.8 을설치하세요. ~$ sudo apt-get install openjdk-8-jre 2. 아래명령어를입력하여기본 Java 환경을확인하고기본명령어로등록하세요 ~$ update-alternatives --config java 선택 경로 우선순위상태 /usr/lib/jvm/java-8-openjdk-amd64/jre/bin/java 1081 자동모드 *1 /usr/lib/jvm/java-8-openjdk-amd64/jre/bin/java 1081 수동모드 2 /usr/lib/jvm/java-8-oracle/jre/bin/java 1081 수동모드 Press <enter> to keep the current choice[*], or type selection number: 1 3. 아래명령어를입력하여 Java 가정상적으로설정되었는지확인하세요. ~$ java version 14

22 부록 C. DBMS 설치하기 IPA 솔루션은 Maria DB 10.2 버전을지원합니다. 다음은 mariadb 설치예시입니다. 1. mariadb 를설치하기위해서는 libaio 가필요합니다. 아래의명령어를입력하여 libaio 를설치하세요. ~$ apt-get install libaio1 libaio-dev 2. mariadb 파일을 /ipa/download 디렉토리에다운로드한후압축을해제하세요. ~$ tar xvfz /ipa/download/mariadb linux-x86_64.tar.gz 3. 압축을해제한파일을 /ipa/pkgs/mariadb 디렉토리로옮긴후 ipadb 계정에권한을부여하세요. ~$ mv /ipa/download/mariadb linux-x86_64 /ipa/pkgs/mariadb ~$ sudo chown -R ipadb /ipa/pkgs/mariadb 4. mariadb 의 log 가저장될디렉토리를생성한후 ipadb 계정에권한을부여하세요. ~$ mkdir /ipa/logs/maraidb ~$ sudo chown O+rx ipadb /ipa/logs/mariadb 5. mariadb 실행에필요한기본적인사용환경을설정하세요. ~$ mkdir /ipa/logs/maraidb/conf ~$ sudo chown ipadb /ipa/logs/mariadb/conf ~$ cp ~/mysql.conf /ipa/logs/mariadb/conf/ ~$ vi /ipa/logs/mariadb/conf/ /ipa/logs/maraidb/conf/mysld.conf port = 4406 default-character-set = utf8 15

23 DBMS 설치하기 > socket = /rpa/pkgs/mariadb/conf/mysqld.sock [mysqld] datadir = /rpa/pkgs/mariadb/data basedir = /rpa/pkgs/mariadb explicit_defaults_for_timestamp = 1 socket = /rpa/pkgs/mariadb/conf/mysqld.sock plugin_load=server_audit=server_audit.so;simple_password_check=simple_password_check.so server_audit_file_path = /ipa/logs/mariadb/server_audit.log server_audit_file_rotate_size = server_audit_events = CONNECT server_audit_logging = ON max_connections = 500 init_connect = SET collation_connection = utf8_general_ci init_connect = SET NAMES utf8 character-set-server = utf8 collation-server = utf8_general_ci lower_case_table_names = 0 user = ipadb port = 4406 pid-file = /ipa/pkgs/mariadb/conf/mysqld.pid log-output=file #general-log=1 #general_log_file=/rpa/logs/mariadb/mariadb.log slow-query-log=1 slow_query_log_file=/rpa/logs/mariadb/mariadb-slow.log long_query_time=30 log-error=/rpa/logs/mariadb/mariadb.err ## Time Zone Setting after install #default-time-zone='utc' [mysqldump] default-character-set = utf8 socket = /rpa/pkgs/mariadb/conf/mysqld.sock 16

24 DBMS 설치하기 > [mysql] 6. mysql_install_db 스크립트를실행해데이터디렉토리를생성하세요. ~$ /ipa/pkgs/mariadb/scripts/mysql_install_db - defaults-file=/ipa/pkgs/maridb/conf/mysqld.conf //mariadb daemon을 background로실행 ~$ /ipa/pkgs/maridb/bin/mysqld_safe defaults-file=/ipa/pkgs/mariadb/conf/mysld.conf& ~$ su ~$ /ipa/pkgs/mariadb/bin/mysqladmin password [ROOT 패스워드 ] S /ipa/pkgs/mariadb/conf/mysqld.sock 17

25 부록 D. Brity Works 연계가이드 Brity Works 는단일 Open API 규격을통해여러다른기종시스템들과직접연동할수있습니다. 연동포트클라우드서비스이용시방화벽설정의문제로 RPA API Gateway 서버포트만사용합니다. 전송방법클라이언트는 HTTP 및 HTTPS를 GET 방식또는 POST 방식을통해호출합니다. 외부연동시보안및인증규격 RPA Open API는인증정보및권한을확인합니다. 호출자의정보는사전에등록되어있어야합니다. 서버연계 : 서버용인증서를이용하여 RPA 시스템에서토큰을발급받습니다. 클라이언트연계 : RPA 시스템에서발급받은라이선스를이용하여토큰을발급받고인증을진행합니다. Java 사용시서버인증에필요한토큰을발급해주는라이브러리는별도로제공됩니다. D.1 각파라미터정의 프로세스를시작하는 API 의각파라미터정의는다음과같습니다. name: 이름을뜻하며파라미터를식별해주는 ID로도사용됩니다. expression: 챗봇등에서문장을작성할때사용할수있는한글명칭입니다. description: 파라미터에대한설명입니다. optional: "yes" 또는 "no" 의값을가지며 optional 혹은 mandatory 여부를지정합니다. type: JavaScript의기준으로 "Boolean", "Number", "String" 등이있습니다. 18

26 Brity Works 연계가이드 > 프로세스카탈로그조회 (asset/api/v1/objects/type/process) D.2 프로세스카탈로그 조회 (asset/api/v1/objects/type/process) 외부시스템에서 Brity Works 에등록된자동화프로세스목록을조회하고, 프로세스의 Input 파라미터및상세 정보를조회할수있습니다. 다음은카탈로그를조회하는 API 의예시입니다. 기능 API 방식요청사항 Input 파라미터 Output 파라미터 RPA 프로세스 /asset /api/v1/o GET process 없음 [{"filepath": "/a.dll","name": 카탈로그조회 bjects/type/pro 타입의 "testasset1","typename": cess 리스트를 "Asset", 조회합니 "id": ,"type": 다. 6,"category": "dll","version": "1.00", "desc": " 축하메일보내기 ", "inputs" : [{"name" : "sender","expression" : " 발신인 ","desc" : " 이메일을보내는 사람 ","optional" : "no","type" : "String"}, {"name" : "receiver","expression" : " 수신인 ","desc" : " 이메일을받는 사람 ", "optional" : "no","type" : "String"}, {"name" : "content","expression" : " 본문 ","desc" : " 메일 본문 ","optional" : "no","type" : "String"}], "outputs" : [{"name" : "result","expression" : " 발신 결과 ","desc" : " 이메일발신성공 여부 ","optional" : "no","type" : "Boolean"}]},] RPA 프로세스 /asset/api/v1/o GET process datetime= [ 카탈로그 bjects/type/pro 타입의 T17%3A20%3A30%2B09% { "outputs": "[]", 조회 ( 특정시점 cess/changed? 리스트를 3A00 "updatedatetime": 이후변경내용 ) datetime=[dat 조회합니 , etime String] 다. Format : YYYY-MM- "inputs": "[]", DDThh:mm:ssTZD "filepath": "park_3.proc", 19

27 Brity Works 연계가이드 > 프로세스실행 (/scheduler/api/v1/jobs) 기능 API 방식요청사항 Input 파라미터 Output 파라미터 (URL Encoding) "typename": "Process", "project": { "name": "Test_Ver1_0b", "id": "afec5113-d892-46d6-aae1-9cfad48178c9" }, "type": 2, "version": "1.80", "delyn": "Y", "ischanged": "Y", "name": "park_3", "id": "02f5a6ab-46bd-47ae-952 e-2b11aa2f2499", "activation": "Y", "category": "Process", "desc": "" } ] D.3 프로세스실행 (/scheduler/api/v1/jobs) 카탈로그조회를통해식별된자동화프로세스를원격봇이수행해줍니다. 식별된프로세스의 Input 파라미터에따라 필요한값을입력하고 RPA 자동화프로세스실행을요청합니다. 업무수행요청후결과는비동기로전송됩니다. 수행요청의결과및규격은다음과같습니다. 기능 API 방식요청사항 Input 파라미터 Output 파라미터 RPA 프로세스 /scheduler/api/ POST scheduler { [ {"jobid": 시작 v1/jobs 서버에 "jobtype":"1", "proc " f3bcef2-58d RPA 프로 essid":" e7a93", 세스를 3856", 즉시시작 "priority":"0", "resultcode": "SUCCESS" }] 하도록요 "userauthentication" 청합니다. :"{Brity Eco Token}", "jobparameter":"{ "sender" : joonwon7.lee@samsung.com, 20

28 Brity Works 연계가이드 > 프로세스수행결과전달방식 기능 API 방식 요청사항 Input 파라미터 Output 파라미터 "receiver" : sh.sun@s amsung.com, "content" : " 메일본문내용..." }" } D.4 프로세스수행결과전달방식 RPA 자동화프로세스의수행결과는아래 3 가지방식으로전달할수있습니다. 폴링 (Polling): RPA 프로세스결과조회 API를이용하여주기적으로결과를전달하는방식입니다. 콜백 (Callback): 외부시스템에서 RPA 프로세스실행요청시결과통지를받을 URL을함께전달하여결과를전달하는방식입니다. Custom: 외부시스템의변경이어려운경우 RPA 서버에서직접 API를호출하여결과를전달하는방식입니다. 챗봇연계시이방식을이용합니다. 프로세스시작시생성된 jobid 는이후에도계속사용되며, 프로세스결과를전달받는챗봇의 API 를 호출할때같이전달됩니다. 프로세스실행이끝난후생성된결과값은카탈로그에정의된양식에따라챗봇에게전달됩니다. D.5 챗봇과 Brity Works 연계 챗봇의사용자대화처리기능을이용해사용자가원하는업무내용을분석합니다. 또한 RPA 의업무자동화기능을 이용해 AI 로보틱스프로세스환경을구축할수있습니다. 순서단계내용연계 API 1 데이터수집 RPA 프로세스카탈로그조회를통해 대화생성및 RPA 프로세스를 계획합니다. 프로세스카탈로그조회 API(/asset /api/v1/objects/type/process) 2 파라미터수집챗봇대화진행을통해 RPA 프로세스실행에필요한 Input 21

29 Brity Works 연계가이드 > 챗봇과 Brity Works 연계 순서단계내용연계 API 파라미터를수집합니다. 3 자동화프로세스실행 RPA 자동화프로세스시작을요청합니다. 4 자동화프로세스결과전달 RPA 로부터자동화프로세스수행 결과를전달합니다. 프로세스실행 ( /scheduler/api/v1/jobs) 프로세스실행결과를 Custom 방식으로전달 22