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 FS007523 - Integração Itinerário.

Síntese

O SENAI possui a necessidade de realizar a integração de cursos entre a base do Itinerário Nacional e a base SGE DN, e desta base para as bases do SGE dos diversos DR's existentes nos estados.

Esta integração se dá em duas partes.

A primeira delas, correspondente à este manual, são os cadastros que serão alimentados e comporão os dados integrados entre os sistemas.

Requisitos

Expandir

title	Req. 01 – Cadastro Customizado de Unidades de Competência

Pré-Requisitos / Parametrizações

Não se aplica.

Detalhamento do Processo

Foi desenvolvido no menu Customizado do TOTVS Educacional o cadastro de Unidades de Competência.

O usuário poderá inserir, editar e excluir os registros dessa entidade. Os seguintes campos estarão disponíveis para edição:

Competência (obrigatório): será gravado o código da Competência.
Descrição (obrigatório): será gravado a descrição da Competência.

Image Modified

O usuário poderá também inserir as capacidades da Unidade, que podem ser Capacidades Técnicas (Detalhadas no Requisito 3) e Capacidades de Gestão (Detalhadas no Requisito 4).

Image Modified

Expandir

title	Req. 02 – Consultas para criação de filtros (SESI e SENAI)Cadastro Customizado de Fundamentos Técnicos Científicos

Pré-Requisitos / Parametrizações

Nenhum.

Detalhamento do Processo

Foi desenvolvido no menu Customizado do TOTVS Educacional o cadastro de Fundamentos Técnicos Científicos.

O usuário poderá inserir, editar e excluir os registros dessa entidade. Os seguintes campos estarão disponíveis para edição:

Código (obrigatório): será gravado o código do Fundamento Téc. Científico.
Descrição (obrigatório): será gravado a descrição do Fundamento Téc. Científico.

Na tela de visualização dos dados, o usuário poderá consultar ainda se o registro foi inserido manualmente ou via Integração, através da coluna Origem Registro.

Image Added

Expandir

title	Req. 03 – Cadastro Customizado de Capacidades Técnicas

Pré-Requisitos / Parametrizações

Nenhum.

Detalhamento do Processo

Foi desenvolvido no menu Customizado do TOTVS Educacional o cadastro de Capacidades Técnicas.

O usuário poderá inserir, editar e excluir os registros dessa entidade. Os seguintes campos estarão disponíveis para edição:

Código (obrigatório): será gravado o código da Capacidade Técnica.
Descrição (obrigatório): será gravado a descrição da Capacidade Técnica.

Na tela de visualização dos dados, o usuário poderá consultar ainda se o registro foi inserido manualmente ou via Integração, através da coluna Origem Registro.

Image Added

Para o SENAI, foram criadas as seguintes consultas:

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

Expandir

title	Req. 04 – Cadastro Customizado de Capacidades de Gestão

Pré-Requisitos / Parametrizações

Nenhum.

Detalhamento do Processo

Foi desenvolvido no menu Customizado do TOTVS Educacional o cadastro de Capacidades de Gestão.

O usuário poderá inserir, editar e excluir os registros dessa entidade. Os seguintes campos estarão disponíveis para edição:

Código (obrigatório): será gravado o código da Capacidade de Gestão.
Descrição (obrigatório): será gravado a descrição da Capacidade de Gestão.
Tipo (obrigatório): O tipo da capacidade de Gestão poderá ser Metodológica, Organizativa ou Social.

Na tela de visualização dos dados, o usuário poderá consultar ainda se o registro foi inserido manualmente ou via Integração, através da coluna Origem Registro.

Image Added

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)

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)

desenvolvido no menu Customizado do TOTVS Educacional o cadastro de Conhecimentos.

O usuário poderá inserir, editar e excluir os registros dessa entidade. Os seguintes campos estarão disponíveis para edição:

Código (obrigatório): será gerado automaticamente um código do Conhecimento.
Descrição Conhecimento Nível 1 (obrigatório): será gravado a descrição do primeiro nível do Conhecimento.
Descrição Conhecimento Nível 2: será gravado a descrição do segundo nível do Conhecimento.
Descrição Conhecimento Nível 3: será gravado a descrição do terceiro nível do Conhecimento.

Image Added

Na tela de visualização dos dados, o usuário poderá consultar ainda se o registro foi inserido manualmente ou via Integração, através da coluna Origem Registro.

Image Added

Expandir

title	Req. 03 – Consulta dados a serem disponibilizados no Portal05 – Cadastro Customizado de Conhecimentos

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

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	Req. 06 – Cadastro Customizado de Ambientes Pedagógicos

Pré-Requisitos / Parametrizações

Nenhum.

Detalhamento do Processo

Foi desenvolvido no menu Customizado do TOTVS Educacional o cadastro de Ambientes Pedagógicos.

O usuário poderá inserir, editar e excluir os registros dessa entidade. Os seguintes campos estarão disponíveis para edição:

Código (obrigatório): será gravado o código do Conhecimento.
Descrição (obrigatório): será gravado a descrição do Conhecimento.
Tipo (obrigatório): O tipo do Ambiente Pedagógico poderá ser:

Máquinas

Equipamentos

Ambientes Pedagógicos

Material Didático

Máquinas, Equipamentos, Instrumentos e Ferramentas

Ferramentas e Suprimentos

Instrumentos

Materiais

Equipamentos, Ferramentas e Instrumentos

Recursos Didáticos

Mobiliário

Observações/Recomendações

Na tela de visualização dos dados, o usuário poderá consultar ainda se o registro foi inserido manualmente ou via Integração, através da coluna Origem Registro.

Image Added

Expandir

title	Req. 07 – Anexo Customizado de Unidade de Competência - Curso

Pré-Requisitos / Parametrizações

Nenhum.

Detalhamento do Processo

Foi desenvolvido um anexo customizado no TOTVS Educacional, menu Currículo e Oferta – Matrizes Curriculares.

O usuário poderá inserir, editar e excluir os registros dessa entidade. Os seguintes campos estarão disponíveis para edição:

Competência (obrigatório): um lookup onde o usuário irá selecionar a Unidade de Competência (Detalhada no Requisito 1) desejada para ser inserida na Matriz Curricular.

Na tela de visualização dos dados, o usuário poderá consultar ainda se o registro foi inserido manualmente ou via Integração, através da coluna Origem Registro.

Image Added

Expandir

title	Req. 08 – Anexo Customizado de Unidade de Competência - Disciplina

Pré-Requisitos / Parametrizações

Nenhum.

Detalhamento do Processo

Foi desenvolvido um anexo customizado no TOTVS Educacional, menu Currículo e Oferta – Disciplinas.

O usuário poderá inserir, editar e excluir os registros dessa entidade. Os seguintes campos estarão disponíveis para edição:

Competência (obrigatório): um lookup onde o usuário irá selecionar a Unidade de Competência (Detalhada no Requisito 1) desejada para ser inserida na Disciplina.

Na tela de visualização dos dados, o usuário poderá consultar ainda se o registro foi inserido manualmente ou via Integração, através da coluna Origem Registro.

Image Added

Expandir

title	Req. 09 – Anexo Customizado de Fundamentos Técnicos Científicos – Disciplina

Pré-Requisitos / Parametrizações

Nenhum.

Detalhamento do Processo

Foi desenvolvido um anexo customizado no TOTVS Educacional, menu Currículo e Oferta – Disciplinas.

O usuário poderá inserir, editar e excluir os registros dessa entidade. Os seguintes campos estarão disponíveis para edição:

Fundamentos Técnicos Científicos (obrigatório): um lookup onde o usuário irá selecionar o Fundamento Técnico Científico (Detalhada no Requisito 2) desejada para ser inserida na Disciplina.

Na tela de visualização dos dados, o usuário poderá consultar ainda se o registro foi inserido manualmente ou via Integração, através da coluna Origem Registro.

Image Added

Expandir

title	Req. 10 – Anexo Customizado de Capacidades Técnicas – Disciplina

Pré-Requisitos / Parametrizações

Nenhum.

Detalhamento do Processo

Foi desenvolvido um anexo customizado no TOTVS Educacional, menu Currículo e Oferta – Disciplinas.

O usuário poderá inserir, editar e excluir os registros dessa entidade. Os seguintes campos estarão disponíveis para edição:

Capacidades Técnicas (obrigatório): um lookup onde o usuário irá selecionar a Capacidade Técnica (Detalhada no Requisito 3) desejada para ser inserida na Disciplina.

Image Added

Expandir

title	Req. 11 – Anexo Customizado de Capacidades de Gestão – Disciplina

Pré-Requisitos / Parametrizações

Nenhum.

Detalhamento do Processo

Foi desenvolvido um anexo customizado no TOTVS Educacional, menu Currículo e Oferta – Disciplinas.

O usuário poderá inserir, editar e excluir os registros dessa entidade. Os seguintes campos estarão disponíveis para edição:

Capacidades Técnicas (obrigatório): um lookup onde o usuário irá selecionar a Capacidade Técnica (Detalhada no Requisito 3) desejada para ser inserida na Disciplina.

Image Added

Expandir

title	Req. 12 – Anexo Customizado de Conhecimentos – Disciplina da Grade

Pré-Requisitos / Parametrizações

Nenhum.

Detalhamento do Processo

Foi desenvolvido um anexo customizado no TOTVS Educacional, menu Currículo e Oferta – Matrizes Curriculares – Anexo Período – Anexo Disciplinas da Matriz Curricular – Anexo Conhecimentos.

O usuário poderá inserir, editar e excluir os registros dessa entidade. Os seguintes campos estarão disponíveis para edição:

Código Conhecimento(obrigatório): um lookup onde o usuário irá selecionar o Conhecimento (Detalhada no Requisito 5) desejada para ser inserida na Disciplina da Matriz Curricular.
Aba Capacidades: o usuário poderá inserir N Capacidades, Técnicas ou de Gestão.

Image Added

Expandir

title	Req. 13 – Cadastro Customizado de Fundamentos Técnicos Cientifícos

Pré-Requisitos / Parametrizações

Nenhum.

Detalhamento do Processo

Foi desenvolvido um anexo customizado no TOTVS Educacional, menu Currículo e Oferta – Matrizes Curriculares – Anexo Período – Anexo Disciplinas da Matriz Curricular – Anexo Capacidades Ambientes Pedagógicos.

O usuário poderá inserir, editar e excluir os registros dessa entidade. Os seguintes campos estarão disponíveis para edição:

Cód. Ambiente Pedagógico (obrigatório): um lookup onde o usuário irá selecionar o Ambiente Pedagógico (Detalhado no Requisito 6) desejada para ser inserida na Disciplina da Matriz Curricular.

Image Added

Expandir

title	Req. 14 – Tela de Parâmetros da Customização - SGE x Itinerário

Pré-Requisitos / Parametrizações

Nenhum.

Detalhamento do Processo

Foi desenvolvido uma parametrização customizada no TOTVS Educacional, menu Customização – Parametrização SGE x Itinerário. O menu de acesso à tela está localizado no TOTVS Educacional -> Customização -> Integração SGE x Itinerário -> Parametrização SGE x Itinerário.

O usuário poderá configurar os seguintes campos:

Endereço do Web Service: Deverá ser inserido o endereço do WebService fornecido pelo Itinerário.

Usuário: Deverá ser inserido o usuário do Itinerário.

Token: Deverá ser inserido o Token de segurança para o acesso ao Itinerário.

Image Added

Aba Segurança:

O usuário irá gerar um Token de Segurança para que os DR’s utilizem o WebService Totvs. Para isso, é preciso digitar um Usuário e Senha validos para login no RM e clicar em Gerar Token. Após isso, basta Salvar e encaminhar o Token para que possa ser inserido na Parametrização DR x Diretório Nacional.

Image Added

Aba De-Para Área:

O usuário deverá cadastrar os De-Paras das Áreas. Serão exibidos dois campos na tela, o primeiro virá preenchido com as áreas do itinerário, e o segundo, com os dados do Totvs Educacional.

Image Added

Aba De-Para Modalidade:

O usuário deverá cadastrar os De-Paras das Modalidades. Serão exibidos dois campos na tela, o primeiro virá preenchido com as modalidades do itinerário, e o segundo, com os dados do Totvs Educacional.

Image Added

Aba Abreviação Modalidade:

O usuário deverá cadastrar as abreviações das Modalidades, com no máximo 3 caracteres, para serem utilizadas na geração dos Códigos do Curso, Grades e Disciplinas.

Image Added

Aba Versões Itinerário:

O usuário deverá cadastrar as Versões do Itinerário que estarão disponíveis para consulta no processo de Integração de Cursos.

Image Added

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

Este processo tem como objetivo consultar a base de dados do Itinerário, utilizando um WebService, e de acordo com a seleção realizada pelo usuário efetuar a integração de cursos no TOTVS SGE. No processo de integração serão importados para a base do SGE Cursos, Habilitação,Matriz Curricular, Período, Disciplinas, Disciplinas no Período e Competências. O menu de acesso ao processo está localizado no TOTVS Educacional -> Customização -> Integração SGE x Itinerário -> Integração Curso.

Na primeira etapa o usuário deverá selecionar a Área, Modalidade e Versão do Itinerário, para que sejam pesquisados os Cursos do Itinerário, obedecendo os dados selecionados. As Áreas e Modalidades deverão ser parametrizadas nos De-Paras (Requisito 14) para que sejam exibidas nos campos. Após a seleção do Curso, o usuário poderá avançar para a segunda etapa.

Image Added

Na segunda etapa, serão exibidos os dados selecionados para conferência. Após a verificação e validação das informações, o usuário poderá avançar para a terceira etapa.

Image Added

Na terceira etapa, serão exibidos os Módulos e as Unidades Curriculares que serão importadas. Será gerada uma nova grade, onde os Módulos serão os Períodos e as Unidades Curriculares serão as Disciplinas, que serão vinculadas aos correspondentes Períodos. O usuário deverá validar e prosseguir para a quarta etapa.

Image Added

Na quarta etapa, serão exibidas as disciplinas em conflito, ou seja, as que já existem cadastradas no TOTVS Educacional. Para cada uma das disciplinas existentes, serão exibidas as Unidades de Competência já cadastradas e as que serão criadas. O usuário poderá apenas atualizar a disciplina, inserindo as novas unidades de competência ou poderá criar uma nova. Para isso, o usuário deverá selecionar o menu presente em cada linha, definindo como “Atualizar Unidade Curricular” ou “Criar Unidade Curricular”.

Exemplo:

Disciplina 1
- Unidades de Competência existentes
  - Unidade Competência 1
- Unidades de Competência que serão criadas
  - Unidade Competência 2

Se o usuário selecionar a opção “Atualizar Unidade Curricular”, a disciplina será atualizada e ficará com os seguintes dados:

Disciplina 1
- Unidades de Competência:
  - Unidade Competência 1
  - Unidade Competência 2

Se o usuário optar por “Criar Unidade Curricular”, será gerada uma nova disciplina com as duas unidades de competência anteriores.

Image Added

Após a verificação das disciplinas em Conflito, o processo será executado. Serão importados os Cursos, Módulos (Período no SGE), Unidades Curriculares (Disciplinas no SGE), Unidades de Competência, Conhecimentos, Fundamentos Técnicos Científicos, Capacidades Técnicas e de Gestão e Capacidades de Ambientes Pedagógicos.

As unidades de Competência carregadas serão integradas no Anexo de Unidades de Competência da Matriz Curricular.

Os Fundamentos Técnicos Científicos, Capacidades Técnicas e de Gestão serão integrados como anexos da Disciplina.

Expandir

title	Req. 15 – Processo de Integração de Cursos - Itinerário - TOTVS SGE

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.

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âmetro

Conteú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.

Histórico de atualização do documento

...

Documento inicial.

Data	Autor	Versão	Descrição das alterações
0509/10/2018	Thiago Neiva Chagas	1.0	Importação do manual para o TDN.
30/10/2018	Ana Carolina Eleutério Abras	2.0	Req. 15 – Processo de Integração de Cursos - Itinerário - TOTVS SGE

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

Síntese

Requisitos

Pré-Requisitos / Parametrizações

Detalhamento do Processo

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Histórico de atualização do documento

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

Síntese

Requisitos

Pré-Requisitos / Parametrizações

Detalhamento do Processo

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Pré-Requisitos / Parametrizações

Histórico de atualização do documento