The Help Documents page under the Object Definitions tab of the Admin Navigation Menu provides the ability for Users to manage documents and different file types (maximum file size is 200mb) used for providing custom Help to iSite users. These documents and files are in addition to the standard Help content that is already provided by iSite.  

 

Availability 

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

  • Settings Administrator 

 

Navigation 

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.  Users can upload any file type and contain any information that is desired to be conveyed to iSite users.   

 

The Help Documents List 

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

  • Document Name: Allows a User to create a name for a given document or file 
  • Description: Allows a User to add a description for a given document or file 
  • Last Updated: Shows the last time the file or document has been edited 
  • Last Updated By: Shows the User who last edited a file or document. 

 

How to Add a New Help Document 

  1. Click the “Add New Help Document” button in the toolbar 
  2. In the Properties tab, fill in the specified properties for the new Help Document 
  • Name 
  • Description 
  • Show Description as a Tooltip? 
  • Assign Content Areas? (can select all or Select Content Areas 
    • Content Areas (depending on selected Content Category) 
      • All (Displays on all iSite pages) 
      • Admin (Displays on all Admin pages) 
      • Document Libraries (Displays on Global File Library) 
      • Lists (Displays on Custom Lists Page)  
      • Lists - Announcements (Displays on Announcements and Related Pages) 
      • Lists - Events (Displays on Events and Related Pages) 
      • Lists - Links (Displays on Links and Related Pages) 
      • Lists - Custom Lists (Displays when viewing a Custom List) 
      • Financials (Displays on Financials Page) 
      • Task Performance (Displays on Task List and tabs found within a Task.) 
      • Task Order Request Workflows (Displays on Workflow List and tabs found within a Task Workflow.) 
      • Task Estimating (Displays on Estimate Module pages, Excluding Workflows) 
      • Variance Analysis (Displays on Variance Analysis Pages) 
      • Help Desk (Shows on Help Desk Pages) 
      • Home Page (Shows on iSite Home Page only) 
      • Funding (Displays on Funding Pages) 
      • Risk Management (Displays on Risk Management Pages) 
      • Timekeeping (Displays on Time Keeping Utilities) 
      • Timekeeping - Entry (Displays on Timecard Pages) 
      • Timekeeping - Proxy User (Shows on any User Proxy pages) 
      • Timekeeping - Reports (Displays on any Reports under timekeeping (Excluding Global Reports)) 
      • Inbox (Displays within a users Inbox) 
      • Deliverables (Displays on Deliverable Pages) 
      • PerformanceEvaluation (Displays on Performance Evaluation Pages) 
      • TaskPlanning (Displays on Task Planning Pages) 
      • Discussions (Displays on Global Forums Pages) 
  1. In the bottom on “Document File”, click “choose File” and select a document or file. 
  2. In the Audience tab, choose the access permissions (all Users or only Users in a specific Security Group). 
  3. Click the “Submit” button to create the new record or click the “Cancel” button to abort the creation process. 

 

**Task and Workflows take precedence for all modules when defining content areas** 

 

How to Edit an Existing Help Document 

  1. In the Help Documents List, select the record to be edited by clicking the Document Name. 
  2. On the Properties tab, fill in the specified properties for the Help Document. 
  3. In the Document File section (below Content Areas section), you can optionally perform one of the following functions: 
    • Click the View/Download link to download the stored Help Document to your Browser for viewing. 
    • Click the Replace link to replace the stored Help Document with an updated or new version. 
  1. Click the “Submit” button to update the record or click the “Cancel” button to abort the editing process. 

 


Page ID:3574-1570-9186