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)

  :

  Logix	A integração não está disponível para esta marca.
  Logix	A integração não está disponível para esta marca.
  Microsiga Protheus	Módulos de Compras, Estoque/Custos e Faturamento nos processos de Recebimento de Materiais, Movimentações Internas de Materiais, Inventário e Saída de Materiais.
  RM	A integração não está disponível para esta marca.

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 a Datasul.

Protheus

Insira aqui as informações pertinentes a Datasul.

RM

Insira aqui as informações pertinentes a Datasul.

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.

Instalação/Atualização

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 HIS e Microsiga 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

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.

únicas

Exemplos:

 

Método	ID	Descrição	Origem	Destino	XSD (versões podem variar)	Rotina Protheus
Cadastros	01	Cliente/Fornecedor	RM	Unidade de Medida	HIS	Microsiga Protheus	CustomerVendorUnitOfMeasure_12_000.xsd	QIEA030
	02Moeda	Grupos de Produtos	RMHIS	Microsiga Protheus	CurrencyFamily_12_000.xsd	MATA035
	03	Unidade Locais de MedidaEstoque	RMHIS	Microsiga Protheus	UnitOfMeasureWarehouse_1_000.xsd	AGRA045
	04	Produto	RMHIS	Microsiga Protheus	Item_?_000.xsd
	05	Centro de Custo	RM	Protheus	CostCenter_1_000.xsd
	06	Ativos	RM	Protheus	NOVA, Ativo fixo
	07	Funcionários	RM	Protheus	Employee_1_000.xsd
	08	Projeto	RM	Protheus	Project_1_000.xsd
	09	Obra	RM	Protheus	SubProject_1_000.xsd
	10	Tarefa	RM	Protheus	TaskProject_1_000.xsd
	11	Meio de Pagamento	RM	Protheus	?????.xsd
12	Condições de pagamento	RM	Protheus	PaymentCondition_1_000.xsd
13	Coligada* * implementado, mas o Protheus não vai enviar, estamos avaliando alternativa para preencher o de/para	RM	Protheus	Company_1_000.xsd
14	Filial* * implementado, mas o Protheus não vai enviar, estamos avaliando alternativa para preencher o de/para	RM	Protheus	Branch_2_000.xsd
Processos	15	Solicitações (compras/armazém)	Protheus	RM	Request_1_000.xsd
	16	Cancelar movimento (solicitação, OS, etc)	Protheus	RM	CancelRequest_1_000.xsd
	17	Cancelar movimento (solicitação, OS, etc)	RM	Protheus	CancelRequest_1_000.xsd
	18	Baixa de estoque	Protheus	RM	Request_1_000.xsd
	19	Baixa de estoque	RM	Protheus	Request_1_000.xsd
	20	Consulta Saldo	Protheus	RM
	21	Apropriação de custos			Request _1_000.xsd
	22	Geração de OS
	23	Consulta de OS
	2_001	MATA010
--	Instituição credenciada	HIS	Microsiga Protheus	CustomerVendor_2_004	--
--	Convênio	HIS	Microsiga Protheus	CustomerVendor_2_004	--
--	Profissional	HIS	Microsiga Protheus	CustomerVendor_2_004	--
--	Procedimento	HIS	Microsiga Protheus	Item_2_001	--
--	Taxa	HIS	Microsiga Protheus	Item_2_001	--
--		HIS	Microsiga Protheus	CustomerVendorInformation_1_000	--
Processos	05	Carga Inicial de Saldos	HIS	Microsiga Protheus	MovementsInternal_1_000	MATA240
	06	Consumo de Pacientes	HIS	Microsiga Protheus	StockTurnover_1_003	MATA241
	07	Saída por Baixa	HIS	Microsiga Protheus	StockTurnover_1_003	MATA241
	08	Entrada por Ganho	HIS	Microsiga Protheus	StockTurnover_1_003	MATA241
	09	Devolução	HIS	Microsiga Protheus	StockTurnover_1_003	MATA241
	10	Transferência (Preparação)	HIS	Microsiga Protheus	Transferwarehouse_1_002	MATA261
	11	Entrada por Doação	Microsiga Protheus	HIS	InputDocument_2_000	MATA103
	12	Inventário	Microsiga Protheus	HIS	MovementsInternal_1_000	MATA240
	13	Saída por Doação	Microsiga Protheus	HIS	Invoice_3_001	MATA461
	14	Saída por Empréstimo	Microsiga Protheus	HIS	Invoice_3_001	MATA461
	15	Alteração de Número do Lote	Microsiga Protheus	HIS	TransferWarehouse_1_002	MATA261
	16	Entrada de NF	Microsiga Protheus	HIS	InputDocument_2_000	MATA103
	17	Alteração de Validade de Lote	Microsiga Protheus	HIS	ValidityLot_1_000	MATA390
	18	Cancelamento de Saída de NF	Microsiga Protheus	HIS	Invoice_3_001	MATA521	24	Ampliação patrimonial

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.

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.