Adding sub content - AcceleratorKMS - Version 3.12 - Help - Hexagon

When you need to include another document as part of your current document, add this document as sub content so that its content is included.

Before you begin

• The document must be open and in edit mode.

About this task

Sub content is added to a particular document when additional activities must be completed in addition to the current document. For example, when you shut down a pump for maintenance, you might need to start another pump to continue operations while maintenance occurs on the first pump. By adding sub content, all the required information is included for the person completing the main document; they do not have to go look elsewhere for the sub content.

There are two types of sub content:

• sub content

• sub template

Sub content: Based on a traditional document style and can be added in either traditional documents or templates. This type of sub content adds a specific instance of a document. For example, if you are shutting down Pump A and you need to specify that Pump B must be started, you would add the sub content for Pump B. Likewise, if you are shutting down Pump C and you need to start Pump D, you would add the sub content for Pump D.

Sub template: Based on a template and can only be added in asset templates. This type allows for the sub content to be asset specific depending on the instance of the main document. When adding a sub template, you must identify an asset variable; you can use an existing one or create a new one. The asset variable is added to the asset profile of the asset for which the main template is being used. For example, if the asset variable is pumpBackup, you set the value of pumpBackup to Pump B in the profile for Pump A. When the shutdown document for Pump A is generated, the sub content to start Pump B is included.

Sub content and sub templates cannot be added within a block.

Procedure

1. Click the gear icon > +Item in the appropriate location.

   The system displays a statement text box.

2. If you are adding sub content to a traditional document, follow these steps:

   1. Click the Type drop-down list, and select Sub content.

   2. Start typing the name of the document you want to add.

   3. Select the sub content you want to add.

   4. Click Reuse.

3. If you are adding sub content to a template, follow these steps:

   1. Click the Type drop-down list, and select Sub content.

   2. Start typing the name of the document, an asset type, or an asset ID.

      The system displays a list of matching documents.

   3. Select the sub content you want to add.

   4. Click Reuse.

   5. If required, set the conditions for the sub content.

4. If you are adding a sub template to a template, follow these steps:

   1. Click the Type drop-down list, and select Sub template.

   2. Start typing the name of the document template or asset type.

   3. Select the sub template you want to add.

   4. Click Reuse.

   5. Type the asset variable to define the asset for the sub template.

   6. If required, set conditions for the sub template.

5. Click Save.

Results

The sub content or sub template is added. If the sub content is added to a document template, it appears in all its generated asset documents unless conditions were specified.

What to do next

If a sub template was added to a document template, you must populate the asset variable in the asset profile to which you want the sub template to appear. After the value is added to the asset profile, the sub template document is displayed in the generated document.