Creating Agency Help for a Component
The Agency Help tab is available on the Copy to Role Component and the Component Summary. The Agency Help tab allows you to add and maintain agency-specific Help content for the associated component. You can add information to document elements you have added to or changed in the base component presentation metadata. You can also add information about procedures that are specific to your agency and not covered in the standard online Help.
The Agency Help tab contains the Agency Help field where you can enter the agency Help content. Click in the text box and type or paste the information you want to record. The system automatically wraps text to a new line, but if you want to start a new paragraph, press ENTER. You can also use the Windows Copy (CTRL+C) and Paste (CTRL+V) commands to copy and paste text from other applications. You can save up to 4,000 characters.
If you want to include a hyperlink in the agency Help content, format the hyperlink as follows:
<a href="URL" target="_blank">Link Text</a>
Replace URL with the destination URL for the webpage, and replace Link Text with the hyperlink text that the user will click in the agency Help to access the webpage. For example, the following is a hyperlink to google.com that uses Google as the link text.
<a href="http://www.google.com/" target="_blank">Google</a>
When you are finished entering agency Help for this component, click the Save button to save the information to the database. The system displays a message to confirm that your changes were saved.
-
Note: Agency help is only displayed for a user if it is enabled for the user's active role. To enable agency help for a role, click the Roles link in the System Administration component, and then click the appropriate Role ID link. On the Role Summary component for the role, click the Agency Help tab, select the View Component Agency Help check box, and click Save.
Once agency help has been added to a component and enabled for the role, the agency help is displayed instead of the default system help when a user clicks the Help button. Users can still access the default system help by clicking the More Help link in the Agency Help window.
