PT
Español
English
Português
    Registrar caso

    Relacionamento entre o ASMS e o Jira Server

    Para realizar a integração é necessário relacionar os campos do ticket Aranda ASMS com os campos do problema do Jira Server através da seção “case” do arquivo de configuração.

    Estrutura JSON

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

    Propriedades :

    Propriedades Descrição
    Referência Identificador exclusivo para criar uma relação entre os conceitos projeto > categoria, itemType, typeRegister, candidato, responsibleGroup, responsável, empresa, cliente ver
    Definição Permite relacionar os campos de caso do ASMS aos campos de problema no Jira Server

    Definição

    Para realizar a integração é necessário relacionar os campos de caso no Aranda ASMS com o Jira Server Issue através da seção “definição” do arquivo de configuração, essas propriedades no ASMS podem ser associadas a campos do tipo list ou string no Jira Server, excluindo a propriedade subject e description.

    Propriedades:

    Propriedades Descrição  
    Assunto Representa o campo Assunto do caso em Aranda e permite que você relacione este campo a um campo equivalente do Problema no Jira Server, é recomendável usar o Resumo.  
    Descrição Representa o campo Descrição do caso em Aranda e permite que você relacione este campo a um campo equivalente do Problema no Jira Server.  
    typeRegister Representa o campo Tipo de registro do caso em Aranda e permite que você relacione este campo a um campo equivalente do Problema no Jira Server. Propriedades internas
    responsibleGroup Representa o campo Grupo Responsável do caso em Aranda e permite que você relacione este campo a um campo equivalente do Problema no Jira Server. Propriedades internas
    responsável Representa o campo Responsável do caso em Aranda e permite que você relacione este campo a um campo equivalente do Problema no Jira Server. Propriedades internas
    candidato Representa o campo Candidato do caso em Aranda e permite que você relacione este campo a um campo equivalente do Problema no Jira Server. Propriedades internas
    Companhia Representa o campo Companhia do caso em Aranda, permite relacionar este campo a outro campo equivalente do Problema no Jira Server. Propriedades internas
    cliente Representa o campo Cliente do caso em Aranda e permite que você relacione este campo a um campo equivalente do Problema no Jira Server. Propriedades internas
    Ci Representa o campo CI do caso em Aranda e permite que você relacione este campo a um campo equivalente do Problema no Jira Server. Propriedades internas

    Caso em ASMS: Ilustração de referência, informações do cliente de casos na 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


    Propriedades internas

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

    Onde:

    Propriedades Descrição  
    tipo Tipo de associação, os tipos suportados são Value, Mapper, FieldValue. FieldValue, Value, Mapper.
    Chave Nome ou identificador do campo no Jira Server onde as informações serão pesquisadas e atualizadas. Propriedades no Jira Server
    searchBy Propriedade de pesquisa de campo, aplica-se apenas a campos do tipo “Usuário” (responsável, solicitante, cliente) ver
    defaultValue Permite adicionar um valor padrão. ver

    Propriedade “defaultValue”

    1. A propriedade defaultValue permite adicionar valores padrão, se você adicionar essa propriedade com o valor de defaultValue.id para o caso em Aranda ou valorPadrão.valor para o problema no Jira Server, o sistema adiciona o valor padrão à plataforma que definiu o valor.
    2. Para os campos “assunto, descrição”, você não pode adicionar um valor padrão porque eles são valores gravados pelo usuário e não há suporte para uma relação de valor.
    3. Você só poderá adicionar um valor padrão se o tipo de mapeamento for “Mapeador” ou “ValorDoCampo”.

    Exemplo:

    1. Defina o valor “incidente” como o Referência:
    2. Na definição do caso Assuma a propriedade responsável (responsável)
    3. “type”: Atribua o tipo de associação como Valor do campo:
    4. “key”: nomeie a propriedade no Jira Server como assigned_to (Propriedades no Jira Server):
    5. “defaultValue”: atribua o defaultValue:
    {
      "case": [
        {
          "reference": "incident",
          "definition": {
            "responsible": {
              "key": "assigned_to",
              "type": "FieldValue",
              "defaultValue": {
                 "id": 222,
                 "value": "id_usuario_jira_Server"
              }
            }
          }
        }
      ]
    }
    

    Pesquisar Propriedade

    A propriedade searchBy é OPCIONAL, só é válido para o tipo “ValorCampo” e para os campos responsável, solicitante e cliente.

    Essa tag permite definir a propriedade pela qual a pesquisa do usuário será realizada nas plataformas ASMS e Jira Server; a propriedade suportada é “Email” e, por padrão, pesquisará a propriedade “name” se a tag “searchBy” não for adicionada.

    Caso de uso

    Para o uso adequado da propriedade de pesquisa “E-mail”, os usuários das duas plataformas devem ter o mesmo e-mail por usuário. Veja a seguir um exemplo da propriedade do solicitante com a opção de pesquisar por “E-mail”.

    {
      "applicant": {
          "type": "FieldValue",
          "key": "Custom.applicant",
          "searchBy": [ "Email" ]
          }
    }
    

    Tipos de relacionamento ou associação de campos

    Os tipos de associação a seguir determinam como os valores das propriedades do ticket serão obtidos.

    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 Busca associar e/ou relacionar os valores do caso Aranda com os valores do Jira Server Issue o campo indicado na propriedade chave no Jira Server, a relação de valores é feita de 1 para 1, a atribuição não pode ser repetida Veja o exemplo
    Valor do campo Os valores de propriedade são enviados diretamente entre plataformas sem qualquer associação/relacionamento Veja o exemplo

    Exemplo de tipo Valor

    1. Defina o valor “incidente” como o Referência.
    2. Na definição do caso Pegue a propriedade Requerente (requerente) e atribua o tipo de associação como Valor.
    {
        "case": [
            {
              "reference": "incident",
              "definition": {
                "applicant": {
                  "type": "Value"
                }
              }
            }
      ]
    }
    
    1. A relação implica que um valor deve ser atribuído de maneira comum para todos os Casos, isso é feito usando a propriedade “applicant”, conforme mostrado abaixo:
    {
        "case": [
            {
              "reference": "incident",
              "definition": {          
                "applicant": {
                  "type": "Value"
                }
              }
            }
      ],
      "applicant": [
            {
                "reference": "",
                "id": 10
            }
      ]
    }
    
    1. Atribuir um valor à propriedade “applicant.reference”:
    {
        "case": [
            {
              "reference": "incident",
              "definition": {          
                "applicant": {
                  "type": "Value"
                }
              }
            }
      ],
      "applicant": [
            {
                "reference": "incident",
                "id": 10
            }
      ]
    }
    

    Observação: o **Casos** associado à “referência” “incidente”, no ASMS será atribuído ao solicitante com ID 10.

    Exemplo de tipo Mapeador

    1. Defina o valor “incidente” como o Referência.
    2. Na definição do caso Pegue a propriedade Requerente (requerente).
    3. “type”: Atribua o tipo de associação como Mapeador.
    4. “key”: nomeie a propriedade no Jira Server como applicant_id_jira_Server (Propriedades no Jira Server).
    {
      "case": [
        {
          "reference": "incident",
          "definition": {
    
            "applicant": {
              "type": "Mapper",
              "key": "applicant_id_jira_Server"
            }
          }
        }
      ]
    }
    
    1. O relacionamento implica que você deve associar os Solicitantes do Aranda Desk (ASMS) aos Solicitantes do Jira Server, é recomendável escrever o Id do requerente a ser listado, conforme mostrado abaixo:
    {
      "case": [
        {
          "reference": "incident",
          "definition": {
    
            "applicant": {
              "type": "Mapper"
            }
          }
        }
      ],
      "applicant": [
        {
          "reference": "incident",
          "mapping": [
            {
              "id": 5,
              "value": "id_solicitante_jira"
            }
          ]
        }
      ]
    }
    

    Nota: O solicitante com o ID da tabela Aranda “5” (ASMS) está relacionado ao solicitante “id_solicitante_jira” no Jira Server

    Exemplo de tipo Valor do campo

    1. Defina o valor “incidente” como o mesa.
    2. Na definição do caso Pegue a propriedade Requerente (requerente).
    3. “type”: Atribua o tipo de associação como Valor do campo.
    4. “key”: nomeie a propriedade no Jira Server como applicant_id_jira_Server (Propriedades no Jira Server).
    {
      "case": [
        {
          "reference": "incident",
          "definition": {
    
            "applicant": {
              "type": "FieldValue",
              "key": "applicant_id_jira_Server"
            }
          }
        }
      ]
    }
    

    ↩ Voltar para Configurações