Introdução à sincronização de processo remoto
Aprenda os conceitos básicos de configuração de uma integração de sincronização de processo remoto para vincular os processos automatizados entre duas ou mais ServiceNow® instâncias.
Antes de começar com a integração da Sincronização de processo remoto
- Como criar sua integração e
- Como gerenciar sua integração
Criar sua integração envolve criar e configurar uma definição de sincronização de processo e seus registros relacionados. Para obter mais informações sobre como começar a criar sua integração de sincronização de processo remoto, siga um exemplo de como Crie sua primeira integração de sincronização de processo remotoou saiba mais sobre definições de sincronização de processo.
Gerenciar sua integração envolve o monitoramento das filas de saída e de entrada e a verificação de erros relacionados a quaisquer definições de sincronização de processo acionadas. Para obter mais informações sobre como monitorar e verificar erros com a integração da Sincronização de processo remoto, consulte Filas de saída e filas de entrada e Como monitorar e solucionar problemas de integração. Você também pode avaliar periodicamente os fluxos de saída e de entrada que são executados automaticamente para sua integração e determinar se deve fazer mudanças nesses fluxos em Workflow Studio.
Definições de sincronização de processo
| Campo | Descrição |
|---|---|
| Nome | Insira um nome que descreva com precisão com qual parte do processo de negócios sua instância lida. Por exemplo, se os usuários em sua instância trabalharem para atender às solicitações do Catálogo de serviços para seus clientes, insira um nome como Execução de solicitação do Catálogo de serviços. |
| Descrição | Opcionalmente, descreva com qual parte do seu processo de negócios essa definição de sincronização de processo lida. |
| Aplicação | Definido automaticamente para o escopo da aplicaçãoatual. |
| Domínio | Se o seu processo estiver relacionado a um domínio específico, escolha um domínio diferente de global. Para obter mais informações, consulte Separação de domínios para provedores de serviço. |
- Definições de captura
- Processar eventos
- Sistemas remotos
- Fluxos de saída
- Fluxos de entrada
Definições de captura
Uma definição de captura especifica quando sua instância deve enviar dados para uma instância remota e quais dados sua instância deve enviar. Uma definição de captura contém as configurações do gatilho da definição de sincronização de processo e dos campos capturados. O gatilho especifica qual operação de registro, como criar, atualizar ou excluir um registro, faz com que sua instância envie dados para uma instância remota. Quando uma definição de captura é acionada, ela cria um objeto a partir de um registro de origem, que contém campos capturados. Em seguida, o fluxo de saída começa a ser executado e correlaciona os campos capturados do registro de origem aos campos em um registro relacionado no sistema remoto.
Um registro de definição de captura tem os seguintes campos:
| Campo | Descrição |
|---|---|
| Processar evento | No formulário Definição de captura, use a pesquisa usando o ícone de lista ( |
| Estado | Escolha Ativo para ativar esta definição de captura para que a definição de sincronização do processo primário seja acionada quando as condições definidas na seção Gatilho deste formulário forem atendidas. |
| Ordem | Insira um valor para a ordem na qual você deseja que sua definição de captura seja acionada em relação a outras definições de captura. Os valores de ordem inferior são respeitados antes dos valores de ordem superior. |
| Aplicação | Definido automaticamente para o escopo da aplicaçãoatual. |
| Domínio | Se o seu processo estiver relacionado a um domínio específico, escolha um domínio diferente de global. Para obter mais informações, consulte Separação de domínios para provedores de serviço. |
Na seção Gatilho, escolha uma tabela de origem autorizada cujos registros você deseja que acionem a definição de sincronização do processo. Você também pode adicionar condições de campo que, quando atendidas, fazem com que a definição de sincronização do processo seja acionada. Quando as condições são atendidas para o gatilho especificado na definição de captura, todos os fluxos de saída associados à definição de sincronização de processo começam a ser executados. Para obter mais informações, consulte Fluxos de saída e fluxos de entrada.
| Campo | Descrição |
|---|---|
| Nome da tabela de origem | Escolha uma tabela autorizada cujos registros acionarão sua definição de sincronização de processo sempre que os registros forem criados, atualizados e excluídos. |
| Filtrar | Use o construtor de condições para adicionar condições que, quando atendidas, acionarão a definição de sincronização do processo. Por exemplo, selecionar faz com que a definição de sincronização do processo seja acionada sempre que um registro no Estado da tabela selecionada é atualizado para Trabalho em andamento. |
Por fim, na seção Capturar, adicione à lista Selecionado os campos que você deseja incluir na carga útil do fluxo de saída.
| Campo | Descrição |
|---|---|
| Incluir campos | Adicione campos à lista Selecionada que você deseja sincronizar com campos na instância remota sempre que a definição de sincronização do processo for acionada. Use o ícone Nota:
|
| Incluir anexos | Se selecionado, todos os anexos associados aos registros de acionamento em sua instância local serão sincronizados com anexos em registros correlacionados na instância remota. Para obter mais informações, consulte |
Processar eventos
Um evento de processo especifica qual parte do processo de negócios começa na instância local e termina na instância remota. O registro de evento de processo em sua instância local e na instância remota deve ter o mesmo nome porque o evento de processo significa o link entre essas instâncias que permite que elas compartilhem partes do mesmo processo de negócios. Um registro de evento de processo tem os seguintes campos:
| Campo | Descrição |
|---|---|
| Nome | Insira um nome que descreva a parte do processo de negócios que começa na instância local e termina na instância remota. Por exemplo, se os usuários em sua instância solicitarem o software que será provisionado na instância remota, você poderá nomear o evento de processo O usuário solicita software. Nota: Um administrador da instância remota, ou instâncias remotas, também deve criar um evento de processo com o mesmo nome que você usa aqui. A criação desses eventos de processo em instâncias separadas cria o link lógico que permite integrar dados entre várias instâncias. |
| Aplicação | Definido automaticamente para o escopo da aplicaçãoatual. |
| Domínio | Se o seu processo estiver relacionado a um domínio específico, escolha um domínio diferente de global. Para obter mais informações, consulte Separação de domínios para provedores de serviço. |
Sistemas remotos
Um sistema remoto contém as configurações das conexões de saída e de entrada relacionadas a outra instância ServiceNow. Um registro de sistema remoto tem os seguintes campos:
| Campo | Descrição |
|---|---|
| Nome | Insira um nome que descreva a instância remota. Por exemplo, se a instância for gerenciada por um de seus clientes, o Cliente A, insira a Instância do cliente A no campo de nome. |
| Descrição | Opcionalmente, insira mais detalhes que descrevam a finalidade geral da instância remota em seu processo de negócios. |
| ID externo | Insira o SYS ID do registro do sistema remoto que compartilha o mesmo evento de processo com sua instância. Para obter o SYS ID de um registro, selecione Copiar sys_id no menu de contexto ( |
| Aplicação | Definido automaticamente para o escopo da aplicaçãoatual. |
| Domínio | Se o seu processo estiver relacionado a um domínio específico, escolha um domínio diferente de global. Para obter mais informações, consulte Separação de domínios para provedores de serviço. |
| Subfluxo de erro | Selecione a pesquisa usando o ícone de lista ( |
| Alias de conexão | Selecione o ícone Pesquisar usando lista ( |
| Estado de saída | Defina como Desabilitado por padrão. Você pode alterar o valor deste campo para Ativo selecionando o link relacionado Validar e ativar sistema remoto na exibição de formulário deste registro de sistema remoto após terminar de criar o registro. |
| Usuário da API de entrada | Usuário que pode se conectar à instância remota. Este usuário deve ter credenciais que correspondam às do usuário com a função ih_process_sync_api na instância remota. |
| Executar fluxos de entrada como | Selecione a pesquisa usando o ícone de lista ( |
| Estado de entrada | Defina como Desabilitado por padrão. Você pode alterar o valor deste campo para Ativo selecionando o link relacionado Validar e ativar sistema remoto na exibição de formulário deste registro de sistema remoto após terminar de criar o registro. |
Depois de criar um registro de evento de processo e um registro de sistema remoto, você pode associar Workflow Studio subfluxos a esses registros para que as ações automatizadas sejam executadas sempre que a definição de sincronização do processo for acionada.
Fluxos de saída e eufluxos nbound
- Processar dados locais, como campos capturados na definição de captura, que serão enviados para a instância remota
- Correlacione esses dados com os dados na instância remota
- Enviar estes dados para a instância remota
Um registro de Fluxo de saída tem os seguintes campos:
| Campo | Descrição |
|---|---|
| Processar evento | Selecione a pesquisa usando o ícone de lista (ícone |
| Subfluxo de saída | Selecione a pesquisa usando o ícone de lista ( |
| Sistema remoto | Selecione a pesquisa usando o ícone de lista ( |
| Aplicação | Definido automaticamente para o escopo da aplicaçãoatual. |
| Domínio | Se o seu processo estiver relacionado a um domínio específico, escolha um domínio diferente de global. Para obter mais informações, consulte Separação de domínios para provedores de serviço. |
- Correlacionar dados na instância local com os dados enviados da instância remota
- Mapear campos enviados da instância remota para campos na instância local
- Dados de processo enviados da instância remota para a instância local
Um registro de Fluxo de entrada tem os seguintes campos:
| Campo | Descrição |
|---|---|
| Processar evento | Selecione a pesquisa usando o ícone de lista ( |
| Subfluxo de entrada | Selecione o ícone Pesquisar usando lista ( |
| Sistema remoto | Selecione a pesquisa usando o ícone de lista ( |
| Aplicação | Definido automaticamente para o escopo da aplicaçãoatual. |
| Domínio | Se o seu processo estiver relacionado a um domínio específico, escolha um domínio diferente de global. Para obter mais informações, consulte Separação de domínios para provedores de serviço. |
Antes de simplesmente escolher os subfluxos Modelo de fluxo de saída de Sincronização de processo remoto - Básica ou Modelo de fluxo de entrada de Sincronização de processo remoto - Básica fornecidos pelo sistema para sua definição de sincronização de processo, convém personalizar esses subfluxos em Workflow Studio.
Sincronizando anexos
- Na primeira vez em que um registro em sua integração é sincronizado, todos os anexos são enviados na carga de saída. As sincronizações subsequentes podem enviar mudanças para anexos ou todos os anexos.
- Os metadados do anexo são sempre enviados com a carga de saída. Esses metadados incluem uma chave sintética criptografada, hash, nome de arquivo, tipo de conteúdo e tamanho.
- A instância remota decide quais anexos receber comparando cada hash e nome de arquivo da carga de entrada com aqueles na instância. Em seguida, ocorre o seguinte processo:
- O sistema de origem valida a chave e envia anexos para o registro de correlação.
- O sistema de origem notifica o sistema remoto de que os anexos estão concluídos.
- O sistema remoto move os anexos do registro de correlação para o registro de destino.
Como sincronizar comentários e anotações de trabalho
Em sua integração, os comentários e anotações de trabalho são sincronizados entre instâncias somente quando ocorrem mudanças nesses campos de diário. Os metadados de mudança são incluídos nas cargas úteis para que os sistemas remotos possam identificar qual usuário criou o comentário ou anotação de trabalho e quando ele foi criado.
Filas de saída e filas de entrada
Depois de criar sua integração de Sincronização de processo remoto criando e configurando os registros mencionados nas seções anteriores, você pode gerenciar sua integração monitorando a fila de saída e a fila de entrada em sua instância.
Uma fila de saída contém o status, informações de erro, dados de nova tentativa e informações de contexto de fluxo para subfluxos de saída que foram executados para dados que foram enviados de sua instância. Para exibir os registros na fila de saída, navegue até .
Um registro de Estado da fila de saída tem os seguintes campos:
| Campo | Descrição |
|---|---|
| Criação | Data em que ocorreu a ação automatizada na sua integração |
| Informações do erro | Mensagem de status da carga de saída |
| Processar evento | Processar evento |
| Sistema remoto | Sistema remoto |
| Recuperar metadados | Metadados para todas as políticas de nova tentativa configuradas para sua carga de saída |
| Status | Status de processamento da carga na fila de saída. As opções incluem:
|
| Domínio | Domínio no qual a ação automatizada para sua integração foi executada |
| Contexto de subfluxo de saída | SYS ID do registro de execução para o fluxo de saída que processou a carga |
Uma fila de entrada contém o status, a sequência de processamento e as informações de correlação dos subfluxos de entrada que foram executados para dados que foram enviados de uma instância remota para sua instância local. Para exibir os registros na fila de entrada, navegue até .
Um registro de Fila de entrada tem os seguintes campos:
| Campo | Descrição |
|---|---|
| Sequência | Ordem na fila. Um número menor é processado antes de um número maior. |
| Status | Status de processamento da carga na fila de entrada. As opções incluem:
Nota: Se um registro de Fila de entrada tiver um status de Erro, altere o status para Pronto para tentar processar novamente a carga de entrada. |
| Processar evento | Processar evento associado à ação de integração |
| Operação | Tipo de operação de registro que a instância remota executou, o que fez com que a instância remota acionasse e enviasse dados. As opções incluem:
|
| Contexto de transformação | SYS ID do registro de execução do fluxo de entrada que processou a carga |
| ID de correlação local | ID de correlação na instância local |
| ID de correlação remota | ID de correlação na instância remota |
| Sistema remoto | Registrodo sistema remoto associado à instância que enviou os dados |
| Domínio | Domínio no qual a ação automatizada para sua integração foi executada |
| Carga | Cadeia de caracteres como carga JSON para dados de entrada |
Como monitorar e solucionar problemas de integração
| Tabela | Descrição |
|---|---|
| Estatísticas de XML | Consulte a seção process_sync_queue para obter informações sobre as filas de saída e de entrada da sua integração, incluindo o tamanho da fila, bem como as taxas de erro e de processamento. |
| Fila de saída | Exiba os dados de captura dos registros que são preparados para serem enviados para fora da sua instância. |
| Estado da fila de saída | Exibir o estado dos registros na tabela Fila de saída. |
| Fila de entrada | Exiba a fila de entrada e a tabela de registros combinadas. |
| Logs | Comece ativando a depuração definindo a propriedade do sistema glide.ih.process.sync.debug como verdadeira. Em seguida, verifique os logs em busca de mensagens de erro que começam com OutboundQueueDao e InboundQueueDao para encontrar mensagens de log com mais informações sobre possíveis problemas com sua integração. |
- Erros de conexão
- Os erros de conexão de saída tentam novamente várias vezes antes de definir o Estado de saída do registro do sistema remoto como Erro. Se os erros continuarem ocorrendo para uma conexão de saída, confirme se nada mudou com o usuário da API de entrada do sistema remoto, como uma mudança nas credenciais do usuário. Em seguida, valide e ative o registro do sistema remoto novamente.
- Erros de processamento de dados
- Erros de processamento de dados normalmente ocorrem como resultado de erros em um fluxo de saída ou de entrada. Para solucionar esses erros, você pode adicionar ações de manipulação de erros ao fluxo, como uma ação Registrar ou Enviar e-mail, quando o Estado do fluxo mudar para Erro. Você também pode adicionar ações que reprocessam ou ignoram o processamento de registros nas tabelas Fila de saída ou Fila de entrada se ocorrer um erro com o fluxo.