Páginas filhas
  • Manual Operacional - Cadastro de Pessoa Física

Cadastro de Pessoa Física


O manual a seguir visa detalhar as customizações realizadas neste projeto para atender as necessidades da integração entre o SGE e Sistema Corporativo no que diz respeito ao cadastro de Pessoa Física.


Pré-requisitos

Não se aplica.


Detalhamento do processo

Foi desenvolvido uma rotina customizada para manter os dados do cadastro do Aluno atualizados entre o SGE e o sistema corporativo.


No momento do cadastro, o usuário irá verificar se o aluno já existe na tabela da Pessoa, utilizando a função nativa de "Localizar Aluno/Registro Preliminar". Se o registro for localizado, os dados serão preenchidos na tela do Aluno e o usuário poderá finalizar o cadastro. Caso não seja localizado, o usuário deverá preencher todos os dados antes de salvar o registro.



No momento de salvar o cadastro do aluno, a customização verificará se a pessoa já foi integrada com o sistema corporativo. Se estiver sido integrada, o registro será salvo normalmente. Caso ainda não tenha sido exportado, uma mensagem será exibida informando o usuário que é necessário realizar a integração entre os dois sistemas e orientando para a utilização da função "Consultar Aluno", acessível através de botão com mesmo nome na tela de cadastro do Aluno.


Tela Consultar Aluno

Na tela de consultar o Aluno, os dados de Data Nascimento, Nome e CPF já virão preenchidos com os dados do mesmo, e o usuário poderá realizar a busca ao sistema corporativo. O usuário deverá, então, realizar a busca, e caso sejam retornado registros, selecionar o adequado e clicar em "Preencher Dados". Nesse momento, os dados do SGE serão sincronizados com os dados recebidos do sistema corporativo e o cadastro do Aluno poderá ser finalizado.

Caso não sejam localizados registros na busca, o usuário deverá clicar em "Integrar" para enviar a Pessoa para o sistema corporativo, para que os dois sistemas possam ser sincronizados. O cadastro poderá, então, ser finalizado.


Obs.: O processo descrito nesse requisito será acionado apenas no cadastro de novos alunos. No momento que for realizado uma alteração no cadastro do aluno, e ele estiver sido exportado para o Sistema Corporativo, um processo será executado para realizar a sincronização dos dados entre os dois sistemas, conforme detalhado no requisito 05 deste manual.


Versão 12.1.27.018

A partir da versão 12.1.27.018 da customização Pessoa Física quando o parametro "Habilitar alunos sem documentação" estiver marcado o campos obrigatorios de CPF e RG não serão exigidos no SGE para a criação/atualização do aluno.

Matrículas Processo Seletivo

Para matrículas realizadas pelo Processo Seletivo - SESI (Educação Básica) ou SENAI (Ensino Superior), os dados do aluno serão enviados para registro da Pessoa Física no Sistema Corporativo, gerando o Id. Corporativo, que será armazenado do SGE.

Campos Obrigatórios

Para as matriculas realizadas pelo Processo Seletivo, antes de realizar a integração da Pessoa Física no Sistema Corporativo a customização realiza uma pré validação de campos obrigatórios antes de realizar a comunicação com o sistema, segue os campos obrigatórios passados pela tela de informações do candidato do processo seletivo:

  • Nome
  • Dt. Nascimento
  • Sexo
  • Estado Civil
  • Grau Instrução
  • Telefone
  • E-mail
  • CEP

Caso o candidato do processo seletivo seja brasileiro será validado também os seguintes campos:

  • CPF
  • Data Emissão Carteira identidade
  • Órgão Emissor identidade
  • Carteira identidade

Alunos menores de idade

Para alunos menores de idade com ou sem CPF, deve se realizar os mesmos passos da seção "Criação de cadastro Pessoa Física - Aluno", porem ao salvar o cadastro do aluno o campo Código SCAE não será preenchido, para que o campo seja preenchido deve-se cadastrar um responsável acadêmico maior de idade utilizando os passos descritos na seção "Criação de cadastro de Pessoa Física - Responsável Academico", somente após a integração do responsável acadêmico com sucesso é que o campo Código SCAE será preenchido com o numero da matricula do aluno no Sistema Legado da FIRJAN.

Pré-requisitos

Não se aplica.


Detalhamento do processo

Foi desenvolvido uma rotina customizada para manter os dados do cadastro do Responsável Acadêmico atualizados entre o SGE e o Sistema Corporativo.

No momento do cadastro do Aluno, o usuário irá verificar se o Responsável Acadêmico já existe na tabela da Pessoa, realizando a busca e selecionando através do Lookup de "Responsável Acadêmico". Se o registro for localizado, o usuário poderá prosseguir para finalizar o cadastro, e a customização irá validar se aquele responsável já foi integrado com o Sistema Corporativo. Se houver sido, o cadastro poderá ser realizado com sucesso, se não, o usuário deverá clicar em "Consultar Responsável Acadêmico" para realizar a integração, conforme detalhado no tópico abaixo "Tela Consultar Responsável Acadêmico". Caso o usuário não localize na busca de Pessoas o Responsável Acadêmico, ele deverá prosseguir também para a função de Consulta, onde o responsável acadêmico será buscado no Sistema Corporativo.


Tela Consultar Responsável Acadêmico

Na tela de consultar o Responsável Acadêmico, os dados de Data Nascimento, Nome e CPF já virão preenchidos com os dados do mesmo se ele estiver sido localizado no SGE e selecionado no Lookup, caso contrário o usuário deverá digitar manualmente as informações e então poderá realizar a busca no sistema corporativo. O usuário deverá, então, realizar a busca, e caso sejam retornado registros, selecionar o adequado e clicar em "Preencher Dados". Nesse momento, duas ações poderão ser realizadas pela customização:

  1. Se uma Pessoa estiver sido localizada no SGE e selecionada no Lookup de Responsável Acadêmico, a customização irá atualizar os dados da mesma com as informações provenientes do Sistema Corporativo.
  2. Caso o Responsável não tenha sido localizado no SGE, ou seja, o lookup de Responsável Acadêmico esteja vazio, a customização irá tentar localizar o registro novamente no SGE, através do CPF:
    1. Se não for localizado, uma nova Pessoa será inserida no SGE e a customização irá preencher o campo de Responsável Acadêmico do Aluno com essa Pessoa importada do Sistema Corporativo.
    2. Caso seja localizado a Pessoa na busca pelo CPF, o sistema irá apenas atualizar os dados e vincular ao cadastro do aluno.

Caso não sejam localizados registros na busca, o usuário deverá clicar em "Integrar" para enviar a Pessoa para o sistema corporativo, para que os dois sistemas possam ser sincronizados. O cadastro poderá, então, ser finalizado.

Obs.: O processo descrito nesse requisito será acionado apenas no cadastro de novos alunos. No momento que for realizado uma alteração no cadastro do aluno, e ele estiver sido exportado para o Sistema Corporativo, um processo será executado para realizar a sincronização dos dados entre os dois sistemas, conforme detalhado no requisito 05 deste manual.

Pré-requisitos

Limpar a máscara do Código do Cliente/Fornecedor em Backoffice | Gestão Financeira | Ambiente | Parâmetros | TOTVS Gestão Financeira | Lançamento | Cliente/Fornecedor| Máscara do Código. Este campo precisa ficar vazio para correto funcionamento do cadastro de Cliente/Fornecedor..


Detalhamento do processo

Foi desenvolvido uma rotina customizada para manter os dados do cadastro do Responsável Financeiro do Aluno (Cliente/Fornecedor) atualizados entre o SGE e o Sistema Corporativo.

No momento do cadastro do Aluno, o usuário irá verificar se o Responsável Financeiro já existe na tabela da Pessoa, realizando a busca e selecionando através do Lookup de "Responsável Financeiro". Se o registro for localizado, o usuário poderá prosseguir para finalizar o cadastro, e a customização irá validar se aquele responsável já foi integrado com o Sistema Corporativo. Se houver sido, o cadastro poderá ser realizado com sucesso, se não, o usuário deverá clicar em "Consultar Responsável Financeiro" para realizar a integração, conforme detalhado no tópico abaixo "Tela Consultar Responsável Financeiro". Caso o usuário não localize na busca de Pessoas o Responsável Financeiro, ele deverá prosseguir também para a função de Consulta, onde o responsável financeiro será buscado no Sistema Corporativo.


Tela Consultar Responsável Financeiro

Na tela de consultar o Responsável Financeiro, os dados de Data Nascimento, Nome e CPF já virão preenchidos com os dados do mesmo se ele estiver sido localizado no SGE e selecionado no Lookup, caso contrário o usuário deverá digitar manualmente as informações e então poderá realizar a busca no sistema corporativo. O usuário deverá, então, realizar a busca, e caso sejam retornado registros, selecionar o adequado e clicar em "Preencher Dados". Nesse momento, duas ações poderão ser realizadas pela customização:

  1. Se uma Pessoa estiver sido localizada no SGE e selecionada no Lookup de Responsável Financeiro, a customização irá atualizar os dados da mesma com as informações provenientes do Sistema Corporativo.
  2. Caso o Responsável não tenha sido localizado no SGE, ou seja, o lookup de Responsável Financeiro esteja vazio, a customização irá tentar localizar o registro novamente no SGE, através do CPF:
    1. Se não for localizado, uma nova Pessoa será inserida no SGE e a customização irá preencher o campo de Responsável Financeiro do Aluno com essa pessoa importada do Sistema Corporativo. O código do cliente/fornecedor será criado com o código do protheus enviado pelo Sistema Corporativo. Assim como o campo complementar ID Corporativo com o IDCorporativo da pesssoa.
    2. Caso seja localizado a Pessoa na busca pelo CPF, o sistema irá apenas atualizar os dados e vincular ao cadastro do aluno.O código do cliente/fornecedor será criado com o código do protheus enviado pelo Sistema Corporativo.Assim como o campo complementar ID Corporativo com o IDCorporativo da pesssoa.
    3. Caso não sejam localizados registros na busca, o usuário deverá clicar em "Integrar" para enviar a pessoa para o sistema corporativo, para que os dois sistemas possam ser sincronizados. O cadastro poderá, então, ser finalizado.



Cadastro Automático de Responsável Financeiro (Cliente/Fornecedor):


A funcionalidade automática permite cadastrar  (Cadastrar ALUNO como responsável, Cadastrar PAI/MÃE como responsável, Cadastrar RESPONSÁVEL ACADÊMICO como responsável) presentes na tela de Aluno na aba de Responsáveis. Ao selecionar uma das opções de cadastro automático para responsável Financeiro, será feito uma busca no sistema corporativo para localização da pessoa e verificar se o mesmo possui o código do Protheus. O Sistema Corporativo deverá retornar o código do Protheus que será utilizado para identificação do responsável no sistema, com o retorno, o cadastro será criado e vinculado ao aluno.



Caso o código do Protheus não seja retornado após ser realizada a consulta, será exibido uma mensagem informando que não será possível vincular aquela pessoa como responsável financeiro do aluno. 


Assim como na imagem abaixo:


O Código retornado pelo Protheus será utilizado no lugar do código gerado pelo responsável financeiro.


Pré-requisitos

Não se aplica.


Detalhamento do processo

Foi desenvolvida uma rotina para verificar as alterações no cadastro de Pessoa e exportá-las para o Sistema Corporativo para que as informações em ambos os sistemas fiquem sincronizadas.


No momento que o registro for alterado, a customização irá verificar se a Pessoa possui o papel de Aluno, Responsável Acadêmico ou Docente Extraquadro (SPROFESSOR) no Educacional. Caso possua, o processo customizado irá verificar se a Pessoa foi exportada para o Sistema Corporativo, consultando o campo complementar "Id Corporativo". Se sim, no momento que o usuário salvar a alteração no cadastro da pessoa, uma chamada será realizada ao webservice do Sistema Corporativo enviando as modificações realizadas no SGE para que ambos os sistemas fiquem sincronizados.


Obs.: Docentes do Quadro (Professores com campo complementar SPROFESSORCOMPL.QUADRO = 0) não serão exportados para o Sistema Corporativo através dessa rotina, pois são tratados de forma específica na customização HCM.

Pré-requisitos

Não se aplica.


Detalhamento do processo

Foi desenvolvida uma rotina para verificar as alterações no cadastro de Responsável Financeiro e exportá-las para o Sistema Corporativo para que as informações em ambos os sistemas fiquem sincronizadas.


No momento que o registro for alterado, a customização irá verificar se o Cliente/Fornecedor possui o papel de Responsável Financeiro de algum Aluno no Educacional. Caso possua, o processo customizado irá verificar se o Cliente/Fornecedor foi exportada para o Sistema Corporativo, consultando o campo complementar "Id Corporativo". Se sim, no momento que o usuário salvar a alteração no registro, uma chamada será realizada ao webservice do Sistema Corporativo enviando as modificações realizadas no SGE para que ambos os sistemas fiquem sincronizados.

Serviços Disponíveis no RM:


Swagger

Todos os serviços disponíveis no RM são agrupados e listados nessa ferramenta, que visa auxiliar na manutenção e documentação de APIs REST.

Para acessar o Swagger, é necessário acessar o link no seguinte formato "http://<servidor>:<portaFrameHTML>/swagger/ui/index" (Exemplo:http://localhost:8080/swagger/ui/index).


O serviços da customização de Cadastro de Pessoa Física estão disponíveis em CstAtualizacaoPessoa, nos métodos AtualizarPessoa e AtualizarResponsavelFinanceiro, ambos do tipo PUT.

Pré-requisitos

Não se aplica.


Detalhamento do processo

Foi desenvolvido um WebService para realizar a integração de Pessoa entre o Sistema Corporativo e o SGE, que está disponível no swagger com o nome AtualizarPessoa.

O método de atualização de pessoa recebe um objeto como parâmetro no corpo da requisição, que são vinculados aos campos no SGE de acordo com a tabela abaixo:

Campo WebServiceSGE
IDSALUNOCOMPL.CODALUNOSCOP( Coligada 3) ou SALUNOCOMPL.CODALUNOSCAE (Coligada 2)
NomePPESSOA.NOME
DataNascimentoPPESSOA.DTNASCIMENTO
EstadoCivilPPESSOA.ESTADOCIVIL
SexoPPESSOA.SEXO
CorPPESSOA.CORRACA
NomeMaeSALUNOCOMPL.NOMEMAE (Coligada 3) e VPCOMPL.NOMEMAE
NomePaiVPCOMPL.NOMEPAI
CPFPPESSOA.CPF
IdentidadePPESSOA.CARTIDENTIDADE
OrgaoEmissorPPESSOA.ORGEMISSORIDENT
DataEmissaoPPESSOA.DTEMISSAOIDENT
TituloEleitorPPESSOA.TITULOELEITOR
PassaportePPESSOA.NPASSAPORTE
Nacionalidade

PPESSOA.NACIONALIDADE

CidadeEnderPPESSOA.CODMUNICIPIO
BairroEnderPPESSOA.BAIRRO
UFEnderPPESSOA.ESTADO OU SALUNO.ESTADO
EstrangeiroInformação inexistente no SGE. Existe o campo de nacionalidade (PPESSOA.NACIONALIDADE) que suprime esta informação.
EmailPPESSOA.EMAIL
DDD

Informação não existe separada do telefone no SGE. Será concatenada ao Telefone.
(PPESSOA.TELEFONE1).

TelefonePPESSOA.TELEFONE1
DDDCel

Informação não existe separada do telefone no SGE. Será concatenada ao Celular.
( PPESSOA.TELEFONE2).

CelularPPESSOA.TELEFONE2
LogradouroPPESSOA.RUA
ComplementoPPESSOA.COMPLEMENTO
NumeroPPESSOA.NUMERO
CEPPPESSOA.CEP
Municipio_IBGEPPESSOA.CODNATURALIDADE
TipoBeneficiarioVPCOMPL.TIPOBENEFICIARIO (Esta informação será adicionada no campo complementar “Tipo Beneficiário” e preenchido por tabela dinâmica T= Titular e D= Dependente).


Serão atualizados as pessoas que sejam aluno, professores ou responsáveis acadêmicos. Apenas professores do quadro (campo complementar SPROFESSORCOMPL.QUADRO = 0) não serão atualizados, e uma mensagem de erro será retornada pelo webservice.


Status de retorno do Webservice

O webservice poderá retornar os seguintes status HTTP:

StatusDescrição
204 - No ContentSerá retornado quando ocorrer sucesso na atualização dos dados da Pessoa.
400 - Bad RequestÉ retornado quando ocorre algum erro de validação e a atualização não é processada. Um objeto com os detalhes do erro é retornado.
500 - Internal Server ErrorÉ retornado quando ocorre algum erro não tratado no webservice, e os detalhes do problema são retornados.

Pré-requisitos

Não se aplica.


Detalhamento do processo

Foi desenvolvido um WebService para realizar a integração de Responsável Financeiro entre o Sistema Corporativo e o SGE, que está disponível no swagger com o nome AtualizarResponsavelFinanceiro.

O método de atualização de responsável financeiro recebe um objeto como parâmetro no corpo da requisição, que são vinculados aos campos no SGE, realiza a busca através do CPF (FCFCO.CGCCFO) e caso seja localizado o registro, atualiza os dados de acordo com a tabela abaixo:

Campo WebServiceSGE
IDNão se aplica para Responsável Financeiro.
NomeFCFO.NOME
DataNascimentoFCFO.DTNASCIMENTO
EstadoCivilFCFO.ESTADOCIVIL
SexoInformação inexistente no SGE para Responsável Financeiro.
CorInformação inexistente no SGE para Responsável Financeiro.
NomeMaeFCFOCOMPL.NOMEMAE
NomePaiFCFOCOMPL.NOMEPAI
CPFFCFO.CGCCFO
IdentidadeFCFO.CIDENTIDADE
OrgaoEmissorFCFO.CI_ORGAO
DataEmissaoInformação inexistente no SGE para Responsável Financeiro.
TituloEleitorInformação inexistente no SGE para Responsável Financeiro.
PassaporteInformação inexistente no SGE para Responsável Financeiro.
Nacionalidade

FCFO.NACIONALIDADE (Se enviar S, gravar 1, se enviar N, gravar 0).

CidadeEnderFCFO.CODMUNICIPIO
BairroEnderFCFO.BAIRRO
UFEnderFCFO.CODETD
EstrangeiroFCFO.NACIONALIDADE (Se enviar S, gravar 1, se enviar N, gravar 0).
EmailFCFO.EMAIL
DDD

Informação não existe separada do telefone no SGE. Será concatenada ao Telefone.
(FCFO.TELEFONE).

TelefoneFCFO.TELEFONE
DDDCel

Informação não existe separada do telefone no SGE. Será concatenada ao Celular.
( FCFO.TELEX).

CelularFCFO.TELEX
LogradouroFCFO.RUA
ComplementoFCFO.COMPLEMENTO
NumeroFCFO.NUMERO
CEPFCFO.CEP
Municipio_IBGEInformação inexistente no SGE para Responsável Financeiro.
TipoBeneficiarioVPCOMPL.TIPOBENEFICIARIO (Esta informação será adicionada no campo complementar “Tipo Beneficiário” e preenchido por tabela dinâmica T= Titular e D= Dependente).


Status de retorno do Webservice

O webservice poderá retornar os seguintes status HTTP:

StatusDescrição
204 - No ContentSerá retornado quando ocorrer sucesso na atualização dos dados do Responsável Financeiro.
400 - Bad RequestÉ retornado quando ocorre algum erro de validação e a atualização não é processada. Um objeto com os detalhes do erro é retornado.
500 - Internal Server ErrorÉ retornado quando ocorre algum erro não tratado no webservice, e os detalhes do problema são retornados.

Histórico de Atualização do Documento


Autor

Versão

Data

Descrição das Alterações

Seção

Pag.

Thiago Neiva

1.0

 

Versão Inicial do Manual