Uma das funcionalidades do PHC GO é a possibilidade de podermos criar parâmetros de utilizador, para que possam depois ser usados nos mais variados desenvolvimentos.

Com este artigo, apresentamos um exemplo de como poderemos criar um parâmetro de utilizador do tipo texto e ler o seu valor, tanto no Front-End como no Back-End.

Inicialmente, é necessário criar um parâmetro de utilizador ( Menu > GO Studio > Toolbox ), de seguida, selecionar a peça Parâmetros e introduzir um novo. Para o parâmetro do tipo texto, tem disponível os seguinte campos:

• Nome: Campo obrigatório que representa a identicação única do parâmetro.

• Título: Campo obrigatório que irá representar o título do campo.

• Descrição: Campo para incluir uma descrição geral do parâmetro.

• Tipo: Campo obrigatório que identifica o tipo do parâmetro. Neste caso o tipo será Texto.

  Notas

  
  

  Se instalou um add-on com um Parâmetro de um determinado Tipo, caso altere posteriormente o Tipo desse Parâmetro, saiba que essa ação poderá ter impacto no add-on, pois a aplicação vai tentar converter o valor do parâmetro para o novo tipo. Caso não consiga, vai tentar aplicar o valor por defeito (caso exista) definido para o parâmetro. Proceda com precaução!
  
  Casos particulares da conversão

  • Conversão para Lista: será aplicado o valor por defeito sem tentativa de conversão.
  • Conversão para Número: Se a conversão falhar, o parâmetro assume o valor "0". Caso o valor "0" esteja fora do intervalo permitido, o parâmetro assume o valor mínimo definido.
  • Conversão para Password: O valor é encriptado.
  • Conversão de Password para outro tipo: O valor é convertido sem encriptação.

• Ordem: Campo para definir a ordem de visualização dentro do grupo do respetivo add-on.

• Subgrupo: Campo obrigatório que irá representar o subgrupo no qual o parâmetro de utilizador será mostrado na lista de parâmetros.

• Tooltip: Texto que irá surgir como explicação visual no campo criado.

• Valor por omissão: Valor inicial quando o parâmetro é criado pela primeira vez na instalação final de cliente.

Após a criação do parâmetro, deve adicionar o respetivo registo ao add-on. Pode fazê-lo através da ação Adicione ao add-on do próprio registo, clicando no icone > Parâmetros de Utiliador > Adicione ao add-on.

Por outro lado, caso pretenda adicionar o parâmetro através do add-on, também é possível. Em modo de edição e sobre a área Peças, tem disponível o agrupador Parâmetros que ao ser expandido, exibe todos os parâmetros existentes.

Depois de efetuar a instalação do add-on, se acedermos aos parâmetros da aplicação, passará a ser apresentado o novo parâmetro que criou.

Como ler este valor no back-end?

Para lermos o valor do parâmetro, teremos de usar uma regra de negócio, com a seguinte configuração, por exemplo:

• Entidade: Documentos de Faturação

• Título: Apresenta valor do parâmetro de utilizador

• Tipo de código: Ao introduzir

• Expressão:

  listMsg.Add(New MsgInfo(CStr(SDK.Parameters.getParameter("u4902_tiposrefportes"))))

O valor que é passado como parâmetro na função getParameter, é o valor que se encontra entre parêntesis em frente ao novo parâmetro criado, neste caso (u4902_tiposrefportes).

Como ler este valor no front-end?

Tal como acontece no back-end, onde existe a função getParameter, em front-end existe a função readParameter.

Para despoletar uma mensagem, por exemplo num evento de ecrã, bastará usar o seguinte comando:

sdk.publishMessage(sdk.readParameter("u4902_tiposrefportes"),AlertTypes.INFO)

Em ambos os cenários de back-end e front-end o resultado vai ser o mesmo. Ao introduzir um documento de faturação, irá ser exibida uma mensagem de informação com o valor que está preenchido no parâmetro geral.