Histórico da Página
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|
Informações Gerais
Especificação | |||
Produto | TOTVS Educacional | Módulo | EDU |
Segmento Executor | Educacional | ||
Projeto1 | PDR_EDU_EDU021 | IRM1 | PCREQ-10616 |
Requisito1 | PCREQ-10620 | Subtarefa1 | PDR_EDU_EDU021-2 |
Chamado2 |
| ||
País | ( X ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colombia ( ) Outro _____________. | ||
Outros | <Caso necessário informe outras referências que sejam pertinentes a esta especificação. Exemplo: links de outros documentos ou subtarefas relacionadas>. |
Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos).
(Obrigatório)
Objetivo
<Nesta etapa informar o objetivo da especificação do requisito, ou seja, o que a funcionalidade deve fazer. Exemplo: Permitir que o usuário defina o percentual mínimo em espécie (dinheiro), a referência mínima para calculo dos débitos do aluno e o período de validade do parâmetro de negociação>.
(Obrigatório)
Permitir que empresas possam se cadastrar como parceiras através de uma página pública disponibilizada no Portal RM.
Definição da Regra de Negócio
<Regra de negócio é o que define a forma de fazer o negócio, o processo definido e/ou as regras que devem ser contempladas. Devem ser descritas restrições, validações, condições e exceções do processo. Caso necessário, incluir neste capítulo também regras de integridade que devem ser observadas no momento do desenvolvimento>.
<Na tabela abaixo informe quais são as rotinas envolvidas, o tipo de operação, a opção de menu e se necessário uma breve descrição das regras de negócio relacionadas a rotina>.
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
[ACAA040 – Parâmetros]Página pública para cadastro da empresa parceira e responsável | [AlteraçãoCriação] | [Atualizações -> Acadêmico-> Tesouraria] | - |
[ACAA050 – Negociação Financeira] | [Envolvida] | [Atualizações -> Acadêmico-> Tesouraria] | - |
Portal RM | - | ||
Fluxo para aprovação do cadastro da empresa parceira e responsável | [Criação] | FLUIG | - |
Fluxo para cadastro de funcionários da empresa parceira já cadastrada[ACAA060 – Cadastro de Pedidos] | [Criação] | [Atualizações -> Acadêmico-> Cadastros] | - |
Exemplo de Aplicação:
- Criar o campo “% Mínimo Espécie” (AAA_PERESP) onde o usuário informará o % que o aluno pagará em dinheiro. Esse % poderá ser alterado durante a negociação.
- Criar o campo “Referência Mínima para Cálculo” (AAA_REFCAL) onde o usuário informará um dos 4 valores disponíveis para pagamento das mensalidades como a referência mínima para calcular o débito total do aluno.
- Criar o parâmetro MV_ACPARNE que definirá se as informações de “% Mínimo Espécie” e “Referência Mínima para Cálculo” serão obrigatórias.
- O parâmetro MV_ACPARNE deve ter as seguintes opções: 1=Obrigatório e 2=Opcional. Deve ser inicializado como opcional>.
Tabelas Utilizadas
- SE2 – Cadastro de Contas a Pagar
- FI9 – Controle de Emissão de DARF>.
Opcional
Protótipo de Tela
<Caso necessário inclua protótipos de telas com o objetivo de facilitar o entendimento do requisito, apresentar conceitos e funcionalidades do software>.
Protótipo 01
Opcional
Fluxo do Processo
<Nesta etapa incluir representações gráficas que descrevam o problema a ser resolvido e o sistema a ser desenvolvido. Exemplo: Diagrama - Caso de Uso, Diagrama de Atividades, Diagrama de Classes, Diagrama de Entidade e Relacionamento e Diagrama de Sequência>.
Opcional
Dicionário de Dados
Arquivo ou Código do Script: AAA – Negociação Financeira / *Versao=CP.2014.12_03*/
Índice | Chave |
01 | <FI9_FILIAL+FI9_IDDARF+FI9_STATUS> |
02 | <FI9_FILIAL+FI9_FORNEC+ FI9_LOJA+FI9_EMISS+FI9_IDDARF> |
03 | <FI9_FILIAL+FI9_FORNEC+ FI9_LOJA+FI9_PREFIX+FI9_NUM+FI9_PARCEL+FI9_TIPO> |
Campo | <AAA_PERESP> |
Tipo | <N> |
Tamanho | <6> |
Valor Inicial | <Varia de acordo com o tipo informado. Por exemplo, quando o campo “tipo” for date, neste campo pode ser informado uma data>. |
Mandatório | Sim ( ) Não ( ) |
Descrição | <Referência Mínima para Cálculo> |
Título | <Ref.Calc.> |
Picture | <@E999.99> |
Help de Campo | <Informar o % que o aluno pagará em dinheiro. Esse % poderá ser alterado durante a negociação> |
(Opcional)
Grupo de Perguntas
<Informações utilizadas na linha Protheus>.
Nome: FINSRF2
X1_ORDEM | 01 |
X1_PERGUNT | Emissão De |
X1_TIPO | D |
X1_TAMANHO | 8 |
X1_GSC | G |
X1_VAR01 | MV_PAR01 |
X1_DEF01 | Comum |
X1_CNT01 | '01/01/08' |
X1_HELP | Data inicial do intervalo de emissões das guias de DARF a serem consideradas na seleção dos dados para o relatório |
(Opcional)
Consulta Padrão
<Informações utilizadas na linha Protheus>
Consulta: AMB
Descrição | Configurações de Planejamento |
Tipo | Consulta Padrão |
Tabela | “AMB” |
Índice | “Código” |
Campo | “Código”; ”Descrição” |
Retorno | AMB->AMB_CODIGO |
FLUIG | - |
Pré-requisitos para utilizar a funcionalidade de cadastro de empresa parceira
- Ter o FLUIG devidamente instalado e configurado conforme documentação:
- Ter o TOTVS Developer Studio (TDS) devidamente instalado e configurado.
- Criar no FLUIG os papéis necessários para a execução dos fluxos de cadastro de empresa parceira e cadastro de funcionário da empresa parceira. É importante criar da mesma forma descrita abaixo pois o fluxo utiliza essa definição para referenciar os papéis).
- Código = aprovador_parcerias | Descrição = Aprovador de parcerias
- Código = responsavel_empresa_parceira | Descrição = Responsável pela empresa parceira
- Associar adequadamente os usuários do FLUIG aos papéis criados anteriormente.
- É importante ter o usuário mestre criado em todas as empresas para que, ao executar a página pública, o sistema consiga validar o usuário que iniciará a solicitação.
- Importar os fluxos "Cadastro de Empresa Parceira" e "Cadastro de Funcionário da Empresa Parceira" para a ferramenta TOTVS Developer Studio (TDS). Caso não tenha alterado a instalação padrão dos produtos TOTVS, os arquivos zipados, contendo o(s) fluxo(s), estarão disponíveis em c:\totvs\CorporeRM\ObjetosGerenciais\Fluig
- Exportar para o servidor do FLUIG os datasets, diagrama, formulário e eventos dos fluxos "Cadastro de Empresa Parceira" e "Cadastro de Funcionário da Empresa Parceira".
A nova solução permitirá que empresas interessadas em ser parceiras da instituição possam solicitar seu cadastro através de uma página pública da instituição (Figuras 1 e 2), disponibilizada no Portal RM.
Parâmetros necessários:
- A funcionalidade permitirá a geração de usuários no RM e para isso novos parâmetros serão criados para permitir a criação automática desses usuários.
- Na etapa 15.09 - Geração de Usuários será criada sub-etapa 15.09.03 - Funcionário Empresa Parceira (Figura 3).
- Nessa opção será permitido parametrizar se a geração será automática ao salvar um funcionário da empresa parceira e quais as regras deverão ser seguidas. (Figuras 4, 5 e 6).
Arquivo web.config:
- Caso o usuário deseje, poderá fazer uso do reCAPTCHA do Google, para impedir a entrada de dados automatizada na página pública. Para configurar o uso do reCAPTCHA é preciso seguir os seguintes passos:
- Acessar o arquivo web.config da pasta "Source/Edu-Educacional/Public/EmpresaParceira/" da instalação do portal para configurar a tag EXIBIR_RECAPTCHA para "true".
- Será necessário preencher também as tags SITE_KEY e SECRET_KEY, desse mesmo arquivo web.config, seguindo as orientações fornecidas pelo Google em https://www.google.com/recaptcha/ para o correto funcionamento.
- Para o correto funcionamento da solução as tags PROCESSID e USERID, desse mesmo arquivo web.config, devem estar configuradas com "rm_edu_dgr_empresa_parceira" e "mestre" respectivamente. Essas informações definem qual fluxo (PROCESSID) deverá ser executado pelo webservice do FLUIG e qual usuário será responsável por iniciar a solicitação (USERID).
Funcionamento da solução:
Através da página pública, a empresa fará seu cadastro, disponibilizando informações necessárias tais como CNPJ, nome fantasia, e-mail, etc., e dados de uma pessoa responsável. Esse responsável será o contato entre empresa e instituição, e o primeiro usuário dessa empresa a ser cadastrado no Portal RM.
Por padrão esta página pública estará com acesso restrito impossibilitando a utilização do cadastro, sendo necessário para os clientes que queiram utilizá-la, a parametrização do arquivo web.config (<allow users="*"/>) e a disponibilização do link http://PORTAL/Source/Edu-Educacional/Public/EmpresaParceira/EduEmpresaParceira.aspx, onde PORTAL é o endereço do Portal RM instalado e configurado no cliente.
Após realizar o cadastro na página pública, essas informações serão encaminhadas para a instituição através de um fluxo do FLUIG (Cadastro de Empresas Parceiras) (Figura 7). O sistema criará automaticamente a solicitação no FLUIG, permitindo que algum usuário, vinculado ao papel de “aprovador_parcerias”, assuma essa solicitação e possa realizar a aprovação desse cadastro.
Após aprovação ou rejeição do cadastro, o sistema deverá enviar e-mail à empresa indicando o status de sua solicitação. Esse status será enviado ao e-mail cadastrado para a pessoa responsável, definido na página pública e será feito através do FLUIG. O FLUIG utiliza templates para realizar o envio de e-mails personalizados, para mais detalhes acessar o link Envio de e-mail personalizado. Os nomes dos templates de e-mail utilizados pelos fluxos são:
- solicitacao_empresa_parceira - enviado ao solicitar o cadastro da empresa
- solicitacao_empresa_parceira_aprovada - enviado ao aprovar o cadastro da empresa
- solicitacao_empresa_parceira_reprovada - enviado ao reprovar o cadastro da empresa
- solicitacao_funcionario_empresa_parceira - enviado ao solicitar o cadastro do funcionário
- solicitacao_funcionario_empresa_parceira_aprovada - enviado ao aprovar o cadastro do funcionário
- solicitacao_funcionario_empresa_parceira_reprovada - enviado ao reprovar o cadastro do funcionário
Caso o cadastro seja aprovado e o parâmetro para geração automática de usuário esteja marcado (conforme parametrização descrita acima) o sistema fará a geração desse usuário para ser utilizado no Portal RM.
***IMPORTANTE***- Se a instituição quiser permitir o acesso desse usuário ao FLUIG, deverá posteriormente realizar o sincronismo RM x FLUIG através da visão de usuários no RM e vincular esse usuário ao papel “responsavel_empresa_parceira” através do módulo de administração do FLUIG.
- O usuário criado, passa a ter acesso ao Portal RM para usufruir dos recursos relacionados ao portal de estágio e poderá também cadastrar novos funcionários para a empresa utilizando a funcionalidade disponibilizada no FLUIG, caso tenha acesso.
- Para cadastrar novo funcionário da empresa, o usuário responsável deverá:
- Acessar o fluxo “Cadastro de Funcionários de Empresa Parceira” no FLUIG e gerar uma nova solicitação.
- Após solicitar o cadastro do novo funcionário no FLUIG, essa solicitação deverá ser aprovada por um usuário vinculado ao papel “aprovador_parcerias” (Figura 8). O mesmo procedimento descrito acima, para geração de usuário RM, também acontecerá após aprovação dessa solicitação no FLUIG.
Alterações de banco:
- Será criado o campo NUMPROCESFLUIG nas tabelas SEMPRESA e SEMPRESAFUNCIONARIO para permitir que o número da solicitação do FLUIG seja gravado quando da aprovação dos fluxos de cadastro de empresa e cadastro de funcionário da empresa. Assim teremos rastreabilidade e poderemos diferenciar as empresas/funcionários cadastrados pelo FLUIG ou pelo RM.
Protótipo de Tela
Página Pública, disponibilizada no Portal RM.
Figura 1
Figura 2
Parametrizador
Figura 3
Figura 4
Figura 5
Figura 6
Fluxo de aprovação do cadastro de parceria (FLUIG)
Figura 7
Fluxo de aprovação do cadastro de funcionário da empresa (FLUIG)
Figura 8
(Opcional)
Estrutura de Menu
<Informações utilizadas na linha Datasul>.
Procedimentos
Procedimento |
|
|
|
Descrição | (Max 40 posições) | (Max 40 posições) | (Max 40 posições) |
Módulo |
|
|
|
Programa base |
|
|
|
Nome Menu | (Max 32 posições) | (Max 32 posições) | (Max 32 posições) |
Interface | GUI/WEB/ChUI/Flex | GUI/WEB/ChUI/Flex | GUI/WEB/ChUI/Flex |
Registro padrão | Sim | Sim | Sim |
Visualiza Menu | Sim/Não | Sim/Não | Sim/Não |
Release de Liberação |
|
|
|
Programas
Programa |
|
|
|
Descrição | (Max 40 posições) | (Max 40 posições) | (Max 40 posições) |
Nome Externo |
|
|
|
Nome Menu/Programa | (Max 32 posições) | (Max 32 posições) | (Max 32 posições) |
Nome Verbalizado[1] | (Max 254 posições) | (Max 254 posições) | (Max 254 posições) |
Procedimento |
|
|
|
Template | (Verificar lista de opções no man01211) | (Verificar lista de opções no man01211) | (Verificar lista de opções no man01211) |
Tipo[2] | Consulta/Manutenção/ Relatório/Tarefas | Consulta/Manutenção/ Relatório/Tarefas | Consulta/Manutenção/ Relatório/Tarefas |
Interface | GUI/WEB/ChUI/Flex | GUI/WEB/ChUI/Flex | GUI/WEB/ChUI/Flex |
Categoria[3] |
|
|
|
Executa via RPC | Sim/Não | Sim/Não | Sim/Não |
Registro padrão | Sim | Sim | Sim |
Outro Produto | Não | Não | Não |
Visualiza Menu | Sim/Não | Sim/Não | Sim/Não |
Query on-line | Sim/Não | Sim/Não | Sim/Não |
Log Exec. | Sim/Não | Sim/Não | Sim/Não |
Rotina (EMS) |
|
|
|
Sub-Rotina (EMS) |
|
|
|
Localização dentro da Sub Rotina (EMS) |
|
|
|
Compact[4] | Sim/Não | Sim/Não | Sim/Não |
Home[5] | Sim/Não | Sim/Não | Sim/Não |
Posição do Portlet[6] | 0 – Top Left 1 – Top Right 2 – Bottom Left 3 – Bottom Right | 0 – Top Left 1 – Top Right 2 – Bottom Left 3 – Bottom Right | 0 – Top Left 1 – Top Right 2 – Bottom Left 3 – Bottom Right |
Informar os papeis com os quais o programa deve ser vinculado |
|
|
|
Cadastro de Papéis
<O cadastro de papéis é obrigatório para os projetos de desenvolvimento FLEX a partir do Datasul 10>.
<Lembrete: o nome dos papeis em inglês descrito neste ponto do documento, devem ser homologados pela equipe de tradução>.
Código Papel | (máx 3 posições) |
Descrição em Português* |
|
Descrição em Inglês* |
|
[1] Nome Verbalizado é obrigatório para desenvolvimentos no Datasul 10 em diante.
[2] Tipo é obrigatório para desenvolvimento no Datasul 10 em diante
[3] Categorias são obrigatórias para os programas FLEX.
[4] Obrigatório quando o projeto for FLEX
[5] Obrigatório quando o projeto for FLEX
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|