ServiceNow

O conector do ServiceNow permite executar operações de inserção, exclusão, atualização e leitura no banco de dados do ServiceNow.

Antes de começar

Antes de usar o conector do ServiceNow, faça o seguinte:

  • No seu projeto do Google Cloud, faça o seguinte:
    • Verifique se a conectividade de rede está configurada. Para informações sobre padrões de rede, consulte Conectividade de rede.
    • Conceda o papel do IAM roles/connectors.admin ao usuário que está configurando o conector.
    • Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.

    • Ative os seguintes serviços:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Para entender como ativar os serviços, consulte Como ativar serviços.

    Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

  • Dê acesso às seguintes tabelas na sua instância do ServiceNow:

    • sys_db_object
    • sys_dictionary
    • sys_glide_object

    Essa permissão é necessária para que o conector se conecte aos seus dados. Para conceder o acesso, siga estas etapas:

    1. No aplicativo ServiceNow, acesse System Security > Access Controls (ACL).
    2. Selecione Novo para criar um objeto de controle de acesso.
    3. Em Tipo, selecione registro.
    4. Em Operação, selecione read.
    5. Em Nome, selecione Tabela [sys_db_object] no primeiro menu suspenso e --Nenhum-- no segundo.
    6. Na seção Exige função, clique duas vezes na caixa de texto Inserir uma nova linha... e pesquise e selecione a função desejada.
    7. Clique em Enviar para criar o objeto ACL.
    8. Atribua a função que tem a ACL criada ao usuário autenticado. Para fazer isso, acesse Administração de usuários > Usuários > Selecione o usuário de autenticação > Funções > Editar... > . e adicione sua função da coleção.

  • Consiga o URL da instância, o nome de usuário e a senha do ServiceNow.

Configurar o conector

Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, faça o seguinte:

  1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

    Acessar a página "Conexões"

  2. Clique em + CRIAR NOVO para abrir a página Criar conexão.
  3. Na seção Local, escolha o local da conexão.
    1. Região: selecione um local na lista suspensa.

      Para conferir a lista de todas as regiões com suporte, consulte Locais.

    2. Clique em PRÓXIMA.
  4. Na seção Detalhes da conexão, faça o seguinte:
    1. Connector: selecione ServiceNow na lista suspensa de conectores disponíveis.
    2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
    3. No campo Nome da conexão, insira um nome para a instância de conexão

      Os nomes de conexão precisam atender aos seguintes critérios:

      • Os nomes de conexões podem usar letras, números ou hifens.
      • As letras precisam ser minúsculas.
      • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das conexões não podem exceder 49 caracteres.
      • Para conectores que aceitam inscrição em eventos, os nomes de conexão não podem começar com o prefixo "goog".
    4. Como opção, insira uma Descrição para a instância de conexão.
    5. Se quiser, ative o Cloud Logging e selecione um nível de registro. Por padrão, o nível de registro é definido como Error.
    6. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
    7. Para usar a conexão em assinaturas de eventos, selecione Ativar assinatura de eventos. Ao selecionar essa opção, as seguintes opções vão aparecer:
      • Ativar assinatura de eventos com entidade e ações: selecione essa opção para usar a conexão para assinatura de eventos e operações de conector (entidades e ações).
      • Ativar somente a assinatura de eventos: selecione essa opção para usar a conexão apenas para assinatura de eventos. Se você selecionar essa opção, clique em Próxima e configure a inscrição no evento.
    8. Incluir tabelas do sistema: selecione essa opção para recuperar tabelas do sistema que armazenam dados de segurança e metadados. Somente usuários com função de administrador têm acesso a essas tabelas.
    9. Filtrar tabelas: especifique as tabelas como uma lista separada por vírgulas. Use esse campo para filtrar as tabelas que você quer que a conexão recupere em vez de todas elas.
    10. Valor de exibição: especifique se a conexão precisa recuperar o valor de exibição, o valor real ou ambos do banco de dados.

      11. Observação: se você definir essa propriedade de conexão como "true", todos os campos retornados serão do tipo "String" devido às limitações da API do ServiceNow.

      • TRUE: retorna valores de exibição para todos os campos.
      • FALSE: retorna os valores reais do banco de dados.
      • ALL: retorna os valores reais e de exibição.
    11. Opcionalmente, defina as Configurações do nó de conexão:

      • Número mínimo de nós: digite o número mínimo de nós de conexão.
      • Número máximo de nós: digite o número máximo de nós de conexão.

      Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

    12. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
    13. Clique em PRÓXIMA.
  5. Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
    1. Tipo de destino: selecione um Tipo de destino.
      • Para especificar o nome do host ou o endereço IP de destino, selecione Endereço do host e insira o endereço no campo Host 1.
      • Para estabelecer uma conexão particular, selecione Anexo de endpoint e escolha o anexo necessário na lista Anexo de endpoint.

      Para estabelecer uma conexão pública com os sistemas de back-end com mais segurança, considere configurar endereços IP de saída estáticos para suas conexões e configure as regras de firewall para autorizar apenas os endereços IP estáticos específicos.

      Para inserir outros destinos, clique em +ADICIONAR DESTINO.

    2. Clique em PRÓXIMA.
  6. Na seção Autenticação, insira os detalhes da autenticação.
    1. Selecione um Tipo de autenticação e insira os detalhes relevantes.

      A conexão do ServiceNow é compatível com os seguintes tipos de autenticação:

      • Nome de usuário e senha

      2. Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

    2. Clique em PRÓXIMA.
  7. Se você ativou a assinatura de eventos, a seção Detalhes da assinatura de eventos vai aparecer na página de criação da conexão. Para entender como configurar os detalhes da assinatura de eventos, consulte Configurar assinatura de eventos.
  8. Revisão: revise os detalhes de conexão e autenticação.
  9. Clique em Criar.

Configurar a autenticação

Digite os detalhes com base na autenticação que você quer usar.

  • Nome de usuário e senha
    • Nome de usuário: o nome de usuário do ServiceNow a ser usado para a conexão.
    • Senha: o Secret do Secret Manager que contém a senha associada ao nome de usuário do ServiceNow.

Configurar a assinatura de eventos

Se você ativou a assinatura de eventos, insira os seguintes valores na seção Detalhes da assinatura de eventos:

  • Token de autenticação: (opcional) selecione o secret do Secret Manager do seu token de autenticação e a versão correspondente no menu suspenso Versão do secret.
  • Algoritmo HMAC: selecione o algoritmo HMAC para criptografar o payload da resposta.
  • Chave secreta HMAC: se você selecionou um algoritmo HMAC, escolha o secret do Secret Manager da chave HMAC e a versão correspondente no menu suspenso Versão do secret.
  • Ativar a conectividade particular: selecione essa opção para detectar eventos com segurança por uma conexão particular.
  • Insira a seguinte configuração de carta não entregue:
    • ID do projeto de mensagens inativas: o ID do projeto do Google Cloud em que você configurou o tópico de mensagens inativas do Pub/Sub.
    • Tópico de mensagens mortas: o tópico do Pub/Sub em que você quer gravar os detalhes do evento não processado.

Etapas após a criação da conexão

Para concluir a configuração da assinatura de eventos, registre o URL do webhook no aplicativo ServiceNow. Portanto, depois que a conexão for criada, siga estas etapas adicionais:

  1. Acesse a página de detalhes da conexão recém-criada e copie o URL do webhook para a assinatura de eventos.
  2. Faça login no aplicativo ServiceNow e faça o seguinte:
    1. Na página Todas > Regras de negócios > Quando executar, selecione a operação que você quer monitorar.
    2. Clique na guia Avançado. Isso abre um editor de script.
    3. Insira um JavaScript que envie uma solicitação para o URL de callback. A solicitação contém o payload que é acionado sempre que uma das operações ativadas ocorre. Um exemplo de JavaScript é o seguinte:

      Modelo

      (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);

      Substitua:

      • WEBHOOK_URL: URL do webhook para assinatura de eventos que você recebeu na página de detalhes da conexão do Integration Connectors.
      • AUTHENTICATION_TOKEN: o texto real do token de autenticação que você configurou para a conexão.
      • EVENT_TYPE: o texto real do tipo de evento que você configurou no gatilho do ServiceNow.
      • CUSTOM_FIELDS: o corpo da solicitação precisa sempre ter o campo eventType. Além desse campo, você pode adicionar outros com base na sua necessidade.
      • SECRET_KEY: o texto real da chave secreta que você configurou para a conexão.
      • ENCRYPTION_ALGORITHM: precisa ser um dos seguintes valores:
        • HmacSHA224
        • HmacSHA256
        • HmacSHA384
        • HmacSHA512

        O algoritmo precisa ser o mesmo que você configurou para a conexão.

      Exemplo

      (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);

Exemplos de configuração de conexão

Esta seção lista os valores de amostra para os vários campos que você configura ao criar a conexão.

Tipo de conexão de autenticação básica

Nome do campo Detalhes
Local us-central1
Conector Servicenow
Versão do conector 1
Nome da conexão google-cloud-servicenow-conn
Conta de serviço Your_Project_Number@serviceaccount
Mostrar valores Verdadeiro
Número mínimo de nós 2
Número máximo de nós 50
Tipo de destino Endereço do host
host 1 https://Your-domainname.com
Nome de usuário User_name
Senha Senha
Versão do secret 1

Exemplos de configuração de conexão

Esta seção lista os valores de exemplo dos vários campos que você configura para criar a conexão do ServiceNow.

Tipo de conexão da Web do ServiceNow

Nome do campo Detalhes
Local us-central1
Conector ServiceNow
Versão do conector 1
Nome da conexão gcp-servicenow-conn
Conta de serviço SERVICE_ACCOUNT_NAME@serviceaccount
Número mínimo de nós 2
Número máximo de nós 50
Tipo de destino Endereço do host
host 1 https://host_name.com
Nome de usuário nome de usuário
Senha senha
Versão do secret 1

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

  • Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

    No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.

  • Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:

    Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações de entidade, essas operações não serão listadas na lista Operations.

  • Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada e um parâmetro de saída. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Ações

Esta seção lista todas as ações compatíveis com a conexão do ServiceNow.

Ação UploadAttachment

Essa ação faz upload de um arquivo como anexo a um registro especificado.

Parâmetros de entrada da ação UploadAttachment

Nome do parâmetro Tipo de dados Obrigatório Descrição
Conteúdo String Não Conteúdo de string para fazer upload como arquivo.
ContentBytes String Não Conteúdo de bytes para fazer upload como arquivo.
HasBytes Booleano Não Define se o upload de conteúdo será feito como bytes.
TableName String Não Nome da tabela a que o arquivo será anexado.
TableSysId String Não Sys_id do registro na tabela especificada por TableName a que você quer anexar o arquivo.

Parâmetros de saída da ação UploadAttachment

Essa ação retorna um conjunto de parâmetros da entidade enviada.

Para ver um exemplo de como configurar a ação UploadAttachment, consulte Exemplos.

Ação DownloadAttachment

Essa ação faz o download de um anexo de arquivo de um registro específico.

Parâmetros de entrada da ação DownloadAttachment

Nome do parâmetro Tipo de dados Obrigatório Descrição
SysId String Sim Sys_id do arquivo anexado.
HasBytes Booleano Não Define se o download do conteúdo será feito em bytes.

Parâmetros de saída da ação DownloadAttachment

Essa ação retorna se o download é verdadeiro ou falso usando o parâmetro "Sucesso". Se for verdadeiro, ela vai gerar o conteúdo de "DownloadAttachment".

Para ver um exemplo de como configurar a ação DownloadAttachment, consulte Exemplos.

Exemplos

Nesta seção, descrevemos como executar algumas das operações e ações da entidade neste conector.

Exemplo: fazer upload de um anexo para um incidente

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação UploadAttachment e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
  "Content": "File is uploaded",
  "TableName": "Incident",
  "TableSysId": "018f4057473ae5104593a6b5316d4357"
}

    4. Este exemplo faz upload do valor do conteúdo do payload como anexo e retorna o conjunto de parâmetros da entidade enviada . Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa UploadAttachment terá um valor semelhante a este:

    {
"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": ""
}

Exemplo: baixar um anexo de um incidente

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DownloadAttachment e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
  "SysId": "440c3995471fe1104593a6b5316d4384"
}

    4. Este exemplo retorna se o download é verdadeiro ou falso usando o parâmetro "Sucesso" e, se for verdadeiro, mostra o conteúdo de "DownloadAttachment". Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DownloadAttachment terá um valor semelhante a este:

    [{
"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. "
}]

Exemplos de operações de entidade

Nesta seção, mostramos como realizar algumas das operações de entidade neste conector.

Exemplo: GET de um único registro para a entidade "Incident"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione "Incidente" na lista Entity.
  3. Selecione a operação GET e clique em Concluído.
  4. Defina o ID da entidade como "0c5f3cece1b12010f877971dea0b1449", que é a chave a ser transmitida. Para definir o ID da entidade, na seção Data Mapper do Data Mapping, clique em Open Data Mapping Editor e insira "0c5f3cece1b12010f877971dea0b1449" no campo Input Value. Escolha EntityId como variável local.

Limitações do sistema

O conector do ServiceNow pode processar no máximo 10 transações por segundo, por nó, e limita qualquer transação além desse limite. Por padrão, o Integration Connectors aloca dois nós (para melhor disponibilidade) para uma conexão.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

Criar conexões usando o Terraform

Use o recurso do Terraform para criar uma conexão.

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.

Para conferir um modelo de exemplo do Terraform para criação de conexão, consulte modelo de exemplo.

Ao criar essa conexão usando o Terraform, defina as seguintes variáveis no arquivo de configuração do Terraform:

Nome do parâmetro Tipo de dados Obrigatório Descrição
proxy_enabled BOOLEAN Falso Marque esta caixa de seleção para configurar um servidor proxy para a conexão.
proxy_auth_scheme ENUM Falso O tipo de autenticação a ser usado para autenticar o proxy ProxyServer. Os valores aceitos são: BASIC, DIGEST, NONE
proxy_user STRING Falso Um nome de usuário a ser usado para autenticar no proxy ProxyServer.
proxy_password SECRET Falso Uma senha a ser usada para autenticar no proxy ProxyServer.
proxy_ssltype ENUM Falso O tipo de SSL a ser usado ao se conectar ao proxy ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, TUNNEL
include_system_tables BOOLEAN Falso Controla se as tabelas do sistema serão expostas ou não.
filter_tables STRING Falso Especifique as tabelas que você quer em uma lista separada por vírgulas.

Usar a conexão do ServiceNow em uma integração

Depois de criar a conexão, ela fica disponível na integração da Apigee e Application Integration. É possível usar a conexão em uma integração pela tarefa de conectores.

  • Para entender como criar e usar a tarefa "Conectores" na integração da Apigee, consulte Tarefa "Conectores".
  • Para entender como criar e usar a tarefa "Conectores" na Application Integration, consulte Tarefa "Conectores".

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir