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 | Serviços | ||
Projeto1 | M_SER_CTR011 | IRM1 | PCREQ-9167 |
Requisito1 | PCREQ-9170 | Subtarefa1 | PDR_SER_CTR011-195 |
Chamado2 | Não se aplica | ||
Release de Entrega Planejada |
| Réplica | Não se aplica |
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>.
Realizar a integração do Sistema Reserve, com o módulo Planejamento e Controle Orçamentário (SIGAPCO) do Sistema Protheus.
(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>.
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 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 (notificaçã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 determinados processos no Reserve (ex. aprovaçã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 passiveis de bloqueio.
Será disponibilizado um ponto de entrada (DT_WSRGProc_Tratamento_Integração_Reserve) 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);
- Retorno indicando se o processo deve ou não ser continuado 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 |
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 |
WSResGET | Criação | Não se aplica | Serviço webservice para interface entre o ReserveGet e o Protheus. |
Link do Documento de Integração: DI_Integracao_SIGAPCO_X_Reserve
Detalhamento Técnico
Informações | ||
---|---|---|
| ||
Nas configurações do job do Web Service, presente no arquivo appserver.ini, a propriedade ONCONNECT deve receber o valor PCOReserve, conforme exemplo abaixo: [JOB_WEBSERVICE] ENVIROMENT=XXXXX ONSTART=__WSSTART ONCONNECT=PCOReserve Essa alteração possibilita o envio do arquivo XML no formato esperado pelo aplicativo ReserveGet. |
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 | WSResGet |
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.1_20160404 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.
Estrutura WebService ReserveGet: Uma premissa para o desenvolvimento do requisito é a configuração do servidor HTTP no Protheus.
Modelo de Requisição que será enviado pelo sistema Reserve ao Web Service Protheus:
<processarPedidosRQ> <Acao>PedidoNotificado</Acao> <Pedido> <Empresa>99999</Empresa> <IDPedido>999999</IDPedido> <IDPedidoOriginal xsi:nil="true" /> <IDGrupo>999999</IDGrupo> <IDRemarcacao xsi:nil="true" /> <Tipo>1</Tipo> <DataCriacao>2015-12-18T15:50:09.373</DataCriacao> <Status>2</Status> <OrigemPedido>0</OrigemPedido> <DataExclusao xsi:nil="true" /> <Excluido>false</Excluido> <Solicitante> <ID>383237</ID> <Matricula /> <Nome>Dayane Maria Coelho Correia</Nome> <Email>[email protected]</Email> </Solicitante> <Responsavel> <ID>0</ID> <Nome>Tatiane Andrade</Nome> <Email>[email protected]</Email> </Responsavel> <TotalFee>0.0000</TotalFee> <FormaPgto>2</FormaPgto> <EmpresaAFaturar>99999</EmpresaAFaturar> <Emissor /> <DataEmissao>0001-01-01T00:00:00</DataEmissao> <DataAutorizacao>2015-12-18T15:51:12.5633768-02:00</DataAutorizacao> <StatusAutorizacao>0</StatusAutorizacao> <Autorizador> <ID>0</ID> </Autorizador> <CCusto>53000009703</CCusto> <Motivo>Eventos/Convencoes</Motivo> <Projeto>4130405</Projeto> <Atividade>KL-2015/2</Atividade> <CampoExtra1>115001</CampoExtra1> <CampoExtra2>KL13</CampoExtra2> <DataMigracao xsi:nil="true" /> <Passageiros> <Passageiro> <ID>381003</ID> <Matricula /> <Nome>Mario Jungbeck</Nome> <Email>[email protected]</Email> <Autorizado>0</Autorizado> <Bilhete /> </Passageiro> </Passageiros> <ReservaEscolhida> <SisRes>G3</SisRes> <Localizador>YEZK5S</Localizador> <OrigemReserva>1</OrigemReserva> <DataReserva>2015-12-18T15:50:09.577</DataReserva> <TarifaPorPax>281.8800</TarifaPorPax> <TaxaPorPax>19.3500</TaxaPorPax> <TaxaServico>0.0000</TaxaServico> <TarifaAcordo>281.8800</TarifaAcordo> <TarifaPromocional>370.9000</TarifaPromocional> <Cambio>1</Cambio> <Moeda>R$</Moeda> <MoedaTaxa>R$</MoedaTaxa> <Multa>0.0000</Multa> <Total>301.2300</Total> <ItensReserva> <ItemReserva> <Internacional xsi:nil="true" /> <PassagemAereo> <Voo>1141</Voo> <CodCia>G3</CodCia> <NomeCia>Gol</NomeCia> <CodOrigem>LDB</CodOrigem> <Origem>Londrina</Origem> <CodDestino>CGH</CodDestino> <Destino>São Paulo, Congonhas</Destino> <Saida>2016-01-12T05:25:00</Saida> <Chegada>2016-01-12T06:30:00</Chegada> <Classe>U</Classe> <ClasseDescricao>Econômica</ClasseDescricao> <BaseTarifaria>UO0D1GO</BaseTarifaria> <Status>HK</Status> <Conexao>false</Conexao> <Internacional>false</Internacional> <Trajeto>0</Trajeto> </PassagemAereo> </ItemReserva> </ItensReserva> <PrazoEmissao>2015-12-21T15:50:16</PrazoEmissao> <Politicas> <MenorTarifa>0</MenorTarifa> <AntecedenciaMinima>1</AntecedenciaMinima> <CiaPreferencial>0</CiaPreferencial> <SelecionarCia>0</SelecionarCia> </Politicas> <Justificativas /> </ReservaEscolhida> <IDLicenciado>99</IDLicenciado> <Licenciado>CopasturBR</Licenciado> </Pedido> </processarPedidosRQ>
Modelo de Resposta que será enviado pelo Web Service Protheus ao sistema Reserve:
<ProcessarPedidosRSxmlns:xsi=http://www.w3.org/2001/XMLSchema-instance xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Erro xmlns="http://www.reserve.com.br/ReserveGET"> <CodErro /> <Mensagem /> </Erro> <PedidoRS xmlns="http://www.reserve.com.br/ReserveGET"> <Acao>SalvarCodAutorizacao</Acao> <IDPedido>9999999</IDPedido> <Valor>011827/</Valor> <Mensagem>PC: 061311</Mensagem> </PedidoRS> </ProcessarPedidosRS>
Estrutura na qual deverá ser montada o Web Service Protheus (Request):
Nome do Serviço: ReserveGet Nome do Método do Web Service: ReserveGet
<ProcessarPedidos>-Estrutura Principal <ProcessarPedidosRQ>-Estrutura do Request <Acao>-String-</Acao> <Pedido>-Estrutura de Pedidos <Empresa>-String-Obrigatório-</Empresa> <IDPedido>-Inteiro-</IDPedido> <IDGrupo>-Inteiro-</IDGrupo> <IDRemarcação>-Inteiro-</IDRemarcação> <Tipo>-Inteiro-</Tipo> <DataCriacao>-DateTime-</DataCriacao> <Status>-Inteiro-</Status> <OrigemPedido>-Inteiro-</OrigemPedido> <DataExclusao>-DateTime-</DataExclusao> <Excluido>-Booleano (True ou False)-</Excluido> <Solicitante>-Estrutura de Solicitante - Obrigatório <ID>- Inteiro - </ID> <CPF>- String - </CPF> <RG>- String - </RG> <Matricula> - String - </Matricula> <Nome>- String - </Nome> <Email>- String - </Email> </Solicitante> <Responsavel>- Estrutura de Responsavel <ID>- Inteiro - </ID> <CPF>- String - </CPF> <RG>- String - </RG> <Matricula> - String - </Matricula> <Nome>- String - </Nome> <Email>- String - </Email> </Responsavel> <TotalFee>- Decimal - Obrigatório. </TotalFee> <FormaPgto>- Inteiro - </FormaPgto> <EmpresaAFaturar>- String - </EmpresaAFaturar> <Emissor> - Estrutura de Emissor <Emissor>- String - </Emissor> <EmissorEmail> - String - </EmissorEmail> </Emissor> <DataEmissao>- DateTime - </DataEmissao> <DataAutorizacao>- DateTime - </DataAutorizacao> <StatusAutorizacao>- Inteiro - </StatusAutorizacao> <Autorizador>- Estrutura de Autorizador <ID>- Inteiro - </ID> <CPF>- String - </CPF> <RG>- String - </RG> <Matricula>- String - </Matricula> <Nome>- String - </Nome> <Email>- String - </Email> </Autorizador> <CodAutorizacao>- String - </CodAutorizacao> <CCusto>- String - Obrigatório. - </CCusto> <CodigoCCustoCliente>- String - Obrigatório. - </CodigoCCustoCliente> <Motivo>- String - </Motivo> <Projeto>- String - </Projeto> <CodigoProjetoCliente>- String - </CodigoProjetoCliente> <Atividade>- String - </Atividade> <CampoExtra1>- String - </CampoExtra1> <CampoExtra2>- String - </CampoExtra2> <CampoExtra3>- String - </CampoExtra3> <DataMigracao>- DateTime - </DataMigracao> <Passageiros> - Array de Estrutura de Passageiros (1-N) <ID>- Inteiro -</ID> <Nome>- String -</Nome> <Email>- String -</Email> <Matricula>- String -</Matricula> <Autorizado>- Inteiro - </Autorizado> <Bilhete>- String - </Bilhete> </Passageiros> <ReservaEscolhida> - Estrutura de Reservas Escolhidas <SisRes>-String- </SisRes> <Localizador>- String- </Localizador> <OrigemReserva>- Inteiro- </OrigemReserva> <DataReserva>- DateTime - </DataReserva> <TarifaPorPax>- Decimal- </TarifaPorPax> <TaxaPorPax>- Decimal- </TaxaPorPax> <TaxaServico>- Decimal- </TaxaServico> <TarifaAcordo>- Decimal- </TarifaAcordo> <TarifaPromocional>- Decimal - </TarifaPromocional> <Cambio>- Decimal-</Cambio> <Moeda>-Decimal-</Moeda> <MoedaTaxa>-Decimal-</MoedaTaxa> <Multa>- Decimal-</Multa> <Total>-Decimal-</Total> <ItensReserva>- Array de Item Reserva (1-N) <ItemReserva>-Estrutura de Item Reserva <Internacional>-Booleano-</Internacional> <Acomodacao>-Estrutura de Acomodacao <IDHotel>-Inteiro-</IDHotel> <NomeHotel>-String-</NomeHotel> <CNPJHotel>-String-</CNPJHotel> <CodCidade>-String-</CodCidade> <Cidade>-String-</Cidade> <CheckIn>-String-</CheckIn> <CheckOut>-String-</CheckOut> <Categoria>-String-</Categoria> <CategoriaDescricao>-String-</CategoriaDescricao> <Diarias>-Inteiro-</Diarias> </Acomodacao> <Seguro>-Estrutura de Seguro <IDSeguradora>-Inteiro-</IDSeguradora> <NomeSeguradora>-String-</NomeSeguradora> <CodCidade>-String-</CodCidade> <Cidade>-String-</Cidade> <InicioValidade>-String-</InicioValidade> <FimValidade>-String-</FimValidade> <Plano>-String-</Plano> <PlanoDescricao>-String-</PlanoDescricao> <Diarias>-Inteiro-</Diarias> </Seguro> <LocacaoCarro>-Estrutura de LocacaoCarro <IDLocadora>-String-</IDLocadora> <NomeLocadora>-String-</NomeLocadora> <CodCidadeRetirada>-String-</CodCidadeRetirada> <CidadeRetirada>-String-</CidadeRetirada> <CodCidadeDevolucao>-String-</CodCidadeDevolucao> <CidadeDevolucao>-String-</CidadeDevolucao> <DataRetirada>-DateTime-</DataRetirada> <DataDevolucao>-DateTime-</DataDevolucao> <TipoVeiculo>-String-</TipoVeiculo> <LocalRetirada>-String-</LocalRetirada> <LocalDevolucao>-String-</LocalDevolucao> <Diarias>-Inteiro-</Diarias> </LocacaoCarro> <PassagemRodoviario>-Estrutura de PassagemRodoviario <Voo>-String-</Voo> <CodCia>-String-</CodCia> <NomeCia>-String-</NomeCia> <CodOrigem>-String-</CodOrigem> <Origem>-String-</Origem> <CodDestino>-String-</CodDestino> <Destino>-String-</Destino> <Saida>-DateTime-</Saida> <Chegada>-DateTime-</Chegada> <Classe>-String-</Classe> <ClasseDescricao>-String-</ClasseDescricao> <BaseTarifaria>-String-</BaseTarifaria> <Status>-String-</Status> </PassagemRodoviario> <PassagemAereo>-Estrutura de PassagemAereo <Voo>-String-</Voo> <CodCia>-String-</CodCia> <NomeCia>-String-</NomeCia> <CodOrigem>-String-</CodOrigem> <Origem>-String-</Origem> <CodDestino>-String-</CodDestino> <Destino>-String-</Destino> <Saida>-DateTime-</Saida> <Chegada>-DateTime-</Chegada> <Classe>-String-</Classe> <ClasseDescricao>-String-</ClasseDescricao> <BaseTarifaria>-String-</BaseTarifaria> <Status>-String-</Status> </PassagemAereo> <PrazoEmissao>-DateTime-</PrazoEmissao> <Politicas>-Estrutura de Politicas <MenorTarifa>-Inteiro-</MenorTarifa> <AntecedenciaMinima>-Inteiro-</AntecedenciaMinima> <CiaPreferencial>-Inteiro-</CiaPreferencial> <SelecionarCia>-Inteiro-</SelecionarCia> </Politicas> </ItemReserva> </ItensReserva> </ReservaEscolhida> </Pedido> </ProcessarPedidosRQ> </ProcessarPedidos>
Estrutura na qual deverá ser montada o Web Service Protheus (Response):
<ProcessarPedidosRS> <Erro>-Estrutura de Erro <CodErro>-String-<CodErro/> <Mensagem>-String-<Mensagem/> </Erro> <PedidoRS>-Estrutura de PedidoRS <Acao>-String-</Acao> <IDPedido>-Inteiro-</IDPedido> <Valor>-String-</Valor> <Mensagem>-String-</Mensagem> </PedidoRS> </ProcessarPedidosRS>
Obs.: Este WebService deverá ser configurado em seu .ini para uma única empresa. O Protheus ao receber a requisição deverá buscar o código na tabela FL2 ( De/Para de Empresas Reserve ) e realizar o PREPARE ENVIRONMENT adequado. Caso a empresa configurada no INI seja a mesma da tabela FL2, o sistema não irá realizar o PREPARE ENVIRONMENT, otimizando os recursos.
| |
|
Fonte | PCOXRES | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Status | Criação | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Ação | Processamento dos dados enviados pelo Reserve no SIGAPCO | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Detalhe da ação | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Em cada chamada do ReserveGet ao Protheus, serão enviados os dados pertinentes a viagem e o ID do processo em questão. Esta rotina processará os dados no SIGAPCO, executando as seguintes etapas:
1. Leitura dos dados da viagem enviados pelo Reserve: Serão carregados em memória os campos da tabela FO6 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.
2. Processamentos dos dados no SIGAPCO: Neste momento, deverá ser disponibilizado um ponto de entrada (DT_WSRGProc_Tratamento_Integração_Reserve), 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:
Para a verificação de bloqueio e geração de lançamentos, utilizar as funções padrões do SIGAPCO (PcoVldLan, PcoIniLan, PcoDetLan e PcoFinLan)
Será executado o ponto de entrada WSRGProc (DT_WSRGProc_Tratamento_Integração_Reserve) para que o cliente realize o processo conforme regra própria. Ao utiliza-lo, ficará a cargo do cliente:
3. Gravação dos dados Os dados do pedido que até então estão em memória, são gravados na tabela FO6. Essa ação possibilita ao SIGAPCO o rastreio da origem dos dados e controle de estorno de saldo.
4. 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 2 - 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
- FO6 – Pedido Reserve x PCO
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.1_20160404 tópico Layout dos XMLs de Request e Response.
2. Leitura dos Dados
O Protheus carrega os dados enviados pelo ReserveGet.
3. Ponto de Entrada Configurado
O ponto de entrada WSRSProc (DT_WSRGProc_Tratamento_Integração_Reserve) permite ao cliente o processamento dos dados conforme regra própria.
4. Processamento Customizado
Na execução do ponto de entrada WSRSProc (DT_WSRGProc_Tratamento_Integração_Reserve) 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);
- Retorno para indicar se o processo deve ou não ser continuado no Reserve.
Caso o cliente utilize o ponto de entrada , o processo continuará na etapa 11 - Resposta do Processamento
5. 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.
6. 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.
7. Bloqueia Processo
Avaliação de saldo para permitir ou não a continuidade do processo no Reserve.
8. Processa Lançamento
Lançamento orçamentário e atualização do saldo do cubo.
9. Bloqueia
Inclusão na mensagem de resposta que o processo foi bloqueado pelo SIGAPCO – Protheus.
10. Aprova
Inclusão na mensagem de resposta que o processo foi aprovado pelo SIGAPCO – Protheus.
11. Resposta do Processamento
Envio da resposta do processo recebido por meio do WebService.
12. Processa a Resposta
Processamento da resposta pelo ReserveGET
13. Processo Aprovado
Avaliaçao do status do retorno da mensagem enviada.
14. Continua Processo
Pedido de viagem prossegue no fluxo do processo.
15. Bloqueia Processo
Pedido de viagem não prossegue no fluxo do processo.
Dicionário de Dados
Arquivo ou Código do Script: FO6 – Pedido Reserve x PCO
Índice | Chave |
01 | FO6_FILIAL+FO6_CODIGO |
02 | FO6_FILIAL+FO6_IDRESE |
Campo | FO6_FILIAL |
Tipo | Caracter |
Tamanho | 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 | FO6_CODIGO |
Tipo | Caractere |
Tamanho | 12 |
Decimal | 0 |
Contexto | Real |
Propriedade | Visual |
Título | Cod. Reg. |
Descrição | Código do Registro |
Obrigatório | Sim |
Usado | Sim |
Browse | Sim |
Help | Código interno para controle da inclusão dos dados, evitando a possibilidade de chave duplicada. |
Campo | FO6_IDRESE |
Tipo | Caractere |
Tamanho | 10 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | ID Reserve |
Descrição | ID do site Reserve |
Obrigatório | Não |
Usado | Sim |
Browse | Sim |
Help | Código do pedido gerado pelo sistema Reserve. |
Campo | FO6_ACAO |
Tipo | Caractere |
Tamanho | 1 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Ação Ped. |
Descrição | Ação do Pedido |
Obrigatório | Não |
Usado | Sim |
Lista Opções | 1=Pré-Notif;2=Pós-Notif;3=Pré-Autorização;4=Pós-Autoriz;5=Pré-Emissão;6=Pós-Emissão;7=Pós-Cancelamento |
Browse | Não |
Help | Indica a ação que está ocorrendo no pedido de viagem no momento da integração com o Protheus. |
Campo | FO6_TIPO |
Tipo | Caractere |
Tamanho | 1 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Tipo Reserva |
Descrição | Tipo da Reserva |
Obrigatório | Não |
Usado | Sim |
Validação | Pertence('123456') |
ListaOpções | 1=Aéreo;2=Hotel;3=Carro;4=Seguro;5=Rodoviário;6=Outros |
Browse | Não |
Help | Indica o tipo de serviço do pedido de viagem. |
Campo | FO6_CC |
Tipo | Caractere |
Tamanho | 9 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Centro Custo |
Descrição | Centro de Custo |
Picture | @! |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Grupo de Campos | 004 |
Help | Centro de custo responsável da viagem. |
Campo | FO6_TOTAL |
Tipo | Numérico |
Tamanho | 15 |
Decimal | 2 |
Contexto | Real |
Propriedade | Alterar |
Título | Total |
Descrição | Valor total da reserva |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Valor total da reserva. |
Campo | FO6_TOTFEE |
Tipo | Numérico |
Tamanho | 15 |
Decimal | 2 |
Contexto | Real |
Propriedade | Alterar |
Título | Total Fee |
Descrição | Valor total Fee |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Valor total de Transaction Fee do pedido de viagem. |
Campo | FO6_MOTIVO |
Tipo | Caractere |
Tamanho | 25 |
Decimal | 0 |
Contexto | Real |
Propriedade | Visual |
Título | Motivo |
Descrição | Motivo da Viagem |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Motivo da viagem. |
Campo | FO6_CLIENT |
Tipo | Caractere |
Tamanho | 6 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Cliente |
Descrição | Código do cliente destino |
Picture | @! |
Validação | ExistCpo("SA1") |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Grupo de Campos | 001 |
Help | Código do cliente que será atendido durante a viagem. |
Campo | FO6_LOJA |
Tipo | Caractere |
Tamanho | 2 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Loja |
Descrição | Loja do Cliente |
Picture | @! |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Grupo de Campos | 002 |
Help | Loja do cliente que será atendido durante a viagem. |
Campo | FO6_ATIVI |
Tipo | Caractere |
Tamanho | 40 |
Decimal | 0 |
Contexto | Real |
Propriedade | Visual |
Título | Atividade |
Descrição | Atividade |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Código da atividade relacionada a viagem. |
Campo | FO6_EXTRA1 |
Tipo | Caractere |
Tamanho | 25 |
Decimal | 0 |
Contexto | Real |
Propriedade | Visual |
Título | Adiantamento |
Descrição | Adiantamento |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Campo extra 1 do Reserve. |
Campo | FO6_EXTRA2 |
Tipo | Caractere |
Tamanho | 25 |
Decimal | 0 |
Contexto | Real |
Propriedade | Visual |
Título | Cpo Extra2 |
Descrição | Campo Extra 2 |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Campo extra 2 do reserve. |
Campo | FO6_EXTRA3 |
Tipo | Caractere |
Tamanho | 40 |
Decimal | 0 |
Contexto | Real |
Propriedade | Visual |
Título | Cpo Extra3 |
Descrição | Campo Extra 3 |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Campo extra 3 do Reserve. |
Campo | FO6_DTCRIA |
Tipo | Data |
Tamanho | 8 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Data Criação |
Descrição | Data de Criação |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Data de criação do pedido de viagem. |
Campo | FO6_DTCANC |
Tipo | Data |
Tamanho | 8 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Data Canc. |
Descrição | Data de canc. do pedido |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Data de cancelamento do pedido de viagem. |
Campo | FO6_DTEMIS |
Tipo | Data |
Tamanho | 8 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Data Emissão |
Descrição | Data Emissão da Reserva |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Data de emissão do pedido de viagem. |
Campo | FO6_DTAUTO |
Tipo | Data |
Tamanho | 8 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Data de Aut. |
Descrição | Data de aut. do ped. |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Data de autorização do pedido de viagem. |
Campo | FO6_DTMIGR |
Tipo | Data |
Tamanho | 8 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Dt. Migração |
Descrição | Data de migração do ped. |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Data de migração do pedido de viagem. |
Campo | FO6_DTRESE |
Tipo | Data |
Tamanho | 8 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Data Reserva |
Descrição | Data da Reserva |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Data de criação da reserva |
Campo | FO6_DTCIAC |
Tipo | Data |
Tamanho | 8 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Checkin Acom |
Descrição | Data checkin acomodação |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Data de checkin - Acomodação. |
Campo | FO6_DTCOAC |
Tipo | Data |
Tamanho | 8 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Checkout Ac. |
Descrição | Data checkout acomodação |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Data de checkout - Acomodação. |
Campo | FO6_DTIVSE |
Tipo | Data |
Tamanho | 8 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Data Ini Seg |
Descrição | Data inicial do seguro |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Data de início da viagem/validade do seguro. |
Campo | FO6_DTFVSE |
Tipo | Data |
Tamanho | 8 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Data Fim Seg |
Descrição | Data final do seguro |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Data de fim da viagem/validade do seguro. |
Campo | FO6_DTRELC |
Tipo | Data |
Tamanho | 8 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Dt Ret Veic |
Descrição | Data de ret. do veiculo |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Data de retirada do veículo - Locação Carro. |
Campo | FO6_DTDELC |
Tipo | Data |
Tamanho | 8 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Dt Dev Veic |
Descrição | Data de dev. do veiculo |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Data de devolução do veículo - Locação Carro. |
Campo | FO6_DTSAPR |
Tipo | Data |
Tamanho | 8 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Dt Saída Rod |
Descrição | Data de saída rodoviário |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Data de saída da viagem - Passagem Rodoviária. |
Campo | FO6_DTCHPR |
Tipo | Data |
Tamanho | 8 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Dt Cheg Rod |
Descrição | Dt de chegada rodoviário |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Data de chegada da viagem - Passagem Rodoviária. |
Campo | FO6_DTSAPA |
Tipo | Data |
Tamanho | 8 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Dt Saída Voo |
Descrição | Data de saída do voo |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Data de saída do voo - Passagem Aérea. |
Campo | FO6_DTCHPA |
Tipo | Data |
Tamanho | 8 |
Decimal | 0 |
Contexto | Real |
Propriedade | Alterar |
Título | Dt Cheg Voo |
Descrição | Data de chegada do voo |
Obrigatório | Não |
Usado | Sim |
Browse | Não |
Help | Data de chegada do voo - Passagem Aérea. |
Casos de Uso
UC – 001 - Geração de movimento (AKD) e atualização de saldo
Objetivo: Gerar lançamento na tabela AKD e atualizar o saldo orçamentário
Pré-condição:
- Cadastro de Centro de Custo integrado ao Reserve;
- Cadastro de Participantes integrado ao Reserve;
- Cadastro de Clientes integrado ao Reserve;
- MV_PCOINT = 1;
- Cadastro de Tipos de Saldo;
- Cadastro de Conta Orçamentária;
- Cadastro de Classe Orçamentária;
- Configuração do Lançamento;
- Configuração do Lançamento de Bloqueio;
- Cadastro de Cubo Orçamentário;
- Cadastro de Planilha Orçamentária.
Inicializador:
- Site Reserve
Fluxo Básico de Eventos:
1.0 Acessar o Site Reserve;
1.1 Preencher os dados de um novo pedido de viagem;
1.2 Confirme a inclusão;
1.3 Sistema deverá se comunicar com o Protheus, realizando o processo do SIGAPCO;
2.0 Verifique se o lançamento foi gerado e se o saldo orçamentário foi atualizado.
Fim do caso de uso
UC – 002 - Bloqueio Orçamentário.
Objetivo: Validar se o pedido de viagem é bloqueado na ativação do Bloqueio Orçamentário.
Pré-condição:
- Cadastro de Centro de Custo integrado ao Reserve;
- Cadastro de Participantes integrado ao Reserve;
- Cadastro de Clientes integrado ao Reserve;
- MV_PCOINT = 1;
- Cadastro de Tipos de Saldo;
- Cadastro de Conta Orçamentária;
- Cadastro de Classe Orçamentária;
- Configuração do Lançamento;
- Configuração do Lançamento de Bloqueio;
- Cadastro de Cubo Orçamentário;
- Cadastro de Planilha Orçamentária.
Inicializador:
- Site Reserve
Fluxo Básico de Eventos:
1.0 Acessar o Site Reserve;
1.1 Preencher os dados de um novo pedido de viagem, informando um valor que ultrapasse o valor Orçado para o periodo;
1.2 Confirme a inclusão;
1.3 Sistema deverá se comunicar com o Protheus, realizando o processo de bloqueio orçamentário;
1.4 O Sistema Reserve deverá bloquear o Pedido de Venda.
2.0 Verifique se o Pedido de viagem foi bloqueado.
Fim do caso de uso
UC – 003 - Estorno de Saldo.
Objetivo: Validar se no cancelamento do pedido de viagem é estornado o saldo no SIGAPCO.
Pré-condição:
- Cadastro de Centro de Custo integrado ao Reserve;
- Cadastro de Participantes integrado ao Reserve;
- Cadastro de Clientes integrado ao Reserve;
- MV_PCOINT = 1;
- Cadastro de Tipos de Saldo;
- Cadastro de Conta Orçamentária;
- Cadastro de Classe Orçamentária;
- Configuração do Lançamento;
- Configuração do Lançamento de Bloqueio;
- Cadastro de Cubo Orçamentário;
- Cadastro de Planilha Orçamentária.
Inicializador:
- Site Reserve
Fluxo Básico de Eventos:
1.0 Acessar o Site Reserve;
1.1 Cancelar um pedido de viagem;
1.2 Confirme o processo;
1.3 Sistema deverá se comunicar com o Protheus, que realizará o estorno no saldo;
1.4 O Sistema Reserve cancelará o pedido de viagem.
2.0 Verifique se o saldo no SIGAPCO foi estornado.
Fim do caso de uso
UC – 004 - Ponto de Entrada.
Objetivo: Validar se o ponto de entrada é executado permitindo a execução do processo especifico do cliente de lançamento e atualização de saldo.
Pré-condição:
- Cadastro de Centro de Custo integrado ao Reserve;
- Cadastro de Participantes integrado ao Reserve;
- Cadastro de Clientes integrado ao Reserve;
- MV_PCOINT = 1;
- Cadastro de Tipos de Saldo;
- Cadastro de Conta Orçamentária;
- Cadastro de Classe Orçamentária;
- Configuração do Lançamento;
- Configuração do Lançamento de Bloqueio;
- Cadastro de Cubo Orçamentário;
- Cadastro de Planilha Orçamentária;
- Configuração do ponto de entrada.
Inicializador:
- Site Reserve
Fluxo Básico de Eventos:
1.0 Acessar o Site Reserve;
1.1 Preencher os dados de um novo pedido de viagem;
1.2 Confirme a inclusão;
1.3 Sistema deverá se comunicar com o Protheus, executando o ponto de entrada ao invés de executar o ponto de lançamento;
1.4 O Sistema Reserve receberá o retorno do processamento do Ponto de Entrada.
2.0 Verifique se a regra definida no ponto de entrada foi executado.
Fim do caso de uso
(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. |
---|