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 . A integração com o Portal SESI é responsável pela sincronização de algumas entidades, facilitando assim a gestão e acesso aos participantes (alunos, professores, funcionários)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.

...

Este material tem como base a visão prática e completa do processo customizado da área Educacional através da Integração Portal SESIda customização para Integração SmartDocs.

A metodologia utilizada tem como ponto de partida o mapeamento completo do respectivo processorespectiva integração, relacionado com as interfaces no 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.

...

O SGE possui valores para as suas tabelas, campos, cadastros, tipos que divergem com os valores atuais cadastrados no Portal SESI Educação. Além das parametrizações descritas acima, é

Para a integração é necessário ter valores equivalentes aos do Portal SESI Educação, antes de acionar o serviço que efetiva a integração. 
A funcionalidade 'Cadastro de DE/PARA' foi disponibilizada para criar esse relacionamento e equivalência entre os sistemas. 

O Cadastro está disponível no Menu:  TOTVS Educacional | Sistema Industria | Integradores | Portal SESI | DE/PARA da integração

Image Removed

A tela de cadastro do DE I PARA é composta por 4 campos que devem ser preenchidos seguindo a ordem: 

1- Entidade (Cadastro): Lista com 6 entidades que devem ter equivalências com o Portal SESI informada. Sendo elas:

• • Curso/segmento,
  • Disciplina
  • Habilitação/Serie
  • Área - Grupo de complemento
  • Área Itinerário
  • Itinerário

Image Removed

2- Curso: Lista com todos os cursos cadastrados na base. 

Image Removed

3- Valor no TOTVS Educacional: Lista da Entidade e Curso selecionado anteriormente. (No exemplo acima, foi selecionado a Entidade: Disciplina e o Curso: EF II, neste caso o valor no TOTVS Educacional trará todas as disciplinas do EF II).

Image Removed

4- Valor no Portal SESI Educação: Onde deve ser informado o código equivalente no Portal SESI Educação (validar com responsável pelo portal).

Image Removed

Após as configurações descritas acima, o usuário poderá executar o processo de Exportação.

A exportação de dados é responsável pelo envio das seguintes Entidades:

• Alunos (e responsáveis acadêmicos)
• Docentes
• Funcionários (Diretores escolares, secretários Escolares, orientadores, comissão coordenadores)
• Turmas
• Matriculas
• Aulas Docentes
• Oficinas (apenas para o Regional Paraná)

Antes de executar o processo é necessário que o usuário entenda as regras de cada Entidade que será integrada.

Serão exportadas as Matriculas dos alunos considerando:

Para integração de Aulas do Docente, será enviado a relação do Docente com as turmas/disciplinas:

Conhecendo a regra de cada Entidade que será exportada.  O usuário poderá executar o processo de Exportação através do Menu:

TOTVS Educacional | Sistema Industria | Integradores | Portal SESI | Exportação de Entidades

Image Removed

Executando manualmente o processo o usuário poderá selecionar uma ou mais entidades.

Image Removed

O resultado da exportação é registrado  no Monitor de log da integração, descrito no próximo tópico deste manual.

Após a exportação dos dados, cada exportação gera um determinado registro de Log.

O Monitor de Log, possibilita uma visão dos dados que foram enviados e o retorno de cada exportação. Ele estará disponível no Menu: 

TOTVS Educacional | Sistema Industria | Integradores | Portal SESI | DE/PARA da integração

Image Removed

Ao acessar a tela é apresentado todos os Registros da Exportação. Para facilitar o entendimento vamos apresenta-lo por Funcionalidade.

Image Removed

Cada Funcionalidade integrada, traz as informações de Log:

Image Removed

No anexo Item de log, é possível visualizar com mais detalhes os dados exportados:

Image Removed

Na tela do anexo temos acesso a:

Mensagem: descrição geral da execução do processo.

Exemplo: Criação do aluno realizada com sucesso.

Dados enviados: Aqui é possível verificar se todos os dados preenchidos foram enviados.

Exemplo de exportação de Pré Cadastro de Pessoa:

• Method= POST (criação) ou PUT (atualização)
• iduser = identificador único da pessoa no Portal SESI
• idred: será enviado fixo “7”
• codigoExterno: campo livre 1 (Cadastro de Filial: DFILIAL.CAMPOLIVRE1)

Dados recebidos: retorno da exportação.

Exemplo: “cadastro realizado com sucesso’’

Caso seja apresentado algum erro na exportação, é possível identificar qual regra foi violada, a partir da mensagem apresentada:

Image Removed

No exemplo acima, o Pré cadastro de pessoa nao foi exportado porque o "O campo Email não é um endereço de email válido."

Nesta situação, o usuário poderá corrigir o campo e realizar o  reenvio desse log, através do Processo: Reenvio de dados:

Image Removed

Os dados referentes a alunos, docentes e funcionários estão sujeitos a modificações após a exportação inicial. Quando essas alterações ocorrerem, ao realizar o processo de exportação novamente, a customização enviará ao Portal SESI apenas os campos que foram modificados.

Vale ressaltar que os campos que foram alterados não serão exportados novamente.

 Aluno na criação (Method =POST) não tinha registro de nome social. Atualizando o cadastro do aluno com a inclusão do nome social e realizado a exportação novamente, foi enviada a atualização (Method = PUT) com o nome social cadastrado (JULIO):

Image Removed  Image Removed

Foi incluído no Portal do aluno, um menu para que ele acesse o Portal SESI.

Quando os alunos clicarem nesse link, eles serão direcionados automaticamente para o Portal SESI, onde serão autenticados automaticamente, sem a necessidade de inserir suas informações de login novamente.

Image Removed

Também foi incluído no Portal do professor, um menu para que ele acesse o Portal SESI.

Quando os professores clicarem nesse link, eles serão direcionados automaticamente para o Portal SESI, onde serão autenticados automaticamente, sem a necessidade de inserir suas informações de login novamente.

Image Removed

O processo para Inativação de usuários - Portal SESI, possibilita inativação por completo do usuário no Portal SESI. 

O processo estará disponível no Menu: TOTVS Educacional | Sistema Industria | Integradores | Portal SESI:

Image Removed

Ao ser acionado o processo apresentará  na tela um lookup com a lista de usuários já integrados como Ativo no Portal SESI, para que o usuário selecione o que será inativado.

Image Removed

É permita a seleção de apenas um usuário por vez.

Atenção a mensagem exibida na tela: 

“ATENÇÃO:  Certifique-se que o usuário selecionado esteja correto. 

Ao executar o processo, o mesmo será inativado por completo no Portal SESI.”

Ao final da execução será exibido o log com o número de registros afetados, informando o sucesso da operação. Esse registro ficará gravado no Log Integração Portal SESI Educação.

Esse processo gera duas ações:

1. No SGE: O cadastro do usuário é alterado com a data da execução do processo (campo expiração de validade) e com o campo Ativo, desmarcado:

Image Removed

       2. Na próxima exportação de dados, o usuário será atualizado e enviado ao Portal SESI com o comando de inativação.

Acesse o menu: TOTVS Educacional | Sistema Indústria | Integrações | Integração Portal SESI. Dentro da opção, selecione o processo de Exportação de Dados do Portal SESI.

O processo de Exportação de Dados do Portal SESI será modificado para incluir o envio das informações das Oficinas da Regional Paraná. Será adicionado um novo checkbox chamado "Oficinas" na interface, permitindo que o usuário marque quando desejar enviar esses dados.

Este processo poderá ser executado manualmente pelo usuário, ou agendado.

Image Removed
 Ao executar o processo a customização irá considerar para envio as seguintes regras:

Será utilizado o parâmetro “Dias para envio da Turma Finalizada”, que terá seu nome alterado para “Dias para envio da Turma/Oficina Finalizada” para o Regional Paraná. Ele armazena o  número de dias considerados após o final da Oficina para identificar se ela deverá ser enviada. Será utilizado como base a Data final da Etapa Principal da Oficina.

Ao ocorrer qualquer alteração nos dados das oficinas enviadas ou inclusão/exclusão de professores vinculados à sala oficina, os dados atualizados serão enviados ao Portal SESI ao rodar o processo de exportação novamente.

<div class="post">POST</div>

Deverá ser utilizado antes do envio de uma pessoa (Aluno/Responsável/Docente/Funcionários) para o Portal SESI na intenção de identificar se reaproveita algum cadastro existente ou cria o pré-cadastro retornando o iduser correspondente.

Tabelas Afetadas: PPESSOA

Authorization - Basic Auth

Username <username>

Token <token>

Body

{
		"idred": 7,
		"regional": "AC",
		"codigoExterno": 1234567,
		"cpf": "862.873.376-05",
		"nome": "Adriano Duarte Cardoso",
		"nomeSocial": "",
		"email": "[email protected]",
		"dataNascimento": "22-04-2000",
		"naturalidade": 4110706,
		"nomeDaMae": "Ivone Duarte Cardoso"
	},
MensagemPSESI: {
		codigo (int, obrigatório),
		descricao (string, obrigatório)
}
RetornoPessoa: {
		iduser (int, obrigatório)
}

Content

• Idred: Identificador enviado de forma fixa o valor ‘7’.
• Regional: Estado do cadastro da Coligada.
• Código Externo: Código da Pessoa.
• CPF: CPF da pessoa no SGE 

• Nome: Nome da pessoa no SGE (Campo Obrigatório).

• Nome social: Nome social da pessoa.
• E-mail: Endereço de e-mail, que será gravado no campo do cadastro da Pessoa. (Campo Obrigatório). 

• Data de Nascimento: Data de Nascimento do Aluno no SGE (Campo Obrigatório).
• Naturalidade: Naturalidade do Aluno no SGE (Campo Obrigatório).  (DCODIFICACAOMUNICIPIO.CODIGO: Quando preenchido pelo cadastro de Município enviaremos: Código do IBGE recuperado pela Codificação de Município da Classificação correspondente ao IBGE, informado nos parâmetros. Caso esteja preenchido por texto enviaremos de forma fixa “1000001”).
• Nome da Mae:  Nome da mãe do aluno. ( Obrigatório caso não possua CPF informado).

Retorno

Usuário Criado com Sucesso: HTTP Code 201 - Body:  RetornoPessoa

Usuário Atualizado com Sucesso: HTTP Code 200 - Body:  RetornoPessoa

Possíveis retorno de erro:

Autenticação Inválida: HTTP Code 401 - Body: MensagemPSESI

Regra não atendida: HTTP Code 400 - Body: MensagemPSESI

Erro geral: HTTP Code 50x - Body: MensagemPSESI

Importante: Caso já tenhamos o idUser para o Cadastro de Pessoa utilizaremos o que já tivermos gravado e não chamaremos a API de Pré-Cadastro da Pessoa.

<div class="post">POST</div>

Deverá ser utilizado o iduser retornado no serviço PessoaSGE para efetivar o cadastro do aluno informando o correspondente a pessoa do aluno e o correspondente ao Responsável, os quais serão enviados todos seus dados pertinentes, mesmo que se repitam alguns nesta primeira interação de criação de aluno.

Tabelas Afetadas: SALUNO, PPESSOA

Interface RM: TOTVS Educacional | Educacional | Currículo e Oferta | Alunos

Authorization - Basic Auth

Username <username>

Token <token>

Body

{
		"iduser": 9999999,
		"idred": 7,
		"regional": "MG",
		"codigoExterno": 7654321,
		"dadosCadastrais": {
			"nome": "Rafaela Ribeiro Bravo",
			"nomeSocial": "",
			"email": "[email protected]",
			"codigoExterno": 7654321,
			"codUsuario": "14139508922",
			"cpf": "141.395.089-22",
			"senha": "MDQxMTE5zY=",
			"emailcomplementar": null,
			"sexo": "feminino",
			"dataNascimento": "05-11-2010",
			"idRaca": "2",
			"raca": "Branca",
			"naturalidade": 4124103,
			"nomeDaMae": "Wanda Ribeiro Bravo"
		},
		responsavel: {
  		"iduser": 8888888,
  		"nome": "Wanda Ribeiro Bravo",
		"nomeSocial": "",
  		"cpf": "187.685.859-18",
  		"codUsuario": "18768585918",
  		"email": "[email protected]",
 		"sexo": "feminino",
  		"codigoExterno": 7654321,
 		"senha": "MDQxMTE5zY=",
  		"dataNascimento": "05-11-1970",
		"idRaca": "2",
		"raca": "Branca",
		"naturalidade": 4124103,
		"nomeDaMae": "Sônia Maria Bravo"
	}
}

Content

• Iduser: Identificador da Pessoa Recuperado pelo serviço de Pré-Cadastro da Pessoa, do Portal SESI.
• Idred: Identificador enviado de forma fixa o valor ‘7’.
• Regional: Estado do cadastro da Coligada.
• Código Externo: Código da Pessoa.

• Nome: Nome do Aluno no SGE (Campo Obrigatório).

• Nome social: Nome social do cadastro
• E-mail: Endereço de e-mail do Aluno, que será gravado no campo do cadastro da Pessoa. (Campo Obrigatório);
• Código do usuário: Código do usuário no SGE.
• CPF: CPF do Aluno no SGE 
• Senha: Senha do usuário no SGE
• E-mail complementar: Caso o e-mail O365 (SALUNOCOMPL.EMAILO365) esteja preenchido o e-mail do cadastro de pessoa (PPESSOA.EMAIL) do aluno é enviado como e-mail complementar, do contrário nenhum e-mail é enviado como complementar.
• Sexo: Correspondendo a 'Feminino' I 'Masculino' (Campo Obrigatório);
• Data de Nascimento: Data de Nascimento do Aluno no SGE (Campo Obrigatório).
• Raça: Identificador da raça
• Naturalidade: Naturalidade do Aluno no SGE (Campo Obrigatório).  (DCODIFICACAOMUNICIPIO.CODIGO: Quando preenchido pelo cadastro de Município enviaremos: Código do IBGE recuperado pela Codificação de Município da Classificação correspondente ao IBGE, informado nos parâmetros. Caso esteja preenchido por texto enviaremos de forma fixa “1000001”).
• Nome da Mae:  Nome da mãe do aluno. ( Obrigatório caso não possua CPF informado).
• Email: Endereço de e-mail do Aluno, que será gravado no campo do cadastro da Pessoa.

Retorno

Aluno Criado com Sucesso: HTTP Code 201 - Body:  MensagemPSESI

Aluno Atualizado com Sucesso: HTTP Code 200 - Body:  MensagemPSESI

Possíveis retorno de erro:

Autenticação Inválida: HTTP Code 401 - Body: MensagemPSESI

Regra não atendida: HTTP Code 400 - Body: MensagemPSESI

Erro geral: HTTP Code 50x - Body: MensagemPSESI

Importante: Caso já tenhamos enviado com o Aluno com Sucesso, será utilizado o serviço de Atualização do Aluno.

<div class="put">PUT</div>

{
		"iduser": 9999999,
		"idred": 7,
		"regional": "MG",
		"codigoExterno": 7654321,
		"dadosCadastrais": {
			"nome": "Rafaela Ribeiro Bravo",
			"nomeSocial": "RAFAEL",
			"email": "[email protected]",
			"codigoExterno": 7654321,
			"codUsuario": "14139508922",
			"cpf": "141.395.089-22",
			"senha": "MDQxMTE5zY=",
			"emailcomplementar": null,
			"sexo": "feminino",
			"dataNascimento": "05-11-2010",
			"idRaca": "2",
			"raca": "Branca",
			"naturalidade": 4124103,
			"nomeDaMae": "Wanda Ribeiro Bravo"
		},
		responsavel: {
  		"iduser": 8888888,
  		"nome": "Wanda Ribeiro Bravo",
		"nomeSocial": "",
  		"cpf": "187.685.859-18",
  		"codUsuario": "18768585918",
  		"email": "[email protected]",
 		"sexo": "feminino",
  		"codigoExterno": 7654321,
 		"senha": "MDQxMTE5zY=",
  		"dataNascimento": "05-11-1970",
		"idRaca": "2",
		"raca": "Branca",
		"naturalidade": 4124103,
		"nomeDaMae": "Sônia Maria Bravo"
	}
}

<div class="post">POST</div>

Deverá ser utilizado o iduser retornado no serviço PessoaSGE para efetivar o cadastro do docente informando o correspondente a pessoa do docente, o qual será enviado todos seus dados pertinentes, mesmo que se repitam alguns nesta primeira interação de criação de docente.

Tabelas Afetadas: SALUNO, PPESSOA

Interface RM: TOTVS Educacional | Educacional | Currículo e Oferta | Professores

Authorization - Basic Auth

Username <username>

Token <token>

Body

{
		"iduser": 10012345,
		"idred": 7,
		"regional": "MG",
		"statusgeral": 1,
		"codigoExterno": 1919191,
		"escolas": [
			{
				"codigoIntegrador": "1234567",
				"ativo": 1
			}
		],
		"dadosCadastrais": {
			"nome": "Tiago Silva Salles",
			"nomeSocial": "",
			"email": "[email protected]",
			"codigoExterno": 1919191,
			"codUsuario": "36718678171",
			"cpf": "367.186.781-71",
			"senha": "MTIzNffNzg=",
			"emailcomplementar": null,
			"sexo": "masculino",
			"dataNascimento": "01-10-1978",
			"idRaca": "10",
			"raca": "Não declarado",
			"naturalidade": 4124400,
			"nomeDaMae": ""
		}
  

Content

• Iduser: Identificador da Pessoa Recuperado pelo serviço de Pré-Cadastro da Pessoa, do Portal SESI.
• Idred: Identificador enviado de forma fixa o valor ‘7’.
• Regional: Estado do cadastro da Coligada.
• Código integrador: Cadastro de Filial (DFILIAL.CAMPOLIVRE1)
• Ativo: Correspondente ao status do usuario no SGE (Verificamos o GUSUARIO.STATUS para definição de Ativo (1) e Inativo(0).
• Código Externo: Código da Pessoa.

• Nome: Nome do professor no SGE (Campo Obrigatório).

• Nome social: Nome social do cadastro
• E-mail: Endereço de e-mail do professor, que será gravado no campo do cadastro da Pessoa. (Campo Obrigatório). Caso o e-mail O365 (SPROFESSORCOMPL.EMAILO365) esteja preenchido este é enviado como principal, do contrário o e-mail do cadastro de pessoa (PPESSOA.EMAIL) do professor é enviado.
• Código do usuário: Código do usuário no SGE.
• CPF: CPF do professor no SGE 
• Senha: Senha do usuário no SGE
• E-mail complementar: Caso o email O365 (SPROFESSORCOMPL.EMAILO365) esteja preenchido o email do cadastro de pessoa (PPESSOA.EMAIL) do professor é enviado como email complementar, do contrário nenhum email é enviado como complementar.
• Sexo: Correspondendo a 'Feminino' I 'Masculino' (Campo Obrigatório);
• Data de Nascimento: Data de Nascimento do professor no SGE (Campo Obrigatório).
• Raça: Identificador da raça
• Naturalidade: Naturalidade do professor no SGE (Campo Obrigatório).  (DCODIFICACAOMUNICIPIO.CODIGO: Quando preenchido pelo cadastro de Município enviaremos: Código do IBGE recuperado pela Codificação de Município da Classificação correspondente ao IBGE, informado nos parâmetros. Caso esteja preenchido por texto enviaremos de forma fixa “1000001”).
• Nome da Mae:  Nome da mãe do professor. ( Obrigatório caso não possua CPF informado).
• Email: Endereço de e-mail do professor, que será gravado no campo do cadastro da Pessoa.

Retorno

Docente Criado com Sucesso: HTTP Code 201 - Body:  MensagemPSESI

Docente Atualizado com Sucesso: HTTP Code 200 - Body:  MensagemPSESI

Possíveis retorno de erro:

Autenticação Inválida: HTTP Code 401 - Body: MensagemPSESI

Regra não atendida: HTTP Code 403 - Body: MensagemPSESI

Erro geral: HTTP Code 50x - Body: MensagemPSESI

Importante: Caso já tenhamos enviado com o Docente com Sucesso, será utilizado o serviço de Atualização do Docente.

<div class="put">PUT</div>

{
		"iduser": 10012345,
		"idred": 7,
		"regional": "MG",
		"statusgeral": 1,
		"codigoExterno": 1919191,
		"escolas": [
			{
				"codigoIntegrador": "1234567",
				"ativo": 1
			}
		],
		"dadosCadastrais": {
			"nome": "Tiago Silva Salles",
			"nomeSocial": "",
			"email": "[email protected]",
			"codigoExterno": 1919191,
			"codUsuario": "36718678171",
			"cpf": "367.186.781-71",
			"senha": "MTIzNffNzg=",
			"emailcomplementar": [email protected],
			"sexo": "masculino",
			"dataNascimento": "01-10-1978",
			"idRaca": "10",
			"raca": "Não declarado",
			"naturalidade": 4124400,
			"nomeDaMae": ""
		}

<div class="put">PUT</div>

Deverá ser enviado as Turmas e Turmas/Disciplina Criando ou Atualizando - Sendo que na criação a chave é o conjunto idred|regional|turno|segmento|serie|turma e para atualização utilizar o idturma (a ser retornado pela API).

Tabelas Afetadas: STURMA , STURMADISC

Authorization - Basic Auth

Username <username>

Token <token>

Body