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
titleRegras e diagramas
Expandir
titleIntegração de dados Oferta

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.

Expandir
titleIntegração de Curso

Estão disponíveis para consulta, os Cursos registrados na Coligada SESI no nível de ensino a selecionado pela SmartDocs. A SmartDocs tem a possibilidade de filtrar por nível de ensino e por curso.

Para os cursos que atenderam ao filtro da SmartDocs,  estará disponibilizado para consulta da os seguintes dados:


DescriçãoCampo do SGE
Id. do Curso

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

Nome do Curso 

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

Descrição do Curso

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


O diagrama no iPaaS é exibido desta forma:


Expandir
titleIntegração de Série

Consideramos para consulta da SmartDocs no iPaaS, todas as Séries associadas aos Cursos mencionados no item anterior, desde que tenham uma Matriz Curricular vinculada e sejam dos níveis de ensino indicados pelo filtro.

Para todos registros que atenderem ao filtro e regra descrito acima, serão enviados os dados abaixo:

DescriçãoCampo do SGE

Id. da série

Será disponibilizado  de forma concatenada:
SHABILITACAO.CODCOLIGADA|SHABILITACAO.CODCURSO|SHABILITACAO.CODHABILITACAO

Nome da série

Será disponibilizado  a descrição existente no no campo  SHABILITACAO.NOME

Código do Curso SCAE

SHABILITACAOCOMPL.CODCURSOSCAE

Produto / Serviço (SCAE)

SHABILITACAOCOMPL.CODSERVICOSCAE

Código Tipo Portfólio
Para Educação Continuada

SHABILITACAOCOMPL.CODTIPOPORTIFOLIO

Portfólio Nacional ou Regional? (N ou R)
Para Educação Continuada

SHABILITACAOCOMPL.TIPOPORTIFOLIO

Portfólio Nacional
Para Educação Continuada

SHABILITACAOCOMPL.CODTIPOPORTIFOLION

Portfólio Regional
Para Educação Continuada

SHABILITACAOCOMPL.CODTIPOPORTIFOLIOR



O diagrama no iPaaS é exibido desta forma:


Expandir
titleIntegração de matriz curricular

Consideramos para consulta da SmartDocs no iPaaS, todas as matrizes curriculares que estejam  vinculadas à Turmas vigentes* (*mais informações no tópico Integração de turmas), que tenham o status considerado "Ativo" (ativo ou atual) e sejam dos níveis de ensino indicados pelo filtro.

Para todos registros que atenderem ao filtro e regra descrito acima, serão enviados os dados abaixo:

DescriçãoCampo do SGE

Id. da Matriz Curricular

Disponibilizado de forma concatenada:
SGRADE.CODCOLIGADA|SGRADE.CODCURSO|SGRADE.CODHABILITACAO|SGRADE.CODGRADE

Descrição da Matriz Curricular

Campo com a descrição existente no cadastro da matriz curricular - SGRADE.DESCRICAO

Carga Horária

SGRADE.CARGAHORARIA

Status da Matriz - Indicador se o curso está Ativo ou Inativo

SGRADE.STATUS

Itinerários Formativos

SITINERARIOFORMATIVOGRADE.CODITINERARIOFORMATIVO

Expandir
titleIntegração de Período Letivo

Estão disponíveis para consulta do iPaaS, todos os períodos letivos que estejam  vinculados à Turmas vigentes* (*mais informações no tópico Integração de turmas) e sejam dos níveis de ensino e filiais indicados pelo filtro.

Para todos registros que atenderem aos filtros e regra descrito acima, serão enviados os dados abaixo:


DescriçãoCampo do SGE

Id.  do Período Letivo

SPLETIVO.CODCOLIGADA|SPLETIVO.IDPERLET

Nome do Período Letivo

SPLETIVO.DESCRIÇÃO

Data de início do Período Letivo

SPLETIVO.DTINICIO

Expandir
titleIntegração de Parametrização por curso (Turno)

Estão disponíveis para consulta da SmartDocs no iPaaS,  todas as Parametrizações por Curso que estejam  vinculados à Turmas vigentes* (*mais informações no tópico Integração de turmas) e sejam dos níveis de ensino e filiais indicados pelo filtro.

Para todos registros que atenderem aos filtros e regra descrito acima, serão enviados os dados abaixo:


DescriçãoCampo do SGE

Id da Parametrização por curso

Disponibilizado de forma concatenada:

SHABILITAÇÃOFILIALPL.CODCOLIGADA|SHABILITAÇÃOFILIALPL.IDPERLET|SHABILITAÇÃOFILIALPL.IDHABILITACAOFILIAL

Turno da Matriz Aplicada 

SHABILITAÇÃOFILIALPL.CODTURNO

Expandir
titleIntegração de Plano de pagamento e Parcelas

Consideramos para consulta da SmartDocs no iPaaS, os planos de pagamento e parcelas, que atendam as regras abaixo e sejam dos níveis de ensino e filiais indicados pelo filtro.

  • Planos de pagamentos vinculados a um período letivo vigente * (*mais informações no tópico Integração de Período Letivo);
  • Que possuam vínculos de habilitação enviados na Integração ‘Parametrização por Curso’  ( SHABILITACAOFILIAL (Curso + série +Matriz Curricular + Turno));
  • Estejam com a data de início e fim vigentes (SPLANOPGTO.DTINICIO - SPLANOPGTO.DTFIM).

Para cada plano de pagamento, serão disponibilizadas as ‘N’ parcelas vinculadas.

Para todos registros que atenderem aos filtros e regras descritas acima, serão enviados os dados abaixo:

DescriçãoCampo do SGE

Código  do Período Letivo

SPLANOPGTO.IDPERLET

Id.  do Plano de pagamento

Disponibilizado de forma concatenada:

SPLANOPGTO.CODCOLIGADA|SPLANOPGTO.IDPERLET|SPLANOPGTO.CODPLANOPGTO

Nome  do Plano de pagamento

SPLANOPGTO.NOME

Código da Parcela

SPARCELAPLANO.PARCELA
Serão enviadas todas as parcelas vinculadas ao plano de pagamento

Data de Vencimento da Parcela

SPARCELAPLANO.DTVENCIMENTO

Valor da Parcela

SPARCELAPLANO.VALOR

Expandir
titleIntegração de Turmas

Estão disponíveis para consulta da SmartDocs no iPaaS, todas as turmas vigentes, considerando a regra para identificação da vigência, sendo:

  • Serão consideradas Turmas que tenham a data de início (STURMA.DTINICIO) igual ou posteriores à data do momento em que a consulta está sendo realizada no iPaaS.
  • Turmas com datas de início anteriores a data atual (data de realização da consulta) não serão exibidas para consulta.

As turmas que atenderem as regras de vigências, serão disponibilizadas de acordo com os níveis de ensino e filiais indicados pelo filtro.

Para todos registros que atenderem ao filtro descrito acima, serão enviados os dados abaixo:


DescriçãoCampo do SGE

Código da Turma

Disponibilizado  de forma concatenada:

STURMA.CODCOLIGADA| STURMA.CODFILIAL| STURMA.IDPERLET|STURMA.CODTURMA

Descrição da Turma

STURMA. NOME

Data de Início da Turma

STURMA.DTINICIAL

Data de Término da Turma

STURMA.DTFINAL

Número Máximo de Alunos

STURMA.MAXALUNOS

Tipo de Mediação/ Modalidade

STURMA.TIPOMEDIACAO

Código da Turma no SCAE

STURMACOMPL.CODTURMASCAE

Empresa Parceira

STURMACOMPL.EMPRESAP

Expandir
titleIntegração de Turmas/disciplinas

Estão disponíveis para consulta da SmartDocs no iPaaS,  todas as Turmas/Disciplinas que estejam  vinculados à Turmas vigentes (mais informações no tópico Integração de turmas) estejam com data de início vigentes* (STURMADISC.DTINICIO) e sejam dos níveis de ensino e filiais indicados pelo filtro.

*A regra para identificar a vigência da turma/disciplina são as mesmas descritas no tópico anteriror.

Para todos registros que atenderem aos filtros e regra descrito acima, serão enviados os dados abaixo:

DescriçãoCampo do SGE

Id da Turma Disciplina

Disponibilizado de forma concatenada:

STURMADISC.CODCOLIGADA|

STURMADISC.IDTURMADISC

Data de Início da Turma Disciplina

STURMADISC.DTINICIAL

Data de Término da Turma Disciplina

STURMADISC.DTFINAL

Tipo  da Turma Disciplina
(Presencial, a distância, semi presencial)

STURMADISC.TIPO

Expandir
titleIntegração de Unidade

Estão disponíveis para consulta, todas as Filiais (Unidades) registradas na Coligada SESI no nível de ensino a selecionado pela SmartDocs. 

Para todos registros que atenderem ao filtro descrito acima, serão enviados os dados abaixo:

DescriçãoCampo do SGE

Coligada

Fixo = 2 

Considerando apenas a coligada SESI.

Id. Unidade/Filial - Contexto

Disponibilizado  de forma concatenada:

GFILIAL.CODCOLIGADA|GFILIAL.CODFILIAL

Os códigos de todas as  filiais cadastradas na Coligada.

Nível de Ensino

CODTIPOCURSO = 1 - Para nível de ensino referente a Educação Básica;

CODTIPOCURSO = 3  Para nível de ensino referente a Educação Continuada.

Unidade/Filial - SCAE

Será enviado o valor informado no campo livre 1:

Filial /Anexo - Dados Fiscais l Dados Adicionais / Campo Livre “1”.
DFILIAL.CAMPOLIVRE1

Expandir
titleIntegração de Situações de matrícula

Estão disponíveis para consulta, todas as Filiais (Unidades) registradas na Coligada SESI no nível de ensino a selecionado pela SmartDocs. 

Para todos registros que atenderem ao filtro descrito acima, serão enviados os dados abaixo:

DescriçãoCampo do SGE

Id. do Status

Disponibilizado de forma concatenada:

 SSTATUS.CODCOLIGADA |SSTATUS.CODSTATUS

Descrição da Situação de matrícula

Disponibilizados os valores informado na tabela SSTATUS.DESCRICAO




Informações
titleSituações de matrícula do template

Nível de Ensino: Educação Básica
Situação de Matrícula Aplicada a Matrícula na Turma (Matrícula no Período Letivo)


Código - Situação de Matrícula SCAE

Código - Situação de Matrícula SGE

Não se aplica

1 -  Pré Matriculado

1 – Matriculado

2 - Matriculado

5 – Trancamento

5 - Trancado

9 – Evasão

7 - Evadido

11 – Promoção/Aprovação

9 - Aprovado

13 – Reprovado

10 - Reprovado / 11 – Reprovado por Frequência

18 – Transferência Externa

3 - Transferência Externa / 33 – Transferência Externa (Somente PR)

19 – Transferência Interna

30 - Transferência Interna (PR não entra) / 32 – Transferência Escola (Somente PR)

20 – Transferência de Turma

31 - Transferência de Turma

21 – Desistente

6 - Desistente

22 – Falecido

45 – Falecido / 30 – Falecido (Somente PR)

23 – Reclassificado

32 - Reclassificado

24 – Reconhecimento de Saberes

70 - Reconhecimento de Saberes

53 - APL

123 - APL

54 - AEP

124 - AEP

55 - EPI

125 - EPI

*Situação de Matricula Aplicada a Disciplina (NOVA EJA e EJA Profissionalizante)


Código - Situação de Matrícula SCAE

Código - Situação de Matrícula SGE

1 – Matriculado

2 - Matriculado

12 – Concluinte

9 - Aprovado

26 – Competência Certificada

72 - Competência Certificada

27 – Dispensado

14 - Dispensado


Nível de Ensino: Educação Continuada


Código - Situação de Matrícula SCAE

Código - Situação de Matrícula SGE

1 – Matriculado

39 - Matriculado

9 – Evasão

67 - Evadido

12 – Concluinte

42 – Concluinte

13 – Reprovado

43 - Reprovado

17 – Participante

66 - Inscrito

18 – Transferência Externa

68 - Transferência Externa

19 – Transferência Interna

69 - Transferência Interna

20 – Transferência de Turma

46 - Transferência de Turma

21 – Desistente

41 - Desistente

22 – Falecido

73 - Falecido



         

Expandir
titleIntegração de dados Pessoas/Matrícula

Para que o SGE registre as matrículas, a SmartDocs disponibilizará os dados via iPaaS, as informações integrantes de uma rotina de matrícula (alunos e seus respectivos responsáveis), para consulta do SGE.

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

Expandir
titleIntegração de Pessoa

No SGE os registros de alunos e responsável acadêmico nascem no cadastro de Pessoas.

Para o registro de Pessoa (alunos e responsável acadêmico) serão considerados as seguintes ações:

  1. Ao recuperar o JSON disponibilizado pela SmartDocs, no IpaaS, é incluido o cadastro da Pessoa no SGE.  Antes da inclusão, será feita uma busca pelo CPF ou dados de unicidade de pessoas (Nome /nome social; data de nascimento; estado natal; naturalidade; nome da mãe). 

Caso a consulta encontre um registro com os mesmos dados citados acima, será realizada uma atualização  do registro da pessoa no SGE. Caso não seja encontrado, a integração realizará a inclusão da pessoa. 

        2. A inclusão ou atualização dos dados de pessoas, será feita considerando as informações descritas no quadro abaixo:

DescriçãoCampo do SGE

Nome

PPESSOA.NOME

Nome  Social

PPESSOA.NOMESOCIAL

Sexo - Correspondendo à 'feminino' | 'masculino'

PPESSOA.SEXO

Data de nascimento formatado em “dd-MM-yyyy”

PPESSOA.DTNASCIMENTO

Sigla do Estado Natal

PPESSOA.ESTADONATAL

Naturalidade

PESSOA.NATURALIDADE

Nacionalidade (Indicador Brasileiro)

PPESSOA.NACIONALIDADE

Estado Civil

PPESSOA.ESTADOCIVIL

Filiação/ Pai

VFILIACAO.CODPESSOAFILIACAO

Filiação/ Mãe

VFILIACAO.CODPESSOAFILIACAO

E-mail

Email do cadastro de pessoa (PPESSOA.EMAIL) 

Pessoa com deficiencia. Tipo:

Física, Auditiva, fala, visual,

mental, intelectual, reabilitado (BR)

PPESSOA.DEFICIENTEFISICO

PPESSOA.DEFICIENTEAUDITIVO

PPESSOA.DEFICIENTEVISUAL

PPESSOA.DEFICIENTEFALA

PPESSOA.DEFICIENTEMENTAL

PPESSOA.DEFICIENTEINTELECTUAL

PPESSOA.BRPDH

Identificador da Cor/Raça

PCORRACA.CODCLIENTE

Descrição da Cor/Raça

PCORRACA.DESCRICAO

CPF

PPESSOA.CPF

Carteira de identidade

PPESSOA.CARTIDENTIDADE

Sigla do Órgão emissor

PPESSOA.ORGEMISSORIDENT

Telefone Residencial

PPESSOA.TELEFONE1

Telefone Celular

PPESSOA.TELEFONE2

CEP

PPESSOA.CEP

Tipo da Rua

PPESSOA.CODTIPORUA

Logradouro

PPESSOA.RUA

Complemento (do endereço)

PPESSOA.COMPLEMENTO

Número

PPESSOA.NUMERO

Tipo do Bairro

PPESSOA.CODTIPOBAIRRO

Bairro

PPESSOA.BAIRRO

Sigla do Estado (do endereço)

PPESSOA.ESTADO

Cidade (do endereço)

PPESSOA.CIDADE

País (do endereço)

PPESSOA.PAIS


       3. Após inclusão/atualização da Pessoa no SGE, será retornado na requisição para Smartdocs o código das pessoas cadastradas.



Expandir
titleIntegração de Cliente Fornecedor

Alunos matriculados em cursos pagos* (*vinculados a plano de pagamentos com parcela), devem ter em seu registro um responsável financeiro, que pode ser uma pessoa física ou jurídica (PF ou PJ).

Esse registro é vinculado ao cadastro do aluno em um campo específico (Responsável Financeiro). 

DescriçãoCampo do SGE

Responsável Financeiro - Cadastro do Aluno

SALUNO.CODCFO

Para isso, será necessário as seguintes ações:

  1. A SmartDocs aciona a requisição de cadastro de Cliente Fornecedor e informa o código de pessoa retornado* (item 3 do tópico anterior).


Responsável financeiro Pessoa Física: Com a informação do código de pessoa retornado e sendo o responsável o pai, a mãe ou o próprio aluno, será cadastrado um cliente/fornecedor no SGE. Após esse cadastro, retornaremos o ID do responsável financeiro, composto pelo dado: Código cliente fornecedor (CODCFO).

Caso o responsável financeiro informado no formulário de matrícula seja uma pessoa física que não seja o pai, a mãe ou o próprio aluno, será necessário incluir essa pessoa, considerando os campos já descritos na HU.03.1.

O cadastro de cliente fornecedor será feito considerando os dados já passados na Integração de pessoas e utilizados na estrutura conforme descrito abaixo:

DescriçãoCampo do SGE

Nome

FCFO.NOME 

Nome  fantasia

FCFO.NOMEFANTASIA

Data de nascimento formatado em “dd-MM-yyyy”

FCFO.DTNASCIMENTO

Estado Civil

FCFO.ESTADOCIVIL

E-mail

Email do cadastro do cliente fornecedor (FCFO.EMAIL) 

Cliente/fornecedor

FCFO.CODCFO

Código gerado automaticamente pelo SGE.

CPF

FCFO.CGCCFO

Carteira de identidade

FCFO.IDENTIDADE

Órgão emissor

PPESSOA.CI_ORGAO

Telefone Residencial

FCFO.TELEFONE

Telefone Celular

FCFO.TELEX

CEP

FCFO.CEP

Tipo da Rua

FCFO.CODTIPORUA

Logradouro

FCFO.RUA

Complemento (do endereço)

FCFOCOMPLEMENTO

Número

FCFO.NUMERO

Estado (do endereço)

FCFO.CODETD

Cidade (do endereço)

FCFO.CODMUNICIPIO

País (do endereço)

FCFO.IDPAIS

Categoria

FCFO.PESSOAFISOUJUR

Preenchido pelo SGE como PF  caso seja retornado o CPF e como PJ caso tenha sido retornado um CNPJ.

Classificação

FCFO.PAGREC

Este campo será Preenchido pelo

SGE, de forma fixa, como Cliente

HTML
<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>
-->