Creating a new template - AcceleratorKMS - Version 3.12 - Help - Hexagon

Create document templates to generate several asset documents from a single template. This is used in place of creating a traditional document.

Before you begin

• The asset type must exist and the asset attributes created.

About this task

Templated content provides the basis for creating asset documents. When a template is combined with asset profiles, the asset documents are generated.

Procedure

1. From the menu, click Templates.

   The Document Templates list opens.

2. Click Create new template.

3. In the Asset type field, select an asset from the list.

4. In the Template field, type a title for the template.

   

   • The title for your template should represent the specific content. For example, if you are building a template for a startup procedure, the template title could be Startup.

   • The generated content titles would follow the format Asset id - Asset type - Template title. For example, for a Startup template, the generated content could be titled PU-123 -- Pump -- Startup and PU-124 -- Pump -- Startup. The titles on generated content can also be edited.

   • If you intend to use this titling convention, use the same asset type name when creating an asset type.

5. Click Create.

6. Click Edit template.

7. In the Access field, do one of the following:

   • Add relevant roles by entering a role name.

   • Click the List all link to select from the list of defined roles.

     Generated asset documents can have additional roles, but they cannot remove inherited template roles.

     

     • The selected roles provide access to this content. You can click the roles icon to also associate the role to workflows and reporting. The color changes from grey to black and the icon includes a plus (+) sign.

     • Associated roles are generally identified as those who need to be aware of the document and the steps involved, such as supervisors and training personnel.

     • For example, the procedure statements are performed by field technicians and console technicians, but the field supervisor should be added as an associated role to ensure they are aware of the document. These roles might also be involved in performing tasks related to the document, such as reviewing or approving changes.

     • The Everyone role represents all users configured in AcceleratorKMS. This role allows all users to view the content and is added by default.

8. Select the order for completing the steps within a document by choosing one of the following:

   • None -- Steps are completed in any order.

   • Role -- Steps for each role must be completed in order.

   • Strict -- All steps are completed in order, regardless of role.

     When creating individual statements, the statement is saved to the database after you click Create. To ensure those statements are saved within your content or block, you must click Preview.

9. Click +Item for a new block or click +Section to add a section.

10. Type a descriptive heading (title) for the block or section.

11. In the section or block, add a statement, block, or sub content using +Item.

12. If conditions need to be added so content is hidden for certain generated content, modify the Display when or Hidden for field on the attributes you previously created for the asset type.

    To avoid complicated template maintenance, the "hidden for" option should be used sparingly. AcceleratorKMS recommends using attributes in the Asset type page to identify statements to be displayed.

13. Continue adding the required sections, statements, blocks, and sub content.

14. Click Preview.

    The system displays the Preview document template changes window and with a list of published documents affected.

15. Type a brief description of the changes made to the content.

16. Click Save.

Results

The document template displays and is ready for whatever you have planned next:

• Come back later and edit it.

• Create the relevant asset documents by clicking Actions > Generate asset documents and selecting assets. The generated asset documents will be draft versions. You can modify the generated asset document title, properties, and completion sequence on statements. The content must be published prior to being available for use.

If there are reusable variables within the template, after the documents are generated, you must edit each asset profile to define the variable values.