Histórico da Página
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|
(Obrigatório)
Informações Gerais
Especificação | |||
Produto | TOTVS Framework | Módulo | Integrações |
Projeto | Desenvolvimento EAI | IRM | |
Requisito/Story/Issue | DEAI1-879 | Subtarefa | DEAI1-1280 |
País | ( X ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colombia ( ) Outro _____________. | ||
Outros |
Objetivo
Implementação do adapter de integração via Mensagem Única TOTVS do cadastro de Empresas, viabilizando assim o CRUD completo do cadastro por envio de mensagem de integração.
Regras de Negócio
Considera-se como escopo deste requisito a implementação do adapter de envio de Mensagens Únicas TOTVS para integração do cadastro de Local de Estoque de Empresas (WarehouseCompany), estando o adapter de recebimento desta mesma mensagem fora do escopo do requisito.
A análise e o desenvolvimento do adapter será efetuado considerando a integração com o PDV ProtheusTOTVS Automação Fiscal (TAF), mas também viabilizará a integração com outras fontes de dados desde que respeitado o layout da mensagem.
Rotina | Tipo de Operação | Opção de Menu |
Regras de Negócio
Locais de Estoque
Empresas | Inclusão/Alteração/Exclusão/Carga de Dados | RM \ |
-
As inclusões, alterações e exclusões de Locais de Estoque são feitos através da Linha RM, que identifica o evento em sua entidade e envia uma mensagem ao PDV Protheus. Os dados de locais de estoque que serão sincronizados pela mensagem única são :
- Pasta Identificação: Filial, Estoque, Inativo, Descrição
A integração deste cadastro é necessário, pois será utilizado como filtro na consulta de saldo de estoque.
Regras de Integridade
- O cadastro deve ser feito no BackOffice RM e sincronizado para o PROTHEUS via Integração TOTVS Mensagem Única.
- Serão enviados para o PROTHEUS somente os Locais de Estoque da Filial que está integrada.
- O campo Código do Local de Estoque no RM possui tamanho de 15 caracteres e no PROTHEUS o campo Código possui tamanho padrão de 2 caracteres extensível até 6 caracteres (até a presente data). Sendo assim será realizado o seguinte tratamento para o tamanho do campo Código:
- Se o campo Código no PROTHEUS for configurado como auto-incremento, ele irá ignorar o código enviado pelo RM, gerando na inclusão do local de estoque o código com auto-incremento.
- Se o campo Código no PROTHEUS não for configurado como auto-incremento, caso seja cadastrado um Local de Estoque com código maior do que o permitido no PROTHEUS será exibida mensagem de consistência similar a: "Tamanho do campo Código maior que o permitido: Enviado X Permitido Y."
Compartilhamento de registros por Coligada e Filial
Visto que o registo no BackOffice RM considera a Filial como parte da Chave e existe a restrição na Mensagem Única TOTVS para envio do 'CompanyInternalId' completo (Coligada + Filial), é necessário que o sistema destinatário possua este cadastro exclusivo por Coligada e exclusivo por Filial.
Em relação ao Protheus deve seguir o seguinte compartilhamento:
- Empresa: Exclusivo
- Unidade: Exclusivo.
- Filial: Exclusivo.
Serviços Globais \ Coligadas |
Fórmula Visual
Para sincronizar o cadastro será necessário importar a fórmula visual que encontra-se disponível na pasta “Fórmulas Visuais”, interna à pasta “ObjetosGerencias” no ambiente instalado do sistema (“../CorporeRM/ObjetosGerencias/Fórmulas Visuais”). Ao importar a fórmula visual deverá ser marcado para cada fórmula o parâmetro “Importar Gatilho” na rotina de Importação de Fórmula Visual.
Visando facilitar a sincronização das bases de dados RM e PDV TAF foi desenvolvida uma atividade de fórmula visual que se responsabiliza por , a partir de alguns parâmetros, obter os dados necessários e solicitar o envio da Mensagem Única TOTVS Warehouse_1.000.
Basicamente é necessário informar a esta atividade somente a lista de chaves dos registros que se deseja integrar, qual a Mensagem Única a enviar e qual o objeto de negócio (DataServer) responsável por retornar as informações do registro. A partir destas informações a atividade se responsabiliza pela leitura, transformação e envio dos dados ao sistema de destino, oferecendo como retorno o Log de integração.
Todas as mensagens trafegadas também constarão no monitor da fila de integração, para posterior conferência.
Tabelas Utilizadas
das mensagens de integração, sincronizando assim todas as Coligadas e Filiais da base de dados.
Tabelas Utilizadas
- GCOLIGADA - ColigadasTLOC- Locais de Estoque
Entidades de Integração
- DataServer envolvido
- EstLOCDataGlbColigadaDataBr
- Transformação
- Id: WarehouseCompany
- Versão: 12.000002
- Fluxo da mensagem
- Saída
- Tipo de Envio:
- Síncrono.
- Fórmula Visual
- 05_PDV_LocalDeEstoqueFórmula de Gatilho: "GLBWKF0001 - Company_Branch.TotvsWF"
- 05.Sincronização de Locais de Estoque.TotvsWF: utilizada para carga inicial
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 |
(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
[6] 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. |
---|
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico.
(Obrigatório)
Informações Gerais
Especificação
Produto
Módulo
Projeto
IRM
Requisito/Story/Issue
Subtarefa
País
( X ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador
( ) USA ( ) Colombia ( ) Outro _____________.
Outros
Objetivo
Implementação do adapter de integração via Mensagem Única TOTVS do cadastro de Empresas, viabilizando assim o CRUD completo do cadastro por envio de mensagem de integração.
Objetiv
o
Considera-se como escopo deste requisito a implementação do adapter de envio de Mensagens Únicas TOTVS para integração do cadastro de Local de Estoque (Warehouse), estando o adapter de recebimento desta mesma mensagem fora do escopo do requisito.
A análise e o desenvolvimento do adapter será efetuado considerando a integração com o PDV Protheus, mas também viabilizará a integração com outras fontes de dados desde que respeitado o layout da mensagem.
Rotina
Tipo de Operação
Opção de Menu
Regras de Negócio
Locais de Estoque
Inclusão/Alteração/Exclusão
RM \ BackOffice \ Gestão de Estoque, Compras e Faturamento \ Cadastros \ Estoque, Compras e Faturamento \ Locais de Estoque
-
As inclusões, alterações e exclusões de Locais de Estoque são feitos através da Linha RM, que identifica o evento em sua entidade e envia uma mensagem ao PDV Protheus. Os dados de locais de estoque que serão sincronizados pela mensagem única são :
- Pasta Identificação: Filial, Estoque, Inativo, Descrição
A integração deste cadastro é necessário, pois será utilizado como filtro na consulta de saldo de estoque.
Regras de Integridade
- O cadastro deve ser feito no BackOffice RM e sincronizado para o PROTHEUS via Integração TOTVS Mensagem Única.
- Serão enviados para o PROTHEUS somente os Locais de Estoque da Filial que está integrada.
- O campo Código do Local de Estoque no RM possui tamanho de 15 caracteres e no PROTHEUS o campo Código possui tamanho padrão de 2 caracteres extensível até 6 caracteres (até a presente data). Sendo assim será realizado o seguinte tratamento para o tamanho do campo Código:
- Se o campo Código no PROTHEUS for configurado como auto-incremento, ele irá ignorar o código enviado pelo RM, gerando na inclusão do local de estoque o código com auto-incremento.
- Se o campo Código no PROTHEUS não for configurado como auto-incremento, caso seja cadastrado um Local de Estoque com código maior do que o permitido no PROTHEUS será exibida mensagem de consistência similar a: "Tamanho do campo Código maior que o permitido: Enviado X Permitido Y."
Compartilhamento de registros por Coligada e Filial
Visto que o registo no BackOffice RM considera a Filial como parte da Chave e existe a restrição na Mensagem Única TOTVS para envio do 'CompanyInternalId' completo (Coligada + Filial), é necessário que o sistema destinatário possua este cadastro exclusivo por Coligada e exclusivo por Filial.
Em relação ao Protheus deve seguir o seguinte compartilhamento:
- Empresa: Exclusivo
- Unidade: Exclusivo.
- Filial: Exclusivo.
Fórmula Visual
Para sincronizar o cadastro será necessário importar a fórmula visual que encontra-se disponível na pasta “Fórmulas Visuais”, interna à pasta “ObjetosGerencias” no ambiente instalado do sistema (“../CorporeRM/ObjetosGerencias/Fórmulas Visuais”). Ao importar a fórmula visual deverá ser marcado para cada fórmula o parâmetro “Importar Gatilho” na rotina de Importação de Fórmula Visual.
Visando facilitar a sincronização das bases de dados RM e PDV foi desenvolvida uma atividade de fórmula visual que se responsabiliza por, a partir de alguns parâmetros, obter os dados necessários e solicitar o envio da Mensagem Única TOTVS Warehouse_1.000.
Basicamente é necessário informar a esta atividade somente a lista de chaves dos registros que se deseja integrar, qual a Mensagem Única a enviar e qual o objeto de negócio (DataServer) responsável por retornar as informações do registro. A partir destas informações a atividade se responsabiliza pela leitura, transformação e envio dos dados ao sistema de destino, oferecendo como retorno o Log de integração.
Todas as mensagens trafegadas também constarão no monitor da fila de integração, para posterior conferência.
Tabelas Utilizadas
- TLOC- Locais de Estoque
Entidades de Integração
- DataServer envolvido
- EstLOCData
- Transformação
- Id: Warehouse
- Versão: 1.000
- Fluxo da mensagem
- Saída
- Tipo de Envio:
- Síncrono.
- Fórmula Visual
- 05_PDV_LocalDeEstoque.TotvsWF
- 05.Sincronização de Locais de Estoque.TotvsWF: utilizada para carga inicial
- Fórmula de Sincronização: "GLBWKF0002 - Sincronização_Company_Branch.TotvsWF"
Mapeamento dos campos
- Mensagem Company 2.002
Mensagem Padrão | Descrição | RM | |||
---|---|---|---|---|---|
Tabela | Campo | Observação | |||
Code | Código da Empresa | GColigada | CODCOLIGADA | ||
InternalId | InternalId da Empresa | GColigada | CODCOLIGADA | ||
CorporateName | Razão social | GColigada | NOME | ||
FancyName | Nome Fantasia | GColigada | NOMEFANTASIA | ||
ShortName | Nome Curto | GColigada | NOMEFANTASIA | ||
GovernmentalInformation | Id [Name='CNPJ' ] | CNPJ da Empresa | GColigada | CGC | Este campo terá sua mascara removida, assim trafegando somente os números. |
Id [Name='Inscricao Estadual' ] | Inscricao Estadual | GColigada | INSCRICAOESTADUAL | Este campo terá sua mascara removida, assim trafegando somente os números. | |
Address | Address | Rua | GColigada | RUA | |
Number | Número | GColigada | NUMERO | ||
Complement | Complemento | GColigada | COMPLEMENTO | ||
District | Bairro | GColigada | BAIRRO | ||
City / CityDescription | Nome da Cidade | GColigada | CIDADE | ||
State / StateCode | Código do Estado | GColigada | ESTADO | ||
State / StateDescription | Nome do Estado | GColigada | ESTADO | ||
Country | Código do País | GColigada | PAIS | ||
CommunicationInformation | PhoneNumber | Telefone | GColigada | TELEFONE | |
FaxNumber | Fax | GColigada | FAX | ||
GColigada | |||||
Layout | Layout do código da Filial | Fixo valor 'FFFF" | |||
BranchLength | Tamanho do layout de Filial | Fixo valor 4 |
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 |
(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. |
---|