Relação entre os campos do CMDB do Aranda e os campos de classe do CMDB do ServiceNow
Para realizar a integração, é necessário relacionar os campos do CI de Aranda com os campos das classes CMDB do ServiceNow por meio do “CI” no arquivo de configuração.
Exemplo de estrutura JSON
{
"ci": [
{
"reference": "",
"definition": {
"name": {
"type": "",
"mappingDirection": "",
"searchBy": "",
"key": ""
},
"description": {
"type": "",
"mappingDirection": "",
"searchBy": "",
"key": ""
},
"assetTag": {
"type": "",
"mappingDirection": "",
"searchBy": "",
"key": ""
},
"serial": {
"type": "",
"mappingDirection": "",
"searchBy": "",
"key": ""
},
"rfid": {
"type": "",
"mappingDirection": "",
"searchBy": "",
"key": ""
},
"barCode": {
"type": "",
"mappingDirection": "",
"searchBy": "",
"key": ""
},
"licenseNumber": {
"type": "",
"mappingDirection": "",
"searchBy": "",
"key": ""
},
"price": {
"type": "",
"mappingDirection": "",
"searchBy": "",
"key": ""
},
"installationDate": {
"type": "",
"mappingDirection": "",
"searchBy": "",
"key": ""
},
"reponsibleDate": {
"type": "",
"mappingDirection": "",
"searchBy": "",
"key": ""
},
"size": {
"type": "",
"mappingDirection": "",
"searchBy": "",
"key": ""
},
"measureUnit": {
"type": "",
"mappingDirection": "",
"key": "",
"searchBy": ""
},
"brand": {
"type": "",
"defaultValue": {
"id": 0,
"value": ""
},
"onError": [
{
"action": "",
"message": ""
}
],
"mappingDirection": "",
"key": "",
"searchBy": ""
},
"model": {
"type": "",
"defaultValue": {
"id": 0,
"value": ""
},
"onError": [
{
"action": "",
"message": ""
}
],
"mappingDirection": "",
"key": "",
"searchBy": ""
},
"responsible": {
"type": "",
"defaultValue": {
"id": 0,
"value": ""
},
"onError": [
{
"action": "",
"message": ""
}
],
"mappingDirection": "",
"key": "",
"searchBy": ""
},
"provider": {
"type": "",
"defaultValue": {
"id": 0,
"value": ""
},
"onError": [
{
"action": "",
"message": ""
}
],
"mappingDirection": "",
"key": "",
"searchBy": ""
},
"manufacturer": {
"type": "",
"defaultValue": {
"id": 0,
"value": ""
},
"onError": [
{
"action": "",
"message": ""
}
],
"mappingDirection": "",
"key": "",
"searchBy": ""
},
"costCenter": {
"type": "",
"defaultValue": {
"id": 0,
"value": ""
},
"onError": [
{
"action": "",
"message": ""
}
],
"mappingDirection": "",
"key": "",
"searchBy": ""
}
}
}
]
}
Propriedades :
| Propriedades | Descrição |
|---|---|
| Referência | Nome da classe ou alias referenciado no ServiceNow |
| Definição | Permite relacionar os campos de IC nos CMDBs do Aranda com os campos de IC no CMDB do ServiceNow |
definition
Para realizar la integración es necesario relacionar la información de aranda ASMS y ServiceNow por medio de la sección “definition” del archivo de configuración. Propriedades:
| Propriedades | Descrição | Propriedades internas |
|---|---|---|
| Nome | Representa o Nome do IC no Aranda CMDB, permite relacionar esse campo a outro campo nas classes do ServiceNow. | ver |
| Descrição | Representa o Descrição do IC no Aranda CMDB, permite relacionar esse campo a outro campo nas classes do ServiceNow. | ver |
| assetTag | Representa o Rótulo de inventário do IC no Aranda CMDB, permite relacionar esse campo a outro campo nas classes do ServiceNow. | ver |
| serial | Representa o Serial do IC no Aranda CMDB, permite relacionar esse campo a outro campo nas classes do ServiceNow. | ver |
| RFID | Representa o RFID do IC no Aranda CMDB, permite relacionar esse campo a outro campo nas classes do ServiceNow. | ver |
| Código de barras | Representa o Código de barras do IC no Aranda CMDB, permite relacionar esse campo a outro campo nas classes do ServiceNow. | ver |
| número de licença | Representa o Número de licença do IC no Aranda CMDB, permite relacionar esse campo a outro campo nas classes do ServiceNow. | ver |
| Preço | Representa o Preço do IC no Aranda CMDB, permite relacionar esse campo a outro campo nas classes do ServiceNow. | ver |
| marca | Representa o Marca do IC no Aranda CMDB, permite relacionar esse campo a outro campo nas classes do ServiceNow. | ver |
| modelo | Representa o Modelo do IC no Aranda CMDB, permite relacionar esse campo a outro campo nas classes do ServiceNow. | ver |
| responsável | Representa o Responsável do IC no Aranda CMDB, permite relacionar esse campo a outro campo nas classes do ServiceNow. | ver |
| provedor | Representa o Fornecedor do IC no Aranda CMDB, permite relacionar esse campo a outro campo nas classes do ServiceNow. | ver |
| fabricante | Representa o Fazedor do IC no Aranda CMDB, permite relacionar esse campo a outro campo nas classes do ServiceNow. | ver |
| Centro de Custos | Representa o Cetro de Custo do IC no Aranda CMDB, permite relacionar esse campo a outro campo nas classes do ServiceNow. | ver |
| unidademedida | Representa o Unidade de medida do IC no Aranda CMDB, permite relacionar esse campo a outro campo nas classes do ServiceNow. | ver |
| data de instalação | Representa o Data de Aceitação do IC no Aranda CMDB, permite relacionar esse campo a outro campo nas classes do ServiceNow. | ver |
| data responsável | Representa o Data de Início da Responsabilidade do IC no Aranda CMDB, permite relacionar esse campo a outro campo nas classes do ServiceNow. | ver |
| tamanho | Representa o Valor da unidade de medida do IC no Aranda CMDB, permite relacionar esse campo a outro campo nas classes do ServiceNow. | ver |
Propriedades internas
{
"type": "",
"key": "",
"searchBy": "",
"mappingDirection": "",
"defaultValue": {
"id": 0,
"value": ""
},
"onError": [
{
"action": "",
"message": ""
}
]
}
A continuación se describen las propiedades type, key, searchBy. que son utilizadas dentro de la definición del ci
| Propriedades | Descrição | |
|---|---|---|
| tipo | Tipo de relacionamento ou associação entre campos. | 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. | |
| direção de mapeamento | Representa a plataforma que tem permissão para atualizar o campo IC | ver |
| 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
| Nome | Descrição | Exemplo |
|---|---|---|
| Valor | Permite atribuir um valor ao campo selecionado através do arquivo de configuração. O valor deve estar dentro das propriedades da taxa 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 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 |
⚐ Nota: Para os campos “name, description, assetTag, serial, rfid, barCode, licenseNumber, price, installationDate, size”, o tipo de mapeamento que pode ser atribuído é “ValorDoCampo”, como esses campos não oferecem suporte a nenhum tipo de relação de valor, eles são valores inseridos pelo usuário.
Propiedad “onError”
- A matriz onError Permite executar uma ação caso o item não seja encontrado na plataforma, repetir uma ação gera um 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, recomenda-se adicionar os seguintes caracteres “{0}” que eles substituirão 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 defaultValue.id para o CMDB de Aranda ou valorPadrão.valor para o CMDB do ServiceNow, o sistema adiciona o valor padrão à plataforma que define o valor.
- Para os campos “name, description, assetTag, serial, rfid, barCode, licenseNumber, price, installationDate, size”, você não pode adicionar um valor padrão porque eles são valores inseridos pelo usuário e uma relação de valor não é suportada.
- Um valor padrão só pode ser adicionado se o tipo de mapeamento for “Mapeador” ou “ValorDoCampo”.
Exemplo:
- Defina o valor “computador” no Referência:
- Na definição do Ci 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:
{
"ci": [
{
"reference": "computador",
"definition": {
"responsible": {
"type": "Mapper",
"key": "assigned_to",
"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 “computador” no Referência:
- Na definição do Ci pegue a propriedade Model (modelo) e atribua o tipo de associação como Valor:
{
"ci": [
{
"reference": "computador",
"definition": {
"model": {
"type": "Value"
}
}
}
]
}
- A relação implica que um valor deve ser atribuído de maneira comum para todos os CEI, isso é feito usando a propriedade “model”, conforme mostrado abaixo:
{
"ci": [
{
"reference": "computador",
"definition": {
"model": {
"type": "Value"
}
}
}
],
"model": [
{
"reference": "computador",
"mapping": [
{
"id": 10
}
]
}
]
}
⚐ Nota: Os ICs atribuídos para a classe “computador” no Aranda CMDB receberão o modelo com Id 10.***
Exemplo de tipo Mapeador
- Defina o valor “computador” no Referência:
- Na definição do Ci pegue a propriedade Model (modelo)
- “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 ):
{
"ci": [
{
"reference": "computador",
"definition": {
"model": {
"type": "Mapper",
"key": "model_id"
}
}
}
]
}
- A relação implica que os modelos do CMDB Aranda devem ser associados aos modelos do CMDB ServiceNow, recomenda-se escrever o sys_id do modelo a ser relacionado, conforme mostrado abaixo:
{
"ci": [
{
"reference": "computador",
"definition": {
"model": {
"type": "Value"
}
}
}
],
"model": [
{
"reference": "computador",
"mapping": [
{
"id": 5,
"value": "sys_id_modelo_servicenow-10"
}
]
}
]
}
⚐ Nota: O modelo com ID “5” do CMDB Aranda está relacionado ao modelo “model-servicenow-10” no CMDB do ServiceNow***
Exemplo de tipo Valor do campo
- Defina o valor “computador” no Referência:
- Na definição do Ci pegue a propriedade Model (modelo)
- “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 Referência e requer que o campo searchBy atribuído um valor (nome pelo qual a entidade referenciada será pesquisada):
- “searchBy”: nomeie a propriedade a ser pesquisada na entidade referenciada:
{
"ci": [
{
"reference": "computador",
"definition": {
"model": {
"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 a pesquisa do item é necessário especificar o nome deste campo, deve-se notar que para a pesquisa do item é utilizado o nome/exibição do item do CMDB de Aranda para terceiros, o id ou outra propriedade não é utilizado, 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***
Tipo de propiedades en ServiceNow Os atributos de classe do ServiceNow podem conter valores que fazem referência a outra entidade (classe) ou seu valor pode ser inserido pelo usuário. Os atributos relacionados a outras entidades são designados pela ServiceNow como “referência” ou seu valor pode ser obtido em uma “caixa de seleção”, conforme explicado abaixo:
Sys_Choice e atributos de referência: ServiceNow pode relacionar suas classes usando dois tipos de atributos, tipo “referência” e “sys_choice”. Os atributos de tipo de referência podem ser encontrados conforme mostrado na imagem na coluna de tipo:
Embora o valor possa ser selecionado a partir de um “caixa de seleção”, está trabalhando com atributos de tipo “sys_choice”, os valores contidos são adicionados ao “sys_choice” e estão relacionados à classe IC.
Valores permitidos para mappingDirection
| Nome | Descrição |
|---|---|
| Ambos | Ambas as plataformas permitem atualizar os campos, este valor é adicionado por padrão |
| Aranda | Somente o Aranda CMDB pode atualizar o campo |
| Externo | Somente o CMDB do ServiceNow pode atualizar o |