List of asms tasks and sub-tasks in Jira Cloud

The following information is relevant to the creation of tasks between platforms.

• The tasks to be related between platforms must have parents previously related between asms and Jira Cloud.
• The reference used for the task must match a specific parent, as is the case on platforms. If in asms my cases for Incidents have tasks of model A, the configuration file must maintain this relationship for proper operation. If you try to relate to a B model, the relationship of the tasks will NOT work.
• Tasks are related through their own endpoints ASMS and jira Cloud

{
  "task": [
    {
      "reference": "",
      "definition": {
        "idByProject": {
          "type": "",
          "key": ""
        },
        "subject": {
          "type": "",
          "key": ""
        },
        "description": {
          "type": "",
          "key": ""
        },
        "responsible": {
          "type": "",
          "key": "",
          "SearchBy": [""]
        },
        "responsibleGroup": {
          "key": "",
          "type": "",
          "defaultValue": {
            "id": 0,
            "value": ""
          }
        },
        "duration": {
          "type": "",
          "key": ""
        },
        "enddate": {
          "type": "",
          "key": ""
        },
        "startdate": {
          "type": "",
          "key": ""
        }
      },
      "model": {
        "id": 0,
        "additionalFields": [
          {
            "id": 0,
            "type": "",
            "field": {
              "key": ""
            },
            "mapping": [
              {
                "id": 0,
                "value": ""
              },
              {
                "id": 0,
                "value": ""
              },
              {
                "id": 0,
                "value": ""
              }
            ]
          }
        ],
        "state": [
          {
            "id": 0,
            "value": "",
            "reason": 0,
            "commentary": {
              "key": "",
              "value": ""
            }
          }
        ]
      }
    }
  ]
}

Where:

Properties

reference: A relationship is created between the configuration of cases and asms tasks by using the reference property

Definition

Notes and recommendations

idByProject

{
   "idByProject": {
                  "type": "FieldValue",
                  "key": ""
               }
}

For this definition, only the type FieldValue, on the property Key The ID of the text field is entered in Jira and used to add the idByProject of the ASMS task, so you can identify the task it is related to from the Jira interface.

Subject

{
   "Subject": {
                  "type": "FieldValue",
                  "key": ""
               }
}

It is recommended to use the Summary of sub-tasks in Jira Cloud.

Description

{
   "Description": {
                  "type": "FieldValue",
                  "key": ""
               }
}

It is recommended to use the Description of sub-tasks in Jira Cloud.

Duration

{
   "duration": {
                  "type": "FieldValue",
                  "key": ""
               }
}

Field to specify the duration of the task in asms, this value is represented in minutes in sub-tasks in Jira Cloud, therefore it is recommended to use a numeric or short text field.

End up

{
   "enddate": {
                  "type": "FieldValue",
                  "key": ""
               }
}

NON-editable and auto-calculated field to show the task end date in asms, this value is only assigned from asms to sub-tasks in Jira Cloud, it is recommended to use a date type field.

startdate

{
   "startdate": {
                  "type": "FieldValue",
                  "key": ""
               }
}

Field with the start date of the task in asms, it is recommended to use a field type date.

Internal properties

{
  "key": "",
  "type": "",
  "searchBy": [ "Email" ],
  "defaultValue": {
    "id": 0,
    "value": ""
  }
}

Where:

defaultValue property

1. The property defaultValue allows you to add default values, if you add this property with the value of defaultValue.id for the task in Aranda or defaultValue.value for the sub-task in Jira Cloud, the system adds the default value to the platform that set the value.
2. For the “subject, description” fields, you can’t add a default value because they are user-written values and a value relationship isn’t supported.
3. You can only add a default value if the mapping type is “Mapper” or “FieldValue”.

Example:

1. Set the value “incident” to the Reference.
2. In the definition of Task Take Responsible Property (responsible).
3. “type”: Assign the association type as FieldValue.
4. “key”: Assign the name of the property in Jira Cloud as assigned_to (Properties in Jira Cloud).
5. “defaultValue”: Assign the defaultValue.

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

Search Property

The searchBy property is OPTIONAL, is only valid for the type “FieldValue” and for the responsible fields.

This tag allows you to define the property by which the user search will be performed on the ASMS and Jira Cloud platforms; the supported property is “Email” and by default it will search for the “name” property if the “searchBy” tag is not added.

Use Case

For proper use of the “Email” search property, users of the two platforms must have the same email per user. The following is an example of the responsible property with the “Email” search option.

{
  "responsible": {
      "type": "FieldValue",
      "key": "assigned_to",
      "searchBy": [ "Email" ]
      }
}

Types of relationship or association of fields

The following association types determine how the values of the ticket properties will be obtained.

Type example Value

1. Set the value “incident” to the Reference.

2. In the definition of Task Take Responsible Property (responsible) and assign the association type as Value.

{
  "task": [
    {
      "reference": "incident",
      "definition": {
        "responsible": {
          "type": "Value"
        }
      }
    }
  ]
}

3. The relationship implies that a value must be assigned in a common way for all the Task, this is achieved by using the “responsible” property, as shown below:

{
  "task": [
    {
      "reference": "incident",
      "definition": {
        "responsible": {
          "type": "Value"
        }
      }
    }
  ],
  "responsible": [
    {
      "reference": "",
      "id": 10
    }
  ]
}

4. Assign a value to the property “responsible.reference”:

{
  "task": [
    {
      "reference": "incident",
      "definition": {
        "responsible": {
          "type": "Value"
        }
      }
    }
  ],
  "responsible": [
    {
      "reference": "incident",
      "id": 10
    }
  ]
}

⚐ Note: The Tasks associated with the “reference” “incident”, in ASMS they will be assigned the responsible with ID 10.

Type example Mapper

1. Set the value “incident” to the Reference. 2. In the definition of Task Take Responsible Property (responsible). 3. “type”: Assign the association type as Mapper. 4. “key”: Assign the name of the property in Jira Cloud as applicant_id_jira_cloud (Properties in Jira Cloud).

{
  "task": [
    {
      "reference": "incident",
      "definition": {

        "responsible": {
          "type": "Mapper",
          "key": "applicant_id_jira_cloud"
        }
      }
    }
  ]
}

5. The relationship implies that you must associate the Aranda desk managers (ASMS) with the Jira Cloud managers, it is recommended to write the Id of the responsible party to be listed, as shown below:

Note: Note that the same mappers will be reused for both cases and tasks.

{
  "task": [
    {
      "reference": "incident",
      "definition": {

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

⚐ Note: The manager with Id “5” of the Aranda table (ASMS) is related to the manager “id_solicitante_jira” in Jira Cloud***

Type example FieldValue

1. Set the value “incident” to the responsible.
2. In the definition of the Task Take Responsible Property (responsible).
3. “type”: Assign the association type as FieldValue.
4. “key”: Assign the name of the property in Jira Cloud as applicant_id_jira_cloud (Properties in Jira Cloud).

{
  "task": [
    {
      "reference": "incident",
      "definition": {
        "responsible": {
          "type": "FieldValue",
          "key": "applicant_id_jira_cloud"
        }
      }
    }
  ]
}

Configure Task Model