Histórico da Página
Manual Operacional da customização - Integração com HCM e Protheus
O manual a seguir visa detalhar as customizações realizadas neste projeto para atender as necessidades da integração entre o SGE, HCM e Gestor de ServiçosProtheus.
| Expandir | ||
|---|---|---|
| ||
Pré-requisitos Não se aplica. Descrição do processo Tela de parâmetros para que o usuário defina se a Unidade (Filial) validará o preenchimento da data inicial da Turma de acordo com a data da Matriz Curricular.Processo customizado responsável por realizar a integração de Docentes entre HCM e TOTVS Educacional. Esta integração não será on-line pelo cadastro de Docente no HCM ou Protheus, sendo necessário acessar a funcionalidade de cadastro de Docente customizada disponibilizada no SGE para que ocorra a integração do cadastro de Professor Detalhamento do processo O usuário deverá selecionar um único registro de Matriz Curricular e executar o processo customizado “Associar serviço ao Curso” disponível em TOTVS Educacional | Currículo e Oferta | Matriz Curricular | Processos.
A customização então acionará o Web Service do Gestor de Serviços e retornará para a tela customizada do processo uma lista de serviços que serão apresentados ao usuário. O usuário deverá escolher um único registro e clicar em Executar. Nenhuma informação desta tela será editável.
A informação se o Curso é Padrão ou Customizado virá preenchida baseado no anexo customizado "Dados do Curso" da Matriz Curricular:
O campo "Serviço" acima será preenchido somente após a conclusão do processo de Associar Serviço ao Curso. Os seguintes dados retornados pelo Web Service serão gravados em duas tabelas customizadas distintas no SGE:
Após a conclusão da gravação do registro nas tabelas customizadas a customização deverá consumir um Web Service do Gestor de Serviços para retornar a Matriz Curricular e o Serviço associado. Os dados de Item e Conta contábil estarão visíveis nos anexos customizados da Matriz Curricular Item contábil e Conta contábil. Nenhuma informação destas telas serão editáveis.
Caso haja necessidade de modificar as informações gravadas, o usuário deverá executar o processo novamente que ao selecionar um novo serviço, deverá sobrescrever todas as informações gravadas nas tabelas customizadas. A alteração do Serviço só será permitida caso não exista nenhuma Matriz Aplicada vinculada à Matriz Curricular. Se houver alguma Matriz Aplicada será apresentada a seguinte mensagem: “Não é possível alterar Serviço para Matriz Curricular que possui Matriz Aplicada vinculada”. Apesar do Serviço não poder ser alterado, a conta, item e datas podem ser modificadas independente da existência de Matriz Aplicada vinculada. Após a alteração dos dados contábeis no SGE a Customização também deverá acionar o Web Service responsável por atualizar o vínculo entre Matriz Curricular e Serviço. Os dados antigos vinculados à Matriz Curricular serão registrados nas abas "Histórico Conta Contábil" e "Histórico Item Contábil" dos anexos customizados "Conta Contábil" e "Item Contábil", respectivamente. | ||
| Expandir | ||
| ||
| Expandir | ||
| ||
| Expandir | ||
| ||
Para inclusão / alteração de Docente no SGE o usuário deverá acessar o menu “TOTVS Educacional | Customização | Cadastro de Docente”. O acesso a este menu será viabilizado via permissão por perfil (Serviços globais | Segurança | Perfis). Ao acessar esta tela estará à disposição do usuário o campo de preenchimento obrigatório: “CPF”.
No momento que o usuário clicar em Avançar, a customização acionará o WebService do HCM para tentar recuperar os dados do Docente. Caberá ao WebService do HCM retornar somente registros pertinentes de acordo com suas regras: (1) cargos do HCM podem ministrar aula (SESI: Professores, pedagogos e Profissional de Libras) – SENAI: Instrutores, Técnicos de Educação, Pedagogos, Especialistas em Serviço Tecnológico e CREF); (2) deverá ser um colaborador do quadro ATIVO. (Os cargos habilitados para dar aula deverão ser verificados na solução do HCM de Famílias / Subfamílias). No momento que o WebService for acionado os seguintes cenários serão possíveis:
Os dados do Docente encontrados no HCM serão exibidos na tela (os dados não poderão ser alterados pelo usuário na tela customizada) e ao clicar em Concluir a customização utilizará estes dados para gravá-lo na base do SGE como Pessoa e Docente do Quadro (SPROFESSORCOMPL.QUADRO = 0). Informações complementares existentes em campos de anexos do Professor serão cadastradas pela funcionalidade nativa do SGE não cabendo à customização inserir estes dados por esta rotina.
O usuário será criado para este Docente de acordo com as parametrizações determinadas em TOTVS Educacional | Ambiente | TOTVS Educacional | Geração de usuários | Professor. Os campos “Ativo” e “Sempre válido” do cadastro do usuário deverão estar marcados.
Os dados do Docente encontrados no HCM serão exibidos na tela (os dados não poderão ser alterados pelo usuário na tela customizada) e ao clicar em Concluir a customização utilizará estes dados para atualizar o registro da Pessoa no SGE e incluí-lo na base do SGE como Docente do Quadro (SPROFESSORCOMPL.QUADRO = 0). Informações complementares existentes em campos de anexos do Professor serão cadastradas pela funcionalidade nativa do SGE não cabendo à customização inserir estes dados por esta rotina.
Caso não exista usuário, o mesmo será criado para o Docente considerando as parametrizações determinadas em TOTVS Educacional | Ambiente | TOTVS Educacional | Geração de usuários | Professor. Os campos “Ativo” e “Sempre válido” do cadastro do usuário deverão estar marcados. Se houver, o usuário será tendo em vista que já existe o usuário na base do SGE, porém a customização deverá confirmar que os campos “Ativo” e “Sempre válido” estejam marcados.
Os dados do Docente encontrados no HCM serão exibidos na tela (os dados não poderão ser alterados pelo usuário na tela customizada) e ao clicar em Concluir a customização utilizará estes dados para atualizar o registro da Pessoa no SGE e atualizá-lo na base do SGE como Docente do Quadro (SPROFESSORCOMPL.QUADRO = 0). Informações complementares existentes em campos de anexos do Professor serão cadastradas pela funcionalidade nativa do SGE não cabendo à customização inserir estes dados por esta rotina.
Nesta situação não será criado usuário para o Docente tendo em vista que já existe o usuário na base do SGE, porém a customização deverá confirmar que os campos “Ativo” e “Sempre válido” estejam marcados.
Customização habilita pergunta: Docente é do Quadro ou Extraquadro?
Se o usuário informar que é do Quadro, a customização emitirá a mensagem: “Docente do quadro deve ser cadastrado inicialmente no RH para posterior cadastro no SGE” e a operação é interrompida.
Se o usuário informar que é Extraquadro, customização deve habilitar os campos para preenchimento manual. Ao clicar em Concluir o registro deverá ser gravado na base do SGE sendo que o campo complementar “Quadro” do Docente será registrado como SPROFESSORCOMPL.QUADRO = 1.
No momento da inclusão, o Docente Extraquadro será associado a Filial que está cadastrando, porém o mesmo ficará nesse momento com status de inativo na referida filial (Anexo Filiais do Professor do cadastro de Docente do SGE). O usuário será criado para este Docente de acordo com as parametrizações determinadas em TOTVS Educacional | Ambiente | TOTVS Educacional | Geração de usuários | Professor. Os campos “Ativo” e “Sempre válido” do cadastro do usuário deverão estar desmarcados. Além disso o campo “Expiração da validade” deverá ser preenchido com a data da criação do usuário, pois se este campo não estiver preenchido, o sistema marca o campo “Sempre Válido”. A ativação do usuário se dará apenas no momento em que for associado o contrato do professor extraquadro com a filial através da integração com o módulo de cadastro de fornecedores PF do Protheus. O detalhamento desta rotina de associação de contratos ao Docente está definida no Req. 02. Este processo customizado deverá marcar o campo “Ativo” e preencher o campo “Expiração da validade”.
Customização habilita pergunta: Docente é do Quadro ou Extraquadro?
Se o usuário informar que é do Quadro, customização deve emitir mensagem “Docente do quadro deve ser cadastrado inicialmente no RH para posterior cadastro no SGE” e a operação é interrompida.
Se o usuário informar que é Extraquadro, customização deve carregar as informações atuais e permitir a alteração dos mesmos manualmente. Ao clicar em Concluir a customização utilizará estes dados para atualizar o registro da Pessoa no SGE e incluí-lo na base do SGE como Docente Extraquadro (SPROFESSORCOMPL.QUADRO = 1). Informações complementares existentes em campos de anexos do Professor serão cadastradas pela funcionalidade nativa do SGE não cabendo à customização inserir estes dados por esta rotina.
Caso não exista usuário, o mesmo será criado para o Docente considerando as parametrizações determinadas em TOTVS Educacional | Ambiente | TOTVS Educacional | Geração de usuários | Professor. Os campos “Ativo” e “Sempre válido” do cadastro do usuário deverão estar desmarcados. Além disso o campo “Expiração da validade” deverá ser preenchido com a data da criação do usuário, pois se este campo não estiver preenchido, o sistema marca o campo “Sempre Válido”. A ativação do usuário se dará apenas no momento em que for associado o contrato do professor extraquadro com a filial através da integração com o módulo de cadastro de fornecedores PF do Protheus. O detalhamento desta rotina de associação de contratos ao Docente está definida no Req. 02. Este processo customizado deverá marcar o campo “Ativo” e preencher o campo “Expiração da validade”.
Customização habilita pergunta: Docente é do Quadro ou Extraquadro?
Se o usuário informar que é do Quadro, customização deve emitir mensagem “Docente do quadro deve ser cadastrado inicialmente no RH para posterior cadastro no SGE” e a operação é interrompida.
Se o usuário informar que é Extraquadro, customização deve carregar as informações atuais e permitir a alteração dos mesmos manualmente. Ao clicar em Concluir a customização utilizará estes dados para atualizar o registro da Pessoa no SGE e atualizá-lo na base do SGE como Docente Extraquadro (SPROFESSORCOMPL.QUADRO = 1). Informações complementares existentes em campos de anexos do Professor serão cadastradas pela funcionalidade nativa do SGE não cabendo à customização inserir estes dados por esta rotina. Nesta situação não será criado usuário para o Docente tendo em vista que já existe o usuário na base do SGE, porém a customização deverá confirmar que os campos “Ativo” e “Sempre válido” estejam desmarcados. Além disso o campo “Expiração da validade” deverá ser preenchido com a data da criação do usuário, pois se este campo não estiver preenchido, o sistema marca o campo “Sempre Válido”. A ativação do usuário se dará apenas no momento em que for associado o contrato do professor extraquadro com a filial através da integração com o módulo de cadastro de fornecedores PF do Protheus. |
| Expandir | ||
|---|---|---|
| ||
| Expandir | ||
| ||
Pré-requisitos Não se aplica. Descrição do processo Interferência customizada na alteração do campo Data de Término (SGRADE.DTFIM) do cadastro de Matriz CurricularProcesso customizado responsável por consultar os contratos dos Docentes Extraquadro no Protheus e então ativar os usuários correspondentes de acordo com a extensão dos contratos. Detalhamento do processo Ao modificar a Data de Término da Matriz Curricular para uma nova data ou nulo e o usuário clicar em Salvar, a customização consumirá um Web Service do Gestor de Serviços cujo o método modificará a data de validade do Serviço. | ||
| Expandir | ||
| ||
No momento que houver a criação de um Docente Extraquadro no SGE à partir da rotina customizada de criação de Docente o usuário do Docente será criado com o campo “Ativo” desmarcado e o campo “Expiração da validade” igual à data da criação do registro. O processo customizado detalhado neste requisito será responsável por marcar o campo “Ativo” e aplicar uma nova data para o campo “Expiração da validade”. O usuário deverá acessar o menu TOTVS Educacional | Currículo e Oferta | Professores | Anexo Filiais do Professor | Consultar contratos. Neste instante a customização acionará um WebService do Protheus passando o CPF do Docente como parâmetro que consultará o cadastro de fornecedores PF.
O WebService retornará o “Contrato de RPCI” do docente extraquadro, assim como a “Data de início” e “Data de término” do referido contrato, “Código do RPCI”, “Código do Serviço Prestado” (Código do serviço de instrutor) e Filial. O Registro dessas informações ficará visível através do Anexo “Contrato de RCPI” (TOTVS Educacional | Currículo e Oferta | Professores | Anexo Filiais do Professor | Anexo) que conterá uma grid com todo o histórico de contratos do Professor por Filial. Será possível abrir cada um dos registros, porém os dados serão apenas para visualização. A consulta ao WebService dos contratos vigentes do Professor Extraquadro deverá ser realizada manualmente por um usuário pelo processo customizado. Baseado na informação registrada no campo “Data de término” a customização deverá preencher o campo “Expiração da validade” e marcar o campo “Ativo” do usuário vinculado ao Docente que está sendo consultado. Caso o WebService retorne mais de um contrato para o Docente seja para a mesma Filial ou não, a customização deve verificar a maior “Data de término” para que esta data seja aplicada ao campo “Expiração de validade” do usuário Pré-requisitos Não se aplica. Descrição do processo Integração via Web Service capaz de retornar o Status da Matriz Curricular para o Gestor de Serviços. Detalhamento do processo O Gestor de Serviços poderá acionar um Web Service TOTVS capaz de retornar ao Gestor o Status da Matriz Curricular solicitada. A consulta será realizada pelo Gestor de Serviços no momento que o mesmo realizar a finalização de um Serviço. Todavia, esta finalização só será concretizada caso o status da Matriz Curricular seja igual a Inativa. |
| Expandir | ||
|---|---|---|
| ||
Pré-requisitos Não se aplica. Descrição do processo Interferência customizada Validação na inclusão de uma Matriz Aplicada para que estas informações sejam replicadas ao Gestor de Serviçosnova Filial para um Docente. Detalhamento do processo Assim que o usuário clicar em Salvar quando estiver incluindo um novo registro de Matriz Aplicada a customização deverá validar se a Matriz Curricular vinculada possui Serviço associado (ZGESTORITEM e ZGESTORCONTA). Se houver, a customização permitirá que o registro seja salvo e acionará a integração via Web Service do Gestor de Serviços enviando os dados da nova Matriz Aplicada. O Web Service deverá receber as seguintes informações:
| ||
| Expandir | ||
| ||
Ao incluir ou alterar algum registro do anexo “Filiais do professor”, se o Docente for do Quadro (SPROFESSORCOMPL.QUADRO = 0) somente será permitido que o usuário adicione uma nova Filial ao Docente se a Filial do contexto do usuário logado seja igual à Filial registrada no campo complementar do Docente (SPROFESSORCOMPL.CODFILIAL). Caso contrário será emitida a mensagem ao salvar: “Filial do Docente é diferente da Filial do contexto. Não será possível salvar o registro”. Ao clicar no botão Excluir da Matriz Curricular Pré-requisitos Não se aplica. Descrição do processo Interferência customizada na exclusão de uma Matriz Aplicada para que estas informações sejam replicadas ao Gestor de Serviços. Detalhamento do processo Assim que o usuário clicar em Excluir do cadastro de Matriz Aplicada, se houver apenas uma Matriz Aplicada ativa para a Matriz Curricular vinculada na unidade (Filial),a customização acionará um Web Service do Gestor de Serviços . A exclusão só será concluída secaso identifique que já exista um Serviço associado à esta Matriz. O retorno dado pelo Web Service permitirá ou não a conclusão da exclusão da Matriz no SGE. Caso o Gestor de Serviços permitir. Caso contrárionão permita a exclusão do registro, será emitdaemitida a mensagem retornada pelo Web Service e a exclusão será abortada.Se houver mais de uma Matriz Aplicada ativa para a Matriz Curricular na unidade (Filial) a exclusão nativa será acionada e o Web Service não será acionado. OWeb Service deverá receber as seguintes informações:Chave da Matriz Curricular. |
| Expandir | ||
|---|---|---|
| ||
Pré-requisitos Não se aplica. Descrição do processo Interferência customizada na alteração do campo "Oferta Ativa "de uma Matriz AplicadaJobServer customizado que consultará o HCM em busca de atualizações na situação dos Docentes. Detalhamento do processo Caso a “Oferta” seja modificada para Ativa (S), assim que o usuário clicar em Salvar, a customização consumirá um Web Service do Gestor de Serviços cujo o método retornará se o Serviço da Matriz Curricular vinculada à Matriz Aplicada no sistema terceiro está finalizado. Se não estiver finalizado, a alteração poderá ocorrer normalmente no SGE. Porém, se o Serviço estiver finalizado a operação no SGE não será concluída e será emitida a mensagem retornada pelo Web Service. Caso a “Oferta” seja modificada para Inativa (N), assim que o usuário clicar em Salvar, a customização verificará se existe outro registro de Matriz Aplicada para a mesma Matriz Curricular com “Oferta” = Ativa. Se houver algum registro, a rotina nativa de alteração da Matriz Aplicada será concluída alterando o campo para “Inativa”. Todavia, se não houver mais nenhuma outra Matriz Aplicada para a mesma Matriz Curricular com “Oferta” = Ativa, a customização acionará um Web Service do Gestor de Serviços para que a mesma seja finalizada também no outro sistema. A desativação no SGE só será permitida caso o Gestor de Serviços permita. Caso contrário será emitida a mensagem retornada pelo Web Service e a rotina de alteração será abortada. O Web Service deverá receber as seguintes informações: A periodicidade de execução deste JobServer deverá ser configurada pela interface Atualização de Docentes disponibilizada em TOTVS Educacional | Customização.
No momento que o WebService do HCM for consultado, serão retornados todos os Docentes ativos no HCM na Unidade de negócio (Filial) enviada como parâmetro do WebService. Mediante os dados retornados a customização encontrará as seguintes possibilidades:
Caso o retorno do WebService não informe os dados de certo Docente que existe no SGE como do Quadro, a customização deverá desmarcar o campo “Ativo” do cadastro do usuário relacionado ao docente (GUSUARIO.STATUS). Além disso, deverá preencher o campo “Término de validade” com a data que o desligamento foi realizado (GUSUARIO.DATAEXPIRACAO) e desmarcar o campo Ativo relacionado à Filial do Professor.
Caso o retorno do WebService informe os dados de certo Docente que existe no SGE como do Quadro, a customização deverá mantê-lo nas condições atuais registradas no SGE.
Caso o retorno do WebService informe os dados de certo Docente que estava registrado como Extraquadro no SGE, a customização deverá atualizar o campo complementar do Docente SPROFESSORCOMPL.QUADRO para igual a 1 e marcar os campos “Ativo” e “Sempre válido” do cadastro de Usuário. Além disso, a Filial retornada pelo HCM deverá ser registrada no Anexo Filiais do Professor como ativa. |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas