User Exits
Search
Search Ajuda e Suporte Suporte do ONESOURCE Global Trade LatAm.

This article applies to:

  • produto: onesource-global-trade
  • Sub-Product: master-data

Como cadastrar uma user exit?

Cadastre uma
user exit
 para executar código customizado em resposta a eventos específicos de uma entidade do sistema.
Certifique-se de ter identificado previamente a entidade (nome da tela) e o evento que desencadeará a
user exit
. Consulte a seção
Campos do cadastro de user exit
 abaixo para a descrição de cada campo.
  1. Acesse
    Dados Mestres
    Configurações de Personalizações
    User Exits
    .
  2. Na tela
    Filtro User Exit
    , clique em
    Adicionar
     .
  3. Na tela
    Criar User Exit
    , configure os toggles
    Ativo
     e
    OSGT Next
     conforme necessário.
  4. Preencha os campos
    Sistema
    ,
    Entidade
    ,
    Evento
     e, opcionalmente,
    Descrição
    .
    Consulte Opções de evento de uma user exit para ver a lista completa de eventos disponíveis.
  5. Na seção
    Atividades
    , clique em
    Adicionar
     e preencha os campos
    Tipo Atividade
    ,
    Conteúdo atividade
     e, opcionalmente,
    Descrição Atividade
    .
    É possível adicionar várias atividades por
    user exit
    . Utilize a alça de arrasto para definir a sequência de execução.
  6. Clique em
    Salvar
    .
A
user exit
 é cadastrada e fica disponível na lista da tela
Filtro User Exit
. A partir daí, ela pode ser consultada, editada e excluída pelas ações disponíveis na tabela.
Se necessário, gere o script SQL da
user exit
. Consulte Como gerar o script SQL de uma user exit? para mais informações.

Campos do cadastro de user exit

Descrição dos campos da tela de criação e edição de
user exits
, incluindo os campos principais e os campos da seção
Atividades
.

Campos principais

Campo
Tipo / Restrição
Descrição
ID
Gerado automaticamente
Código de identificação da
user exit
. Preenchido pelo sistema ao salvar o cadastro. Não requer preenchimento manual.
Ativo
Toggle / Habilitado por padrão
Controla se a
user exit
 está ativa no sistema. Quando desabilitado, o código não é executado mesmo que o evento ocorra.
OSGT Next
Toggle / Habilitado por padrão
Indica que a
user exit
 será utilizada na plataforma
ONESOURCE™ Global Trade Next
. A seleção deste toggle determina os eventos e os tipos de atividade disponíveis no cadastro.
Sistema
Seleção / Obrigatório
Sistema no qual a
user exit
 deve ser aplicada.
Entidade
Texto / Obrigatório, até 250 caracteres
Nome do formulário da entidade na qual a
user exit
 atua. Na plataforma Next, identifique-o via inspeção do navegador. Na plataforma desktop, utilize o botão
Spy
.
Evento
Seleção / Obrigatório
Evento que desencadeará a execução da
user exit
. As opções disponíveis variam conforme a configuração do toggle
OSGT Next
. Consulte a seção abaixo para ver a lista completa.
Descrição
Texto / Opcional, até 4000 caracteres
Descrição livre da finalidade da
user exit
.

Seção Atividades

Campo
Tipo / Restrição
Descrição
Tipo Atividade
Seleção / Obrigatório
Define o tipo de código que será executado. As opções disponíveis dependem da plataforma (desktop ou OSGT Next).
Conteúdo atividade
Texto / Obrigatório
Código-fonte da atividade a ser executada quando o evento ocorrer.
Descrição Atividade
Texto / Opcional
Descrição da finalidade da atividade.

Tipos de atividade - Plataforma Desktop

Tipo de Atividade
Descrição
Comando SqlWindows
Aceita qualquer chamada de função (sem o
Call
) ou atribuição SqlWindows (com o
Set
). Não são permitidos códigos de looping (
WHILE
 ou
LOOP
), nem
BREAK
 ou
RETURN
. Use referência qualificada
<formulário>.<objeto>
 quando necessário.
PLSQL
Aceita qualquer código PL/SQL, incluindo blocos anônimos e chamadas de procedure. Dependendo do evento, a atividade pode ou não participar da transação em andamento (verifique se o uso de
commit
 ou
rollback
 é apropriado para o evento selecionado).
Programa Externo
Tipo descontinuado. Não deve mais ser utilizado.
Controle
Executa comandos de controle de fluxo.

Tipos de atividade - Plataforma OSGT Next

Tipo de Atividade
Descrição
Frontend
Focado na criação e design da interface do usuário. Permite adicionar campos e componentes personalizados e implementar validações no
frontend
. O código é fornecido em formato JSON com a chave
js
.
Routine
Executa funções específicas no
backend
 do sistema, como cálculos, validações ou processamentos. O código é fornecido em formato JSON com as chaves
routineName
,
bindProperty
 e
parameters
.
tip
A caixa de texto exibida abaixo da tabela
Atividades
 apresenta a definição do tipo de atividade selecionado.

Opções de evento de uma user exit

Lista de todos os eventos disponíveis para configuração de
user exits
, com o momento de execução e as observações relevantes por plataforma.

Eventos - Plataforma Desktop

Evento
Execução e transação
Observação
Object Pré-Click
Objeto
:
PushButton_Custom_SW
. Ao clicar no botão, antes de processar
PAM_CustomClick
. Transação aberta.
Evento extra, não faz parte do fluxo de gravação de telas.
Object Pós-Click
Objeto
:
PushButton_Custom_SW
. Ao clicar no botão, após processar
PAM_CustomClick
. Transação aberta.
Evento extra, não faz parte do fluxo de gravação de telas.
Dialog Pré-Abertura
Objeto
:
Dialog_Box_SW
. No início da mensagem
SAM_Create
. Sem controle de transação.
Evento extra, não faz parte do fluxo de gravação de telas.
Dialog Pós-Abertura
Objeto
:
Dialog_Box_SW
. No início da mensagem
SAM_CreateComplete
. Sem controle de transação.
Evento extra, não faz parte do fluxo de gravação de telas.
Dialog Pós-Fechamento
Objeto
:
Dialog_Box_SW
. No início da mensagem
SAM_Destroy
. Sem controle de transação.
Evento extra, não faz parte do fluxo de gravação de telas.
Dialog Pré-Validate
Objeto
:
Dialog_Box_SW
. Na função
wf_DialogValidate
. Sem controle de transação.
Evento extra, não faz parte do fluxo de gravação de telas.
Form Pré-Abertura
Objeto
: Formulários SW. Na sincronização com a classe, dentro de
cf_Create
. Sem transação aberta.
Nenhuma informação foi buscada ainda. Momento ideal para customizar a substituição de uma tela.
Form Pós-Fechamento
Objeto
: Formulários SW. Na destruição do formulário, dentro de
SAM_Destroy
. Sem transação aberta.
Os locks já foram liberados e a conexão foi desfeita. Indicado para pós-processamentos que envolvam mais de um registro.
Form Pré-gravação Inclusão
Objeto
: Formulários SW. No clique no botão de gravação. Transação aberta (falha cancela a gravação).
Nenhuma informação foi inserida ainda. Momento ideal para pré-processamentos.
Form Pré-gravação Alteração
Objeto
: Formulários SW. No clique no botão de gravação. Transação aberta (falha cancela a gravação).
Nenhuma informação foi alterada ainda. Momento ideal para pré-processamentos.
Form Pós-gravação Inclusão
Objeto
: Formulários SW. Antes do commit no processo de gravação. Transação aberta (falha cancela a gravação).
Momento ideal para complementação de informações e pós-processamentos.
Form Pós-gravação Alteração
Objeto
: Formulários SW. Antes do commit no processo de gravação. Transação aberta (falha cancela a gravação).
Momento ideal para complementação de informações e pós-processamentos.
Form ou Table Pré-Validate
Objeto
: Formulários SW e Tabelas SW. Antes do Validate original do formulário ou de cada linha da tabela. Transação aberta (pode interromper a gravação via
gf_ValidateClass
 ou alterando
m_b_Validate
 para
False
).
Momento ideal para complementar validações.
Form Pós-Inicialização
Objeto
: Formulários SW. Após o
PAM_IniciaFormulário
 padrão. Transação aberta, principalmente em modo de alteração.
Momento ideal para modificar a inicialização de dados feita na
PAM_IniciaFormulário
.
Form Pós-Abertura
Objeto
: Formulários SW. Após os
SAM_Create
 dos objetos e antes do
PAM_IniciaFormulário
. Sem transação aberta.
Momento ideal para alterar a inicialização de objetos feita com
SAM_Create
.
Form Pré-Exclusão
Objeto
: Formulários SW. Após confirmação de exclusão, antes do
PAM_Exclui
. Transação aberta.
Momento para realizar checagens extras antes de excluir o registro.
Form Pós-Exclusão
Objeto
: Formulários SW. Após o
PAM_Exclui
, antes do commit. Transação aberta.
Momento ideal para complementar a exclusão com código adicional.

Eventos - Plataforma OSGT Next

Evento
Quando é executado
Observação
Button Pré-Clique
Ação de pré-clique de um botão.
Exclusivo para a plataforma OSGT Next.
Button Pós-Clique
Ação de pós-clique de um botão.
Exclusivo para a plataforma OSGT Next.

Related Content