Relação entre propriedades de pedidos no AFLS e campos de entidade no ServiceNow

Para realizar a integração, é necessário relacionar os campos onde obteremos as informações AFLS e ServiceNow através da seção “WorkOrder” do arquivo de configuração.

Estrutura JSON

{
  "workOrder": [
      {
      "table": "",
      "reference": "",
      "dataSource":"",
      "definition": {
        "note": {
          "type": "",
          "key": ""
        },
        "subject": {
          "type": "",
          "key": ""
        },
        "description": {
          "type": "",
          "key": ""
        },
        "service": {
          "type": "",
          "searchBy": "",
          "key": "",
          "defaultValue": {
            "id": 0,
            "value": ""
          },
          "onError": [
            {
              "action": "",
              "message": "'{0}'"
            }
          ]
        },
        "priority": {
          "type": "",
          "defaultValue": {
            "id": 0,
            "value": ""
          },
          "onError": [
            {
              "action": "",
              "message": ""
            }
          ],
          "key": ""
        },
        "client": {
          "type": "",
          "searchBy": "",
          "searchAfls": "Email,Name",
          "defaultValue": {
            "id": 0,
            "value": ""
          },
          "onError": [
            {
              "action": "",
              "message": ""
            }
          ],
          "key": ""
        },
        "company": {
          "type": "",
          "searchBy": "",
          "defaultValue": {
            "id": 0,
            "value": ""
          },
          "onError": [
            {
              "action": "",
              "message": ""
            }
          ],
          "key": ""
        },
        "location": {
          "type": "",
          "key": ""
        }
      }
    }
  ]
}

Propriedades :

Definição

Para realizar a integração, é necessário relacionar os campos da ordem de trabalho no Aranda AFLS com os campos do ServiceNow usando a seção “definição” do arquivo de configuração.

Propriedades:

Propriedades internas

{
  "key": "",
  "searchBy": "",
  "searchAfls": "",
  "type": "",
  "defaultValue": {
    "id": 0,
    "value": ""
  },
  "onError": [
    {
        "action": "",
        "message": ""
    }
  ]
}

Detalhe para campos de cordas

• Campos de string no ServiceNow são aqueles que permitem armazenar informações alfanuméricas, como nomes, descrições ou qualquer outro tipo de texto. Ao relacionar esses campos aos campos equivalentes no AFLS, é importante garantir que o tipo de associação selecionado seja compatível com o tipo de dado de string para garantir a sincronização e atualização corretas das informações entre ambas as plataformas.
• O tipo de associação que eles apoiam é Valor do campo.
• Não consigo relacionar campos de escolha ou referência.
• Não suporta defaults.
• Ele não suporta a propriedade onError.
• Não suporta a busca por propriedade.
• Ele não suporta a propriedade searchAfls.

Detalhamento do Campo de Serviço

• Permite sincronização com os campos string, escolha, referência e numéricos no ServiceNow.
• O tipo de associação que eles apoiam é Valor do campo, NotMapped e Mapeador.
• Suporta padrão.
• Suporta a propriedade onError.
• Ele não suporta a propriedade searchAfls.
• Sempre é recomendado ter um valor padrão para atribuir, pois é uma propriedade obrigatória.

Detalhes do campo do cliente

• Permite sincronização com os campos string, escolha, referência e numéricos no ServiceNow.
• O tipo de associação que eles apoiam é Valor do campo, NotMapped e Mapeador.
• Suporta padrão.
• Suporta a propriedade onError.
• A propriedade searchAfls determina o valor (Nome, E-mail) que será enviado para buscar no ServiceNow para encontrar o cliente; se não encontrar o cliente no ServiceNow, a ação atribuída na propriedade onError será executada
• Sempre é recomendado ter um valor padrão para atribuir, pois é uma propriedade obrigatória.

Detalhe de campo

• Permite sincronização com os campos string, escolha, referência e numéricos no ServiceNow.
• O tipo de associação que eles apoiam é Valor do campo e Mapeador.
• Suporta padrão.
• Suporta a propriedade onError.
• Ele não suporta a propriedade searchAfls.
• Para a propriedade de “prioridade”, se um valor não for adicionado, ele passa a ser 0 por padrão.

Detalhe para o campo Endereço

• No ServiceNow, os locais estão registrados no “cmn_location”, o corpo associado a essa propriedade deve estar associado a ela.
• O tipo de associação que eles apoiam é Valor do campo.
• Áreas além da referência (cmn_location) não podem ser relacionadas.
• Não suporta defaults.
• Ele não suporta a propriedade onError.
• Não suporta a busca por propriedade.
• Ele não suporta a propriedade searchAfls.
• A localização será pesquisada por latitude e longitude; se não for encontrada, será criada uma marca na entidade (cmn_location).

Tipos de relacionamento ou associação de campos

Em seguida, você pode exibir informações sobre como os tipos funcionam na propriedade type descrita na tabela acima.

Propriedade “onError”

1. A matriz onError permite que você execute uma ação se o item não for encontrado na plataforma; Repetir uma ação gera erro.

2. As ações que você pode tomar se não encontrar o item que procura na plataforma são:

   “Criar uma nota na plataforma” (createNote), na propriedade onError.message Permite personalizar a mensagem que será exibida na nota. É recomendável adicionar os seguintes caracteres “{0}” que será substituído pelo ID do item que está sendo pesquisado.

   “Erro de retorno consumindo a API de integração” (returnError), na propriedade onError.message permite que você personalize a mensagem que será exibida na mensagem de erro, é recomendável adicionar os seguintes caracteres “{0}” que eles substituirão pelo ID do item que está sendo pesquisado.

Propriedade “valorPadrão”

1. A propriedade defaultValue permite adicionar valores padrão, se você adicionar essa propriedade com o valor de true, o sistema solicitará a adição do valor padrão dentro das propriedades destinadas à relação de valor.
2. Para os campos “projeto, serviço, categoria”, você não poderá adicionar um valor padrão porque eles são valores necessários para a criação de caso e você precisa estabelecer uma relação com os valores do ServiceNow.
3. Um valor padrão só pode ser adicionado se o tipo de mapeamento for “Mapeador” ou “ValorDoCampo”.

Exemplo:

1. Defina o valor “wm_order” na propriedade mesa:
2. Na definição do Ordem de trabalho Assuma a propriedade Cliente (cliente)
3. “type”: Atribua o tipo de associação como Valor do campo:
4. “key”: nomeie a propriedade no ServiceNow como Chamador, as propriedades podem ser do tipo Referência, escolha, dados ( Tipo de propriedades no ServiceNow):
5. “defaultValue”: atribua o defaultValue:

{
  "workOrder": [
    {
      "table": "wm_order",
      "definition": {
        "client": {
          "type": "FieldValue",
          "key": "caller",
          "defaultValue": {
             "id": 222,
             "value": "sys_id_client"
          }
        }
      }
    }
  ]
}

⚐ Nota: Recomenda-se escrever o sys_id (se for uma Referência) ou o “valor” (se for uma Escolha) do usuário a ser relacionado.***

Propriedade “fonte de dados”

A propriedade “fonte de dados” permite que a integração determine qual plataforma será a fonte de informação, por defeito o seu valor é “Ambos”:

Exemplo de tipo NotMapped

1. Defina o valor “wm_order” na propriedade mesa:
2. Na definição do Ordem de trabalho Veja o Serviço de Propriedade (serviço) e atribua o tipo de associação como NotMapped:

{
    "workOrder": [
        {
            "table": "wm_order",
            "definition": {
                "service": {
                    "type": "NotMapped"
                }
            }
        }
    ]
}

1. A relação implica que um valor padrão deve ser atribuído para todos Ordens de Trabalho, isso é conseguido usando a propriedade “defaultValue”, conforme mostrado abaixo:

{
    "workOrder": [
        {
            "table": "wm_order",
            "reference": "reference_1",
            "definition": {
                "service": {
                    "type": "NotMapped",
                    "defaultValue": {
                        "id": 222
                    }
                }
            }
        }
    ]
}

⚐ Nota: O Ordens de Trabalho designados para a classe “wm_order” na AFLS serão designados para serviço com ID 222.

Exemplo de tipo Mapeador>

1. Defina o valor “wm_order” na propriedade mesa:
2. Na definição do Ordem de trabalho Assuma a propriedade Cliente (cliente)
3. “type”: Atribua o tipo de associação como Mapeador:
4. “key”: nomeie a propriedade no ServiceNow como Chamador, as propriedades podem ser do tipo Referência, escolha, dados (Tipo de propriedades no ServiceNow):
5. “searchAfls”: Atribua o valor (Nome, E-mail) que será enviado para buscar no ServiceNow para encontrar o cliente:

{
    "workOrder": [
        {
            "table": "wm_order",
            "reference": "reference_1",
            "definition": {
                "client": {
                    "key": "caller",
                    "type": "NotMapped",
                    "searchAfls": "Email"
                }
            }
        }
    ]
}

1. A relação implica que os clientes da AFLS devem estar associados aos clientes do ServiceNow; Recomenda-se que escreva o sys_id do cliente a ser parente, conforme mostrado abaixo:

{
    "workOrder": [
        {
            "table": "wm_order",
            "reference": "reference_1",
            "definition": {
                "client": {
                    "key": "caller",
                    "type": "NotMapped",
                    "searchAfls": "Email"
                }
            }
        }
    ],
    "client": [
        {
            "id": 5,
            "value": "sys_id_client_servicenow",
            "reference": "reference_1"
        }
    ]
}

⚐ Nota: O ID de cliente AFLS “5” está relacionado ao cliente “sys_id_client_servicenow” no ServiceNow***

Exemplo de tipo Valor do campo>

1. Defina o valor “wm_order” na propriedade mesa:
2. Na definição do Ordem de trabalho Empresa de Assumir a Propriedade (empresa)
3. “type”: Atribua o tipo de associação como Valor do campo:
4. “key”: nomeie a propriedade no ServiceNow como Companhia; propriedades podem ser do tipo Referência, escolha, dados (Tipo de propriedades no ServiceNow); a propriedade atribuída é do tipo Reference; Esse tipo de propriedade requer que o searchBy atribuído um valor (nome pelo qual a entidade referenciada será pesquisada):
5. “searchBy”: nomeie a propriedade a ser pesquisada na entidade referenciada:

{
  "workOrder": [
    {
      "table": "wm_order",
      "definition": {
        "company": {
          "type": "FieldValue",
          "key": "company",
          "searchBy": "name"
        }
      }
    }
  ]
}

⚐ Nota: Propriedades referenciadas a outras classes (tabelas) no ServiceNow são compostas por propriedades diferentes. Para permitir que o item seja pesquisado, é necessário especificar o nome desse campo. Na busca de itens, o nome/exibição do item AFLS é usado por terceiros; o ID ou outra propriedade não é utilizada; se houver muitos itens com o mesmo nome no ServiceNow, selecione o tipo de relacionamento como “Mapper” para relacionar os itens por IDs - sys_id.***

↩ Voltar para Configurações