A propriedade “WorkOrder” é uma lista que permite relacionar campos AFLS aos campos do ServiceNow:
A relação entre os campos de ordem de trabalho no AFLS e ServiceNow é apresentada usando o seguinte JSON (Arquivo de Configuração):
{
"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": ""
}
}
}
],
"model": [ ],
"client": [ ],
"company": [ ],
"priority": [ ],
"service": [ ]
}
No ServiceNow, as ordens são trabalhadas no wm_order, para o exemplo vamos tomar esta entidade.
1. Na propriedade “tabela” No arquivo de configuração, digite o nome da tabela wm_order.
2. Na propriedade “referência” No arquivo de configuração, insira um nome único orden_1, será usado para relacionar as propriedades “WorkOrder” com “modelo” e “mapeamentos”.
3. 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”, deixe o padrão.
{
"workOrder": [
{
"table": "wm_order",
"reference": "orden_1",
"definition": {
"note": {
},
"subject": {
},
"description": {
},
"service": {
},
"priority": {
},
"client": {
},
"company": {
},
"location": {
}
}
}
]
}
4. Obtenha o nome das propriedades do ServiceNow que você vai relacionar às propriedades da AFLS clicando com o botão direito no nome do campo e selecionando a opção programa:
Propriedade na ServiceNow
| Etiqueta | Nome |
|---|---|
| Companhia | Companhia |
| Breve descrição | short_description |
| Descrição | Descrição |
| Estado | estado |
| Anotações | work_notes |
| Prioridade | prioridade |
| Localização | Localização |
| Contato | Chamador |
5. Crie uma relação entre as propriedades da AFLS e da ServiceNow:
| Propriedade da AFLS | Propriedade na ServiceNow |
|---|---|
| Assunto | short_description |
| Descrição | Descrição |
| serviço | N/A |
| prioridade | prioridade |
| cliente | Chamador |
| Companhia | Companhia |
| estado | estado |
| Localização | Localização |
| Nota | work_notes |
6. Atribua o tipo de mapeamento que as propriedades irão realizar:
| ValorDoCampo: | Ele recebe valor diretamente do ServiceNow; se o campo no ServiceNow for do tipo Referência você deve adicionar o valor “searchBy” no arquivo de configuração, este campo corresponde ao campo pelo qual o valor será pesquisado |
| NotMapped | Disponível apenas para o campo serviço, permite adicionar um valor padrão quando não relaciona um serviço. |
| Mapeador: | Atribua esse valor de mapeamento caso precise comparar ou relacionar valores AFLS e ServiceNow |
| Propriedade da AFLS | Propriedade na ServiceNow | Tipo de mapeamento |
|---|---|---|
| Assunto | short_description | Valor do campo |
| Descrição | Descrição | Valor do campo |
| serviço | N/A | NotMapped |
| prioridade | prioridade | Mapeador |
| cliente | Chamador | Valor do campo |
| Companhia | Companhia | Valor do campo |
| estado | estado | – |
| Localização | Localização | Valor do campo |
| Nota | work_notes | Valor do campo |
⚐ Nota: Propriedades que não possuem tipo de mapeamento serão mapeadas em seções posteriores.
7. As propriedades atribuídas com o “tipo de mapeamento” “ValorDoCampo”, exigem propriedade “searchBy” no arquivo de configuração, essa propriedade permite que você pesquise ServiceNow:
Forneça o nome da pesquisa para o tipo de propriedade FieldValue:
| Propriedade da AFLS | Propriedade na ServiceNow | Tipo de mapeamento | Campo de pesquisa |
|---|---|---|---|
| Assunto | short_description | Valor do campo | – |
| Descrição | Descrição | Valor do campo | – |
| serviço | N/A | NotMapped | – |
| prioridade | prioridade | Mapeador | – |
| cliente | Chamador | Valor do campo | |
| Companhia | Companhia | Valor do campo | Nome |
| estado | estado | – | – |
| Localização | Localização | Valor do campo | – |
| Nota | work_notes | Valor do campo | – |
⚐ Nota: Propriedades como “Observação”, “assunto” e “Descrição” não exigem propriedade “searchBy” porque eles não são campos de referência em ServiceNow, ao contrário de propriedades “cliente” e “Companhia” que se eles precisarem da propriedade “searchBy” porque são campos do tipo de Referência no ServiceNow.” A propriedade “Localização” não exige propriedade “searchBy” porque internamente é pesquisado por latitude e longitude na tabela “cmn_location”.
8. Digite o relacionamento feito nas etapas anteriores no arquivo de configuração:
{
"workOrder": [
{
"table": "wm_order",
"reference": "orden_1",
"definition": {
"note": {
"key": "work_notes",
"type": "FieldValue"
},
"subject": {
"type": "FieldValue",
"key": "short_description"
},
"description": {
"type": "FieldValue",
"key": "description"
},
"service": {
"type": "NotMapped",
"defaultValue": {
"id": 1
}
},
"priority": {
"type": "Mapper",
"key": "priority"
},
"client": {
"type": "FieldValue",
"searchBy": "email",
"searchAfls": "",
"key": "caller"
},
"company": {
"type": "FieldValue",
"searchBy": "name",
"key": "company"
},
"location": {
"type": "FieldValue",
"key": "location"
}
}
}
]
}
9. A propriedade “cliente” Requer propriedade “searchAfls” Essa propriedade determina se você deve enviar o Nome do Cliente ou o E-mail para buscar ServiceNow, insira o valor “E-mail” No arquivo de configuração:
{
"workOrder": [
{
"table": "wm_order",
"reference": "orden_1",
"definition": {
"client": {
"type": "FieldValue",
"searchBy": "email",
"searchAfls": "Email",
"key": "caller"
}
}
}
]
}
⚐ Nota: Note que em ServiceNow o Chamador é um campo de referência de tipo ao módulo de usuários, então a propriedade deve ser usada “searchBy” Para especificar o campo pelo qual a busca será realizada, neste caso atribuímos o “e-mail”.
10. Digite no arquivo de configuração o nome do campo ao qual você relacionará a propriedade “idByProject”:
{
"workOrder": [
{
"table": "wm_order",
"reference": "orden_1",
"definition": {
"note": {
"key": "work_notes",
"type": "FieldValue"
},
"subject": {
"type": "FieldValue",
"key": "short_description"
},
"description": {
"type": "FieldValue",
"key": "description"
},
"service": {
"type": "NotMapped",
"defaultValue": {
"id": 1
}
},
"priority": {
"type": "Mapper",
"key": "priority"
},
"client": {
"type": "FieldValue",
"searchBy": "email",
"searchAfls": "Email",
"key": "caller"
},
"company": {
"type": "FieldValue",
"searchBy": "name",
"key": "company"
},
"location": {
"type": "FieldValue",
"key": "location"
}
}
}
]
}
Continuar: Registrar as propriedades de mapeamento (etapa 4) ↪