Histórico da Página
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|
Informações Gerais
Especificação | |||
Produto | TOTVS Obras e Projetos | Módulo | Integração TOP x Protheus |
Segmento Executor | Construção e Projetos | ||
Projeto1 | CPTOP001 | IRM1 | CPTOP001-11 |
Requisito1 | CPTOP001-12 | Subtarefa1 | CPTOP001-231 |
Chamado2 |
País | (X) Brasil ( ) Argentina ( ) |
México ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) |
Colômbia ( ) Outro _____________. | ||
Outros |
Não de aplica |
Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos).
Objetivo
Especificar as demandas relacionadas a implantação da integração do TOTVS Obras e Projetos com o back-office PROTHEUS em cliente piloto.
Definição da Regra de Negócio
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
[ACAA040 – Parâmetros]
[Alteração]
[Atualizações -> Acadêmico-> Tesouraria]
-
[ACAA050 – Negociação Financeira]
[Envolvida]
[Atualizações -> Acadêmico-> Tesouraria]
-
[ACAA060 – Cadastro de Pedidos]
[Criação]
[Atualizações -> Acadêmico-> Cadastros]
-
Configurador da Integração | Alteração | Integração -> Ferramentas-> Configurar | Configurador da Integração TOP X PROTHEUS |
Conversor | Alteração | Integração -> Ferramentas-> Conversão -> Converter Integração | Conversor de Integração TOP x PROTHEUS |
Projetos - Sincronismo | Alteração | Construção e Projetos -> Visão de Projetos-> Processos -> Sincronizar Projeto PROTHEUS | Projetos |
Contratos | Alteração | Construção e Projetos -> Projeto -> Controle -> Básico -> Contrato -> Contratos | Contratos |
Pedidos | Alteração | Construção e Projetos -> Projeto -> Planejamento-> Básico ->Geração de Pedidos | Pedidos |
PROTHEUS - Produtos | Envolvida | SIGAEST -> Atualizações -> Cadastros -> Produto | PROTHEUS para RM |
PROTHEUS - Cliente | Envolvida | SIGAFAT -> Atualizações -> Cadastros -> Cliente | PROTHEUS para RM |
PROTHEUS - Fornecedores | Envolvida | SIGAFIN -> Atualizações -> Cadastros -> Fornecedor | PROTHEUS para RM |
PROTHEUS - Nota Fiscal | Envolvida | SIGACOM -> Atualizações -> Movimentos -> Documento de Entrada | PROTHEUS para RM |
Importação PINI | Alteração | Construção e Projetos -> Projeto -> Utilitários-> Conversão -> Integrar com Base PINI | Integrar com Base PINI |
- Configurador da Integração TOP X PROTHEUS
Parâmetro VERSAOPROTHEUS
Criar o parâmetro VERSAOPROTHEUS na tabela HCPARAMETROS. Com este parâmetro contendo o valor 11 (referente ao PROTHUES PROTHEUS 11), ao rodar o configurador algumas mensagens serão mapeadas com a versão diferente da atual. As mensagens e versões mapeadas para compatibilizar com o PROTHEUS 11 são:
Descrição | Entidade | Versão |
Baixa na NF | INVOICE | 3.001 |
Pedido de Compra | ORDER | 3.002 |
Solicitação | REQUEST | 1.008 |
Inclusão do Parâmetro: Para Para integrar com o PROTHEUS 11 deve ser executa o comando SQL abaixo na base de dados:
INSERT INTO HCPARAMETROS (CODCOLIGADA, NOMECOLUNA, VALORSTR) VALUES (0,'VERSAOPROTHEUS','11');
Tipo de Movimento Contratos
Criar um Criar um comando SQL no configurador para alterar os tipos de movimentos dos contratos. Todos os contratos da base de dados têm os valores defaults para geração de movimentos para suprimentos/faturamento alterados para:
Tipo | Movimento | Movimento Retenção |
Pagar | 1.1.04 | 1.2.02 |
Receber | 2.1.01 | 2.2.03 |
Mensagens Comuns com o TIN
Ao rodar o configurador do TOP, o sistema deve verificar se existe a mensagem mapeada na integração do TIN. Caso exista, não será mapeada na integração do TOP. As mensagens em comuns são:
Descrição | Entidade |
Centro de Custo | COSTCENTER |
Cliente/Fornecedor | CUSTOMERVENDOR |
Natureza Financeira | FINANCIALNATURE |
Pedido de Compra | ORDER |
Permissão de Usuários a Movimentos
Criar um procedimento que dá permissão para usuários nos tipos de movimentos. Este procedimento deve ser executado no processo de configuração.
Criar uma trigger TRIGGER que ficará na tabela de cadastro de usuários. Será executada a cada inclusão de usuários e dará permissão para o usuário cadastrado em todos os tipos de movimentos. Esta permissão ocorrerá somente se a integração TOP x PROTHEUS estiver ativa.
Parâmetros por Coligada
Unificar o processo de parametrização por coligada entre as integrações do TOP e do TIN. Ao rodar o configurador os parâmetros por coligada serão os mesmos utilizados nas integrações.
2.
.
Envio de Obras, Etapas e Tarefas
Criar o parâmetro PRJ_EXPORTAVALORTRF na integração TOP x PROTHEUS que determinará se os valores referentes a Obra, Etapa e Tarefas, serão enviados ao PROTHEUS.
O parâmetro deve ser desabilitado na inicialização fazendo com que o sistema não envie os valores. Veja o Protótipo 02 e 04.
Este parâmetro deverá ser tratado de forma que contemple todos os pontos de envio dos registros da planilha de atividades.
- Conversor de Integração TOP x Protheus
Marcar / Desmarcar Entidades
Criar menu POPUP para marcar/desmarcar todas as entidades. Veja o Protótipo 01.
Parâmetro Tamanho do Código da Unidade de Medida
Criar o parâmetro TAMCODUNDPROTHUES para identificar o tamanho da unidade de medida no PROTHEUS. O tamanho default caso não exista o parâmetro é 2(dois). No RM o tamanho é até 5 e no PROTHEUS poderá ser alterado o tamanho do campo na tabela.
Não há necessidade de utilização deste parâmetro quando não existir unidades com o tamanho do código maior que 2 no cadastro do RM.
Inclusão do Parâmetro: O comando SQL para ajustar o tamanho do código é:
INSERT INTO HCPARAMETROS (CODCOLIGADA, IDINTEGRACAO, PACOTEPADRAO, NOMECOLUNA, VALORINTTIPOCOLUNA, VALOR) VALUES (0, 1002, 0,'TAMCODUNDPROTHUES','Integer', XXX). Onde ; Onde XXX é o tamanho para tratamento do código da unidade de medida.
Uma vez inserido o parâmetro o mesmo ficará disponível no anexo de parâmetros do cadastro da integração.
Conversão de Obras, Etapas e Tarefas
Devem ser enviados para pesquisa somente registro que forem do tipo planilha de atividades e cenário principal. Validar os projetos que são passíveis de envio, projetos em andamento, paralisados, revisados e cancelados não serão enviados.
Para evitar que ocorra um processamento sem controle para o envio de Obra, Etapa e Tarefa, o sistema deverá verificar em cada um dos processamentos se existe um de-para para a empresa e projeto. Caso exista o sistema não deverá enviar a pesquisa para o PROTHEUS. Caso o usuário necessite reprocessar um projeto, será necessário primeiro a exclusão dos de-paras via comando SQL.
Log de Conversão
Ajuste no registro de log do conversor para não exibir erro de duplicidade da chave primária.
Ajuste no conversor de produtos para utilizar no “corpo” da mensagem uma coligada e filial válida.
Ajuste no conversor para processar todos os locais de estoque, exceto 9999999 inserido pelo configurador da integração por mensagem única TOP x PROTHEUS.
3.- Projetos
Sincronizar Projeto PROTHEUS
Para projetos já sincronizados o sistema passa a verificar se a data de alteração esta superior a data de atualização do “DE-PARA”, se sim, a alteração é enviada ao PROTHEUS.
Quando for sincronizado um item da planilha de atividade que não contenha o nome e descrição será enviado como descrição “XXXX sem nome no TOP”, onde XXXX pode ser Obra, Etapa ou Tarefa.
Realizar ajustes nas consultas SQL do processo de sincronismo melhorando a performance.
Parâmetro TROCAFILIALPROTHEUSMU
Criar o parâmetro TROCAFILIALPROTHEUSMU. Este parâmetro foi criado com a finalidade de no caso de algum cliente tiver a tabela de projetos, obras, etapas e tarefas compartilhadas como exclusivo por filial e não for possível alterar, deverá habilitar este parâmetro. Para isto deve estar com o valor 1(UM). Com este parâmetro ativo, ocorrendo uma troca de filial no projeto, o sistema fará a exclusão do projeto e tarefas na filial antiga e inclusão na nova filial. Por isto o ideal é não utilizar o compartilhamento "exclusivo" de projetos e tarefas por filial.
Inclusão do Parâmetro: O comando SQL incluir o parâmetro é:
INSERT INTO HCPARAMETROS (CODCOLIGADA, NOMECOLUNA, VALORINT) VALUES (0, 'TROCAFILIALPROTHEUSMU', 1);
4. Contratos
Integrar com base PINI
Ao realizar a importação de insumos que não possuem o código na PINI, o sistema não deverá gravar o insumo para o projeto e adicionar o motivo da não gravação no LOG.
A mensagem padrão para o LOG seguirá o seguinte exemplo: "Insumo [Escavadeira hidráulica sobre esteiras 162 HP 121 kW, capacidade 1,3 m³] com unidade [UN] não possui código na PINI."
- Contratos
Gerar Integração com Suprimentos / Faturamento
Atualizar o campo identificador de integração dos movimentos gerados será atualizado com o “DE-PARA” retornado pelo PROTHEUS.
Retirar o envio de projeto e tarefa para retenções de contratos a receber de serviços.
Alterar o configurador para adicionar um valor default para os parâmetros discriminar retenção e enviar retenção como desconto. Os comandos adicionados no configurador são:
UPDATE MPARAMETRO SET VALORINT = 0 WHERE CODCOLIGADA = 1 AND IDPRJ = 9 AND PARAMETRO = 'DISCRIMINARVALORETENCAODEDUCAO'
UPDATE MPARAMETRO SET VALORINT = 1 WHERE CODCOLIGADA = 1 AND IDPRJ = 9 AND PARAMETRO = 'ENVIARRETENCAODESCONTO'
Nos casos em que a data de vencimento calculada for inferior a data de hoje, o sistema passa a assumir a data corrente do servidor.
No envio de retenção o sistema passa a não enviar para o PROTHEUS, rateios que ficarem com valor zerado no título de provisão da retenção.
Parâmetro de Projeto Permite Alterar Filial
Criar o parâmetro “Parâmetro de Projeto Permite Alterar Filial” e se marcado, será possível alterar a filial e local de estoque default no contrato e no momento de gerar a integração com suprimentos / faturamento.
Contratos de Insumo
Ajuste na pesquisa da associação de objetos no contrato para considerar o número do aditivo ao validar o parâmetro de projeto que permite associar acima de 100%.
5.- Pedidos
Geração de Pedidos
Atualizar o campo identificador de integração dos movimentos gerados será atualizado com o “DE-PARA” retornado pelo PROTHEUS.
Parâmetro
MAXITEMGERPEDPROTHEUSMAXITEMGERPEDPROTHEUS
Criar o parâmetro MAXITEMGERPEDPROTHEUS. Este parâmetro tem por finalidade ajustar o tamanho da mensagem quando o ambiente do PROTHEUS não suportar o trafego de mensagem muito extensas (tamanho em bytes) por possuírem muitos itens.
Determina a quantidade máxima de itens que serão processados para gerar o pedido / solicitação. Será considerado se maior que 0(zero).
Inclusão do Parâmetro: O comando SQL de inclusão do parâmetro é:
INSERT INTO HCPARAMETROS (CODCOLIGADA, IDINTEGRACAO, PACOTEPADRAO, NOMECOLUNA, TIPOCOLUNA, VALORINTVALOR) VALUES (0, 1002, 0,'MAXITEMGERPEDPROTHEUS','Integer', XXX). XXX ; XXX é a quantidade de itens a enviar por mensagem.
Uma vez inserido o parâmetro o mesmo ficará disponível no anexo de parâmetros do cadastro da integração.
Geração de Pedidos Extras
Quando integrado com o PROTHEUS, o sistema não permitirá o envio itens relacionados a obras e etapas. Sendo enviado somente tarefas de último nível.
A consistência é será realizada no momento que o usuário clicar em gravar/salvar o item. Veja o Protótipo 03.
Quanto integrado com o PROTHEUS o parâmetro "Exibe obras e etapas para pedido extra" localizado nos parâmetros de
projetos em "Integração | Suprimentos / Faturamento | Geral" deverá ser desmarcado e desabilitado.
Atualizar o campo identificador de integração dos movimentos gerados será atualizado com o “DE-PARA” retornado pelo PROTHEUS.
6. Cadastros Básicos da Integração
- PROTHEUS para o RM
Produto
Ajustar o SOURCECODE código fonte da mensagem ITEM da integração TOP x PROTHEUS para verificar se existe o DE-PARA de filial e caso não exista apresentar uma mensagem intuitiva ao usuário.
Cliente e Fornecedores
Ajuste para truncar o número do endereço do cliente e fornecedor compatibilizando com o tamanho 8 do RM.
7. Nota fiscal
Nota Fiscal - Documento de Entrada no PROTHEUS
Ajustado a forma de identificar a coligada do produto no recebimento da nota fiscal no RM.
8.
Protheus Para RM
Atualização de Saldos
Ajuste para não considerar projeto 0(zero) se integrado por mensagem única e seja tipo de movimento (4.1.04) de atualização de custos.
Tabelas Utilizadas
- Não se aplica
Opcional
Protótipo de Tela
<Caso necessário inclua protótipos de telas com o objetivo de facilitar o entendimento do requisito, apresentar conceitos e funcionalidades do software>.
Protótipo 01
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 |
A atualização de custos ocorre em vários processos de movimentação de estoque do PROTHEUS. Um exemplo é uma nota fiscal relacionado a um pedido de material onde o tipo de entrada e saída (TES) movimenta o estoque. Neste caso irá enviar do custo no momento de registro da nota de entrada.
Tabelas Utilizadas
- Não se aplica
Protótipo de Tela
Protótipo 01 - Conversor de Integração - Step de Escolha de Entidades
Protótipo 02 - Parâmetros da Integração TOP x PROTHEUS
Protótipo 03 - Item do Pedido Extra
Protótipo 04 - XML envio Obra
(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
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|