Manual Operacional da customização - Integração SmartDocs


Objetivo

Este documento foi elaborado para informar aos usuários chave da área Educacional do SESI, sobre a Integração com a SmartDocs . O SESI DN implementou o programa de Transformação Digital de Serviços de Documentação Escolar e a gestão digital dos documentos é de responsabilidade da SmartDocs. Para que a integração aconteça O SGE disponibiliza para consulta os campos necessários, através do  TOTVS iPaaS.

Público Alvo
Este manual é destinado aos colaboradores selecionados como usuários chave do SESI.

Metodologia

Este material tem como base a visão prática e completa da customização para Integração SmartDocs.

A metodologia utilizada tem como ponto de partida o mapeamento completo do respectiva integração, relacionado com as os campos do Sistema TOTVS Educacional. Sempre que houver alguma atividade a ser realizada no Sistema, as suas funcionalidades e rotinas serão explicadas com detalhe.


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:

         

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

Acesse as configurações através do seguinte caminho:

TOTVS iPaas

Existem duas etapas para serem configurados: Configuração de ambiente e Configuração de conta.


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

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



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


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

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’.

Após a criação do ambiente, será necessário a criação da conta.

A opção de cadastro fica no mesmo caminho citado no cadastro de ambiente, basta clicar na opção ‘Contas’ -> Cadastrar conta.

Informe os dados:

  • Nome da Conta: Informe o nome do regional;
  • Ambiente: Selecionar o ambiente criado conforme no item Configuração de ambiente;
  • Tipo de Autenticação: Selecione a opção ‘BASIC’;
  • Username: Informar o usuário criado para acesso ao iPaaS, descrito no item permissões e orientações técnicas, deste manual.
  • Password: Informar a senha do usuário definido no campo acima.



Os dados necessários para integração de uma Oferta, serão disponibilizados no iPaaS pelo SGE. Desta forma a SmartDocs consulta esses dados, selecionando as informações necessárias para a realização da Matrícula. 

Seguindo as regras descritas nos próximos tópicos.

Estão disponíveis para consulta, os Cursos registrados na Coligada SESI no nível de ensino selecionado pela SmartDocs.

Desse cursos, consideramos os seguintes dados:


DescriçãoCampo do SGE
Id. do Curso

Será disponibilizado  de forma concatenada:
SCURSO.CODCOLIGADA|SCURSO.CODCURSO

Nome do Curso 

Será enviado a descrição existente no no campo  SCURSO.NOMECURSO.

Descrição do Curso

Será enviado a descrição existente no no campo  SCURSO.COMPLEMENTO


O diagrama no iPaaS é exibido desta forma:











         

Para que o SGE registre as matrículas, a SmartDocs disponibilizará os dados via iPaaS, para consulta do SGE. Seguindo as regras, descritas  nos próximos tópicos.


<style>
	.expand-control {
    	cursor: pointer;
    	text-decoration: none;
	    margin-bottom: 10px;
	    background-color: #ededed;
	    height: 30px;
	    font-size: 14px;
	    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>
-->