OpenAPI 사양을 임포트하여 스포크 작성 및 작업 빌드
OpenAPI 사양을 임포트하여 통합을 자동화하고 재사용 가능한 작업을 생성합니다.
시작하기 전에
- 에서 ServiceNow Store스포크 생성기 앱을 설치합니다.
- Professional Pack 설치 프로그램(com.glide.hub.integrations.professional)이 설치되어 있고 라이센스에 권리가 부여되어 있는지 ServiceNow 통합 허브 확인합니다.
- 필요한 역할: 관리자
프로시저
- 다음으로 이동 모두 > 프로세스 자동화 > 워크플로우 스튜디오.
- Click 새로 생성 > 스포크.
-
스포크 정보 화면에서 스포크를 새 범위에서 생성할지 기존 범위에서 생성할지 지정합니다.
-
새 범위에서 스포크를 생성하도록 선택하는 경우 통합의 로고로 이미지를 선택하고 필드를 채웁니다.
여기에서는 Zoom과의 통합을 예로 들어 보겠습니다.
필드 설명 스포크 이름 사용자 지정 스포크를 식별하는 이름입니다. 설명 사용자 지정 스포크에 대한 설명입니다. 주:앱 범위 이름의 값은 x_<회사 코드>_<스포크 이름>_<스포크> 형식입니다. 기본적으로 <회사 코드>는 snc입니다. 시스템 속성glide.appcreator.company.code의 값을 구성하여 회사 코드를 구성할 수 있습니다.
이 구성된 값은 앱 범위 이름 값이 생성될 때 사용됩니다.
-
기존 범위에서 스포크를 생성하도록 선택하는 경우 통합의 로고로 이미지를 선택하고 필드를 채웁니다.
여기에서는 AWS와의 통합을 예로 들어 보겠습니다.
필드 설명 애플리케이션 이름 기존 애플리케이션 이름 또는 범위입니다. 앱 범위 이름 선택한 애플리케이션 이름을 기준으로 자동으로 채워지는 범위 이름입니다. 설명 사용자 지정 스포크에 대한 설명입니다.
-
새 범위에서 스포크를 생성하도록 선택하는 경우 통합의 로고로 이미지를 선택하고 필드를 채웁니다.
-
계속을 클릭합니다.
제공된 이름과 설명을 기준으로 스토어에 일치하는 스포크가 있으면 스포크 상세 정보가 표시됩니다.
-
스토어에서 세부 정보 보기를 클릭하여 일치하는 스포크의 세부 정보를 확인합니다.
일치하는 스포크의 상세 정보가 새 브라우저 탭에 표시됩니다.
-
스토어에서 스포크를 설치합니다.
자세한 내용은 Install a ServiceNow Store application 문서를 참조하십시오.
-
스포크를 설치한 후 탭으로 워크플로우 스튜디오 이동합니다.
스토어 에서 스포크를 설치했습니까?라는 메시지가 표시됩니다.
-
다음 옵션 중 하나를 선택하고 계속을 클릭합니다.
옵션 설명 예, 설치된 스포크를 볼 수 있습니다. 통합 아래의 스포크 대시보드로 리디렉션하는 옵션입니다. 아니요, 사용자 지정 스포크를 빌드합니다. 스포크 생성을 계속하는 옵션입니다. 아니요, 스포크 생성을 종료하고 싶습니다. 현재 탭을 닫는 옵션입니다.
-
스토어에서 세부 정보 보기를 클릭하여 일치하는 스포크의 세부 정보를 확인합니다.
-
사용자 지정 스포크를 빌드하려면 건너뛰기를 클릭합니다.
주:다음 단계는 아니요, 사용자 지정 스포크를 빌드하겠습니다. 옵션을 선택한 경우에도 적용할 수 있습니다.
스포크가 생성되고 확인 메시지가 표시됩니다.
-
빌드 정보 화면에서 스포크를 빌드할 방법을 선택합니다.
OpenAPI 사양 또는 Postman 컬렉션을 사용하여 스포크를 빌드하도록 선택할 수 있습니다.
-
OpenAPI 사양을 선택하고 계속을 클릭하여 OpenAPI 사양을 임포트합니다.
- OpenAPI 소스의 경우 새로 임포트를 클릭합니다.
-
새 OpenAPI 소스 임포트 화면에서 다음 두 단계 중 하나를 수행합니다.
-
URL을 사용하여 임포트하려면 임포트 방법으로URL에서 임포트를 선택하고 OpenAPI URL에 URL을 지정합니다.
-
JSON 또는 YAML 코드를 사용하여 수동으로 임포트하려면 임포트 메서드에 대해 수동으로 JSON 또는 YAML에서 임포트를 선택하고 JSON 또는 YAML로 코드를 제공합니다.
-
URL을 사용하여 임포트하려면 임포트 방법으로URL에서 임포트를 선택하고 OpenAPI URL에 URL을 지정합니다.
-
임포트를 클릭합니다.
OpenAPI 소스가 임포트됩니다.
- 연결 및 자격 증명 별칭에 대해 새로 만들기를 클릭합니다.
-
새 연결 및 자격 증명 별칭 생성 화면에서 필드에 내용을 입력하고 별칭 정보를 입력합니다.
필드 설명 연결 및 자격 증명 이름 연결 및 자격 증명 별칭 기록을 식별하는 이름입니다. 인증을 위한 구성 템플릿 이 통합에 필요한 인증 메커니즘입니다. 인증 메커니즘이 OpenAPI 소스와 호환되는지 확인합니다. 주:구성 템플릿은 사용자가 제공한 OpenAPI 사양에 따라 자동으로 채워집니다. 기본 옵션을 계속 사용하거나 요구 사항에 따라 변경할 수 있습니다. - 별칭 생성을 클릭하고 계속합니다.
-
같은 화면에서 필드에 내용을 입력하여 별칭을 구성합니다.
필드 설명 연결 정보 연결 이름 연결 기록을 식별하는 이름입니다. 연결 URL 외부 공급업체 인스턴스 또는 서버에 연결하기 위한 기본 URL입니다. 이 URL은 사용자가 제공한 OpenAPI 사양에 따라 자동으로 채워집니다. 자격 증명 정보 선택한 구성 템플릿에 따라 관련 자격 증명 필드가 표시됩니다. 자격 증명 기록을 구성하는 데 필요한 값을 제공합니다. 별칭 기록을 나중에 구성하려면 나중에 수행을 클릭합니다.
-
제출을 클릭합니다.
연결 별칭 기록이 생성됩니다.
-
작업 생성을 클릭합니다.
OpenAPI 사양을 사용하여 수행할 수 있는 모든 작업이 나열됩니다.
-
필요한 작업을 선택합니다.
검색 창에 필요한 용어를 입력하여 필요한 작업을 검색할 수 있습니다. 지정된 검색어와 일치하는 작업이 표시됩니다.
-
게시를 클릭합니다.
또는 초안으로 작업 저장 을 선택하여 작업을 초안으로 저장하고 요구 사항에 따라 수정한 후 나중에 게시할 수도 있습니다.
-
완료: 스포크로 이동하여 스포크 페이지로 이동하여 게시 상태를 확인합니다.
- OpenAPI 단계가 포함된 작업이 생성됩니다. OpenAPI 단계에 대한 자세한 내용은 다음 문서를 참조하십시오 OpenAPI support in the REST step.
- 작업 입력과 출력이 매핑됩니다.
- 작업은 스포크 상세 페이지의 아래에서 게시되고 나열됩니다. 작업 > 게시됨.
이러한 게시된 작업을 사용하여 요구 사항에 따라 플로우와 하위 플로우를 생성할 수 있습니다.
- 초안으로 작업을 저장한 경우 아래의 스포크 상세 페이지에서 이러한 초안 작업에 액세스할 수 있습니다. 작업 > 초안.
- 스포크 활동에 대한 런타임 정보를 보려면 스포크 세부 정보 페이지에서 스포크 활동 로그 를 클릭합니다. 스포크 활동이 수행될 때마다 시스템은 해당 정보를 스포크 활동 로그로 생성합니다. 활동 로그를 보려면 필요한 번호 를 클릭합니다. 스포크 활동 로그의 모든 운영에는 다음 상태 값 중 하나가 있습니다.
상태 설명 신규 작업에 대한 이벤트가 생성되고 이 작업이 곧 실행됩니다. 오류 운영을 실행하지 못했습니다. 처리 중 작업 실행이 진행 중입니다. 성공 작업이 성공적으로 실행되었습니다.
스포크 상세 페이지에서 플로우와 하위 플로우를 생성하여 통합에 사용할 수 있습니다. 자세한 내용은 플로우 구축 및 하위 플로우 빌드 중 문서를 참조하십시오.
스포크 활동 로그와 함께 스포크 상세 페이지에서 사용 가능한 플로우, 하위 플로우 및 작업에 대한 상세 정보를 볼 수도 있습니다.