Show TOC

 Integration of DMS Documents in PI Sheets Locate this document in the navigation structure

Use

You can use this function to directly integrate production-relevant documents that are stored in the SAP Document Management Service (DMS) in a PI sheet or manufacturing cockpit. The system can automatically determine and display the valid, released document version. If the documents can be read directly in an embedded frame in the PI sheet, they are archived in the batch record together with the PI sheet.

Prerequisites

You have stored your documents in DMS. To create a document in DMS from the SAP Easy Access screen, choose LogisticsCentral Functions → Document Management → Document → Create .

To display a document in the PI sheet, the following requirements must be met:

  • The deletion flag is not set for the document.

  • The document version specified is valid and released.

  • Only one original application file with the specified workstation application is assigned to the document.

  • The original application file to be displayed is active and stored in the secure storage area .

Activities

Integrating DMS Documents in PI Sheets

To integrate a document from DMS in the PI sheet, proceed as follows:

  1. In the master recipe or process order, assign a process instruction of type 0 with a long text characteristic, for example, characteristic PPPI_INSTRUCTION.

  2. In the long text characteristic, define an HTML page in which you address the document via a URL. Use the paragraph format HTML for this.

If you want to display the document within the PI sheet and archive it together with the PI sheet, use an embedded frame. You can, however, also use a hyperlink to call up the document in a separate window.

Structure of the Document URL

The URL that you use to address a document in the PI sheet must adhere to the following convention:

SAPR3-DMS- < Document number > - < Document type >-< Document part > - < Document version > - < Workstation application of the original >

Example

You want to integrate a document with the following data in the PI sheet:

Document number

DOC1

 

Document type:

PI

 

Document part:

001

 

Version:

03

 

Workstation application:

WWW

 

Additional files:

None

To integrate the document in an embedded frame, you define the following long text, for example, in your process instruction:

<iframe width=500 src="SAPR3-DMS-DOC1-PI-001-03-WWW" name="DOC1 scrolling=yes> The document cannot be displayed. </iframe>

To call up the document as a hyperlink, you define the following long text, for example, in your process instruction:

Note the <a href="SAPR3-DMS-DOC1-PI-001-03-WWW" scrolling=yes>master formula</a>.

Laying down the Document Version when Creating a Control Recipe

If you do not specify the document version in the URL, the system determines the valid version when calling up the PI sheet. This means that different documents may be displayed at different times in the PI sheet.

However, you can lay down the valid document version when you create a control recipe. To do so, proceed as follows:

  1. You assign the following characteristics before the long text characteristic to the process instruction from whose long text you refer to the document:

  • PPPI_DMS_DOCUMENT_NUMBER (Document number)

  • PPPI_DMS_DOCUMENT_TYPE (Document type)

  • PPPI_DMS_DOCUMENT_PART (Document part)

  • PPPI_DMS_DOCUMENT_VERSION (Document version)

  1. You assign values to all characteristics except for the document version.This characteristic is automatically assigned the valid version when the control recipe is created.

  2. You go to the long text and use text symbols to refer to the characteristics assigned before in the URL.To do so, insert command & < Characteristic number > & per characteristic.For more information on text symbols, see Using Text Symbols in Process Instructions .

Example

You have defined the following characteristics in the master recipe or process order:

Char.No.

Characteristic

Characteristic Value

0010

PPPI_DMS_DOCUMENT_NUMBER

DOC1

0020

PPPI_DMS_DOCUMENT_TYPE

PI

0030

PPPI_DMS_DOCUMENT_PART

001

0040

PPPI_DMS_DOCUMENT_VERSION

03

0050

PPPI_DMS_WS_APPLICATION

WWW

0060

PPPI_INSTRUCTION

See long text value assignment below

Using text symbols, you refer to the characteristics assigned before in the long text of characteristic PPPI_INSTRUCTION:

... </iframe> <iframe width=500 height=300 src="SAPR3-DMS-&0010&-&0020&-&0030&-&0040&-&0050&" name="DMS document"> </iframe> ...

Dealing with Special Characters

If the document number, document type, document part, and so on contain one of the following special characters, this character must be replaced by the appropriate escape sequence in the URL:

Special Character

Escape Sequence

 

Minus ( - )

%2D

 

Blank ( )

%20

 

Percent sign (%)

%25

 

Slash ( / )

%2F

Displaying Original Application Files with Additional Data

You can display additional files referenced in an original file in the PI sheet if the following requirements are met:

  • The document type specifies that the documents are stored by means of the Knowledge Provider.

  • Special characters in file names of the additional files were replaced by the appropriate escape sequence when referencing them in the original application file.

If you want to load an original application file to the PI sheet together with its additional files, add the extension " /* " (slash and asterisk) to the document URL. The complete URL is as follows:

SAPR3-DMS- < Document number > - < Document type >-< Document part > - < Document version > - < Workstation application of the original > /*

References Between Original Application Files

You can use an URL that is structured according to the convention " SAPR3-... " to refer to other documents within an original application file. The reference is replaced in the PI sheet. If you load the original application file together with its additional files, you must, however, add the prefix " ../ " (two periods and slash) and insert a blank character immediately after the URL.

Example

<p>Note the<a href="../SAPR3-DMS-DOC5-PI-001-02-www ">guidelines</a>.</p>

Demand-Driven Loading of Documents

Documents that are called up via a hyperlink in the PI sheet need not be loaded immediately when the PI sheet is started. To make sure that these documents are only loaded when the hyperlink is executed, note the following when defining the hyperlink:

  • Replace " SAPR3-DMS ..." by " SAPR3*DMS ..." in the document URL.

  • Add the attribute id="_bfw_link_" after the document URL.

You can only use this option, however, if the document URL does not contain any escape sequences.