NTEGRAÇÃO <NOME DO REQUISITO> X <VERTICAL/MÓDULO YYY>

Contexto de negócio (Introdução)

Com a integração entre o módulo de Compras do Logix, e o Portal de Compras Paradigma (WBC – Web Business Center), que será responsável pela cotação de itens com diversos fornecedores, é possível agregar volumes de compras para cotação de preço, dentre outras vantagens. A integração proporciona uma automação da área de compras, pois todo o processo de respostas de cotações é realizado pelos próprios fornecedores que já estão cadastrados no portal de compras da Paradigma. Neste portal podem ser feitas avaliações desses fornecedores por outros clientes, como qualidade do produto e prazo de entrega.

  A geração de ordens de compra será realizada no Logix, e serão enviadas para o portal de acordo com a necessidade, para o tratamento pelo portal de compras. O processo de cotação e escolha dos vencedores é realizada no portal, sendo o pedido de compra gerado pelo Logix e posteriormente enviado para o portal de compras da Paradigma, solicitando assim o aceite do Fornecedor vencedor da cotação.

Existe ainda um segundo fluxo nesta integração, onde o comprador pode realizar todo o processo até a geração do pedido de compra dentro do ERP e enviar então apenas o pedido para o portal, solicitando o aceite do Fornecedor.(Necessário Verificar como ficará as tags de cotação que o portal envia quando a cotação é feita pelo portal)

Além da integração de transações de negócio (ordens de compra, cotação e pedido) são integrados uma série de cadastrados

para equalizar os dados utilizados entre os dois sistemas.

Esta integração se dará utilizando Mensagem Única/EAI2 e suas transações como síncronas.

Sistemas Envolvidos

Descrição dos sistemas envolvidos no contexto de negócio (e que serão envolvidos na integração).

• Suprimentos Logix, módulo de compras.
• Parceiro - Portal de Compras Paradigma - WBC

Escopo

Descreva, dado o contexto, qual o escopo de atuação da integração. Cite as áreas/perfis de usuários e funções impactadas. Se existe uma parte do contexto de negócio que a integração não tenta resolver, deixe explícito.

Defina exatamente o que a integração FAZ, o que ela NÃO FAZ e a sua finalidade.

[O conteúdo poderá estar disponível na ferramenta PMS – Painel de Gestão de Projetos, opção Plano do Projeto]

Como são os processos os que serão integrados, mas com uma visão geral e não só o ponto de integração caso contrário a homologação [ou outro que pegar o documento] não saberá do que se trata no sistema vertical, de forma sucinta, como funciona e o(s) ponto(s) de integração.

Citar a responsabilidade de cada produto.

Descrever com mais detalhes sobre o que será integrado (mas não ser especialista nas entidades/processos, pois suas particularidades serão descritas posteriormente) incluindo diagramas, prints, imagens, etc o que for interessante para auxiliar o entendimento.

Interessante aqui a inclusão de diagramas, imagens, lógicas, fluxo(s) do(s) processo(s) o que considerar interessante e agregador ao documento e ao escopo.

Pré-requisitos instalação/implantação/utilização

Versões mínimas de produto Logix:

• Logix – Versão 12 ;
• Pacote de liberação - 12.1.12;

Pré-requisitos:

• Criação do webservice e instalação/configuração do EAI Logix, com as mensagens de integração habilitadas no monitor EAI10000, consultar http://tdn.totvs.com/pages/releaseview.action?pageId=36308844.

Instalação/Atualização

Configuração das transações do EAI Logix:

• Executar o programa EAI10000 (Monitor EAI)
  • Acesse o menu Configuração > Aplicativo Hospedeiro. Clique no botão “Buscar novos adapters” para carregar os adapters existentes no RPO, de acordo com as novas configurações. Lembrando que os adapters são as funções responsáveis pelo tráfego de mensagens entre os sistemas.
  • Acesse o menu Configuração > Aplicativos Externos. Clique no botão “Incluir” e na opção “Configuração”:
    • Selecione a Classe Canal “EAIChannelParadigma”
    • Informe a “url” do webservice da Paradigma
    • Preencha o campo “textformat” com 1
    • Clique em “Confirmar” na tela de Configuração e na tela de criação do Aplicativo Externo

Acesse novamente o menu Configuração > Aplicativo Hospedeiro. Clique no botão “Modificar” e no ícone referente as “Rotas” de cada uma das mensagens abaixo, para habilitar o trafego das mensagens entre os webservices do Logix e da Paradigma

Datasul

Insira aqui as informações pertinentes a Datasul.

Logix

Parâmetros gerais:

 Utiliza a integração com Portal de Compras Paradigma

→ Conversor: SUP01685

→ LOG00086 (Parâmetros) – utiliza_portal_paradigma– (“N”)

Parâmetro que indica se serão integrados com o Portal de Compras Paradigma os dados dos cadastros de Unidade de Medida, Fornecedor, Estabelecimento, Transportador, Item (Produto), Relacionamento Item

(Produto) x Fornecedor, Moeda, Usuário e Condição de Pagamento.

Para que a integração entre o Logix e o Portal Paradigma funcione, este parâmentro deverá estar habilitado.

Permite recebimento para pedidos recusados pelo fornecedor no Portal?

→ Conversor: SUP01726

→ LOG00086 (Parâmetros) – permite_rec_ped_recus_portal– (“1”)

Opções:

1 - Bloqueia recebimento: Realiza o bloqueio no recebimento manual (SUP3760) e importações Totvs Colaboração (SUP34203), Importação de notas (SUP0552), EDI (SUP0001).

2 - Alerta no recebimento manual: Emite um alerta no recebimento manual (SUP3760) somente, para as demais rotinas realiza o bloqueio.

3 - Não considera: Não considera a recusa de pedido do Portal, permite incluir nota fiscal normalmente, manual (SUP760) e importações Totvs Colaboração (SUP34203), Importação de notas (SUP0552), EDI (SUP0001).

Parâmetros por Fornecedor:

 Efetuar comunicação via Portal de Compras?

→ VDP10000 – folder Fornecedor > Comunicação (SUP20132)

Este parâmetro é gravado na tabela “sup_par_fornecedor”, parâmetro “forn_portal_compras” parâmetro_booleano = “S”.

Este parâmetro estará visível na tela de Comunicação apenas quando o parâmetro geral “utiliza_portal_paradigma” estiver habilitado.

A partir do momento que o parâmetro “forn_portal_compras” estiver habilitado para o fornecedor, toda modificação, ou carga inicial, ele será integrado com o Portal de Compras. 

Protheus

Insira aqui as informações pertinentes ao Protheus.

RM

Insira aqui as informações pertinentes ao RM.

Controle de Versão

O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.

Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.

Suporte

O suporte aos recursos da Integração será de responsabilidade de todas as linhas, sendo assim as equipes de suporte dos produtos RM Conector e Backoffice Protheus estarão aptas a fazer a primeira análise e, quando necessário, repassar para a equipe mais adequada em cada caso.

Observação: Este modelo de suporte está sendo revisado pela TOTVS.

Transações/Entidades/Mensagens únicas

Apresente quais as transações/entidades que são trocadas e quem envia a informação para quem. Pode (e recomenda-se) ter um diagrama, uma tabela ou afins que apresente este fluxo.

Relacione quais são as mensagem únicas (TOTVSMessage) utilizadas e qual o seu relacionamento com as entidades já existentes do ERPs envolvidos.

Exemplos:

Fluxo das Informações

Para cada fluxo de informação descreva, se necessário, alterações de comportamento que o respectivo produto irá sofrer. Por exemplo: quando o Logix recebe o PEDIDO de OUTRO ERP, este pedido não poderá ser alterado no Logix.

Liste quais as entidades integradas e como é o mapeamento entre as diferentes estruturas. Por exemplo: Classe no sistema A vira categoria no sistema B, o campo X é refletido no campo Y etc.

Liste quais transações/operações a integração fará com as entidades relacionadas. Exemplo: Insert de PEDIDO, Insert, update de ITEM, buscar saldo em estoque do ITEM no dia X ou buscar dados do FUNCIONÁRIO.

Cadastros

Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.

Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos

Em seguida faça uma descrição para cada um dos fluxos para cada entidade

<Transação/Entidade>

Identificador da Mensagem: <mensagem>

Versão: <versão>

Módulo <marca 1>: <BackOffice – Gestão xxxxxxx>

Módulo <marca 2>: <SIGAXXX>

Tipo de Envio: <Assíncrona/Síncrona>

Notas:

Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela

A seguir descrever as variações, particularidades da mensagem e processos (integração) de acordo com cada marca

Limitações/Restrições

Descreva limitações e restrições para a integração que está sendo descrita.

Processos

Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.

Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos

Em seguida faça uma descrição para cada um dos fluxos para cada entidade

<Transação/Processo>

Tipo de Fluxo: Protheus -> RM

Mensagem: Request_1_000

Versão: 1.000

Descrição de todo o comportamento e funcionamento do processo. Breve contexto, origem, regras, integração (geração da mensagem, envio, recebimento no destino), o quê supostamente irá ocorrer no destino, retorno, impacto, consequências, o que foi afetado, como conferir, validar, etc o retorno.

Acrescentar um diagrama do processo.

A seguir descrever as variações, particularidades da mensagem e processos (desta integração) de acordo com cada marca

Notas:

Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela

Limitações/Restrições

Descreva limitações e restrições para a integração que está sendo descrita. 

Limitações / Restrições Gerais

Descreva limitações e restrições para cada fluxo descrito no tópico anterior. Exemplo:

• ERP1 envia ITEM cadastrado para o ERP2

ERP1 somente enviará o ITEM se este estiver em uma das famílias cadastradas no parâmetro FAMILIA_INTEGRACAO.

Se o tipo de valorização do estoque for FIFO.

• ERP2 envia PEDIDO cadastrado para o ERP1

O pedido recebido no ERP1 vindo do ERP2 estará bloqueado para alteração.

Como fazer (opcional)

Descreva os passos que viabilizem a integração.

Exemplo:

Os passos para viabilizar a integração são:

• No Logix ou no Protheus efetue o cadastro das seguintes informações: Clientes, fornecedores, transportadores, cidades, cotação de moeda e unidades de medida.
• No Logix cadastrar um novo depositante e efetuar toda a parametrização necessária para a operação de WMS.
• No Logix cadastrar um novo produto que seja controlado pelo WMS, para o depositante cadastrado anteriormente.
• No Logix efetuar um processo de recebimento para o produto cadastrado anteriormente, utilizando uma nota fiscal provisória (tipo “A”).
• No Protheus consultar a nota fiscal de recebimento que foi registrada no Logix, validando as informações recebidas.
• No Logix efetuar um processamento de regularização fiscal, efetuando a cobertura dos produtos recebidos anteriormente.
• No Protheus verificar se foi efetuado corretamente o relacionamento entre os dois documentos.
• No Logix efetuar um processo de expedição para o novo produto cadastrado, até o momento do envio da mensagem de integração de pedido de venda.
• No Protheus efetuar o faturamento do pedido de venda recebido.
• No Protheus verificar se a nota fiscal gerada contém todas as informações necessárias para o segmento de operador logístico (armazém geral).
• No Protheus efetuar a escrituração fiscal das notas fiscais, verificando se as regras da legislação deste segmento foram respeitadas.
• No Logix é possível consultar o número do pedido de venda gerado para as notas fiscais de retorno simbólico e conta/ordem no programa WMS6333 (Consulta de Documentos). Para os processos de faturamento de serviço o número do pedido está disponível no programa WMS6411 (Movimentos a Faturar).

Situações comuns (opcional)

Descreva situações problemáticas comuns que podem ocorrer durante o funcionamento da integração e como solucioná-los. Neste ponto também é importante dar instruções de como reconhecer e investigar problemas que podem vir a ocorrer durante a integração. Se houver, apresente tabelas de códigos e descrições de erros que a integração poderá apresentar.

Este tópico possivelmente será alimentado com as experiências durante o desenvolvimento da integração e poderá ser realimentado durante o uso da integração no cliente.

Exemplo 1:

Tratamento de erros de integração (Produto A)

Tratamento de erros de integração (Produto B)

Exemplo 2:

Quando uma mensagem é enviada do Logix para o Protheus, podem ocorrer situações em que o WebService não estará totalmente funcional. Nestes casos uma mensagem de erro genérica irá aparecer na tela:

Exemplo:

Erro ao enviar a mensagem de Cidade via Integração

Se o arquivo de log for analisado, poderemos ver a falha na comunicação com o sistema destino:

-------------------------------------------------------------------------------

WSCERR044 / Não foi possível POST : URL http://172.16.31.57:8011/ws/FWWSEAI.apw

ADVPL WSDL Client 1.080707 / tst on 20120315 08:49:51

-------------------------------------------------------------------------------

Para resolver este problema, verifique as configurações do sistema de destino, analisando o funcionamento do servidor utilizado para esta comunicação e a habilitação do endereço do WebService. 

Checklist de suporte da aplicação

Crie um check-list de verificação de alguns pontos importantes para o funcionamento e atendimento da integração.

Instalação/Configuração

Relacione itens de verificação para garantir que a integração está corretamente instalada e configurada. Isto não pode ser uma cópia do procedimento de instalação/configuração, mas verificações pontuais que podem remeter aos itens da instalação.

Checklist de Verificações:

Relacione itens de verificações para que o atendente possa:

• Identificar o funcionamento da integração;
• Identificar a ocorrências de problemas;
• Coletar evidências do mau funcionamento relatado pelo cliente;
• Realizar possíveis ajustes na integração quanto à configuração ou negócio.

Anexos