Skip to main content

FieldLogs

Attaching Documentation to a Step

You can attach documentation to a Step by clicking DocumentIcon.png to provide additional information to the user.

Attach_Documentation_tab.png

The following options are available:

  • Text_Attachment.png Text

  • Picture_Attachment.png Pictures

  • Video_Attachment.png Videos

  • Sound_Attachment.png Audio files

  • URL_Attachment.png URL

  • File_Attachment.png Files from your computer

  • HTML_Attachment.png HTML

  • Documents.png Documents from Document Management System.

To attach text:

  1. Click the Text_Attachment.png icon.

  2. Enter your text.

    Enter_Text.png

    Note

    The text that you enter in this field is displayed as simple text and cannot be formatted.

    The text is attached to the Step.

To attach an image, video, audio, or any other file from your computer, you can either drag and drop the files directly to the Add documentation section or follow the procedure below.

Drag_Drop.png

  1. Click the icon of the type of file that you want to attach.

    AttachingDocuentation1.png

    A dialog box opens.

    AttachDoc1.png

  2. Click Browse.

    AttachDoc2.png

  3. Select a file from your device.

  4. Click Open.

    The selected file name appears in the field as seen below.

  5. Click Save.

    attachingdoc2.png

    The attachment appears as shown below.

    AttachDoc3.png

    You can provide a Figure ID for image, video, and audio attachments. A comment box is provided to add additional information about the different attachment types.

To attach a Url:

  1. Click the Url URL_Attachment.png icon.

    A box appears under the list of icons.

  2. In the Url field, enter a Url.

    Enter_URL.png

    Tip

    Click View to open the Url in a new tab.

To attach HTML content:

  1. Click on the HTML HTML_Attachment.png icon.

  2. Enter HTML content.

    Enter_HTML_content.png

    The HTML content is attached to the Step.

To attach a Document from the Document Management Space:

  1. Click the Documents DocumentIcon.png icon.

    SelectDocumentsIcon.png

    The dialog Select a document opens.

    SelectaDocument.png

  2. Select the required document.

    SelectRequiredDocument.png

    When you select the document, the All files option is selected by default. You can select all, few or no files using the dropdown as shown below.

    ExpandFileDropdown.png
    SelectChecbox.png

    Note

    You can also add the documents without selecting any files.

  3. When multiple revisions of a document are available, you can either add the latest revision or select the required version from the Select a version dropdown.

    UseLatestVersion.png
    SelectRequiredRevision.png

    When you select the Use latest version and All files options, the documents attached to the Step are updated to the latest version. The attachments are updated to the latest version even on published Templates, that had an earlier version during publication.

    UseLatestRevision_AllFiles.png

  4. Click Confirm Selection.

    ConfirmSelection.png

The document is attached to the Step.

DcoumentsAttached.png

The file information is presented as shown in the image above. The first file in the selection is displayed as a thumbnail. The number of files is highlighted and the file names are available in the Comment field.

Click View to open the dialog View details, where you can perform the following actions:

ClickView.png
ViewDetailsScreen.png

  1. Preview the document.

  2. Download the document.

  3. View the Metadata or document details.

  4. Navigate to the Document Space in which the document is present.

Note

To attach multiple documents to the Step one by one, perform the steps from 1 to 3.

Tip

Comment

You can add a comment to provide additional information about the attached media.

Move documentation

You can move documentation from one Step to another with a drag and drop operation.

Move_Documentation.png

Documentation type

You can add information about a related Reference Manual to any attachment by selecting from the Documentation type dropdown list.

AttachDocRef.png

Note

You can associate a Documentation Key to any documentation attached.

In this section: