Como customizar as informações exibidas na tela de detalhes do documento?

Obs.: A customização dessas informações pode ser feita com a criação de um layout de documentos. Caso ainda não tenha criado um, clique aqui para acessar a FAQ que explica os primeiros passos. Caso já tenha criado um layout, acesse-o a partir do menu Layouts de Documentos no Portal do Aprovador.

As informações da tela de detalhes do documento são aquelas que o usuário visualiza ao clicar em um documento na lista de pendências. Elas podem ser customizadas na seção Informações do documento, na tela de edição do layout.

Essas informações estão divididas em três partes: campos do cabeçalho, campos do documento e coleções. A imagem abaixo mostra onde estão localizadas cada uma dessas partes no app do Aprovador.

Observação: no Portal, os campos do cabeçalho também são exibidos nas informações da lista de documentos, como mostrado na figura abaixo.

Campos do cabeçalho e campos do documento

Os campos do cabeçalho são os campos comuns a todos os documentos, independente do ERP ou módulo, e são os primeiros campos exibidos na tela de detalhes. Além disso, como mostrado acima, eles são exibidos também na tela da lista de documentos no Portal. Exemplos: Assunto (textSubject), ID do documento (textId), entre outros.

Os campos do documento são os campos particulares a cada ERP/módulo e são exibidos logo abaixo dos campos do cabeçalho no App e no Portal.

Voltando à tela de edição do layout, na seção Informações do documento, veja que, abaixo das três abas referentes ao tipo de campo, existem duas colunas: “Arraste os campos” à esquerda e “Campos do cabeçalho/documento” à direita. Serão exibidos no documento os campos que estiverem na coluna da direita. Seguem abaixo algumas instruções quanto ao que pode ser alterado:

Para retirar um campo, basta clicar no ícone da lixeira à direita.
Para incluir um campo da coluna da esquerda, arraste-o ou clique no ícone da seta apontada para a direita.
Para adicionar um campo que não esteja em nenhuma das colunas, clique em “Adicionar um campo” ou no ícone com o símbolo “+”.
Para editar um campo, clique em “Editar”.
Para mudar a ordem dos campos, basta arrastá-los.

Mais detalhes sobre adição/edição de campos mais abaixo neste artigo.

Coleções

As Coleções são geralmente utilizadas para listar os itens de um documento, sejam itens de uma solicitação de compra ou as ordens de um pedido de compra, por exemplo.

Assim como nos campos do cabeçalho/documento, serão exibidas no documento apenas as coleções que estiverem na coluna da direita (na foto abaixo, na coluna do meio pois a terceira coluna está exibindo os campos da coleção).

Ao expandir uma coleção, você verá que existem campos dentro dela. As instruções sobre como editar, adicionar ou excluir um campo de uma coleção são as mesmas válidas para os campos do cabeçalho/documento, descritas no tópico anterior.

Observação: apenas objetos trazidos na integração com o atributo "collectionId" podem ser adicionados como uma coleção. No caso, o código da coleção deve ser o próprio "collectionId".

Ao editar uma coleção, além do label, é possível customizar a exibição da lista de coleções. São as informações exibidas na tela que lista todos os itens da coleção, tanto no App quanto no Portal.

Essas informações são compostas de título e descrição e, caso não sejam preenchidas, serão exibidas as informações padrão. Para ver quais campos podem ser inseridos, clique em Visualizar campos disponíveis.

Adicionando/editando um campo

Ao editar um campo nos Campos do cabeçalho, é possível customizar apenas o seu label. Caso queira adicionar um novo campo, clique em “Visualizar campos disponíveis” para ver quais campos podem ser adicionados. No cabeçalho é possível inserir também campos do documento. Eles também estarão na lista de campos disponíveis, antecedidos por “metadata.”.

Ao adicionar ou editar um campo que seja parte dos Campos do documento ou das Coleções, existem mais opções de customização. São elas:

Código do Campo – defina aqui qual é o campo, geralmente no formato TABELA.CAMPO (use os campos já existentes no layout como guia). Obs.: os campos com tipo do metadado igual a título ou agrupamento aceitam texto livre.
Label – defina um label correspondente ao campo.
Valores dinâmicos – ao habilitar esta opção, será exibido no lugar do campo o que estiver preenchido na caixa de texto “Expressão” logo abaixo. Nela é possível incluir um ou mais campos, além de texto fixo.
Tipo do metadado – escolha o formato de exibição do campo. Mais detalhes no próximo tópico deste artigo.
Formatação – escolha entre usar a linguagem de formatação Markdown ou usar as opções disponíveis embaixo, como colocar o campo em negrito, itálico ou alterar sua cor (preto, verde ou vermelho).

Observação: caso você adicione um novo campo e ele não apareça no documento, pode ser que a integração não esteja buscando este campo. Neste caso, entre em contato com suporte@aprovador.com para ajudarmos.

Tipo do metadado

Ao adicionar/editar um campo do documento ou um campo da coleção, uma das opções que devem ser configuradas é o tipo do metadado, que define a forma como o campo será exibido. As opções são: agrupamento, link, lista, texto múltiplas linhas, texto simples e título.

A imagem de exemplo abaixo mostra, à esquerda, seis campos, cada um com um tipo de metadado diferente, e à direita, a exibição desses campos no App.

Viu como é simples? Caso tenha alguma dúvida, entre em contato com suporte@aprovador.com.

Veja também as outras FAQs relacionadas aos layouts de documentos:

Artigos nessa seção