Partilhar via


Copiar dados do ServiceNow V2 usando o Azure Data Factory ou o Synapse Analytics

APLICA-SE A: Azure Data Factory Azure Synapse Analytics

Tip

Experimente o Data Factory no Microsoft Fabric, uma solução de análise tudo-em-um para empresas. O Microsoft Fabric abrange tudo, desde a movimentação de dados até ciência de dados, análises em tempo real, business intelligence e relatórios. Saiba como iniciar uma nova avaliação gratuitamente!

Este artigo descreve como usar a Atividade de Cópia no Azure Data Factory e os pipelines do Synapse Analytics para copiar dados do ServiceNow. Ele se baseia no artigo de visão geral da atividade de cópia que apresenta uma visão geral da atividade de cópia.

Important

O conector ServiceNow V1 está no estágio de remoção. Recomenda-se atualizar o conector ServiceNow de V1 para V2.

Capacidades suportadas

Este conector ServiceNow é suportado para os seguintes recursos:

Capacidades suportadas IR
Atividade de cópia (fonte/-) (1) (2)
Atividade de pesquisa (1) (2)

① Ambiente de execução de integração do Azure ② Ambiente de execução de integração auto-hospedado

Para obter uma lista de armazenamentos de dados suportados como fontes/coletores, consulte a tabela Armazenamentos de dados suportados .

O serviço fornece um driver interno para habilitar a conectividade. Portanto, você não precisa instalar manualmente nenhum driver usando esse conector.

Prerequisite

Para usar esse conector, você precisa ter uma função com pelo menos acesso de leitura às tabelas sys_db_object, sys_db_view e sys_dictionary no ServiceNow.

Para acessar modos de exibição no ServiceNow, você precisa ter uma função com pelo menos acesso de leitura a tabelas sys_db_view_table e sys_db_view_table_field .

Como Começar

Para executar a atividade de cópia com um pipeline, você pode usar uma das seguintes ferramentas ou SDKs:

Criar um serviço vinculado ao ServiceNow usando a interface do usuário

Use as etapas a seguir para criar um serviço vinculado ao ServiceNow na interface do usuário do portal do Azure.

  1. Navegue até a guia Gerenciar em seu espaço de trabalho do Azure Data Factory ou Synapse e selecione Serviços Vinculados e clique em Novo:

  2. Procure ServiceNow e selecione o conector ServiceNow.

    Captura de ecrã do conector ServiceNow.

  3. Configure os detalhes do serviço, teste a conexão e crie o novo serviço vinculado.

    Captura de tela da configuração do serviço vinculado para ServiceNow.

Detalhes de configuração do conector

As seções a seguir fornecem detalhes sobre as propriedades usadas para definir entidades do Data Factory específicas para o conector ServiceNow.

Propriedades do serviço vinculado

As seguintes propriedades são suportadas para o serviço associado ServiceNow:

Property Description Required
tipo A propriedade type deve ser definida como: ServiceNowV2 Yes
ponto final O ponto de extremidade do servidor ServiceNow (http://<instance>.service-now.com). Yes
authenticationType O tipo de autenticação a ser usado.
Os valores permitidos são: Basic, OAuth2
Yes
nome de utilizador O nome de usuário usado para se conectar ao servidor ServiceNow para autenticação Basic e OAuth2. Yes
palavra-passe A senha correspondente ao nome de usuário para autenticação Basic e OAuth2. Marque este campo como um SecureString para armazená-lo com segurança ou faça referência a um segredo armazenado no Cofre de Chaves do Azure. Yes
clientId O ID do cliente para autenticação OAuth2. Sim para autenticação OAuth
clientSecret O segredo do cliente para a autenticação OAuth2. Marque este campo como um SecureString para armazená-lo com segurança ou faça referência a um segredo armazenado no Cofre de Chaves do Azure. Sim para autenticação OAuth
grantType Especifica o tipo de fluxo OAuth2.0 que o aplicativo cliente usa para acessar o token. O valor padrão é senha. Sim para autenticação OAuth

Example:

{
    "name": "ServiceNowLinkedService",
    "properties": {
        "type": "ServiceNowV2",
        "typeProperties": {
            "endpoint" : "http://<instance>.service-now.com",
            "authenticationType" : "Basic",
            "username" : "<username>",
            "password": {
                 "type": "SecureString",
                 "value": "<password>"
            }
        }
    }
}

Propriedades do conjunto de dados

Para obter uma lista completa de seções e propriedades disponíveis para definir conjuntos de dados, consulte o artigo sobre conjuntos de dados . Esta seção fornece uma lista de propriedades suportadas pelo conjunto de dados ServiceNow.

Para copiar dados de ServiceNow, defina a propriedade type do conjunto de dados como ServiceNowV2Object. As seguintes propriedades são suportadas:

Property Description Required
tipo A propriedade type do conjunto de dados deve ser definida como: ServiceNowV2Object Yes
tableName Nome da tabela. Yes
valueType O tipo de valores da tabela ServiceNow. O valor dessa propriedade pode ser display ou actual (padrão). Você pode encará-lo como o parâmetro sysparm_display_value sendo verdadeiro ou falso ao chamar as APIs REST do ServiceNow. No

Example

{
    "name": "ServiceNowDataset",
    "properties": {
        "type": "ServiceNowV2Object",
        "typeProperties": {
            "tableName": "<table name>",
            "valueType": "actual"
        },
        "schema": [],
        "linkedServiceName": {
            "referenceName": "<ServiceNow linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

Propriedades da atividade de cópia

Para obter uma lista completa de seções e propriedades disponíveis para definir atividades, consulte o artigo Pipelines . Esta seção fornece uma lista de propriedades suportadas pela fonte ServiceNow.

ServiceNow como fonte

Para copiar dados do ServiceNow, defina o tipo de origem na atividade de cópia como ServiceNowV2Source. As seguintes propriedades são suportadas na seção de origem da atividade de cópia:

Property Description Required
tipo A propriedade type da fonte de atividade de cópia deve ser definida como: ServiceNowV2Source Yes
expressão Use a expressão para ler dados. Você pode configurar a expressão no Construtor de consultas. Ele tem o mesmo uso que o construtor de condições no ServiceNow. Para obter instruções sobre como usá-lo, consulte este artigo. Você também pode usar parâmetros de expressão. Observe que você deve usar o valor real em vez do valor de exibição. No
Em expression
tipo O tipo de expressão. Os valores podem ser Constante (padrão), Unário, Binário, Campo e Nário. No
value O valor constante. Sim quando o tipo de expressão é Constante ou Campo
operators O valor do operador. Para obter mais informações sobre operadores, consulte a seção Operadores disponíveis para campos de escolha contendo cadeias de caracteres neste artigo. Sim quando o tipo de expressão é Unário ou Binário
operands Lista de expressões às quais o operador é aplicado. Sim quando o tipo de expressão é Unário ou Binário
pageSize O número de documentos por página do resultado da consulta. Recomenda-se definir o tamanho da página entre 5.000 e 10.000 para permitir leituras multifio. No
(o padrão é 300)

Example:

"activities": [
    {
        "name": "CopyFromServiceNow",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<ServiceNow input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "ServiceNowV2Source",
                "expression": {
                    "type": "Nary",
                    "operators": [
                        "<"
                    ],
                    "operands": [
                        {
                            "type": "Field",
                            "value": "u_founded"
                        },
                        {
                            "type": "Constant",
                            "value": "2000"
                        }
                    ]
                },
                "pageSize": 300
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Usando parâmetros de expressão

Você pode configurar o parâmetro de expressão no Construtor de consultas selecionando Adicionar conteúdo dinâmico. O tipo de parâmetro deve ser Object e o valor deve seguir o formato mostrado no exemplo JSON abaixo:

 {
	"type": "Nary",
	"operators": [
		"="
	],
	"operands": [
		{
			"type": "Field",
			"value": "col"
		},
		{
			"type": "Constant",
			"value": "val"
		}
	]
}

Aqui está um exemplo do JSON de origem usando o parâmetro expression:

"activities": [
    {
        "name": "CopyFromServiceNow",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<ServiceNow input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "ServiceNowV2Source",
                "expression": {
                    "type": "Expression",
                    "value": "@pipeline().parameters.expressionParameter"
                }
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Observação

A coluna sys_tags e suas colunas derivadas não podem ser obtidas devido a limitações da API ServiceNow.

Propriedades da atividade de consulta

Para saber detalhes sobre as propriedades, verifique Atividade de pesquisa.

Atualizar o conector ServiceNow

Aqui estão as etapas que ajudam você a atualizar seu conector ServiceNow:

  1. Crie um novo serviço vinculado consultando as propriedades do serviço vinculado.
  2. A consulta na origem é atualizada para o construtor de consultas, que tem o mesmo uso que o construtor de condições no ServiceNow. Saiba como configurá-lo referindo-se ao ServiceNow como origem.

Diferenças entre ServiceNow V2 e V1

O conector ServiceNow V2 oferece novas funcionalidades e é compatível com a maioria dos recursos do conector ServiceNow V1. A tabela abaixo mostra as diferenças de funcionalidades entre V2 e V1.

ServiceNow V2 ServiceNow V1
useEncryptedEndpoints, useHostVerification e usePeerVerification não são suportados no serviço vinculado. Suporte useEncryptedEndpoints, useHostVerification e usePeerVerification no serviço vinculado.
Suporte Construtor de consultas na origem. O construtor de consultas não é suportado na origem.
Não há suporte para consultas baseadas em SQL. Suporte a consultas baseadas em SQL.
As consultas sortBy não são suportadas no Construtor de consultas. Suporte para consultas com ordenação por no Query.
Você pode exibir o esquema no conjunto de dados. Não é possível visualizar o esquema no conjunto de dados.
Você pode configurar valueType para display ou actual em conjuntos de dados. O nome da tabela real ou de exibição é usado como o valor de tableName.

O nome da coluna é [column name] para exibição e valor real.
O nome da tabela exibida ou real com o prefixo "Display" ou "Atual" acrescentado é usado como o valor de tableName.

O nome da coluna para o valor real é [column name]_value, enquanto para o valor de exibição é [column name]_display_value.

Para obter uma lista de armazenamentos de dados suportados como fontes e destinos pela atividade de cópia, consulte armazenamentos de dados suportados.