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

imported>Jason.nicholls
imported>Jason.nicholls
No edit summary
Line 1: Line 1:
{{DISPLAYTITLE:Customizing the Help Menu}}
{{DISPLAYTITLE:The Help Menu}}
[[Category:AppBoard 2.4]]
[[Category:AppBoard 2.4]]
The '''Help''' menu is shown both in the Builder and Viewer and by default includes the following entries:
The '''Help''' menu is shown both in the Builder and Viewer and by default includes the following entries:
Line 6: Line 6:
* Help
* Help
* About
* About
=== 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, then this will not work.}}


=== Help ===
=== 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.
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.
Line 30: Line 57:


By default this file is included in full archives of the system and will be retained when upgrading.
By default this file is included in full archives of the system and will be retained when upgrading.
=== 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.}}

Revision as of 08:29, 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

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, then this will not work.

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=3607"