Skip to main content

FieldLogs

Associating Documentation References

Documentation Reference of a Template contains the Documentation Keys and information about the related OEM Manual sources.

You can add a Documentation Key to a Template or Template Step. This enables the identification of an impacted Template during the Screening Process. A Documentation Key can either be added manually or from the Reference Manual.

You can also add additional Documentation Keys to the Template or any Template Steps, as required.

This section is automatically filled when you generate a Template from a Reference Manual. In the Documentation Reference section of the Templates_Information_Editor.png Templates Information Editor, the Source OEM Manual is displayed as shown below.

AssocDocRef1.png
Adding a Documentation Key Manually

You can manually enter the Documentation Key to a Template or a Template Step.

Warning

We only recommend adding Documentation Keys from a Reference Manual. Adding Documentation Keys manually is not advisable.

To manually add a Documentation Key to the Documentation Reference:

  1. Click + Add Documentation Key from the Documentation Reference section in the Template Information Editor.

    AssocDocRef2.png

    To add Documentation Keys to any Step of the Template, click +Add Documentation Key from the Documentation Reference section in the Step Information Editor as shown below.

    AssocDocRef3.png

    The Documentation Key section appears.

    DocumentationKeyRelatedFields.png

  2. Select the Documentation type.

    AssocDocRf8b.png

    This displays the Documentation Key fields.

    AssocDocRefDocType.png

  3. Enter the details as shown below.

    AssocDocRefDocDetails.png

    The details can be entered manually for the Template from the corresponding Reference Manual.

  4. Click Greytick.png as shown below.

    AssocDocRf8a.png

    Note

    After entering the Documentation Key details, ensure that the Greytick.png icon is clicked. If not, the changes will not be saved.

    The Documentation Key is saved as part of the Documentation Reference.

    AssocDocRefSavedManual.png

    Note

    The added Documentation Key can be edited or deleted if required.

Adding a Documentation Key from a Reference Manual

You can also add the Documentation key from a Reference Manual.

To add a Documentation Key from the Reference Manual:

  1. Open an additional Detail panel using the hamburger icon.

    AssocDocRef6a.png

  2. Click the Reference Manuals icon in the new panel as shown below.

    AsocDocRef6b.png

  3. Right-click on the required item in the Reference Manual and select Add Documentation Key to Template or Add Documentation Key to Step, as required.

    AssocDocRef5.png

    • Add Documentation Key to Template: Adds Documentation Key to the Template.

    • Add Documentation Key to Step: Adds Documentation Key to the Template Step.

    In this example, the Documentation Key is added to the Documentation Reference of the Template.

    AssocDocRef7.png

    Note

    When you edit the Documentation Key by clicking EditIcon.png, all the fields except Label are non-editable.

    PublicKeysNon-Editable.png

  4. Click Save.

    ClickSave.png
Editing Documentation Keys

Documentation Keys manually added to the Documentation Reference of a Template or a Template Step can be edited.

To edit a Documentation Key:

  1. Click the GreyPencil.png icon.

    AssocDR-Edit1.png

  2. Make the required changes to the Documentation Key and click Greytick.png to save.

    AssocDREdit2.png

    Note

    If Greytick.png is not clicked, the changes will not be saved.

    You can edit a Documentation Key multiple times.

    However, when you edit the Documentation Key added directly form the Reference Manual, all the fields except Label are non-editable as shown below.

    PublicKeysNon-Editable.png

    Warning

    The Source OEM Manual details cannot be edited manually. If it is deleted, it cannot be added again.

    AssocDR-Edit3.png
Clearing Documentation Keys

Several Documentation Keys can be linked to a Template or a Template Step.

In the example below, two Documentation Keys have been added.

ManyDocKeys.png

You can clear some, or all of the Documentation Keys if required.

To clear a Documentation Key from the Documentation Reference, click the greycross.png icon beside it as shown below.

ClearDR1a.png
ClearDR1b.png

To clear all the details in the Documentation Reference:

  1. Click Clear in the Documentation Reference as shown.

    DocRefClear1.png

  2. Click Clear.

    DocRefClear2.png

    Warning

    This will remove all the Documentation Keys including the Source OEM Manual. If this is done, the Source OEM Manual cannot be added again manually.

    All the references to the OEM Manuals are removed from the Documentation Reference as seen below. You can add all the Documentation Keys again manually. However, the Source OEM Manual details cannot be added.

    DocRefClear3.png
In this section: