Relación entre propiedades de la orden en AFLS y los campos de la entidad en ServiceNow

Para realizar la integración es necesario relacionar los campos donde obtendremos la información de AFLS y ServiceNow por medio de la sección “workOrder” del archivo de configuración.

Estructura del 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": ""
        }
      }
    }
  ]
}

Propiedades :

definition

Para realizar la integración es necesario relacionar los campos de la orden de trabajo en Aranda AFLS con los campos en ServiceNow mediante la sección “definition” del archivo de configuración.

Propiedades:

propiedades internas

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

Detalle para los campos tipo cadenas de texto (string)

• Los campos de tipo cadena de texto (string) en ServiceNow son aquellos que permiten almacenar información alfanumérica, como nombres, descripciones o cualquier otro tipo de texto. Al relacionar estos campos con los campos equivalentes en AFLS, es importante asegurarse de que el tipo de asociación seleccionado sea compatible con el tipo de dato string para garantizar una correcta sincronización y actualización de la información entre ambas plataformas.
• El tipo de asociación que soportan es FieldValue.
• No se puede relacionar campos tipo choice o reference.
• No admite valores por defecto.
• No admite la propiedad onError.
• No admite la propiedad searchBy.
• No admite la propiedad searchAfls.

Detalle del campo servicio

• Permite la sincronización con campos tipo string, choice, reference y numéricos en ServiceNow.
• El tipo de asociación que soportan es FieldValue, NotMapped y Mapper.
• Admite valores por defecto.
• Admite la propiedad onError.
• No admite la propiedad searchAfls.
• Se recomienda siempre tener un valor por defecto para asignar ya que es una propiedad requerida.

Detalle del campo cliente

• Permite la sincronización con campos tipo string, choice, reference y numéricos en ServiceNow.
• El tipo de asociación que soportan es FieldValue, NotMapped y Mapper.
• Admite valores por defecto.
• Admite la propiedad onError.
• La propiedad searchAfls determina el valor (Nombre, Email) que se enviará a buscar en ServiceNow para encontrar el cliente, si no encuentra el cliente en ServiceNow se ejecutará la acción asignada en la propiedad onError
• Se recomienda siempre tener un valor por defecto para asignar ya que es una propiedad requerida.

Detalle del campo

• Permite la sincronización con campos tipo string, choice, reference y numéricos en ServiceNow.
• El tipo de asociación que soportan es FieldValue y Mapper.
• Admite valores por defecto.
• Admite la propiedad onError.
• No admite la propiedad searchAfls.
• Para la propiedad “priority” si no se agrega un valor toma por defecto 0.

Detalle para el campo Dirección

• En ServiceNow las ubicaciones se registran en la clase “cmn_location”, el campo asociado con esta propiedad debe estar asociada hacia esta.
• El tipo de asociación que soportan es FieldValue.
• No se puede relacionar campos diferente a reference (cmn_location).
• No admite valores por defecto.
• No admite la propiedad onError.
• No admite la propiedad searchBy.
• No admite la propiedad searchAfls.
• La ubicación se buscara por latitud y longitud, si no encuentra creara un registro en la entidad (cmn_location).

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.

Propiedad “onError”

1. El array onError permite ejecutar una acción si no se encuentra el item en la plataforma; repetir una acción genera error.

2. Las acciones que puede ejecutar si no encuentra el item buscado en la plataforma son:

   “Crea una nota en la plataforma” (createNote), en la propiedad onError.message permite personalizar el mensaje que se mostrará en la nota. Se recomienda agregar los siguientes caracteres “{0}” que se reemplazarán por el ID del item que se está buscando.

   “Retornar error al consumir el API de integración” (returnError), en la propiedad onError.message permite personalizar el mensaje que se mostrara en el mensaje de error, se recomienda agregar los siguientes caracteres “{0}” que reemplazarán por el ID del item que se esta buscando.

Propiedad “defaultValue”

1. La propiedad defaultValue permite agregar valores por defecto, si agrega esta propiedad con el valor de true, el sistema solicita agregar el valor por defecto dentro de las propiedades destinadas para la relación de valores.

2. Para los campos “project, service, category”, no s podrá agregar un valor por defecto por ser valores requeridos para la creación del caso y es necesario establecer una relación con los valores de ServiceNow.

3. Sólo se puede agregar un valor por defecto si el tipo de mapeo es “Mapper” o “FieldValue”.

Ejemplo:

1. Asigne el valor “wm_order” en la propiedad table:
2. En la definición del workOrder tome la propiedad Cliente (client)
3. “type”: Asigne el tipo de asociación como FieldValue:
4. “key”: Asigne el nombre de la propiedad en ServiceNow como caller, las propiedades pueden ser de tipo Reference, Choice, Data ( Tipo de propiedades en ServiceNow):
5. “defaultValue”: Asigne la propiedad defaultValue:

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

⚐ Nota: Se recomienda escribir el sys_id (si es un Reference) o el “value” (si es un Choice) del usuario a relacionar.***

Propiedad “dataSource”

La propiedad “dataSource” le permite a la integración determinar que plataforma será la fuente de información, por defecto su valor es “Both”:

Ejemplo tipo NotMapped

1. Asigne el valor “wm_order” en la propiedad table:
2. En la definición del workOrder tome la propiedad Servicio (service) y asigne el tipo de asociación como NotMapped:

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

1. La relación implica que debe asignarse un valor por defecto para todas las ordenes de trabajo, esto se logra mediante la propiedad “defaultValue”, como se muestra a continuación:

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

⚐ Nota: Las ordenes de trabajo asignadas a la clase “wm_order” en AFLS se les asignará el servicio con Id 222.

Ejemplo tipo Mapper>

1. Asigne el valor “wm_order” en la propiedad table:
2. En la definición del workOrder tome la propiedad Cliente (client)
3. “type”: Asigne el tipo de asociación como Mapper:
4. “key”: Asigne el nombre de la propiedad en ServiceNow como caller, las propiedades pueden ser de tipo Reference, Choice, Data (Tipo de propiedades en ServiceNow):
5. “searchAfls”: Asigne el valor (Nombre, Email) que se enviará a buscar en ServiceNow para encontrar el cliente:

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

1. La relación implica que debe asociarse los clientes de AFLS con los clientes de ServiceNow; se recomienda escribir el sys_id del cliente a relacionar , como se muestra a continuación:

{
    "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: Se relaciona el cliente con Id “5” de AFLS con el cliente “sys_id_client_servicenow” en ServiceNow***

Ejemplo tipo FieldValue>

1. Asigne el valor “wm_order” en la propiedad table:
2. En la definición del workOrder tome la propiedad Compañía (company)
3. “type”: Asigne el tipo de asociación como FieldValue:
4. “key”: Asigne el nombre de la propiedad en ServiceNow como company; las propiedades pueden ser de tipo Reference, Choice, Data (Tipo de propiedades en ServiceNow); la propiedad asignada es de tipo Reference; este tipo de propiedad requiere que el campo searchBy se le asigne un valor (nombre por el que se buscara en la entidad Referenciada):
5. “searchBy”: Asigne el nombre de la propiedad con la que se buscará en la entidad referenciada:

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

⚐ Nota: Las propiedades referenciadas a otras clases (tablas) en ServiceNow están compuestas por diferentes propiedades. Para permitir la búsqueda del item se requiere especificar el nombre de este campo. En la búsqueda del item se usa el nombre/display del item de AFLS hacia terceros; no se utiliza el id u otra propiedad; si en ServiceNow existen muchos elementos con el mismo nombre, seleccione el tipo de relación como “Mapper”, para relacionarlos los items por IDs - sys_id.***

↩ Volver a Configuración