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 | Protheus | Módulo | SIGAPCO |
Segmento Executor |
| ||
Projeto1 |
| IRM1 |
|
Requisito1 |
| Subtarefa1 |
|
Chamado2 |
| ||
Release de Entrega Planejada |
| Réplica |
|
País | ( x ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) 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
<Nesta etapa informar o objetivo da especificação do requisito, ou seja, o que a funcionalidade deve fazer. Exemplo: Permitir que o usuário defina o percentual mínimo em espécie (dinheiro), a referência mínima para calculo dos débitos do aluno e o período de validade do parâmetro de negociação>.
(Obrigatório)Realizar a integração do Sistema Reserve, com o módulo Planejamento e Controle Orçamentário (SIGAPCO) do Sistema Protheus.
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>
A integração do Sistema Reserve com módulo SIGAPCO do Sistema Protheus, oferecerá maior controle orçamentário para a empresa, possibilitando:
- Registrar o valor movimentado nas diferentes etapas do processo de pedido de viagem (solicitação, aprovação, emissão e cancelamento) e atualizar os saldos orçamentários conforme regra de negócio (ex: saldo previsto, saldo realizado, etc.);
- Bloquear processos no Reserve (ex. inclusão de pedido de viagem) de acordo com o regra de bloqueio, definida no SIGAPCO;
Serão inclusos pontos de lançamento orçamentário para contemplar as etapa do processo de viagem, possibilitando o ajuste de saldos orçamentários.
Serão inclusos pontos de bloqueio orçamentário para contemplar as etapas do processo de viagem, possibilitando o bloqueio orçamentário.
Será disponibilizado um ponto de entrada para permitir que o cliente realize o controle orçamentário de forma própria. Ao utiliza-lo, ficará a cargo do cliente:
- Inclusão do lançamento (AKD);
- Atualização do saldo dos cubos;
- Bloqueio orçamentário;
- Estorno de saldos orçamentários (provenientes de cancelamentos no Reserve).
Será utilizada uma nova tabela para registro das notificações de status dos pedidos de viagem vindos do Reserve, permitindo a elaboração da regra de lançamento no SIGAPCO, rastreabilidade dos dados e estorno dos saldos.
Considerações:
- A inclusão manual de pedido de viagem originado do Protheus não será contemplada.
- O processo de contingência do PCO não será disponibilizado, por não haver interação com interface gráfica.
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
PCOXRES | Criação | Não se aplica | Rotina responsável pelo processamento dos dados enviados pelo ReserveGET e geração dos lançamentos no SIGAPCO |
PCOXLOAD | Alteração | Não se aplica | Rotina responsável pela carga dos pontos de lançamento e bloqueio padrões do SIGAPCO |
Detalhamento Técnico
Rotinas impactadas
Fonte | PCOXLOAD | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Função | PcoChkAK8 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Status | Alteração | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Ação | Adequação da rotina para realizar a carga dos novos pontos de lançamento e bloqueio | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Detalhe da ação | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
A rotina de carga de pontos de lançamentos e bloqueios, deve ser ajustada para contemplar o processo de pedido de viagem. Abaixo seguem a relação de dados para inserção: 1. Processos de Sistema – AK8 (arrayaProcess)
2. Pontos de Lançamentos – AKB (ArrayaItens)
3. Pontos de Bloqueio – AKA (ArrayaBlq)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Fonte | [WEBSERVICE] |
Status | Criação |
Ação | Disponibilização de WebService para consumo do aplicativo ReserveGet |
Detalhe da ação | |
A comunicação entre o aplicativo ReserveGET e o Protheus, ocorrerá por meio de WebService. O Protheus disponibilizará o WebService para receber dados conforme a documentação ReserveGet - V1.2_20151105 tópico Layout dos XMLs de Request e Response.
O Reserve notificará o acontecimento de cada etapa do pedido de viagem, enviando os dados necessário e possibilitando ao Protheus, computar os dados no módulo SIGAPCO e interagir no processo, realizando ou não o bloqueio orçamentário.
| |
|
Fonte | PCOXRES | ||||||||||||||||||||||||||||||||||||||
Status | Criação | ||||||||||||||||||||||||||||||||||||||
Ação | Chamada da rotina: Reserve via WebService | ||||||||||||||||||||||||||||||||||||||
Detalhe da ação | |||||||||||||||||||||||||||||||||||||||
Em cada chamada do ReserveGet ao Protheus, será enviado os dados pertinentes a viagem e o ID do processo em questão. Esta rotina, executará as seguintes etapas:
1. Instanciação do ambiente de acordo com a empresa e filial envolvidas: Abertura de ambiente, conforme o dado obtido na tag <Empresa>.
2. Leitura dos dados da viagem enviados pelo Reserve: Serão carregados em memória os campos da tabela FO5 com os seguintes dados:
Essa carga tem como intuito disponibilizar dados para definição da regra de lançamento, regra de bloqueio ou ponto de entrada.
3. Processamentos dos dados no SIGAPCO: Neste momento, deverá ser diponibilizado um ponto de entrada, para que o cliente possa efetuar seu próprio controle no SIGAPCO, ficando a cargo dele a geração de lançamento (AKD), atualização de saldo orçamentário, bloqueio orçamentário e estorno. Desta forma, abaixo segue a orientação para cada um dos casos:
Em cada chamada que o ReserveGET realizar ao Protheus, deverá ser analisado qual é o valor da tag <ID Processo> e executar o ponto de lançamento correspondente. Abaixo segue a tabela com os relacionamentos:
Exemplo de tratamento para integração com o PCO:
//----------------------------------------------------------------------- // Inserido no inicio do processo de leitura dos dados //----------------------------------------------------------------------- PcoIniLan("000401") . . . //---------------------------------------------------------------------------------------------------------------------- // Inserido após a leitura e antes de gravar, para possibilitar o bloqueio do processo. O // código Item do Processo é de acordo com o ID da operação enviada pelo ReserveGet //---------------------------------------------------------------------------------------------------------------------- PcoDetLan(cCodProc,cCodItem,"PCOXRES") . . . //-------------------------------------------------- //Inserido após a gravação dos dados //-------------------------------------------------- PcoFinLan("000401")
Será executado o ponto de entrada para que o cliente realize o processo conforme regra própria. Ao utiliza-lo, ficará a cargo do cliente:
4. Gravação dos dados Os dados do pedido que até então estão em memória, são gravados na tabela FO5. Essa ação possibilita ao SIGAPCO o rastreio da origem dos dados e controle de estorno de saldo.
5. Resposta para o ReserveGET Na etapa final do processo, será retornado para o sistema ReserveGet se o SIGAPCO permite a continuidade do processo ou bloqueia. Essa definição é obtida na etapa 3 - Processamentos dos dados no SIGAPCO, na execução da regra de bloqueio.
| |||||||||||||||||||||||||||||||||||||||
|
Tabelas Utilizadas
- AK8 – Processos de Sistema
- AKA – Pontos de Bloqueio
- AKB – Pontos de Lançamentos
- FO5 – Pedido de Viagem
- 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
ReserveGETx SIGAPCO - Protheus
Descrição dos Sub-Processos
1. Processo Reserve
Na interação com o pedido no Reserve, o sistema ReserveGET consome o WebService disponibilizado pelo Protheus enviando os dados conforme documentação ReserveGet - V1.2_20151105tópico Layout dos XMLs de Request e Response.
<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>.
2. Leitura dos Dados
No recebimento dos dados, o Protheus obtém os seguintes dados para o processo orçamentário:
- Empresa: Utilizado para inicialização do ambinte no SIGAPCO.
- Filial: Utilizado para inicialização do ambinte no SIGAPCO.
- ID Reserve: Utilizado para armazenamento na tabela FO5, permitindo a rastreabilidade do movimento no SIGAPCO.
- Data: Utilizado para armazenamento na tabela FO5, permitindo a rastreabilidade do movimento no SIGAPCO.
- Centro de Custo: Utilizado para regra de lançamento e regra de bloqueio do SIGAPCO.
- Valor: Utilizado para a regra de lançamento e regra de bloqueio do SIGAPCO.
- Tipo de Viagem: Utilizado para a regra de lançamento e regra de bloqueio do SIGAPCO.
3. Lançamento Configurado
Conforme o ID do processo que está ocorrendo no Reserve, o Protheus verificará se o ponto de lançamento está configurado para execução.
4. Bloqueio Configurado
Conforme o ID do processo que está ocorrendo no Reserve, o Protheus verificará se o ponto de bloqueio está configurado para execução.
5. Bloqueia Processo
Avaliação de saldo para permitir ou não a continuidade do processo no Reserve.
6. Processa Lançamento
Lançamento orçamentário e atualização do saldo do cubo.
7. Bloqueia
Inclusão na mensagem de resposta que o processo foi bloqueado pelo SIGAPCO – Protheus.
8. Aprova
Inclusão na mensagem de resposta que o processo foi aprovado pelo SIGAPCO – Protheus.
9. Resposta do Processamento
Envio da resposta do processo recebido por meio do WebService.
10. Processa a Resposta
Processamento da resposta pelo ReserveGET
11. Processo Aprovado
Avaliaçao do status do retorno da mensagem enviada.
12. Continua Processo
Pedido de viagem prossegue no fluxo do processo.
13. Bloqueia Processo
Pedido de viagem não prossegue no fluxo do processo.
Opcional
Dicionário de Dados
Arquivo ou Código do Script: AAA – Negociação Financeira / *Versao=CP.2014.12_03*/FO5 – Pedido de Viagem
Í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 |
FO5_ |
FILIAL |
Tipo |
Caracter |
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
8 | |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Filial |
Descrição | Filial do Sistema |
Obrigatório | Não |
Usado | Não |
Browse | Não |
Grupo de Campo | 033 |
Help | Filial do Sistema |
Campo | FO5_CODIGO |
Tipo | Caracter |
Tamanho | 12 |
Decimal | 0 |
Contexto | Real |
Propriedade | Visual |
Título | Cod. Reg. |
Descrição | Código do Registro |
Obrigatório | Sim |
Usado | Sim |
Help | Código interno para controle da inclusão dos dados, evitando a possibilidade de chave duplicada. |
Campo | FO5_IDRES |
Tipo | Caracter |
Tamanho | 8 |
Decimal | 0 |
Contexto | Real |
Propriedade | Visual |
Título | ID Reserve |
Descrição | ID do Pedido Reserve |
Obrigatório | Sim |
Usado | Sim |
Help | ID do pedido gerado pelo sistema Reserve. |
Campo | FO5_DATA |
Tipo | Data |
Tamanho | 8 |
Decimal | 0 |
Contexto | Real |
Propriedade | Visual |
Título | Data Proc. |
Descrição | Data do Processo |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Data do processo ocorrido no reserve (ex: inclusão, autorização, emissão, cancelamento, etc.). |
Campo | FO5_CCUSTO |
Tipo | Caracter |
Tamanho | 9 |
Decimal | 0 |
Contexto | Real |
Propriedade | Visual |
Título | Centro Custo |
Descrição | Centro de Custo |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Grupo de Campos | 004 |
Help | Centro de custo relaciona ao pedido de viagem do Reserve. |
Campo | FO5_VALOR |
Tipo | Numérico |
Tamanho | 16 |
Decimal | 2 |
Contexto | Real |
Propriedade | Visual |
Título | Valor |
Descrição | Valor do Pedido |
Obrigatório | Sim |
Usado | Sim |
Browse | Não |
Help | Valor do pedido de viagem. |
Campo | FO5_TPVIAG |
Tipo | Caracter |
Tamanho | 1 |
Decimal | 0 |
Contexto | Real |
Propriedade | Visual |
Título | TipoViagem |
Descrição | Tipo de Viagem |
Obrigatório | Não |
Usado | Sim |
ListaOpções | 1=Aéreo;2=Hotel;3=Carro;4=Seguro Viagem;5=Rodoviário;6=CAV |
Browse | Não |
Help | Indica o tipo de serviço do pedido de viagem. |
Campo | FO5_STATUS |
Tipo | Caracter |
Tamanho | 1 |
Decimal | 0 |
Contexto | Real |
Propriedade | Visual |
Título | Status Ped. |
Descrição | Status do Pedido |
Obrigatório | Sim |
Usado | Sim |
ListaOpções | 1=Pré-Notificacao;2=Pós-Notificação;3=Pré-Autorização;4=Pós-Autorização; 5=Pós-AutorizacaoAnulada;6=Pós-Emissão;7=Pós-Cancelamento;8=Pré-Emissão |
Browse | Não |
Help | Indica o status do pedido no momento da integração com o Protheus. |
(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. |
---|