ServiceNow

ServiceNow 커넥터를 사용하면 ServiceNow 데이터베이스에 대한 삽입, 삭제, 업데이트, 읽기 작업을 수행할 수 있습니다.

시작하기 전에

ServiceNow 커넥터를 사용하기 전에 다음 태스크를 수행합니다.

Google Cloud 프로젝트에서:
- 커넥터를 구성하는 사용자에게 roles/connectors.admin IAM 역할을 부여합니다.
- 커넥터에 사용할 서비스 계정에 다음 IAM 역할을 부여합니다.
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  서비스 계정은 인증을 거쳐야 하며 Google API의 데이터에 액세스할 수 있는 승인을 받은 사람이 아닌 사용자를 나타내는 특별한 유형의 Google 계정입니다. 서비스 계정이 없으면 서비스 계정을 만들어야 합니다. 자세한 내용은 서비스 계정 만들기를 참조하세요.
- 다음 서비스를 사용 설정합니다.
  - secretmanager.googleapis.com(Secret Manager API)
  - connectors.googleapis.com(Connectors API)
  서비스 사용 설정 방법은 서비스 사용 설정을 참조하세요.
이러한 서비스나 권한이 이전 프로젝트에서 사용 설정되지 않았으면 커넥터를 구성할 때 서비스나 권한을 사용 설정하라는 메시지가 표시됩니다.
ServiceNow 인스턴스의 다음 테이블에 대한 액세스 권한을 제공합니다.
- sys_db_object
- sys_dictionary
- sys_glide_object
이 권한은 커넥터가 데이터에 연결하는 데 필요합니다. 액세스 권한을 제공하려면 다음 단계를 따르세요.
1. ServiceNow 애플리케이션에서 System Security(시스템 보안) > Access Controls(ACL)(액세스 제어(ACL))로 이동합니다.
2. New(새로 만들기)를 선택하여 액세스 제어 객체를 만듭니다.
3. Type(유형)에서 record(레코드)를 선택합니다.
4. Operation(작업)에서 read(읽기)를 선택합니다.
5. Name(이름)의 첫 번째 드롭다운에서 Table [sys_db_object]([sys_db_object] 테이블)를 선택하고 두 번째 드롭다운에서 --None--(없음)을 선택합니다.
6. Requires role(역할 필요) 섹션에서 Insert a new row....(새 행 삽입....) 텍스트 상자를 더블클릭한 다음 원하는 역할을 검색하여 선택합니다.
7. Submit(제출)을 클릭하여 ACL 객체를 만듭니다.
8. 생성된 ACL이 있는 역할을 인증 사용자에게 할당합니다. 이를 위해 User Administration(사용자 관리) > Users(사용자) > Select authenticating user(인증 사용자 선택) > Roles(역할) > Edit(수정)... > 으로 이동합니다. 그런 다음 컬렉션에서 역할을 추가합니다.

커넥터 구성

커넥터를 구성하려면 데이터 소스(백엔드 시스템)에 대한 연결을 만들어야 합니다. 연결은 데이터 소스와 관련이 있습니다. 즉, 데이터 소스가 많으면 데이터 소스마다 별도의 연결을 만들어야 합니다. 연결을 만들려면 다음 단계를 따르세요.

Cloud 콘솔에서 Integration Connectors > 연결 페이지로 이동한 다음 Google Cloud 프로젝트를 선택하거나 만듭니다.
연결 페이지로 이동
+ 새로 만들기를 클릭하여 연결 만들기 페이지를 엽니다.
위치 섹션에서 연결 위치를 선택합니다.
1. 리전: 드롭다운 목록에서 위치를 선택합니다.
  지원되는 모든 리전 목록은 위치를 참조하세요.
2. 다음을 클릭합니다.
연결 세부정보 섹션에서 다음을 완료합니다.
1. 커넥터: 사용 가능한 커넥터의 드롭다운 목록에서 Servicenow를 선택합니다.
2. 커넥터 버전: 사용 가능한 버전의 드롭다운 목록에서 커넥터 버전을 선택합니다.
3. 연결 이름 필드에서 연결 인스턴스의 이름을 입력합니다.
  연결 이름은 다음 기준을 충족해야 합니다.
  - 연결 이름에 문자, 숫자, 하이픈을 사용할 수 있습니다.
  - 문자는 소문자여야 합니다.
  - 연결 이름은 문자로 시작하고 문자 또는 숫자로 끝나야 합니다.
  - 연결 이름은 63자를 초과할 수 없습니다.
4. 선택적으로 연결 인스턴스에 대한 설명을 입력합니다.
5. 서비스 계정: 필수 역할이 있는 서비스 계정을 선택합니다.
6. 이벤트 구독에 연결을 사용하려면 이벤트 구독 사용 설정을 선택합니다. 이 옵션을 선택하면 다음 옵션이 표시됩니다.
  - 항목 및 작업으로 이벤트 구독 사용 설정: 이벤트 구독 및 커넥터 작업(항목 및 작업) 모두에 연결을 사용하려면 이 옵션을 선택합니다.
  - 이벤트 구독만 사용 설정: 이벤트 구독에만 연결을 사용하려면 이 옵션을 선택합니다.
  이러한 두 가지 선택 모두의 경우 후속 단계에서 이벤트 세부정보를 구성하라는 메시지가 표시됩니다.
7. 필요한 경우 연결 노드 설정을 구성합니다.
  - 최소 노드 수: 최소 연결 노드 수를 입력합니다.
  - 최대 노드 수: 최대 연결 노드 수를 입력합니다.
  노드는 트랜잭션을 처리하는 연결의 단위(또는 복제본)입니다. 연결에 대해 더 많은 트랜잭션을 처리하려면 더 많은 노드가 필요합니다. 이와 반대로 더 적은 트랜잭션을 처리하기 위해서는 더 적은 노드가 필요합니다. 노드가 커넥터 가격 책정에 미치는 영향을 파악하려면 연결 노드 가격 책정을 참조하세요. 값을 입력하지 않으면 기본적으로 최소 노드가 (높은 가용성을 위해) 2로 설정되고 최대 노드는 50으로 설정됩니다.
8. 프록시 사용: 이 체크박스를 선택하여 연결의 프록시 서버를 구성하고 다음 값을 구성합니다.
9. 선택적으로 + 라벨 추가를 클릭하여 키/값 쌍의 형식으로 연결에 라벨을 추가합니다.
10. 다음을 클릭합니다.
대상 섹션에서 연결하려는 원격 호스트(백엔드 시스템)의 세부정보를 입력합니다.
1. 대상 유형: 대상 유형을 선택합니다.
  1. 호스트 주소 필드에 대상의 호스트 이름이나 IP 주소를 지정합니다.
    1. 백엔드 시스템에 비공개 연결을 설정하려면 다음 단계를 수행합니다.
      1. PSC 서비스 연결을 만듭니다.
      2. 엔드포인트 연결을 만든 다음 호스트 주소 필드에 엔드포인트 연결의 세부정보를 입력합니다.
    2. 추가 보안을 사용하여 백엔드 시스템에 공개 연결을 설정하려면 연결의 고정 아웃바운드 IP 주소를 구성한 후 방화벽 규칙을 구성하여 특정 고정 IP 주소만 허용 목록에 추가합니다.
  추가 대상을 입력하려면 +대상 추가를 클릭합니다.
2. 다음을 클릭합니다.
인증 섹션에서 인증 세부정보를 입력합니다.
1. 인증 유형을 선택하고 관련 세부정보를 입력합니다.
  Servicenow 연결에서는 다음 인증 유형이 지원됩니다.
  - 사용자 이름 및 비밀번호
2. 다음을 클릭합니다.
이벤트 구독을 사용 설정한 경우 연결 생성 페이지에 이벤트 구독 세부정보 섹션이 표시됩니다. 이벤트 구독 세부정보를 구성하는 방법은 이벤트 구독 구성을 참조하세요.
검토: 연결 및 인증 세부정보를 검토합니다.
만들기를 클릭합니다.

인증 구성

사용할 인증을 기반으로 세부정보를 입력합니다.

사용자 이름 및 비밀번호
- 사용자 이름: 연결에 사용할 ServiceNow 사용자 이름입니다.
- 비밀번호: ServiceNow 사용자 이름과 연결된 비밀번호가 포함된 Secret Manager 보안 비밀입니다.

이벤트 구독 구성[미리보기]

이벤트 구독을 사용 설정한 경우 이벤트 구독 세부정보 섹션에 다음 값을 입력합니다.

인증 토큰: (선택사항) 인증 토큰의 Secret Manager 보안 비밀과 보안 비밀 버전 드롭다운에서 해당 보안 비밀 버전을 선택합니다.
HMAC 알고리즘: (선택사항) 응답 페이로드를 암호화할 HMAC 알고리즘을 선택합니다.
HMAC 보안 비밀 키: HMAC 알고리즘을 선택한 경우 HMAC 키의 Secret Manager 보안 비밀과 해당 보안 비밀 버전 드롭다운에서 해당 보안 비밀 버전을 선택합니다.

연결 만들기 단계 게시

이벤트 구독 구성을 완료하려면 ServiceNow 애플리케이션에 웹훅 URL을 등록해야 합니다. 따라서 연결이 생성된 후 다음 추가 단계를 수행합니다.

새로 만든 연결의 연결 세부정보 페이지로 이동하고 이벤트 구독의 웹훅 URL을 복사합니다.

ServiceNow 애플리케이션에 로그인하고 다음을 수행합니다.

모두 > 비즈니스 규칙 > 실행 시기 페이지에서 수신할 작업을 선택합니다.
고급 탭을 클릭합니다. 그러면 스크립트 편집기가 열립니다.

콜백 URL로 요청을 전송하는 자바스크립트를 입력합니다. 요청에는 사용 설정된 작업이 발생할 때마다 트리거되는 페이로드가 포함됩니다. 샘플 자바스크립트는 다음과 같습니다.

템플릿

(function executeRule(current, previous /*null when async*/ ) {
var request = new sn_ws.RESTMessageV2();
request.setEndpoint('WEBHOOK_URL'); // here you must the listener url where you want send the event payload

request.setHttpMethod('POST');

var authToken = "AUTHENTICATION_TOKEN"
request.setRequestHeader("authorization", authToken);
request.setRequestHeader("Accept", "application/json");
request.setRequestHeader('Content-Type', 'application/json');

request.setRequestBody("{\"eventType\":\"" +
"EVENT_TYPE" + CUSTOM_FIELDS "\"}");

var data = request.getRequestBody();
var secretKey = "SECRET_KEY";

var signature = SncAuthentication.encode(data, secretKey, "ENCRYPTION_ALGORITHM");
request.setRequestHeader("hmacauthorization",signature);
var response = request.execute();

})(current, previous);

다음을 바꿉니다.

WEBHOOK_URL: 통합 커넥터의 연결 세부정보 페이지에서 가져온 이벤트 구독에 대한 웹훅 URL입니다.
AUTHENTICATION_TOKEN: 연결을 위해 구성한 인증 토큰의 실제 텍스트입니다.
EVENT_TYPE: ServiceNow 트리거에서 구성한 이벤트 유형의 실제 텍스트입니다.
CUSTOM_FIELDS: 요청 본문에는 항상 eventType 필드가 있어야 합니다. 이 필드 외에도 요구사항에 따라 다른 필드를 추가할 수 있습니다.
SECRET_KEY: 연결을 위해 구성한 보안 비밀 키의 실제 텍스트입니다.
ENCRYPTION_ALGORITHM: 다음 값 중 하나여야 합니다.
- HmacSHA224
- HmacSHA256
- HmacSHA384
- HmacSHA512
알고리즘은 연결에 대해 구성한 것과 동일한 알고리즘이어야 합니다.

예

(function executeRule(current, previous /*null when async*/ ) {
var request = new sn_ws.RESTMessageV2();
request.setEndpoint('https://webhook.site/bb37937e-24ea-19b3-9dcd-84eca77f60eg'); // here you must the listener url where you want send the event payload

request.setHttpMethod('POST');

var authToken = "YWRtaW46ZkVpNypxVzhCL3VY"
request.setRequestHeader("authorization", authToken);
request.setRequestHeader("Accept", "application/json");
request.setRequestHeader('Content-Type', 'application/json');

request.setRequestBody("{\"caller_id\":\"" +
current.caller_id + "\",\"eventType\":\"" +
"service_now_event_type_1" + "\",\"company\":\"" +
current.company + "\",\"number\":\"" +
current.number + "\",\"description\":\"" +
current.description + "\",\"FirstName\":\"" +
current.u_firstname + "\",\"LastName\":\"" +
current.u_lastname + "\",\"status\":\"" +
current.u_status + "\",\"Element\":\"" +
current.getElement() + "\",\"category\":\"" +
current.category + "\",\"opened_at\":\"" +
current.opened_at + "\",\"opened_by\":\"" +
current.opened_by + "\",\"location\":\"" +
current.location + "\",\"salesforceId\":\"" +
current.u_salesforceid + "\"}"); //fields you want

var data = request.getRequestBody();
var secretKey = "YWRtaW46ZkVpNypxVzhCL3VY";

// var MAC_ALG_4 = "HmacSHA384";
var MAC_ALG_3 = "HmacSHA256";
// var MAC_ALG_5 = "HmacSHA512";
// var MAC_ALG_2 = "HmacSHA224";

var signature = SncAuthentication.encode(data, secretKey, MAC_ALG_3);
request.setRequestHeader("hmacauthorization",signature);
var response = request.execute();

})(current, previous);

항목, 작업, 조치

모든 Integration Connectors는 연결된 애플리케이션의 객체에 대한 추상화 레이어를 제공합니다. 이 추상화를 통해서만 애플리케이션의 객체에 액세스할 수 있습니다. 추상화는 항목, 작업, 조치로 노출됩니다.

항목: 연결된 애플리케이션 또는 서비스에서 항목은 객체 또는 속성 모음으로 간주될 수 있습니다. 항목의 정의는 커넥터마다 다릅니다. 예를 들어 데이터베이스 커넥터에서는 테이블이 항목이고, 파일 서버 커넥터에서는 폴더가 항목이며 메시징 시스템 커넥터에서는 큐가 항목입니다.
그러나 커넥터가 항목을 지원하지 않거나 항목을 포함하지 않을 수 있으며, 이 경우 Entities 목록이 비어 있습니다.
작업: 작업은 항목에 대해 수행할 수 있는 활동입니다. 항목에서 다음 작업을 수행할 수 있습니다.
- 목록
- 가져오기
- 만들기
- 업데이트
- 삭제
사용 가능한 목록에서 항목을 선택하면 항목에 사용 가능한 작업 목록이 생성됩니다. 작업에 대한 자세한 설명은 커넥터 태스크의 항목 작업을 참조하세요. 그러나 커넥터가 항목 작업을 지원하지 않으면 이렇게 지원되지 않는 작업은 Operations 목록에 나열되지 않습니다.
조치: 커넥터 인터페이스를 통해 통합에 제공되는 첫 번째 클래스 함수입니다. 조치를 사용하면 항목을 변경할 수 있습니다. 조치는 커넥터마다 다릅니다. 하지만 커넥터가 조치를 지원하지 않을 수 있으며 이 경우 Actions 목록이 비어 있습니다.

작업

이 섹션에는 Servicenow 연결에서 지원하는 모든 작업이 나와 있습니다.

UploadAttachment 작업

이 작업은 파일을 지정된 레코드에 첨부파일로 업로드합니다.

UploadAttachment 작업의 입력 매개변수

매개변수 이름	데이터 유형	필수	설명
Content	문자열	아니요	파일로 업로드할 문자열 콘텐츠입니다.
ContentBytes	문자열	아니요	파일로 업로드할 바이트 콘텐츠입니다.
HasBytes	불리언	아니요	콘텐츠를 바이트로 업로드할지 여부입니다.
TableName	문자열	아니요	파일을 첨부할 테이블의 이름입니다.
TableSysId	문자열	아니요	파일을 첨부할 TableName으로 지정된 테이블의 레코드 Sys_id입니다.

UploadAttachment 작업의 출력 매개변수

이 작업은 업로드된 항목에서 매개변수 집합을 반환합니다.

UploadAttachment 작업을 구성하는 방법의 예시는 예시를 참조하세요.

DownloadAttachment 작업

이 작업은 특정 레코드에서 첨부파일을 다운로드합니다.

DownloadAttachment 작업의 입력 매개변수

매개변수 이름	데이터 유형	필수	설명
SysId	문자열	예	첨부파일의 Sys_id입니다.
HasBytes	불리언	아니요	콘텐츠를 바이트로 다운로드할지 여부입니다.

DownloadAttachment 작업의 출력 매개변수

이 작업은 성공 매개변수를 통해 다운로드가 true 또는 false인지 여부를 반환하고, true인 경우 DownloadAttachment의 콘텐츠를 출력합니다.

DownloadAttachment 작업을 구성하는 방법의 예시는 예시를 참조하세요.

예시

이 섹션에서는 이 커넥터에서 일부 항목 작업과 조치를 수행하는 방법을 설명합니다.

예 - 이슈의 첨부파일 업로드

Configure connector task 대화상자에서 Actions를 클릭합니다.
UploadAttachment 조치를 선택한 다음 완료를 클릭합니다.
커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다.
```
{
  "Content": "File is uploaded",
  "TableName": "Incident",
  "TableSysId": "018f4057473ae5104593a6b5316d4357"
}
```

이 예시에서는 페이로드의 콘텐츠 값을 첨부파일로 업로드하고 업로드된 항목의 매개변수 집합을 반환합니다 . 작업이 성공하면 UploadAttachment 태스크의 connectorOutputPayload 응답 매개변수가 다음과 비슷한 값을 갖습니다.

{
                      "SysId": "a667f5d1939be110ff87352d6cba10fc",
                      "FileName": "7043426257788756581.connector.txt",
                      "TableSysId": "018f4057473ae5104593a6b5316d4357",
                      "TableName": "Incident",
                      "DownloadLink": "https://gcp.service-now.com/api/now/v1/attachment/a667f5d1939be110ff87352d6cba10fc/file",
                      "ContentType": "text/plain",
                      "SizeBytes": "16",
                      "ChunkSizeBytes": "700000",
                      "Compressed": "true",
                      "SizeCompressed": "36",
                      "SysTags": "",
                      "ImageHeight": "",
                      "ImageWidth": "",
                      "AverageImageColor": "",
                      "SysModCount": "0",
                      "Hash": "807e96c2942c41ad699d004a9d6a74595c84fab09111d479b6bbe013d5debff6",
                      "State": "pending",
                      "SysUpdatedBy": "gcp2",
                      "SysUpdatedOn": "2023-06-07 07:23:34",
                      "SysCreatedBy": "gcp2",
                      "SysCreatedOn": "2023-06-07 07:23:34",
                      "encryption_context": ""
                    }

예 - 이슈 첨부파일 다운로드

Configure connector task 대화상자에서 Actions를 클릭합니다.
DownloadAttachment 조치를 선택한 다음 완료를 클릭합니다.
커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다.
```
{
  "SysId": "440c3995471fe1104593a6b5316d4384"
}
```

이 예시에서는 성공 매개변수를 통해 다운로드가 true 또는 false인지 여부를 반환하고, true인 경우 DownloadAttachment의 콘텐츠를 출력합니다. 작업이 성공하면 DownloadAttachment 태스크의 connectorOutputPayload 응답 매개변수가 다음과 비슷한 값을 갖습니다.

[
                    {
                      "Success": "True"
                    },
                    {
                      "Content": " A Simple Text File \r\n\r\n\r\n This is a small demonstration .txt file - \r\n just for use in the Virtual Mechanics tutorials. More text. And more \r\n text. And more text. And more text. And more text. \r\n And more text. And more text. And more text. And more text. And more \r\n text. And more text. Boring, zzzzz. And more text. And more text. And \r\n more text. And more text. And more text. And more text. And more text. \r\n And more text. And more text. \r\n And more text. And more text. And more text. And more text. And more \r\n text. And more text. And more text. Even more. Continued on page 2 ...\r\n Simple PDF File 2 \r\n ...continued from page 1. Yet more text. And more text. And more text. \r\n And more text. And more text. And more text. And more text. And more \r\n text. Oh, how boring typing this stuff. But not as boring as watching \r\n paint dry. And more text. And more text. And more text. And more text. \r\n Boring. More, a little more text. The end, and just as well. "
                    }]

시스템 제한사항

ServiceNow 커넥터는 노드별로 초당 최대 10개의 트랜잭션을 처리할 수 있으며 이 한도를 초과하는 모든 트랜잭션을 제한할 수 있습니다. 기본적으로 Integration Connectors는 가용성을 높이기 위해 연결에 2개의 노드를 할당합니다.

Integration Connectors에 적용되는 한도에 대한 자세한 내용은 한도를 참조하세요.

참고: Integration Connectors 노드 수는 사용량에 따라 동적으로 자동 확장됩니다. 하지만 자동 확장을 기다리지 않고 대용량을 예약하려면 연결의 최소 노드 값을 조정하면 됩니다. 연결에 대해 더 많은 트랜잭션을 처리하려면 더 많은 노드가 필요합니다. 이와 반대로 더 적은 트랜잭션을 처리하려면 더 적은 노드가 필요합니다. 노드 값을 구성하려면 다음 안내를 따르세요.

사용한 만큼만 지불 고객인 경우 연결 수정 페이지에서 최소 및 최대 노드 값을 구성합니다.
정기 결제 기반 고객인 경우 지원팀에 문의하세요.

노드에서 처리할 수 있는 최대 트랜잭션은 다양한 요소에 따라 달라집니다. 따라서 처리량을 늘리기 위해 최소 노드를 조정하기 전에 백엔드 시스템이 필요한 트래픽을 처리하도록 최적으로 설정되었는지 확인하는 것이 좋습니다.

terraform을 사용하여 연결 만들기

Terraform 리소스를 사용하여 새 연결을 만들 수 있습니다.

Terraform 구성을 적용하거나 삭제하는 방법은 기본 Terraform 명령어를 참조하세요.

연결 만들기를 위한 샘플 Terraform 템플릿을 보려면 샘플 템플릿을 참조하세요.

Terraform을 사용하여 이 연결을 만들 때는 Terraform 구성 파일에서 다음 변수를 설정해야 합니다.

매개변수 이름	데이터 유형	필수	설명
proxy_enabled	부울	거짓	이 체크박스를 선택하여 연결의 프록시 서버를 구성합니다.
proxy_auth_scheme	ENUM	거짓	ProxyServer 프록시에 인증하는 데 사용할 인증 유형입니다. 지원되는 값은 BASIC, DIGEST, NONE입니다.
proxy_user	STRING	거짓	ProxyServer 프록시에 인증하는 데 사용할 사용자 이름입니다.
proxy_password	SECRET	거짓	ProxyServer 프록시에 인증하는 데 사용할 비밀번호입니다.
proxy_ssltype	ENUM	거짓	ProxyServer 프록시에 연결할 때 사용할 SSL 유형입니다. 지원되는 값은 AUTO, ALWAYS, NEVER, TUNNEL입니다.
include_system_tables	부울	거짓	시스템 테이블을 노출할지 여부를 제어합니다.
filter_tables	STRING	거짓	쉼표로 구분된 목록으로 원하는 테이블을 지정합니다.

통합에서 ServiceNow 연결 사용

연결을 만들면 Apigee Integration 및 Application Integration에서 사용할 수 있게 됩니다. 커넥터 태스크를 통해 통합에서 연결을 사용할 수 있습니다.

Apigee Integration에서 커넥터 태스크를 만들고 사용하는 방법을 알아보려면 커넥터 태스크를 참조하세요.
Application Integration에서 커넥터 태스크를 만들고 사용하는 방법을 이해하려면 커넥터 태스크를 참조하세요.

Google Cloud 커뮤니티에서 도움 받기

Google Cloud 커뮤니티에서 Cloud 포럼에 질문을 게시하고 이 커넥터에 대해 토론할 수 있습니다.

다음 단계

연결 일시중지 및 재개 방법 알아보기
커넥터 사용량 모니터링 방법 알아보기
커넥터 로그 확인 방법 알아보기