Páginas filhas
  • Manual Operacional da Customização de Contratos

Versões comparadas

Chave

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

Manual Operacional da Customização - Contratos (Integração ERP)


Projetos: FS007270, FS007271, FS007272, FS007878, FS007916, FS008136 e FS008062

Nome do cliente: FIEP

Objetivo


O manual a seguir tem por objetivo orientar o usuário sobre as implementações realizadas para sua empresa. Todas as funcionalidades descritas neste manual se baseiam no que está descrito nos documentos de especificação dos projetos abaixo e alterações de escopo:

  • FS007270-Integrações AX Fase I
  • FS007271-Integrações AX Fase II
  • FS007272-Pronatec
  • FS007878-Integração AX - Item de Venda
  • FS007916 (960607) - Integração ERP - Item de Venda - Carga Horária
  • FS008136 (A02305) - Tratativas Situação de Matrícula
  • FS008262 - Integração ERP - Data Início Contrato



Expandir
titleParametrização das Integrações

Pré-requisitos


Não se aplica.


Descrição do processo


Esta tela permitirá o cadastro dos parâmetros necessários para conexão com os WebServices necessários para integração do TOTVS Educacional com o Sistema AX, parâmetros necessários para integração do contrato, aditivo de contrato e termo de rescisão, e parâmetros para demais processos da customização.


Detalhamento do processo


No TOTVS Educacional, por meio do menu Customização | Integração ERP | Parametrização das Integrações, o usuário administrador efetuará as parametrizações referentes ao processo.




Deverão ser parametrizados as seguintes informações:


Campo

Descrição

WS – Matrícula

Endereço de acesso ao WebService de Matrícula disponibilizado pelo AX e a chave criptografada de acesso

WS – Customer Service

Endereço de acesso ao WebService de Customer Service disponibilizado pelo AX e a chave criptografada de acesso

WS – Itens de Venda


Endereço de acesso ao WebService de Itens de Venda disponibilizado pelo AX e a chave criptografada de acesso

WS – Informações da Unidade Operacional (Filial)

Endereço de acesso ao WebService de Unidade Operacional disponibilizado pelo AX e a chave criptografada de acesso


Obs.: Campos de preenchimento obrigatório




Guia: Integração com o sistema AX

SubGuia Integração do Contrato | Parâmetros:

 

Aluno do contrato:

Habilita campos complementares do aluno na tela customizada de integração do contrato (Sim/Não): caso seja habilitado este parâmetro, na tela de integração do contrato serão apresentados os dados complementares do aluno.

 




Serviço odontológico:

  • Utiliza serviço odontológico: Marcar a esta flag para informar se o contexto (coligada / filial / nível de ensino) utilizará o serviço odontológico (sim / não). Caso o usuário habilite está “flag”, os demais dados abaixo referentes ao serviço odontológico deverão ser preenchidos.
  • Código do serviço de odontologia: Deverá ser informado o código do serviço de odontologia (item de venda), a ser exibido no processo de integração de contrato com o sistema AX.

Observação:

Ao usuário clicar em “salvar”, a rotina customizada validará se em outro contexto (coligada, filial e nível de ensino) existe o item de venda (código do serviço de odontologia) associado.

Caso seja localizado, será apresentada a seguinte mensagem: “ O item de venda já se encontra parametrizado na coligada ‘X’, filial ‘X’ e nível de ensino ‘X’”. 

  • Valor do serviço de odontologia: Informar o valor do serviço de odontologia, a ser exibido no processo de integração de contrato com o sistema AX.


Pessoas vinculadas ao contrato:

  • Gestor responsável pelo contrato: deverá ser informado o gestor responsável pelo contrato no contexto (coligada/filial/nível de ensino), essa informação parametrizada será buscada no momento da integração do contrato com o sistema AX.
  • Gerente responsável para Assinatura do contrato: deverá ser informado o gerente responsável pela assinatura do contrato no contexto (coligada/filial/nível de ensino), essa informação parametrizada será buscada no momento da integração do contrato com o sistema AX.

Observação:

O CPF do Gerente responsável para Assinatura do contrato, será preenchido automaticamente de acordo com o cadastro da Pessoa no TOTVS. Caso não seja exibido, o cadastro de pessoa deverá ser atualizado podendo ser feito por meio do lookup da seguinte maneira: Clicar no nome da pessoa | cadastro de pessoa | Doc. Básicos e atualizar o CPF.


Alteração da situação de matrícula:

  • Status Matriculado Default: deverá ser informado o status matriculado padrão que será utilizado no processo de mudança de turma
  • Motivo de alteração de matrícula do contrato: deverá ser informado o motivo da alteração de matrícula do contrato que será utilizado no processo de mudança de turma
  • Motivo de alteração de matrícula do aditivo do contrato: deverá ser informado o motivo da alteração de matrícula do aditivo do contrato que será utilizado no processo de mudança de turma
  • Motivo de alteração de matrícula do aditivo do contrato sem valor: deverá ser informado o motivo da alteração de matrícula do aditivo do contrato sem valor que será utilizado no processo de mudança de turma



Modelo de Contrato:

  • Modelo de contrato: deverão ser informados quais modelos de contrato serão apresentados no processo customizado de integração do contrato, requisito 3.



Usuário com permissão para efetivar matrícula com data retroativa:

  • Código de usuário: deverá ser informado quais usuários possuirão permissão para efetuar a matrícula com data retroativa ao mês vigente (conforme descrito por meio do Req.3).



Status de Pré-matrículado: usuário deverá informar quais os status de matrículas considerados como “pré-matriculado”. Por intermédio desta lista, será realizada uma validação através do requisito 3.



Status de Matriculado: usuário deverá informar quais os status de matrículas considerados como “matriculado”. Por intermédio desta lista, será realizada uma validação através do requisito 3.




Expandir
titleGuia Integração de termos de rescisão e aditivos de contrato

Rescisão de Contrato: Usuário deverá informar as situações de matrícula consideradas para verificação se o contrato pode ser rescindido (conforme descrito por meio do Req. 07).



SubGuia Aditivo de Contrato:

Valor da disciplina: Habilita campo para informar valor aplicado da disciplina (Sim/Não): caso seja habilitado este parâmetro, na tela de integração do aditivo do contrato (descrito por meio dos requisitos Req.08 e Req.08.1) será apresentado o campo de valor da disciplina para que o usuário informe no momento da integração.



Mudança de turma: usuário deverá informar as situações de matrículas consideradas para verificação do Status de “Mudança de turma” (conforme descrito por meio do Req.07.1). Sendo informado o status da matrícula de destino.



Equivalências e dispensas: usuário deverá informar as situações de matrículas consideradas para serem utilizadas no processo de “Dispensas” (conforme descrito por meio do Req.08.1).




Modalidade do curso: usuário deverá informar as modalidades de curso consideradas para a integração com o AX das dependências e disciplinas avulsas (Req.08 e Req.08.1).




Venda Avulsa: deverá ser informado um ítem de venda a ser utilizado no momento da integração da venda avulsa (Req.15 – Vendas avulsas).








Expandir
titleAnexo customizado no cadastro de matriz aplicada

Pré-requisitos


Não se aplica.


Descrição do processo


Este anexo permite o preenchimento de informações adicionais do contrato do aluno para serem utilizadas no processo de Integração do contrato ERP.


Detalhamento do processo


O usuário deverá acessar no TOTVS Educacional o menu Currículo e Oferta | Matrizes curriculares, Anexo | Matriz Aplicada, por meio da edição de um registro,  Anexo | Dados do contrato ERP


.



Os seguintes campos serão disponibilizados por meio desta tela:

  • Valor sugerido do curso: usuário preencherá o valor sugerido do curso.
  • Quantidade de parcela: usuário informará a quantidade de parcelas “default” da matriz aplicada (curso).
  • Item de venda: usuário preencherá o item de venda.

Importante:

Um item de venda poderá estar associado a mais de uma matriz aplicada, desde que a matriz aplicada tenha somente o turno diferente de uma para a outra. Caso o usuário escolha o item de venda que já esteja associado a uma matriz aplicada diferente, a rotina customizada emitirá uma mensagem ao usuário e não permitirá que o cadastro seja concluído.




Expandir
titleAnexo customizado no cadastro de município

Pré-requisitos


Não se aplica.


Descrição do processo


Esse anexo permitirá o cadastrado do número IBGE de determinado município


Detalhamento do processo


O usuário deverá acessar no TOTVS Gestão Fiscal,  por meio do cadastro de município, localizado no menu | Cadastros | Município | Anexo | Dados IBGE.


O seguinte campo será disponibilizado por meio desta tela:

  • Número do IBGE (campo texto): usuário preencherá o código do IBGE associado ao município.


Observação: Através do cadastro do responsável financeiro (cliente/fornecedor), na aba de “endereço”, campo “código munícipio”, ao chamar a tela de listagem, é possível efetuar a edição de um município.


Expandir
titleHistórico dos dados de serviço odontológico

Pré-requisitos


É necessário executar o script “Totvs_Campos_Complementares” para criar os seguintes campos:

DTADESAOODONTO – Tipo DateTime

DTCANCSERVODONTO – Tipo DateTime

Ativar os campos complementares: ODONTO, DTADESAOODONTO, DTCANCSERVODONTO.


Descrição do processo


Este requisito possibilita a gravação do histórico das últimas informações antes da alteração dos seguintes campos complementares de matrícula no período letivo: Aderiu serviço odontolócio?, Data de adesão do serviço odontológico, Data de cancelamento do serviço odontológico.


Detalhamento do processo


Usuário acessa por meio do TOTVS Educacional, a matrícula no período letivo, localizada por meio do menu: Currículo e Oferta | Alunos | Matrícula no Período Letivo, para controle odontológico, existirão os seguintes campos complementares:

  • Aderiu Serviço Odontológico (SMATRICPLCOMPL.ODONTO);
  • Data de adesão do serviço odontológico (campo complementar a ser criado na tela de matrícula do período letivo);
  • Data de cancelamento do serviço odontológico (campo complementar a ser criado na tela de matrícula do período letivo)


A cada alteração de dados de um destes campos na matrícula do período letivo, as informações (dados antigos) serão armazenadas em tabela customizada para histórico. 


Expandir
titleProcesso de consulta de status do aluno no ERP

Pré-requisitos


Preencher o endereço e chave de acesso ao WebService de Matrícula conforme Req. 1.


Descrição do processo


Este processo possibilita a visualização do status do contrato do aluno no ERP.


Detalhamento do processo


Usuário acessa no TOTVS Educacional, o processo “Consulta do Status de contrato do aluno no ERP” na tela de “Contrato do ERP”, localizada na matrícula no período letivo, através do menu: Currículo e Oferta | Alunos | Processos, Matricular Aluno, Anexo | Contrato do ERP, seleciona um registro, Processos | Consulta do Status de contrato do aluno no ERP.



Na tela do processo, usuário avança a primeira etapa do processo para que sejam apresentados os dados referente ao status do contrato do aluno retornados pelo ERP.

Expandir
titleConsulta status do aluno no ERP

Pré-requisitos


Não se aplica.


Descrição do processo


Este processo acionará a integração de consulta do Status do aluno no ERP.


Detalhamento do processo


Conforme descrito no requisito 3.6, o usuário acionará a integração de consulta do Status do aluno no ERP.

No processo será consumido método de consulta disponibilizado pelo ERP, serão buscados os seguintes dados :

                Status do Contrato ERP

                Status do aluno.

Expandir
titleCancelamento exclusão, transferência, trancamento

Pré-requisitos


Parametrizar o(s) status de matrícula que o contrato pode ser rescindido por meio do menu Customização | Integrações ERP | Integração com o sistema ERP | Integração de Termos de Rescisão e Aditivos de Contrato | Rescisão de Contrato conforme Req. 1.


Somente um aluno deverá ser selecionado para execução do processo.


Descrição do processo


Este requisito verifica através do processo nativo de “Alteração de Situação de Matrícula” se a nova situação de matrícula selecionada está parametrizada conforme req.1, para rescisão de contrato. Em seguida realiza a rescisão do contrato ou inativação do aluno no sistema ERP, e apresenta o termo de encerramento/rescisão do contrato em PDF para o usuário.


Detalhamento do processo


Quando o usuário efetuar o processo de “alteração de situação de matrícula”, por meio do menu Secretaria | Matrícula | Matrícula no Período Letivo, em seguida, Processo | Alterar situação da matrícula, a rotina customizada verificará se a nova situação escolhida pelo usuário para a matrícula no período letivo se encontra parametrizada com o “status que o contrato pode ser rescindido” (conforme descrito por meio do requisito 1).


Caso esteja parametrizada, será verificado o tipo de contrato vinculado a matrícula do aluno conforme descrição a seguir:

        Se o contrato em questão for igual a “Pessoa Física com valor” ou “Pessoa Física com valor” será efetuada a rescisão do contrato

        Se o contrato em questão for igual a “Pessoa Jurídica”, “Pessoa Jurídica empresa estrangeira”, “Base Estadual/Nacional” ou “CEI”, será efetuada a inativação do aluno no contrato.


Por fim, será apresentado ao usuário o termo de rescisão do contrato em formato PDF.

Expandir
titleItem de Venda

Pré-requisitos


Preencher dados de conexão de acesso ao WebService do ERP no TOTVS Educacional | Customização | Parametrização das Integrações conforme Req. 1.


Descrição do processo


Este processo realiza integração do TOTVS Educaional com o sistema ERP para importação da lista de itens de venda.


Detalhamento do processo


Usuário deverá acessar o TOTVS Educacional | Menu Customização | Integração ERP | Processos Agendados | Item de venda ERP, ao qual será utilizado o JOBSERVER, por onde o usuário administrador poderá configurar a periodicidade que será agendada o processo  usado na integração do TOTVS Educacional x Sistema ERP.




O processo customizado automaticamente conforme agendamento do JOBSERVER realizará a integração do TOTVS Educacional com o sistema ERP realizando a importação dos itens de venda cadastrados no ERP.

Expandir
titleUnidade Operacional

Pré-requisitos


Este processo irá identificar o código da coligada da Filial de acordo com o CNPJ da Coligada cadastrada no TOTVS Serviços Globais.

Portanto, o usuário deverá atualizar o cadastro de Coligada no TOTVS Serviços Globais | Administração | Coligadas, de modo que as Filiais cadastradas no ERP tenham as Coligadas correspondentes cadastradas no TOTVS Serviços Globais.

Descrição do processo


Este processo realiza a importação do cadastro de Unidade Operacional (Filial) do sistema ERP para o TOTVS Educacional.


Detalhamento do processo


Usuário acessa o processo no TOTVS Educacional, através do Menu Customização | Integração ERP | Processos Agendados | Unidade Operacional do ERP, ao qual será utilizado o JOBSERVER, por onde o usuário administrador poderá configurar a periodicidade que será agendada o processo usado na integração do TOTVS Educacional x Sistema ERP.




O processo automaticamente conforme agendamento do JOBSERVER, realizará a integração com o sistema ERP, para obtenção da lista de unidade operacional atualizará

o cadastro de Filiais do TOTVS Educacional.


Expandir
titleModelos de contratos e termos aditivo e de rescisão

Pré-requisitos


Não existem pré-requisitos para este processo.


Descrição do processo


Este processo realiza a importação de modelos de contratos e termos de aditivo e rescisão cadastrados no sistema ERP, de modo que possam ser parametrizados por meio do req. 1 através do menu de Customização | Parametrização das Integrações | Integração com o sistema ERP | Integração de contrato | Modelo de contrato.


Detalhamento do processo


Usuário acessa o processo no TOTVS Educacional, através do Menu Customização | Integração ERP | Processos Agendados | Modelos de contratos e Termos aditivo e de rescisão do ERP, ao qual será utilizado o JOBSERVER, por onde o usuário administrador poderá configurar a periodicidade que será agendada o processo usado na integração do TOTVS Educacional x Sistema ERP.



O processo executará automaticamente conforme agendamento do JOBSERVER realizando a integração com o sistema ERP para obtenção da lista de modelos de contratos.

Posteriormente, este modelos estarão disponíveis para parametrização conforme req. 1.

Expandir
titleIntegração de contrato com sistema ERP

Pré-requisitos


Realizar as parametrizações conforme descrito no item “Parametrização das Integrações”.


Criar os campos complementares conforme tabela abaixo:


SMATRICPLCOMPL

Nome da coluna

Descrição

Tipo

Tamanho

Tabela dinâmica

ODONTO

Aderiu Serviço Odontológico?

Alfanumérico

10

SIMOUNAO

DTADESAOODONTO

Data Adesão

Alfanumérico

255


INTEGRADOAX

Integrado AX

Alfanumérico

10


EMPRESA

Empresa:

Alfanumérico

10


EBEP

EBEP?

Alfanumérico

10

SIMOUNAO

BAIXARENDA

Possui declaração de baixa renda?

Alfanumérico

10

SIMOUNAO

TIPOBOLSA

Tipo Bolsa

Alfanumérico

10


TIPODESC

Tipo de Desconto

Alfanumérico

10

TIPODESC

CATEGORIA

Categoria

Alfanumérico

10


CNPJAPREND

CNPJ de Aprendizagem (somente números)

Alfanumérico

20


ARTICULACAO

Articulação

Alfanumérico

10

ARTICULACA

TIPOGRAT

Condição do aluno

Alfanumérico

10

TIPOGRAT

SALUNOCOMPL

Nome da coluna

Descrição

Tipo

Tamanho

Tabela dinâmica

MOTIVOCPF

Motivo CPF não informado:

Alfanumérico

10

SMOTIVOCPF

Tabela dinâmica: SIMOUNAO

Código

Descrição

0

Não

1

Sim

Tabela dinâmica: MEIOPGTO

Código

Descrição

01

Descrição 01

02

Descrição 02

...

...




Descrição do processo


Este processo é responsável por realizar a integração das matriculas do TOTVS Educacional, com os contratos financeiros no sistema ERP.


Detalhamento do processo


Para realizar a integração, o usuário deverá acessar o processo customizado, localizado no menu “Matrícula e Avaliação | Matrículas | Processos | Integração de Contrato com sistema ERP”.



Uma vez acionado, o processo customizado realizará as seguintes validações antes de seguir com a integração:


  • Verifica se existe turma vinculada na matrícula.
  • Verifica se no cadastro da turma as datas de início e fim estão preenchidas.
  • Verifica se a data da matrícula é anterior ao mês atual e caso positivo verifica se o usuário tem permissão para executar a matrícula com data retroativa
  • Verifica se o status da matricula no período letivo esta cadastrada na parametrização “Status de Pré-Matriculado”.
  • Verifica se o contrato referente a matrícula foi enviado ao ERP anteriormente.
  • Verifica se o item de venda foi devidamente parametrizado na Matriz Aplicada.


Caso alguma das validações citadas acima, seja verdadeira, será apresentado uma mensagem ao usuário informando o motivo da inconsistência e o processo será interrompido.



Etapas para inclusão de contrato no ERP


Se o processo não encontrar nenhuma inconsistência, será apresentado um “wizard” onde o usuário deverá avançar todos os passos informando todas as obrigatoriedades antes de enviar o contrado ao ERP


Na primeira etapa, será apresentado os tipos de contrato. Caso o tipo de contrato selecionado esteja relacionado a Pessoa Física (PF), o campo "Modelo de Contrato" será obrigatório, caso o tipo de contrato selecionado esteja relacionado a Pessoa Jurídica (PJ), o campo “Número do contrato no ERP” será obrigatório.


Tipos de contrato PF:

  • Pessoa Física
  • Pessoa Física – Estrangeira


Tipos de contrato PJ:

  • Pessoa Jurídica
  • Pessoa Jurídica – Estrangeira
  • Base Estadual/Nascional
  • CEI




Para o campo “Modelo do contrato”, será listado todos os registros importados do ERP através da rotina customizada para agendamento e/ou execução localizada no menu “Customização | Integração ERP | Processos Agendados | Modelos de Contrato e Termos de aditivo e de rescisão do ERP”.


Para o campo “Número do Contrato no ERP”, o usuário deverá informar um código de contrato para que a rotina customizada verifique se este contrato está válido no sistema ERP e se existe vagas disponíveis.




  1. Tipo de Contrato PJ


Caso o tipo de contrato selecionado seja PJ, todas as consistências estejam de acordo e o usuário acione o botão “Executar”, a rotina customizada consumira o webservice do AX invocando o método “Contract_CorporateRegistrationInsert” passando as informações abaixo:


ID

Atributo

Descrição

Origem da informação no TOTVS

1

contractId

Número do contrato

Informação localizada no campo “Número do contrato no AX”

2

programId

Código do Item de Venda

Código do Item de venda parametrizado na Matríz Aplicada. ZPARAMHABILITACAOFILIAL.CODITEMVENDA

3

student

Informações do Aluno

Informação localizada na tabela abaixo (bloco Student).





  1. Tipo de Contrato PF


Caso o tipo de contrato selecionado seja PF, e todas as consistências estejam de acordo, a rotina customizada apresentará os passos abaixo:


Caso a opção “Habilita campos complementares do aluno no contrato” presente na parametrização da Integração de contrato esteja marcada, será apresentada o passo abaixo contendo as informações complementares da matrícula no período letivo .


Por meio desta tela, as informações não poderão ser alteradas. Sendo assim, as informações serão apresentadas apenas para consulta. Caso haja a necessidade de alterar estas informações, o usuário deverá efetuar por meio da matrícula no período letivo do aluno.


Image Added


Ao avançar, a rotina customizada, executará uma validação na data de matricula, verificando se a mesma é anterior ao mês corrente. Caso positivo, a  o processo deverá considerar a data inicial do mês e apresentará uma mensagem informativa ao usuário.


Após a execução da validação, será exibido o próximo passo com os dados do curso e data do contrato. Nessa etapa, os campos de data início e fim do contrato são de preenchimento obrigatórios.


Image Added


Image Added


Caso a opção “Utiliza serviço odontológico” presente na parametrização da Integração de contrato esteja marcada, será apresentada a etapa abaixo contendo as informações do código do serviço odontológico e valor do serviço odontológico que foram previamente cadastradas na parametrização.


Por meio desta tela, o usuário deverá informar se haverá ou não desconto odontológico através do campo “adesão de odonto escolar” e posteriormente a data de adesão do serviço odontológico.


Image Added



Ao avançar, será apresentado a etapa contendo as informações da parametrização da forma de pagamento, onde o usuário deverá informar os seguintes campos:


  • Desconto: Através deste campo, o usuário poderá adicionar um desconto no valor total do contrato.


  • Observação: Campo texto para que o usuário informe somente como descritivo o motivo da concessão do desconto no contrato.


  • Nº (id) solicitação de Bolsa e Desconto: Campo texto para que o usuário informe o número da identificação de solicitação (workflow) aberto no TOTVS para aprovação do desconto.


  • Parcelas: Campo para que o usuário informe a quantidade de parcela que será gerada para o pagamento, como “default” será buscada a informação parametrizada junto a matriz aplicada.


  • Vencimento da Primeira parcela: Usuário preencherá qual será o vencimento da primeira parcela.


  • Período: Campo para que o usuário informe a periodicidade do vencimento das demais parcelas, podendo ser fixa em todo dia X ou em um período de X dias.


Nesta etapa os campos de vencimento da primeira parcela e a periodicidade dos demais vencimentos, são de preenchimento obrigatórios.


Image Added


Depois de preencher os campos da condição de pagamento e acionar o botão avançar, será apresentado a etapa contendo as informações de todas as parcelas. Nesta etapa, o usuário poderá ajustar as datas de vencimento e os valores da parcela coso haja necessidade.


Image Added


Image Added



Ao final de todos os passos o usuário deverá acionar o botão “Executar”, onde a rotina customizada consumira o webservice do ERP invocando o método “Contract_IndividualRegistrationInsert” passando as informações abaixo:


ID

Atributo

Descrição

Origem da informação no TOTVS

1

ContractIndividual

Classe contendo todas as informações necessárias para incluir um contrato PF

Informação localizada na tabela abaixo (bloco ContractIndividual).