Documentation Index

Fetch the complete documentation index at: https://help.ila.cegid.com/llms.txt

Use this file to discover all available pages before exploring further.

Explore as funcionalidades disponíveis para aproveitar todo o potencial da nova plataforma de ajuda!

Como configurar funções do utilizador?

Prev Next
  • PT

  • ES

  • AO

  • CV

  • MZ

  • ST

  • GW

  • Professional

  • Executive

  • Public Sector

  • Omnia

  • Evolution


Uma Função do Utilizador (XDU) corresponde a uma determinada ação executada pelo sistema, que implementa uma determinada regra de negócio.

Esta funcionalidade permite garantir e responder a todas as regras de negócio específicas a cada empresa, nomeadamente:

  • Envio de mensagens de email personalizadas para cada empresa;
  • Execução de stored procedures ou queries sobre a base de dados da empresa;
  • Execução de formulários do utilizador ou macros de extensibilidade;
  • Exportação e/ou envio por email de mapas do utilizador;
  • Executar outros utilitários externos ou documentos.
O conceito de Função do Utilizador serve de base à implementação de Menus e Processos do Utilizador.

Criar tipos de funções de utilizador

A plataforma disponibiliza os seguintes tipos de funções do utilizador:

  • Email: envio de mensagens por email;
  • Aplicação Externa: execução de aplicações ou documentos externos;
  • Macro Extensibilidade: execução de macros definidas no(s) projetos PEX associados(s) à empresa;
  • Formulário do Utilizador: execução de Formulários Customizados;
  • Mapa do Utilizador: impressão de mapas do utilizador com possibilidade de exportação e/ou envio por email;
  • Stored Procedure: execução de stored procedures existentes na base de dados da empresa;
  • User Defined Function: execução de user defined functions existentes na base de dados da empresa (apenas disponível em SQL Server 2000 ou superior);
  • Query SQL: execução de queries SQL ad-hoc.

Dependendo do tipo, cada função do utilizador permite a definição de:

  • Parâmetros: permitem torná-la dinâmica e adaptável a várias situações idênticas;
  • Resultados: na forma de valores discretos (numéricos ou alfanuméricos), listas de valores ou listas de registos.

Para criar tipo de funções de utilizador, siga os seguintes passos:

Criar função do utilizador Query SQL

  1. Aceder a Extensibilidade | Funções na área de configurações do ERP (backstage);
  2. Clicar em Nova;
  3. No separador Geral, definir as seguintes propriedades da função: - Definir o nome da função; - Definir o tipo de função, selecionando a opção Query SQL; - Indicar uma descrição da função (opcional);
  4. No separador Definição, indicar a Query SQL a utilizar na execução;
  5. Clicar em Confirmar.

Ao definir as funções do utilizador do tipo Query SQL,poderá utilizar parâmetros na especificação da Query. Assim, é potencializada a adaptabilidade a cenários que utilizem componentes de natureza variável.

Deverá também definir o resultado da função, uma vez que a forma como a datatable resultante da Query SQL será interpretada pelo motor de execução depende do tipo de resultado selecionado:

  • Nenhum: a Query SQL não devolve qualquer resultado;
  • Texto, Inteiro, Numérico, Data, Booleano: a Query SQL devolve uma datatable com apenas um registo e com uma coluna, que deve ser interpretada de acordo com o tipo de dados selecionado;
  • Lista de Registos: a QuerySQL devolve uma datatable com vários registos e várias colunas.

Criar função de utilizador Email

  1. Aceder à opção Extensibilidade | Funções na área de configurações do ERP (backstage);
  2. Clicar em Nova;
  3. No separador Geral, definir o nome da função;
  4. Definir o tipo de função, clicando na opção Email;
  5. Indicar uma descrição da função (opcional);
  6. No separador Definição, definir o destinatário, selecionando a opção Para e indicar o endereço de email do destinatário;
  7. Definir o assunto, indicando o tópico do assunto que será tratado na mensagem;
  8. Definir a mensagem, digitando o conteúdo da mensagem;
  9. Indicar os anexos, selecionando os ficheiros a anexar à mensagem (opcional);
  10. Por fim, clicar em Confirmar.

Ao definir as funções de utilizador do tipo Email, sugere-se a utilização de parâmetros na configuração da mensagem de email. Assim, é reforçado o envio da mensagem, independentemente dos destinatários e de outras particularidades meramente adaptáveis no contexto da mensagem.

Nota: As funções do tipo Email não permitem a definição dos respetivos resultados.

Criar função do utilizador Formulário do Utilizador

  1. Aceder a Extensibilidade | Funções na área de configurações do ERP (backstage);
  2. Clicar em Nova;
  3. No separador Geral, definir o nome da função;
  4. Definir o tipo de função, selecionando a opção Formulário do Utilizador;
  5. Indicar uma descrição da função (opcional);
  6. No separador Definição, selecionar o formulário do utilizador a utilizar na execução; Nota: Os formulários customizados devem ser previamente implementados em PEX (Extensibility) e as extensões associadas à empresa;
  7. Por fim, clicar em Confirmar.

Nota: As funções do tipo Formulário do Utilizador não permitem a definição de parâmetros nem dos resultados.

Criar função do utilizador Aplicação Externa

  1. Aceder a Extensibilidade | Funções na área de configurações do ERP (backstage);
  2. Clicar em Nova;
  3. No separador Geral, definir o nome da função;
  4. Definir o tipo de função, selecionando a opção Aplicação Externa;
  5. Indicar uma descrição da função (opcional);
  6. No separador Definição, definir o comando, identificando a localização da aplicação/documento externo;
  7. Definir os parâmetros, enumerando os parâmetros adicionais a aplicar na execução (opcional);
  8. Definir a diretoria inicial, identificando a respetiva localização física (opcional);
  9. Definir o tipo de janela a utilizar na execução;
  10. Por fim, clicar em Confirmar.

Ao definir as funções do utilizador do tipo Aplicação Externa, sugere-se a utilização de parâmetros na configuração da aplicação/documento externo. Assim, a execução de uma determinada aplicação ou documento é potencializada baseada em critérios dinâmicos.

A execução de aplicações externas permite definir qual o tratamento aplicar ao resultado, sendo possível especificar dois tipos de resultados:

  • Nenhum - o resultado da execução não será tratado pelo motor de execução;
  • Inteiro - a aplicação executada produzirá um exit code que será tratado pelo motor no final da execução.

Criar função do utilizador Mapa do Utilizador

  1. Aceder a Ferramentas | Funções do Utilizador;
  2. Clicar em  Nova;
  3. No separador Geral, definir o nome da função;
  4. Definir o tipo de função, selecionando a opção Mapa do Utilizador;
  5. Indicar uma descrição da função (opcional);
  6. No separador Definição, definir o mapa a ser executado;
  7. Selecionar o formato do mapa;
  8. Definir o envio por email, caso pretenda que o resultado da execução do mapa seja enviado por email (opcional);
  9. Definir a localização física, caso pretenda que o resultado da execução do mapa seja guardado em ficheiro (opcional);
  10. Por fim, clicar em Confirmar.

Ao definir as funções do tipo Mapas do Utilizador, sugere-se a utilização de parâmetros na configuração do mapa, de forma a facilitar a adaptação ao processo de exportação. Se o mapa do utilizador tiver parâmetros definidos no Crystal Reports, estes serão automaticamente detetados e adicionados à lista de parâmetros da função.

O resultado deste tipo de função é fixo e corresponde sempre à localização física do mapa do utilizador depois de exportado no formato selecionado.

Não será disponibilizado o resultado da execução, se a configuração da função do utilizador não incluir o envio do mapa por email e/ou a exportação para uma diretoria em disco.

Criar função Macro de Extensibilidade

As macros de extensibilidade devem ser criadas em extensões PEX e carregadas na configuração de extensibilidade antes que seja possível criar funções com base nas macros destas extensões.

Poderá consultar as extensões em Extensibilidade | Extensões na área de configurações do ERP.

Para criar uma função macro de extensibilidade, siga os seguintes passos:

  1. Aceder a Extensibilidade | Funções na área de configurações do ERP (backstage);
  2. Clicar em Nova;
  3. No separador Geral, definir o nome da função;
  4. Selecionar a opção Macro Extensibilidade no tipo de função;
  5. Indicar uma descrição da função (opcional);
  6. No separador Definição, definir o projeto no qual está definida a macro;
  7. Selecionar a macro definida no projeto Extensibilidade;
  8. Por fim, clicar em Confirmar.

Os parâmetros da função do utilizador serão os parâmetros que correspondem à função que implementa a macro. O resultado da função do utilizador será determinado também pela definição da macro, como o tipo de retorno da função que implementa a macro.

Criar função do utilizador Stored Procedure

  1. Aceder a Extensibilidade | Funções na área de configurações do ERP (backstage);
  2. Clicar em Nova;
  3. No separador Geral, definir o nome da função;
  4. Definir o tipo de função, selecionando a opção Stored Procedure;
  5. Indicar uma descrição da função (opcional);
  6. No separador Definição, selecionar a Stored Procedure a utilizar na execução;
  7. Por fim, clicar em  Confirmar.

Os parâmetros da função do utilizador serão determinados pela própria definição da Stored Procedure na base de dados.

Deverá definir o resultado da função. Apesar de em princípio uma stored procedure não produzir resultados, o SQLServer permite que a respetiva definição inclua queries à base de dados.

Se definidas corretamente, estas queries permitem simular um resultado na forma de um recordset. A forma como o recordset será interpretado pelo motor de execução depende do tipo de resultado selecionado:

  • Nenhum: a Stored Procedure não devolve qualquer resultado;
  • Texto, Inteiro, Numérico, Data, Booleano: a Stored Procedure devolve um recordset com apenas um registo e uma coluna, que deve ser interpretada de acordo com o tipo de dados selecionado;
  • Lista de registos: a Stored Procedure devolve um recordset com vários registos e colunas.

Criar função do utilizador User Defined Function

  1. Aceder a Extensibilidade | Funções na área de configurações do ERP (backstage);
  2. Clicar em Nova;
  3. No separador Geral, definir o nome da função;
  4. Definir o tipo de função, selecionando a opção User Defined Function;
  5. Indicar uma descrição da função (opcional);
  6. No separador Definição, selecionar a User Defined Functiona utilizar na execução;
  7. Por fim, clicar em Confirmar.

Os parâmetros e resultados da função do utilizador serão determinados pela própria definição User Defined Function na base de dados.


Configurar funções de utilizador

Para configurar uma função do utilizador, siga os seguintes passos:

  1. Aceder à opção Extensibilidade | Funções na área de configurações do ERP (backstage);
  2. Selecionar a Função do Utilizador que pretende configurar;
  3. Clicar em Editar ou efetuar um duplo clique sobre a função selecionada;
  4. Na janela Função do Utilizador, configurar a função do utilizador (descrição, definição e configuração dos parâmetros);
  5. Por fim, Confirmar.
A definição das propriedades e consequente parametrização dependem do tipo de função especificada.

Remover funções de utilizador

Para remover uma função do utilizador, siga os seguintes passos:

  1. Aceder a Extensibilidade | Funções na área de configurações (backstage) do ERP;
  2. Selecionar a Função do Utilizador que pretende remover;
  3. Clicar em Anular.

Será apresentada uma mensagem de confirmação para remover a função. Se responder positivamente, a função do utilizador será removida do sistema.


Executar funções

É possível efetuar uma função do utilizador:

  • A partir da janela de Configuração de Funções;
  • A partir do menu através de um Atalho e/ou de um Menu do Utilizador;
  • Em consequência da execução de um Processo do Utilizador.

A execução da função do utilizador será efetuada imediatamente. No entanto, será pedido ao utilizador (excepto nos processos do utilizador) para solicitar os valores de todos os parâmetros (não completamente definidos na configuração). Posteriormente, serão apresentados os resultados caso existirem.

Para executar uma função do utilizador, siga os seguintes passos:

  1. Aceder a Extensibilidade | Funções, na área de configurações (backstage) do ERP;
  2. Selecionar a Função do Utilizador que pretende executar;
  3. Clicar em Executar.

Nota: O exemplo refere-se à execução de uma função a partir da janela de configuração de funções.

Dependendo do tipo de configuração aplicada na definição da função, poderá eventualmente ser solicitado a introdução dos parâmetros.

O envio de mensagens é efetuado assincronamente, ou seja, sempre que uma função do utilizador do tipo Email for executada, a respetiva mensagem será colocada numa fila de espera para envio.

O envio propriamente dito será efetuado pela aplicação Windows Scheduler Services, de acordo com o calendário de execução definido.