INTEGRAÇÃO TOTVS Educacional X Urânia

Contexto de negócio (Introdução)

A elaboração dos horários dos professores de uma Instituição de Ensino é um trabalho árduo e que requer muita atenção. Para fazer um horário escolar, deve-se considerar a especificidade de cada docente: disponibilidade de dias e horários e quais disciplinas ministra.

Sistemas Envolvidos

• TOTVS Educacional - O módulo Educacional gerencia escolas e faculdades (ensino básico e superior), por meio de ferramentas que permitem maior agilidade nos processos que envolvem os alunos, responsáveis, professores e os funcionários.
• Urânia - Software desenvolvimento para auxiliar na preparação de quadro de horários.

Integração

O TOTVS Educacional pode ser configurado para integrar com o sistema Geha/Urânia, com o objetivo de auxiliar na elaboração de horários para as turmas disciplinas, como para os professores.

Premissa:

Esta integração ocorre através de exportação e importação de arquivos xml.

• URANEXP.XML: Utilizado para exportar dados do Totvs Educacional para o Urânia.
• IMPORT_URANIA.XML: Utilizado para importar dados do Urânia para o Totvs Educacional.

Escopo

As entidades e os pontos de integração que farão parte do escopo dessa integração são:

Perfil de Acesso

Para definição do perfil de acesso para as funcionalidades relacionadas a integração com o Urânia o usuário deve acessar o módulo Serviços Globais | Segurança | Perfis, selecionar o contexto Educacional.

Segue árvore de permissões relacionada ao Urânia.

Perfil de acesso: Educacional | Integrações | Urânia

Parâmetros de Integração

Segue abaixo a definição de parâmetros para a utilização da integração entre TOTVS Educacional e Urânia.

O acesso ocorre por meio do TOTVS Educacional | Configurações | Parâmetros | Urânia

Utiliza Integração com o Urânia 

• O Urânia somente estará disponível se o TOTVS Educacional estiver parametrizado para integrar com o Urânia.

Utiliza "Ambiente " do Urânia como "sala" do TOTVS Educacional

• Com este parâmetro marcado no cadastro de sala é disponibilizado o campo "Referência de sala para o Urânia" para que seja informado a referência do Ambiente no cadastro da sala.

Permitir atualização dos horários da turma disciplina que possua professor com folha de pagamento aprovada 

• Os horários serão atualizados somente se o controle de aprovação dos dados da folha de pagamento estiver ativo. Assim acesse: Parâmetros | Integração| Folha | Folha 2/2 " Utiliza controle de alteração de registro", marque a opção Professor da Turma/Disciplina.

Permitir alteração de salas via integração após a matrícula de aluno  

Permitir alteração de professores da turma/disciplina via integração após a matrícula de alunos

Permitir alteração de horários via integração após a matrícula de alunos

Permitir atualização de turma/disciplina com conteúdo previsto preenchido no plano de aula 

Pré-requisitos instalação/implantação/utilização

Não é escopo desse documento descrever as instalação do ERP RM e nem sua configuração.

RM

Utilizar a versão RM 12.1.15 ou superior.

Controle de Versão

O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.

Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.

Suporte

O suporte aos recursos da Integração será de responsabilidade de todas as linhas, sendo assim as equipes de suporte dos produtos RM Conector e Backoffice Protheus estarão aptas a fazer a primeira análise e, quando necessário, repassar para a equipe mais adequada em cada caso.

Observação: Este modelo de suporte está sendo revisado pela TOTVS.

Cadastros

Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.

Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos

Em seguida faça uma descrição para cada um dos fluxos para cada entidade

<Transação/Entidade>

Identificador da Mensagem: <mensagem>

Versão: <versão>

Módulo <marca 1>: <BackOffice – Gestão xxxxxxx>

Módulo <marca 2>: <SIGAXXX>

Tipo de Envio: <Assíncrona/Síncrona>

Notas:

Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela

A seguir descrever as variações, particularidades da mensagem e processos (integração) de acordo com cada marca

Limitações/Restrições

Descreva limitações e restrições para a integração que está sendo descrita.

Processos

Exportação de dados Urânia

Para exportar os registros de Disciplinas, Turmas, Professores, e a Gradedeve-se utilizar o processo de Exportação de dados Urânia. Tal processo é  acessado em Integrações | Urânia | Exportação de dados Urânia.

Ao executar o processo e preciso informar também o total de aulas por dias das turmas, quais os dias da semana que irão ocorrer as aulas e onde será gerado o arquivo com os dados que é importado para o Urânia. Esse processo se gerar o arquivo “URANEXP.XML”, através do TOTVS Educacional.

Após selecionar as entidades Disciplinas, turmas e Grade irá adicionar um passo no processo para que seja selecionado as turmas. Estas poderão ser selecionadas utilizando o filtro da turma através do curso, habilitação e turma, ou por seleção de consulta SQL ou por filtro de globais.

Se selecionado a entidade Professor será exibido um passo no processo para identificar os professores que serão importados.

Ao concluir a execução do processo será exibido informações no log das entidades que foram exportadas para o arquivo URANEXP.XML”. O arquivo criado está seguindo o layout definido disponibilizado pelo Urânia. 

Importante

O log do processo informa:

• Se existe turmas associadas a um turno que não possui nenhum agrupamento de horário informado;
• Se existe turmas que não tem agrupamento de horário definido e o turno associado estiver a definição de mais de um agrupamento;
• Se o número de horários do agrupamento da turma for diferente do valor total de aulas definido no processo;
• Quando existir informações no layout do urânia menores que as respectivas informações do TOTVS Educacional e que precisarem forem truncadas;
• Cadastros que não foram exportados.

Ao executar o processo, se estiver parametrizado para exportar "Grades" (turmas/disciplinas) irá apenas as turmas/disciplinas ativas e que não sejam gerenciadas.

Consistências realizadas no processo

Nome da turma

O campo "Nome turma" do arquivo de "turmas" está relacionado ao nome reduzido do cadastro de turma do TOTVS Educacional. Caso o campo do cadastro da turma estiver vazio ou for maior que o definido no layout, a turma não será informada no arquivo.

Número de aulas

O campo "Número de aulas" do arquivo de "Disciplinas" está relacionado ao número de aulas do cadastro de turma/disciplina do TOTVS Educacional e este deve estar preenchido, caso o mesmo esteja em branco a  a turma/disciplina não será informada no arquivo.

Abreviatura do professor

O campo "Abreviatura" do arquivo de "professores" está relacionado ao campo apelido do cadastro de professores do TOTVS Educacional. Caso o campo do cadastro do professor  estiver vazio ou for maior que o definido no layout, o professor não será informado no arquivo.

Observação: Quando é exportado além dos dados um turno integral para o urânia, o Sistema divide o turno em dois para facilitar a criação dos horários. Assim na hora de importar para o Educacional é necessário selecionar a opção de exportar vários arquivos no sistema urânia para que haja a unificação dos dois horários, e o sistema educacional receba um único arquivo contendo todos os horários do turno integral.

Importação Dados urânia

Através deste processo é possível importar as alocações de salas e professores do Urânia para o TOTVS Educacional. 

Na execução do processo é informado o período letivo, o período do turno e o arquivo que foi gerado no Urânia.

Observação: Este processo não atualiza os dados da turma/disciplina, as informações importadas são armazenadas em um estrutura temporária que possibilita a conferência das informações antes da efetivação na base de dados. O processo respeitará o contexto corrente do usuário.

Durante o processo de importação algumas validações são realizadas:

• Verifica a existência da turma referenciada no arquivo de importação;

• Verifica a existência da turma/disciplina referenciada no arquivo de importação;

• Verifica a existência do professor referenciado no arquivo de importação;

• Verifica a existência da sala (ambiente) referenciado no arquivo caso o parâmetro "Utiliza "Ambiente” do Urânia como “Sala" do TOTVS Educacional estiver habilitado;

• Verifica a existência da relação entre aula e o horário do TOTVS Educacional;

• Parâmetro "Permitir atualização de turma/disciplina com conteúdo previsto preenchido no plano de aula" desabilitado;

• Parâmetro "Permite atualização dos horários da turma/disciplina que possua professor com folha de pagamento aprovada" desabilitado;

• Verifica a existência de alunos matriculados.

Ao concluir a execução, é informado no log:

• Quantidade de turmas/disciplinas sugeridas apagadas: Número de turmas/disciplinas que foram importadas na execução anterior do processo para o período letivo e turno

• Quantidades de turmas/disciplinas: Número de turmas/disciplinas que é importada

• Quantidade de turmas/disciplinas sugeridas com pendência/aviso no log: Número de turmas/disciplinas que possuem algum tipo de inconsistência, podem ser do tipo pendência: log que precisa de alguma ação do usuário ou aviso: log para o qual existem permissões no processo de importação definitiva e dependendo da escolha do usuário poderá impedir ou permitir a atualização da turma/disciplina.

• Quantidade de turmas/disciplinas sugeridas sem pendência/aviso no log: Número de turmas/disciplinas que foram importadas e não ocorreu nenhuma inconsistência.

• Detalhes da importação de cada turma/disciplina.

Estrutura das turmas/disciplinas importadas do Urânia

Cria estrutura de oferta a partir da turmas disciplinas importadas

<Transação/Processo>

Tipo de Fluxo: Protheus -> RM

Mensagem: Request_1_000

Versão: 1.000

Descrição de todo o comportamento e funcionamento do processo. Breve contexto, origem, regras, integração (geração da mensagem, envio, recebimento no destino), o quê supostamente irá ocorrer no destino, retorno, impacto, consequências, o que foi afetado, como conferir, validar, etc o retorno.

Acrescentar um diagrama do processo.

A seguir descrever as variações, particularidades da mensagem e processos (desta integração) de acordo com cada marca

Notas:

Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela

Limitações/Restrições

Descreva limitações e restrições para a integração que está sendo descrita. 

Limitações / Restrições Gerais

Descreva limitações e restrições para cada fluxo descrito no tópico anterior. Exemplo:

• ERP1 envia ITEM cadastrado para o ERP2

ERP1 somente enviará o ITEM se este estiver em uma das famílias cadastradas no parâmetro FAMILIA_INTEGRACAO.

Se o tipo de valorização do estoque for FIFO.

• ERP2 envia PEDIDO cadastrado para o ERP1

O pedido recebido no ERP1 vindo do ERP2 estará bloqueado para alteração.

Como fazer (opcional)

Descreva os passos que viabilizem a integração.

Exemplo:

Os passos para viabilizar a integração são:

• No Logix ou no Protheus efetue o cadastro das seguintes informações: Clientes, fornecedores, transportadores, cidades, cotação de moeda e unidades de medida.
• No Logix cadastrar um novo depositante e efetuar toda a parametrização necessária para a operação de WMS.
• No Logix cadastrar um novo produto que seja controlado pelo WMS, para o depositante cadastrado anteriormente.
• No Logix efetuar um processo de recebimento para o produto cadastrado anteriormente, utilizando uma nota fiscal provisória (tipo “A”).
• No Protheus consultar a nota fiscal de recebimento que foi registrada no Logix, validando as informações recebidas.
• No Logix efetuar um processamento de regularização fiscal, efetuando a cobertura dos produtos recebidos anteriormente.
• No Protheus verificar se foi efetuado corretamente o relacionamento entre os dois documentos.
• No Logix efetuar um processo de expedição para o novo produto cadastrado, até o momento do envio da mensagem de integração de pedido de venda.
• No Protheus efetuar o faturamento do pedido de venda recebido.
• No Protheus verificar se a nota fiscal gerada contém todas as informações necessárias para o segmento de operador logístico (armazém geral).
• No Protheus efetuar a escrituração fiscal das notas fiscais, verificando se as regras da legislação deste segmento foram respeitadas.
• No Logix é possível consultar o número do pedido de venda gerado para as notas fiscais de retorno simbólico e conta/ordem no programa WMS6333 (Consulta de Documentos). Para os processos de faturamento de serviço o número do pedido está disponível no programa WMS6411 (Movimentos a Faturar).

Situações comuns (opcional)

Descreva situações problemáticas comuns que podem ocorrer durante o funcionamento da integração e como solucioná-los. Neste ponto também é importante dar instruções de como reconhecer e investigar problemas que podem vir a ocorrer durante a integração. Se houver, apresente tabelas de códigos e descrições de erros que a integração poderá apresentar.

Este tópico possivelmente será alimentado com as experiências durante o desenvolvimento da integração e poderá ser realimentado durante o uso da integração no cliente.

Exemplo 1:

Tratamento de erros de integração (Produto A)

Tratamento de erros de integração (Produto B)

Exemplo 2:

Quando uma mensagem é enviada do Logix para o Protheus, podem ocorrer situações em que o WebService não estará totalmente funcional. Nestes casos uma mensagem de erro genérica irá aparecer na tela:

Exemplo:

Erro ao enviar a mensagem de Cidade via Integração

Se o arquivo de log for analisado, poderemos ver a falha na comunicação com o sistema destino:

-------------------------------------------------------------------------------

WSCERR044 / Não foi possível POST : URL http://172.16.31.57:8011/ws/FWWSEAI.apw

ADVPL WSDL Client 1.080707 / tst on 20120315 08:49:51

-------------------------------------------------------------------------------

Para resolver este problema, verifique as configurações do sistema de destino, analisando o funcionamento do servidor utilizado para esta comunicação e a habilitação do endereço do WebService. 

Checklist de suporte da aplicação

Crie um check-list de verificação de alguns pontos importantes para o funcionamento e atendimento da integração.

Instalação/Configuração

Relacione itens de verificação para garantir que a integração está corretamente instalada e configurada. Isto não pode ser uma cópia do procedimento de instalação/configuração, mas verificações pontuais que podem remeter aos itens da instalação.

Checklist de Verificações:

Relacione itens de verificações para que o atendente possa:

• Identificar o funcionamento da integração;
• Identificar a ocorrências de problemas;
• Coletar evidências do mau funcionamento relatado pelo cliente;
• Realizar possíveis ajustes na integração quanto à configuração ou negócio.

Anexos