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 12 | Módulo | Folha de Pagamento | ||||||
Segmento Executor | manufaturaManufatura | ||||||||
Projeto1 | D_MAN_TSA001 | IRM1 | PCREQ-363 | ||||||
Requisito1 | PCREQ-4846 | Subtarefa1 | PDRMAN-4281 | ||||||
Chamado2 |
| Release de Entrega Planejada | 12.1.7 | Réplica | Não se Aplica|||||
País | ( X X) Brasil ( X ) Argentina ( X ) Mexico ( X ) Chile ( X ) Paraguai ( X ) Equador ( X ) USA ( X ) Colombia ( ) Outro _____________. | ||||||||
Outros | <Caso necessário informe outras referências que sejam pertinentes a esta especificação. Exemplo: links de outros documentos ou subtarefas relacionadas>. |
Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos).
(Obrigatório)
Objetivo
1)- Permitir a realização da carga de informações somente do que não existe no TSA ainda
- .
- Possibilitar que o usuário realize integração de uma seleção de determinada informação sem a necessidade de acessar o cadastro.
- Integrar a informações somente quando alterar um campo que impacta no TSA (informações de cadastro
- )
- .
(Obrigatório)
Definição da Regra de Negócio
<Regra de negócio é o que define a forma de fazer o negócio, o processo definido e/ou as regras que devem ser contempladas. Devem ser descritas restrições, validações, condições e exceções do processo. Caso necessário, incluir neste capítulo também regras de integridade que devem ser observadas no momento do desenvolvimento>.
<Na tabela abaixo informe quais são as rotinas envolvidas, o tipo de operação, a opção de menu e se necessário uma breve descrição das regras de negócio relacionadas a rotina>.
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] | - |
Exemplo de Aplicação:
- Criar o campo “% Mínimo Espécie” (AAA_PERESP) onde o usuário informará o % que o aluno pagará em dinheiro. Esse % poderá ser alterado durante a negociação.
- Criar o campo “Referência Mínima para Cálculo” (AAA_REFCAL) onde o usuário informará um dos 4 valores disponíveis para pagamento das mensalidades como a referência mínima para calcular o débito total do aluno.
- Criar o parâmetro MV_ACPARNE que definirá se as informações de “% Mínimo Espécie” e “Referência Mínima para Cálculo” serão obrigatórias.
- O parâmetro MV_ACPARNE deve ter as seguintes opções: 1=Obrigatório e 2=Opcional. Deve ser inicializado como opcional>.
Tabelas Utilizadas
- SE2 – Cadastro de Contas a Pagar
- FI9 – Controle de Emissão de DARF>.
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>.
FP8875:
No programa de carga, abaixo do browse de destino da informação incluir um novo browse que irá conter a lista de chaves da informação as colunas início e fim da informação que virão com “” e “zzz...” e “0” “999...” como default para as informações, conforme demonstrado na tela abaixo. Quando o usuário selecionando o registro no browse de destino, o browse do filtro deverá ser atualizado com as chaves da informação. Ao voltar a informação para o browse de origem limpa a informação do filtro. Quando a informação for do tipo inteiro somente permitir incluir números.
No botão “Filtro” incluir:
- O campo “Realiza Consutla ” para permitir que o usuário marque caso deseje realizar uma consulta no TSA da informação que está sendo integrada para verificar se a mesma já existe no TSA. Como Default o campo vem marcado.
- O campo “Gera XML Consulta” para possibilitar gerar os arquivos XML de envio e retorno para o TSA. Este campo somente será habilitado caso o campo Consulta TSA for marcado.
- O Campo "Considera Somente Funcionário Desligado" para possibilitar gerar a integração de funcionários demitidos. Este campo vem desmarcado como Default.
FP8875rp (Emissão do Relatório):
- Quando o campo "Realiza Consulta" (botão Filtro) estiver marcado, a cada lista de informação gerada para a carga o sistema deverá realizar chamar o Webservice de consulta da informação no TSA.
- Criar uma include fp8875rp.i que conterá o código que irá realizar a consulta, e irá retornar uma temp-table com os erros que ocorreram, os xml de envio e de retorno e uma temp-table com as chaves tsa que já encontra-se no TSA, sendo que estas chaves precisam ser eliminadas da temp-table de carga assim como precisam ser diminuídas do contador de informações.
- Caso a temp-table de erro tenha conteúdo deverá ser demonstrado na colune Status Consulta, conforme demonstrado abaixo. Caso não tenha ocorrido erro o status deverá ser demonstrado como Realizada com sucesso. Ajustar a data e a hora do relatório para que a coluna possa ser demonstrada. retirar a coluna chave tsa.
FPAPI538:
pi-consulta-tsa:
- Contruir nova procedure interna (pi-consulta-tsa) que irá conter os comandos para montagem do xml e a chamada para a procedure interna da integração da consulta. Esta procedure receberá como parâmetro a temp-table consulta que conterá a tabela do tipo de informação que está sendo feita a consulta e como retorno deverá receber o xml que foi gerado, o xml de retorno e uma temp-table de erro (tt-erro-tsa).
- Necessário criar um de-para entre informação do HCM com a tabela do TSA (varinc/var10507.i).
- Exemplo do XML:
<externalKeysInserted>
<table>USER</table>
<externalKey>1;1;1</externalKey>
<externalKey>1;1;2</externalKey>
<externalKey>1;1;3</externalKey>
</externalKeysInserted>
pi-integr-consulta:
- Construir uma procedure interna (pi-integr-consulta) que irá executar a operação de envio do XML de consulta para o TSA estrutura do XML. Deverá receber como parâmetros o tipo de informação, o xml gerado, o nome da operação que será executada para integração. Deverá retornar o xml de retorno do TSA e a temp-table de erro (tt-erro-tsa).
- Chamar a procedure interna (pi-conecta-webservice) para Verificar se a conexão com o TSA está ok, caso não esteja deverá atualizar a temp-table de erro. Nome do serviço é synchronization.
- Deverá executar a operação no serviço enviando o xml gerado e recebendo um xml de retorno. Nome da operação é externalKeysInserted
- Deverá executar uma procedure interna que será responsável pelo processamento do xml de retorno (pi-retorno-consulta).
pi-retorno-consulta:
- Construir uma procedure interna (pi-retorno-consulta) que irá processar o xml de retorno e irá retornar uma temp-table com os erros encontrados e outra temp-table com as chaves que encontra-se no TSA.
- Utilizar as procedures internas do programa xmlutp/ut-genxml.p para maninupar o xml.
- Procurar pela tag statusCode, poderão retornar quatro códigos:
- 01401 - indica que existem pelo menos uma chave tsa que existe no TSA Caso ocorra esse retorno deverão ser lidas todas as tags <externalKey> e gravadas na temp-table de retorno para eliminar as informações da carga.
- 01402 - a tabela informada não existe no TSA. Caso ocorre esse retorno deverá ser atualizada a tabela de erro com o statuscode, buscar a tag <statusDescription> e atualizar no campo mensagem da temp-table de erro.
- 01403 - nenhuma chave foi encontrada no TSA. Neste caso não deverá atualizar a temp-table de erro. Somente indica que todos os registros deverão ser enviados para o TSA. Então deverá aparecer que a consulta foi realizada com sucesso.
- 00101 - algum erro técnico ocorrido. Caso ocorre esse retorno deverá ser atualizada a tabela de erro com o statuscode, buscar a tag <statusDescription> e atualizar no campo mensagem da temp-table de erro.
Incluir na Include FP8875.i
Caso o campo "Gera XML Consulta" esteja marcado então gerará no diretório temporário definido para o usuário, um arquivo xml para cada consulta realizada no TSA com a seguinte nomenclatura: a letra “C” de consulta mais “-“ mais o número de sequência do movimento, se tiver (caso não tenha deve ser 00000000000000). Mais “–“, mais o tipo de informação, mais “-“, mais uma sequência numérica consulta. Exemplo de nome: “C-12345678901234-Funcionario-1.xml”. Também gerará um arquivo com o retorno do TSA com a seguinte nomenclatura: a letra “R” de retorno mais “-“ mais o número de sequência do movimento, se tiver (caso não tenha deve ser 00000000000000). Mais “–“, mais o tipo de informação, mais “-“, mais uma sequência numérica consulta. Exemplo de nome: “R-12345678901234-Funcionario-1.xml”.
Gatilhos das informações de cadastro:
Alterar o gatilho do cadastro para enviar somente quando ocorrer alteração nos campos que impactam no TSA conforme quadro abaixo:
Programa | Colunas que impactam no TSA |
FP0560 | Inclusão de Registro, Alteração da Pessoa Jurídica |
FP0660 | Inclusão de Registro, Alteração do campo Descrição |
FP0720 | Inclusão do Registro, Alteração da Descrição |
FP1420 | Inclusão do Registro, Alteração de CNPJ, CEI, Nome, País, UF, Cidade, Bairro, Endereço, Número, CEP, Fone Contato |
FP1440 | Inclusão do Registro, Alteração de Nome, Endereço, Número, cidade, e-mail, CPF, RG, Data Emissão RG, Orgão RG, UF RG, Bairro, Telefone, Telefone Contato, UF, Cep |
FP0840 | Pessoa Física, Tipo De Prestador, Data de Validade, PIS |
FP0060 | Inclusão do Registro, Alteração da Descrição e do Tipo da Situação |
FP1930 | Inclusão do Registro, Descrição Localidade |
FP1930B | Inclusão do Registro, Descrição Feriado e Repica Feriado |
FP1200C | Inclusão do Feriado, Alteração Descrição do Feriado |
Funcionário: Quando for alteração do cadastro de funcionário não enviar as informações de histórico.
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
[FP8870 – Monitor TSA] | [Alteração] | [Tarefas] | - |
[FP8875 – Carga TSA] | [Alteração] | [Tarefas] | - |
[FP8876 - Integrador TSA] | [Alteração] | [Tarefas] | - |
[FP8878 - Eliminação Movimentos TSA] | [Alteração] | [Tarefas] | - |
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. |
---|