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

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). 

Objetivo

 

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

 

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

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) 

AK8_CODIGO

000401

AK8_DESCRI

Pedido de Viagem

AK8_FUNCAO

PCOXRES

 

2. Pontos de Lançamentos – AKB (ArrayaItens)

AKB_PROCESS

000401

AKB_ITEM

01

AKB_DESCRI

Pedido de Viagem - Após a inclusão do ped. e antes do autorizador ser notificado

AKB_ENTIDA

FO5

AKB_INDICE

1

 

AKB_PROCESS

000401

AKB_ITEM

02

AKB_DESCRI

Pedido de Viagem - Após o autorizador ser notificado da inclusão do pedido.

AKB_ENTIDA

FO5

AKB_INDICE

1

 

AKB_PROCESS

000401

AKB_ITEM

03

AKB_DESCRI

Pedido de Viagem - Durante o processo de autorização do pedido.

AKB_ENTIDA

FO5

AKB_INDICE

1

 

AKB_PROCESS

000401

AKB_ITEM

04

AKB_DESCRI

Pedido de Viagem - Após a autorização do pedido.

AKB_ENTIDA

FO5

AKB_INDICE

1

 

AKB_PROCESS

000401

AKB_ITEM

05

AKB_DESCRI

Pedido de Viagem - Após a anulação de todos os passageiros.

AKB_ENTIDA

FO5

AKB_INDICE

1

 

AKB_PROCESS

000401

AKB_ITEM

06

AKB_DESCRI

Pedido de Viagem - Após a emissão do pedido.

AKB_ENTIDA

FO5

AKB_INDICE

1

 

AKB_PROCESS

000401

AKB_ITEM

07

AKB_DESCRI

Pedido de Viagem - Após o cancelamento do pedido.

AKB_ENTIDA

FO5

AKB_INDICE

1

 

AKB_PROCESS

000401

AKB_ITEM

08

AKB_DESCRI

Pedido de Viagem - Antes da emissão do pedido.

AKB_ENTIDA

FO5

AKB_INDICE

1

 

 3. Pontos de Bloqueio – AKA (ArrayaBlq)

 

AKA_PROCESS

000401

AKA_ITEM

01

AKA_DESCRI

Pedido de Viagem - Após a inclusão do ped. e antes do autorizador ser notificado

AKA_CHAVE

XFilial(“FO5”)+M->FO5_IDRESERV

AKB_ENTIDA

FO5

 

AKA_PROCESS

000401

AKA_ITEM

02

AKA_DESCRI

Pedido de Viagem - Após o autorizador ser notificado da inclusão do pedido.

AKA_CHAVE

XFilial(“FO5”)+M->FO5_IDRESERV

AKB_ENTIDA

FO5

 

AKA_PROCESS

000401

AKA_ITEM

03

AKA_DESCRI

Pedido de Viagem - Durante o processo de autorização do pedido.

AKA_CHAVE

XFilial(“FO5”)+M->FO5_IDRESERV

AKB_ENTIDA

FO5

 

AKA_PROCESS

000401

AKA_ITEM

04         

AKA_DESCRI

Pedido de Viagem - Após a autorização do pedido.

AKA_CHAVE

XFilial(“FO5”)+M->FO5_IDRESERV

AKB_ENTIDA

FO5

 

AKA_PROCESS

000401

AKA_ITEM

06

AKA_DESCRI

Pedido de Viagem - Após a emissão do pedido.

AKA_CHAVE

XFilial(“FO5”)+M->FO5_IDRESERV

AKB_ENTIDA

FO5

 

AKA_PROCESS

000401

AKA_ITEM

08

AKA_DESCRI

Pedido de Viagem - Antes da emissão do pedido.

AKA_CHAVE

XFilial(“FO5”)+M->FO5_IDRESERV

AKB_ENTIDA

FO5

 

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:

        

 

 

Campo FO5

Valor

FO5_FILIAL

XFilial("FO5")

FO5_CODIGO

[Auto numerador]

FO5_IDRES

<TAG>

FO5_DATA

<TAG>

FO5_CCUSTO

<TAG>

FO5_VALOR

<TAG>

FO5_TPVIAG

<TAG>

FO5_STATUS

<TAG>

 

 

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:

 

    • Ponto de entrada não configurado:

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:

 

 

ID Processo Reserve

Processo Protheus

Item Processo Protheus

1

000401

01

2

02

3

03

4

03

5

05

6

06

7

07

8

08

 

 

 

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")

 

    • Ponto de entrada configurado:

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:

        • 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).

 

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

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

 

 

 

 

 

 

 

 

 

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.

 

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.

 

Dicionário de Dados

 

Arquivo ou Código do Script: FO5 – Pedido de Viagem

  

Índice

Chave

01

FO5_FILIAL+FO5_CODIGO

02

FO5_FILIAL+FO5_IDRES

Campo

FO5_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

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.

 

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

 

 Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico.