Adding Information in the Documentation Section

Procedure

  1. Highlights: You can view the highlight cards and also set their visibility using the Settings button.
  2. To add, or assign, or edit an existing document to the equipment, choose the Start of the navigation pathDocumentation Next navigation step DocumentsEnd of the navigation path tab, and perform the following tasks:

    In the Documents section, choose Add menu to upload a new document, and perform the following steps.

    1. Choose Start of the navigation pathAdd Next navigation step Add ImageEnd of the navigation path to add an image

      1. In the Add Image pop-up, browse for a file.

      2. In the Additional Information section:

        • Assign a Main Category to classify the document.

          You can also assign additional categories in the More Categories field. You can also assign a Phase, if necessary.
        • Select the type of sensitive data available in the document from the Data Sensitivity list.

        • Select the language from the dropdown that corresponds to the documents.

        • Enter a description. You can also enter a long description, if necessary.

        • You can block the replication of files in certain countries (relevant data centers in that country) by selecting the countries in the Blocked Data Center Countries.

          • Only the owner of the document can edit this list.

          • Others can view the blocked countries and data centers.

          • If the document is already shared, then you will not be allowed to block countries and data centers.

          • When editing the document, you can change the blocked country and data center list.

        • Select the confidentiality of the document if it’s not shared with everyone.

      3. Choose Upload.

        You can use Check and Upload to check if there are any duplicates that exist in the system. If duplicate files exist, you will then view the files in the Similar File Detected dialog box. You then can Continue Uploading the New File or you can select a file from the duplicate file list and Use Selected File option to upload it.

    2. Choose Start of the navigation pathAdd Next navigation step Add DocumentEnd of the navigation path to add a document.

      1. In the Add Document popup browse for a file.

      2. In the Additional Information section:

        • Assign a Main Category to classify the document.

          You can also assign additional categories in the More Categories field. You can also assign a Phase, if necessary.
        • Select the type of sensitive data available in the document from the Data Sensitivity list.

        • Select the language from the dropdown that corresponds to the documents.

        • Enter a description. You can also enter a long description, if necessary.

        • You can block the replication of files in certain countries (relevant data centers in that country) by selecting the countries in the Blocked Data Center Countries.

          • Only the owner of the document can edit this list.

          • Others can view the blocked countries and data centers.

          • If the document is already shared, then you will not be allowed to block countries and data centers.

          • When editing the document, you can change the blocked country and data center list.

        • Select the confidentiality of the document if it’s not shared with everyone.

      3. Choose Upload.

        You can use Check and Upload to check if there are any duplicates that exist in the system. If duplicate files exist, you will then view the files in the Similar File Detected dialog box. You then can Continue Uploading the New File or you can select a file from the duplicate file list and Use Selected File option to upload it.

    3. Choose Start of the navigation pathAdd Next navigation step Add LinkEnd of the navigation path to add a document link.
      1. In the Add Link popup, provide a URL link to the document along with a Display Name.
      2. In the Additional Information section:

        • Assign a Main Category to classify the document.

          You can also assign additional categories in the More Categories field. You can also assign a Phase, if necessary.
        • Select the type of sensitive data available in the document from the Data Sensitivity list.

        • Select the language from the dropdown that corresponds to the documents.

        • Enter a description. You can also enter a long description, if necessary.

        • You can block the replication of files in certain countries (relevant data centers in that country) by selecting the countries in the Blocked Data Center Countries.

          • Only the owner of the document can edit this list.

          • Others can view the blocked countries and data centers.

          • If the document is already shared, then you will not be allowed to block countries and data centers.

          • When editing the document, you can change the blocked country and data center list.

        • Select the confidentiality of the document if it’s not shared with everyone.

      3. Choose Upload.

        You can use Check and Upload to check if there are any duplicates that exist in the system. If duplicate files exist, you will then view the files in the Similar File Detected dialog box. You then can Continue Uploading the New File or you can select a file from the duplicate file list and Use Selected File option to upload it.

    4. You can add a new version of a document by selecting the document from the list and choose Start of the navigation pathAdd Next navigation step Add New VersionEnd of the navigation path.

      1. In the Add New Version popup browse for a file.

      2. In the Additional Information section, enter a Description for the document. You can also enter a long description, if necessary.

      3. Choose Upload.

  3. In the Documents section, from the Add menu choose Assign to upload an existing document and perform the following steps:
    1. In the Select Documents dialog box, search for an appropriate file.
    2. From the Documents search results list, select a document.
    3. Choose OK.

    You can also use Remove and Download to remove or download any of the documents assigned to the equipment.

  4. To add a hotspot to an image select an image in the Documents section, see Creating Hotspots.
  5. To add instructions to the equipment, go to Start of the navigation pathDOCUMENTATION Next navigation step INSTRUCTIONSEnd of the navigation path and perform the following tasks:
    1. Choose Assign.
    2. From the Select Instructions dialog box, select the appropriate instruction.
    3. Choose OK.
  6. To assign failure modes to the equipment, go to Start of the navigation pathDOCUMENTATION Next navigation step  Failure ModesEnd of the navigation path and perform the following tasks:
    1. Choose Assign.
    2. Select a failure mode.
    3. Choose OK.
    You can select a failure mode and choose Remove to unassign the failure mode.

    If you have write access to the equipment even though you do not have write access to the failure mode, you can still edit the failure mode instance page of the equipment.

    When you copy a failure mode and Save & Publish it:

    • A new failure mode is created with the same causes and instructions from the source failure mode

    • The newly created failure mode is directly assigned to the object

    • The new failure mode is in published state

    • You navigate to the new failure mode instance page that includes all the copied failure mode instances: effects, causes, instructions, and detection method

    • The new failure mode appears in the failure mode section list.

    You can view the failure mode instance, which is directly assigned (at the same time), you can now view different object icons in the <From> field of the failure mode section if the failure mode is inherited or assigned directly to the equipment.

    You can now flag inherited failure modes to not relevant using the Not Relevant button. This excludes the failure modes from any assessments relevant to the equipment. Inherited failure modes that are marked as Not Relevant, when assigned explicitly, will be set to Relevant.

    In the failure mode instance page:
    • You can add new effects using Start of the navigation pathAdd Next navigation step NewEnd of the navigation path or assign existing effects using Start of the navigation pathAdd Next navigation step AssignEnd of the navigation path in the Effects section. For each effect, you can Add Effect Details like:

      • Local Effect Description: describes the direct effect on the equipment or the how it affects the equipment it is part of.

      • Higher-Level Effect Description: describes how is the system affected the equipment is part of.

      • End Effect Description: describes the ultimate effect that the failure has on safety and/or the environment (if any) and any impact on production or operational capability.

      • Potential Worst-Case Effect Description: specifies what would happen in case no measures would be taken to anticipate, prevent, or detect the failure.

    • You can add new causes using Start of the navigation pathAdd Next navigation step NewEnd of the navigation path or assign existing causes using Start of the navigation pathAdd Next navigation step AssignEnd of the navigation path in the Causes section. You can assign a Low Level Failure Mode to the new causes that you create.

    • You can assign existing spare parts to the failure mode instance using Assign in the Spare Parts section.

      You can select the assigned spare parts from the list and choose Remove to unassign them.

      Spare parts that can be assigned to the failure mode instance are displayed in the assign dialog box. Spare parts already assigned to the failure mode are filtered out from the list.

    • You can assign existing instructions to the failure mode instance using Start of the navigation pathInstructions Next navigation step AssignEnd of the navigation path.

      Once you have assigned instructions, you can assign causes for the selected the instructions using Manage Cause.

      You can also select instructions from the list and unassign them using Remove.

    like:
  7. You can view the alert types associated with the equipment under Start of the navigation pathDOCUMENTATION Next navigation step Alert TypesEnd of the navigation path
  8. To view announcements assigned to the equipment, choose Start of the navigation pathDOCUMENTATION Next navigation step AnnouncementsEnd of the navigation path
  9. To create an improvement request for the equipment, perform the following tasks:

    1. Choose Start of the navigation pathDOCUMENTATION Next navigation step New Improvement RequestEnd of the navigation path.

    2. Enter the relevant details in the New Improvement Request dialog box.

    3. Choose OK.

  10. View and create baselines

    Baselines are snapshot that is used as a reference point. Multiple snapshots can be created over a period of period to view and monitor the full extent of the data change over time. Baselines provide you the ability to travel back in time to see how the equipment data was, and where & when data has changed.

    You can create a baseline:

    • Using the New button in the Baseline section.

    • Using the Create Baseline option in the Start of the navigation pathPhase Next navigation step Manage PhaseEnd of the navigation path.

  11. You can view the list of functions assigned to the equipment under Start of the navigation pathDOCUMENTATION Next navigation step FunctionsEnd of the navigation path.
    1. Choose Assign.
    2. Select a function.
    3. Choose OK.
    You can select a function and choose Remove to unassign a function.

    For more information, refer to Functions.