Histórico da Página
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.
| Expandir | |
|---|---|
|
...
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.
...
| title | Req. 01 – Parâmetros da customização |
|---|
Pré-requisitos
Não se aplica.
Detalhamento do processo
Foi desenvolvido uma tela de parâmetros para que o usuário possa informar os dados para acesso ao webservice do Sistema Corporativo. A tela está disponível no menu Educacional → Customização → Parâmetros Web Service e possui os seguintes campos:
- Url base web Service: Endereço de acesso base da API que será utilizada para envio dos registros de
aluno, Responsável Financeiro e Responsável Acadêmico. Informe o caminho do Host para conexão
com a API, porém até antes da última barra do trecho “api”.
- Usuário para autenticação: Usuário que terá acesso ao Web Service Sistema Corporativo.
- Password para autenticação: Senha do usuário que terá acesso ao Web Service Sistema Corporativo
...
| ||||||||||||||||||||
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.
|
| Expandir | |
|---|---|
|
...
| ||
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:
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. |
| Expandir | ||
|---|---|---|
| ||
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:
Cadastro Automático de Responsável Financeiro (Cliente/Fornecedor):
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.
|
| Expandir | ||
|---|---|---|
| ||
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. |
| Expandir | ||
|---|---|---|
| ||
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:
| Expandir | |
|---|---|
|
...
| |
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. |
| Expandir | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
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:
|
| Expandir | |
|---|---|
|
...
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
Status de retorno do Webservice O webservice poderá retornar os seguintes status HTTP:
|
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 |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas