Caso | Centro de Integração Aranda

Relacionamento entre ASMS e ServiceNow

Para realizar a integração é necessário relacionar as informações do Aranda, ASMS e ServiceNow através da seção “case” do arquivo de configuração.

Estrutura JSON

{
  "case": [
    {
      "externalIdField": "",
      "table": "",
      "definition": {
        "itemType": "",
        "applicant": {
          "key": "",
          "searchBy": "",
          "type": "",
          "defaultValue": {
            "id": 0,
            "value": ""
          },
          "onError": [
              {
                "action": "",
                "message": ""
              }
          ]
        },
        "category": {
          "key": "",
          "searchBy": "",
          "type": ""
        },
        "ci": {
          "key": "",
          "searchBy": "",
          "type": "",
          "defaultValue": {
            "id": 0,
            "value": ""
          },
          "onError": [
              {
                "action": "",
                "message": ""
              }
          ]
        },
        "project": {
          "key": "",
          "searchBy": "",
          "type": ""
        },
        "responsible": {
          "key": "",
          "searchBy": "",
          "type": "",
          "defaultValue": {
            "id": 0,
            "value": ""
          },
          "onError": [
              {
                "action": "",
                "message": ""
              }
          ]
        },
        "responsibleGroup": {
          "key": "",
          "searchBy": "",
          "type": "",
          "defaultValue": {
            "id": 0,
            "value": ""
          },
          "onError": [
              {
                "action": "",
                "message": ""
              }
          ]
        },
        "service": {
          "key": "",
          "searchBy": "",
          "type": ""
        },
        "typeRegister": {
          "key": "",
          "searchBy": "",
          "type": "",
          "defaultValue": {
            "id": 0,
            "value": ""
          },
          "onError": [
              {
                "action": "",
                "message": ""
              }
          ]
        },
        "providers": {
          "key": "",
          "searchBy": "",
          "type": "",
          "defaultValue": {
            "id": 0,
            "value": ""
          },
          "onError": [
              {
                "action": "",
                "message": ""
              }
          ]
        },
        "organizationalArea": {
          "key": "",
          "searchBy": "",
          "type": "",
          "defaultValue": {
            "id": 0,
            "value": ""
          },
          "onError": [
              {
                "action": "",
                "message": ""
              }
          ]
        }
      }
    }
  ]
}

Propriedades :

Propriedades	Descrição
mesa	Entidade ou classe (tabela) referenciada no ServiceNow, incidente, problema e change_request de entidades com suporte
campoIdentificaçãoExterna	Campo em que a ID do caso do ASMS será armazenada no ServiceNow
Definição	Permite relacionar campos de caso do ASMS a campos no ServiceNow

Definição

Para realizar a integração é necessário relacionar os campos do caso no Aranda ASMS com o Caso no ServiceNow utilizando a seção “definição” do arquivo de configuração.

Propriedades:

Propriedades	Descrição
tipo de item	Tipo de caso em ASMS ao qual esta definição está associada; Na visualização de criação, você pode exibir o nome do campo como “tipo”. Os tipos suportados são Incidentes, Problema, Alteração, ServiceCall, Release
typeRegister	Representa o campo Tipo de registro do caso em Aranda e permite relacionar esse campo a um campo equivalente das classes (incidente, problema change_request) no ServiceNow.
serviço	Representa o campo Serviço do caso em Aranda e permite relacionar esse campo a um campo equivalente das classes (incidente, problema change_request) no ServiceNow.
Projeto	Representa o campo Projeto do caso em Aranda, permite relacionar este campo a outro campo equivalente das classes (incidente, problema change_request) no ServiceNow.
responsibleGroup	Representa o campo Grupo Responsável do caso em Aranda e permite relacionar esse campo a um campo equivalente das classes (incidente, problema change_request) no ServiceNow.
responsável	Representa o campo Responsável do caso em Aranda e permite relacionar esse campo a um campo equivalente das classes (incidente, problema change_request) no ServiceNow.
categoria	Representa o campo Categoria do caso em Aranda e permite relacionar esse campo a um campo equivalente das classes (incidente, problema change_request) no ServiceNow.
candidato	Representa o campo Candidato do caso em Aranda e permite relacionar esse campo a um campo equivalente das classes (incidente, problema change_request) no ServiceNow.
Ci	Representa o campo CI do caso em Aranda e permite relacionar esse campo a um campo equivalente das classes (incidente, problema change_request) no ServiceNow.
Companhia	Representa o campo Companhia do caso em Aranda e permite relacionar esse campo a um campo equivalente das classes (incidente, problema change_request) no ServiceNow.
cliente	Representa o campo Cliente do caso em Aranda e permite relacionar esse campo a um campo equivalente das classes (incidente, problema change_request) no ServiceNow.
Provedores	Representa o campo Fornecedores do caso em Aranda e permite relacionar esse campo a um campo equivalente das classes (incidente, problema change_request) no ServiceNow.
área organizacional	Representa o campo Área Organizacional do caso em Aranda e permite relacionar esse campo a um campo equivalente das classes (incidente, problema change_request) no ServiceNow.

Caso en ASMS: Ilustración de referencia, información del cliente de los casos en la plataforma ASMS

Caso en ASMS parte 2: Ilustración de referencia, información básica de los casos en la plataforma ASMS

Propriedades internas

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

A continuación se describen las propiedades que son utilizadas dentro de los objetos typeRegister, service, project, responsibleGroup, responsible, category, providers, organizationalArea y applicant:

Propriedades	Descrição
tipo	Tipo de associação; os tipos suportados são Value, Mapper, FieldValue	FieldValue, Value, Mapper.
Chave	Nome ou ID do campo no ServiceNow em que o valor será encontrado e atualizado.	Tipo de propriedades no ServiceNow
searchBy	Se o campo for do tipo *Referência* (referência a outra classe) deve incluir o nome pelo qual a referência será pesquisada.
onError	Permite executar uma ação caso o item não seja encontrado na plataforma	ver
defaultValue	Permite adicionar um campo padrão.	ver

Tipos de relación o asociación de campos
A continuación podrá visualizar información sobre el funcionamiento de los tipos en la propiedad type descrita en el cuadro anterior.

Nome	Descrição	Exemplo
Valor	Permite atribuir um valor ao campo selecionado através do arquivo de configuração. O valor deve estar nas propriedades da razão de valor	Veja o exemplo
Mapeador	Procura associar e/ou relacionar os valores do CMDB Aranda com os valores do CMDB ServiceNow o campo indicado na propriedade chave no ServiceNow, a relação de valores é feita 1 a 1, a atribuição não pode ser repetida	Veja o exemplo
Valor do campo	Os valores das propriedades são enviados diretamente entre plataformas sem qualquer tipo de associação/relacionamento, para os campos do tipo “Referência” no ServiceNow é necessário escrever o campo que será tomado e processado para ser enviado para a plataforma Aranda, este campo deve ser escrito no “searchBy”	Veja o exemplo

Propiedad “onError”

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

Propiedad “defaultValue”

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.
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.
Um valor padrão só pode ser adicionado se o tipo de mapeamento for “Mapeador” ou “ValorDoCampo”.

Exemplo:

Defina o valor “incidente” como o mesa:
Na definição do caso Assuma a propriedade responsável (responsável)
“type”: Atribua o tipo de associação como Valor do campo:
“key”: nomeie a propriedade no ServiceNow como assigned_to, as propriedades podem ser do tipo Referência, escolha, dados ( Tipo de propriedades no ServiceNow):
“defaultValue”: atribua o defaultValue:

{
  "case": [
    {
      "table": "incident",
      "definition": {
        "itemType": "ServiceCall",      
        "responsible": {
          "key": "assigned_to",
          "type": "FieldValue",
          "defaultValue": {
             "id": 222,
             "value": "sys_id_usuario_servicenow"
          }
        }
      }
    }
  ]
}

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

Ejemplo tipo Value

Defina o valor “incidente” como o mesa:
Na definição do caso Pegue a propriedade Requerente (requerente) e atribua o tipo de associação como Valor:

{
    "case": [
        {
          "table": "incident",
          "definition": {
            "applicant": {
              "type": "Value"
            }
          }
        }
  ]
}

A relação implica que um valor deve ser atribuído de maneira comum para todos os Casos, isso é feito usando a propriedade “applicant”, conforme mostrado abaixo:

{
  "case": [
    {
      "table": "incident",
      "definition": {
        "applicant": {
          "type": "Value"
        }
      }
    }
  ],
  "applicant": [
    {
      "reference": "",
      "id": 10
    }
  ]
}

Atribuir um valor à propriedade “applicant.reference”:

{
  "case": [
    {
      "table": "incident",
      "definition": {
        "applicant": {
          "type": "Value"
        }
      }
    }
  ],
  "applicant": [
    {
      "reference": "ref_incident",
      "id": 10
    }
  ]
}

O tipo de associação “Valor” requer a atribuição das propriedades básicas (projeto, serviço, categoria) com um tipo de associação “Mapeador”:
Atribua a propriedade “case.category”.
Atribua a propriedade “category.reference” com o mesmo valor que você atribuiu em “candidate.reference”.

{
  "case": [
    {
      "table": "incident",
      "definition": {
        "applicant": {
          "type": "Value"
        },
        "category": {
          "key": "category",
          "type": "Mapper"
        }
      }
    }
  ],
  "applicant": [
    {
      "reference": "ref_incident",
      "id": 10
    }
  ],
  "category": [
    {
      "reference": "ref_incident",
      "id": 222,
      "value": "value_category_servicenow"
    }
  ]
}

⚐ Nota: O Casos atribuído à classe “incidente” no ASMS será atribuído ao solicitante com ID 10.***

Exemplo de tipo Mapeador

Defina o valor “incidente” como o mesa:
Na definição do caso Pegue a propriedade Requerente (requerente)
“type”: Atribua o tipo de associação como Mapeador:
“key”: nomeie a propriedade no ServiceNow como model_id, as propriedades podem ser do tipo Referência, escolha, dados (Tipo de propriedades no ServiceNow):

{
  "case": [
    {
      "table": "incident",
      "definition": {

        "applicant": {
          "type": "Mapper",
          "key": "model_id"
        }
      }
    }
  ]
}

A relação implica que os candidatos da tabela Aranda (ASMS) devem estar associados aos candidatos do ServiceNow; Recomenda-se escrever o sys_id do requerente a ser relacionado, conforme mostrado abaixo:

{
  "case": [
    {
      "table": "incident",
      "definition": {

        "applicant": {
          "type": "Value"
        }
      }
    }
  ],
  "applicant": [
    {
      "table": "incident",
      "mapping": [
        {
          "id": 5,
          "value": "sys_id_solicitante_servicenow"
        }
      ]
    }
  ]
}

⚐ Nota: O solicitante com a ID da Tabela Aranda “5” (ASMS) está relacionado ao solicitante “sys_id_solicitante_servicenow” no CMDB do ServiceNow***

Exemplo de tipo Valor do campo

Defina o valor “incidente” como o mesa:
Na definição do caso Pegue a propriedade Requerente (requerente)
“type”: Atribua o tipo de associação como Valor do campo:
“key”: nomeie a propriedade no ServiceNow como model_id; 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):
“searchBy”: nomeie a propriedade a ser pesquisada na entidade referenciada:

{
  "case": [
    {
      "table": "incident",
      "definition": {

        "applicant": {
          "type": "FieldValue",
          "key": "model_id",
          "searchBy": "name"
        }
      }
    }
  ]
}

⚐ Nota: As 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 pesquisa de itens, o nome/exibição do item da tabela (ASMS) é usado para terceiros; o ID ou outra propriedade não é usado; se houver muitos itens com o mesmo nome no CMDB do ServiceNow, selecione o tipo de relação como “Mapeador”, para relacionar os itens por IDs - sys_id.***

↩ Voltar para Configurações