Skip to main content

Relationships

Documents can be related to products and to other documents. Documents can have multiple related documents under them and be related to other documents in multiple static relationships. There are five default document relationship types that you can use or deactivate, and you can create additional document relationship types to articulate document to document relationships. In the user interface, you can use the MCM - Related Documents component to display a list of the documents that are related to the current document version record.

MCM - Related Documents component

The MCM - Related Documents component lists the documents that are related to the current Document Version. With this component, users can (1) create and relate new documents to the current document and (2) relate existing documents to the current document.

Create document relationship types

In addition to using the out-of-the-box document relationship types, you can create and use custom document relationship types. To create and enable a new document relationship type:

  1. Create a CM_Document_Relationship_Type__mdt record. Visit Document Relationship Type.

  2. (Optional) Create a Document Type Relationship Type (CM_Document_Type_Relationship_Type__mdt) record to enable the relationship type to be used for specific document types/subtypes. The mvn__CM_Document_Type_Relationship_Type__mdt.mvn__CM_Document_Relationship_Type__c field must be set to the name of the CM_Document_Relationship_Type__mdt record that you created in step one. Visit Document Type Relationship Type.

  3. Add a picklist value to mvn__CM_Document_Relationship__c.mvn__CM_Type__c. This value must be the DeveloperName of the CM_Document_Relationship_Type__mdt record that you created in step one. Visit  Document Relationship.

Default document relationship types

A document relationship connects a document version to another document version. There are five default document relationship types:

Note

When a document in a relationship with other documents experiences a significant change in status, owners of the related documents should be notified. For example, if a global document is updated, owners of any local versions should need to be notified. Visit System events.

Bundle

A Bundle relationship indicates that CM_Document_Version_2__c should be bundled with CM_Document_Version_1__c when CM_Document_Version_1__c is selected. In other words, when a document with a Bundle relationship is selected for a medical inquiry fulfillment, the bundled material is automatically packaged with it (fulfillment package).

Note

A Bundle relationship only works in one direction. For example, from the Document A record, you create a Bundle relationship with Document B, but from the Document B record, you do not create a Bundle relationship with Document A. If you select Document A for fulfillment, Document B is added to the fulfillment package. However, if you select Document B for fulfillment, Document A is not added to the fulfillment package.

Bundle relationships are created manually. To view Bundle relationships or create a Bundle relationship, navigate to the Related Documents component on a document record.

Relevant

A Relevant relationship helps with content management and indicates CM_Document_Version_2__c is relevant to CM_Document_Version_1__c. Reviewers and Approvers use Relevant documents for internal fact checking. For example, if Document B provides input into a document (Document A), add Document B as a Relevant document to Document A.

Relevant relationships are created manually from the Related Documents component on a document record.

Sourced

A Sourced relationship indicates CM_Document_Version_2__c is sourced from CM_Document_Version_1__c. For example, if you make a copy of a Global document, the Local copy lists the Global document as Sourced.

If you clone a document, Komodo Publications Planning automatically creates a Sourced relationship between the source document and the cloned document. Komodo Publications Planning also automatically creates a Sourced relationship for Translations.

Translation

A Translation relationship indicates CM_Document_Version_2__c is a translation of CM_Document_Version_1__c. Create a Translation when you want to add a translated version of the document that you are viewing to Komodo Publications Planning. The languages of both documents should be different, but the content should be the same.

When you create a new translation, the metadata from the sourced document version automatically populates in the Document Wizard. As you progress through the Document Wizard, you can make changes to the metadata and then save the new translation.

Note

A relationship modeling a translation of a translation is not supported.

Local Version

A Local Version relationship indicates CM_Document_Version_2__c is a local version of CM_Document_Version_1__c. This relationship is created when you add a version of a Global document that meets local standards. In the Related Documents component of the document record, the Global document lists all Local Versions.

Local Versions can be multi-leveled. For example, Document C is a local version of Document B, and Document B is a local version of Document A.

When you create a new local version, the metadata from the sourced document version automatically populates in the Document Wizard. As you progress through the Document Wizard, you can make changes to the metadata and then save the new translation.

Metadata

The primary metadata used to manage document relationships include:

  • Document Relationship (mvn__CM_Document_Relationship__c) - a polymorphic junction object between either two document version records or a document version and a product.

  • Document Relationship Type (mvn__CM_Document_Relationship_Type__mdt) - specifies the types of document relationships.

  • Document Type Relationship Type (mvn__CM_Document_Type_Relationship_Type__mdt) - connects the Document Relationship Type (CM_Document_Relationship_Type__mdt) and Document Type (CM_Document_Type__mdt) custom metadata types.