Base de informações da plataforma

Índice

Operações customizadas

RTSYSINF.CAD_OPERACOES_CUSTOM

Descrição

Manutenção das operações customizadas do sistema, tais como scripts ou chamadas a outras rotinas externas.

Veja Suporte a scripts customizados pelo cliente para maiores detalhes.

Exemplos:
Seguem alguns exemplos de operações customizadas.

Bloquear a exclusão de pedidos da categoria "venda"

Não permite a exclusão dos pedidos da categoria "venda", mesmo que os eventos de exclusão estejam disponíveis para os usuários.
Operação customizada:
Preferências que verifica(m) o evento de exclusão e executa a operação customizada (ver Eventos de sistema).

Esta interface é usada em diferentes guias do sistema. Clique nos links de navegação abaixo para obter maiores informações.

Operações custom:

Campos:

Nome global que identifica a operação do sistema. Este campo é calculado automaticamente peno nome da operação, concatenando o nome da interface da operação com o nome da operação.

Não existem duas operações com mesmo nome global.
Título original dado para a operação no idioma de desenvolvimento. Normalmente equivale ao nome de um botão ou de um label.
Exemplos: Insert, Delete, Update, Cancelar pedido, etc.
Texto descritivo sobre a operação.
Nome de identificação (único) do tipo de implementação. Ex: Java, SQL, Jasper, Rhino, etc.
Implementação para executar a operação. Pode ser um script ou apenas uma referencia utilizada pelo ambiente para a execução do mesmo. Por exemplo:
  • Para tipos nativos, pode ser o nome da classe e do método Java que deve ser executado.
  • Para um relatório Jasper, será o caminho do mesmo dentro da área de relatórios
  • Para um relatório por modelo, será o caminho do relatório como arquivo anexo
  • etc.
Indica o tipo de política de acesso que é usado para esta funcionalidade.
Note que, dependendo da arquitetura utilizada, este atributo serve apenas como referência para o que foi codificado no sistema. Alterar o valor do mesmo não siginifica que seja possível mudar o comportamento do sistema. As arquiteturas poderão ou não implementar as regras de acesso com base neste atributo.
  • Público - A interface pode ser acessada livremente (mesmo usários não logados no sistema).
  • Usuário - Qualquer usuário logado no sistema tem acesso aos recursos da interface
  • Restrito - O acesso é restrito a usuários específicos.
  • Exige credencial - É um tipo especial de política de acesso que pede as credenciais do usuário no momento da operação.
Permite definir eventos que devem disparar a execução desta rotina. O nome dos eventos segue os padrões usados na configuração de EVENT_LISTENER. Informe um evento por linha. Exemplo:
QUESTN.APLICACOES_QUESTIONARIOS.POS_INSERT
Representação de toda a operação custom no formato json.
Nome dado para identificar o usuário no sistema. Seu valor é definido durante o cadastramento do usuário e é utilizado como credencial na autenticação de acesso (login) ao sistema. Não existem dois usuários com o mesmo login.
O login é insensível ao caso. Informar "user", "USER" ou "User" serão sempre considerados iguais. Na verdade, será sempre convertido para letras minúsculas.
Sugere-se que seja estabelecido um padrão para o preenchimento do login. Esse padrão pode depender da quantidade de usuários esperados para o sistema e alguns padrões são:
  • Nome e sobrenome separados por um ponto. Ex: ayrton.senna
  • Nome do usuário: Ex: ayrton
  • Nome e primeira letra do sobrenome: Ex: ayrtons
  • Primeira letra do nome e sobrenome: Ex: asenna
  • E-mail do usuário. Ex: ayrton.senna@gmail.com
  • etc.
Nome dado para identificar o usuário no sistema. Seu valor é definido durante o cadastramento do usuário e é utilizado como credencial na autenticação de acesso (login) ao sistema. Não existem dois usuários com o mesmo login.
O login é insensível ao caso. Informar "user", "USER" ou "User" serão sempre considerados iguais. Na verdade, será sempre convertido para letras minúsculas.
Sugere-se que seja estabelecido um padrão para o preenchimento do login. Esse padrão pode depender da quantidade de usuários esperados para o sistema e alguns padrões são:
  • Nome e sobrenome separados por um ponto. Ex: ayrton.senna
  • Nome do usuário: Ex: ayrton
  • Nome e primeira letra do sobrenome: Ex: ayrtons
  • Primeira letra do nome e sobrenome: Ex: asenna
  • E-mail do usuário. Ex: ayrton.senna@gmail.com
  • etc.

Operações

Topo

Pesquisar

Ao pesquisar, o usuário poderá informar critérios de filtro para listar apenas os registros desejados. Normalmente depois de informar os filtros desejados, o usuário deverá executar a operação [b:Listar].
Obtenha maiores detalhes em Como utilizar a tela de pesquisa?.
Comportamento:Topo

Pesquisa genérica

Campos utilizados para pesquisa genérica
Topo

Listar

Apresenta uma lista com os registros que atendem aos filtros informados.
A lista possui diversos recursos práticos e importantes para o usuário:
Público
Usuário
Restrito
Exige credencial
Comportamento:Topo

Novo

Permite criar novos registros no sistema. Ao ser executado, o sistema apresenta um formulário com todos os campos do registro que deverão ser preenchidos. Quando todos os campos desejados estiverem preenchidos, clique em [b:Salvar].
Comportamento:Topo

Alterar

A partir da tela de consulta de um registro, esta operação permite alterar os dados do mesmo.
O sistema abre um formulário com os campos editáveis. Após alterar os campos, o usuário deverá clicar em [b:Salvar].
Comportamento:Topo

Excluir

Exclui o registro selecionado. A exclusão do registro pode ser disparada a partir da tela de consulta e/ou de manutenção do mesmo.
O registro somente será excluído se todas as condições necessárias forem encontradas, gerando um erro, caso alguma destas condições não estiver sendo atendida.
Topo

Consultar

A consulta de um registro é realizada quando o usuário clica no primeiro link de um dos registros resultantes a operação [b:Listar]. A tela apresenta as informações detalhadas do registro, bem como as ações que o usuário pode disparar a partir dele (alterar, excluir, cancelar, etc.).
Comportamento:Topo

Executar

Executa o script. Se houverem parâmetros, pede primeiro para o usuário informar os parâmetros.
Se não houverem parâmetros, ou os parâmetros já estão informados, executa diretamente o operação.
Comportamento:Topo

Entrar parâmetros

Apresenta um formulário com os parâmetro a serem informados.
Topo

JSON

Permite incluir uma operação custom pela representação JSON do mesmo.
Topo

Executar (sem interface)

Executa o script pura e simplesmente (sem apresentar esta interface).
Esta função é utilizada para ser executada a partir do menu do sistema.
Comportamento:

Dúvidas frequentes

  • Como escrever scripts?
  • Configurações

    RTSYSINF.CAD_OPERACOES_CUSTOM.USAR_NOME_GLOBAL

    Preferencia temporária para controlar se o nome global vai ser o nome da operação custom ou do CadOperacoes.

    Tipo: FLAG

    Regras

    Calcular JSON

    Monta a representação JSON de toda a operação custom.
    Eventos que disparam esta regra:
    • Antes de apresentar o conteúdo formulário "Alterar"

    Filtrar gatilhos

    Permite filtrar pelo gatilho utilizado pela operação
    Eventos que disparam esta regra:
    • Depois de ler formulário "Pesquisar"

    Importar JSON

    Inclui (cadastra) uma operação custom a partir das informações de JSON informadas. Permite obter uma operação custom de uma base para configuração facilitada em outra base.

    Importar parâmetros do JSON

    Importa os parâmetros de uma operação conforme estão registrados no JSON.

    Ler gatilhos

    Faz a leitura dos gatilhos (event-listener) que por ventura estejam configurados.
    Eventos que disparam esta regra:
    • Antes de cada registro formulário "Alterar"
    • Antes de cada registro formulário "Consultar"
    • Antes de cada registro formulário "Listar"

    Ler operação do JSON

    Busca os dados da entidade base a partir do JSON.

    Preparar formulário

    Caso operação tenha parâmetros, criar o formulário para informa-los.

    A rotina busca ID da operação como parâmetro direto da requisição como através de formulário Z_FORM para operações de autocomplete.

    Caso não seja encontrado um ID ou o ID não corresponda a uma operação de sistema, ocorrerá um erro do tipo "RecordNofFound".

    Caso a operação encontradas tenha campos (parametros_operacoes;name - ERROR: Não foi possível encontrar um registro em COMPONENTES onde NOME_GLOBAL = PARAMETROS_OPERACOES!), o sistema cria um formulário para ela.
    Eventos que disparam esta regra:
    • Antes de inicializar o componente formulário "Executar"
    • Antes de inicializar o componente formulário "Executar (sem interface)"

    Salvar gatilhos

    Salva os gatilhos em uma preferência de EVENT_LISTENER.
    Eventos que disparam esta regra:
    • Antes de inserir formulário "Novo"
    • Depois de alterar formulário "Alterar"

    Veja também