Layout Definition for PI Sheets and Cockpits (SAP Library

Layout Definition for PI Sheets and Cockpits

Purpose

You can define the layout for browser-based PI sheets and manufacturing cockpits in any way you like. If you have not entered the relevant declaration, the system automatically uses the standard layout for PI sheets or manufacturing cockpits.

You can use the layout definition to:

Integrate PI sheets or cockpits with an individual frameset
Display PI sheets with a defined number of phases in a separate header area
Change the entire structure and formatting of the documents to be displayed

Prerequisites

If you want to replace the standard layout with your own layout, the following requirements must be met:

You have defined a valid XSL style sheet.
See: Definition of XSL Style Sheets for PI Sheets and Cockpits

The XSL file and all files to which you refer in the XSL file have been stored in the Business Document Service of the SAP R/3 System.
See: Managing of Documents for Layout Definitions

Process Flow

To change the standard layout or replace it with a different layout, you proceed as follows:

You enter characteristic PPPI_LAYOUT at the following locations:

For PI sheets:

In the process order or master recipe, you can define PPPI_LAYOUT in a process instruction of type 0 at the beginning of a control recipe.

In Customizing, you can define PPPI_LAYOUT in a process instruction category of type 0 and specify it as an automatically generated process instruction in the control recipe destination.
See also: Defining and Setting Up Control Recipe Destinations

For cockpits:

In Customizing for Cockpit Definitions, you can define PPPI_LAYOUT in the first process instruction (of type 0).

You enter an XML definition in the long text for characteristic PPPI_LAYOUT. Note the following:

The XML definition must start with an XML declaration that specifies which XML version is required to process the XML document (in this case the XSL file):

<?xml version="1.0"?>

The XML definition must start and end with the <LAYOUT> tag:

If you want to use your own XSL style sheet, you must specify the XSL file in the <LAYOUT>/<STYLE> tag.

Example
<LAYOUT>...
<STYLE>SAPR3-BDS-POC_TEMPLATE-OT-MYDOC-MYSTYLE.XSL</STYLE>
</LAYOUT>

For PI sheets, the system automatically loads a standard archiving layout when you archive PI sheets in the batch record. If you want to use a different archiving layout, you must specify the appropriate XSL file in the <LAYOUT>/<ARCHIVE>/<STYLE> tag.

Example
<LAYOUT> ...
<ARCHIVE>
<STYLE>SAPR3-BDS-POC_TEMPLATE-OT-MYDOC-MYSTYLE_A.XSL</STYLE>
</ARCHIVE>
</LAYOUT>

You can assign a certain number of phases to the PI sheet header. The header and the phases you have defined are static and are always displayed when you scroll in the document. To do so, you must specify the number of phases in the <LAYOUT>/<HEADER> tag.

Example
<LAYOUT> ...
<HEADER>1</HEADER>
</LAYOUT>

If you want the system to create additional frames with different contents beside the PI sheet or cockpit itself, you need to define a frameset.

Example
<LAYOUT> ...
<FRAMESET ROWS="50%,50%">
<FRAME SRC="#DOCUMENT#"></FRAME>
<FRAME SRC="http://www.sap.com"></FRAME>
</FRAMESET>
</LAYOUT>

You can integrate different contents in the different frames.

To do so, you must assign the URLs with the files to be called to the individual frames. The PI sheet or cockpit itself must always be specified in the frameset definition. You do so by using #DOCUMENT#.

Example <FRAME SRC="#DOCUMENT#"> </FRAME>

To display another cockpit in a frame, you specify the corresponding cockpit name in the frame source.

The following URL convention must be adhered to:
SAPR3-PIDOC-<plant>PI<cockpit name>
Example <FRAME SRC="SAPR3-PIDOC-001PIMYCOCKPIT"> </FRAME>

To display another PI sheet in a frame, you specify the corresponding PI sheet number in the frame source.

The following URL convention must be adhered to:
SAPR3-PIDOC-<PI sheet number>
Example <FRAME SRC="SAPR3-PIDOC-00000000000004711"> </FRAME>

To display another Internet or Intranet page in a frame, you specify the corresponding URL in the frame source.

The following URL convention must be adhered to:
http://...
Example <FRAME SRC="http://www.sap.com"> </FRAME>

These documents (PI sheets and cockpits) can only be loaded once. This means that if several documents have the same ID, only the first document (instance) is loaded. All other instances for the same document are inactive.

Caution

Note the following:

All tag names must be written in capital letters
File names are case-sensitive and must be specified correctly

Example

The following example illustrates an XML definition in the long text of characteristic PPPI_LAYOUT. You can use all HTML attributes and tags for the FRAMESET tag definition that the browser supports. You must, however, adhere to the conventions for XML. The FRAMESET tag definition is identical to the one in HTML.

<?xml version="1.0"?>

<STYLE>SAPR3-BDS-POC_TEMPLATE-OT-MYDOC-MYSTYLE.XSL</STYLE>

<ARCHIVE>
<STYLE>SAPR3-BDS-POC_TEMPLATE-OT-MYDOC-MYSTYLE_A.XSL</STYLE>
</ARCHIVE>

</LAYOUT>