CA Service Management

Expand all | Collapse all

Add or Update Help Link in Employee Menu Bar

Jump to Best Answer
  • 1.  Add or Update Help Link in Employee Menu Bar

    Posted 01-05-2017 01:58 PM

    We are in the process of preparing one of our ticket systems to be accessible by our customers.

     

    In the Employee view, by default, there are the Home, About, and Help links at the top-right corner. We would like to add a custom help file (will most likely be a PDF, but will consider other formats) for our customers that is being created that includes our customizations. We also understand that the CA Help section should also appear for legal reasons, but we would like to adjust the Help section and/or the links at the top-right corner, so our customers will contact us instead of CA for help with using the ticket system.



  • 2.  Re: Add or Update Help Link in Employee Menu Bar

    Posted 01-05-2017 05:17 PM

    Laura,

     

    It looks like the std_body_site.htmpl form within the Employee form group is the place to look, around lines 76-94.

     

    I don't have a specific example of a customization, but if anybody else has one handy please share.



  • 3.  Re: Add or Update Help Link in Employee Menu Bar
    Best Answer

    Posted 01-06-2017 04:48 AM

    Hi,

    this could be done in this way:

     

    • copy bopcfg\www\htmpl\web\employee\std_body_site.htmpl to site\mods\www\htmpl\web\employee\std_body_site.htmpl, and then open it for edit using text editor (advanced editors like Notepad++ are prefrered);

     

    • find this codepart:
    <PDM_IF "1" != "${args.KEEP.IsPopUp:0}" && "1" != "${args.popupType:0}">
        if (for_role) {
            document.write(' <A HREF="$cgi?SID=$prop.SID+FID=123+OP=DISPLAY_FORM+HTMPL=home.htmpl" onclick="detailCancel();return true;" ');
            document.writeln('accesskey=m><span>Home</span></A> ');
            document.writeln('<SPAN class="menulink_separator">|</SPAN>');
            document.write(' <A HREF="$cgi?SID=$prop.SID+FID=123+OP=DISPLAY_FORM+HTMPL=about.htmpl" onclick="detailCancel();return true;" ');
            document.writeln('><span>About</span></A> ');
            document.writeln('<SPAN class="menulink_separator">|</SPAN>');
            document.write(' <a href="JavaScript:help_on_form(\'$prop.form_name\');" ');
            document.writeln('><span>Help</span></a> ');
        } else {
            document.write(' <A HREF="$cgi?SID=$prop.SID+FID=123+OP=DISPLAY_FORM+HTMPL=home.htmpl" ');
            document.writeln('class=emp_menu accesskey=m><span>Home</span></A> ');
            document.write(' <A HREF="$cgi?SID=$prop.SID+FID=123+OP=DISPLAY_FORM+HTMPL=about.htmpl" ');
            document.writeln('class=emp_menu><span>About</span></A> ');
            document.write(' <a href="JavaScript:help_on_form(\'$prop.form_name\');" ');
            document.writeln('class=emp_menu><span>Help</span></a> ');
        }
    </PDM_IF>

     

    • add required content linked with your PDF, code could be:
    <PDM_IF "1" != "${args.KEEP.IsPopUp:0}" && "1" != "${args.popupType:0}">
        if (for_role) {
            document.write(' <A HREF="$cgi?SID=$prop.SID+FID=123+OP=DISPLAY_FORM+HTMPL=home.htmpl" onclick="detailCancel();return true;" ');
            document.writeln('accesskey=m><span>Home</span></A> ');
            document.writeln('<SPAN class="menulink_separator">|</SPAN>');
            document.write(' <A HREF="$cgi?SID=$prop.SID+FID=123+OP=DISPLAY_FORM+HTMPL=about.htmpl" onclick="detailCancel();return true;" ');
            document.writeln('><span>About</span></A> ');
            document.writeln('<SPAN class="menulink_separator">|</SPAN>');
            document.write(' <a href="JavaScript:help_on_form(\'$prop.form_name\');" ');
            document.writeln('><span>Help</span></a> ');
            // Adding extra URL to PDF
            document.writeln('<SPAN class="menulink_separator">|</SPAN>');
            document.write(' <a href="$CAisd/help/employee_help.pdf" target="_blank" ');
            document.writeln('><span>PDF</span></a> ');
        } else {
            document.write(' <A HREF="$cgi?SID=$prop.SID+FID=123+OP=DISPLAY_FORM+HTMPL=home.htmpl" ');
            document.writeln('class=emp_menu accesskey=m><span>Home</span></A> ');
            document.write(' <A HREF="$cgi?SID=$prop.SID+FID=123+OP=DISPLAY_FORM+HTMPL=about.htmpl" ');
            document.writeln('class=emp_menu><span>About</span></A> ');
            document.write(' <a href="JavaScript:help_on_form(\'$prop.form_name\');" ');
            document.writeln('class=emp_menu><span>Help</span></a> ');
            // Adding extra URL to PDF
            document.write(' <a href="$CAisd/help/employee_help.pdf" target="_blank" ');
            document.writeln('class=emp_menu><span>PDF</span></a> ');
        }
    </PDM_IF>

     

    • copy your PDF file to bopcfg\www\wwwroot\help directory.

     

    • reset web-cache to apply changes using pdm_webcache command.

     

    how it looks:

     

    Regards,

    cdtj



  • 4.  Re: Add or Update Help Link in Employee Menu Bar

    Posted 01-06-2017 10:09 AM

    This worked!  Thanks very much!