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 Servicenow, execute as seguintes tarefas:

  • No seu projeto do Google Cloud, faça o seguinte:
    • Conceda o papel do IAM roles/connectors.admin ao usuário que estiver 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.

  • Forneça acesso às seguintes tabelas na 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 Segurança do sistema > Controles de acesso (ACL).
    2. Selecione Novo para criar um objeto de controle de acesso.
    3. Em Tipo, selecione registro.
    4. Em Operação, selecione leitura.
    5. Em Nome, selecione Tabela [sys_db_object] no primeiro menu suspenso e --None-- no segundo.
    6. Na seção Requer papel, clique duas vezes na caixa de texto Inserir uma nova linha...., depois pesquise e selecione o papel desejado.
    7. Clique em Enviar para criar o objeto da ACL.
    8. Atribua o papel que tem a ACL criada ao usuário autenticador. Para fazer isso, acesse Administração do usuário > Usuários > Selecionar usuário de autenticação > Papéis > Editar... > . e, em seguida, adicione o papel da sua coleção.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). 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, siga estas etapas:

  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 acessar 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 63 caracteres.
    4. Como opção, insira uma Descrição para a instância de conexão.
    5. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
    6. Para usar a conexão para inscrições de eventos, selecione Ativar inscrição de eventos. Ao fazer isso, as seguintes opções são exibidas:
      • Ativar assinatura de evento 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 inscrição de eventos: selecione esta opção para usar a conexão somente para inscrições de eventos.

      Para essas duas seleções, você precisa configurar os detalhes do evento nas etapas subsequentes.

    7. 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.

    8. Usar proxy: marque esta caixa de seleção para configurar um servidor proxy para a conexão e defina os seguintes valores:
      • Esquema de autenticação de proxy: selecione o tipo de autenticação para autenticar com o servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
        • Básico: autenticação HTTP básica.
        • Resumo: autenticação HTTP de resumo.
      • Usuário proxy: um nome de usuário a ser usado para autenticar com o servidor proxy.
      • Senha de proxy: a chave secreta do Secret Manager da senha do usuário.
      • Tipo de SSL de proxy: o tipo de SSL a ser usado para se conectar ao servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
        • Automático: configuração padrão. Se o URL for HTTPS, a opção Túnel será usada. Se o URL for HTTP, a opção NUNCA será usada.
        • Sempre: a conexão será sempre com SSL ativado.
        • Nunca: a conexão não está com SSL ativado.
        • Túnel: a conexão é feita por um proxy de encapsulamento. O servidor proxy abre uma conexão com o host remoto e o tráfego flui de ida e volta pelo proxy.
      • Na seção Servidor proxy, insira os detalhes do servidor proxy.
        1. Clique em + Adicionar destino.
        2. Selecione um Tipo de destino.
          • Endereço do host: especifique o nome do host ou o endereço IP do destino.

            Se quiser estabelecer uma conexão privada com seu sistema de back-end, faça o seguinte:

    9. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
    10. 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.
      • Selecione Endereço do host na lista para especificar o nome do host ou o endereço IP do destino.
      • Para estabelecer uma conexão particular com seus sistemas de back-end, Selecione Anexo de endpoint na lista e depois selecione o anexo de endpoint necessário. na lista Endpoint Attachment.

      Se você quiser 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, em seguida, configure as regras de firewall para colocar na lista de permissões 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.

      Os seguintes tipos de autenticação são compatíveis com a conexão Servicenow:

      • 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ê tiver ativado a assinatura de eventos, a seção Detalhes da assinatura do evento vai aparecer na página de criação de conexão. Para entender como configurar os detalhes da assinatura de eventos, consulte Configurar a 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: secret do Secret Manager que contém a senha associada ao nome de usuário do ServiceNow.

Configurar a assinatura de eventos [Prévia]

Se você tiver ativado a assinatura do evento, insira os seguintes valores na seção Detalhes da assinatura do evento:

  • Token de autenticação: (opcional) selecione o secret do Secret Manager do token de autenticação e a versão do secret correspondente na lista suspensa Versão do secret.
  • Algoritmo HMAC: (opcional) selecione o algoritmo HMAC para criptografar o payload de resposta.
  • Chave secreta HMAC: se você selecionou um algoritmo HMAC, selecione o secret do Secret Manager da chave HMAC e a versão do secret correspondente na lista suspensa Versão do secret.

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

Para concluir a configuração da inscrição no evento, é preciso registrar o URL do webhook com seu aplicativo ServiceNow. Portanto, depois que a conexão for criada, execute as seguintes etapas extras:

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

      transformação

      (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ê receberia da página de detalhes da conexão dos Integration Connectors.
      • AUTHENTICATION_TOKEN: o texto real do token de autenticação que você configurou para a conexão.
      • EVENT_TYPE: o texto real para o tipo de evento que você configurou no acionador do ServiceNow.
      • CUSTOM_FIELDS: o corpo da solicitação sempre precisa ter o campo eventType. Além desse campo, é possível adicionar outros campos com base na sua solicitação.
      • SECRET_KEY: o texto real da chave secreta que você configurou para a conexão.
      • ENCRYPTION_ALGORITHM: precisa ser qualquer um destes 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);

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 for compatível com nenhuma das operações da entidade, essas operações sem suporte não serão incluídas na lista de 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 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 suportadas pela conexão Servicenow.

Ação UploadAttachment

Esta ação faz upload de um arquivo como anexo de 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 No Conteúdo de string para fazer upload como arquivo.
ContentBytes String No Conteúdo de bytes para upload como arquivo.
HasBytes Booleano No Define se o upload de conteúdo será feito como bytes.
TableName String No Nome da tabela à qual o arquivo será anexado.
TableSysId String No Sys_id do registro na tabela especificada por TableName à qual você deseja anexar o arquivo.

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

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

Para saber como configurar a ação UploadAttachment, consulte Exemplos.

Ação de DownloadAttachment

Esta 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 de anexo.
HasBytes Booleano No 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 é True ou false por meio do parâmetro Success e, se True, gera o conteúdo de DownloadAttachment

Para saber como configurar a ação DownloadAttachment, consulte Exemplos.

Examples

Esta seção descreve como executar algumas das operações e ações de 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 Task Input 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 Content de Payload como anexo e retorna o conjunto de Parameters para a entidade enviada . Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa UploadAttachment terá um valor semelhante ao seguinte:

    {
                      "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: fazer o download de 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 Task Input 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 é True ou false por meio do parâmetro Success e, se True, gera 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 ao seguinte:

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

Limitações do sistema

O conector ServiceNow pode processar no máximo 10 transações por segundo, por nó e limitar todas as transações 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.

Usar o Terraform para criar conexões

É possível usar o recurso do Terraform para criar uma nova conexão.

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

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

Ao criar essa conexão usando o Terraform, você precisa definir 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 do ProxyServer. Os valores aceitos são: BASIC, DIGEST, NONE
proxy_user STRING Falso Um nome de usuário a ser usado para autenticar o proxy do ProxyServer.
proxy_password SECRET Falso Uma senha a ser usada para autenticação no proxy ProxyServer.
proxy_ssltype ENUM Falso O tipo de SSL a ser usado na conexão com o 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 Servicenow em uma integração

Depois que você cria a conexão, ela fica disponível na Apigee Integration e no Application Integration. É possível usar a conexão em uma integração por meio da tarefa "Conectores".

  • Para entender como criar e usar a tarefa "Conectores" na integração da Apigee, consulte a Tarefa "Conectores".
  • Para entender como criar e usar a tarefa Conectores no 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