커넥터 배포
커넥터를 로컬로 작성하고 테스트한 후에는 이를 ThingWorx Flow의 온프레미스 테스트 인스턴스에 배포할 수 있습니다. 커넥터를 ThingWorx Flow 서버에 배포하려면 다음 단계를 수행합니다.
1. 커넥터 프로젝트에서 npm install 명령을 실행합니다.
이렇게 하면 커넥터에 필요한 모든 패키지가 설치됩니다.
2. 명령 프롬프트를 시작하고 다음 명령을 실행합니다.
flow-deploy connector -s <커넥터 프로젝트의 루트 디렉터리> -t <ThingWorx Flow 설치 디렉터리>
이 명령은 다음 작업을 수행합니다.
a. 아티팩트 메타데이터를 데이터베이스 로드 파일에 복사합니다.
b. 아이콘을 런타임 위치에 배포합니다.
c. 커넥터 코드를 커넥터의 런타임 위치에 복사합니다.
3. 배포된 아티팩트 메타데이터를 ThingWorx Flow에 로드하려면 다음 명령을 실행합니다.
flow-deploy migrate
4. > > 로 이동하여 ThingWorx Flow 서비스를 재시작합니다.
커넥터의 연결, 작업 및 트리거를 사용하여 흐름을 작성할 수 있어야 합니다.
flow-deploy
flow-deploy 명령에는 다음 하위 명령이 포함됩니다.
 |
ThingWorx Composer에서
WorkflowSubsystem의 OAuth 서비스를 사용하여 OAuth를 로드하거나 삭제하는 것이 좋습니다.
|
flow-deploy의 모든 하위 명령은 다음 매개 변수를 수락합니다.
|
매개 변수
|
설명
|
데이터 유형
|
|---|---|---|
|
--log,-l
|
로그 수준을 설정합니다.
|
[문자열] [기본값: "info"]
|
|
--version
|
ThingWorx Flow Deploy Utility의 버전 번호를 표시합니다.
|
[부울]
|
|
--help
|
다양한 명령, 하위 명령 및 명령에 제공할 수 있는 매개 변수에 대한 도움말을 표시합니다.
|
[부울]
|
flow-deploy about
ThingWorx Flow Deploy Utility의 버전 정보를 인쇄합니다. flow-deploy about 명령의 명령 구문 및 출력은 다음과 같습니다.
flow-deploy about
ThingWorx Flow Deploy Utility, Version :1.0.2
flow-deploy connector
사용자 정의 커넥터 패키지를 ThingWorx Flow 설치 디렉터리에 배포한 다음 연결, 작업 등의 사용자 정의 커넥터 아티팩트에 대한 메타데이터를 포함하도록 로드 스크립트를 업데이트합니다.
flow-deploy connector 명령은 다음 매개 변수를 수락합니다.
|
매개 변수
|
설명
|
데이터 유형
|
|---|---|---|
|
--sourceDir,-s
(필수)
|
사용자 정의 커넥터 프로젝트의 루트 디렉터리입니다.
|
[문자열]
|
|
--targetDir,-t
(필수)
|
ThingWorx Flow 설치 디렉터리이며 기본 위치는 C:\ThingWorxOrchestration입니다.
|
[문자열]
|
|
--allow_schema_overwrite
|
flow-deploy 도구는 기존 작업, 연결 및 트리거의 메타데이터 JSON 파일에 있는 입력 및 출력 스키마 속성을 덮어쓸 수 없습니다. 덮어쓴다면 이전 스키마를 사용하여 작성된 흐름이 끊어집니다. 그러나 개발 중에는 입력 및 출력 스키마 속성을 덮어쓸 수 있습니다. 커넥터 프로젝트의 새 스키마로 기존 스키마를 덮어쓰려면 이 플래그를 설정합니다.
|
-
|
flow-deploy connector 명령의 구문은 다음과 같습니다.
flow-deploy connector --sourceDir <커넥터 프로젝트의 루트 디렉터리> --targetDir <ThingWorx Flow 설치 디렉터리>
flow-deploy migrate
이 명령은 커넥터 메타데이터를 ThingWorx Flow 서버에 로드합니다.
flow-deploy migrate 명령은 다음 매개 변수를 수락합니다.
|
매개 변수
|
설명
|
데이터 유형
|
|---|---|---|
|
--sourceDir,-s
(필수)
|
ThingWorx Flow 설치 디렉터리이며 기본 위치는 C:\ThingWorxOrchestration입니다.
|
[문자열]
|
|
--Database username, -u
(필수)
|
ThingWorx Flow 데이터베이스에 대한 사용자 이름입니다.
|
[문자열]
|
|
--Database password, -p
(필수)
|
ThingWorx Flow 데이터베이스에 대한 암호입니다.
|
-
|
flow-deploy migrate 명령의 구문은 다음과 같습니다.
flow-deploy migrate --sourceDir <ThingWorx Flow 설치 디렉터리> -u <ThingWorx Flow 데이터베이스에 대한 사용자 이름> -p <ThingWorx Flow 데이터베이스에 대한 암호>
flow-deploy oauths
이 명령을 사용하여 OAuth 구성 작업을 수행할 수 있습니다. 이 명령에는 두 개의 하위 명령이 포함됩니다.
|
|
ThingWorx Composer에서
WorkflowSubsystem의 OAuth 서비스를 사용하여 OAuth를 로드하거나 삭제하는 것이 좋습니다.
|
다음은 flow-deploy oauths 명령의 모든 하위 명령에서 공통적으로 사용되는 매개 변수입니다.
|
매개 변수
|
설명
|
데이터 유형
|
|---|---|---|
|
--username,-u
|
ThingWorx 관리자 사용자 이름
|
[문자열]
|
|
--password,-p
|
ThingWorx 관리자 암호
|
[문자열]
|
|
--app-key,-a
|
ThingWorx 응용 프로그램 키
|
[문자열]
|
|
--twx-url,-t
|
https://<호스트 이름:포트>/Thingworx 형식의 ThingWorx 기본 URL입니다.
|
[문자열]
|
flow-deploy oauths load
이 명령은 OAauth 구성을 ThingWorx Flow의 실행 인스턴스에 업로드합니다.
커넥터에 대한 OAuth 로드에 대한 지침은
커넥터 OAuth 설정 구성을 참조하십시오.
flow-deploy oauths 명령의 모든 하위 명령에서 공통적으로 사용되는 매개 변수 외에도 이 명령은 다음 매개 변수를 수락합니다.
|
매개 변수
|
설명
|
데이터 유형
|
|---|---|---|
|
--file, -f
|
OAuth 구성 데이터 파일의 이름입니다.
|
[문자열]
|
flow-deploy oauths load 명령의 구문은 다음과 같습니다.
flow-deploy oauths load -u <ThingWorx 관리자 사용자 이름> -p '<ThingWorx 관리자 암호>' --twx-url <ThingWorx 기본 URL> -f <OAuth 구성 파일의 경로>
여기서 <ThingWorx 기본 URL>은 https://<호스트 이름:포트>/Thingworx 형식이어야 합니다.
flow-deploy oauths delete
이 명령은 기존 구성을 ThingWorx Flow에서 삭제하는 데 사용됩니다. OAuth 구성을 삭제하는 경우 흐름에서 연결을 다시 만들어야 합니다.
flow-deploy oauths 명령의 모든 하위 명령에서 공통적으로 사용되는 매개 변수 외에도 이 명령은 다음 매개 변수를 수락합니다.
|
매개 변수
|
설명
|
데이터 유형
|
|---|---|---|
|
--name, -n
(필수)
|
커넥터의 이름입니다. 이 이름은 OAuth 구성 파일에서 사용할 수 있습니다.
|
[문자열]
|
|
--title
(필수)
|
OAuth 공급자의 제목입니다. 이 제목은 OAuth 구성 파일에서 사용할 수 있습니다.
|
[문자열]
|
flow-deploy oauths delete 명령의 구문은 다음과 같습니다.
flow-deploy oauths delete -u <ThingWorx 관리자 사용자 이름> -p '<ThingWorx 관리자 암호>' --twx-url <ThingWorx 기본 URL> -n <커넥터의 이름> --title <OAuth 공급자의 제목>
여기서 <ThingWorx 기본 URL>은 https://<호스트 이름:포트>/Thingworx 형식이어야 합니다.
예를 들어 제목이 'box'인 'box' 커넥터에 대한 OAuth를 삭제하려면 다음 명령을 실행합니다.
flow-deploy oauths delete -u <ThingWorx 관리자 사용자 이름> -p '<ThingWorx 관리자 암호>' --twx-url <ThingWorx 기본 URL> -n box --title Box
여기서 <ThingWorx 기본 URL>은 https://<호스트 이름:포트>/Thingworx 형식이어야 합니다.
flow-deploy settings
단일 커넥터에 대해 여러 테넌트를 구성할 수 있습니다. 이 명령을 사용하면 특정 ThingWorx Flow 서버에 대한 일부 설정의 사용자 정의를 허용함으로써 커넥터의 동작을 업데이트할 수 있습니다. 이 명령에는 다음 하위 명령이 포함됩니다.
다음은 flow-deploy settings 명령의 모든 하위 명령에서 공통적으로 사용되는 매개 변수입니다.
|
매개 변수
|
설명
|
데이터 유형
|
|---|---|---|
|
--username,-u
|
ThingWorx 관리자 사용자 이름
|
[문자열]
|
|
--password,-p
|
ThingWorx 관리자 암호
|
[문자열]
|
|
--app-key,-a
|
ThingWorx 응용 프로그램 키
|
[문자열]
|
|
--twx-url,-t
|
https://<호스트 이름:포트>/Thingworx 형식의 ThingWorx 기본 URL입니다.
|
[문자열]
|
|
--connector,-c
|
커넥터 이름
|
[문자열]
|
|
--file,-f
|
커넥터 설정 파일 경로
|
[문자열]
|
|
--systemid,-s
|
사용자 정의 시스템 ID
|
[문자열]
|
|
--default, -d
|
기본 시스템 ID
|
[문자열]
|
flow-deploy settings download
ThingWorx Flow의 실행 인스턴스에서 커넥터 설정을 다운로드합니다.
예를 들어 ThingWorx Flow 서버의 지정한 커넥터에 대한 구성 설정을 다운로드하려면 다음 명령을 실행합니다.
flow-deploy settings download -f <커넥터 설정 파일의 경로> -t <ThingWorx 기본 URL> -u <ThingWorx 관리자 사용자 이름> -p '<ThingWorx 관리자 암호>' -c <커넥터 이름> -s <사용자 정의 시스템 ID>
flow-deploy settings file-download
ThingWorx Flow의 실행 인스턴스에서 파일을 다운로드합니다.
flow-deploy settings 명령의 모든 하위 명령에서 공통적으로 사용되는 매개 변수 외에도 이 명령은 다음 매개 변수를 수락합니다.
|
매개 변수
|
설명
|
데이터 유형
|
|---|---|---|
|
--fileId
|
업로드할 파일의 파일 ID입니다. 이 이름은 커넥터 설정 정의 파일에서 사용할 수 있습니다.
|
[문자열]
|
flow-deploy settings file-download 명령의 구문은 다음과 같습니다.
flow-deploy settings file-download -f <사용자 정의 파일의 경로> -t < ThingWorx 기본 URL> -u <ThingWorx 관리자 사용자 이름> -p '<ThingWorx 관리자 암호>' -c <커넥터 이름> -s <사용자 정의 시스템 ID> –fileID <업로드할 파일의 ID>
flow-deploy settings upload
커넥터 설정을 ThingWorx Flow의 실행 인스턴스에 업로드합니다.
|
|
이 명령을 실행하기 전에 구성 설정 JSON 파일을 만들고 -f 매개 변수를 사용하여 이 파일의 경로를 제공하십시오. 이 파일의 설정이 스키마와 일치하면 설정이 성공적으로 업로드되고 그렇지 않으면 필요한 스키마를 제공하는 오류 메시지가 나타납니다.
|
다음과 같은 예를 고려해 보십시오.
◦ 사용자 정의 시스템 ID를 가진 지정된 커넥터에 대해 ThingWorx Flow 서버에 설정을 업로드하려면 다음 명령을 실행합니다.
flow-deploy settings upload -f <커넥터 설정 파일의 경로> -t <ThingWorx 기본 URL> -u <ThingWorx 관리자 사용자 이름> -p '<ThingWorx 관리자 암호>' -c <커넥터 이름> -s <사용자 정의 시스템 ID>
◦ 기본 시스템 ID를 가진 지정된 커넥터에 대해 ThingWorx Flow 서버에 설정을 업로드하려면 다음 명령을 실행합니다.
flow-deploy settings upload -f <커넥터 설정 파일의 경로> -t <ThingWorx 기본 URL> -u <ThingWorx 관리자 사용자 이름> -p '<ThingWorx 관리자 암호>' -c <커넥터 이름> -d
flow-deploy settings file-upload
파일을 ThingWorx Flow의 실행 인스턴스에 업로드합니다.
flow-deploy settings 명령의 모든 하위 명령에서 공통적으로 사용되는 매개 변수 외에도 이 명령은 다음 매개 변수를 수락합니다.
|
매개 변수
|
설명
|
데이터 유형
|
|---|---|---|
|
--fileId
|
업로드할 파일의 파일 ID입니다. 이 이름은 커넥터 설정 정의 파일에서 사용할 수 있습니다.
|
[문자열]
|
|
--contentType
|
파일의 콘텐츠 유형입니다.
|
[문자열]
|
예: flow-deploy settings file-upload -f <사용자 정의 파일의 경로> -t <ThingWorx 기본 URL> -u <ThingWorx 관리자 사용자 이름> -p '<ThingWorx 관리자 암호>' -c <커넥터 이름> -s <사용자 정의 시스템 ID> –fileID <업로드할 파일의 ID> --contentType <콘텐츠 유형>