Fábrica de Software TOTVS BH

Atalhos

Páginas filhas
  • Manual Operacional da Customização - Portal da Transparência 2.0

Versões comparadas

Versão antiga 16

changes.mady.by.user Usuário desconhecido (thiago.chagas)

Gravado em

comparado com

Nova versão 17

changes.mady.by.user Usuário desconhecido (thiago.chagas)

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Expandir
titleReq. 02 – Consultas para criação de filtros (SESI e SENAI)

Pré-Requisitos / Parametrizações

Nenhum.


Detalhamento do Processo

Foram desenvolvidas Consultas SQL para que seja possível elaborar os filtros utilizados no Portal Regional.
Para o SESI, foram criadas as seguintes consultas, com seus respectivos parâmetros e retorno:

Consulta

Parâmetros

Retorno

Município

Coligada (Obrigatório)

CIDADE

Programa

Coligada (Obrigatório) e município (opcional)

CODMODALIDADECURSO e MODALIDADECURSO

Produto

Coligada (Obrigatório) e município (opcional) e programa (opcional)

Produto (CODSERVICOSCAE)


Para o SENAI, foram criadas as seguintes consultas:

Consulta

Parâmetros

Retorno

Município

Coligada (Obrigatório)

CIDADE

Área de Atuação

Coligada (Obrigatório) e município (opcional)

Código da Área (CODAREA) e Nome da Área (NOMEAREA)

Curso

Coligada (Obrigatório)e município (opcional) e área de atuação (opcional)

Código do Curso (CODCURSO) e Nome (NOMECURSO)

Exemplo de uma requisição enviada para o WebService

Consulta SQL cadastrada no RM, com o código "CstTesteFiltros".

Como podemos ver na imagem abaixo, ela retorna os dados do município e tem um parâmetro (MUNICIPIO).

Image Removed

Exemplo do envio da requisição via Postman:

Image Removed

Código da requisição em HTTP

GET /rm/api/TOTVSCustomizacao/ConsultasSQL/ExecutaConsultaSQL?codColigada=0&codSentenca=CstTesteFiltros&parameters=MUNICIPIO=Belo Horizonte HTTP/1.1
Host: localhost:8080
Authorization: Basic bWVzdHJlOnRvdHZz

Expandir
titleReq. 03 – Consulta dados a serem disponibilizados no Portal

Pré-Requisitos / Parametrizações

Nenhum.


Detalhamento do Processo

Foi criada uma consulta SQL para retorno dos dados de gratuidade que serão exibidos no Portal da Transparência. Obs.: uma única consulta foi criada para retorno dos dados no contexto do SESI e SENAI.
Segue abaixo um exemplo de retorno do método da consulta com a descrição e valores de todos os campos retornados.

Exemplo de retorno do método de consulta de vagas de gratuidade

Propriedade

Descrição

SESI

SENAI

CODCOLIGADA

Código da Coligada

2

3

NOMECOLIGADA

Nome da Coligada

SESI

SENAI

CODFILIAL

Código da Unidade de Ensino (Filial)

2002

3002

NOMEFILIAL

Nome da Unidade de Ensino (Filial)

SESI - Ampére

SENAI - Ampére

RUA

Rua da Unidade de Ensino (Filial)

Rua Antenas

Rua Antenas

NUMERO

Número da Unidade de Ensino (Filial)

344

344

COMPLEMENTO

Complemento da Unidade de Ensino (Filial)

100

100

BAIRRO

Bairro da Unidade de Ensino (Filial)

Nossa Senhora das Graças

Nossa Senhora das Graças

CIDADE

Cidade do Prédio da Turma ou da Unidade de Ensino (Filial)

AMPERE

AMPERE

ESTADO

Estado da Unidade de Ensino (Filial)

PR

PR

PAIS

País da Unidade de Ensino (Filial)

Brasil

Brasil

CEP

CEP da Unidade de Ensino (Filial)

85640000

85640000

TELEFONE

Telefone da Unidade de Ensino (Filial)

32719719

32719719

NOMECURSO

Nome do curso

Ensino Médio

Eletrônica Industrial

SERIE

Série

1ª Série


PREREQUISITOS

Pré-requisitos

Idade mínima:
Idade máxima:
Escolaridade:

Idade mínima:
Idade máxima:
Escolaridade:

CURSOPRESDIST

Presencial/À distância


Presencial

PROGRAMA

Programa

Educação Básica


CODMODALIDADECURSO

Código da Modalidade do Curso

1, 2, 3, 4, 5, 6, 7

05, 11, 15, 150, 21, 31, 41, 57, 58, 67, 81, 87, 91, 92, 93

MODALIDADECURSO

Nome da Modalidade do Curso

Regular

Iniciação Profissional

CODPRODUTO

Código do Produto SCAE

53


PRODUTO

Nome do Produto SCAE

Ensino médio - 1º ano


NOMEAREA

Área de atuação


Eletrônica

CODTURMA

Código da Turma

1B33VEM

APB-V-000149/2018

NOMETURMA

Descrição da Turma

1B33VEM - 1° CT APENA 15

Eletrônica Industrial – 000149/2018

IDPERLET

Identificador do Período Letivo

2894

2987

CODPERLET

Código do Período Letivo

2018

2018/2

NOMEIDPERLET

Nome do Período Letivo

Período Letivo de 2018

Período Letivo 2º Semestre 2018

NOMEGRADE

Nome da Matriz Curricular

1ª Série - Ensino Médio

Eletrônica Industrial

TURNO

Turno

Manhã

Noite

TIPOMEDIACAO

Tipo de Mediação (Turma)

Presencial

Semipresencial

CARGAHORARIA

Carga Horária da Matriz Curricular

900

200

MAXALUNOS

Máximo de Alunos

40

20

VAGASGRAT

Vagas de gratuidade regimental / regulamentar

5

3

VAGASGRATDISP

Vagas de gratuidade regimental / regulamentar disponíveis

2

1

DTINICIOMATRICULA

Data inicial de Matrícula da Turma

10/09/2017

10/05/2018

DTFINMATRICULA

Data final de Matrícula da Turma

31/10/2017

30/06/2018

DTINICIAL

Data inicial da Turma

01/02/2018

01/08/2018

DTFINAL

Data final da Turma

15/12/2018

15/02/2018

Expandir
titleWeb Service Consulta SQL

Pré-Requisitos / Parametrizações

Nenhum.


Detalhamento do Processo

Foi desenvolvido um Web Service destinado a executar consultas SQL's cadastradas no RM.

Ao realizar a instalação da customização, ele estará disponível para acesso através do serviço do RM.


Segurança

Para a autenticação no Web Service, é utilizado um Token, gerado pela tela de parametrização da customização.

Para isso, o usuário deverá acessar a tela de Parâmetros, no menu "TOTVS Educacional→Customização→Parâmetros".

Após acessar a tela, preencher os campos Usuário e Senha com dados válidos para realizar um login no RM. Em seguida, executar o processo "Gerar Token".

O Token gerado no campo "Token Portal Transparência V2" deverá ser enviado em todas as requisições, no header "Authorization", da seguinte forma: Basic token_gerado.


Parâmetros do Web Service

O web service possui 3 parâmetros, sendo dois deles obrigatórios e todos enviados via GET:

ParâmetroConteúdo esperado
CodColigada (Obrigatório)A coligada da consulta SQL cadastrada no RM.
CodSentenca (Obrigatório)O Código da sentença SQL.
Parametros (Opcional)

Os parâmetros da consulta SQL. Devem ser passados da seguinte forma:

param1=value;param2=value.

Exemplo:

codColigada=0;codArea=1

Se a consulta que será executada não possuir parâmetros, o campo será enviado sem nenhum valor.


Exemplo de uma requisição enviada para o WebService

Consulta SQL cadastrada no RM, com o código "CstTesteFiltros".

Como podemos ver na imagem abaixo, ela retorna os dados do município e tem um parâmetro (MUNICIPIO).

Image Added


Exemplo do envio da requisição via Postman:

Image Added


Código da requisição em HTTP

GET /rm/api/TOTVSCustomizacao/ConsultasSQL/ExecutaConsultaSQL?codColigada=0&codSentenca=CstTesteFiltros&parameters=MUNICIPIO=Belo Horizonte HTTP/1.1
Host: localhost:8080
Authorization: Basic bWVzdHJlOnRvdHZz

Histórico de atualização do documento

...