웹후크는 HTTP POST 요청을 사용하여 여러 응용프로그램 간에 콜백을 전달하도록 상호 작용할 수 있는 널리 지원되는 방법입니다. 자세한 내용은 웹후크에 대한 Wikipedia의 페이지를 참고하세요. 웹후크의 일반적인 용도로는 이메일 또는 SMS를 통한 알림 전송, 소셜 미디어에 메시지 게시, 스프레드시트에 레코드 자동 작성, 엔터프라이즈 데이터베이스 업데이트 등이 있습니다.
ArcGIS Survey123에서 현장조사 응답을 제출하면 웹후크를 설정하고 활성화할 수 있습니다. 예를 들어, 피처 레이어에 정보가 제출된 후 웹후크를 호출하여 알림 이메일 전송, 스프레드시트에 현장조사 콘텐츠 추가, 경고 전송 등의 다른 작업을 트리거할 수 있습니다.
사무실에 자체 웹후크 공급자가 있을 수 있지만Microsoft Power Automate, Make(이전 이름: Integromat), Zapier, tray.io 등 다양한 서드 파티 워크플로 서비스를 사용할 수 있습니다. 이러한 모든 서비스는 Survey123을 자동화된 프로세스로 통합하는 데 사용될 수 있습니다. 특히, Microsoft Power Automate와 Make에는 각각 빌트인 Survey123 커넥터가 있으므로 Survey123을 웹후크 워크플로에 최소한의 작업으로 통합할 수 있으며 Survey123 웹사이트에서 웹후크를 구성하거나 페이로드 URL을 입력할 필요가 없습니다.
주의:
현장조사의 웹후크를 생성하거나 수정한 경우 변경 내용이 적용되도록 하려면 Survey123 현장 앱에서 현장조사를 업데이트해야 합니다.
Survey123을 워크플로의 트리거로 사용할 수 있는 방법은 매우 많습니다. 다음 3개 섹션에서는 특정 값으로 답변되었던 질문을 포함한 응답을 전송한 경우 웹후크를 설정하여 알림 이메일을 보내는 방법을 보여줍니다.
이 주제의 끝 부분에는 웹후크 이벤트 페이로드에 사용할 수 있는 모든 등록정보가 참조용으로 나열됩니다.
Make에 웹후크 설정
Make(이전 이름: Integromat)는 온라인 자동화 플랫폼입니다. 시작하려면 무료 계정에 가입하세요. Make에는 이메일 알림에 첨부 파일을 포함하거나, 스프레드시트에 레코드를 추가하거나, 캘린더 항목을 생성하기 위한 시작점으로 사용할 수 있는 템플릿이 포함되어 있습니다.
- https://www.make.com/으로 이동하여 로그인합니다.
- 시나리오 페이지에서 새 시나리오 생성 버튼을 클릭합니다.
- 화면 중간의 모듈 아이콘을 클릭합니다. Survey123을 검색하여 선택합니다.
- 현장조사 보기 트리거 모듈을 선택합니다.
이 모듈은 현장조사 응답이 제출될 때마다 시나리오를 실행하도록 설계되었습니다.
현장조사 보기 모듈 구성에 도움이 되는 팝업이 나타납니다.
팁:
보고서 생성 모듈을 사용하여 현장조사 응답에 대한 보고서를 생성할 수 있습니다.
- 추가를 클릭하고 웹후크의 이름을 입력합니다.
해당 이름은 웹후크를 구성할 현장조사에 고유한 이름이어야 합니다.
- Survey123 모듈을 Make에서 처음 사용할 경우 ArcGIS 기관에 대한 연결을 설정합니다. Make에서는 후속 사용을 위해 사용자 정보가 저장되므로 로그인은 한 번만 수행하면 됩니다. 연결에서 추가를 클릭하고 ArcGIS에 대한 연결 이름을 지정합니다.
- ArcGIS Online에 연결하려면 저장을 클릭하여 ArcGIS 기관에 로그인합니다.
- ArcGIS Enterprise에 연결하려면 포털에 Make을 등록합니다. 자세한 내용은 Survey123 유용한 정보: Make 블로그 게시물을 참고하세요.
- 연결할 ArcGIS 기관에서 현장조사를 선택합니다.
- 웹후크에 포함할 옵션을 확인하고 저장을 클릭합니다.
모든 고급 설정에 대해 기본값인 예를 유지하는 것을 권장합니다. 이 경우 웹후크를 사용자 정의할 때 가장 유연하게 작업할 수 있습니다.
- 확인을 클릭합니다.
웹후크가 생성되고 현장조사 보기 모듈이 구성됩니다.
- 현장조사 보기 모듈 오른쪽의 다른 모듈 추가 버튼을 클릭하여 다른 모듈을 연결합니다.
- 이메일을 검색하고 이메일 모듈을 선택합니다.
- 이메일 보내기 작업을 선택합니다.
- Make에서 이 모듈을 처음 사용할 경우 추가를 클릭하여 이메일 계정에 대한 연결을 설정합니다. 연결 유형을 선택하고 계정에 로그인합니다.
Make에서는 후속 사용을 위해 연결이 저장되므로 로그인은 한 번만 수행하면 됩니다.
- 받는 사람 이메일 주소를 추가합니다.
해당 이메일은 트리거된 이메일이 전송될 이메일 주소입니다.
- 제목 텍스트 상자를 클릭합니다. 이때 나타나는 모듈 설정 패널에서 이메일 제목 생성에 사용할 현장조사 필드를 선택합니다.
- 콘텐츠 텍스트 상자를 클릭합니다. 이때 나타나는 모듈 설정 패널에서는 이메일 콘텐츠 생성에 사용할 현장조사 필드를 선택합니다. HTML을 사용하여 콘텐츠 서식을 지정할 수 있습니다.
- 확인을 클릭합니다.
이 시나리오는 질문에 대해 특정 방식으로 답변할 때 이메일을 보내야 하므로 필터를 제공합니다.
- 두 모듈 사이의 도구 버튼을 클릭한 다음 필터 설정을 선택합니다.
- 조건 텍스트 상자를 클릭한 다음 필터에 사용할 현장조사 필드를 선택합니다.
- 조건의 연산자를 선택합니다. 이 경우에는 기본값인 같음을 선택합니다.
- 조건의 값을 입력하고 확인을 클릭합니다.
- 저장을 클릭하여 시나리오를 저장합니다.
필요한 경우 한 번 실행을 클릭하여 웹후크를 테스트할 수 있습니다. 한 번 실행을 클릭한 후 Survey123을 열어 현장조사를 제출해 현장조사 응답이 필터 조건을 충족하는지 확인할 수 있습니다. 받는 사람의 이메일 수신 여부를 확인합니다.
- 페이지 왼쪽 하단에 있는 토글 버튼을 사용하여 시나리오를 활성화합니다. 일정을 즉시로 설정하여 현장조사 응답이 제출될 때마다 시나리오가 실행되도록 합니다.
Survey123을 Make 시나리오의 트리거로 사용하는 추가 방법에 대해 알아보려면 Survey123 통합을 참고하세요.
Microsoft Power Automate에 웹후크 설정
Microsoft Power Automate는 Microsoft Office 365 플랫폼에서 사용할 수 있는 웹후크 서비스입니다.
비고:
Power Automate에서 플로를 생성하는 데 사용된 ArcGIS Online 자격 증명은 2주 후에 자동으로 로그아웃됩니다. Power Automate에서 예상한 현장조사를 찾을 수 없는 경우 Survey123 데이터 연결이 활성화되어 있는지 확인합니다. 자세한 내용은 빠른 팁: ArcGIS Connectors for Power Automate 새로고침 토큰을 유효하게 유지하기 블로그 기사를 참고하세요.
ArcGIS 또는 ArcGIS Enterprise 커넥터를 사용하여 Microsoft Power Automate에서 플로를 설정하려면 아래 단계를 완료합니다. 이전에 Survey123 커넥터로 플로를 생성한 경우 계속 작동하지만 새로운 기능은 ArcGIS 및 ArcGIS Enterprise 커넥터에만 추가됩니다. 자세한 내용은 ArcGIS Connectors for Power Automate에서 Survey123 트리거 및 작업 블로그 기사를 참고하세요.
- Microsoft Power Automate를 엽니다.
- 페이지 측면 메뉴에서 생성을 선택합니다.
- 빈 화면에서 시작 옵션에서 자동화된 클라우드 흐름을 선택합니다.
자동화된 클라우드 흐름 생성 대화 상자가 나타납니다.
- 플로의 이름을 지정합니다.
이제 트리거를 선택합니다.
- 검색 표시줄에 ArcGIS를 입력하고 현장조사 응답이 제출될 때를 선택합니다.
주의:
플로에서 ArcGIS Online 기관에 로그인하도록 요구하는 경우 ArcGIS에서 현장조사 응답이 제출될 때 옵션을 선택합니다. 플로에서 ArcGIS Enterprise 기관에 로그인하도록 요구하는 경우 ArcGIS Enterprise에서 현장조사 응답이 제출될 때 옵션을 선택합니다.
- 생성을 클릭합니다.
- Microsoft Power Automate에서 해당 커넥터를 처음 사용하는 경우에는 로그인을 클릭하여 ArcGIS 기관 자격 증명으로 로그인합니다.
Microsoft Power Automate에서는 후속 사용을 위해 자격 증명이 저장되므로 로그인은 한 번만 수행하면 됩니다.
- 현장조사 드롭다운 목록에서 웹후크에 사용할 현장조사를 선택합니다.
이제 웹후크에 대한 트리거를 설정했지만 웹후크가 해당 트리거로 작업을 수행하려면 추가 단계를 따라야 합니다.
이 플로에서는 질문에 대해 특정 방식으로 답변할 때 이메일을 보내야 하므로, 조건을 제공합니다.
- 새 단계 버튼을 클릭하고 작업 섹션의 상단에서 조건을 선택합니다.
- 맨 왼쪽 텍스트 상자를 클릭하여 현장조사의 질문이나 등록정보를 선택할 수 있는 대화 상자를 열고 현장조사를 한정하는 데 사용할 현장조사 질문을 선택합니다.
- 정확한 응답을 찾고 있으므로 가운데 텍스트 상자의 드롭다운 메뉴에서 같음 조건을 트리거로 선택합니다.
- 가장 오른쪽 텍스트 상자에 알림을 보낼 질문의 값을 입력합니다.
조건이 충족될 경우에만 이메일이 전송되도록 합니다.
- 예인 경우 상자에서 작업 추가를 클릭합니다.
아니요인 경우 상자는 빈 상태로 유지됩니다.
여러 메일 서비스에는 이 플로에 사용할 수 있는 커넥터가 포함되어 있습니다.
- Office 365 Outlook - 이메일 보내기(V2)를 선택합니다.
- 자격 증명이 아직 저장되지 않은 경우 자격 증명을 사용하여 메일 서비스에 로그인합니다.
- 이메일의 받는 사람, 제목, 본문 필드를 작성합니다.
텍스트 상자를 선택할 때 나타나는 동적 콘텐츠 대화 상자를 통해 필요에 따라 현장조사 응답의 콘텐츠를 삽입할 수 있습니다.
- 이메일 설정을 완료했으면 저장을 클릭합니다.
웹후크가 완료되어 기본 설정에 따라 활성화됩니다. 이제 현장조사 응답이 지정된 조건과 함께 제출될 때마다 웹후크가 실행됩니다.
팁:
보고서 작성 작업을 사용하여 현장조사 응답에 대한 보고서를 생성할 수 있습니다.
Survey123 웹사이트에서 웹후크 구성
다음 단계를 완료하여 Survey123 웹사이트에서 웹후크를 설정할 수 있습니다.
- 내 현장조사 페이지에서 현장조사 패널의 오른쪽 하단에 있는 메뉴에서 설정 탭을 선택합니다.
- 왼쪽 메뉴에서 웹후크 섹션을 선택합니다.
해당 페이지에서는 설정한 모든 웹후크를 설정하고 접근할 수 있습니다. Survey123에 설정한 웹후크가 아직 없다면 페이지가 빈 상태로 표시됩니다.
- 웹후크 추가를 클릭합니다.
웹후크가 현장조사와 상호작용하는 방식을 설정할 수 있는 새 페이지가 표시됩니다.
- 웹후크의 이름을 입력합니다. 이 이름은 향후에 웹후크를 식별하는 데 사용됩니다.
- 페이로드 URL은 현장조사 정보가 전송될 곳입니다. 이 URL은 외부 웹후크 서비스에서 제공해야 합니다.
Microsoft Power Automate 또는 Make와 같은 서비스를 사용하여 웹후크를 생성하면 페이로드 URL이 이 페이지에 자동으로 채워집니다. Zapier 또는 FME Server와 같은 기타 서비스는 이 페이지에 복사할 수 있는 페이로드 URL을 제공합니다. 기타 앱에서는 웹후크를 수신하기 위한 전용 서비스를 생성해야 할 수 있습니다.
- 트리거 이벤트는 웹후크가 호출되는 특정 작업을 설명합니다. 새 레코드가 제출됨을 선택합니다.
- 이벤트 데이터를 통해 현장조사에서 페이로드에 포함될 정보를 선택할 수 있습니다(예시: 현장조사 정보, 서버 응답, 제출된 레코드, 사용자 정보, 포털 정보). 현장조사 정보 옵션과 제출된 레코드 옵션을 선택합니다.
- 상태 토글 버튼은 저장될 때 웹후크를 활성화할지 여부를 결정합니다. 켜기(기본값)로 설정된 상태를 유지합니다.
- 저장을 클릭합니다.
웹후크를 사용할 준비가 되었으며 현장조사 응답이 제출될 때마다 실행됩니다. 웹후크 공급자 내에 설정된 규칙은 특정 기준이 충족되는 경우에만 이메일을 보내도록 할 수 있습니다.
이벤트 페이로드 등록정보
웹후크 이벤트는 등록정보 페이로드를 JSON 객체로 보냅니다. 페이로드의 콘텐츠는 현장조사에 따라 다릅니다. 다음 테이블에는 JSON 객체에 포함된 공통 등록정보가 나와 있습니다.
| 등록정보 | 설명 |
|---|---|
| eventType | 이벤트 유형입니다. 값은 addData 또는 editData일 수 있습니다. |
| portalInfo | 현장조사가 호스팅되는 ArcGIS 기관에 대한 정보입니다. 여기에는 다음 등록정보가 포함되어 있습니다.
|
| surveyInfo | 웹후크를 생성한 현장조사에 대한 정보입니다. 여기에는 다음 등록정보가 포함되어 있습니다.
|
| userInfo | 현장조사를 제출한 사용자의 ArcGIS 기관 계정에 대한 정보입니다. 여기에는 다음 등록정보가 포함되어 있습니다.
|
다음 등록정보는 현장조사 및 이벤트 유형에 따라 다릅니다.
| 등록정보 | 설명 |
|---|---|
| applyEdits | 현장조사에서 제출한 편집 적용 페이로드입니다. eventType이 addData인 경우 adds가 포함됩니다. eventType이 editData인 경우 updates가 포함됩니다. 새 반복 레코드를 추가하면 adds도 포함됩니다. |
| response | applyEdits 작업의 응답입니다. 여기에는 작업에 의해 생성된 피처의 Global ID 및 작업의 성공 여부가 포함됩니다. |
| feature | 제출된 현장조사 레코드입니다. 여기에는 다음 등록정보가 포함되어 있습니다.
|