Data: 02/03/2018
10/10/2017
Especificação - Detalhamento Funcional
1. Síntese .............................................................................................................................................................................................2
2. Requisitos .......................................................................................................................................................................................2
2.1. Escopo .....................................................................................................................................................................................2
2.2. Restrições ................................................................................................................................................................................2
2.3. Infraestrutura e Ambiente de Desenvolvimento .......................................................................................................................2
3. Modelo de Solução .........................................................................................................................................................................3
Req. 01 – Parâmetros de integração SGE x Portal da Transparência............................................................................................4
Req. 02 – Web Service de consulta de cursos ...............................................................................................................................7
4. Histórico de Atualização do Documento ....................................................................................................................................22
4.1. Histórico de Versões ..............................................................................................................................................................22
4.2. Aprovação ..............................................................................................................................................................................22
1. Síntese
O objetivo deste projeto é descrever a integração a ser realizada entre o SGE e o Portal da Transparência quer permitirá aos DR’s
consultar dados de gratuidade regimental / regulamentar dos cursos e posteriormente disponibilizar estas informações em seus
portais, atendendo assim, a fase 2 do Módulo de gratuidade (Transparência). Neste documento estará detalhada a solução a ser
implementada pela TOTVS.
2. Requisitos
2.1. Escopo
Req. 01 – Parâmetros de integração SGE x Portal da Transparência
Req 02 – Web Service de consulta de cursos
2.2. Restrições
Não estão contemplados neste documento:
i. Funcionalidades não contempladas no escopo deste documento ou qualquer informação que esteja implícita na
documentação.
ii. Desenvolvimento de help on-line.
iii. Criação e manutenção de usuários do sistema.
iv. Elaboração ou alteração de qualquer relatório.
v. Desenvolvimento de rotinas ou programas para carga de dados.
vi. Seleção, instalação e configuração de infraestrutura, banco de dados, hardware e ambiente operacional necessário
à implementação do projeto desenvolvido, seja em ambiente de testes ou ambiente oficial.
vii. Manutenções em outros Sistemas não descritos na Proposta.
viii. Procedimentos de backup do sistema ou banco de dados.
ix. Disponibilidade do projeto desenvolvido em outras línguas.
x. De-Para entre os sistemas integrados.
xi. Implementação nos Portais dos DR’s para publicação das informações de gratuidade regimental / regulamentar.
xii. Req. 02 – Relatório de Consulta a Cursos com gratuidade regimental / regulamentar. O Req. 02 será tratado em
documento de Especificação a parte para que a entrega do Req. 01 não seja afetada pela validação do layout do
relatório.
2.3. Infraestrutura e Ambiente de Desenvolvimento
O presente documento considera os itens Abaixo como premissas técnicas referentes à infraestrutura e ambiente da sua
empresa. Todo o projeto de desenvolvimento será feito tomando como base as informações colocadas Abaixo:
Sistema Base: TOTVS
Base de Dados: SQL / Oracle
Linguagem: .NET
Versão ERP: 11.83 e 12.1.17 (a customização será desenvolvida na versão 11.83 e posteriormente será convertida
para a versão 12.1.17).
Obs: O DR Mato Grosso do Sul está na versão 12.1.14 e a previsão para conversão com o acompanhamento da
TOTVS está previsto para Setembro/18.
3. Modelo de Solução
TOTVS PORTAL DR
Customização extrai dados do SGE <<estender>> Dados são recebidos pelo Portal
Parâmetros salvos
Descrição do Processo
1. Usuário acessa TOTVS Educacional | Customização | Parâmetros Portal Transparência.
2. Usuário visualiza os campos parametrizáveis.
3. Usuário preenche os campos e clica em Salvar.
4. Parâmetros salvos.
5. Fim do processo.
Detalhamento de Cálculos
Não se aplica.
Detalhamento de Processos Específicos
O objetivo deste requisito é detalhar a criação de uma tela de parâmetros para a customização do Portal da Transparência. Esta
interface estará disponível em TOTVS Educacional | Customização | Parâmetros Portal Transparência.
Ao acessar esta tela será visualizada uma grid (Fig. 01.01) com todos os parâmetros listados para esta Customização. Serão
eles:
Usuário: Usuário (válido no SGE) utilizado para gerar o token de autenticação.
Senha: Senha do usuário no SGE para gerar o token de autenticação.
Token: Token que deve ser configurado para acesso ao Web Service.
O campo Token não deverá ser preenchido manualmente pelo usuário. O usuário deverá executar o processo Gerar
Token, disponível em TOTVS Educacional | Customização | Parâmetros Portal Transparência | Processos.
Baseado no usuário e senha informados nos demais parâmetros, a Customização gerará um token que deverá ser
informado pela rotina do sistema terceiro que acionará o Web Service de consulta de cursos.
ESTRUTURA DE DADOS:
Chave da tabela.
ZTEMPLATEPARAMETROVA
Coligada LOR.CODCOLIGADA N/A Varchar 5 Campo não visível na tela.
Esta tabela será por Coligada.
ZTEMPLATEPARAMETROVA
Usuário LOR.USUARIO Text box Varchar 20
Protótipo
As imagens dos protótipos são meramente ilustrativas, podendo variar ao longo do desenvolvimento de acordo com a ferramenta
TOTVS.
Descrição do Processo
1. Portal do DR aciona Web Service TOTVS.
2. Customização extrai dados de gratuidade regimental / regulamentar do banco de dados do SGE.
3. Customização retorna os dados para o Portal do DR.
4. Customização grava log de consulta realizada.
5. Fim do processo.
Detalhamento de Cálculos
Não se aplica.
Detalhamento de Processos Específicos
O objetivo deste requisito é detalhar a criação do Web Service de consulta de cursos a ser realizada no SGE para atender a
demanda do Portal da Transparência. O Web Service será implementado utilizando arquitetura REST, possibilitando a troca de
mensagens em formato JSON. A autenticação se dará a partir de um Token disponibilizado nos parâmetros (Req. 01) e que o
sistema terceiro que realizar a integração com o Web Service precisará enviar para que a autenticação ocorra.
No momento que o método disponibilizado pela TOTVS for consumido, os seguintes parâmetros são esperados para filtrar os
dados que serão extraídos do SGE:
Coligada.
Unidade de Ensino.
Modalidade de Curso.
Com estas informações a Customização deverá extrair do SGE os seguintes dados:
Modalidade de Curso.
Código da Coligada.
Nome da Coligada.
Unidade de Ensino (Filial).
Nome da Unidade de Ensino (Filial).
Rua da Unidade de Ensino (Filial).
Número da Unidade de Ensino (Filial).
Complemento da Unidade de Ensino (Filial).
Bairro da Unidade de Ensino (Filial).
Cidade da Unidade de Ensino (Filial).
Estado da Unidade de Ensino (Filial).
País da Unidade de Ensino (Filial).
CEP da Unidade de Ensino (Filial).
Telefone da Unidade de Ensino (Filial).
Código da Modalidade do Curso.
Nome da Modalidade do Curso.
Código do Produto SCAE.
Nome do Produto SCAE.
Código da Turma.
Descrição da Turma.
Identificador do Período Letivo.
Código do Período Letivo.
Descrição do Período Letivo.
Descrição da Matriz Curricular.
Turno.
Tipo de Mediação.
Carga Horária da Matriz Curricular.
Máximo de Alunos.
Vagas de gratuidade regimental / regulamentar.
Vagas de gratuidade regimental / regulamentar disponíveis.
Data inicial de matrícula da Turma.
Data final de matrícula da Turma.
Data inicial da Turma.
Data final da Turma.
Todavia, não serão todos os Cursos que serão enviados ao Portal do DR. Apenas aqueles que possuírem Turmas com o campo
complementar “Publica no Portal do Regional” igual a Sim (STURMACOMPL.PUBLICAPORTAL = S) e que o Período de
Matrícula da Parametrização por Curso compreenda a Data atual serão integrados.
Para identificar se o Período de Matrícula da Turma compreenda a Data atual (data em que a pesquisa está sendo realizada
pelo DR no Web Service TOTVS), será considerada as Datas de Matrícula da Parametrização por Curso vinculada à Turma:
STURMA.CODCOLIGADA + STURMA.IDPERLET + STURMA.IDHABILITACAOFILIAL
SHABILITACAOFILIALPL.CODCOLIGADA + SHABILITACAOFILIALPL.IDPERLET +
SHABILITACAOFILIALPL.IDHABILITACAOFILIAL
SHABILITACAOFILIALPL.DTINICIOMATRICULA e DTFINMATRICULA. Ou seja, se a data de consulta estiver
compreendida entre as datas iniciais e finais de Matrícula na Parametrização por Curso, o registro passa a ser elegível à ser
integrado com o Portal da Transparência.
Sobre as vagas de gratuidade regimental / regulamentar, duas informações serão enviadas ao Portal da Transparência:
Total de vagas de gratuidade regimental / regulamentar (STURMACOMPL.VAGASGRAT).
Vagas disponíveis de gratuidade regimental / regulamentar: serão consideradas o número de matrículas no Período Letivo
para a Turma que possuem o campo SMATRICPLCOMPL.CODFINANC = 2 (Gratuidade Regulamentar) ou o
campo SMATRICPLCOMPL.TIPOGRAT = 1 (Gratuidade Regimental) e então este valor será subtraído ao “Total
de vagas de gratuidade regimental / regulamentar” e enviado ao Portal da Transparência.
Como os campos na Matrícula no Período Letivo são diferentes entre as Coligadas SESI e SENAI, a customização deverá
verificar, independente do Código da Coligada passada como Parâmetro no Web Service pelo Portal, se o preenchimento
de algum dos dois campos atende a premissa detalhada acima. Essa validação duplicada se deve ao fato que a
Customização não pode adimitr que as Coligadas SESI sempre são igual a 2 e Coligadas SENAI sempre são igual a 3.
Cada consulta realizada ao Web Service gravará um registro na tabela customizada ZTRANSPARENCIALOG. Nesta tabela,
além dos valores enviados nos parâmetros de entrada do método (Coligada, Unidade de Ensino e Modalidade), serão gravadas
as chaves das Matrizes Curriculares retornadas baseadas pelos parâmetros de entrada, além da Turma, Vagas de gratuidade
regimental / regulamentar Total e Disponíveis, hora e data da consulta. Esta tabela não possuirá interface para consulta. Ou
seja, caso a partir de uma consulta realizada pelo Portal do DR, sejam retornados “N” registros de Matrizes Curriculares / Turmas
que possuem Turmas com Vagas de Gratuidade regimental / regulamentar, esta tabela possuirá os mesmos “N” registros.
PONTOS DE ATENÇÃO:
Os parâmetros a serem enviados pelo DR (Coligada, Unidade de Ensino e Modalidade de Curso) deverão ter códigos
válidos no SGE. Não será realizado nenhum De-Para entre os sistemas integrados.
O campo complementar da Turma “Publica no Portal do Regional” deve ser do Tipo Alfanumérico com Tamanho = 1 e
possuir uma tabela dinâmica vinculada com as seguintes opções: N = Não e S = Sim. A criação deste campo será
realizada via script pela Fábrica de Software. Caberá aos DR’s disponibilizarem o campo no cadastro de Turma.
O campo complementar da Turma “Total de vagas de gratuidade regimental / regulamentar” deve ser do Tipo Inteiro. A
criação deste campo será realizada via script pela Fábrica de Software. Caberá aos DR’s disponibilizarem o campo no
cadastro de Turma.
Para correta extração dos dados da base do SGE é imprescindível que as Datas de Matrícula da Parametrização por
Curso, os campos complementares da Turma (Publica no Portal do Regional e Vagas de gratuidade regimental /
regulamentar) e os campos complementares da Matrícula no período letivo (Código de Financiamento SCAE se SESI e
Condição do Aluno se SENAI) estejam corretamente preenchidos.
É de responsabilidade de cada DR consumir o método do Web Service SGE e disponibilizar as informações no seu Portal.
Com os dados disponibilizados pelo método, no Portal do Regional poderão ser criados os filtros necessários. Estes filtros
não são de responsabilidade da Fábrica.
Cada DR poderá utilizar um Portal para publicação das informações, porém, o método de consumo será único.
Para utilização da customização, cada DR deverá disponibilizar um servidor web com a biblioteca RM instalada e o IIS
(Internet Information Services) configurado, viabilizando a implementação da solução proposta.
É responsabilidade dos DR’s manterem o Web Service on-line.
ESTRUTURA DE DADOS:
CODMODALIDADECU
RSO Modalidade do Curso Varchar 4
STURMA.CODCOLI
GADA
GCOLIGADA.CODC
NOMECOLIGADA Nome da Coligada OLIGADA Varchar 60
GCOLIGADA.NOME
FANTASIA
Código da Unidade de
CODFILIAL Parâmetro de entrada Smallint 5
Ensino (Filial)
STURMA.CODFILI
AL +
STURMA.CODCOLI
GADA
Nome da Unidade de GFILIAL.CODFIL
NOMEFILIAL Varchar 100
Ensino (Filial) IAL +
GFILIAL.CODCOL
IGADA
GFILIAL.NOMEFA
NTASIA
STURMA.CODFILI
AL +
STURMA.CODCOLI
GADA
Rua da Unidade de
RUA GFILIAL.CODFIL Varchar 100
Ensino (Filial) IAL +
GFILIAL.CODCOL
IGADA
GFILIAL.RUA
STURMA.CODFILI
AL +
STURMA.CODCOLI
GADA
Número da Unidade de
NUMERO GFILIAL.CODFIL Varchar 8
Ensino (Filial) IAL +
GFILIAL.CODCOL
IGADA
GFILIAL.NUMERO
STURMA.CODFILI
AL +
STURMA.CODCOLI
GADA
Complemento da
GFILIAL.CODFIL
COMPLEMENTO Unidade de Ensino IAL + Varchar 60
(Filial) GFILIAL.CODCOL
IGADA
GFILIAL.COMPLE
MENTO
STURMA.CODFILI
AL +
STURMA.CODCOLI
GADA
Bairro da Unidade de
BAIRRO GFILIAL.CODFIL Varchar 80
Ensino (Filial) IAL +
GFILIAL.CODCOL
IGADA
GFILIAL.BAIRRO
STURMA.CODFILI
AL +
STURMA.CODCOLI
GADA
Cidade da Unidade de
CIDADE GFILIAL.CODFIL Varchar 32
Ensino (Filial) IAL +
GFILIAL.CODCOL
IGADA
GFILIAL.CIDADE
STURMA.CODFILI
Estado da Unidade de AL +
ESTADO Varchar 2
Ensino (Filial) STURMA.CODCOLI
GADA
STURMA.CODFILI
AL +
STURMA.CODCOLI
GADA
País da Unidade de
PAIS GFILIAL.CODFIL Varchar 20
Ensino (Filial) IAL +
GFILIAL.CODCOL
IGADA
GFILIAL.PAIS
STURMA.CODFILI
AL +
STURMA.CODCOLI
GADA
CEP da Unidade de
CEP GFILIAL.CODFIL Varchar 9
Ensino (Filial) IAL +
GFILIAL.CODCOL
IGADA
GFILIAL.CEP
STURMA.CODFILI
AL +
STURMA.CODCOLI
GADA
Telefone da Unidade
TELEFONE Varchar 8
de Ensino (Filial)
GFILIAL.CODFIL
IAL +
GFILIAL.CODCOL
IGADA
STURMA.CODCOLI
GADA +
STURMA.MODALID
ADE
SMODALIDADECUR
MODALIDADECURS Nome da Modalidade SO.CODCOLIGADA Varchar 60
O do Curso +
SMODALIDADE.CO
DMODALIDADE
SMODALIDADECUR
SO.DESCRICAO
STURMA.IDHABIL
ITACAOFILIAL +
STURMA.CODCOLI
GADA
SHABILITACAOFI
LIAL.IDHABILIT
ACAOFILIAL +
SHABILITACAOFI Será enviado apenas
LIAL.CODCOLIGA se o campo
DA complementar for
Código do Produto
CODPRODUTO Varchar 10 encontrado no cadastro
SCAE de Habilitação (Série),
SHABILITACAOFI caso contrário, estará
LIAL.CODHABILI em branco.
TACAO +
SHABILITACAOFI
LIAL.CODCURSO
+
SHABILITACAOFI
LIAL.CODCOLIGA
DA
STURMA.IDHABIL
ITACAOFILIAL +
STURMA.CODCOLI
GADA
SHABILITACAOFI
LIAL.IDHABILIT
ACAOFILIAL +
SHABILITACAOFI
LIAL.CODCOLIGA
DA
Será enviado apenas
SHABILITACAOFI se o campo
LIAL.CODHABILI complementar for
Nome do Produto
PRODUTO TACAO + Varchar 70 encontrado no cadastro
SCAE SHABILITACAOFI de Habilitação (Série),
LIAL.CODCURSO caso contrário, estará
+ em branco.
SHABILITACAOFI
LIAL.CODCOLIGA
DA
SHABILITACAOCO
MPL.CODHABILIT
ACAO +
SHABILITACAOCO
MPL.CODCURSO +
SHABILITACAOCO
MPL.CODCOLIGAD
A
STURMA.CODTURM
CODTURMA Código da Turma A Varchar 20
Identificador do STURMA.IDPERLE
IDPERLET Varchar 10
Período Letivo T
STURMA.IDPERLE
T
Código do Período SPLETIVO.IDPER
CODPERLET Varchar 10
Letivo LET
SPLETIVO.CODPE
RLET
STURMA.IDPERLE
T
Nome do Período SPLETIVO.IDPER
NOMEIDPERLET Varchar 60
Letivo LET
SPLETIVO.DESCR
ICAO
STURMA.IDHABIL
Nome da Matriz ITACAOFILIAL
NOMEGRADE Varchar 255
Curricular
SHABILITACAOFI
STURMA.IDHABIL
ITACAOFILIAL
SHABILITACAOFI
LIAL.
IDHABILITACAOF
ILIAL
TURNO Turno Varchar 15
SHABILITACAOFI
LIAL.CODTURNO
STURNO.CODTURN
O
STURNO.NOME
1 = Presencial.
STURMA.TIPOMED 2 = Semipresencial.
TIPOMEDIACAO Tipo de Mediação IACAO Varchar 25
3 = Educação a
distância.
STURMA.IDHABIL
ITACAOFILIAL
Carga Horária da
CARGAHORARIA Decimal 15,4
Matriz Curricular
SHABILITACAOFI
LIAL.
STURMA.MAXALUN
MAXALUNOS Máximo de Alunos OS Int 10
Vagas de gratuidade
STURMACOMPL.
VAGASGRAT regimental / Int 10
VAGASGRAT
regulamentar
Serão consideradas o
número de matrículas
no Período Letivo para
a Turma que possuem
o campo
SMATRICPLCOMPL
.CODFINANC = 2
(Gratuidade
Vagas de gratuidade Regulamentar) ou
regimental / STURMACOMPL.VA SMATRICPLCOMPL
VAGASGRATDISP Int 10
regulamentar GASGRATDISP .TIPOGRAT = 1
disponíveis (Gratuidade
Regimental), então
este valor será
subtraído ao “Total de
vagas de gratuidade
regimental /
regulamentar” e
enviado ao Portal da
Transparência
STURMA.CODCOLI
DTINICIOMATRIC Data inicial de GADA +
STURMA.IDPERLE Datetime 8
ULA Matrícula da Turma
T +
STURMA.IDHABIL
STURMA.CODCOLI
GADA +
STURMA.IDPERLE
T +
STURMA.IDHABIL
ITACAOFILIAL
SHABILITACAOFI
LIALPL.CODCOLI
Data final de Matrícula GADA +
DTFINMATRICULA Datetime 8
da Turma SHABILITACAOFI
LIALPL.IDPERLE
T +
SHABILITACAOFI
LIALPL.IDHABIL
ITACAOFILIAL
SHABILITACAOFI
LIALPL.DTFINMA
TRICULA
STURMA.DTINICI
DTINICIAL Data inicial da Turma AL Datetime 8
Número da Unidade de
NUMERO N/A Varchar 8
Ensino (Filial)
Código da Modalidade do
CODMODALIDADECURSO N/A Varchar 4 Chave da tabela.
Curso
Vagas de gratuidade
regimental / regulamentar VAGASGRATDISP N/A Int 10
disponíveis
Protótipo
Não se aplica.
Atualização pontual na
Davi Leles Braga Pereira
08/03/2018 2.1 documentação de acordo com call Sim
Lacerda
realizada com Perla e Décio.
4.2. Aprovação
Data Nome Assinatura