Histórico da Página
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|
(Obrigatório)
Informações Gerais
Especificação | |||||||||||||||||||
Produto | CRM | Módulo | CRL - Relacionamento | ||||||||||||||||
Segmento Executor | Manufatura | ||||||||||||||||||
Projeto1 | IRM1 |
| |||||||||||||||||
Requisito1 |
| Subtarefa1 |
| ||||||||||||||||
Chamado2 |
| ||||||||||||||||||
País | ( X ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colombia ( ) Outro _____________. | ||||||||||||||||||
Outros |
Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos).
(Obrigatório)
Objetivo
Desenvolver a interface que irá renderizar o questionário para ser respondido.
Esta interface será utilizada tanto para execução interna quanto externa.
A funcionalidade deverá ser desenvolvido em HTML utilizando o THF (TOTVS HTML Framework).
(Obrigatório)
Definição da Regra de Negócio
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
Execução de Questionários | Criação | - | - |
Tabelas Utilizadas
- crm_script
- crm_script_pag
- crm_script_quest
- crm_script_quest_atrib
- crm_script_respos
- crm_script_respos_quest
Legado
A funcionalidade de questionários deve ser retirada do módulo de foundation e reformulada para o módulo de CRM visando uma maior aderência aos processos de CRM. Sendo assim, os cadastros e rotinhas desenvolvidos em FLEX/Metadados serão desativados e não serão migrados para a nova estrutura. As entradas de menu das funcionalidades de questionários, atualmente no Foundation > Questionários, serão desabilitas e não mais visíveis no menu.
Geral
- A engine será desenvolvida utilizando o THF (TOTVS HTML Framework) obedecendo as diretrizes já utilizadas pelo CRM HTML;
- Está engine estará disponível para execução dos questionário internos (Modal) e externos (TOTVS RFI).
Engine
A renderização do questionário obedece a estrutura (páginas, ordem e numeração) definida no cadastro do mesmo e deve ser totalmente responsiva, inclusive para mobile (smartphones).
Somente é permitida a renderização e execução de questionário que ainda não tenham expirado e que não estejam concluídos. Caso o questionário esteja expirado ou concluído o sistema notifica o usuário a respeito e encerra automaticamente a execução. A informação de validade está disponível em: crm_script.val_inic_valid / crm_script.val_fim_valid.
A informação de completude do questionário está dísponivel através do campo: crm_script_respos.idi_status; sendo: 1. Pendente | 2. Parcial | 3. Finalizado.
As questões renderizadas em cada página deve seguir a seguinte componentização:
Tipo | Componente | Observação |
---|---|---|
1. Texto | Totvs Text Area | Por padrão deve ser renderizado com apenas 1 linha e deve permitir ser expansivo verticalmante. |
2. Múltipla Seleção | Totvs MultiSelect | Lista com a opção de múltipla escolha. |
3. Seleção Única | Totvs Select | Lista para seleção única. |
4. Radio | Totvs Radio (DEPRECATED) | Pode ser utilizando o bsswitch como alternativa para utilizar o conceito mobile de on/off. |
5. Checkbox | Totvs Checkbox (DEPRECATED) | Deve ser renderizado horizontalmente. Quando mobile (smarphones), verticalmente. |
6. Data | Totvs Datepicker | Somente seleção de data. |
7. Hora | Totvs Time | Somente seleção de hora/minuto. |
8. Matriz | Totvs Radio (DEPRECATED) | No caso da matriz, deve ser renderizado uma linha para cada atributo (valor) da questão (eixo y) e para cada opção da faixa (eixo x) um 'radio'. Cada item da matriz é de única seleção, ou seja, não é permitida a seleção de mais de um opção da faixa disponível. |
9. Introdução | - | Texto livre, pode ser renderizado apenas dentro de um elemento HTML do tipo '<p>'. |
A definição do tipo de questão se da através do campo: crm_script_quest.idi_tip_quest
Quando a questão multivalorada possuir um atributo marcado como 'Outro', através do campo 'crm_script_quest_atrib.log_livre_1 = true', o sistema disponibiliza um campo de texto para que o entrevistado possa inserir as informações a mais. Este campo de texto somente fica ativo quando a opção correspondente estiver marcada. Caso a questão seja obrigatória e o usuário selecione esta opção então o campo de texto passa a ser obrigatório também. Este atributo sempre será renderizado como último atributo da questão.
Na rederização das questões, as observações/descrições deve ser exibidas logo a baixo do enunciado.
As questões de resposta obrigatória possuem indicação visual através do caractere asterisco '*'.
A informação do número da questão é desconsiderada na renderização desta forma o título de uma questão pode ser resumido a: * Qual o seu nome?
A navegabilidade entre as página se dá através do botões 'Anterior' e 'Próxima'. Sempre que acionado o botão 'Anterior' o usuário deve ser destinado a última página visualizada. Já quando acionado o botão 'Próxima', o sistema deve sempre verifica se todas as questões obrigatórias foram respondidas e encaminha o usuário para a próxima página; nos casos em que exista alguma questão obrigatória não respondida o sistema notifica o usuário a respeito da questão pendente. Caso exista uma questão com desvio cadastrado na página, então o sistema deve verificar se o requisito para desvio foi atendido; quando atendido o sistema deve direcionar o usuário para a página especificada no desvio, caso contrário segue o fluxo padrão.
Informações |
---|
Cada página poderá possuir apenas um único desvio. Este desvio somente será permitido através de questões de seleção única ou radio. Para o desvio deverá ser informado uma página alvo subsequente. Não é permitido informar um desvio para uma página antecedente. |
Independente da página em que o usuário se encontra, exceto na última página, sempre existe a possibilidade de salvar o andamento do questionário. Quando está operação for solicitada o sistema questiona se o usuário gostaria de prosseguir com a operação e o informa que o formulário não será encerrado e poderá ser continuado posteriormente.
Entretanto, quando usuário estiver na última página a opção de salvar é substituída pela operação de finalizar. Uma vez finalizado o questionário não pode mais ser alterado.
A comunicação entre a engine o servidor, tanto para operação de renderização quando persistência sempre trafega o dataset completo com toda a estrutura do questionário.
A operação de cancelar encerra a execução do questionário sem realizar a persistência no banco de dados. Antes de efetivar essa operação o usuário deve realizar a confirmação da mesma.
Ao finalizar o questionário, antes da persistência, o sistema deve realizar o cálculo do peso das questões, páginas e do questionário em si para armazenar o indicador no campo: crm_script_respos.val_peso.
Dica |
---|
Fórmula: Calcular o % total dos atributos em caso de múltipla escolha e que tenha sido informado o peso para os atributos; Em seguida, aplicar esse % obtido sob o % total da questão para obter o valor que a questão resultou para a página. Realizar este procedimento para cada questão da página. Após somar todos os % das questões, este % deve ser aplicado sob o % total estimado para a página. Ao final, deve ser somado os % de cada página do questionário para obter o peso final da resposta do questionário. |
Antes de efetivar a persistência das respostas, o sistema verifica questão por questão qual o tipo referido e quando identificada questões do tipo multivaloradas deve realizar o tratamento para que o código dos atributos selecionados sejam persistidos no campo crm_script_respos_quest.dsl_resp de forma sequencial sendo separados por ',', exemplo: '10,11,12'. No das questões do tipo matriz, o sistema deve também armazenar de forma sequencial, entretanto seguindo a seguinte estrutura: deve armazenar o código dos atributos selecionados e dos respectivos itens da faixa separando os atributos por '|' e o item da faixa por ',', exemplo: 10|1,11|1,12|3.
No caso das questão do tipo multivaloradas, quando estiver selecionado o atributo 'outros' (crm_script_quest_atrib.log_livre_1 = true), a resposta será gravada no campo crm_script_respos_quest.dsl_resp assim como as demais, entretanto, o texto informado para o atributo será gravado junto utilizando o separador '|', exemplo: 10,12|Vila Velha. Ainda neste caso, o sistema não permite que o campo de valor 'Outros' possua o caracter '|', este é removido durante a operação caso exista para evitar incompatibilidade com o modelo adotado.
Após o carregamento do questionário, antes de iniciar a renderização do questionário, o sistema verifica se já existem respostas cadastradas para o questionário. Caso possua, o sistema realiza a tratativas das respostas para cada tipo de pergunta, os valores armazenados no campo crm_script_respos_quest.dsl_resp para lista de atributos selecionados (extent). Quando a questão for do tipo matriz, o sistema separa os atributos e o valor selecionado para cada atributo em duas listas (extent) equivalentes.
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 |
(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
[6] 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. |
---|