Document, Form, and Project Relationships


Relationships can be created between Documents, Forms and Projects.  Relationships are simply a method to associate documents, forms, and projects, such that finding and managing items that are related to each other is more easily accomplished.

In order to create a relationship to other items, you need at least editor rights to the current document, form, or project and viewer rights to the other document, form or project.  Users will only see the documents, forms or projects that they have permissions to view when they look at data on the relationship tabs. (See the Document Security, Project Security, and Form Security sections for more information on the different security levels and how it affects the user's ability to work with the corresponding Document, Project, or Form)

Types of Relationships

Document-Document (Parent, Child, Peer)

Documents can be related to other documents with one of three types of relationships: Parent, Child, and Related (or Peer). These types of relationships allow establishment of a hierarchy to better assist with organizing and tracking down related documents. Each relationship must be created manually by a user.

The following information is displayed on each of the three relationship lists:

Email: Provides a link to Document Properties (or a download link) via E-mail.
View Icon: Opens the listed document. (No column heading is visible).
Check-out Status: Displays green check mark for checked out documents. (No heading)
Doc ID: The Document ID (unique Document ID)
File Name: File name associated with the document.
Description: Description of the listed document.
Rev: The latest document revision visible to the user. 
Status: Current document status (released, unreleased, pending)
Folder: Displays the folder the document is associated with 
Checkin Date: Date the document was placed in the Document Library.

A New Document can be added or Existing Document Relationships can be created by selecting the option on the second level menu. When users with editor rights or higher create associations with documents, they will be able to search for documents that meet specific criteria. Users will only be able to associate documents that they have rights to view in the Document Library.


Parent

Parent documents are found by clicking a Document ID and then selecting the Parents tab. The Parents tab is available to all document Owners, Editors and Viewers. This is where top tier documents are displayed when a subordinate relationship exists. (e.g.  a policy is a parent to a procedure document).

Child

Children documents are found by drilling down on a Document ID and then selecting the Children tab. The Children tab is available to all document Owners, Editors and Viewers. Documents in this view are controlled based on the permissions that the user has to those documents in the Document Library. If a user does not have access to a document or the document is archived, it will not be visible when the user selects the children tab. 

 

Related (Peer)

Related documents are found by clicking on a Document ID to open the Document Properties, and then selecting the Related tab. The Related tab is available to all document Owners, Editors and Viewers. This is where peer to peer document associations are displayed when a relationship exists between documents (example: a procedure and a flowchart used to complete the procedure could be established as related documents). These relationships are created manually.

Document-Form

Documents and forms can be related for easier tracking purposes. When the relationship is established, the form will appear on the document's "Forms" relationship tab, and the document will appear on the form's "Documents" tab. Note that only form data instances can be associated in this way, not the form templates themselves.

The following information is displayed on the document's Form tab:

Form Name: The name (Form ID) of the form data instance.
Form Data View Link: A link to view the form.
Form Data Edit Link: A link to edit the form data, which is available for editors/owners.
Workflow Status: Lists the current sequence of the workflow associated to the form.
Percent Complete: Displays the percentage completed of the associated workflow.
Modified By: Displays the user who last modified the form data.
Last Modified:Shows the date and time when the form data was last modified.

The following information is displayed on the form's Documents tab:

Email: Provides a link to the Document (or a download link) via E-mail.
View Icon: Opens the listed document. (No column heading is visible).
Checkout Status: Displays green check mark for checked out documents. (No heading)
Doc ID: The Document ID (unique identifier of the document)
File Name: File name associated with the document.
Description: Description of the listed document.
Rev: The latest document revision visible to the user. 
Status: Current document status (released, unreleased, pending)
Folder: Displays the folder the document is associated with 
Checkin Date: Date the document was placed in the Document Library.


Document-Project

Documents and Projects can be related for easier tracking purposes. When the relationship is established, the project will appear on the document's "Projects" relationship tab, and the document will appear on the project's "Documents" tab.

The following information will be displayed on the document's Projects tab:

Name: The project's name
Description: The current description of the project.
Status: The open/closed status of the project.
User: The user who created the project.
Create Date: The date the project was created.

The following information is displayed on the project's Documents tab:

Email: Provides a link to the Document (or a download link) via E-mail.
View Icon: Opens the listed document. (No column heading is visible).
Checkout Status: Displays green check mark for checked out documents. (No heading)
Doc ID: The Document ID (unique identifier)
File Name: File name associated with the document.
Description: Description of the listed document.
Rev: The latest document revision visible to the user. 
Status: Current document status (released, unreleased, pending)
Folder: Displays the folder the document is associated with 
Checkin Date: Date the document was placed in the Document Library.


Form-Form

Forms can be related to each other for easier tracking purposes. When the relationship is established, the forms will appear on each other's Forms tab. Bear in mind that only form data instances can be related to each other, not the form templates themselves.

The following information is displayed on the forms' Form tabs:

Form Name: The name (ID) of the form data instance.
Form Data View Link: A link to view the form.
Form Data Edit Link: A link to edit the form data, which is available for editors/owners.
Workflow Status: Lists the current sequence of the workflow associated to the form.
Percent Complete: Displays the percentage completed of the associated workflow.
Modified By: Displays the user who last modified the form data.
Last Modified: Shows the date and time when the form data was last modified.


Form-Project

Forms and Projects can be related for easier tracking purposes. When the relationship is established, the project will appear on the form's "Projects" tab, and the form will appear on the project's "Forms" tab. Keep in mind that only form data instances can be related to projects, not the form templates themselves.

The following information will be displayed on the form's Projects tab:

Name: The project's name
Description: The current description of the project.
Status: The open/closed status of the project.
User: The user who created the project.
Create Date: The date the project was created.

The following information is displayed on the project's Form tab:

Form Name: The name (ID) of the form data instance.
Form Data View Link: A link to view the form.
Form Data Edit Link: A link to edit the form data, which is available for editors/owners.
Workflow Status: Lists the current sequence of the workflow associated to the form.
Percent Complete: Displays the percentage completed of the associated workflow.
Modified By: Displays the user who last modified the form data.
Last Modified: Shows the date and time when the form data was last modified.


Modifying Relationships

How to Modify Document-Document Relationships

Users can either establish new relationships between documents or remove existing relationships. There are three kinds of relationships between documents - Parent, Child, and Peer (Related). Users have two means to establish new document relationships, and one method to remove the relationship. The following examples will describe the methods for adding or removing a Parent relationship.  Although the example is focused on parent relationships, these steps can be applied to any document relationship tabs on the Document ID Card  to create or remove the other types of relationships.

Uploading a New Related Document

Uploading a New Parent Document:

 

  1. Navigate to the Parent tab in the Document Properties of the soon-to-be child document.
  2. Select the New Document button.

  3.  Select the folder where the new document will be uploaded.
  4. Select the file to upload.
  5. Click the Next button.

  6. Edit the metadata or index fields as needed.
  7. Click the Save to Vault button.



  8. After the document is uploaded, the Parent tab document list should include the new document.

Establishing an Existing Document as a Related Document

Establishing an Existing Document as a Parent:

  1. Navigate to the Parent tab in the Document Properties of the soon-to-be child document.
  2. Select the Modify Parent Relationships button.

  3. Enter in search conditions to find the document.
  4. Select the document from the left box.
    Note: If a user does not have rights to a document or the document is archived they will not see it in this listing.
  5. Click on the right-facing arrow to assign the document as a parent.

  6. Click on the Finish button, or close the window.



  7. The document should now be listed in the Parent tab.

 

Removing a Document Relationship

Removing a Parent Relationship:
  1. Navigate to the Parent tab of the child document's Document Properties.
  2. Click on the Modify Parent Relationships button.

  3. Select the document to be removed from the Assigned Documents box.
  4. Click on the left pointing arrow to remove the document from the Assigned Documents box.

  5. Click on the Finish button (or close the window)

  6. The Parent tab should no longer display the document.

How to Modify Document-Form Relationships

Users can establish a Document-Form relationship from either the Document Properties, which is opened by clicking on the Doc ID link in the document library (or anywhere that has the document listed), or the user can establish the relationship from the Form Properties, which is opened by clicking on the Form Name in the Form Data section.

From the Document's Properties:

Users have one method for both adding or removing form relationships from the target document. Both methods are achieved through the Forms tab located in the document details of the document. Detailed walkthroughs for adding or removing relationships through the document details Forms tab are listed below:

Relating Forms to a Document

  1. Navigate to the Forms tab of the document properties.
  2. Select the "Relate Forms" button.

  3. Select the form template from the top drop-down menu.
  4. (optional) Enter in search conditions to find the desired form instance.
  5. Select the form(s) from the Available Forms list on the left.
  6. Click on the right-facing arrow to relate the form(s) to the document.

  7. Click finish (or close the window)

  8. The form will now be listed in the Forms tab of the document.

Removing Form Relationships from a Document

  1. Navigate to the Forms tab of the document properties.
  2. Click on the Relate Forms button.

  3. Select the form to be removed from the Assigned Forms list on the right.
  4. Click on the left-facing arrow to remove the form(s) from the assignment list.

  5. Click Finish (or simply close the window).

  6. The form should no longer be present on the Forms list in the Document Details.



From the Form's Properties:

Uploading Related Documents to a Form

  1. Navigate to the Document tab in the Form Properties.
  2. Click on the New Document button.

  3. Select a folder for the new document.
  4. Select the file to upload.
  5. Click Next

  6. Fill in the required index fields and make any necessary metadata changes (if applicable).
  7. Click on the Save to Vault button.

  8. The new document will now appear in the list on the form's Documents tab.

Relating Documents to a Form

  1. Navigate to the Document tab in the Form Properties.
  2. Click on the Modify Document Relationships button.

  3. (optional) Enter in search conditions to find the desired document
  4. Select the document in the Available Documents list.
  5. Click on the right-facing arrow to relate the document to the form.

  6. Click Finish (or simply close the window).

  7. The document will now be listed on the Form's Documents tab.

Removing Document Relationships from a Form

  1. Navigate to the Document tab in the Form Properties.
  2. Check the box of the document to be removed from the relationship.
  3. Click the Remove Related Docs button.

  4. Select OK at the prompt.

  5. Document will no longer be present on the list in the form's Documents tab.


How to Modify Document-Project Relationships

Users can establish a Document-Project relationship from either the Document Properties, which is opened by clicking on the Doc ID link in the document library (or anywhere that has the document listed), or the user can establish the relationship from the Project Properties, which is opened by clicking on the Project Name wherever it may be listed.

From the Document Properties:

Relating Projects to a Document

  1. Navigate to the Projects tab in the Document Details.
  2. Click on Relate Projects button.

  3. (Optional) Enter in search conditions to narrow down the list to the desired project.
  4. Select the project on the Available Projects list.
  5. Click the right-facing arrow to relate the project to the document.

  6. Click the Finish button (or simply close the window).

  7. The project will now be listed in the Projects tab in the Document Properties.

Removing Project Relationships from a Document

  1. Navigate to the Projects tab in the Document Properties.
  2. Check the box of the listed project to be removed.
  3. Click on the Remove button.

  4. Click OK at the prompt.

  5. The project will no longer be listed in the Projects tab of the Document Properties.



From the Project Properties:

Relating Documents to a Project

  1. Navigate to the Documents tab in the Project Details.
  2. Click on the actions button and select Modify Related Documents.

  3. Enter in search conditions to find the desired document.
  4. Select the document in the Available Documents list.
  5. Click on the right-facing arrow to assign the document to the relationship.

  6. Click the Finish button (or close the window).

  7. The document will now be listed in the Documents tab of the Project Properties.

Removing Document Relationships from a Project

  1. Navigate to the Documents tab in the Project Properties.
  2. Click on the actions button, then select the Modify Related Documents option.

  3. Select the desired document from the Assigned Documents list.
  4. Click the left-facing arrow to remove the document from the relationship assignment.

  5. Click on the Finish button (or close the window).

  6. The document will no longer be visible in the Documents tab of the Project Properties.



How to Modify Form-Form Relationships

Users can establish a relationship between forms through either of the forms' "Forms" tab in the form properties. Clicking on the form's name link will open the form properties. Note that only form data instances can be related to each other, not the form templates themselves.

Relating Forms

  1. Navigate to the Forms tab of one the forms to be related.
  2. Click on the Modify Related Forms button.

  3. Select the form template of the form to be related.
  4. (Optional) Set the field to be displayed in the Available Forms list.
  5. (Optional) Enter a search string to narrow the Available Forms list down.
  6. Select the form from the Available Forms list.
  7. Click on the right-facing arrow to assign the selected form as related.

  8. Click finish (or close the window).

  9. The assigned form will now be listed in the Forms tab of the Form Properties.

Removing Form Relationships

  1. Navigate to the Forms tab in the Form Properties of one of the forms.
  2. Check the box next to the Form to be removed.
  3. Click the Remove Related Forms button.

  4. Click the OK button on the prompt.

  5. The form will no longer be listed in the Forms tab in the Form Properties.

How to Modify Form-Project Relationships

Users can establish a relationship between forms and projects through either the "Projects" tab of the form's properties, or through the "Forms" tab in the Project's properties. The form properties are reached by clicking on the Form's name link in the form data section, and the Project's properties are reached by clicking on the project's name link in the projects list. Note that only form data instances can be related to a project, not the form templates themselves.

From the Form's Properties:

Relating Projects to a Form

  1. Navigate to the Projects tab in the Form Properties.
  2. Click the Modify Related button.

  3. (Optional) Enter in search conditions to narrow the displayed available projects down.
  4. Select the desired project from the Available Projects list.
  5. Click the right-facing arrow to assign the project to be related to the form.

  6. Click the Close button (or close the window).

  7. Project should now be listed in the Projects tab of the Form Properties.

Removing Project Relationships from a Form

  1. Navigate to the Projects tab in the Form Properties.
  2. Check the box next to the project to be removed.
  3. Click the Remove Related button.

  4. Click OK at the prompt.

  5. The project will no longer be listed in the Projects tab of the Form Properties.



From the Project's Properties:

Relating Forms to a Project

  1. Navigate to the Forms tab of the Project Properties.
  2. Click on the Form Associations button.

  3. Select the Form Template of the desired form from the drop down list.
  4. (Optional) Enter in search conditions to narrow the list of available forms.
  5. Select the desired from in the Available Forms list.
  6. Click on the right-facing arrow to assign the form to be related to the project.

  7. Click on the Finish button.

  8. The Form should now be visible on the Forms tab in the Project Properties.

Removing Form Relationships from a Project

  1. Navigate to the Forms tab of the Project Properties.
  2. Click on the Form Associations button.

  3. Select the form that needs to be removed from the relationship in the Assigned Forms list.
  4. Click the left-facing arrow to remove the form relationship.

  5. Click finish (or close the window).

  6. The form will no longer be listed in the Forms tab of the Project Properties.