INTEGRAÇÃO Aplicativo Minha Manutenção X ERP Datasul

O objetivo desta integração é permitir que usuários do ERP Datasul possam visualizar e editar os dados informados no Aplicativo Minha Manutenção, reduzindo assim o trabalho de inclusão manual de todas as informações dentro do ERP Datasul e a utilização de folhas de papel.

O Aplicativo Minha Manutenção facilita no processo de Criação da Ordem de Manutenção, Apontamento das Ordens de Manutenção, Acompanhar os Serviços em Andamento e na Solicitação de Serviços.

Sistemas Envolvidos

Os sistemas envolvidos na integração são:

• Aplicativo Minha Manutenção
• ERP Datasul

Configurações para a integração do Aplicativo Minha Manutenção com ERP Datasul

Para a integração é necessário configurar o “valve” para o gerenciamento das conexões.

1 - Localizar o arquivo server.xml, que pode ser encontrado na instância do Jboss: ".\deploy\jboss-web.deployer\server.xml"

2 - Adicionar as linhas abaixo como elemento "filho" da tag <Host ...>:

<Valve className="com.datasul.framework.valve.DatasulValve"

            allowHeaders="Content-Type,Accept,Accept-Language,Content-Language,Authorization,returnformatversion"

            contextsToValidate="/dts/datasul-rest,/api,/webexecbo,/josso"

            allowOrigin="*"

            allowMethods="GET, POST, DELETE, PUT, PATCH, HEAD, OPTIONS"

            allowCredential="true" />

Configurações para realizar o Login no APP

Para realizar o login é necessário que o usuário realize a seguinte configuração no App:

1. Na tela inicial em configurações, deve escolher o tipo de conexão:

• Acesso Direto: Ao selecionar essa opção, deverá ser informado o Servidor(IP), a Porta e o intervalo de sincronização*;
• Acesso via Mingle: Ao selecionar essa opção, deverá ser informado o Alias e o Intervalo de Sincronização*.

1. Na tela inicial do App deve ser informado o mesmo Login e Senha que o usuário utiliza para acessar o ERP Datasul.

*O intervalo de sincronização vêm por padrão em 5 minutos.

O login é realizado através do Basic Authentication, chamando o back end o fonte “profile.p”, para mais informações de login deve-se acessar link Login na página:https://tdn.totvs.com/display/public/FRAMJOI/Desenvolvimento+de+APIs+para+o+produto+Datasul#DesenvolvimentodeAPIsparaoprodutoDatasul-Classesutilit%C3%A1rias

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 do APP

1. Smartphone ou tablet com Android a partir da versão 5.0;
2. Acesso à internet para baixar o aplicativo e para sincronizar as informações do APP com o ERP;
3. Usuário e Senha de acesso ao Datasul;
4. Cadastro do Alias de Acesso no Mingle*.

*Para solicitar a criação do Alias, acesse o endereço https://mingle.totvs.com.br/landpage/.

Datasul

Insira aqui as informações pertinentes a Datasul.

Logix

Insira aqui as informações pertinentes ao Logix.

Protheus

Insira aqui as informações pertinentes ao Protheus.

RM

Insira aqui as informações pertinentes ao RM.

Instalação/Atualização

Este tópico tem por objetivo orientar a instalação da integração, visando o seu funcionamento completo. Instalação de produtos ou ferramentas necessárias podem referenciar outros documentos existentes, desde que estejam disponíveis no repositório de documentação da TOTVS ou sejam enviados junto com o documento da integração em si. As informações mínimas necessárias para teste tópico são:

• Procedimentos que devem ser observados quando um dos produtos for atualizado.
• Configuração necessária que deve ser realizada em arquivos de configuração ou programas de parâmetros etc.
• Arquivos diversos que devem ser mantidos em determinados locais para o funcionamento da integração, exemplo: xml, xsd.
• Atualizações necessárias em banco de dados ou instruções para que elas sejam feitas.
• Processos, módulos ou programas que precisam ser instalados ou atualizados. Deve ser definida a versão mínima necessária dos programas envolvidos.
• Ferramentas, servidores ou serviços que precisam ser disponibilizados e configurados, o que pode gerar necessidade de novo hardware ou aumento de capacidade. Exemplo: serviço de WebService.
• Instruções para habilitar a comunicação da ferramenta EAI entre as partes, quais rotas devem ser definidas ou como as transações devem ser habilitadas.

Observação: evite o uso de Prints de telas, facilitando, assim, o trabalho de tradução e versionamento deste documento.

Datasul

Insira aqui as informações pertinentes a Datasul.

Logix

Insira aqui as informações pertinentes ao Logix.

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.

Programas rest chamados para realizar as rotinas das funções do APP

laborreport.p

logerror.p

mobile.p

order.p

ordercreate.p

profile.p

requestmaterial.p

servicerequest.p

taskdocument.p

validacontador.p

Parâmetros que as rotinas rest recebem

Todos os programas rest recebem como parâmetros JSON, e tem que ser chamados via Basic Authentication informando Usuário e Senha.

Criação de OM

Chamada rest
http:// servidor : porta /api/mip/v1/ordercreate

metodo:Post
paramametros obrigatorios

cdEquipe: "015" codigo da equipe
cdManut: "insp"  codigo da manutenção
codEqpto: "040" codigo equipamento
dataCriacao: "2020-09-03T19:28:11.524Z"
descricao: "teste"
dtManut: "2020-09-03T16:27:41-03:00"
modulo: 1 modulo = 1 Manutenção industrial.

Criação de SS

http:// servidor : porta /api/mip/v1/servicerequest

metodo:Post
paramametros obrigatorios

codEqpto: "040" Equipamento e descricao
descricao: "Jeffe"


Busca Perfil e Menu

Metodo get sem paramametros
http:// servidor : porta/mip/v1/profile/profile

depois a gente melhora mais 

pq tem que ser chamado no modelo de api novo do frame

ai tem uma doc deles pra isso

ai os cara que vão ler

nao vou detalhar algo que ja tem

Exemplo de chamado do rest profile.p

"ttPermissaoAcesso": {

                "ttPermissaoAcesso": [

                               {

                                               "permitePlayStop": true

                               }

                ]

},

Exemplo de chamado Criação da OM

"cdEquipe": "015",

"cdManut": "nsp",

"codEqpto": "040",

"dataCriacao": "2020-09-04T13:30:00.000Z",

"descricao": "Teste",

"dtManut": "2020-09-04T13:30:00.000Z",

"modulo": 1

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