The Help Documents function on the Object Definitions tab of the Admin Page is available for Portal Administrators to manage documents used for providing custom Help to iSite users.  These documents are in addition to the standard Help content that is already provided by iSite. Administrators can add new Help Documents, edit existing Help Documents and delete Help Documents.


Availability

Users with any of the following Permissions may manage Help Documents:


Navigation

Global Navigation Bar > Admin > Object Definitions > Help Documents


What is a Help Document?

Help Documents give the ability to provide an additional level of Help information to iSite users for a contract.  These documents may be of any file type and contain any information that is desired to be conveyed to iSite users.  For instance, a Help Document may be created that may contain supporting lookups or formulas for the Task Estimating function within iSite.  Or, a Help Document might be created to document each step within a Task Order Request Workflow.  


These Help Documents can be enabled to appear within specific modules of iSite or can be enabled to appear in all areas.


Help Document Maintenance Functions

The following functions are available when performing Help Document Maintenance


 

Properties of a Help Document

A Help Document has the following properties:


  • Document Name
  • Description
  • Content Category
  • Content Area (Displays the associated help document only when viewing a specific page or set of pages of iSite)
  • Document Content


The Help Documents List

The Help Documents list displays the Documents that are configured and assigned to the iSite License.  The list will display the following information:


  • Document Name
  • Description
  • Original File Name
  • Last Updated


How to Use the Help Documents List

  1. Click on the Document Name in the list whose information you would like to edit.


How to Add a New Help Document

  1. Click the Add New Help Document button in the toolbar
  2. In the Properties section, fill in the specified properties for the new Help Document:
    1. Name
    2. Description
    3. Category
    4. Content Area (depending on selected Content Category)
  3. In the Help Document File section, select the document that will be used for the Help Document File
  4. Click the Create Help Document button to create the new record or click the Cancel button to abort the creation process.


Note: The maximum file size allowed for help documents is 200mb. 


How to Edit an Existing Help Document

  1. In the Help Documents List, select the record to be edited by clicking the Template Name.
  2. On the Properties tab, fill in the specified properties for the Help Document.
    1. Name
    2. Description
    3. Category
    4. Content Area (depending on selected Content Category)
      1. All (Displays on all iSite pages)
      2. Admin (Displays on all Admin pages)
      3. Document Libraries (Displays on Global File Library)
      4. Lists (Displays on Custom Lists Page) 
      5. Lists - Announcements (Displays on Announcements and Related Pages)
      6. Lists - Events (Displays on Events and Related Pages)
      7. Lists - Links (Displays on Links and Related Pages)
      8. Lists - Custom Lists (Displays when viewing a Custom List)
      9. Financials (Displays on Financials Page)
      10. Task Performance (Displays on Task List and tabs found within a Task.)
      11. Task Order Request Workflows (Displays on Workflow List and tabs found within a Task Workflow.)
      12. Task Estimating (Displays on Estimate Module pages, Excluding Workflows)
      13. Variance Analysis (Displays on Variance Analysis Pages)
      14. Help Desk (Shows on Help Desk Pages)
      15. Home Page (Shows on iSite Home Page only)
      16. Funding (Displays on Funding Pages)
      17. Risk Management (Displays on Risk Management Pages)
      18. Timekeeping (Displays on Time Keeping Utilities)
      19. Timekeeping - Entry (Displays on Timecard Pages)
      20. Timekeeping - Proxy User (Shows on any User Proxy pages)
      21. Timekeeping - Reports (Displays on any Reports under timekeeping (Excluding Global Reports))
      22. Inbox (Displays within a users Inbox)
      23. Milestones (Displays on Milestone Pages)
      24. PerformanceEvaluation (Displays on Performance Evaluation Pages)
      25. TaskPlanning (Displays on Task Planning Pages)
      26. Discussions (Displays on Global Forums Pages)

                   Note: Task and Workflows take precedence for all modules when defining content areas.  

  1. In the Help Document File section, you can optionally perform one of the following functions:
    1. Click the View/Download link to download the stored Help Document to your Browser for viewing.
    2. Click the Replace link to replace the stored Help Document with an updated or new version.
    3. Click the Delete link to delete the stored Help Document.
  2. Click the Update Help Document button to update the record or click the Cancel button to abort the editing process.


Deleting Help Documents

Deleting a Help Document is a permanent change and cannot be reversed.  Proceed with caution.


How to Delete a Help Document

  1. In the Help Documents List, select the record to be deleted by clicking the Document Name.
  2. In the Help Document Maintenance page, click the Delete this Help Document... button in the toolbar.
  3. In the confirmation message pop-up, click the OK button to permanently delete the selected record or click the Cancel button to abort the deletion process.


The selected Help Document will be permanently deleted from iSite.


How to Delete Multiple Help Documents

  1. In the Help Documents List, click the check box next to each record that you want to delete.
  2. Click the Delete Help Documents... button in the toolbar.
  3. In the confirmation message pop-up, click the OK button to permanently delete the selected records or click the Cancel button to abort the deletion process.


The selected Help Documents will be permanently deleted from iSite.


Page ID:3574-1570-9186