PT
Español
English
Português
    Caso

    Relação entre ASMS e DevOps

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

    Estrutura JSON

    {
      "case": [
        {
        "reference": "",
        "definition": {
          "subject": {
            "type": "",
            "key": ""
          },
          "description": {
            "type": "",
            "key": ""
          },
          "idByProject":{
            "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 campos de caso do ASMS a campos WorkItem no DevOps

    Definição

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

    Propriedades:

    Propriedades Descrição  
    Assunto Representa o campo Assunto do caso em Aranda e permite relacionar este campo a um campo equivalente do WorkItem no DevOps, recomenda-se usar o System.Title.  
    Descrição Representa o campo Descrição do caso em Aranda e permite relacionar esse campo a um campo equivalente do WorkItem no DevOps. ver
    idByProject Representa o ID do caso e permite que você relacione esse campo a um campo equivalente no WorkItem no DevOps. Propriedades internas
    typeRegister Representa o campo Tipo de registro do caso em Aranda e permite relacionar esse campo a um campo equivalente do WorkItem no DevOps. Propriedades internas
    responsibleGroup Representa o campo Grupo Responsável do caso em Aranda e permite relacionar esse campo a um campo equivalente do WorkItem no DevOps. Propriedades internas
    responsável Representa o campo Responsável do caso em Aranda e permite relacionar esse campo a um campo equivalente do WorkItem no DevOps. Propriedades internas
    candidato Representa o campo Candidato do caso em Aranda e permite relacionar esse campo a um campo equivalente do WorkItem no DevOps. Propriedades internas
    Companhia Representa o campo Companhia do caso em Aranda, permite relacionar esse campo a outro campo equivalente do WorkItem no DevOps. Propriedades internas
    cliente Representa o campo Cliente do caso em Aranda e permite relacionar esse campo a um campo equivalente do WorkItem no DevOps. Propriedades internas
    Ci Representa o campo CI do caso em Aranda e permite relacionar esse campo a um campo equivalente do WorkItem no DevOps. Propriedades internas

    Descrição:

    A descrição do WorkItem pode estar relacionada ao tipo de campo adicional “Parágrafo” de casos de ASMS.

    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

    WorkItem DevOps: Ilustración de referencia, información básica de los tickets en la plataforma DevOps

    Propiedades 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 DevOps onde as informações serão pesquisadas e atualizadas. Ver
    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 “Key”

    A integração permite que você relacione as propriedades do caso às propriedades do WorkItem no DevOps

    1. Para obter o nome dos imóveis pode consultar: Propriedades de DevOps
    2. Relacionar Caminho da área em DevOps
    • A nomenclatura da área do caminho tem as seguintes restrições: Ver.
    • A integração criará a Área do Caminho caso ela não exista.
    • Se o valor atribuído no ASMS for nulo ou vazio no DevOps, a área de caminho padrão será atribuída que corresponde ao nome do projeto.
    • Se o valor atribuído no DevOps for a área do caminho, por padrão (nome do projeto) no ASMS, o campo será atribuído vazio ou nulo.
    • Se o valor atribuído na propriedade ASMS OR DevOps for nulo ou vazio e o arquivo de configuração for atribuído ao defaultValue, as plataformas terão o valor registrado em defaultValue.
    • É permitido relacionar as seguintes propriedades básicas do caso com o “Caminho da Área”
     *  Ci
     *  Companhia
     *  Grupo Responsável
     *  Digite o registro    *  Quando os campos estão relacionados a "System.AreaPath", somente os tipos de relação "Mapper" ou "FieldValue" são permitidos.    *  [Para relacionar o **Ids** das propriedades](#ejemplo-tipo-mapper) ASMS com o Caminho da Área, **NÃO** digite o nome que é adicionado por padrão na Área do Caminho (nome do projeto), adicione apenas o **Caminho**.
       
       
       <center><img src="/aic/pt/assets/images/devops/areapath_definition.jpg"></center>    *  Não é permitido relacionar mais de um campo à propriedade "System.AreaPath".    *  Os seguintes tipos de campos de caso adicionais estão relacionados ao "Caminho da área"
     
     *  Texto curto  
     *  Lista
     *  Catálogo (Lista)
     *  Catálogo (Árvore)        *  Para campos adicionais, não é permitido adicionar a propriedade **"valor"** se estiver relacionado a "System.AreaPath".
    

    Nota: A compatibilidade de campo adicional é validada em tempo de execução;

    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 WorkItem no DevOps, o sistema adiciona o valor padrão à plataforma que define o valor.
    2. Para os campos “assunto”, “Descrição”, “idByProject”, 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”: atribua o nome da propriedade no DevOps como assigned_to (Propriedades de DevOps).
    5. “defaultValue”: atribua o defaultValue.
    {
      "case": [
        {
          "reference": "incident",
          "definition": {
            "responsible": {
              "key": "assigned_to",
              "type": "FieldValue",
              "defaultValue": {
                 "id": 222,
                 "value": "id_usuario_devops"
              }
            }
          }
        }
      ]
    }
    

    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 DevOps; 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 WorkItem DevOps o campo indicado na propriedade chave no DevOps, 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

    Nota: Para os campos “assunto”, “Descrição”, “idByProject”, permite apenas o tipo de associação: Valor do campo

    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
        }
      ]
    }
    

    Nota: 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”: atribua o nome da propriedade no DevOps como applicant_id_devops (Propriedades de DevOps).
    {
      "case": [
        {
          "reference": "incident",
          "definition": {
    
            "applicant": {
              "type": "Mapper",
              "key": "applicant_id_devops"
            }
          }
        }
      ]
    }
    
    1. O relacionamento implica que você deve associar os Solicitantes do Aranda Desk (ASMS) aos Solicitantes do DevOps, é recomendável escrever o Id do requerente a ser relacionado, conforme mostrado abaixo:
    {
      "case": [
        {
          "reference": "incident",
          "definition": {
    
            "applicant": {
              "type": "Mapper"
            }
          }
        }
      ],
      "applicant": [
        {
          "reference": "incident",
          "mapping": [
            {
              "id": 5,
              "value": "id_solicitante_devops"
            }
          ]
        }
      ]
    }
    

    Nota: O solicitante com a ID da tabela Aranda “5” (ASMS) está relacionado ao solicitante “id_solicitante_devops” no DevOps***

    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”: atribua o nome da propriedade no DevOps como applicant_id_devops (Propriedades de DevOps).
    {
      "case": [
        {
          "reference": "incident",
          "definition": {
            "applicant": {
              "type": "FieldValue",
              "key": "applicant_id_devops"
            }
          }
        }
      ]
    }    
    

    ↩ Voltar às configurações