기관 관리자는 특정 이벤트가 발생했을 때 알림을 받도록 ArcGIS Enterprise 배포용 웹후크를 구성할 수 있습니다. 기관 및 서비스 웹후크를 구성하는 방법은 다음 섹션에 나와 있습니다.
웹후크 생성을 위한 필수 구성 요소
웹후크를 생성하기 전에 다음을 검토하세요.
- 기관 웹후크를 사용하려면 기관에서 ArcGIS Enterprise 10.7 이후 버전을 사용 중이어야 합니다. 서비스 웹후크를 사용하려면 기관에서 ArcGIS Enterprise 11.0 이후 버전을 사용 중이어야 합니다.
- 기관 웹후크를 생성 및 관리하려면 관리자이거나 기본 Administrator 역할이 할당되어야 합니다.
- 서비스 웹후크를 생성 및 관리하려면 업데이트, 삭제, 보안 및 인프라 또는 서버 Administrator 권한이 할당되거나 기본 Administrator 역할이 할당되어야 합니다.
- 웹후크 수신기는 HTTPS를 통해 통신하도록 구성되어야 합니다. 수신기에 지원되는 몇 가지 옵션으로는 서드 파티 웹 서비스 수신기(Microsoft Power Automate, Zapier, IFFT), 사용자 설정 웹 서비스, ArcGIS Notebook Server, ArcGIS Workflow Manager 등이 있습니다. 사용자 설정 웹 서비스를 생성하거나 서드 파티 수신기를 사용하여 시작하는 방법에 대한 예시는 웹후크 저장소를 참고하세요. Notebook Server 및 Workflow Manager 웹후크 생성에 대한 자세한 내용은 ArcGIS Notebooks로 워크플로 자동화 및 웹후크로 작업 생성을 각각 참고하세요.
- 피처 서비스에 대한 웹후크를 구성하려면 서비스에 편집 기능이 포함되어야 하며 동기화 없이 변경 추적이 활성화되어 있어야 합니다.
- 지오프로세싱 서비스에 대한 웹후크를 구성하려면 서비스가 비동기식이어야 합니다.
비고:
이 릴리즈에서 서비스 웹후크는 베타 기능입니다. 베타 버전을 사용하는 동안 이러한 기능은 완전하지 않을 수 있고 알려진 성능 또는 품질 문제가 있을 수 있으며 Esri 기술지원에서 지원하지 않습니다. 서비스 웹후크의 베타 API 문서는 서비스 웹후크 관리자 API 가이드 PDF에서 확인할 수 있습니다. ArcGIS Enterprise의 베타 기능에 대한 자세한 내용은 베타 기능을 참고하세요.
기관 웹후크 생성
기관 웹후크를 사용하면 ArcGIS Enterprise portal 항목, 그룹, 사용자와 연결된 이벤트 트리거를 구독할 수 있습니다.
비고:
사용자, 그룹, 항목 관련 이벤트에 대한 웹후크를 생성하는 POST 요청 예시를 확인하려면 웹후크 생성 REST API 문서를 참고하세요.
기관 웹후크를 생성하려면 다음 단계를 따르세요.
- ArcGIS Portal Directory로 이동하여 Administrator 역할이 있는 구성원으로 로그인합니다.
웹후크는 관리자 또는 기본 Administrator 역할이 할당된 구성원만 생성 및 관리할 수 있습니다.
https://machine.domain.com/webadaptor/sharing/rest로그인하면 계정에 대한 사용자 리소스 페이지가 표시됩니다.
- 기관 ID 하이퍼링크를 클릭하거나 다음 형식을 요청하여 Portal Self 리소스 페이지에 접근합니다.
https://machine.domain.com/webadaptor/sharing/rest/portals/self - Self 리소스 페이지 하단으로 스크롤하고 웹후크 > 웹후크 생성을 클릭하여 웹후크 생성 작업에 접근합니다.
- 웹후크 생성 엔드포인트에서 다음 정보를 제공합니다.
- 이름 텍스트 상자에 웹후크의 고유한 이름을 입력합니다.
- 웹후크가 생성되는 동안 쿼리될 페이로드 URL 텍스트 상자에 웹후크 수신기의 페이로드 URL을 입력하여 수신기 및 ArcGIS Enterprise portal 간에 연결이 구성되도록 합니다.
페이로드 URL 예시는 다음과 같습니다.
https://app.logic.azure.com:443/workflows/b688528a36e246279dc050f936e5ebd4/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=nHP-LBo9x-nSgMi11DSDuwRIUiJr-8yKGCy7OYaT_ow - 필요에 따라 수신기로 웹후크 메시지를 인증하는 데 사용할 수 있는 웹후크 암호를 설정합니다. 암호(선택 사항) 텍스트 상자에 사용자 정의 영숫자 문자열을 입력합니다.
- 필요한 경우 구성 등록정보 텍스트 상자에 웹후크에 대한 비활성화 정보를 지정합니다.
기본 설정에 따라 웹후크가 5일 동안 5번의 오류가 발생하면 비활성화됩니다.
- 해당 웹후크를 트리거할 이벤트 아래에서 수동 정의 또는 모든 항목 보내기를 선택합니다.
- 수동으로 정의를 선택하여 이러한 쉼표로 구분된 이벤트에 대한 변경 사항 보내기 텍스트 상자에 해당 웹후크에 사용할 트리거 이벤트를 나열합니다. 예를 들어 기관의 특정 그룹과 관련된 모든 이벤트를 구독하려면 아래에 설명된 이벤트과 유사한 트리거 이벤트를 입력합니다. 여기서 [groupID]는 특정 그룹과 연결된 고유 ID를 나타냅니다.
/groups/[groupID]/update - 모든 항목 보내기를 선택하면 지원되는 모든 트리거 이벤트를 구독하게 됩니다. 발생하는 각 이벤트에 대한 알림을 받게 됩니다.
- 수동으로 정의를 선택하여 이러한 쉼표로 구분된 이벤트에 대한 변경 사항 보내기 텍스트 상자에 해당 웹후크에 사용할 트리거 이벤트를 나열합니다. 예를 들어 기관의 특정 그룹과 관련된 모든 이벤트를 구독하려면 아래에 설명된 이벤트과 유사한 트리거 이벤트를 입력합니다. 여기서 [groupID]는 특정 그룹과 연결된 고유 ID를 나타냅니다.
- 위의 매개변수가 구성되면 웹후크 생성을 클릭하여 요청을 제출합니다.
작업이 완료되면 새 웹후크가 기관에 추가됩니다.
기관 웹후크에 대한 고급 매개변수 구성
기관의 웹후크에 적용된 고급 설정을 사용하면 전달 시도 횟수, 알림 시간, 전달 시도 간격 지정과 같은 웹후크의 성능을 추가로 사용자 정의할 수 있습니다.
비고:
이러한 고급 등록정보를 구성하는 POST 요청 예시를 확인하려면 웹후크 설정 업데이트 REST API 문서를 참고하세요.
이러한 고급 등록정보를 설정하려면 다음을 수행합니다.
- ArcGIS Portal Directory로 이동하여 Administrator 역할이 있는 구성원으로 로그인합니다. 웹후크는 관리자 또는 기본 Administrator 역할이 할당된 구성원만 생성 및 관리할 수 있습니다.
https://machine.domain.com/webadaptor/sharing/rest로그인하면 계정에 대한 사용자 리소스 페이지가 표시됩니다.
- 기관 ID 하이퍼링크를 클릭하거나 다음 형식을 요청하여 Portal Self 리소스 페이지에 접근합니다.
https://machine.domain.com/webadaptor/sharing/rest/portals/self - Self 리소스 페이지 하단으로 스크롤하고 웹후크 > 설정 > 업데이트를 클릭하여 웹후크 설정 업데이트 작업에 접근합니다.
- 웹후크 설정 업데이트 엔드포인트에서 다음 정보를 제공합니다.
- 알림 시도 횟수 값을 설정합니다.
해당 값은 웹후크 페이로드를 전달하기 위해 시도할 횟수를 지정합니다. 기본 설정에 따라 ArcGIS Enterprise portal은 페이로드 전달을 3번 시도합니다. 시도 값은 0~5의 정수여야 합니다.
- 알림 시간 초과(초) 값을 설정합니다.
해당 값은 ArcGIS Enterprise portal이 수신기로부터 응답을 수신하기 위해 대기할 시간(초)을 지정합니다. 기본 설정에 따라 ArcGIS Enterprise portal은 10초 대기합니다. ArcGIS Enterprise portal이 대기할 시간(초) 값은 0~60초의 정수여야 합니다.
- 알림 경과 시간(초) 값을 설정합니다.
해당 값은 각 페이로드 전달 시도 간 시간(초)을 지정합니다. 기본 설정에 따라 ArcGIS Enterprise portal은 이전 시도가 실패한 경우 5초 후에 알림 시도 횟수에 지정된 시도 횟수에 도달할 때까지 다른 페이로드 전달을 시도합니다.
- 알림 시도 횟수 값을 설정합니다.
- 위의 매개변수가 구성되면 웹후크 설정 업데이트를 클릭하여 요청을 제출합니다.
작업이 완료되면 업데이트된 등록정보가 구성된 모든 기관 웹후크에 적용됩니다.
지오프로세싱 서비스 웹후크 생성
지오프로세싱 서비스 웹후크를 사용하면 지오프로세싱 서비스와 연결된 특정 이벤트 트리거를 구독할 수 있습니다.
비고:
지오프로세싱 서비스에 대한 웹후크를 생성하는 POST 요청 예시를 확인하려면 서비스 웹후크 관리자 API 가이드 PDF에서 웹후크 REST API 베타 문서를 참조하세요.
지오프로세싱 서비스 웹후크를 생성하려면 다음 단계를 따르세요.
- ArcGIS Server 관리자 디렉터리로 이동하여 적절한 관리 권한이 할당된 구성원으로 로그인합니다.웹후크는 업데이트, 삭제, 보안 및 인프라 또는 서버 Administrator 권한이 할당되었거나 기본 Administrator 역할이 할당된 관리자만 생성 및 관리할 수 있습니다.
https://machine.domain.com/webadaptor/admin - 로그인한 후 서비스 > [ServiceName] > 웹후크 > 생성을 클릭하여 지오프로세싱 서비스에 대한 웹후크 리소스로 이동합니다. 여기서 [ServiceName]은 웹후크가 생성될 서비스를 나타냅니다. 특정 폴더에 있는 서비스의 경우 서비스 > [FolderName] > [ServiceName] > 웹후크 > 생성을 클릭합니다. 여기서 [FolderName]은 서비스가 있는 폴더를 나타냅니다.
주의:
지오프로세싱 서비스에 대한 웹후크를 구성하려면 지오프로세싱 서비스가 비동기식이어야 합니다.
- 웹후크 생성 엔드포인트에서 다음 정보를 제공합니다.
- 이름 텍스트 상자에 웹후크의 고유한 이름을 입력합니다. 특수 문자를 사용하면 오류 응답이 발생하므로 영숫자 값만 이름에 입력할 수 있습니다.
- 필요에 따라 수신기로 웹후크 메시지를 인증하는 데 사용할 수 있는 웹후크 암호를 설정합니다. 서명 키 텍스트 상자에 사용자 정의 영숫자 문자열을 입력합니다.
- 웹후크가 생성되는 동안 쿼리될 후크 URL 텍스트 상자에 웹후크 수신기의 페이로드 URL을 입력하여 수신기 및 배포의 ArcGIS Server 간에 연결이 구성되도록 합니다. 페이로드 예시는 다음과 같습니다.
https://app.logic.azure.com:443/workflows/b688528a36e246279dc050f936e5ebd4/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=nHP-LBo9x-nSgMi11DSDuwRIUiJr-8yKGCy7OYaT_ow - 필요에 따라 미디어 유형을 지정합니다. 콘텐츠 유형 드롭다운 메뉴에서 다음 중 하나를 선택합니다.
- application/json(기본값)
- application/x-www-form-urlencoded
- 필요에 따라 페이로드 형식을 정의합니다. 페이로드 형식 드롭다운 메뉴에서 다음 중 하나를 선택합니다.
- JSON(기본값)
- PJSON
- 필요에 따라 활성 매개변수를 사용하여 웹후크가 트리거될 때 콜백을 비활성화 또는 활성화합니다. 활성화하려면 True를 선택합니다. 비활성화하려면 False를 선택합니다.
콜백이 기본 설정으로 활성화되어 있습니다.
- 위의 매개변수가 구성되면 생성을 클릭하여 요청을 제출합니다.
작업이 완료되면 새 웹후크가 특정 지오프로세싱 서비스에 적용됩니다.
비고:
기관 및 피처 서비스 웹후크와 달리 지오프로세싱 서비스 웹후크에는 사용자 정의 이벤트 트리거가 없습니다. 지오프로세싱 서비스 웹후크는 지오프로세싱 작업이 완료되면 페이로드를 전달합니다. 지오프로세싱 서비스를 위해 전달되는 페이로드에 대한 자세한 내용은 페이로드 항목을 참고하세요.피처 서비스 웹후크 생성
피처 서비스 웹후크를 사용하면 피처 서비스와 연결된 특정 이벤트 트리거를 구독할 수 있습니다.
비고:
피처 서비스에 대한 웹후크를 생성하는 POST 요청 예시를 확인하려면 서비스 웹후크 관리자 API 가이드 PDF에서 웹후크 REST API 베타 문서를 참조하세요.
피처 서비스 웹후크를 생성하려면 다음 단계를 따르세요.
- ArcGIS Server 관리자 디렉터리로 이동하여 적절한 관리 권한이 할당된 구성원으로 로그인합니다.
웹후크는 업데이트, 삭제, 보안 및 인프라 또는 서버 Administrator 권한이 할당되었거나 기본 Administrator 역할이 할당된 관리자만 생성 및 관리할 수 있습니다.
https://machine.domain.com/webadaptor/admin - 로그인한 후 서비스 > [ServiceName] > 웹후크 > 생성을 클릭하여 피처 서비스에 대한 웹후크 리소스로 이동합니다. 여기서 [ServiceName]은 웹후크가 생성될 서비스를 나타냅니다. 특정 폴더에 있는 서비스의 경우 서비스 > [FolderName] > [ServiceName] > 웹후크 > 생성을 클릭합니다. 여기서 [FolderName]은 서비스가 있는 폴더를 나타냅니다.
주의:
피처 서비스에 대한 웹후크를 구성하려면 피처 서비스에 편집 기능이 포함되어야 하며 동기화 없이 변경 추적이 활성화되어 있어야 합니다.
- 웹후크 생성 엔드포인트에서 다음 정보를 제공합니다.
- 이름 텍스트 상자에 웹후크의 고유한 이름을 입력합니다. 특수 문자를 사용하면 오류 응답이 발생하므로 영숫자 값만 이름에 입력할 수 있습니다.
- 유형 변경 텍스트 상자에 해당 웹후크에 사용할 이벤트 트리거를 나열합니다. 예를 들어, 피처 서비스가 생성될 때마다 웹후크를 호출하려면 다음 이벤트 트리거를 사용합니다.
예시
FeaturesCreated - 필요에 따라 수신기로 웹후크 메시지를 인증하는 데 사용할 수 있는 웹후크 암호를 설정합니다. 서명 키 텍스트 상자에 사용자 정의 영숫자 문자열을 입력합니다.
- 웹후크가 생성되는 동안 쿼리될 후크 URL 텍스트 상자에 웹후크 수신기의 페이로드 URL을 입력하여 수신기 및 배포의 ArcGIS Server 간에 연결이 구성되도록 합니다. 페이로드 예시는 다음과 같습니다.
https://app.logic.azure.com:443/workflows/b688528a36e246279dc050f936e5ebd4/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=nHP-LBo9x-nSgMi11DSDuwRIUiJr-8yKGCy7OYaT_ow - 필요에 따라 미디어 유형을 지정합니다. 콘텐츠 유형 드롭다운 메뉴에서 다음 중 하나를 선택합니다.
- application/json(기본값)
- application/x-www-form-urlencoded
- 필요에 따라 페이로드 형식을 정의합니다. 페이로드 형식 드롭다운 메뉴에서 다음 중 하나를 선택합니다.
- JSON(기본값)
- PJSON
- 필요에 따라 활성 매개변수를 사용하여 웹후크가 트리거될 때 콜백을 비활성화 또는 활성화합니다. 활성화하려면 True를 선택합니다. 비활성화하려면 False를 선택합니다.
콜백이 기본 설정으로 활성화되어 있습니다.
- 예약 텍스트 상자에서 초 정보를 수정하여 웹후크 예약을 조정합니다. 편집이 많은 피처 서비스의 경우 초 값을 낮추면 페이로드에 이벤트 정보가 적은 웹후크가 더 자주 수신됩니다. 자주 변경되지 않는 피처 서비스의 경우 초 등록정보 값을 높여 페이로드에 더 많은 이벤트 정보가 포함된 웹후크를 덜 자주 수신합니다.
예약의 최소(기본)값은 20초입니다.
- 위의 매개변수가 구성되면 생성을 클릭하여 요청을 제출합니다.
작업이 완료되면 새 웹후크가 특정 피처 서비스에 적용됩니다.