Páginas filhas
  • Manual Operacional - Integração SmartDocs

Versões comparadas

Chave

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

...

Expandir
titlePermissões e orientações Técnicas

Para utilização da Integração com a SmartDocs é necessário observar alguns pontos:


  1. O Regional precisar ter em sua Base de dados, o usuário INT.SGE.iPaaS com o Perfil  de DBA.  Esse usuário será utilizado para acesso ao iPaaS.
  2. Verificar o contexto em cadastrado no SGE.

       

     3.  Importação das consultas SQL:

         

Expandir
titleParâmetros da IntegraçãoConfigurações
Table Excerpt
nameParametrosIntegracaoConfiguracaoAmbiente
Table Excerpt
nameConfiguracaoAmbiente

Além das premissas técnicas, é essencial o usuário definido no item anterior deverá realizar algumas configurações para garantir o sucesso da integração:

Acesse os Parâmetros as configurações através do seguinte caminho:

TOTVS Educacional > Sistema Indústria >Portal SESI> Parâmetros iPaas

Existem duas etapas para A interface exibirá sete abas para serem configurados: Identificação, Reconhecimento de Saberes, Cursos (segmentos), Situações de matrícula, Validação de e-mail, Funcionários e Autenticação SSOConfiguração de ambiente e Configuração de conta.


Essa aba refere-se a configurações para utilização de Consulta/validação de email pela Quickemail.

Os campos apresentados são:

URL API: Endereço de acesso à API para  consulta de e-mail, disponibilizado pela Educar Brasil;

TOKEN: Token de acesso à API para  consulta de e-mail, disponibilizado pela Educar Brasil.

Intervalo de horas: Este campo será considerado para validar novamente o e-mail na QuickeMail (somente daqueles que  não tenham sido considerados "válidos") respeitando o intervalo de horas definido no parâmetro. 

Image Removed

Deck of Cards
historyfalse
idParams

Nesta aba, são configurados os campos referentes ao Reconhecimento de Saberes.

Image Removed

Token para WS: Este recurso serve para gerar um Token do tipo Basic Authentication, o qual deve ser informado no Portal SESI para utilização da autenticação da comunicação com o SGE

Gerando...

Para gerar o Token deve ser informado o usuário e senha do usuário que será registrado a utilização da integração vinda do Portal SESI Educação.

Image Removed

É importante utilizar um usuário exclusivo.

Os demais campos, são para configurar os status e motivos de alteração para indicar quando a situação do aluno  for:

  • Reconhecimento de Saberes: Utilizado para identificar as disciplinas em Reconhecimento de Saberes, que precisam ser reconhecidas pelo Portal SESI Educação.
  • Competências reconhecidas:  Utilizado para alterar a situação das disciplinas certificadas no Reconhecimento de Saberes;
  • Motivo da alteração: Utilizado no Motivo Alteração, ao alterar a situação de matrícula para situação Competência Reconhecida automaticamente pelo processo.
  • Competências não reconhecidas: Utilizado para alterar a situação das disciplinas reprovadas no Reconhecimento de Saberes
  • Motivo da alteração: Utilizado no Motivo Alteração, ao alterar a situação de matrícula para situação Competência não Reconhecida automaticamente pelo processo.
  • Matricula no período letivo: Utilizado para alterar a situação da Matrícula no Período Letivo ao receber o retorno do Reconhecimento de Saberes e para identificação da matrícula em itinerário a ser considerada como Matriculado;
  • Motivo de alteração: Utilizado no Motivo Alteração, ao alterar a situação da Matrícula no Período Letivo automaticamente pelo processo.

Nesta aba deverá ser informado/cadastrado os cursos do SGE – Módulo Educacional (segmentos de ensino da Educação Básica indicadas no Portal SESI Educação (Educar Brasil)) para os quais somente alunos e professores/disciplinas de tais cursos serão integrados.

Image Removed

Junto a informação de cada curso deverá ser sinalizado se o e-mail do aluno (matriculado em tal curso) deverá ser obrigatório e também se alunos menores de 18 (dezoito) anos (matriculado em tal curso) deverão ter um responsável acadêmico informado. 

Cursos (Segmentos).gifImage Removed

Para integração dos alunos  no Portal SESI, o status do aluno é definido de acordo com sua Situação de Matrícula no SGE. 

Nesta aba o usuário deverá informar as situações de matricula no SGE, que o Portal SESI deve considerar como: Pré matriculado, Matriculado ou Inativo.

Image Removed

Ao incluir um novo registro será apresentado 3 campos para preenchimento:

Sit. Matricula: Lista  das as situações de matrículas existentes na base.

Status Indica: Status no Portal SESI, da situação de matricula selecionada. Podendo ser Pré matriculado, Matriculado ou Inativo.

Não enviar ao Portal SESI:  Se o checkbox "Não enviar ao Portal SESI" estiver marcado as matrículas com tal situação serão desprezadas para a integração.

Image Removed           Image Removed

Card
labelIdentificaçãoConfiguração de ambiente
Table Excerpt
nameparametrosidentificacao

Nesta aba, são configurados os campos básicos para o funcionamento da integração.

Image Removed

  • Habilita Integração Portal SESI Educação - O processo de integração pode estar agendado, mas a integração apenas irá ocorrer se este parâmetro estiver marcado. Tal parâmetro é valido para os registros de Alunos, Responsáveis Acadêmico, Professores, Diretor(es), Secretário(s), Coordenador(es) e Orientador Pedagógico para que seja realizada a integração de usuários para o Portal SESI Educação.
  • Dados da Integração:
    • Endereço de acesso ao webservice de integração, disponibilizado pela Educar Brasil;
    • Usuário do Portal SESI Educação para o consumo do webservice, disponibilizado pela Educar Brasil;
    • Chave de verificação para o consumo do webservice, disponibilizado pela Educar Brasil.
  • Classificação de Municípios (IBGE): Campo com lista de classificação de municípios (DCLASSIFMUNICIPIO), para o usuário selecionar em qual classificação de Município corresponde a do IBGE.
  • Dias para envio de turma finalizada: Neste campo o usuário deverá informará a quantidade de dias (em números)  em que uma turma finalizada será considerada na exportação.

Card
labelReconhecimento de Saberes
Table Excerpt
nameparametrosrecsabes
Card
labelCursos (Segmentos)
Table Excerpt
nameparametroscursos
Card
labelSituações de Matrícula
Table Excerpt
nameparametrossitmatric
Estado
colourGreen
titleExemplo:

Se a Escola  considerar que a situação de matricula "cancelado" do SGE deve ser enviada ao Portal SESI como Inativo, o preenchimento será da seguinte:

Image Removed

Se em determinado momento a Escola determinar que essa situação de matrícula não deve ser considerada na  Exportação ao Portal SESI é necessário marcar  o checkbox:

Image Removed

Aviso

Se o usuário do aluno estiver Ativo, o processo customizado de exportação ao Porlta SESI busca a informação  parametrizada nessa aba, para fazer a relação da situação de matricula do Aluno com status indica, identifcado se será ou não exportado.

Se o usuário do aluno estiver Inativo, o processo customizado já envia para o Portal SESI como Inativo.

Card
labelValidação de e-mail
Table Excerpt
nameparametrosvalidaemail
Card
labelFuncionários
Table Excerpt
nameparametrosfuncionarios

Na integração de Funcionários ao Portal SESI Educação os registros contêm uma propriedade indicando o perfil do funcionário.

Este cadastro deve ser utilizado para informar o perfil de cada Funcionário, que poderá ser:

  • Funcionário Administrativo (Perfil padrão do Portal SESI)
  • Funcionário Pedagógico e
  • Administrador de Unidade

Image Removed

Neste cadastro devem ser preenchidos os campos conforme a sua funcionalidade:

  1. Código da filial/escola: utilizado para identificar para qual filial se destina o funcionário que terá um perfil diferenciado do padrão. Um funcionário pode estar em mais de uma filial e com perfis diferentes;
  2. Código da Pessoa: mostrando apenas os funcionários a serem levados ao Portal SESI para filial selecionada no campo 1 que ainda não foram parametrizados, deve ser selecionado o funcionário ao qual se quer atribuir um perfil diferenciado para a filial selecionada;
  3. Perfil no Portal SESI Educação: utilizado para identificar qual perfil enviar ao Portal SESI, combo que permite selecionar entre os perfis: Funcionário Administrativo, Funcionário Pedagógico e Administrador de Unidade.

Image Removed

Aviso

Somente os funcionários cuja o perfil padrão (Funcionário Administrativo) não atenda as necessidades da Unidade que devem ser parametrizados neste cadastro.

etapa o usuário deverá realizar a configuração de ambiente, seguindo dos passos:

  • Conectando a empresa: Serviço Social da Indústria SESI 

Image Added



  •  Acesse o menu Ferramentas -> Aplicativos -> Busque por TOTVS RM

Image Added


  • Ao acessar o TOTVS RM é necessário cadastrar um ambiente adicional:

Image Added

Informe os dados:

  1. Nome do ambiente: Informe o nome do regional e tipo de ambiente;
  2. URL: A URL é composta pelos parâmetros: {ambiente}/api. Neste campo, deverá ser informado o endereço para que a integração tenha acesso ao ambiente que possua o SGE instalado.
  3. Tipo de autenticação: Selecione a opção ‘BASIC’.
Card
labelConfiguração de conta
Table Excerpt
nameparametrosrecsabes
  • tes
Card
labelAutenticação SSO
Esse parâmetro deve ser preenchido exclusivamente via importação do arquivo. Qualquer manipulação manual dos campos, resultará em falhas da funcionalidade.



Table Excerpt
nameparametrossso

Aba destinada à configuração de logins via SSO (Single Sign-On). 

Os campos são preenchidos automaticamente após a Importação do Arquivo (config_sesi.json) que é fornecido pelo Portal SESI

Image Removed

Abaixo descrição dos campos para conhecimento:

  • Endereço WebService: Endereço de acesso ao webservice disponibilizado pelo Portal SESI.
  • Public Key: chave pública para descriptografar o token JWT.
  • Client ID: usuáriode acesso ao webservice disponibilizado pelo Portal SESI.Secret Key: Senhade acesso ao webservice disponibilizado pelo Portal SESI.
  • Importar arquivo (config_sesi.json): Botão para importação das configurações via arquivo JSON*.
  • *Arquivo disponibilizado pelo Portal SESI.
    Aviso



    HTML
    <style>
    	.expand-control {
        	cursor: pointer;
        	text-decoration: none;
    	    margin-bottom: 10px;
    	    background-color: #ededed;
    	    height: 30px;
    	    font-size: 20px;
    	    padding: 5px;
    	}
    	.expand-control-text {
        	vertical-align: top;
    	    font-weight: bold;
    		color: #242424;
    	}
    	.post {
        	background-color: #378000;
    	    color: #ffffff;
    	    display: inline-block;
    	    padding: 5px;
    	    border-radius: 5px;
    		font-weight: bold;
    	}
    	.get {
        	background-color: #004fd6;
    	    color: #ffffff;
    	    display: inline-block;
    	    padding: 5px;
    	    border-radius: 5px;
    		font-weight: bold;
    	}
    	.put {
        	background-color: #ffa200;
    	    color: #ffffff;
    	    display: inline-block;
    	    padding: 5px;
    	    border-radius: 5px;
    		font-weight: bold;
    	}
    	.delete {
        	background-color: #cf0000;
    	    color: #ffffff;
    	    display: inline-block;
    	    padding: 5px;
    	    border-radius: 5px;
    		font-weight: bold;
    	}
    	.endereco{
    		display: inline-block;
    		padding: 5px;
    		font-weight: bold;
    	}
    </style>
    <!-- 
    EXEMPLO DE MARCAÇÃO PARA TIPO DE REQUEST:
    <div class="post">POST</div>
    <div class="get">GET</div>
    <div class="put">PUT</div>
    <div class="delete">DELETE</div>
    
    O ENDEREÇO DEVE SER INSERIDO COM A SEGUINTE MARCAÇÃO:
    <div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/ItemContabil</div>
    -->