Registrar case | Centro de Integraciones Aranda

Relación entre ASMS y Jira Server

Para realizar la integración es necesario relacionar los campos del ticket de Aranda ASMS con los campos del issue de Jira Server por medio de la sección “case” del archivo de configuración.

Estructura del json

{
  "case": [
    {
    "reference": "",
    "definition": {
      "subject": {
        "type": "",
        "key": ""
      },
      "description": {
        "type": "",
        "key": ""
      },
      "responsible": {
        "type": "",
        "key": "",
        "defaultValue": {
          "id": 0,
          "value": ""
        }
      },
      "responsibleGroup": {
        "key": "",
        "type": "",
        "defaultValue": {
          "id": 0,
          "value": ""
        }
      },
      "client": {
        "type": "",
        "key": "",
        "defaultValue": {
          "id": 0,
          "value": ""
        }
      },
      "company": {
        "type": "",
        "key": "",
        "defaultValue": {
          "id": 0,
          "value": ""
        }
      },
      "applicant": {
        "type": "",
        "key": "",
        "defaultValue": {
          "id": 0,
          "value": ""
        }
      },
      "typeRegister": {
        "type": "",
        "key": "",
        "defaultValue": {
          "id": 0,
          "value": ""
          }
      },
      "ci": {
        "type": "",
        "key": "",
        "defaultValue": {
          "id": 0,
          "value": ""
        }
      }
      }
    }
  ]
}

Propiedades :

Propiedades	Descripción
reference	Identificador único para crear una relación entre los conceptos project > category, itemType, typeRegister, applicant, responsibleGroup, responsible, company, client ver
definition	Permite relacionar los campos del caso de ASMS con los campos del Issue en Jira Server

definition

Para realizar la integración es necesario relacionar los campos del caso en Aranda ASMS con el Issue de Jira Server mediante la sección “definition” del archivo de configuración, estas propiedades en ASMS se pueden asociar con campos de tipo lista o string en Jira Server, excluyendo la propiedad subject y description.

Propiedades:

Propiedades	Descripción
subject	Representa el campo Subject del caso en Aranda y permite relacionar este campo con un campo equivalente del Issue en Jira Server, se recomienda usar el campo summary.
description	Representa el campo Description del caso en Aranda y permite relacionar este campo con un campo equivalente del Issue en Jira Server.
typeRegister	Representa el campo Tipo de registro del caso en Aranda y permite relacionar este campo con un campo equivalente del Issue en Jira Server.	Propiedades internas
responsibleGroup	Representa el campo Grupo responsable del caso en Aranda y permite relacionar este campo con un campo equivalente del Issue en Jira Server.	Propiedades internas
responsible	Representa el campo Responsable del caso en Aranda y permite relacionar este campo con un campo equivalente del Issue en Jira Server.	Propiedades internas
applicant	Representa el campo Solicitante del caso en Aranda y permite relacionar este campo con un campo equivalente del Issue en Jira Server.	Propiedades internas
company	Representa el campo Compañía del caso en Aranda, permite relacionar este campo con otro campo equivalente del Issue en Jira Server.	Propiedades internas
client	Representa el campo Cliente del caso en Aranda y permite relacionar este campo con un campo equivalente del Issue en Jira Server.	Propiedades internas
ci	Representa el campo CI del caso en Aranda y permite relacionar este campo con un campo equivalente del Issue en Jira Server.	Propiedades internas

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

Issue Jira Server: Ilustración de referencia, información básica de los tickets en la plataforma Jira Server

Propiedades internas

{
  "key": "",
  "type": "",
  "defaultValue": {
    "id": 0,
    "value": ""
  }
}

Donde:

Propiedades	Descripción
type	Tipo de asociación, los tipos soportados son Value, Mapper, FieldValue.	FieldValue, Value, Mapper.
key	Nombre o identificador del campo en Jira Server donde se buscará y actualizará la información.	Propiedades en Jira Server
defaultValue	Permite agregar un valor por defecto.	ver

Propiedad “defaultValue”

La propiedad defaultValue permite agregar valores por defecto, si agrega esta propiedad con el valor de defaultValue.id para el caso en Aranda o defaultValue.value para el Issue en Jira Server, el sistema agrega el valor por defecto a la plataforma que estableció el valor.
Para los campos “subject, description”, no se puede agregar un valor por defecto porque son valores escritos por el usuario y no se admite una relación de valores.
Sólo podrá agregar un valor por defecto si el tipo de mapeo es “Mapper” o “FieldValue”.

Ejemplo:

Asigne el valor “incident” en la propiedad reference:
En la definición del case tome la propiedad Responsable (responsible)
“type”: Asigne el tipo de asociación como FieldValue:
“key”: Asigne el nombre de la propiedad en Jira Server como assigned_to (Propiedades en Jira Server):
“defaultValue”: Asigne la propiedad defaultValue:

{
  "case": [
    {
      "reference": "incident",
      "definition": {
        "responsible": {
          "key": "assigned_to",
          "type": "FieldValue",
          "defaultValue": {
             "id": 222,
             "value": "id_usuario_jira_Server"
          }
        }
      }
    }
  ]
}

Tipos de relación o asociación de campos
Los siguientes tipos de asociación determinan como se obtendrán los valores de las propiedades del ticket.

Nombre	Descripción	Ejemplo
Value	Permite asignar un valor al campo seleccionado a través del archivo de configuración. Se requiere que el valor se encuentre dentro de las propiedades de relación de valores	ver ejemplo
Mapper	Busca asociar y/o relacionar los valores del caso de Aranda con los valores del Issue de Jira Server el campo indicado en la propiedad key en Jira Server, la relación de valores se hace 1 a 1, no se admite que la asignación se repita	ver ejemplo
FieldValue	Los valores de las propiedades se envían directamente entre plataformas sin ningún tipo de asociación/relación	ver ejemplo

Ejemplo tipo Value

Asigne el valor “incident” en la propiedad reference.

En la definición del case tome la propiedad Solicitante (applicant) y asigne el tipo de asociación como Value.

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

La relación implica que debe asignarse un valor de forma común para todos los casos, esto se logra mediante la propiedad “applicant”, como se muestra a continuación:

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

Asigne un valor a la propiedad “applicant.reference”:

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

Nota: Los **casos** asociados al “reference” “incident”, en ASMS se les asignará el solicitante con Id 10.

Ejemplo tipo Mapper

Asigne el valor “incident” en la propiedad reference.
En la definición del case tome la propiedad Solicitante (applicant).
“type”: Asigne el tipo de asociación como Mapper.

“key”: Asigne el nombre de la propiedad en Jira Server como applicant_id_jira_Server (Propiedades en Jira Server).

{
 "case": [
     {
       "reference": "incident",
       "definition": {
            
         "applicant": {
           "type": "Mapper",
           "key": "applicant_id_jira_Server"
         }
       }
     }
  ]
}

La relación implica que debe asociarse los solicitantes de la mesa de Aranda (ASMS) con los solicitantes de Jira Server, se recomienda escribir el id del solicitante a relacionar , como se muestra a continuación:

{
 "case": [
     {
       "reference": "incident",
       "definition": {
            
         "applicant": {
           "type": "Mapper"
         }
       }
     }
  ],
  "applicant": [
     {
         "reference": "incident",
         "mapping": [
             {
                 "id":5,
                 "value": "id_solicitante_jira"
             }
         ]
     }
  ]
}

Nota: Se relaciona el solicitante con Id “5” de la mesa de Aranda (ASMS) con el solicitante “id_solicitante_jira” en Jira Server

Ejemplo tipo FieldValue

Asigne el valor “incident” en la propiedad table.
En la definición del case tome la propiedad Solicitante (applicant).
“type”: Asigne el tipo de asociación como FieldValue.
“key”: Asigne el nombre de la propiedad en Jira Server como applicant_id_jira_Server (Propiedades en Jira Server).

{
    "case": [
        {
          "reference": "incident",
          "definition": {
            
            "applicant": {
              "type": "FieldValue",
              "key": "applicant_id_jira_Server"
            }
          }
        }
  ]
}

Volver a Configuración