Appboard/2.4/builder/help menu configuration: Difference between revisions

imported>Joe.firebaugh
m (Created page with '{{DISPLAYTITLE:Customizing the Help Menu}} You can modify the "Help" menu in the Appboard Builder with custom URL's of HTML content that you wish to show in popup windows. The…')
 
imported>Jason.nicholls
No edit summary
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:Customizing the Help Menu}}
{{DISPLAYTITLE:The Help Menu}}
[[Category:AppBoard 2.4]]


You can modify the "Help" menu in the Appboard Builder with custom URL's of HTML  content that you wish to show in popup windows.  The following file shows the XML configuration for the menu:
The '''Help''' menu is shown both in the Builder and Viewer and by default includes the following entries:


'''.../server/webapps/enportal/WEB-INF/xmlroot/appboard/config/actions.xml'''
* Change Password
<pre>
* Help
<?xml version="1.0" encoding="UTF-8"?>
* About
<configuration>
 
[[File:appboard-2.4-help-menu.png|center|frame|Help Menu from standard AppBoard 2.4 install.]]
 
== Default Menu Items ==
 
=== Change Password ===
 
The Change Password item will allow a user to change their password.
 
{{Note|Changing passwords is only supported for users who are managed within AppBoard. For users managed externally, such as through Active Directory or other LDAP service, this feature will not work. Alternatively this item can be removed or customized to take the user elsewhere for password changes - see ''Customizing the Menu'' below.}}
 
=== Help ===
 
This menu item will pop-up a window showing the current version product documentation. As this uses the Edge public documentation website then this feature requires an Internet connection.
 
=== About ===
 
The About menu provides general information about the versions of AppBoard and its associated components.
 
Information provided in the About menu includes the following:
 
* enPortal Version
* enPortal Build #
* AppBoard Version
* AppBoard Build #
* Tomcat Version
* Operating System
* Java Version
* Installed Product Integration Modules
 
{{Note|The file that manages the About menu configuration is <tt>[<i>Install_Home</i>]/server/webapps/enportal/framework/Help/appboard_about.jsp</tt>. The AppBoard administrator can modify this file if he or she determines that it contains any information that should not be provided to the end-user. If any changes are made to this file, care should be taken to ensure that the file is manually migrated during system upgrades.}}
 
 
== Customizing the Menu ==
 
It's possible to change the items shown in the help menu which can prove useful in a production environment where the Help (link to product documentation) and About items may not be of use to the actual end-users. Also it's possible to add new items for convenience.


<obj className="appboard.actions" id="viewerActions">
The following file shows the XML configuration for the menu:


<association name="actions">
<tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/xmlroot/appboard/config/actions.xml</tt>


<obj className="appboard.actions.Action" label="Change Password" href="/enportal/servlet/pd/vdir/system/user/password/Change Password" />
<code>[xml,N]
<obj className="appboard.actions.Action" label="Help" href="http://edgedoc.edge-technologies.com/index.php/Main_Page" />
<?xml version="1.0" encoding="UTF-8"?>
<obj className="appboard.actions.Action" label="About" href="/enportal/framework/Help/appboard_about.jsp" />
<configuration>
  <obj className="appboard.actions" id="viewerActions">
</association>
    <association name="actions">
      <obj className="appboard.actions.Action" label="Change Password" href="/enportal/servlet/pd/vdir/system/user/password/Change Password" />
      <obj className="appboard.actions.Action" label="Help" href="http://edgedoc.edge-technologies.com/docs/appboard/2.4" />
      <obj className="appboard.actions.Action" label="About" href="/enportal/servlet/pd/vdir/system/appboard/About" />
</obj>
    </association>
  </obj>
</configuration>
</configuration>
</pre>
</code>
 
By default this file is included in full archives of the system and will be retained when upgrading.

Latest revision as of 08:36, 2 April 2014


The Help menu is shown both in the Builder and Viewer and by default includes the following entries:

  • Change Password
  • Help
  • About
Help Menu from standard AppBoard 2.4 install.

Default Menu Items

Change Password

The Change Password item will allow a user to change their password.

Template-note.png
Changing passwords is only supported for users who are managed within AppBoard. For users managed externally, such as through Active Directory or other LDAP service, this feature will not work. Alternatively this item can be removed or customized to take the user elsewhere for password changes - see Customizing the Menu below.

Help

This menu item will pop-up a window showing the current version product documentation. As this uses the Edge public documentation website then this feature requires an Internet connection.

About

The About menu provides general information about the versions of AppBoard and its associated components.

Information provided in the About menu includes the following:

  • enPortal Version
  • enPortal Build #
  • AppBoard Version
  • AppBoard Build #
  • Tomcat Version
  • Operating System
  • Java Version
  • Installed Product Integration Modules
Template-note.png
The file that manages the About menu configuration is [Install_Home]/server/webapps/enportal/framework/Help/appboard_about.jsp. The AppBoard administrator can modify this file if he or she determines that it contains any information that should not be provided to the end-user. If any changes are made to this file, care should be taken to ensure that the file is manually migrated during system upgrades.


Customizing the Menu

It's possible to change the items shown in the help menu which can prove useful in a production environment where the Help (link to product documentation) and About items may not be of use to the actual end-users. Also it's possible to add new items for convenience.

The following file shows the XML configuration for the menu:

[INSTALL_HOME]/server/webapps/enportal/WEB-INF/xmlroot/appboard/config/actions.xml

[xml,N] <?xml version="1.0" encoding="UTF-8"?> <configuration> 

 <obj className="appboard.actions" id="viewerActions">
   <association name="actions">
     <obj className="appboard.actions.Action" label="Change Password" href="/enportal/servlet/pd/vdir/system/user/password/Change Password" />
     <obj className="appboard.actions.Action" label="Help" href="http://edgedoc.edge-technologies.com/docs/appboard/2.4" />
     <obj className="appboard.actions.Action" label="About" href="/enportal/servlet/pd/vdir/system/appboard/About" />

   </association>
 </obj>

</configuration>

By default this file is included in full archives of the system and will be retained when upgrading.

Retrieved from "http://ab.edge-technologies.com/docs/index.php?title=Appboard/2.4/builder/help_menu_configuration&oldid=3611"