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 | Datasul | Módulo | Framework |
Segmento Executor | Tecnologia | ||
Projeto | PGR_LD_FRW001-81 | IRM | PCREQ-3617 |
Requisito | PCREQ-6064 | Subtarefa | Não se aplica |
Release de Entrega Planejada | DTS12.1.8 | Réplica | Não se aplica |
País | ( X) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colombia ( ) Outro _____________. | ||
Outros | Não se aplica |
Objetivo
O objetivo desta especificação é preparar o produto Dtatasul Datasul para realizar a chamada da Central de Ajuda em todos os pontos onde hoje é executado o Help On-line.
Definição da Regra de Negócio
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio | |
men/men900aamen900za.p | [Alteração] | N/A | Realiza a chamada do help da Central de Ajuda | |
HelpController.as | [ACAA050 – Negociação Financeira] | [Envolvida] | [Atualizações -> Acadêmico-> Tesouraria] | - |
[ACAA060 – Cadastro de Pedidos] | [Criação] | [Atualizações -> Acadêmico-> Cadastros] | - |
PROGRESS
MEN/MEN900AA.P
Alteração] | N/A | Realiza a chamada da Central de Ajuda | |
Portlet.as | [Alteração] | N/A | Realiza a chamada da Central de Ajuda |
LicenseManager.as | [Alteração] | N/A | Realiza a chamada da Central de Ajuda |
EIPFlexConfigurationLoader.java | [Alteração] | N/A | Realiza a chamada da Central de Ajuda |
FlexLicenseServlet.java | [Alteração] | N/A | Realiza a chamada da Central de Ajuda |
HelpController.js | [Alteração] | N/A | Realiza a chamada da Central de Ajuda |
PROGRESS
MEN/MEN900ZA.P
Aviso | ||
---|---|---|
| ||
O fonte deve ser pré processado para a versão 12.1.8 . |
No programa men/men900aamen900za.p
a variável c-nome-hmlhtm
armazena a informação do nome do programa, então devemos alterar o nome da variável para c-prog-programahelp
e facilitar o entendimento quanto a informação que armazena.
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
/* TESTA SE ESTA CHAMANDO DO MENU DE MODULO */ IF c-nome-htm <> "men903za" THEN DO: IF procedimento.cod_prog_dtsul_base <> "" THEN DO: FIND prog_dtsul WHERE prog_dtsul.cod_prog_dtsul = procedimento.cod_prog_dtsul_base NO-LOCK NO-ERROR. END. IF AVAIL prog_dtsul THEN DO: ASSIGN c-prog-temp = REPLACE(prog_dtsul.nom_prog_ext,"/","~\") c-prog-programahelp = ENTRY(1,ENTRY(NUM-ENTRIES(c-prog-temp,"~\"),c-prog-temp,"~\"),"."). END. END. |
A Quando a versão do produto for maior ou igual a 12.1.8, caso o parâmetro de ativação da central de ajuda help.center.disable seja diferente de true, a string enviada como parâmetro na chamada da procedure openUrl
deverá ser modificada, prevendo a necessidade enviar as informações de linha de produto, segmento, versão, modulo e , ação/ rotina . e os rests de fluig e dos parâmetros da central de ajuda. O argumento help.center.disable, passado como parâmetro para o men/men906zb, é uma propriedade que como padrão vem ativada = falso e não será informado no datasul_framework.properties, para manter a central de ajuda como padrão. Caso seja necessário utilizar o help offline a propriedade help.center.disable deverá ser informada no arquivo datasul_framework.properties do produto Datasul igualando ela a true, dai produto passará a chamar o help antigo.
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Bloco de código | ||||||||
| ||||||||
RUN openUrl ("lineProduct=datasul~&sement=" + c-segmento + "~&version=" + c-versão + "~&module=" + men/men906zb.p(ENTRY(10,SESSION:PARAMETER),ENTRY(9,SESSION:PARAMETER),ENTRY(11,SESSION:PARAMETER),ENTRY(12,SESSION:PARAMETER),"","getProperty","","","help.center.disable","",vExecHTML). ASSIGN isHelpCenterActive = LOGICAL(RETURN-VALUE) NO-ERROR. IF isHelpCenterActive = 'true' THEN RUN openUrl ("i=" + c-lang + "~&m=" + lc(procedimento.cod_modul_dtsul) + "~&actionp=" + c-programa). |
Para recuperar o segmento do produto, - avaliar o uso do LS.
Para recuperar a versão do produto, deverá ser verificada a propriedade framework.version
utilizando o programa men/men906zb.p
.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
RUN men/men906zb.p(ENTRY(10,SESSION:PARAMETER),ENTRY(9,SESSION:PARAMETER),ENTRY(11,SESSION:PARAMETER),ENTRY(12,SESSION:PARAMETER),"","getProperty","","","framework.version",""). |
Informações |
---|
Considerar apenas o conteúdo antes do hífen como versão do produto |
Alterar a procedure openUrl
na atribuição de valor da variável cUrl deixar de concatenar a string [+ "/scripts/open.html"].
nome-htm).
ELSE
RUN openUrl ( "lineProduct=datasul~&segment=" + c-segmento + "~&version=" + c-versão + "~&module=" + procedimento.cod_modul_dtsul
+ "~&action=" + c-prog-help + "~&language=" + v_cod_idiom_usuar
+ "~&URLHELPCENTERFLUIG=http://" + ENTRY(10,SESSION:PARAMETER) + ":" + ENTRY(9,SESSION:PARAMETER) + "/help/resources/FluigCommunityHelpCenter/getFluigCommunity"
+ "~&URLHELPCENTERPARAMS=http://" + ENTRY(10,SESSION:PARAMETER) + ":" + ENTRY(9,SESSION:PARAMETER) + "/help/resources/ParamsHelpCenter/getParams").
|
Para recuperar a versão do produto, deverá ser executado o programa btb/version.r e remover o produto ('datasul_') mantendo apenas a versão release, 12.1.8 por exemplo.
Para recuperar o segmento do produto, deverá ser verificada a propriedade ls.segment no arquivo datasul_framework.properties do produto Datasul que encontra-se no servidor de aplicação JBoss, utilizando o programa men/men906zb.p
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
RUN men/men906zb.p(ENTRY(10,SESSION:PARAMETER),ENTRY(9,SESSION:PARAMETER),ENTRY(11,SESSION:PARAMETER),ENTRY(12,SESSION:PARAMETER),"","getLSProperty","","","ls.segment","",vExecHTML). |
Na procedure openUrl,
quando a versão do produto for maior ou igual a 12.1.8, deverá executar o trecho que segue somente se a variável isHelpCenterDisable
for igual a no
:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
IF cUrl <> ? THEN DO: | ||||||
Bloco de código | ||||||
| ||||||
IF cUrl <> ? THEN DO: /* utiliza a url de documentacao definida no config.xml com os devidos tratamentos no EIPFlexConfigurationLoader */ ASSIGN/* cUrlutiliza = cUrl a url de documentacao definida no config.xml com os devidos tratamentos no EIPFlexConfigurationLoader */ ASSIGN cUrl = cUrl + "/scripts/open.html". END. |
JAVA
EIPFlexConfigurationLoader
no método String getURL()
há a definição da URL para a chamada do help. Atualmente ha o valor "http://www.totvs.com/mktfiles/tdiportais/helponlinedatasul/" que deverá ser substituído pelo concatenação dos valores: "http://" + this.config.getRemoteServer + ":" + this.config.getRemoteServerPort + "/" + [contexto central de ajuda a ser definido]
ELSE DO:
/* assume a url padrao do legado pois nao foi possivel ler a url do EIPFlexConfigurationLoader */
ASSIGN cUrl = "hlp/openhelp.html".
END.
|
Senão, passar a executar este trecho no retorno da execução do men/men906zb.p
.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
IF cUrl = ? THEN DO: | ||||||
Bloco de código | ||||||
| ||||||
private String getURL() { /* Semensagem estaindicando configuradoque parao utilizar help offline,não armazenaraesta aconfigurado docURL*/ Stringreturn. docURL = null; if(this.config.getUseHelpOffLine()) {END. |
FLEX
HelpController.as
No metodo callHelpURL
realizar alterações para receber o segmento e versão do produto conforme exemplo que segue:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
/** * Realiza if(this.config.getDocURL() != null) docURL = this.config.getDocURL(); } else { /* Se esta configurado para utilizar help online, utilizara a docURLOnLine como docURL, * pois todos os locais utilizam docURL*/ if(this.config.getDocURLOnLine() != null) { docURL = this.config.getDocURLOnLine(); } } /* se o conteudo da docURL continua invalido, assume a URL fixa de help */ if(docURL == null || docURL.trim().equals("")) { docURL = "http://www.totvs.com/mktfiles/tdiportais/helponlinedatasul/"; } return docURL; } |
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 |
(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. |
---|
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 | Datasul | Módulo | Framework |
Segmento Executor | Tecnologia | ||
Projeto | PGR_LD_FRW001-81 | IRM | PCREQ-3617 |
Requisito | PCREQ-6064 | Subtarefa | Não se aplica |
Release de Entrega Planejada | DTS12.1.8 | Réplica | Não se aplica |
País | ( ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colombia ( ) Outro _____________. | ||
Outros | Não se aplica |
Objetivo
O objetivo desta especificação é preparar o produto Dtatasul para realizar a chamada da Central de Ajuda em todos os pontos onde hoje é executado o Help On-line.
Definição da Regra de Negócio
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
men/men900aa.p | [Alteração] | N/A | Realiza a chamada do help |
[ACAA050 – Negociação Financeira] | [Envolvida] | [Atualizações -> Acadêmico-> Tesouraria] | - |
[ACAA060 – Cadastro de Pedidos] | [Criação] | [Atualizações -> Acadêmico-> Cadastros] | - |
PROGRESS
MEN/MEN900AA.P
O fonte deve ser pré processado para a versão 12.1.8 .
No programa men/men900aa.p
a variável c-nome-hml
armazena a informação do nome do programa, então devemos alterar o nome da variável para c-programa
e facilitar o entendimento quanto a informação que armazena.
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
/* TESTA SE ESTA CHAMANDO DO MENU DE MODULO */
IF c-nome-htm <> "men903za" THEN DO:
IF procedimento.cod_prog_dtsul_base <> "" THEN DO:
FIND prog_dtsul
WHERE prog_dtsul.cod_prog_dtsul = procedimento.cod_prog_dtsul_base
NO-LOCK NO-ERROR.
END.
IF AVAIL prog_dtsul THEN DO:
ASSIGN c-prog-temp = REPLACE(prog_dtsul.nom_prog_ext,"/","~\")
c-programa = ENTRY(1,ENTRY(NUM-ENTRIES(c-prog-temp,"~\"),c-prog-temp,"~\"),".").
END.
END.
|
A string enviada como parâmetro na chamada da procedure openUrl
deverá ser modificada, prevendo a necessidade enviar as informações de linha de produto, segmento, versão, modulo e ação/ rotina.
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
RUN openUrl ("lineProduct=datasul~&sement=" + c-segmento + "~&version=" + c-versão + "~&module=" + procedimento.cod_modul_dtsul + "~&action=" + c-programa). |
Para recuperar o segmento do produto, - avaliar o uso do LS.
Para recuperar a versão do produto, deverá ser verificada a propriedade framework.version
utilizando o programa men/men906zb.p
.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
RUN men/men906zb.p(ENTRY(10,SESSION:PARAMETER),ENTRY(9,SESSION:PARAMETER),ENTRY(11,SESSION:PARAMETER),ENTRY(12,SESSION:PARAMETER),"","getProperty","","","framework.version",""). |
Informações |
---|
Considerar apenas o conteúdo antes do hífen como versão do produto |
Alterar a procedure openUrl
na atribuição de valor da variável cUrl deixar de concatenar a string
+ "/scripts/open.html".
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
IF cUrl <> ? THEN DO:
/* utiliza a url de documentacao definida no config.xml com os devidos tratamentos no EIPFlexConfigurationLoader */
ASSIGN cUrl = cUrl + "/scripts/open.html".
END.
|
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>.
a abertura do help conforme a aba corrente ou o módulo desejado na tela de Ajuda do Datasul.
*/
private function callHelpURL(isGP:Boolean, moduleHelp:Boolean = false):void {
var user:UserValue = UserManager.getInstance().user;
var i = user.defaultLocale.languageCode;
var url:String = Application.application.url;
var isHelpCentralDisable:Boolean = (PropertyUtil.getInstance().getProperty("help.center.active","false") == "true");
var lm:LicenseManager = new LicenseManager();
var version:String = PropertyUtil.getInstance().getProperty("framework.version");
version = version.substr(0,version.indexOf("-"));
url = url.substr(0, url.indexOf("/index-flex.swf"));
var urlRest:String = url.substr(0, url.lastIndexOf("/"));
this.programName = "";
//Se for para abrir o help da aba aberta
if (currentTab != null && !moduleHelp) {
//Verifica se a aba atual é Metadados.
try {
// É Metadados.
var currentView:IMDView = WorkspaceMediator.getView(currentTab) as IMDView;
if (!currentView.helpURL) {
var splittedXMLName:Array = currentView.xmlName.split("/");
// A posição do primeiro parâmetro é a posição 1 pois o formato do xmlName é
// "view/[applicationName]/[formName]" ou "view/[applicationName]/freeform/[formName]" ou ainda
// "view/[applicationName]/crudfreeform/[formName]", onde então a primeira posição será
// obrigatoriamente do applicationName. Já o outro parâmetro é a penúltima posição do Array, pois o
// último valor será obrigatoriamente o formName.
currentView.helpURL =
StringUtil.
substitute("{0}/{1}", splittedXMLName[1], splittedXMLName[splittedXMLName.length - 1]);
}
this.programName = currentView.helpURL.split("/")[1];
} catch (e:Error) {
this.programName = currentTab.resourceName;
}
if (this.programName.indexOf("di") < 0) {
if (this.programName.indexOf("homepage") > 0) {
this.programName = "f_area_trabalho";
}
if (this.programName.split(".").length > 1) {
this.programName = this.programName.split(".")[1];
}
} else {
this.programName = "f_menu";
}
}
if (isHelpCentralDisable == true) {
url += "/help/openhelp.html?";
if (isGP) { // Se o grupo de aplicativo do módulo for igual à Gestão de Planos
url += "gp=true";
} else { // Demais grupos de aplicativo
url += "gp=false&i=" + i + "&m=" + this.moduleName;
if (StringUtil.trim(this.programName) != "") {
url += "&p=all/" + this.programName;
}
}
navigateToURL(new URLRequest(url));
}
else {
lm.getLsInfo("segment", function(result:ResultEvent) {
var segmentCode:String = result.result.value["segmentCode"];
url += "help?lineProduct=datasul&segment=" + segmentCode + "&version=" + version ;
url += "&module=" + this.moduleName + "&action=" + this.programName + "&language=" + i;
url += "&URLHELPCENTERFLUIG=" + urlRest + "/help/resources/FluigCommunityHelpCenter/getFluigCommunity";
url += "&URLHELPCENTERPARAMS=" + urlRest + "/help/resources/ParamsHelpCenter/getParams";
navigateToURL(new URLRequest(url));
}, function(fault:FaultEvent) {
//Tratar o erro com uma msg
});
}
} |
Portlet.as
No metodo callHelpURL
realizar alterações para receber o segmento e versão do produto conforme exemplo que segue:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
/**
* Realiza a abertura do Help do portlet para o help online.
* @param isGP
*
*/
private function callHelpURL(isGP:Boolean):void {
var functionalityName:String = this.resource.resourceName;
var isHelpCentralDisable:Boolean = (PropertyUtil.getInstance().getProperty("help.center.disable","false")=="true");
if (functionalityName.lastIndexOf(".") > 0) {
functionalityName = functionalityName.split(".")[functionalityName.split(".").length - 1];
}
var user:UserValue = UserManager.getInstance().user;
var i = user.defaultLocale.languageCode;
var url:String = Application.application.url;
var lm:LicenseManager = new LicenseManager();
var version:String = PropertyUtil.getInstance().getProperty("framework.version");
version = version.substr(0,version.indexOf("-"));
url = url.substr(0, url.indexOf("/index-flex.swf"));
var urlRest:String = url.substr(0, url.lastIndexOf("/"));
if (isHelpCentralDisable == true) {
url += "/help/openhelp.html?";
if (isGP) {
url += "gp=true";
} else {
url += "gp=false&i=" + i + "&m=" + this.moduleName;
url += "&p=all/" + functionalityName;
}
navigateToURL(new URLRequest(url));
}
else {
lm.getLsInfo("segment", function(result:ResultEvent) {
var segmentCode:String = result.result.value["segmentCode"];
url += "help?lineProduct=datasul&segment=" + segmentCode + "&version=" + version ;
url += "&module=" + this.moduleName + "&action=" + functionalityName + "&language=" + i;
url += "&URLHELPCENTERFLUIG=" + urlRest + "/help/resources/FluigCommunityHelpCenter/getFluigCommunity";
url += "&URLHELPCENTERPARAMS=" + urlRest + "/help/resources/ParamsHelpCenter/getParams";
navigateToURL(new URLRequest(url));
}, function(fault:FaultEvent) {
//Tratar o erro com uma msg
});
}
}
|
LicenseManager.as
Definir o metodo getLsInfo
na classe LicenseManager.as
para que seja possível recuperar o segmento do cliente, conforme exemplo que segue:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
/**
* Envia solicitação para recuperar o segmento do produto
* @param result Função para tratar o retorno positivo da solicitação
* @param fault Função para tratar o retorno negativo da solicitação
* @return
*/
public function getLsInfo(information:String, result:Function, fault:Function):String {
var line:String = "OP=GETLSINFO";
line += "#PARENTTHREADID=#PSID=#CUSRNAME=#SLOT=0";
line += "#FEDERALID=#IPADDRESS=#SESSIONID=";
line += "#LSINFOPARAM=";
line += information;
this.sendData(line, result, fault);
} |
JAVA
EIPFlexConfigurationLoader.java
no método String getURL()
há a definição da URL para a chamada do help. Atualmente ha o valor "http://www.totvs.com/mktfiles/tdiportais/helponlinedatasul/" que deverá ser utilizado apenas se a propriedade help.center.disable
for igual a true
caso contrario, deverá ser utilizada a string: "http://" + this.config.getRemoteServer ()+ ":" + this.config.getWebServerPort() + "/help".
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
private String getURL() {
String isHelpCentralDisable = PropertyUtil.getInstance().getProperty("help.central.active","false").equals("true");
/* Se esta configurado para utilizar help offline, armazenara a docURL*/
String docURL = null;
if(this.config.getUseHelpOffLine()) {
if(this.config.getDocURL() != null) docURL = this.config.getDocURL();
} else {
/* Se esta configurado para utilizar help online, utilizara a docURLOnLine como docURL,
* pois todos os locais utilizam docURL*/
if(this.config.getDocURLOnLine() != null) {
docURL = this.config.getDocURLOnLine();
}
}
/* se o conteudo da docURL continua invalido, assume a URL fixa de help */
if(docURL == null || docURL.trim().equals("")) {
if (isHelpCentralDisable == true)
docURL = "http://www.totvs.com/mktfiles/tdiportais/helponlinedatasul/";
else
docURL = "http://" + this.config.getRemoteServer() + ":" + this.config.getWebServerPort() + "/help";
}
return docURL;
} |
JAVASCRIPT
HelpController.js
Alterar o script HelpController.js
semelhante ao exemplo que segue:
Bloco de código | ||||
---|---|---|---|---|
| ||||
define(['index', 'directive-modal'], function (index) {
'use strict';
index.register.controller('HelpController', ['$rootScope', '$scope','$window','$modalInstance','$filter','totvs.app-main-view.Service','MenuApplications','MenuPrograms','ModalWindow','messageHolder', function($rootScope, $scope, $window, $modalInstance, $filter, appViewService, MenuApplications, MenuPrograms, ModalWindow, messageHolder) {
var i18n = $filter('i18n');
var HELP_URL = "http://www.totvs.com/mktfiles/tdiportais/helponlinedatasul/";
var prefs = Properties.getProperty(Properties.ACCESS_PREFERENCES);
var isHelpCentralDisable = (Properties.getProperty("help.center.disable","false") === true);
if (isHelpCentralDisable === true){
if (prefs != undefined && prefs != null) {
HELP_URL = prefs.docURL;
}
} else {
HELP_URL = window.location.protocol + "//" + window.location.hostname + (window.location.port ? ':' + window.location.port: '') + "/help";
}
$scope.grpApplications = MenuApplications.getApplications();
$scope.getCurrentView = function () {
return appViewService.getPageActive();
}
$scope.checkInternetAccess = function(success, fail) {
var checkUrl = HELP_URL + "scripts/images/logo.gif";
var img = document.createElement("img");
img.id = "tstImg";
img.src = checkUrl;
document.body.appendChild(img);
document.getElementById("tstImg").onload = function() {
$("#tstImg").remove();
success();
}
document.getElementById("tstImg").onerror = function() {
$("#tstImg").remove();
fail();
}
}
var alerts = {type: '',
title:'',
detail: ''};
$scope.openHelpCurrent = function () {
var view = $scope.getCurrentView();
var programUrl = view.url;
if (view.name === appViewService.HOME) {
$scope.callHelpUrl(appViewService.HOME, 'fnd');
} else {
if (programUrl.indexOf("external") >= 0) {
var programId = "";
if (programUrl.indexOf("datasul") >= 0) {
programId = programUrl.split("datasul/")[1];
programId = programId.replace(/\//g, ".");
programId = programId.replace(/\+/g, "_");
} else {
programId = programUrl.split("external/")[1];
}
MenuPrograms.findFunctionalityById(programId, function(result) {
MenuPrograms.getProgramById(programId, function(result) {
var mod = result.program.mod.replace(".swf", "").toLowerCase();
$scope.callHelpUrl(programId, mod);
});
});
}
}
}
$scope.callHelpUrl = function(programId, moduleId) {
var userProps = Properties.getProperty(Properties.USER);
var segmentDesc = Properties.getProperty(Properties.LICENSE,'segmentDesc');
var version = Properties.getProperty("framework.version");
MenuApplications.getApplicationByModule(moduleId, function(result) {
var grpApp = result.grpApplication;
var helpUrl = HELP_URL;
if (grpApp.toLowerCase() == "sau" && isHelpCentralDisable === true) {
helpUrl += "portal_gp/";
} else {
if (!isHelpCentralDisable)
helpUrl += "?lineProduct=datasul&segment=" + segmentDesc + "&language=" + userProps.dialect + "&version=" + version;
else
helpUrl += "scripts/open.html?i=" + userProps.dialect;
if (programId == appViewService.HOME) {
if (!isHelpCentralDisable)
helpUrl += "&module=fnd";
else
helpUrl += "&m=fnd";
} else {
if (programId == 'homepage') {
programId = "f_area_trabalho";
} else {
programId = programId.substring(programId.lastIndexOf(".") + 1, programId.length);
}
if (!isHelpCentralDisable){
helpUrl += "&module=" + moduleId + "&action=" + programId;
helpUrl += "&URLHELPCENTERFLUIG=" + window.location.protocol + "//" + window.location.hostname + (window.location.port ? ':' + window.location.port: '') + "/help/resources/FluigCommunityHelpCenter/getFluigCommunity";
helpUrl += "&URLHELPCENTERPARAMS=" + window.location.protocol + "//" + window.location.hostname + (window.location.port ? ':' + window.location.port: '') + "/help/resources/ParamsHelpCenter/getParams";
}
else
helpUrl += "&m=" + moduleId + "&p=all/" + programId;
}
}
if (!isHelpCentralActive) {
$window.open(helpUrl);
} else {
$scope.checkInternetAccess(function() {
//Success - Internet Access
$window.open(helpUrl);
}, function() {
//Fail - Internet Access
if (!window.location.origin) {
window.location.origin = window.location.protocol + "//" + window.location.hostname + (window.location.port ? ':' + window.location.port: '');
}
helpUrl = window.location.origin + "/datasul/help/offline/" + userProps.dialect + "/nocon.html";
$window.open(helpUrl);
});
}
});
}
$scope.openUrlHelp = function (grpApplication, module) {
var userProps = Properties.getProperty(Properties.USER);
var segmentDesc = Properties.getProperty(Properties.LICENSE,'segmentDesc');
var version = Properties.getProperty("framework.version");
var helpUrl = HELP_URL;
if (!isHelpCentralActive) {
helpUrl += "?lineProduct=datasul&segment=" + segmentDesc + "&language=" + userProps.dialect + "&version=" + version;
helpUrl += "&module=" + module.moduleId.toLowerCase();
helpUrl += "&URLHELPCENTERFLUIG=" + window.location.protocol + "//" + window.location.hostname + (window.location.port ? ':' + window.location.port: '') + "/help/resources/FluigCommunityHelpCenter/getFluigCommunity";
helpUrl += "&URLHELPCENTERPARAMS=" + window.location.protocol + "//" + window.location.hostname + (window.location.port ? ':' + window.location.port: '') + "/help/resources/ParamsHelpCenter/getParams";
} else {
if (grpApplication.codGroupAplicat.toLowerCase() == "sau") {
helpUrl += "portal_gp/";
} else {
helpUrl += "scripts/open.html?i=" + userProps.dialect;
helpUrl += "&m=" + module.moduleId.toLowerCase();
}
}
$window.open(helpUrl);
}
$scope.checkURL = function (url, callBack) {
var request = new XMLHttpRequest;
request.open('GET', url, false);
request.onreadystatechange = function (){
callBack(request.status==200);
}
request.send();
}
$scope.openAbout = function () {
$scope.close();
ModalWindow.openLargeWindow("html/menu/about.html", {
controller: 'SysInfoCtrl'
});
}
$scope.openSysInfo = function () {
$scope.close();
ModalWindow.openLargeWindow("html/menu/sysinfo.html",{
controller: 'SysInfoCtrl',
size: 'lg',
});
}
$scope.openProgramEMS2 = function () {
$rootScope.openProgramProgress("btb/btb901zg.w", "btb901");
}
$scope.openProgramEMS5 = function () {
$rootScope.openProgramProgress("prgtec/btb/btb901zg.p", "btb901zg");
}
$scope.openProgramEMS = function () {
$rootScope.openProgramProgress("prohelp/_msgs.p", "_msgs");
}
$scope.openProgramTraceDebug = function () {
$rootScope.openProgramProgress("men/men903zi.p", "men903zi");
}
$scope.openProgramExtractVersion = function () {
$rootScope.openProgramProgress("men/men903zf.p", "men903zf");
}
$scope.openProgramProfiler = function () {
$rootScope.openProgramProgress("utp/ut-prof.w", "ut-prof");
}
$scope.close = function () {
$modalInstance.close();
};
}]);
}); |
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
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|