Manual Operacional da Customização - Portal da Transparência 2.0

...

Projeto: FS007963 (941582) – Portal da Transparência 2.0
Cliente: SESI / SENAI DN

Objetivo deste documento

Prezados Senhores,

O documento a seguir tem por objetivo orientar o usuário sobre as implementações realizadas para sua empresa. Todas as funcionalidades descritas neste manual têm como base o que está descrito no documento FS007963 (941582) – Portal da Transparência 2.0.

...

Síntese

O objetivo deste projeto documento é detalhar a as funcionalidades da nova integração a ser realizada entre o SGE e o Portal da Transparência na qual ao invés de consumir métodos pré-definidos, será é consumido um método que executará executa uma consulta previamente criada no cadastro de consultas SQL padrão do SGE.

...

Expandir

title	Req. 01 – Validação de preenchimento de campos complementares (SESI e SENAI)

Pré-Requisitos / Parametrizações

Necessário habilitar os seguintes campos complementares da turma: "Publica no Portal do Regional", "Vagas gratuidgratuidade. Regimental/regulamentar", "Data inicial de matrícula", "Data final de matrícula" e , "Forma de Inscrição" e "Pré-Requisitos".

Dica
Para acessar o roteiro de ativação dos campos complementares, clique aqui.

Detalhamento do Processo

Foi desenvolvida uma validação customizada no cadastro de Turmas, a fim de verificar se os campos complementares foram preenchidos. A customização irá exibir uma mensagem de erro impedindo que a alteração/cadastro da turma seja realizado se o campo "Publica Portal do Regional" estiver com o valor de S (Sim) e algum dos seguintes campos estejam em branco:

Vagas de Gratuidade
Data inicial de matrícula
Data final de matrícula
Forma de inscrição
Pré-Requisitos
- Obs.: o campo Pré-Requisitos, para o SENAI, deverá ser preenchido na Matriz Curricular, e para o SESI, será preenchido na Série (
  Habilitacao
  Habilitação), ambos campos complementares.

Se o campo "Publica Portal do Regional" estiver vazio ou com N (Não), a customização irá permitir que os registros sejam salvos, porém irá alertar com uma mensagem quais os campos complementares que foram preenchidos e que a Turma não será exibida 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.

Expandir

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

Expandir

title	Req. 03 – Consulta dados a serem disponibilizados no Portal

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

NUMERO

Número da Unidade de Ensino (Filial)

344

COMPLEMENTO

Complemento da Unidade de Ensino (Filial)

100

BAIRRO

Bairro da Unidade de Ensino (Filial)

Nossa Senhora das Graças

CIDADE

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

AMPERE

ESTADO

Estado da Unidade de Ensino (Filial)

PR

PAIS

País da Unidade de Ensino (Filial)

Brasil

CEP

CEP da Unidade de Ensino (Filial)

85640000

TELEFONE

Telefone da Unidade de Ensino (Filial)

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:

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

title	Web 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.

Swagger

Todos os serviços disponíveis no RM são agrupados e listados nessa ferramenta, que visa auxiliar na manutenção e documentação de APIs REST.

Para acessar o Swagger, é necessário acessar o link no seguinte formato "http://<servidor>:<portaFrameHTML>/swagger/ui/index" (Exemplo: http://localhost:8080/swagger/ui/index

)

.

Para verificar a porta, acesse, através do IIS, o Website "FrameHTML", que é gerado quando realizada a instalação do Portal RM:

Image Removed

Após isso, basta clicar com o botão direito do mouse no Website "FrameHTML" e clicar na opção "Editar ligações...". Conforme imagem abaixo, a porta seria a 8080, e o link ficaria da seguinte forma "http://localhost:8080/swagger/ui/index".

Image Removed

Ao acessar o Swagger, serão listados todos os serviços disponíveis, com a descrição do serviço, parâmetros e urls:

Image Removed

O webservice de consultas SQL é o "CstExecSQL", método "ExecutaConsultaSQL".

Segurança

Para a autenticação no

Web Service

...

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:

...

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

...

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

...

Lista Códigos dos Sistemas

...

Histórico de atualização do documento

Histórico de versões

Data	Autor	Versão	Descrição das alterações
05/10/2018	Thiago Neiva Chagas	1.0	Documento inicial.
07/05/2018	Ana Carolina Eleutério Abras	2.0	Adicionadas informações sobre o Token - Versão 2

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 23

Nova versão Atual

Chave

Manual Operacional da Customização - Portal da Transparência 2.0

Projeto: FS007963 (941582) – Portal da Transparência 2.0
Cliente: SESI / SENAI DN

Objetivo deste documento

Síntese

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Detalhamento do Processo

Pré-Requisitos / Parametrizações

Histórico de versões

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 23

Nova versão Atual

Chave

Manual Operacional da Customização - Portal da Transparência 2.0

Projeto: FS007963 (941582) – Portal da Transparência 2.0Cliente: SESI / SENAI DN

Objetivo deste documento

Síntese

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Detalhamento do Processo

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Histórico de versões

Projeto: FS007963 (941582) – Portal da Transparência 2.0
Cliente: SESI / SENAI DN