Fábrica de Software TOTVS BH

Atalhos

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

Versões comparadas

Versão antiga 18

changes.mady.by.user Vanessa de Sousa Carvalho

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Andre Oliveira de Souza

Gravado em

Chave

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

...

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 

Image Removed

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

Image Removed

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

Image Removed

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.

Image Removed

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 ousuá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.
Expandir
titleConfigurações
Table Excerpt
nameConfiguracaoAmbiente
Table Excerpt
nameConfiguracaoAmbiente
Deck of Cards
historyfalse
idParams
Card
label1º - Configuração de ambiente
Table Excerpt
nameparametrosidentificacao
Card
label2º - Configuração de conta
Table Excerpt
nameconfiguracaoconta

As configurações do ambiente iPaaS devem ser realizadas seguindo os passos descritos na documentação iPaaS - Configurações de ambiente e conta

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:

Image Added


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:

Image Added


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

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

da Matriz Curricular

Disponibilizado Será disponibilizado  de forma concatenada:
SCURSOSGRADE.CODCOLIGADA|SCURSOSGRADE.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:

Image Removed

Expandir
titleIntegração de Série

|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


O diagrama no iPaaS é exibido desta forma:

Image Added

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) 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 e filiais indicados pelo filtro.

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


SHABILITACAOCOMPL.CODTIPOPORTIFOLIOR

DescriçãoCampo do SGE

Id. da série  do Período Letivo

SPLETIVOSerá 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

O diagrama no iPaaS é exibido desta forma:

Image Removed

SPLETIVO.IDPERLET

Nome do Período Letivo

SPLETIVO.DESCRIÇÃO

Data de início do Período Letivo

SPLETIVO.DTINICIO


O diagrama no iPaaS é exibido desta forma:

Image Added


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

Estão disponíveis

Consideramos para consulta da SmartDocs no iPaaS, todas as matrizes curriculares  todas as Parametrizações por Curso que estejam  vinculadas vinculados à 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 e filiais indicados pelo filtro.

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


DescriçãoCampo do SGE

Id . da Matriz CurricularParametrização por curso

Disponibilizado de forma concatenada:

SGRADESHABILITAÇÃOFILIALPL.CODCOLIGADA|SGRADESHABILITAÇÃOFILIALPL.CODCURSOIDPERLET|SGRADE.CODHABILITACAO|SGRADE.CODGRADESHABILITAÇÃOFILIALPL.IDHABILITACAOFILIAL

Turno 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

Aplicada 

SHABILITAÇÃOFILIALPL.CODTURNO


O diagrama no iPaaS é exibido desta forma:


Image Added

Expandirexpand
titleIntegração de Período Letivode Plano de pagamento e Parcelas

Consideramos para consulta da SmartDocs no iPaaS, os planos de pagamento e parcelas, que atendam as regras abaixo 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)
  • 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 vinculadasEstã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 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 pagamentoId da Parametrização por curso

Disponibilizado de forma concatenada:

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

Turno da Matriz Aplicada 

SHABILITAÇÃOFILIALPL.CODTURNO

Expandir
titleIntegração de Plano de pagamento e Parcelas

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


O diagrama no iPaaS é exibido desta forma:

Plano de pagamento:

Image Added


Parcelas do plano:

Image Added

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

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 ao filtro descrito acima, serão enviados os dados abaixo:


DescriçãoCampo do SGE

Código  do Período Letivo

SPLANOPGTO.IDPERLET

Id.  do Plano de pagamento

Código da Turma

Disponibilizado  de

Disponibilizado de

forma concatenada:

SPLANOPGTO


STURMA.CODCOLIGADA| STURMA.CODFILIAL|

SPLANOPGTO

STURMA.IDPERLET|

SPLANOPGTO

STURMA.

CODPLANOPGTO

Nome  do Plano de pagamento

CODTURMA

Descrição da Turma

STURMA

SPLANOPGTO

. NOME

Código

Data de Início da

Parcela

Turma

SPARCELAPLANO

STURMA.

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

DTINICIAL

Data de

Vencimento

Término da

Parcela

Turma

SPARCELAPLANO

STURMA.

DTVENCIMENTO

Valor da Parcela

SPARCELAPLANO.VALOR

Expandir
titleIntegração de Turmas

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


O diagrama no iPaaS é exibido desta forma:


Image Added


STURMA. NOME
Expandir
titleIntegração de Turmas/disciplinas

Estão 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 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 ao filtro aos filtros e regra descrito acima, serão enviados os dados abaixo:

DescriçãoCampo do SGE
Código

Id da Turma Disciplina

Disponibilizado 

Disponibilizado de forma concatenada:

STURMA

STURMADISC.CODCOLIGADA

| STURMA.CODFILIAL| STURMA.IDPERLET

|

STURMA.CODTURMA

Descrição da Turma

STURMADISC.IDTURMADISC

Data de Início da Turma Disciplina

STURMA

STURMADISC.DTINICIAL

Data de Término da Turma Disciplina

STURMA

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

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

STURMADISC.TIPO


O diagrama no iPaaS é exibido desta forma:


Image Added


Expandir
titleIntegração de Turmas/disciplinasUnidade

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.

Filiais (Unidades) registradas na Coligada SESI no nível de ensino a selecionado pela SmartDocs. 

Para todos registros que atenderem ao filtro Para todos registros que atenderem aos filtros e regra 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 

Id da Turma Disciplina

Disponibilizado de forma concatenada:

STURMADISCGFILIAL.CODCOLIGADA|STURMADISCGFILIAL.IDTURMADISCCODFILIAL

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

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


O diagrama no iPaaS é exibido desta forma:


Image Added

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

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. do Status

Disponibilizado

Id. Unidade/Filial - Contexto

Disponibilizado  de forma concatenada:

GFILIAL SSTATUS.CODCOLIGADA |GFILIALSSTATUS.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

CODSTATUS

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

Disponibilizados os valores informado na tabela SSTATUS.DESCRICAO


O diagrama no iPaaS é exibido desta forma:


Image Added


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

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 12 – TrancamentoConcluinte

5 9 - TrancadoAprovado

9 26 – EvasãoCompetência Certificada

7 72 - EvadidoCompetência Certificada

11 27 – Promoção/AprovaçãoDispensado

9 14 - AprovadoDispensado


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

10 43 - Reprovado / 11 – Reprovado por Frequência

17 – Participante

66 - Inscrito

18 – Transferência Externa

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

19 – Transferência Interna

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

20 – Transferência 20 – Transferência de Turma

31 46 - Transferência de Turma

21 – Desistente

6 41 - 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

         

73 - Falecido



         

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

Para que o SGE registre as matrículas, a SmartDocs disponibilizará 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.


O diagrama no iPaaS é exibido desta forma:

Pessoa:

Image Added


Filiação: 


Image Added

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 no tópico anterior.

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

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

Para que o SGE registre as matrículas, a SmartDocs disponibilizará 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. 

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 no tópico anterior.

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

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:

PPESSOANOME SocialPPESSOANOMESOCIALPPESSOA.NACIONALIDADEPPESSOAVFILIACAO.CODPESSOAFILIACAO de pessoa (PPESSOA.EMAIL) PPESSOA.CPFPPESSOACARTIDENTIDADESigla do ORGEMISSORIDENTPPESSOATELEFONE1Sigla do Estado
DescriçãoCampo do SGE

Nome

FCFO.

NOME 

Nome 

fantasia

FCFO.

Sexo - Correspondendo à 'feminino' | 'masculino'

PPESSOA.SEXO

NOMEFANTASIA

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

PPESSOA.DTNASCIMENTO

Sigla do Estado Natal

PPESSOA.ESTADONATAL

Naturalidade

PESSOA.NATURALIDADE

Nacionalidade (Indicador Brasileiro)

FCFO.DTNASCIMENTO

Estado Civil

FCFO.ESTADOCIVIL

Filiação/ Pai

VFILIACAO.CODPESSOAFILIACAO

Filiação/ Mãe

E-mail

Email do cadastro

do cliente fornecedor (FCFO.EMAIL) 

Cliente/fornecedor

FCFO.CODCFO

Código gerado automaticamente pelo SGE.

CPF

FCFO.CGCCFO

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

Carteira de identidade

FCFO.

IDENTIDADE

Órgão emissor

PPESSOA.

CI_ORGAO

Telefone Residencial

FCFO.

TELEFONE

Telefone Celular

PPESSOA.TELEFONE2

FCFO.TELEX

CEP

FCFO.CEP

Tipo da Rua

FCFO.CODTIPORUA

Logradouro

FCFO.RUA

Complemento

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

(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

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


Responsável financeiro Pessoa Jurídica:A SmartDocs irá acionar a requisição de cadastro de Cliente Fornecedor, sem enviar a informação do cod pessoa.  Neste caso, o cadastro do responsável seguirá as regras para cadastro do Cliente/fornecedor, sendo elas:

  • Antes da inclusão, será feita uma busca pelo CNPJ.
  • Caso a consulta encontre um registro com os mesmos dados citados acima, será realizada uma atualização do registro de cliente fornecedor.
  • Caso não seja encontrado, a integração realizará a inclusão.

A inclusão será feita considerando os campos descritos no quadro

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

Telefone Residencial
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

E-mail

Email do cadastro do cliente fornecedor (FCFO.EMAIL) 

Cliente/fornecedor

FCFO.CODCFO

Código gerado automaticamente pelo SGE.

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 é Preenchido pelo SGE, de forma fixa, como Cliente

CPF/CNPJ

FCFO.CGCCFO

Telefone Comercial

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

Responsável financeiro Pessoa Jurídica:A SmartDocs irá acionar a requisição de cadastro de Cliente Fornecedor, sem enviar a informação do cod pessoa.  Neste caso, o cadastro do responsável seguirá as regras para cadastro do Cliente/fornecedor, sendo elas:
  • Antes da inclusão, será feita uma busca pelo CNPJ.
  • Caso a consulta encontre um registro com os mesmos dados citados acima, será realizada uma atualização do registro de cliente fornecedor.
  • Caso não seja encontrado, a integração realizará a inclusão.

A inclusão será feita considerando os campos descritos no quadro abaixo:

DescriçãoCampo do SGE

Nome

FCFO.NOME 

Nome  fantasia

FCFO.NOMEFANTASIA

E-mail

Email do cadastro do cliente fornecedor (FCFO.EMAIL) 

Cliente/fornecedor

FCFO.CODCFO

Código gerado automaticamente pelo SGE.

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 é Preenchido pelo SGE, de forma fixa, como Cliente

CPF/CNPJ

FCFO.CGCCFO

Telefone Comercial

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

FCFO.IDPAIS


O diagrama no iPaaS é exibido desta forma:


Image Added

Expandir
titleIntegração de Aluno

Após o cadastro de pessoa e cliente fornecedor , descritos nos tópicos acima, será necessário inserir um cadastro de Aluno, vincular a pessoa criada e seus responsáveis (acadêmico e financeiro) . 

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

  1. Que a SmartDocs acione a requisição de cadastro de aluno e informe no campo ‘CodPessoa’, o código de pessoa retornado (HU.03.1).
  2. Além das informações existentes no cadastro de pessoa, será necessário enviar os seguintes dados:
DescriçãoCampo do SGE

Código do Estudante no Sistema do DR

Aluno | Identificação | Campo Complementar | Código do Aluno no SCAE

SALUNOCOMPL.CODALUNOSCAE

Envia o código SCAE do Aluno.
*A obrigatoriedade desse campo se aplica a casos de rematrícula.

Motivo CPF não informado

SALUNOCOMPL. MOTIVOCPF

Este campo é obrigatório apenas para casos de alunos que não possuem CPF.

Neste campo consideramos receber os códigos:

1- Menor de 18 anos
2- Apenado
3- Indígena
4- Estrangeiro
5- Responsável se recusou a tirar o CPF do filho menor de idade.

Dados extraídos da tabela dinâmica template SGE.

NIT (PIS/PASEP)

SALUNOCOMPL.NIT

Envia o número NIT do Aluno

Responsável Acadêmico - Código da Pessoa

SALUNO.CODPESSOARACA
Envia o código retornado da integração de pessoa.

Responsável Financeiro - Cadastro do Aluno

SALUNO.CODCFO
Envia o código retornado a Integração de Cliente fornecedor.


     3. Com a inclusão do aluno, é realizado os vínculos dos responsáveis, já descritos nos tópicos acima.

    • Alunos menores de idade: Para alunos menores de idade, o responsávelacadêmico deve ser preenchido de forma obrigatória.
    • Matrículas em cursos pagos: Para alunos que serão matriculados em cursos pagos, o responsável financeiro (ainda que seja o próprio aluno) deve ser preenchido de forma obrigatória.
    • Alunos que não possuem CPF: Nesses casos, o campo complementar Motivo CPF não informado, deve ser preenchido de forma obrigatória. 

     4. Após inclusão/atualização do aluno no SGE, será retornado para Smartdocs o ID do aluno, que será composto pelos dados concatenados: Coligada | RA.


O diagrama no iPaaS é exibido desta forma:


Image Added

Aluno | Identificação | Campo Complementar | Código do Aluno no SCAE
SALUNOCOMPL.CODALUNOSCAE

Envia o código SCAE do Aluno.
*A obrigatoriedade desse campo se aplica a casos de rematrícula.

SALUNOCOMPL. MOTIVOCPF

Este campo é obrigatório apenas para casos de alunos que não possuem CPF.

Neste campo consideramos receber os códigos:

1- Menor de 18 anos
2- Apenado
3- Indígena
4- Estrangeiro
5- Responsável se recusou a tirar o CPF do filho menor de idade.
Dados extraídos da tabela dinâmica template SGE.SALUNO.CODCFO
Envia o código retornado a Integração de Cliente fornecedor.

     3. Com a inclusão do aluno, é realizado os vínculos dos responsáveis, já descritos nos tópicos acima.

Alunos menores de idade: Para alunos menores de idade, o responsávelacadêmico deve ser preenchido de forma obrigatória.
  • Matrículas em cursos pagos: Para alunos que serão matriculados em cursos pagos, o responsável financeiro (ainda que seja o próprio aluno) deve ser preenchido de forma obrigatória.
      • Alunos que não possuem CPF: Nesses casos, o campo complementar Motivo CPF não informado, deve ser preenchido de forma obrigatória. 

         4. Após inclusão/atualização do aluno no SGE, será retornado para Smartdocs o ID do aluno, que será composto pelos dados concatenados: Coligada | RA.

    SMATRICPL.CODTIPOMAT
    Expandir
    titleIntegração da Matrícula no Período letivo

    O cadastro da matrícula no período letivo, representa que um determinado aluno está matriculado em algum período letivo e cursando uma habilitação/Filial.

    Expandir
    titleIntegração de Aluno

    Após o cadastro de pessoa e cliente fornecedor , descritos nos tópicos acima, será necessário inserir um cadastro de Aluno, vincular a pessoa criada e seus responsáveis (acadêmico e financeiro) . 

    Após registros de Pessoa, responsáveis e aluno é necessário incluir para cada aluno a sua respectiva matrícula.

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

    1. Que a SmartDocs acione a requisição de cadastro de aluno e informe no campo ‘CodPessoa’, o código de pessoa retornado (A SmartDocs informa no campo ‘idAluno’ (passado na requisição), o ID retornado, composto por COLIGADA | RA, conforme descrito na história HU.03.1)3.

    Além das informações existentes no cadastro de

    pessoa

    aluno, será necessário enviar

    os seguintes dados:
    DescriçãoCampo do SGE

    Código do Estudante no Sistema do DR

    Motivo CPF não informado

    NIT (PIS/PASEP)

    SALUNOCOMPL.NIT

    Envia o número NIT do Aluno

    Responsável Acadêmico - Código da Pessoa

    SALUNO.CODPESSOARACA
    Envia o código retornado da integração de pessoa.

    Responsável Financeiro - Cadastro do Aluno

    Expandir
    titleIntegração da Matrícula no Período letivo

    os seguintes dados:

    DescriçãoCampo do SGE

    Código do Tipo de Matrícula 

    SMATRICPL.CODTIPOMAT

    Neste campo consideramos receber os códigos:

    1 - Novato

    2 - Veterano

    7 - Dependente

    Dados extraídos da tabela dinâmica template SGE.

    Situação de Matrícula (Cod Status)

    Enviar o código da situação de matrícula (Conforme está descrito no Tópico Integração Situação de matrícula).

    Data da Matrícula 

    SMATRICPL.DTMATRICULA

     Formatado em “dd-MM-yyyy”

    Data de Previsão de Término do Curso

    SMATRICPLCOMPL.DTTERMINO

    Matrícula no Período Letivo | Campos Complementares | Data de Previsão de Término do Curso

    Formatado em “dd-MM-yyyy”

    Código da matrícula no sistema do DR - SCAE

    SMATRICPLCOMPL.CODMATRICULASCAE

    Matrícula no Período Letivo | Campos Complementares | Código da Matrícula (SCAE)

    Indicador EBEP

    SMATRICPLCOMPL.EBEP

    Matrícula no Período Letivo | Campos Complementares | EBEP

    Neste campo consideramos receber os códigos:

    0 - Não

    1 - Sim

    Dados extraídos da tabela dinâmica template SGE.

    Indicador Tempo Integral

    SMATRICPLCOMPL.TEMPOINTEGRAL

    Matrícula no Período Letivo | Campos Complementares | Tempo Integral

    Neste campo consideramos receber os códigos:

    0 - Não

    1 - Sim

    Dados extraídos da tabela dinâmica template SGE.

    Indicador Vira Vida

    SMATRICPLCOMPL.VIRAVIDA

    Matrícula no Período Letivo | Campos Complementares | Vira Vida

     Neste campo consideramos receber os códigos:

    0 - Não

    1 - Sim

    Dados extraídos da tabela dinâmica template SGE.

    Código do Financiamento

    SMATRICPLCOMPL.CODFINANC

    Matrícula no Período Letivo | Campos Complementares | Código do Financiamento (SCAE)
    Neste campo consideramos receber os códigos:
    1 - Pago

    2 - Gratuidade Regulamentar

    3 - Gratuidade Não Regulamentar

    Dados extraídos da tabela dinâmica template SGE.

    Código do Vínculo

    SMATRICPLCOMPL.CATEGORIA

    Matrícula no Período Letivo | Campos Complementares | Categoria

    O cadastro da matrícula no período letivo, representa que um determinado aluno está matriculado em algum período letivo e cursando uma habilitação/Filial.

    Após registros de Pessoa, responsáveis e aluno é necessário incluir para cada aluno a sua respectiva matrícula. Para isso, será necessário as seguintes ações:

    1. A SmartDocs informa no campo ‘idAluno’ (passado na requisição), o ID retornado, composto por COLIGADA | RA, conforme descrito na história HU.03.3.

    Além das informações existentes no cadastro de aluno, será necessário enviar os seguintes dados:

    DescriçãoCampo do SGE

    Código do Tipo de Matrícula 

    Neste campo consideramos receber os códigos:
    1 -

    Novato

    Trabalhador da Indústria

    2 -

    Veterano

    Funcionário SESI/SENAI

    3

    7

    - Dependente

    Dados extraídos da tabela dinâmica template SGE.

    Situação de Matrícula (Cod Status)

    Enviar o código da situação de matrícula (Conforme está descrito no Tópico Integração Situação de matrícula).

    Data da Matrícula 

    SMATRICPL.DTMATRICULA

     Formatado em “dd-MM-yyyy”

    Data de Previsão de Término do Curso

    SMATRICPLCOMPL.DTTERMINO

    Matrícula no Período Letivo | Campos Complementares | Data de Previsão de Término do Curso

    Formatado em “dd-MM-yyyy”

    Código da matrícula no sistema do DR - SCAE

    SMATRICPLCOMPL.CODMATRICULASCAE

    da Indústria

    4 - Docente

    5 - Comunidade

    Dados extraídos da tabela dinâmica template SGE.

    CNPJ da empresa

    ao qual o estudante é vinculado

    (quando Trabalhador/Dependente da Indústria e Comunidade por Demanda da Indústria)

    SMATRICPLCOMPL.CNPJEMPRESA

    Matrícula no Período Letivo | Campos Complementares |

    Código da Matrícula (SCAE)

    Indicador EBEP

    CNPJ da Empresa

    CEI da empresa

    ao qual o estudante é vinculado

    (quando Trabalhador/Dependente da Indústria e Comunidade por Demanda da Indústria)

    SMATRICPLCOMPL.CEI

    SMATRICPLCOMPL.EBEP

    Matrícula no Período Letivo | Campos Complementares |

    EBEP

    Neste campo consideramos receber os códigos:

    0 - Não

    1 - Sim

    Dados extraídos da tabela dinâmica template SGE.

    Indicador Tempo Integral

    CNPJ da Empresa

    Razão Social da Empresa Vínculo

    (quando Trabalhador/Dependente da Indústria e Comunidade por Demanda da Indústria)

    SMATRICPLCOMPL.NOMEEMPRESA

    SMATRICPLCOMPL.TEMPOINTEGRAL

    Matrícula no Período Letivo | Campos Complementares |

    Tempo Integral

    Neste campo consideramos receber os códigos:

    0 - Não

    1 - Sim

    Dados extraídos da tabela dinâmica template SGE.

    Indicador Vira Vida

    SMATRICPLCOMPL.VIRAVIDA

    Matrícula no Período Letivo | Campos Complementares | Vira Vida

     Neste campo consideramos receber os códigos:

    0 - Não

    1 - Sim

    Dados extraídos da tabela dinâmica template SGE.

    Código do Financiamento

    SMATRICPLCOMPL.CODFINANC

    Matrícula no Período Letivo | Campos Complementares | Código do Financiamento (SCAE)

    Nome  da Empresa

    ,

    Expandir
    titleIntegração de Matricula nas disciplinas

    No SGE, alunos matriculados em um Período Letivo, também são matriculados em disciplinas.

    Esse cadastro informa que um determinado aluno está matriculado nas disciplinas daquele curso.

    Consideramos o preenchimento dos campos abaixo:

    DescriçãoCampo do SGE

    Identificador da Turma Disciplina

    STURMADISC.CODCOLIGADA|

    STURMADISC.IDTURMADISC

    (Conforme enviado no item HU.02.8.

    Código do Tipo de Matrícula 

    SMATRICPL.TIPOMAT

    Neste campo consideramos receber os códigos:

    1 -

    Pago

    Novato

    2 -

    Gratuidade Regulamentar

    Veterano

    3

    7 -

    Gratuidade Não Regulamentar

    Dependente

    Dados extraídos da tabela dinâmica template SGE.

    Situação de Matrícula (Cod Status)

    Enviar o código da situação de matrícula (Conforme tabela enviada no HU.02.

    Código do Vínculo

    SMATRICPLCOMPL.CATEGORIA

    Matrícula no Período Letivo | Campos Complementares | Categoria

    Neste campo consideramos receber os códigos:
    1 - Trabalhador da Indústria

    2 - Funcionário SESI/SENAI

    3 - Dependente da Indústria

    4 - Docente

    5 - Comunidade

    Dados extraídos da tabela dinâmica template SGE.

    CNPJ da empresa

    ao qual o estudante é vinculado

    (quando Trabalhador/Dependente da Indústria e Comunidade por Demanda da Indústria)

    SMATRICPLCOMPL.CNPJEMPRESA

    Matrícula no Período Letivo | Campos Complementares | CNPJ da Empresa

    CEI da empresa

    ao qual o estudante é vinculado

    (quando Trabalhador/Dependente da Indústria e Comunidade por Demanda da Indústria)

    SMATRICPLCOMPL.CEI

    Matrícula no Período Letivo | Campos Complementares | CNPJ da Empresa

    Razão Social da Empresa Vínculo

    (quando Trabalhador/Dependente da Indústria e Comunidade por Demanda da Indústria)

    SMATRICPLCOMPL.NOMEEMPRESA

    Matrícula no Período Letivo | Campos Complementares | Nome  da Empresa

    ,

    Expandir
    titleIntegração de Matricula nas disciplinas

    No SGE, alunos matriculados em um Período Letivo, também são matriculados em disciplinas.

    Esse cadastro informa que um determinado aluno está matriculado nas disciplinas daquele curso.

    Consideramos o preenchimento dos campos abaixo:

    DescriçãoCampo do SGE

    Identificador da Turma Disciplina

    STURMADISC.CODCOLIGADA|

    STURMADISC.IDTURMADISC

    (Conforme enviado no item HU.02.8.

    Código do Tipo de Matrícula 

    SMATRICPL.TIPOMAT

    Neste campo consideramos receber os códigos:
    1 - Novato

    2 - Veterano

    7 - Dependente

    Dados extraídos da tabela dinâmica template SGE.

    Situação de Matrícula (Cod Status)

    Enviar o código da situação de matrícula (Conforme tabela enviada no HU.02.10).

    Data da Matrícula 

    SMATRICPL.DTMATRICULA

     Formatado em “dd-MM-yyyy”

    Expandir
    titleIntegração de contrato (Processo nativo)

    Ao finalizar uma matrícula no SGE, nativamente pode ser gerado um contrato para o aluno (conforme parametrização de cada Regional) no SGE.

    Para cursos pagos, onde é gerado um contrato financeiro, ocorre também, o vínculo de um Plano de pagamento e responsável financeiro para cada aluno. 

    Não haverá ação da integração para gestão dos contratos, planos de pagamento e parcelas. A gestão de inclusão de contrato ocorrerá de forma nativa, de acordo com as parametrizações de cada Regional.

    Atenção as parametrizações abaixo são de responsabilidade do usuário:

    DescriçãoCampo do SGE

    Código  do Plano de pagamento

    SCONTRATO..CODPLANOPGTO

    Essa informação faz parte da integração do plano de pagamento, já descrito neste manual

    Responsável financeiro

    Responsável financeiro vinculado ao cadastro do aluno, conforme descrito em Integração Cliente forncedor.

    Expandir
    titleIntegração de Rematrícula

    A rematrícula é o processo pelo qual um aluno já matriculado no SGE, se reinscreve para continuar seus estudos no ano letivo seguinte.

    Nestes casos, não é necessário um novo cadastro do aluno, o SGE utiliza o mesmo cadastro para vinculá-lo ao novo período letivo.

    Sendo assim, ao receber uma rematrícula, a SmartDocs disponibilizará via iPaaS, todos os dados descritos para inclusão de Pessoas/matriculas, considerando o envio específico de alguns, como por exemplo:

    1. Tipo de Matrícula: Para identificar os alunos que devem passar pelo processo de rematrícula, o campo Tipo de matrícula (SMATRICPL.CODTIPOMAT) deverá ser enviado com o código 2 - Veterano.
    2. Código SCAE do Aluno: Para os alunos veteranos, será necessário que o código de matrícula SCAE seja enviado de forma obrigatória.
    Aviso
    titleImportante

    As configurações necessárias para que o processo nativo de rematrícula aconteça, permanecem sem alterações. Sendo de responsabilidade do Regional.  

    Ex.: Ter o próximo período letivo cadastrado, informar o código do “próximo curso” e “próxima série” na matriz curricular; informar a “próxima turma” no cadastro de turmas, etc

    10).

    Data da Matrícula 

    SMATRICPL.DTMATRICULA

     Formatado em “dd-MM-yyyy”


    O diagrama no iPaaS é exibido desta forma:


    Image Added

    Expandir
    titleIntegração de contrato (Processo nativo)

    Ao finalizar uma matrícula no SGE, nativamente pode ser gerado um contrato para o aluno (conforme parametrização de cada Regional) no SGE.

    Para cursos pagos, onde é gerado um contrato financeiro, ocorre também, o vínculo de um Plano de pagamento e responsável financeiro para cada aluno. 

    Não haverá ação da integração para gestão dos contratos, planos de pagamento e parcelas. A gestão de inclusão de contrato ocorrerá de forma nativa, de acordo com as parametrizações de cada Regional.

    Atenção as parametrizações abaixo são de responsabilidade do usuário:

    DescriçãoCampo do SGE

    Código  do Plano de pagamento

    SCONTRATO..CODPLANOPGTO

    Essa informação faz parte da integração do plano de pagamento, já descrito neste manual

    Responsável financeiro

    Responsável financeiro vinculado ao cadastro do aluno, conforme descrito em Integração Cliente forncedor.

    Expandir
    titleIntegração de Rematrícula

    A rematrícula é o processo pelo qual um aluno já matriculado no SGE, se reinscreve para continuar seus estudos no ano letivo seguinte.

    Nestes casos, não é necessário um novo cadastro do aluno, o SGE utiliza o mesmo cadastro para vinculá-lo ao novo período letivo.

    Sendo assim, ao receber uma rematrícula, a SmartDocs disponibilizará via iPaaS, todos os dados descritos para inclusão de Pessoas/matriculas, considerando o envio específico de alguns, como por exemplo:

    1. Tipo de Matrícula: Para identificar os alunos que devem passar pelo processo de rematrícula, o campo Tipo de matrícula (SMATRICPL.CODTIPOMAT) deverá ser enviado com o código 2 - Veterano.
    2. Código SCAE do Aluno: Para os alunos veteranos, será necessário que o código de matrícula SCAE seja enviado de forma obrigatória.


    Aviso
    titleImportante

    As configurações necessárias para que o processo nativo de rematrícula aconteça, permanecem sem alterações. Sendo de responsabilidade do Regional.  

    Ex.: Ter o próximo período letivo cadastrado, informar o código do “próximo curso” e “próxima série” na matriz curricular; informar a “próxima turma” no cadastro de turmas, etc.

    Expandir
    titleMonitoramento de dados - Visor no iPaaS

    O usuário responsável pelas configurações no iPaaS ( INT.SGE.iPaaS com o Perfil  de DBA - Descrito no tópico Permissões e orientações técnicas), terá acesso ao  menu de monitoramento do TOTVS iPaaS.

    Os principais  menus para acesso dos dados estão disponíveis em:

    Menu Monitoramento > Monitor

    Image Added



    O Monitor do iPaaS permite um acesso aos dados trafegados e o usuário poderá utilizar alguns filtros, conforme descrito abaixo.

    • Filtro por data

    As opções para seleção, são:

    • Hoje, 
    • Últimos 7 dias, 
    • Últimos 15 dias, 
    • Últimos 30 dias e 
    • Personalizado

    Image Added


    Selecionando a opção  ‘personalizado’, o usuário pode determinar um período de consulta. Conforme imagem abaixo:

    Image Added


    • Filtro por situação:

    As opções para seleção, são:

    • Todos, 
    • Processada, 
    • Não processada, 
    • Reprocessada e 
    • Processando.

    Image Added


    • Filtro integração:

    Neste filtro o usuário pode selecionar uma ou mais  interações desenvolvidas ou  todas.

    Image Added


    Após a seleção dos filtros, é exibido para o usuário o primeiro resultado dos filtros que traz o quantitativo.


    Image Added


    Logo abaixo será apresentado a(s) mensagem (ns) com o identificador, a integração, a situação, o componente, a data de recebimento e uma coluna ações. 

    O identificador, a situação e o componente, podem ser utilizados em um segundo filtro. Conforme imagens abaixo:

    Image Added


    Na coluna ações é possível visualizar a mensagem e a rastreabilidade da comunicação iPaaS, do registro selecionado.


    Image Added


    Image Added



    Integrações com situação não processada, poderão ser reprocessadas por dois menus:


    Image Added


    Neste menu superior, é possível reprocessar as mensagens com erro. Para isso é necessário informar o Período e a integração.

    Image Added


    No menu lateral  na coluna Ações o reprocessamento acontece de maneira individual.

    Para mais informações sobre a funcionalidade de monitoramento, segue  o link da documentação  TOTVS iPaaS no TDN.

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