HelpButton method in class DialogTemplate available?

Maik Scharlau on May 2, 2012

Hi,

is the help button still not available for custom reports?

According to a thread from 2009 it was supposed to be included in one of the next releases...

In case it is already available: How do I add/create a help-file/where do I find the HelpID?

Best,

Maik

Tags: #arisreport; #arisreportscripting

Bookmark

Notify Moderator

8 Replies

Jens Heylmann on May 3, 2012 - 15:29

Hi Maik,

for the current ARIS Service Release 3, 2012 it is available:

Report class DialogTemplate - Method HelpButton

HelpButton ( String p_sHelpID )

Inserts a "Help" button in the dialog. A dialog may only contain a maximum of one Help button.

The Help button always has the dialog identifier "Help". The position and size of the button are determined automatically.

The parameter "p_sHelpID" can be a predefined HelpID or an arbitrary HTML text.

In this case the text must begin with "<html>" and end with "</html>";

Cheers,

Jens

or register to reply.

Notify Moderator

Han Boogaardt on May 10, 2012 - 08:57

Thanks Jens for this info.

Unfortunately this doesn't work for me.

Is there a list of predefined HelpID's? If so, where can I find it?

What about the "arbitrary HTML text"? Must this text be defined with a variable or should it be contained in a file? Both cases do not work for me. If it must be in a file, where should this be located.

TIA for your answer,

Han

or register to reply.

Notify Moderator

Kris Nunes on February 24, 2014 - 03:16

Was this resolved?

Any idea on how to use the Arbitrary Text?

Thanks,

Kris

or register to reply.

Notify Moderator

Ilya Seletkov on February 24, 2014 - 03:42

Templ.HelpButton("<html>This is help text</html>");

or register to reply.

Notify Moderator

Han Boogaardt on February 25, 2014 - 08:57

I found out how it works. The parameter must be a reference to a HTML file in an ARIS client helpfile.

The ARIS client helpfile is "attrmaintain_en_help.jar" when you use the architect and "exploreronedb_en_help.jar" in case you use the designer.

These JAR files, located in the oem01 folder, are actually ZIP library files and can easily be modified with the Winzip tool (the ARIS client must be stopped before you do this).

Here are the instructions to create an online help for your script dialogs:

- First create the HTML file, e.g. "12345.htm". Use one of the help files in the above JAR files as template.

- Add the "12345.htm" file plus any picture (.gif) files used to the appropriate JAR file.

- Add the following line in "map.jhm" in the JAR file as follows:

   <mapID target="HID_Dialog01.hlp" url="12345.htm" />

- Add these lines in your script:

   var sHelpfile = "HID_Dialog01.hlp";

   userdialog.HelpButton (sHelpfile);

or register to reply.

Notify Moderator

Kris Nunes on March 2, 2014 - 23:17

Han, thanks a ton, your solution works both like a charm. It is definitely something I would have never figured out without your help.

Ilya, I did try this solution by having the HTML scripts between the tags, but it did not work. May be I am doing something wrong.

This would be the ideal solution would be not to have to monkey with the Jar files, but I would have to live with it. Something better than nothing :)

Thanks again.

Kris

or register to reply.

Notify Moderator

Ilya Seletkov on March 3, 2014 - 07:14

There is report example tested in 7.2.5. External and internal links do not work for some reasons.

var sHelp = "<html><h3>Html header</h3>";
sHelp+="<br>";
sHelp+= "Second line";
sHelp+="<br>";
sHelp+= "<a name = \"3line\"></a>3 line";
sHelp+="<br>";
sHelp+="<a href=\"http://www.google.com\">Link does not work for unknown reason</a>";
sHelp+="<br>";
sHelp+="<br>";
sHelp+= "<a href=\"#3line\">Local link does not work too.</a>";
sHelp+="</html>";
function GetDialog()
{        
    this.getPages = function()
    {
        var oTmpl = Dialogs.createNewDialogTemplate(600,200,"");
        oTmpl.OKButton();
        oTmpl.HelpButton(sHelp);
        oTmpl.CancelButton();
        return [oTmpl];
    }
    //Начальные настройки диалога
    this.init = function(aPages)
    {           
        return;
    }
    this.isInValidState = function(pageNumber)
    {
            return true;
    }
    this.getResult = function()
    {
        return -1;
    }
    return;
}  
var dlg = new GetDialog();
 Dialogs.showDialog(dlg, Constants.DIALOG_TYPE_PROPERTY, "test dialog");

or register to reply.

Notify Moderator

Rene Broll on February 22, 2018 - 07:48 as Reply to Han Boogaardt

@Han Boogaardt

Can you tell me, where i can find the oem01 folder?

Thanks

or register to reply.

Notify Moderator