Documentação EPL - Clientes

Transcrição

1 Documentação EPL - Clientes Revisão 1 Maio / 2010

2 INDICE O que são os EPLs (Entry Point LOGIX)..3 Objetivo dos Pontos de Entrada..3 Etapas da criação do EPL3 a) Abertura do chamado3 b) Criação de chamada ao EPL3 c) Desenvolvimento da funcionalidade.3 d) Guarda dos fontes..3 Implementação do EPL CLIENTE (Acionado a partir de fontes padrões LOGIX)4 Como usar a função LOG_getVar()5 Caso de uso5 Exemplo de código fonte para uma função EPL com nome padrão TOTVS (acionada a partir de uma rotina padrão LOGIX)..6 Contatos da Fabrica de Software Logix..6

3 O que são os EPLs (Entry Point LOGIX) São pontos localizados no código fonte LOGIX e que permite que funcionalidades pontuais sejam personalizadas de acordo com a regra do cliente. Estas regras não fazem parte do produto padrão. Objetivo dos Pontos de Entrada Os Pontos de Entrada possibilitam customizações específicas de clientes sem afetar a execução padrão do sistema LOGIX, podendo ou não estas customizações ser mantidas pela TOTVS. O Ponto de Entrada somente estará disponível a partir da versão do LOGIX através do uso da tecnologia atual (By You Tec), conhecida também como TOTVS Tec. Etapas da criação do EPL Para a disponibilização de um Ponto de entrada o cliente deve: a) Abertura do chamado A solicitação de inclusão de chamada para uma funcionalidade EPL no produto padrão LOGIX deve ser realizada pelo cliente TOTVS através da abertura de chamado via Central de Atendimento indicando o local exato da necessidade (Exemplo -> após o final da gravação da Nota fiscal). b) Criação de chamada ao EPL É de responsabilidade da equipe de desenvolvimento do produto TOTVS a inclusão da chamada de uma função EPL dentro do produto padrão. A TOTVS cria uma chamada para a EPL solicitada e posteriormente repassa as informações e ações disponíveis no produto para uso. A abertura da chamada ao EPL não possui valorização ao cliente TOTVS. c) Desenvolvimento da funcionalidade O desenvolvimento das funcionalidades do EPL (específicas) pode ser realizado por: Clientes TOTVS : é pré requisito é estar na versão Logix em diante. Canais TOTVS: Franquias e unidades TOTVS através de seus analistas desenvolvedores; FSW TOTVS: Fábrica de software TOTVS LOGIX. Neste caso será orçado via personalização utilizando-se o modelo tradicional. d) Guarda dos fontes A guarda do fonte pode será feita de 3 formas : 1) Pelo próprio cliente usando-se a ferramenta de desenvolvimento para compilação no R.P.O. 2) Sem evolução e pela fábrica Joinville através do contrato de guarda de fonte. 3) Com evolução e pela fábrica Joinville através do contrato de guarda de fonte.

4 Implementação do EPL CLIENTE (Acionado a partir de fontes padrões LOGIX) Existem duas formas de desenvolvimento de EPL liberadas para o cliente desenvolver, sendo: 1) Funções externas desenvolvidas por clientes e acionadas a partir de fontes EPL mantidos pela TOTVS (específicos do cliente), não precisam ter suas nomenclaturas seguindo um padrão de nomes de funções LOGIX, pois é uma função mantida em um fonte externo sob guarda do cliente. 2) Funções externas desenvolvidas por clientes e acionadas diretamente por fontes padrões LOGIX, sendo que neste caso possuem nomenclatura padronizada repassada pela TOTVS, não possuem definição de parâmetros, pois estes devem ser lidos internamente a partir código implementado na função usando a função LOG_getVar() conforme exemplo citado mais adiante no item Como usar a função LOG_getVar() e a função também obrigatoriamente deverá sempre retornar um único valor indicando o STATUS de execução da função EPL. A Totvs repassa as informações disponíveis a partir de chamadas EPL realizadas a partir de programas padrões LOGIX. No código fonte do EPL por sua vez deve-se recuperar estas informações usando a função LOG_getVar( <parametro> ). Exemplo: LET l_pedido = LOG_getVar( pedido ) Caso seja repassado ao cliente o nome da função EPL que obrigatoriamente o cliente deve definir para poder codificar a função EPL (nome obecendo padrões TOTVS), esta função deverá sempre retornar um valor indicando o STATUS de execução da função, pois dependendo deste retorno, o sistema LOGIX poderá interpretar o retorno do EPL como um cancelamento a partir do ponto atual da chamada (retorno como FALSE), ou então considerar a execução do EPL com sucesso (retorno como TRUE) Cada função EPL desenvolvida pelo cliente, caso seja uma função de nome padrão repassada pela TOTVS (quando função EPL é acionada diretamente a partir de um fonte padrão LOGIX), deverá prever um único retorno obrigatório, que é um STATUS de execução do EPL, pois dependendo deste retorno, o sistema LOGIX poderá interpretar o retorno do EPL como um cancelamento ou interrupção a partir do ponto atual da chamada (retorno como FALSE), ou então considerar a execução do EPL com sucesso (retorno como TRUE) Caso surja alguma situação em que não seja suficiente apenas ter o status o status de retorno para o sistema para continuar o processamento ou cancelá-lo (Exemplo: modificar alguma informação do sistema que tenha sido calculada pela função EPL), deverá ser desenvolvida uma função EPL mantida pela TOTVS como específica para o cliente e a partir deste EPL mantido pela TOTVS fazer a respectiva chamada da função EPL mantida pelo cliente, onde neste caso não terá nomenclatura padrão TOTVS para a função e deverá prever o recebimento de todos os parâmetros, bem como retornar todos os valores necessários. O cliente, neste caso, deve repassar para equipe de desenvolvimento da TOTVS a documentação da função, indicando o nome da função, objetivo, especificação dos parâmetros de entrada e dos retornos da função, bem como os tipos e dimensões de cada retorno. De preferência sempre tentar definir um dos retornos desta função como sendo um STATUS de execução (valor TRUE ou FALSE) para permitir ter opção de cancelar a ação atual do EPL ou não. Em resumo, um EPL de cliente nesta situação nunca retorna dados diretamente para a aplicação padrão do LOGIX, pois os retornos desta função serão consistidos antes de serem utilizados para alterar algum dado no sistema.

5 Como usar a função LOG_getVar() Sintaxe LOG_getVar(<parâmetro>) Objetivo Buscar algum valor que foi nomeado e armazenado em memória Parâmetro Nome de busca do valor em memória definido pelo sistema LOGIX. Caso seja feita busca de um valor que não tenha sido armazenado pelo sistema LOGIX, uma mensagem de erro no arquivo de LOG do servidor de aplicação será emitida como forma de alerta e valor será retornado como vazio. RETORNO Valor em memória armazenado para o nome repassado como parâmetro. Caso de uso Ponto de entrada LOGIX SUP0580 (Cadastro de fretes) Rotina de consistência de fretes. Função EPL: Y_sup0580_after_insert() Objetivo: Executado após a gravação dos dados no banco de dados relacionados ao frete, antes da efetivação dos dados (COMMIT). Parâmetros EMPRESA TIPO: frete_sup.cod_empresa disponíveis: Empresa do conhecimento de frete CONHECIMENTO TIPO: frete_sup.num_conhec Número do conhecimento de frete SERIE_CONHECIMENTO TIPO: frete_sup.ser_conhec Número de série do conhecimento de frete SUBSERIE_CONHECIMENTO TIPO: frete_sup.ssr_conhec Subsérie do conhecimento de frete TRANSPORTADORA TIPO: frete_sup.cod_transpor Código da transportadora do conhecimento Retorno esperado TRUE Função EPL executada com sucesso FALSE Função EPL gerou alguma inconsistência ou erro

6 Exemplo de código fonte para uma função EPL com nome padrão TOTVS (acionada a partir de uma rotina padrão LOGIX) # # FUNCTION Y_SUP0580_after_insert() # # DEFINE l_empresa LIKE frete_sup.cod_empresa DEFINE l_conhec LIKE frete_sup.num_conhec DEFINE l_ser_conhec LIKE frete_sup.ser_conhec DEFINE l_ssr_conhec LIKE frete_sup.ssr_conhec DEFINE l_cod_trasnpor LIKE frete_sup.cod_transpor #RECUPERAÇÃO DOS PARÂMETROS ENVIADOS PELO SISTEMA LOGIX LET l_empresa = LOG_getVar("empresa") LET l_valor = LOG_getVar("conhecimento") LET l_ser_conhec = LOG_getVar("serie_conhecimento") LET l_ssr_conhec = LOG_getVar("subserie_conhecimento") LET l_cod_transpor = LOG_getVar("trasnportadora") <código específico. Caso tenha alguma falha executar RETURN FALSE> RETURN TRUE END FUNCTION Contatos da Fabrica de Software Logix fswlogix@totvs.com.br Telefone: 0 **