Versions Compared

Version Old Version 10 New Version 11
Changes made by

Alina Jo

Alina Jo

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerptReusable Excerpts - MasterReusable Excerpts - MasternameContact - CPFMnopanel

Insert excerpt
Reusable Excerpts - Master
Reusable Excerpts - Master
nameContact - CPFM
nopaneltrue

The Related Documents function allows the user to attach electronic files, such as documents, spreadsheets, or images, to their working record. Related documents can also point to a URL (web) shortcut.

...

Expand
titleUpload File(s)

  1. Locate the Record to which you want to add a document

  2. Click on Related Documents under the left View Menu

  3. In the Related Documents screen, click Edit

  4. Click Add to open a New Document

  5. Click on Browse andlocate the new document on your computer to upload

  6. Alternatively, you could also drag the document from your desktop to the No files selected field

  7. Click Next to navigate to the next section: Add Meta Data

Add Attributes
Expand
titleAdd Meta Data

  1. In the Add Meta Data section of New Document, the first field is the Title field. This will automatically populate with the name of the document you uploaded, but you can edit that at this step.

  2. The next field down is Type, or your document type. Click on the spyglass icon to open the Document Type screen.

  3. Once you select your Document Type, you will be taken back to the Add Meta Data section of the New Document screen.

  4. The next field down is called Tags. Enter any tags here that will help users when they’re searching for this document (e.g., UTILITY BILL INVOICE)

Expand
title

  1. is called Tags. Enter any tags here that will help users when they’re searching for this document (e.g., UTILITY BILL INVOICE)

Expand
titleAdd Attributes

Click Next to access the next section of New Document after Add Meta Data, Add Attributes.

Info

Note: Add Attributes is only used occasionally on a document type needing attributes. This field enables the user to sequence, describe, set a data type to either string or number, and state whether or not the attribute is required.

Expand
titleAdd Permissions

...

Expand
titleExternal Links

Expand
titleSave

📘 Step-by-Step Tutorial

Attaching a Document to a Record

Expand
titleClick here for 👉 Upload File(s)

Upload File(s)

  1. Locate the Record to which you want to add a document.

  2. Click on Related Documents under the left View Menu.

    • The Related Documents View enables users to attach electronic records, such as a documents, spreadsheets, or images from the record on which the user is working.

  3. Click on Edit image-20241014-204957.pngImage Modified

image-20241014-205109.pngImage Modified

  1. Hit Add image-20241014-205209.pngImage Modified to open a New Document.

image-20241014-205243.pngImage Modified

  1. Click on Browse image-20241014-205328.pngImage Modified

  2. Locate the new document on your computer.

    • Alternatively, you could also drag the document over from your desktop to the No files selected field.

  3. Click Nextimage-20241014-205525.pngImage Modified at the top-left of your screen

image-20241014-205401.pngImage Modified
Expand
titleClick here for 👉 Add Meta Data

Add Meta Data

  1. Notice in the list of links on the left, we are currently in the Add Meta Data section of the New Document.

    • The first/top field in this view is the Title field. This will automatically populate with the name of the document that was uploaded. You have the option to change the Title at this time.

image-20241014-205740.pngImage Modified

  1. The next field is Type or more specifically, Document Type. This is a functional group of documents with a class like General, Image, Invoice, etc. To select your document Type, click the spyglass icon to open the Document Type screen.

image-20241014-205855.pngImage Modified

  1. Once the Document Type has been selected, you will return to the New Document screen.

  2. The next field down is called Tags. Tags assist the user when they’re performing a search for the document. Add in your tags here (e.g., UTILITY BILL INVOICE).

image-20241014-205944.pngImage Modified
Expand
titleClick here for 👉 Add Attributes

Add Attributes

From the Add Meta Data section, you can click Next (top-left corner) to get to the next section, Add Attributes.

Info

Note: Add Attributes is only used occasionally on a document type needing attributes. This field enables the user to sequence, describe, set a data type to either string or number, and state whether or not the attribute is required.

Expand
titleClick here for 👉 Add Permissions

Add Permissions

  1. Click Next again to reach the Add Permissions screen.

Info

Add Permissions assigns roles to the document limiting the users who have access. The Chosen Roles will have access to view and/or editing privileges.

Note

If your system requires permissions to be placed on a document, contact your System Administrator for the appropriate permissions for the Document Type.

  1. To add Permissions, click Load (screenshot, below) image-20241014-210147.pngImage Modified This will populate a list of Roles.

image-20241014-210243.pngImage Modified

  1. Select each Role you will be adding to Permissions.

  2. When a permission is applied to a document and then SAVED – Only individuals with one of those roles will have access to that document.

Info

Note: If you give a set permissions that don’t include yourself, you will not have access to the document, once saved.

  1. Click Next (top-

...

  1. left) image-20241014-210425.pngImage Added

Expand
titleClick here for 👉 Attach Button

Attach Button

The Attach button allows you to search for content that has been loaded into AiM.

image-20241014-210552.pngImage Modified

  1. The Attach button will lead you to a search screen called Select Documents.

  2. You can fill in the appropriate fields to locate the specific document or just click on Execute to see a listing of all available documents.

  3. Once you have selected the document, click Done.

image-20241014-210750.pngImage Modified

  1. Back in the Related Documents screen, the chosen document will populate on your Document Listing.

image-20241014-210930.pngImage Modified
Expand
titleClick here for 👉 Add vs Attach

Understanding Add versus Attach
To illustrate the difference between Add and Attach, let’s say you have an owner’s manual, and you want to attach it to 5 different Air Handlers.

When the manual has been Added to each Air Handler, what happens when a new manual is released?
👉 Choosing Add would add a copy of the manual to each of the Air Handlers, uploading the document 5 times.
👉 You would have to remove the old copy of the manual and add the new one to every asset individually.

Best Practice - Use Add for the 1st unit and Attach for the other 4
👉 If you Add the manual to the 1st Air Handler, you can then use Attach to the other 4, to link to the same document.

Summary
When you Add the document to the 1st Air Handler, that Adds the document to the AiM system. Then by using Attach for the other units, it will link to the same document.

Expand
titleClick here for 👉 Remove a Document

Remove a Document

  1. From your main Related Documents screen, select the document you wish to remove.

  2. Click Remove image-20241014-211124.pngImage Modified

  3. Click Yes image-20241014-211151.pngImage Modified to confirm you want to delete your selection.

image-20241014-211225.pngImage Modified

Under the Document Listing, the Related Document will no longer be present.

image-20241014-211305.pngImage Modified
Expand
titleClick here for 👉 External Link(s)

Link an External URL

You can also create a Link between AiM and an External URL. 

image-20241014-211415.pngImage Modified

  1. Click on the Linkimage-20241014-211454.pngImage Modifiedbutton. This will open the Web Link screen.

  2. Complete the following fields:

    • Title - Title of the link

    • Extra Description - A description of the document. This can include up to 255 characters.

    • URL - The external web link

image-20241014-211527.pngImage Modified

  1. Click Done image-20241014-211622.pngImage Modified to return to the Related Documents screen.

Save

When you have completed each step above and are back at the New Document screen, don’t forget to save.

  1. Click Save image-20241014-211757.pngImage Modified

  2. Click Back image-20241014-211812.pngImage Modified to return to your view to the record.