Searching for and Viewing Documents
Searching & Viewing – Home Hub & Document Hub
Documents can easily be found within GEMS using the “Find a Document” or “Find text in a Document” tiles on the main home screen or Document Hub.
Please note: To utilize the “Find text in a Document” search, uploaded documents will need to have been converted to Optical Character Recognition format (OCR) before their addition to the database (this allows text to be searchable in these files).
Additionally, Documents can be found from the Search Hub.
Searching & Viewing – Entity Snapshot
Once a file has been associated with an entity within GEMS it can be located from the entity snapshot using the “Documents" button on the entity Snapshot.
From the documents screen, documents can then be grouped by several properties such as document date and type.
To view a single document, click on the description of the document. To view multiple documents, select the checkboxes to the left of the document names, right-click and select ‘View Document’ or select the button from the top right of the search results listed.
Please note: It may be required to hold the CTRL key down while launching documents from within GEMS on certain networks.
Viewing and Modifying Document Properties
To view and modify the properties of a document, first search for and locate the document. You can then "right-click” the document title/description to access the actions menu.
To review a document's details, select Open from the actions menu.
To update document properties, click the Edit button.
Batch Printing Documents
To print several documents at the same time, the batch print functionality streamlines this process. This is especially useful for situations such as when a User has created an electronic filing form for several entities in a single batch. Multiple documents can be created as part of the batch number and then printed at the same time.
To print a single document or a group of documents at the same time, do the following:
Search for the required documents.
Select the checkbox beside all required files.
Right-click and select “Batch Print”.
Please note: If the selected documents have differing file types, for example, one Microsoft Word document and one EF form; the documents will open in separate windows to be printed.
Please note: The selected documents are combined into a single file and opened in the browser for printing.
Deleting Documents
Caution should be exercised in deleting Documents as all associations are stripped; in other words, deleting a Document that’s been associated with more than one entity deletes that Document everywhere, not just from one entity. Individual associations can be removed by editing Document properties.
The process of deleting documents is outlined below:
Search for the required Documents in any of the ways outlined above.
Select the checkboxes next to the Document(s), right-click, and select Delete from the menu.
Select the If deleting the document record(s), also delete the physical file(s) associated with the document record(s) to delete the physical file from the database.
Please note: To retain the document file in the database for future reuse and delete the document record, make sure this checkbox is clear.
Please note: Documents deleted in this manner are irretrievably deleted from GEMS.
Click the Submit button. The selected document records and physical files (if selected) are deleted from the GEMS database
Documents may also be deleted when viewing the properties of a document.
Changing the Status of Documents
To manually change the status of a document, for example, if an electronic filing form has been created in GEMS but filed manually, status of the form must be updated in GEMS.
The process for doing this is outlined below:
Search for the required documents.
Select the checkboxes next to the document(s), right-click, and select ‘Change Status’ from the right-click menu
Select the date of status change along with the new desired status for the required files.
Click the Save button. The selected document records are updated to reflect the new status.
Launching the Filing Module
For documents that can be submitted electronically to the relevant authority, the filing module is used to perform the submission. The steps to launching the filing module for documents are outlined below:
Search for the required documents.
Select the checkboxes next to the document(s), right-click, and select ‘Launch Filing Module’ from the right-click menu.
The Filing Module is displayed with all the selected forms in the Entity drop-down menu.
For more details on electronic filing, see the Forms & Filings section within the Tutorials section on the Community Support Site.
Convert RTF Documents to PDF Format
Please note: ‘Convert RTF to PDF’ is a licensed module and this functionality is available only if the module license has been installed in GEMS. Customized Assemblies are also required to use this functionality. Please speak to Customer Support for more information.
To convert documents in the Rich Text Format (RTF) to the PDF format in GEMS, do the following:
Search for all RTF documents
Select the checkboxes next to the documents, right-click, and select ‘Convert RTF to PDF’ from the right-click menu. A confirmation message is displayed.
Select the ‘Convert document’ checkbox and click the Submit button. The RTF document is converted into a PDF document. The RTF document is converted into a PDF document.
Please note: Both RTF and PDF documents remain in the database. The RTF file is not deleted as part of this process.
Downloading Multiple Files into a .zip folder
From within the Entity Snapshot, Document Hub it is possible to download one or more documents into a .zip folder.
To do this, simply check the box beside each required document record and then select the download button.
A window will appear as the files are compressed and once complete an automatic download should appear. If this fails to complete automatically an option to download will be present in the window.
Please note: Documents can also be downloaded from a Search Hub - “Documents” search or “Find a Document” tile on the Home Screen. To do so simply check the box beside the required file and choose the Export Download menu option.
Restricting Document Download – Admin Only
Admins can restrict who will have access to download multiple documents using the document download button through Admin > GEMS Settings > System Management > Options > General > Bulk Document Download.
There are 3 settings options whereby Admins can allow:
Only Admins to use the Document Download feature;
Admins and Edit users to use the Document Download feature;
or all GEMS users to use the Document Download feature.
Please note: The default setting for GEMS is Admin Only.
Appendix A: Document Management Best Practices
Properly arranging and building document upload and nomenclature rules for Users is key to successfully maintaining the document library for quick reference and access by the User community, and expands the value of GEMS as a central documentation repository for a wide variety of departments across the organization.
Following the best practices in the subsequent sections will help ensure maximum benefit from the GEMS document upload and management features.
Best Practice 1: Ensure all Documents have unique names
One of the first steps to achieving solid document storage and retrieval practice is to ensure there is a consistent and reliable document naming scheme clearly defined and adhered to across the entire GEMS user community afforded document upload and retrieval access.
Though GEMS will automatically append an incremental number to the filename if documents of the same physical filename are uploaded into the application, this may lead to confusion when searching for and retrieving these uploaded files and doesn’t give any clear indication about the document’s provenance, association, or content.
For example: If 3 documents named Resolution.pdf are uploaded by 3 different users into GEMS, they will be named in chronological order as follows:
1st document: Resolution.pdf
2nd document: Resolution_0.pdf
3rd document: Resolution_1.pdf
Whenever possible, adopt a naming schema that highlights unique characteristics of the document, such as entity or person name, file or reference numbers, dates, or other unique identifiers.
The above documents could be more easily distinguished if named as follows:
1st document: Resolution for Entity ABC_Nov2011.pdf
2nd document: Resolution for Entity DEF_Nov2011.pdf
3rd document: Resolution for ENTITY GHI_Nov2011.pdf
Best Practice 2: Document Naming Consistency if including Dates in Filenames
If users are including dates of reference in the document's physical filenames, ensure there is consistency in the date format and the date sequence used in the filename.
The best way to list the date is based on an international standard, such as ISO 8601. ISO 8601 specifies numeric representations of date and time to be used in electronic format. The international standard date notation is:
YYYY_MM_DD or YYYYMMDD
Where YYYY is the year, MM is the month of the year between 01 (January) and 12 (December), and DD is the day of the month between 01 and 31. For example, January 5, 2008, is written as 2008_01_05 or 20080105.
Best Practice 3: Avoid special characters in physical filenames
There are several universally recognized ‘special characters’ that in some networks, applications, and security configurations, may be interpreted as malicious code and block the document from uploading, downloading, and possibly other actions, both within and outside of GEMS.
To ensure documents uploaded in GEMS are not construed as such, the following character and character combinations should be avoided in the physical file names of any documents prepared for upload to GEMS*:
· .. (double periods)
· ./ (period/backspace)
· : (colon)
· % (percentage symbol)
· < (less than)
· >(greater than)
· $ (dollar sign)
· % (percent sign)
· [ (square open bracket)
· ] (square close bracket)
· ) (open bracket)
· ( (close bracket)
· “ (quotation mark)
· ‘ (apostrophe)
Other Considerations:
Documents containing a trailing space before the extension (document. pdf versus document.pdf) will fail to upload and download.
Documents with physical filenames that have multiple periods in the filename may also fail, both in upload and retrieval (this.is.a.test.document.pdf versus this_is_a_test_document.pdf)
Consider using underscores ( _ ) instead of periods or spaces in the physical filename. Periods have a specific function when included in a filename (universally used in front of file-name extensions to denote file formats such as .jpg and .doc, so using them in a filename could result in errors.) Any spaces in a physical filename translated in a web environment to be read as “%20”.
For example, a document titled test document.pdf could be seen as test%20document.pdf when opened up and referenced in some viewing applications.
Spaces in the actual document filename may also be interpreted as a trigger for a new line break in the document itself by some document rendering programs, such as Microsoft Word, and email programs like Microsoft Outlook.
Please note: If hosted with CGS, restrictions, as outlined above, are enforced consistently, and documents containing the above special characters in the physical filename of the document will be blocked from upload and retrieval outright. There will be an error message indicating the document contains one or more of the aforementioned invalid special characters in its physical filename.
Best Practice 4: Ensure filenames are less than 256 characters in length
The universally accepted maximum physical filename is 256 characters. (Some Operating Systems/applications permit far fewer) Filenames exceeding this number of characters will be truncated by GEMS at the 255th character in the physical filename once uploaded.
Best Practice 5: Use GEMS Document Properties for effective quick reference
GEMS affords additional granularity to a document’s properties.
Whenever possible, make use of:
Key Words
Document Type
Document Category and Sub-Category
Description fields
Document Effective Date
To further characterize the documents.
Ensure that this is consistent across the organization: using Document Types and/or categorization, for example, means a far more effective manner of building access levels against documents based on specific user roles and user document visibility needs.
Additional data entered in the available Document Properties fields means richer indexing of the documents when using the Full-Text Search features available in GEMS, as well as more accurate document searching and retrieval for the users.
Best Practice 6: Keep Document’s physical file sizes small
Control over document file size is one of the most common pitfalls for clients struggling to maintain an accessible and referable document library in GEMS.
Large document files represent overhead both in storage and retrieval time, particularly if there are large quantities of scanned (PDF or JPG) documents. A 100 kb file will always download faster than a 1 MB file.
Whenever possible, insist on the lowest acceptable resolution rate when scanning documents for storage in GEMS. A black and white scanned document, scanned at high-resolution rates, looks no different in digital format than one scanned at minimal resolution rates, yet may be 100 times larger. A good rule to abide by is that documents in GEMS should be no larger than the organization’s maximum email file attachment size; If unable to send a file stored in GEMS via email, then it is possibly too large and should be evaluated for file size reduction and re-upload.
Best Practice 7: Use standard file extensions for GEMS Documents
Universally accepted file formats/ extensions are:
.doc / .docx: Microsoft Word
.xls /.xlsx / .csv: Microsoft Excel
.ppt : Microsoft PowerPoint
.one : Microsoft OneNote files
.opx : OrgPlus files
.pdf : Adobe PDF
.txt : Text format files
.jpg / .gif : image files (small)
.bmp : bitmap image files, and tend to be large
.zip / .rar: compressed files. Note however that the contents of compressed files may violate some network policies based on scanning and security and for hosted clients, additional security scanning may be undertaken to ensure no malicious content is uploaded.


















