INTEGRAÇÃO SIGAJURI FLUXO APROVAÇÕES X FLUIG

Contexto de negócio (Introdução)

O Gestão Jurídica foi desenvolvido para atender aos departamentos jurídicos de empresas e tem como principais objetivos, a administração das contingências, gestão de procurações e documentos societários, facilitar o relacionamento com escritórios parceiros e fornecer maior sinergia com as áreas Contábil e de Recursos Humanos.

Além disso proporciona ampla organização e gerenciamento de todas as informações pertinentes à área e aos negócios da empresa, elevando a capacidade do Departamento Jurídico, alinhando-o à estratégia de negócios da Companhia, tornando-o detentor das informações necessárias à tomada de decisões estratégicas, sem depender de escritórios externos.

Além de acompanhar os processos com informações sempre atualizadas,  permite total controle de valores para os serviços prestados.

Desta forma, oferece os seguintes resultados:

• Otimização da produção intelectual.

• Gestão efetiva da contingência.
• Melhoria na análise de performance dos escritórios externos.
• Facilita a troca de informações com o RH.
• Mantém informações processuais atualizadas.
• Processo eletrônico e base de conhecimento.

Sistemas Envolvidos

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

• Sistema/Módulo vertical - Qual o módulo, qual marca, suas principais características, funcionalidades, escopo do módulo, etc
• BackOffice(s) - Qual(ais) marca(s), o que o ERP engloba, quais são seus pontos fortes, funcionalidades, etc, explanações principalmente no que diz respeito às funcionalidades do ERP que serão utilizadas pela integração (mas sem citar a integração)

Integração

O que levou a criação da integração / o porquê da integração (Finalidade/Objetivo), de forma macro, o que será integrado do, por exemplo, Vertical com o ERP (BackOffice)

Explique o contexto de negócio ou do problema na qual esta integração estará inserida. Isto inclui o funcionamento da(s) ponta(s) envolvida(s).

Apresentar a integração como uma melhoria para o cenário ou como uma solução para o problema.

• Premissas
  Gerais, do Vertical, do BackOffice e dos demais artefatos/sistemas envolvidos
  Premissas Gerais
  Premissas A
  Premissas B

• Arquitetura (Tecnologia)

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

Relacione quais são os pré-requisitos (técnicos ou de negócio) para a integração. Este tópico não deve incluir informações da implantação normal do módulo, mas apenas informações específicas da integração. É como se este tópico já partisse do princípio que o módulo que será integrado já está normalmente instalado.

Entre os tópicos deste tópico podemos citar:

• Versões mínimas de produtos.
• Módulos ou programas que geram informações necessárias a integração. Muitas vezes a integração partirá de informações que somente são trabalhadas em um determinado programa ou processo, que deverá estar em uso no cliente.
• Ferramentas que são necessárias a integração, como: EAI, ESB, servidor de WebService etc.
• Aspectos legais nos quais as partes envolvidas na integração devem estar inseridas, caso as informações envolvidas sejam utilizadas para o cumprimento de alguma lei específica.
• Requisitos de hardware ou Software, como servidores, link de internet, capacidade de armazenamento e memória, sistema operacional.

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.

• FLUIG
• Microsiga Protheus®, Sigajuri – Gestão Jurídica

Integração

O objetivo da integração é permitir que atividades (Follow-up) cadastrados no SIGAJURI sejam executados e aprovados através de um fluxo de processos dentro do FLUIG. Quando a integração estiver habilitada no módulo SIGAJURI, todos os compromissos incluídos vão aparecer na central de tarefas do FLUIG na parte de tarefas a concluir. Quando a atividade é executada, o FLUIG vai validar se existe um fluxo de aprovação. Se houver um fluxo, a atividade vai ser destinada a um aprovador e caso não exista nenhum fluxo configurado, a atividade será finalizada.

• Premissas
  O FLUIG deve estar configurado preferencialmente utilizando o Identity. Caso não esteja, todos os usuários que estiverem cadastrados no FLUIG devem estar cadastrados no PROTHEUS.
  O cadastro de usuários de Protheus deve conter obrigatoriamente o e-mail de todos os usuários cadastrados, caso contrário não será possível relacionar os usuários do Protheus com o FLUIG.

Escopo

Com esta integração habilitada, todos os usuários que atuam em compromissos do SIGAJURI poderão dar baixa em seus compromissos utilizando a central de tarefas do FLUIG. Toda a movimentação fica registrada e a execução do compromisso é registrado em um andamento processual para consulta posterior.

Abaixo, o fluxo macro do fluxo de aprovações que foi criado:

Image Added

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

Para que a integração funcione corretamente devemos seguir os passos abaixo que serão detalhados posteriormente:

Requisitos de produto

• Protheus Release 12.1.7
• Deve estar habilitada a estrutura de Web Services do Protheus
• FLUIG 1.5.1 ou posterior. (Se não utilizar Identity, todos os usuários devem estar cadastrados com o mesmo e-mail do Protheus e FLUIG).
• FLUIG STUDIO para importar os fluxos desenvolvidos para dentro do FLUIG.

Instalação/Atualização

Neste tópico serão ilustrados os passos para configurar a integração no Protheus e no FLUIG.

Protheus:

• Configurar o parâmetro MV_JFLUIGA como "1".
• Configurar o parâmetro MV_JFLUIGAP com o id do workflow do fluxo de aprovações exportado para o FLUIG. O workflow foi criado com o id "SIGAJURI_AprovaFU".
• Configurar o parâmetro MV_ECMURL com o endereço do servidor FLUIG, no formato "http://fluig.totvs.com:8080/webdesk".
• Configurar o parâmetro MV_ECMUSER com o nome do usuário que tem direito de admin no FLUIG. Se o cliente utiliza o identity atentar-se que este parâmetro recebe o e-mail do usuário.
• Configurar o parâmetro MV_ECMPSW com a senha do usuário com direito de admin no servidor do FLUIG.
• Configurar o parâmetro MV_ECMEMP com o código da empresa cadastrada no FLUIG. Este número varia de acordo com a instalação e deve ser obtido com a equipe que implantou o FLUIG. Geralmente a empresa é "1".
• Validar se todos os tipos de resultado de follow-up estão cadastrados (JURA017). Na versão atual 12.1.7, a integração prevê que exista apenas um tipo de resultado de follow-up para cada tipo existente (1 - Pendente, 2 - Concluído, 3 - Cancelado e 4 - Em Aprovação).
  
  

FLUIG:

Abaixo segue passo-a-passo das informações que devem ser importadas para o FLUIG. Para mais informações técnicas sobre o FLUIG, deve ser consultado o manual no TDN (dev.fluig.com).

A TOTVS disponibiliza o projeto do FLUIG com todos os arquivos que devem ser exportados para o servidor.  Abaixo a relação dos mesmos:

• Datasets
• Formulários
• Widgets
• Processos

Alguns serviços precisam ser cadastrados também. Pode ser que algum deles já exista, neste caso, devemos apenas validar as informações:

• CardService : Este serviço é do próprio FLUIG e precisa estar cadastrado. Um endereço de exemplo: http://172.16.104.151:8080/webdesk/ECMCardService?wsdl
  
  Image Added
• SIGAJURI : Este serviço é o serviço utilizado nas integrações com o SIGAJURI. O nome do mesmo no Protheus é WSFLUIGJURIDICO. Como exemplo, http://172.16.103.171:8083/WSFLUIGJURIDICO.apw?WSDL
  
  Image Added

Quando o serviço do Protheus é criado no FLUIG, ele assume como um id interno o endereço do servidor, então para cada instalação será preciso atualizar as referências dentro dos datasets. Abaixo um exemplo:

Image Added

É preciso atualizar a referência onde está escrito "_171._103._16._172._8083"" para o endereço condizente com o ambiente Protheus do cliente.

Todos os datasets devem ser exportados para o FLUIG mantendo o nome original do projeto, como o exemplo abaixo:

Image Added

Depois de atualizar todos os datasets é preciso exportar os formulários que ficam na pasta forms. Para exportar um novo formulário, o FLUIG STUDIO irá solicitar o id da pasta que o formulário deve ficar localizado. Aconselhamos que seja criada uma pasta específica para que todos os formulários sejam armazenados. Para o correto funcionamento dos formulários, todos os usuários devem ter acesso a pasta para poderem ler/gravar/alterar as informações.

Um exemplo da pasta criada:

Image Added

Para cada formulário, executar o procedimento abaixo:

Image Added

Para exportar as Widgets, escolher cada Widget e mandar exportar para o FLUIG. Exemplo abaixo:

Image Added

Para exportar os processos, seguir o mesmo procedimento. O mais importante é sempre marcar a opção "Liberar Versão".

Image Added

O dataset dsParamsSIGAJURI deve ser atualizado com as informações do ambiente do cliente, como usuário que deve ser utilizado, o id da empresa e o id do formulário criado no FLUIG para cada Widget.

Image Added

Mesmo com as Widgets exportadas para o FLUIG, é preciso criar uma página para que os usuários tenham acesso as mesmas. Abaixo os passos para criar uma página diretamente no FLUIG:

1- Abrir Painel de Controle -> WCM -> Minhas Páginas

Image Added

2- Escolher a opção Adicionar

Image Added

3- Escolha um modelo de página e clique em Avançar.

Image Added

4- Defina um nome e a descrição para a página.

Image Added

5- Escolha os usuários que podem ter acesso e clique em Concluir.

Image Added

6- Será exibida a página em branco com os slots onde as widgets devem ser adicionadas. No canto superior de cada slot existe um botão + para adicionar as Widgets.

Image Added

7- Ao clicar no botão de adicionar, será exibida uma lista. Procurar pela categoria SIGAJURI

Image Added

8- Ao adicionar a Widget selecionada, publicar a página usando o menu do usuário no canto superior direito da tela.

Image Added

9- O FLUIG irá pedir uma descrição para a publicação da página.

Image Added

10-. Pronto, agora a página pode ser acessada através do menu lateral do FLUIG.

Image Added

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 Todas 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:

 Image Removed

Image Removed

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.

são realizadas via WEBSERVICE padrão do FLUIG e as informações armazenadas no FLUIG são informações intermediárias e servem apenas como consulta. As informações completas permanecem cadastradas no Protheus.

Fluxo das Informações

As informações são sempre cadastradas através do SIGAJURI e enviadas ao FLUIG. Para este requisito, nunca um workflow de aprovação será iniciado através do FLUIG.

Cadastros

Todas as informações enviadas ao FLUIG tem como origem as entidades (NTA - Follow-ups e NSZ - Assuntos Jurídicos) 

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

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 WMSFollow-up.
• 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. 

• FLUIG, na central de tarefas, existirá um workflow do tipo de Atividades SIGAJURI com as características do follow-up criado.

Checklist de suporte da aplicação

Instalação/Configuração

• Garantir que o web service do Protheus esteja habilitado
• Garantir que todos os parâmetros envolvidos estejam preenchidos

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:

Anexos