Using the DocuPhase Help System

This online help system is context-sensitive, and generally meant to be a reference tool that allows you to use the DocuPhase Platform in the most efficient way possible.

Context-Sensitive help gives you immediate assistance and information based on the currently displayed Application window/screen. For example, if you are on the Search screen and click the help icon (), the help window appears providing information specifically for the Search screen. However, if you want to find help on another feature or topic regarding the DocuPhase Platform, a search field also appears on every screen. You can search the entire help system - without having to open another window!

Once you become acquainted with the basic operation of help, you can use it to review or learn anything from the most basic, every day functionality (e.g., uploading Documents) to the more advanced, and less frequently used features (e.g., Indexing) and beyond.

IMPORTANT!

Because what you see once you log into the DocuPhase Platform is based (in part) on your security access/login credentials, information, examples, and references in the help system may differ from what you see in your environment.

If you think you should have access to something you don’t, please contact your DocuPhase Technical Point of Contact (TPOC) for assistance.

TIP

It is recommended that you review the conventions used in the online help so that you can familiarize yourself with how the system works.

Tell me about...

Icons/Symbols Specific to Online Help Content

While there are many icons within the DocuPhase Platform, there are those that only appear within the online help and pertain specifically to help content.

NOTE

DocuPhase icons are described in another topic in this help system. Tell me more...

Icon / Symbol	What it means...	Example of how it appears in Help...
	Warning - When you see this symbol and text, be sure to read it carefully as it is design to call attention to an impending risk to your information, system, or process. Always read the entire note very carefully; then, proceed with care as noted in the Warning.	WARNING!!! Any changes that were made to a Document while it was checked out are lost by the “undo checkout” method. In order for changes to be saved to the Document, it MUST be checked in by the User who checked it out.
	Important - This symbol identifies essential information and precautions for keeping your information accurate and secure. Always read the entire note very carefully, and take the necessary actions, as needed.	IMPORTANT! As of version 6.1, the name of the iSynergy platform was changed to DocuPhase. You may notice some updates and revised files paths have been updated to reflect this change.
	Best Practice - A Best Practice icon appears any time there is an official DocuPhase recommendation for a technique or process that has been found to be the best to use in a particular situation or circumstances.	BEST PRACTICE When sending email to request assistance, along with a detailed description of the issue, be sure to include all system version information, as this allows the DocuPhase Technical Support Team to be more efficient in responding to your ticket.
	Note - The Note icon highlights additional information and/or reminders that you may be able to use in completing a Work Item.	NOTE Remember, what you see in the DocuPhase system is based on your security access/login credentials. If you think you should have access to something you don’t, or have issues with something you DO see, please contact your DocuPhase System Administrator or Technical Point of Contact (TPOC) for assistance.
	Tip - This symbol indicates a suggestion or idea to help you work more effectively, and make the most of a particular feature.	TIP This symbol offers a suggestion or idea to help you work more effectively and make the most of a particular feature.
	Example - This icon appears in help when a pattern, model, or illustration is being provided to assist you in understanding a process or concept.	EXAMPLE Let's say you are searching for a Doc Type called “Invoices” with a CreateDate range of 2/13/2016 to 8/13/2016. However, if this criterion results in a list of invoices too long to quickly find a specific item, you can use to return to this search and perhaps change the date range to 2/13/2016 to 5/13/2016, or add Batch ID, etc. Adding more criteria to the search reduces the results returned making it easier to find specific items.
	TPOC/Admin-Specific Function - When you see this icon, it indicates that the focus of the associated information is for administrative or technical (TPOC) use. While informative in general terms, the average User does not have permissions to perform Admin/TPOC operations.	This symbol appears in headings or in/near information within a help topic.
	Return to Top - Takes you back to the top of the currently displayed Help topic.	Appears at the bottom of every page. You can use this icon to return to the top of the currently displayed help topic.

Standard Help Navigational Icons

This help system has been designed to make it easier for Users (you) to find and review information to help you work efficiently within the DocuPhase Platform: limiting the need to sort or scroll through finer details, as well as making it easier to access other resources that exist outside the help system itself. The icons shown below help you to navigate through the help system itself rather than anything specific to content.

Item	Element	Use it to...
1	Search	enter a word (or series of words) to find the instances of the word/words that appear in various topics within the online help: allowing you to find information that might not appear on the currently displayed help page. EXAMPLE If the help topic about using the Viewer is displayed, you can enter "rubber stamp" to find more information about making changes to Rubber Stamps.
2	Bread crumbs	track (and navigate back through) where you've been in the system during a single session, allowing you to backtrack through previously displayed topics. You can click on any section off a breadcrumb to return to its corresponding topic.
3		navigate to the previous topic in the help system.
4		navigate to the next topic in the help system.
5		remove highlighting after you have performed a Search. When you enter search criteria within the online help system, any matching text is highlighted. This button allows you to view the related text without the highlights. NOTE Once you use this button to remove the highlights, you must repeat the search to make the highlights reappear.
6	/	toggles between Expand all and Collapse all drop-down text on the currently displayed topic.
7		print currently displayed help topic. BEST PRACTICE It is recommended that you first use the Expand All button ( - as described above) before you print. Any text that is not displayed on the screen is not printed.
8		navigate to the main (Home) page of the online help.

Topic-Specific Conventions

The following are the conventions used in this online help system to help you quickly locate the specific information or instructions you need. Each convention is a way to find more information as it relates to the currently displayed topic.

Example	What it means / How it works
	Tell me about.... vs. Tell me how to... Sections - These sections appear in the majority of topics. "*Tell me about" sections provide conceptual information such as field definitions, background information, purpose of a feature, etc.: while the "Tell me how to*" sections give you the procedural information in the form of a step-by-step process.
	Drop-down Headings - Generally (but not always), these appear within the Tell me about/Tell me how to... sections. Click on them to reveal corresponding information. The example here shows a specific heading from this topic; however, these headings always correspond to the currently displayed topic.
	Linked Headings - Similar to Drop-down Headings (as described above), these appear within the *Tell me about.../Tell me how to...* sections. Click on them to go directly to related information within the project. These differ from Drop-down items, as they correspond to other topics, not the topic currently displayed.
	Show me... - These most often appear within the Tell me how to... sections and provide a visual reference for procedures described in written steps, notes, tips, etc.
	Tell me more... - These links generally appear at the end of a paragraph; each takes you to another topic or area providing additional details regarding the corresponding paragraph.
	Also see... - This section appears at the top right of almost every help topic and takes you to other topics or sections, providing one or more additional reference topics as they relate to specific information or procedures currently displayed.
	Open PDF - A PDF icon appears next to any link that allows you to open a corresponding PDF document