Upload a Document

About this task

Using Route Editor, you can add a document that contains reference material to perform an operation (for example, circuit diagram, standard operating procedure). To do so, you must first upload the document, and then attach it to the appropriate route.

When you upload a document, it is stored in a document store application named Apache CouchDB. The following conditions apply when you upload a document to attach to a route:
  • You can use documents of the PDF format only.
  • The maximum file size allowed is 25 MB.

Before you begin

Apache CouchDB must be installed, and the credentials must be provided while installing Plant Applications Web Client. For more information, contact your administrator.

Procedure

  1. In the Route Editor page, select the route for which you want to upload a document.
  2. Select Documents, and then select .
    The Upload document window appears.
  3. Provide values as specified in the following table.
    BoxDescription
    FILE NAME / URLIdentifies the URL or path to the document. The URL must use the HTTPS protocol.
    Tip: If the document is stored in the local machine or in a network location accessible from the local machine, you can select Browse to go to the path.
    NAMEIdentifies the name of the document. Enter a unique value that does not exceed 100 characters.
    Important: If a document with the same name exists, a new version of the same document is created, and is assigned the product line, material, and equipment of the original document. Therefore, you must ensure that the document name is unique among all the documents stored in the Plant Applications file store.
    ENGINEERING REVISION #Identifies the revision number of the document as specified in your organization. For example, if the document that you want to upload is a design document of revision number 15, enter 15.
    Note: The engineering revision number is different from the revision number maintained in the document store.
    DESCRIPTIONIdentifies the description of the document. You must enter a value.
  4. Select Upload.

Results

The document is uploaded to the document store.

What to do next

Attach the document to a route or an operation.