Campos

Ao clicar em EDITOR mostrado no tópico anterior, será aberta a janela de Editor de formulários, aqui o usuário iniciará a construção da configuração de campos adicionais, para isso clique no símbolo de + ou clique em criar no centro da página.

IMPORTANTE!

Se o recurso não estiver disponível, solicite ao produto que conduza os procedimentos necessários, habilitando a configuração para o cadastro desejado.

Selecione o respectivo Cadastro que receberá os campos adicionais e insira uma Descrição.

Habilitando o parâmetro Configuração adicional é gerado uma nova configuração para o mesmo cadastro. A ferramenta permite que seja cadastrado até 5 configurações para cada cadastro. Exemplo: digamos que um cadastro de agências bancárias tenha campos específicos para os estados do RS e SC, com esse cenário a ferramenta permite criar uma configuração com os campos de RS e outra com os campos de SC.

Definido o cadastro, será mostrado o ambiente de Editor de formulários, onde será possível efetivamente editar os campos adicionais.

Através desses botões a ferramenta possibilita realizar algumas ações como: Adicionar nova configuração, Salvar, Editar detalhes, Gerenciar atributos, Alternar campos versionados removidos, Publicar, Adicionar um campo, Adicionar um agrupador e Adicionar uma tabela.

Inserindo agrupadores e campos

Antes de criar os campos adicionais, é necessário criar os Agrupadores, que são seções da guia de Campos adicionais, esses agrupadores serão alocados logo abaixo da barra de ferramentas e receberão os campos adicionais. Para criar agrupadores clique no botão destacado abaixo:

Informe um Título para este agrupador, este título será exibido ao usuário final na guia de Campos adicionais.

É possível gerar quantos agrupadores quiser, mas se houver inserido um agrupador por engano basta excluí-lo clicando no ícone representado por uma lixeira que fica disposto do lado superior direito do nome do agrupador.

Agrupador definido, insira os respectivos campos adicionais. Para isso clique no botão destacado na imagem abaixo.

Ao clicar no ícone para adicionar campos, outras informações são apresentadas nessa janela. Os campos Tipo e Limite de caracteres são os únicos que não são padrões, ou seja, os demais campos sempre serão exibidos independentemente do tipo de campo adicional que for criado.

A partir deste ponto, inicia de fato a edição do Campo adicional. Prosseguindo com o preenchimento do campo será habilitada a barra lateral direita com a seção Configurações do campo. Em Nome será exibido inicialmente Campo 1, para editar clique no campo mencionado e digite o nome.

A ferramenta permite redimensionar os campos, ou seja, é possível aumentar ou diminuir sua extensão por meio do ícone destacado abaixo:

Também é permitido arrastar o campo para qualquer lugar do Agrupador, basta clicar e arrastar com o mouse para onde desejar:

Logo abaixo, informe se o campo será obrigatório ou não, para isso selecione SIM ou NÃO. Se defini-lo como obrigatório, o usuário final será obrigado a preencher o campo para que o cadastro possa ser salvo.

No campo Tipo serão apresentadas opções que definirão a categoria que será aplicada no campo que está sendo cadastrado. No próximo subtítulo, cada tipo de cadastro será apresentado com suas particularidades.

A opção Somente leitura, quando definida como SIM, habilita o campo Valor padrão, consequentemente deverá ser preenchido. A opção permite ainda que o campo já venha preenchido com a informação desejada, impossibilitando a edição do campo pelo usuário final. Este recurso é útil para entidades das quais algumas informações solicitadas no cadastro são de conhecimento prévio da filial/revenda e possuem uma única alternativa de seleção e não sejam preenchidas de forma equivocada.

Em Dica de preenchimento, é possível inserir uma instrução em forma de texto para que o usuário possa visualizar, essa informação fica localizada ao lado do nome do campo no ícone de interrogação. Mantendo o mouse em cima do ícone a dica será exibida.

O Placeholder nada mais é do que um texto que pode ser exibido dentro do campo adicional, o mesmo também pode ser utilizado de forma a instruir o usuário final. Vale lembrar que o texto exibido é meramente visual, ou seja, ele não preenche de forma alguma o campo. No momento que o usuário clicar no campo, o texto desaparece imediatamente, porém esse recurso aparece apenas quando o campo Somente leitura estiver marcado na opção Não.

A última etapa da edição do campo adicional é a definição da Variável, que será o identificador para utilizar o campo em scripts e relatórios. A propriedade variável é obrigatória para mapear o campo adicional existente.

IMPORTANTE!

A variável não pode conter números, espaços, caracteres especiais (Ex: $%&*) ou letras maiúsculas.

Através do ícone de lixeira é possível descartar o rascunho atual do campo adicional e retornar para última versão publicada.

Clicando no ícone mencionado acima uma mensagem é exibida questionando o descarte, caso queira excluí-lo pressione SIM, caso contrário aperte NÃO para cancelar a ação.

Antes de publicar (vincular definitivamente o campo adicional ao cadastro) é necessário salvar as configurações realizadas até então.

Chegou a hora de tornar disponível o que foi cadastrado, para isso, clique no botão Publicar. Uma mensagem será exibida questionando se deseja realmente publicar a versão. Ao clicar em SIM confira no sistema se as informações estão corretas, caso contrário edite as informações e repita o processo.

Observe como fica a guia Campos Adicionais do cadastro do sistema Planejamento.

Inserindo agrupadores do tipo tabela

A ferramenta Campos adicionais possui a opção de incluir agrupadores do tipo tabela, facilitando a visualização e também o preenchimento das informações. Para inserir um novo clique em Adicionar uma tabela.

Informações a serem preenchidas aparecem ao lado direito da tela.

Insira um nome no campo Título (se refere a configuração do agrupador) e um Nome para a tabela, o campo título é preenchido automaticamente.

Adicione a quantidade de colunas que achar necessário clicando no botão +COLUNA. Ao lado do título existe um ícone de engrenagem, é através desse ícone que serão realizadas as configurações da coluna.

As informações apresentadas nesta tela são as mesmas que foram detalhadas no tópico Inserindo agrupadores. É necessário preenchê-las para cada coluna adicionada, ao finalizar pressione o botão CONCLUIR.

Insira uma Dica de preenchimento se achar necessário e uma Variável que é obrigatório. Logo após salve e publique.

No sistema aparecerá a tabela como cadastrado, porém, para inserir elementos basta clicar em +ITEM. Os campos são habilitados para que sejam inseridos as informações.

Inserindo Aliases em um campo adicional

Na janela de configurações de campos adicionais, logo abaixo da propriedade “Nome da Variável", há a possibilidade de se manter uma lista de aliases (apelidos) para cada campo contido na configuração. Esses aliases podem ser utilizados para se referenciar esses campos na ferramenta de scripts, fazendo com que o campo possa ser chamado tanto pelo nome original da variável, como por qualquer um dos apelidos da mesma.

Essa necessidade surgiu para atender as demandas de alterações de nomes de variáveis originadas normalmente de processos de migração ou própria configuração equivocada na criação dos campos adicionais, onde o campo ficava com o nome diferente do esperado por extensões de prestação de contas ou relatórios padrões do sistema, por exemplo. Após essa entrega, o próprio técnico de implantação possui autonomia para estar solucionando essa divergência dos nomes, sem a necessidade de se registrar um ticket para ser atendido pelo setor de desenvolvimento.

É possível inserir quantos aliases quanto necessários para um campo clicando no botão +, e posteriormente removê-los clicando no botão de lixeira se necessário. Após a configuração dos aliases, basta salvar e publicar a configuração, e os mesmo já estarão disponíveis para uso.

Recomenda-se a utilização dessa funcionalidade em cenários onde o nome da variável do campo está diferente do nome esperado por relatórios/scripts flexibilizados, por exemplo: O processo de migração gerou na entidade um campo adicional com uma variável chamada “cod_tce”, mas uma determinada extensão de prestação de contas espera uma variável de nome “codigo_tce”, logo a execução não consegue retornar o valor do campo desejado. Para solucionar, pode-se adicionar o alias “codigo_tce” na variável “cod_tce”, para dessa forma a extensão conseguir realizar a leitura corretamente, evitando a necessidade de se customizar o artefato ou abrir um ticket solicitando o ajuste do nome da variável.

Ao acessar o explorador de fonte de dados das ferramentas de scripts e/ou relatórios, é possível visualizar que para os campos que possuem pelo menos um alias cadastrado, aparecerá um ícone de agenda permitindo exibir a listagem dos apelidos cadastrados para aquele campo. Qualquer um dos nomes da lista (assim como o nome original) podem ser utilizados para se referenciar o campo na ferramenta de extensões.

A imagem abaixo exemplifica a chamada de um campo adicional utilizando o alias configurado no cadastro de campos. Nota-se que mantém-se o funcionamento padrão da chamada, apenas utilizando o nome do alias sem se fazer necessário nenhuma outra alteração.

O alias utilizado na configuração deve ser obrigatoriamente único, ou seja, não é permitido utilizar o mesmo apelido para dois campos diferentes na mesma configuração, assim como não é permitido utilizar um alias que possua o mesmo nome da variável principal de outro campo.

Gerenciando atributos

Este recurso visa organizar, visualizar e flexibilizar as extensões com mais agilidade. Para inserir um novo atributo clique em Gerenciar atributos.

Insira a quantidade desejada de chaves e valores no botão +ATRIBUTOS e clique em SALVAR para gravar as informações.

FIQUE LIGADO!

Este recurso está disponível apenas para usuários desenvolvedores, ou seja, usuários que elaboram os artefatos.

Ao adicionar um atributo é possível buscar no campo de pesquisa. Para isso, insira no campo de pesquisa exatamente como cadastrado no atributo.
Exemplo: Um atributo cadastrado com a Chave: Estado e Valor: AM, deve ser digitado no campo de busca da seguinte maneira: Estado:AM ou com letras minúsculas estado:am. Os dois pontos entre a chave e o valor são essenciais para que a busca seja realizada de maneira correta.

Atributo cadastrado:

Busca pelo Atributo:

Artefato mostrado na tela:

Atributos flexibilizados

A ferramenta possui um mecanismo capaz de flexibilizar atributos através da orquestração, ou seja, atributos presentes no artefato de origem serão enviados para as entidades de destino.

Ao efetuar a orquestração, os atributos do artefato da entidade de origem serão flexibilizados/desflexibilizados — a depender do evento — na entidade de destino.

No caso de substituição de migração de responsabilidade, os valores anteriores serão todos removidos, permanecendo somente os do novo autor. Assim, diferente de relatórios e scripts onde é possível personalizar na entidade de destino, campos adicionais sempre receberão os valores conforme determinado na origem.

Criando mais de uma configuração padrão em um cadastro

Na ferramenta Campos Adicionais é possível criar diversas configurações com o identificador “padrão”, desde que a entidade possua uma licença ativa para o uso do orquestrador.

Nas entidades onde existirem mais de uma, a ferramenta aplicará a regra de que será usada com a data de criação mais antiga. Esta regra aplicar-se-á na exibição dos campos adicionais nas telas, fontes de dados e outros locais onde se faça necessária.

No caso da entidade não possuir licença ativa para o Orquestrador, serão aplicadas as regras existentes, onde é permitido somente um registro com o identificador padrão.

Para atender esse recurso foi implementado a coluna CRIAÇÃO, possibilitando visualizar as datas dos cadastros.

Organizando campos e alternando-os entre os agrupadores

É possível alternar os campos entre os agrupadores mesmo quando já estão sendo utilizados, facilitando a organização dos mesmos. Para isso, basta mover os campos entre os agrupadores desejados.

Após a organização dos campos, salve e publique as informações. Na página do sistema que contenham os campos adicionais cadastrados, utilize a tecla TAB do teclado para alternar entre os campos. Apertando essa tecla é respeitada a ordem sequencial conforme a disposição em tela.