Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Migration of unmigrated content due to installation of a new plugin

 Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico.                                                             

  

(Obrigatório)

Informações Gerais

 

Especificação

Produto

 PROTHEUS

Módulo

 SIGATMS

Segmento Executor

 

Projeto1

 LOGTMS01

IRM/EPIC1

 LOGTMS01-1469

Requisito/Story/Issue1

 

Subtarefa1

 

Chamado/Ticket2

 

País

( X ) Brasil  (  ) Argentina  (  ) Mexico México  (  ) Chile  (  ) Paraguai  (  ) Equador

(  ) USA  (  ) Colombia   Colômbia   (  ) Outro _____________.

Outros

<Caso necessário informe outras referências que sejam pertinentes a esta especificação. Exemplo: links de outros documentos ou subtarefas relacionadas>.

   Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos). 

(Obrigatório)

Objetivo 

 Fornecer

Fornecer e controlar de forma única e sequencial a numeração para qualquer cadastro integrado com o Código Único disponibilizado pela Integração do Datasul via Mensagem Padronizada – EAI.

Garantir

Também permite que

os

cadastros

que

de clientes e fornecedores, possuam o mesmo código para consulta e alteração

pertençam

desde que pertença a mesma

pessoal

pessoa física ou jurídica.

 

  

(Obrigatório)

Definição da Regra de Negócio

 O que é Código Único

 

 É É um controle de numeração automático que é disponibilizado e controlado pelo Datasul. E permite  Permite que os cadastros sejam integrados com o mesmo código, desde que pertença a mesma pessoal pessoa física ou jurídica, garantindo assim que a consulta de um cadastro especifico seja realizado em qualquer um dos sistemas integrados pelo mesmo código de pesquisa.

 

 

Rotinas Envolvidas na Integração: 

Rotina

Tipo de Operação

Opção de Menu

Regras de Negócio

MATA020B - Integração

[Chamada de Integração

 

-

MATI020B – Rotina EAI

[Disparo da Integração]

 

-

MATA030 - Cadastro de ClientesCadastro 

Exemplo de Aplicação:

  • Criar o campo “% Mínimo Espécie” (AAA_PERESP) onde o usuário informará o % que o aluno pagará em dinheiro. Esse % poderá ser alterado durante a negociação.
  • Criar o campo “Referência Mínima para Cálculo” (AAA_REFCAL) onde o usuário informará um dos 4 valores disponíveis para pagamento das mensalidades  como a referência mínima para calcular o débito total do aluno.
  • Criar o parâmetro MV_ACPARNE que definirá se as informações de “% Mínimo Espécie” e “Referência Mínima para Cálculo” serão obrigatórias.
  • O parâmetro MV_ACPARNE deve ter as seguintes opções: 1=Obrigatório e 2=Opcional. Deve ser inicializado como opcional>.

 

Opcional

Protótipo de Tela

 

não tem.

 

Protótipo 01

 

 

 Image Removed

 

 

 

 

 

 

Opcional

Fluxo do Processo

 

<Nesta etapa incluir representações gráficas que descrevam o problema a ser resolvido e o sistema a ser desenvolvido. Exemplo: Diagrama - Caso de Uso, Diagrama de Atividades, Diagrama de Classes, Diagrama de Entidade e Relacionamento e Diagrama de Sequência>. 

Opcional

Dicionário de Dados

 

Arquivo ou Código do Script: AAA – Negociação Financeira / *Versao=CP.2014.12_03*/

  

Índice

Chave

01

<FI9_FILIAL+FI9_IDDARF+FI9_STATUS>

02

<FI9_FILIAL+FI9_FORNEC+ FI9_LOJA+FI9_EMISS+FI9_IDDARF>

03

<FI9_FILIAL+FI9_FORNEC+ FI9_LOJA+FI9_PREFIX+FI9_NUM+FI9_PARCEL+FI9_TIPO>

Campo

<AAA_PERESP>

Tipo

<N>

Tamanho

<6>

Valor Inicial

<Varia de acordo com o tipo informado. Por exemplo, quando o campo “tipo” for date, neste campo pode ser informado uma data>. 

Mandatório

Sim (  ) Não (  )

Descrição

<Referência Mínima para Cálculo>

Título

<Ref.Calc.>

Picture

<@E999.99>

Help de Campo

<Informar o % que o aluno pagará em dinheiro. Esse % poderá ser alterado durante a negociação>

 

(Opcional)

Grupo de Perguntas

 

<Informações utilizadas na linha Protheus>.

 

Nome: FINSRF2

X1_ORDEM

01

X1_PERGUNT

Emissão De

X1_TIPO

D

X1_TAMANHO

8

X1_GSC

G

X1_VAR01

MV_PAR01

X1_DEF01

Comum

X1_CNT01

'01/01/08'

X1_HELP

Data inicial do intervalo de emissões das guias de DARF a serem consideradas na seleção dos dados para o relatório 

 

(Opcional)

Consulta Padrão

<Informações utilizadas na linha Protheus>

 

Consulta: AMB

Descrição

Configurações de Planejamento

Tipo

Consulta Padrão

Tabela

“AMB”

Índice

“Código”

Campo

“Código”; ”Descrição”

Retorno

AMB->AMB_CODIGO

 
 
MATA020 - Cadastro de FornecedoresCadastro  

 

Como funciona

Ao realizar um cadastro de Cliente ou Fornecedor e após preencher os campos CNPJ/CPF (A1_CGC) e Inscrição Estadual (A1_INSCR), será disparada a integração pela rotina Integração (MATA020B) que solicita o código único para o Datasul (responsável pelo controle e distribuição do código). A rotina de integração do Protheus recebe o próximo código disponível e verifica qual rotina de cadastro fez a solicitação de uso do código e vincula o valor ao respectivo campo que representa o código de cadastro podendo ser A1_COD ou A2_COD.

Ao confirmar o cadastro, após o preenchimento dos principais campos é realizada uma segunda integração que envia para o Datasul o código único fornecido na primeira integração e completa com a inscrição federal (CPF ou CNPJ) e a inscrição estadual.


Momentos da Integração:

A integração acontece em 2 estágios:

  1. Ao preencher os campos referentes ao CPF/CNPJ e Inscrição Estadual, estando esses campos validos e preenchidos é disparada a integração via EAI solicitando o próximo código disponível. Na integração realizada, neste momento é enviado para o Datasul apenas as informações dos campos CPF/CNPJ e Inscrição Estadual.
  2. Na confirmação do cadastro é disparada outra integração via EAI informando o código único que o Datasul disponibilizou. Neste momento é informado o CNPJ/CPF e a Inscrição Estadual para atualizar o controle de numeração pelo Datasul.

 

Observação:

Os campos A1_LOJA ou A2_LOJA deve ser preenchido com inicializador padrão.

A rotina de integração verifica internamente para qual das rotinas Fornecedores (MATA020) ou Cliente (MATA030), está solicitando o código único e de acordo com o nome da rotina passada será atualizado com o código único o campo de código. Conforme demonstrado abaixo:

  • Se Fornecedores (MATA020), atualiza o campo A2_COD;
  • Se Cliente (MATA030), atualiza o campo A1_COD;


Observação:

O campo A1_LOJA ou A2_LOJA, deve ser preenchido com inicializador padrão.


Importação do XML de Nota Fiscal

Fonte TMSAE80.PRW (Integração Totvs Colaboração Notas Fiscais de Clientes)

Nesta rotina existe a chamada de rotina automática pela function TMSAE80Inc(), quando houver a leitura de um destinatário será executada a rotina automática para o cadastro de Clientes (MATA030). Estando o adapter de código único cadastrado será realizada a chamada via Integração EAI do código único e esse cadastro será gravado com esse código.

 

Configuração Inicial

  1. Cadastrar o Adapter pelo Módulo Configurador (SIGACFG) e informar a rotina EAI (MATA020B) referente a Mensagem Padronizada – CUSTOMERVENDORRESERVEID.
    A interface de cadastro pode ser acessada pelo módulo de Configuração (SIGACFG) pelo caminho: Ambiente / Schedule / Adapter EAI.
    Clique em Incluir e em seguida cadastre o Adapter conforme tabela de campos informada abaixo:

Tabela de Campos - Integração do Código Único

Campo

Conteúdo

Mensagem Única

1-SIM

Rotina

MATA020B

Mensagem

CUSTOMERVENDORRESERVID

Descrição

Sugerido – Integ-Codigo Único

Envia

1-SIM

Recebe

1-SIM

Método

Embora não seja requerida essa configuração. É obrigatório que seja informado 1-Síncrono.

Operação

1-Todas

Canal Envio

2-EAI

Versão de Envio (Atual 1.000)

O cadastro preenche automaticamente a ultima versão definida na rotina de integração. Caso a versão na marca receptora seja inferior, basta mudar para a versão abaixo ao que ele preencheu no campo, se for superior deverá ser atualizada a versão do XSD da mensagem.

 

Ainda nessa tela, existe na parte inferior que se refere ao cadastro do Roteamento de mensagens, esse cadastro é opcional, porém é importante ter um roteamento apontando para cada marca envolvida na integração por meio desse adapter.

Para cadastrar o roteamento basta preencher os seguintes campos:

CampoDescrição
ProdutoPressione F3 ou dê duplo clique no campo, clicando em seguida na lupa para apresentar a tela de seleção de registro. Selecione a rota disponível para a marca da qual deseja se comunicar pela Integração EAI.
EnviaInforme 'SIM' para que seja realizada a integração dependendo de como foram configurados os campos Envia e Recebe.

Observação

Quando falamos de mensagem única com método de envio Síncrono, devemos tomar o cuidado para que apenas uma marca esteja com o campo Envia='SIM'.

 

        2 - Cadastrar o De/Para de Empresa / Filial informando os campos

             Acesse: Ambiente / Schedule / Emp.filial Mensagem Única.

Preencha os campos conforme descrição informada na tabela de campos, logo abaixo:

Campo

Conteúdo

Referencia*

Informar descrição da referencia externa, pode ser a marca ou produto. Como por exemplo: “DATASUL” ou “PROTHEUS”.

Company*

Informar o código da empresa da marca externa.

Branch

Filial da marca externa.

Grupo Emp.Protheus*

Informar o código da empresa associada ao recebimento da integração (Empresa do Protheus).

Fil.Protheus*

Informar a filial que está associada ao recebimento da integração (Filial do Protheus).

         

       3 - Cadastrar a Rota EAI de acesso ao Webservice da marca externa.

           Acesse: Ambiente / Schedule / Cadastro Rotas EAI

Esse cadastro é necessário para que o Adapter entenda para onde a integração deve apontar para realizar o envio do XML de integração.

Preencha os seguintes campos descrito na tabela abaixo:

Campo

Conteúdo

Produto*

Descrição da marca externa. Exemplo: “Datasul” ou “Protheus”.

Aplicação*

Informe o nome da aplicação externa que é associada a mensagem recebida da marca externa.

Url*

Endereço / Url do servidor de webservice do Datasul. Obter essa informação com a equipe de integração da marca externa.

Client WS*

Quando Datasul informar WSEAIDATASUL.

Quando Protheus manter o valor já preenchido por padrão, que é: WSEAISERVICE.

Método*

Manter como receiveMessage.

Usuário

Informe o usuário de autenticação do webservice quando requerido.

Senha

Informe a senha de autenticação do webservice quando requerido.

      4 - Opcional:

           Incluir no inicializador padrão dos campos A1_LOJA e A2_LOJA, o conteúdo inicial para preenchimento desses campos na abertura do cadastro. Caso não seja configurado, a rotina integradora assume o conteúdo para esses campos como sendo “01”.

     5 - Exemplo de Utilização

Exemplo de cadastro de cliente com código único:

Acesso pelo menu do Módulo Gestão de Transportes (SIGATMS): 

Caminho: Atualizações / Cadastros / Clientes (MATA030)

Na tela de Cadastro, os campos referente a Código e Loja, estarão vazios (caso não tenha adicionado um inicializador padrão). 

Image Added

Preencha os campos obrigatórios.

Ao preencher os campos CNPJ/CPF (A1_CGC) e Ins.Est (A1_INSCR) será disparada a Integração EAI que solicitará o código único.

Aguarde a integração conforme figura abaixo:

Image Added

Finalize preenchendo os demais campos e clique no botão Salvar para finalizar o cadastro.

Image Added

Observações:

  • Toda vez que no ato de cadastro for trocado o CNPJ/CPF ou a Inscrição Estadual, será disparada a Integração, e isso fará com que o código único seja subistituído no campo "Código" (A1_COD).
  • Lembre-se que para o código único funcionar, deve-se configurar o Adapter conforme descrito nesta documentação na seção Configurações Iniciais. 
Informações
titleImportante:

Informações adicionais sobre o uso do EAI no Protheus podem ser acessadas pelos links abaixo:

EAI Protheus

A camada do EAI 

(Opcional)

Estrutura de Menu

 

<Informações utilizadas na linha Datasul>.

 

Procedimentos

 

Procedimento

 

 

 

Descrição

(Max 40 posições)

(Max 40 posições)

(Max 40 posições)

Módulo

 

 

 

Programa base

 

 

 

Nome Menu

(Max 32 posições)

(Max 32 posições)

(Max 32 posições)

Interface

GUI/WEB/ChUI/Flex

GUI/WEB/ChUI/Flex

GUI/WEB/ChUI/Flex

Registro padrão

Sim

Sim

Sim

Visualiza Menu

Sim/Não

Sim/Não

Sim/Não

Release de Liberação

 

 

 

 

 

 

Programas

 

Programa

 

 

 

Descrição

(Max 40 posições)

(Max 40 posições)

(Max 40 posições)

Nome Externo

 

 

 

Nome Menu/Programa

(Max 32 posições)

(Max 32 posições)

(Max 32 posições)

Nome Verbalizado[1]

(Max 254 posições)

(Max 254 posições)

(Max 254 posições)

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]

Consulta/Manutenção/ Relatório/Tarefas

Consulta/Manutenção/ Relatório/Tarefas

Consulta/Manutenção/ Relatório/Tarefas

Interface

GUI/WEB/ChUI/Flex

GUI/WEB/ChUI/Flex

GUI/WEB/ChUI/Flex

Categoria[3]

 

 

 

Executa via RPC

Sim/Não

Sim/Não

Sim/Não

Registro padrão

Sim

Sim

Sim

Outro Produto

Não

Não

Não

Visualiza Menu

Sim/Não

Sim/Não

Sim/Não

Query on-line

Sim/Não

Sim/Não

Sim/Não

Log Exec.

Sim/Não

Sim/Não

Sim/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

 

 

 

 

Cadastro de Papéis

<O cadastro de papéis é obrigatório para os projetos de desenvolvimento FLEX a partir do Datasul 10>.

<Lembrete: o nome dos papeis em inglês descrito neste ponto do documento, devem ser homologados pela equipe de tradução>.

 

Código Papel

(máx 3 posições)

Descrição em Português*

 

Descrição em Inglês*

 

[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.