Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|
Especificação | |||
Produto | PROTHEUS | Módulo | SIGAGFE |
Segmento Executor |
| ||
Projeto1 | M_DL_GFE002 | IRM1 | PCREQ-9315 |
Requisito1 | PCREQ-9318 | Subtarefa1 | PDRDL-2399 |
Chamado2 |
| ||
País | ( X ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colombia ( ) Outro _____________. | ||
Outros | ER_PCREQ-9323_Aprovação_de_tabelas_de_frete_por_nível_de_alçada_(ADVPL) |
Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos).
Desenvolver estrutura para a integração de tabelas e negociações de fretes com o módulo MLA do ERP Datasul.
O Módulo de MLA (Módulo Logístico de Aprovação) serve para controlar eletronicamente a aprovação de documentos conforme parametrização. Através dele é permitido ao aprovador visualizar as principais informações do documento e aprová-lo através de e-mail (Microsoft Outlook ou Lotus Notes) ou pelo Portal do MLA, sem necessariamente acessar o ERP. Ele permite a aprovação de diversos tipos de documentos do Datasul-EMS, inclusive os que estiverem sendo controlados por rotinas específicas, ou seja, documentos específicos.
Através deste requisito, será possível utilizar o módulo para a aprovação de tabelas de fretes e negociações criadas no SIGAGFE. Para tanto, será criado um novo tipo de documento no MLA denominado "Negociação de fretes", código 029.
A chave definida para o documento será ( Cadastrado no programa MLA0102 ):
INI | FIM | DESCRIÇÃO | |
---|---|---|---|
29 - Negociação de Fretes | 1 | 5 | Cod. Estabel |
6 | 20 | Fornecedor | |
21 | 27 | Tabela | |
28 | 33 | Negociação |
Referência:
A referência poderá ser utilizada como diferencial de aprovação do documento e, para a negociação de frete, será utilizado o Transportador (GV9_CDEMIT), permitindo assim um direcionamento da aprovação particular entre as tabelas de cada fornecedor de serviço de fretes.
A integração da negociação será efetuada via Web Service Protheus, seguindo o modelo atual de integração entre ERP Totvs 12/Datasul e SIGAGFE para os processos de frete, passando pelas etapas de Solicitação dos registros pendentes - Recebimento e processamento > Execução Integração MLA (API) > Retorno das informações.
Nos programas de solicitação de registros para integração, CD0433, CDF433 e CDF433RP, será feita a chamada para a API que gera a pendência do documento no MLA, e aguarda a aprovação.
Utilizando o processo de aprovação do MLA, as aprovações podem ser realizadas de diversas formas:
Também serão desenvolvidos novos programas para a consulta da pendência através do programa MLA0301, para aprovação no Portal HTML e Aprovação por e-mail.
cdp\cd0433.W – Monitor Integração GFE | Alteração | Logística -> Gestão de Frete Embarcador -> Tarefas | - |
cdp\cdf433.P - Agent Listener GFE | Alteração | NA | - |
cdp\cdf433RP.P - integração via RPW | Alteração | NA | - |
cdp\cdf433.i11 - Integração | Criação | NA | - |
cdp\cd0089.w - Parâmetros de integração GFE | Alteração | Logística -> Gestão de Frete Embarcador -> Tarefas | - |
laphtml\ mlahtml029e.p - Aprovação por e-mail | Criação | NA | - |
lapepc\mla029.p - Retorno da aprovação | Criação | NA | - |
MLA0122 - Inclusão Facilitada | Alteração | NA | - |
laphtml/mlahtml029p.p - Novo portal MLA | Criação | NA | - |
CD0433.W, CDF433.P, CDF433RP.P:
Neste programas, serão criadas as chamadas para a include CDF433.I11 que fará a interpretação da mensagem enviada pelo GFE e a chamada da include de integração com o MLA.
Segue o padrão de integração de outros processos do SIGAGFE com o ERP Totvs 12 / Datasul (Ex.: cdf433.i1).
Esta chamada será condicionada com ao campo de integração da negociação de fretes com o MLA, no cabeçalho do CD0433 ou nos parâmetros de entrada do CDF433 e CDF433RP.
A Chamada do registro e a geração da pendência com sucesso, altera a situação do campo GV9_SITMLA para 7-Enviado/aguardando aprovação, para evitar que seja chamado novamente pelo Agent Listener.
Incluir na tela do programa CD0433 a opção para marcar a integração de negociações de frete com o MLA (conforme protótipo de tela apresentado na respectiva seção).
cdp\cdf433.i11
Este programa será o responsável por receber a informação enviada do GFE e seu processamento para o envio correto das informações solicitadas pela API de integração MLAAPI001.
Ele segue o padrão de estrutura de integrações do SIGAGFE com o ERP Totvs 12/Datasul (Ex.: cdf433.i1)
As informações enviadas pelo Web Service do SIGAGFE para o MLA terá a estrutura de toda a tabela de frete e será necessária a quebra dos registro para a chamada do programa de integração:
#GV9|GV9_FILIAL|GV9_CDEMIT|GV9_NRTAB|GV9_NRNEG|GV9_CDCLFR|GV9_CDTPOP|GV9_DTVALI|GV9_TPLOTA|GV9_DTCRIA|GV9_USUCRI|GV9_SITMLA|
#GV8|GV8_NRROTA|GV8_TPORIG|GV8_NRCIOR|GV8_DSTORI|GV8_DSTORF|GV8_NRREOR|GV8_CDPAOR|GV8_DSPAOR|GV8_CDUFOR|GV8_CDFIOR|GV8_TPDEST|GV8_NRCIDS|GV8_DSTDEI|GV8_DSTDEF|GV8_NRREDS|GV8_CDPADS|GV8_CDUFDS|GV8_CDFIDS|GV8_NMREM|GV8_CDDEST|
#GV7|GV7_CDFXTV|GV7_CDTPVC|GV7_DSTPVC|GV7_QTFXFI|GV7_UNICAL|GV7_VLALUG|GV7_FRQKM|GV7_VLKMEX|
#GV1|GV1_CDCOMP|GV1_VLFIXN|GV1_PCNORM|GV1_VLUNIN|GV1_VLFRAC|GV1_VLMINN|GV1_VLLIM|GV1_VLFIXE|GV1_PCEXTR|GV1_VLUNIE|GV1_CALCEX|
#GVQ|GVQ_CODCOT|GVQ_SEQCOT|GVQ_OBSCOT|GVQ_VALCOT|
O programa chama em seguida a API de criação de pendência de negociações de frete no MLA - mlaapi001.p, passando os parâmetros abaixo informados na tabela de parâmetros do programa MLAAPI001.
Como o processo de aprovação no MLA não prevê documentos de outros sistemas, fora das tabelas do Totvs 12 / Datasul, será necessário gravar um registro na tab-generica com os dados que serão utilizados para apresentação no e-mail de aprovação, programa de consulta e no detalhamento do documento no portal MLA.
A criação do registro na tab-generica terá a utilização = "GFE_MLA_GV9", gravando a chave do registro no campo char-1 e os demais da estrutura no char-2.
Cada registro de tabela vindo do GFE (#GV9, #GV8, etc.) será gravada em uma tab-generica diferente, sempre diferenciando pelo campo utilização, que terá a nomenclatura da tabela ao final do código "GFE_MLA_XXX" (Ex.: GFE_MLA_GV9, GFE_MLA_GV8).
O retorno da temp-table tt-erro deve ser direcionado para o GFE para ser gravado no campo "GV9_MOTMLA".
A sintaxe para a chamada da API (baseada no documento MLAAPI001 - API - Geração de pendência de aprovação (MLA) ):
Tabela de parâmetros - MLAAPI001
Parâmetro | Tipo | Formato | Descrição | Entrada/Saída |
i-cod-tip-doc | Inteiro | >>9 | Código do tipo do documento para o qual deve ser gerada, alterada ou eliminada a(s) pendência(s)
Utilizar: 29 – Negociação de fretes. | Entrada |
i-tipo-trans | Inteiro | 9 | Transação que está sendo realizada (criação, alteração ou eliminação) Utilizar: 1 – Inclusão (Se o GV9_SITMLA = “2”) 2 – Modificação 3 – Eliminação (Se o GV9_SITMLA = “5”) | Entrada |
c-motivo | Caractere | x(40) | “Aprovação de nova tabela de fretes” | Entrada |
de-valor | Decimal | ->>,>>>,>>9.99 | GVQ_VALCOT | Entrada |
i-moeda | Inteiro | >9 | 0 | Entrada |
c-usuar-trans | Caractere | x(12) | GV9_USUCRI | Entrada |
c-usuar-doc | Caractere | x(12) | GV9_USUCRI | Entrada |
c-lotacao-doc | Caractere | x(20) | “ ” | Entrada |
c-item | Caractere | x(16) | “ ” | Entrada |
c-referencia | Caractere | x(20) | GV9_CDEMIT | Entrada |
c-ep-codigo | Caractere | x(3) | Empresa corrente | Entrada |
c-cod-estabel | Caractere | x(5) | Estabelecimento para o qual a pendência será gerada. – GV9_FILIAL | Entrada |
tt-mla-chave | Temp-table |
| Informações da chave do documento. Enviar cada um dos registros de chave do documento como um registro diferenciado de "extent" na temp-table. (input table tt-mla-chave) | Entrada |
tt-erro | Temp-table |
| Retorno de erros do MLA | Saída |
Após a criação da pendência de aprovação no MLA, enviar mensagem ao GFE para alterar a situação do campo GV9_SITMLA para '7-Enviado/aguardando aprovação', através da função setdataws. Esta alteração é necessária para que o registro não seja chamado novamente pelo Web Service enquanto não for aprovado ou rejeitado no MLA.
laphtml\ mlahtml029e.p :
Quando forem geradas as pendências de aprovação, o usuário receberá em seu e-mail o HTML com as informações do documento em questão e opções para aprovação (Para este processo é necessário configurar o usuário para o recebimento do e-mail).
O programa MLAHTML029e terá a função de criação e envio do e-mail aos usuários cadastrados como aprovadores da pendência de negociação de fretes. O programa deve possuir os seguintes parâmetros:
Código do tipo do documento (INTEGER - INPUT)
Código do aprovador (CHARACTER - INPUT)
Chaves do documento - tt-mla-chave (TEMP-TABLE - definição na include: lap/mlaapi001.i99 - INPUT)
HTML do e-mail - tt-html (TEMP-TABLE - definição na include: laphtml/mlahtml.i - OUTPUT)
Dentro deste programa será estruturado o e-mail de aprovação, no formato '.html' com as informações da tabela de fretes.
Apresentar as informações disponíveis no registro da tab-genérica.utilização = "GFE_MLA_GV9", e relacionadas, que forem criadas no programa cdf433.i11 com os dados enviados pelo SIGAGFE.
cdp\cd0089.w:
Criar o parâmetro de integração do processo de aprovação de negociações de fretes, conforme protótipo apresentado na seção 'Protótipo de tela".
Este parâmetro será gravado na tab-generica.utilização = "Setup", posição 704 do campo char-2. Terá a função de habilitar ou desabilitar a opção de integração das negociações de frete com o MLA no CD0433/ CDF433 e CD0433rp.
lapepc\mla029.p :
Programa para tratamento e envio do retorno da aprovação ou rejeição efetuado pelo usuário no MLA.
Este programa será executado quando o usuário aprovador realizar a intervenção na pendência de negociação de fretes no MLA e deve ser cadastrado no programa MLA0101 (FAQ 58026 - Quais informações devem ser preenchidas no programa MLA0101?).
A ação do usuário sobre a pendência deve ativar a chamada para a função do Web Service Protheus setdataws, passando a atualização do registro no GFE. Segue a estrutura utilizadas nas integrações de processos do SIGAGFE no Datasul, como a integração de doc. frete com fiscal, etc.
Ex.: RUN setdataws IN hcdf600(INPUT lcTabela, INPUT lcIntegracao, INPUT cRetornoToSetData, INPUT cSetData).
MLA0122 - Inclusão Facilitada:
Será alterado o programa MLA0122, Programa de inclusão facilitada da pendencia de aprovação, para que o documento 029-Negociação de fretes e sua chave possam ser gerados de forma automatizada pelo usuário.
A exemplo dos demais tipos de documentos do MLA, criar o bloco de tratamento para o documento tipo 29.
laphtml/mlahtml029p.p
Programa progress que irá retornar os dados para a interface HTML (tanto para a listagem de documentos, quando para o detalhamento).
Para a construção desse programa utilizar os programas laphtml/mlahtml000p.p e laphtml/mlahtml000p.i como exemplo (que estão expedidos com fonte aberto). Eles contêm orientações e exemplos para construção deste programa.
Criar os HTMLs que funcionem de forma responsiva, para que possam ser executados em dispositivos móveis também.
A estrutura do programa deve seguir o padrão orientado pela equipe de desenvolvimento do módulo MLA, documetado em: DMLA0003_Como_criar_documentos_para_o_novo_portal_do_MLA_ou_customizar_existentes_(a_partir_12.1.8).
Estrutura de apresentação do documento de negociação de fretes no Portal:
Dados principais (lista de pendências):
Filial
Solicitante
Data da solicitação
Transportador
Número da tabela
Nr. da Negociação
Valor do comparativo de fretes
Detalhamento (em sequencia, conforme quantidade de registros):
Tarifa
- Componente
- Valor tarifa. (Todos os campos da GV1)
Rota
- Nr. Rota
- Tipo Origem
- Origem
- Tipo Destino
- Destino
Faixa
- Cod. Faixa
- Cod. tp. veículo
- Descr. tipo de veículo
Obs.: Atualizar a documentação no TDN:
FAQ 58026 - Quais informações devem ser preenchidas no programa MLA0101?
FAQ 58025 - Quais informações devem ser preenchidas no programa MLA0102?
DMLA0004_Quais_são_as_informações_consideradas_como_referência_para_os_documentos_do_MLA?
Tabelas Utilizadas
CD0433 - Monitor de integração TOTVS 12 X SIGAGFE.
CD0089 - Parâmetros de integração EMS x GFE
Não se aplica.
Não se aplica.
Não se aplica.
Não se aplica.
Procedimentos
Não se aplica.
Programas
Programa | mlaapi010v.p | mlahtml029e.p | mla029.p | mlahtml029p.p | CDF433.I11 |
Descrição | API integração negoc. frete x MLA | E-mail aprovação negoc. frete x MLA | Aprovação/rejeição negoc. frete x MLA | Página de aprovação de negoc. frete x Portal MLA | Receiver negoc. frete x MLA. |
Nome Externo | lap\mlaapi010v.p | laphtml\ mlahtml029e.p | lapepc\mla029.p | laphtml/mlahtml029p.p | CDF433.I11 |
Nome Menu/Programa |
|
|
| ||
Nome Verbalizado[1] |
|
|
| ||
Procedimento |
|
|
| ||
Template | (Verificar lista de opções no man01211) | (Verificar lista de opções no man01211) | (Verificar lista de opções no man01211) | ||
Tipo[2] | Tarefas | Tarefas | Tarefas | Tarefas | Tarefas |
Interface | GUI | GUI | GUI | GUI | GUI |
Categoria[3] |
|
|
| ||
Executa via RPC | Não | Não | Sim | Não | sim |
Registro padrão | Sim | Sim | Sim | Sim | Sim |
Outro Produto | Não | Não | Não | Não | Não |
Visualiza Menu | Não | Não | Não | Não | Não |
Query on-line | Não | Não | Não | Não | Não |
Log Exec. | Não | Não | Não | Não | Não |
Rotina (EMS) |
|
|
| ||
Sub-Rotina (EMS) |
|
|
| ||
Localização dentro da Sub Rotina (EMS) |
|
|
| ||
Compact[4] | Sim/Não | Sim/Não | Sim/Não | ||
Home[5] | Sim/Não | Sim/Não | Sim/Não | ||
Posição do Portlet[6] | 0 – Top Left 1 – Top Right 2 – Bottom Left 3 – Bottom Right | 0 – Top Left 1 – Top Right 2 – Bottom Left 3 – Bottom Right | 0 – Top Left 1 – Top Right 2 – Bottom Left 3 – Bottom Right | ||
Informar os papeis com os quais o programa deve ser vinculado |
|
|
|
[1] Nome Verbalizado é obrigatório para desenvolvimentos no Datasul 10 em diante.
[2] Tipo é obrigatório para desenvolvimento no Datasul 10 em diante
[3] Categorias são obrigatórias para os programas FLEX.
[4] Obrigatório quando o projeto for FLEX
[5] Obrigatório quando o projeto for FLEX
[6] Obrigatório quando o projeto for FLEX
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|