process industry 3
TRANSCRIPT
Process Management (PP-PI-PMA)
HE
LP
.PP
PI
Re lease 4 .6C
Process Management (PP-PI-PMA) SAP AG
Copyright © Copyright 2001 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. Microsoft®, WINDOWS®, NT®, EXCEL®, Word®, PowerPoint® and SQL Server® are registered trademarks of Microsoft Corporation. IBM®, DB2®, OS/2®, DB2/6000®, Parallel Sysplex®, MVS/ESA®, RS/6000®, AIX®, S/390®, AS/400®, OS/390®, and OS/400® are registered trademarks of IBM Corporation. ORACLE® is a registered trademark of ORACLE Corporation. INFORMIX®-OnLine for SAP and Informix® Dynamic Server
TM are registered trademarks of
Informix Software Incorporated. UNIX®, X/Open®, OSF/1®, and Motif® are registered trademarks of the Open Group. HTML, DHTML, XML, XHTML are trademarks or registered trademarks of W3C®, World Wide Web Consortium, Massachusetts Institute of Technology. JAVA® is a registered trademark of Sun Microsystems, Inc. JAVASCRIPT® is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. SAP, SAP Logo, R/2, RIVA, R/3, ABAP, SAP ArchiveLink, SAP Business Workflow, WebFlow, SAP EarlyWatch, BAPI, SAPPHIRE, Management Cockpit, mySAP.com Logo and mySAP.com are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other products mentioned are trademarks or registered trademarks of their respective companies.
2 April 2001
SAP AG Process Management (PP-PI-PMA)
Icons
Icon Meaning
Caution
Example
Note
Recommendation
Syntax
April 2001 3
Process Management (PP-PI-PMA) SAP AG
Contents
Process Management (PP-PI-PMA) .................................................................12 Access Process Management.................................................................................................... 15 Process Messages ...................................................................................................................... 16 Process Message ........................................................................................................................ 18 Process Message Category........................................................................................................ 20 Process Message Destination ................................................................................................... 21 Senders of Process Messages .................................................................................................. 23 Relationship Between Message and Message Destination .................................................... 24 Example: Structure Overview of a Process Message ............................................................. 26 R/3 Integration Using Process Messages................................................................................. 27
Goods Issue Posting ................................................................................................................ 29 Reversing of Goods Movements.............................................................................................. 31 Goods Receipt Posting ............................................................................................................ 33
Goods Receipt Posting via Quality Management ............................................................... 34 Goods Receipt Posting via Inventory Management ........................................................... 36 Goods Receipt Posting for By-Products ............................................................................. 38
Batch Creation ......................................................................................................................... 40 Assigning Values to Batch Characteristics .............................................................................. 42 Inspection Results Reporting to QM ........................................................................................ 44 Time Event Confirmation for Phases ....................................................................................... 45 Time Event Confirmation for Secondary Resources................................................................ 48 User Status Update for Operations and Phases...................................................................... 51 Update of Control Recipe Status and the Corresponding Order Statuses .............................. 52 Time Ticket Confirmation for Phases....................................................................................... 54 Time Ticket Confirmation for Secondary Resources ............................................................... 58 Reporting of Maintenance Data ............................................................................................... 62 Material Flow Posting Between Process Orders...................................................................... 66
Process Message Creation......................................................................................................... 70 Creating Process Messages Manually..................................................................................... 71
Sending of Process Messages .................................................................................................. 72 Starting the Send Function for Process Messages.................................................................. 73 Process Message Checks........................................................................................................ 75 Message Data Transfer............................................................................................................ 77
Process Message Monitoring..................................................................................................... 78 Display of Process Message Lists ........................................................................................... 80
Accessing the Message Monitor......................................................................................... 82 Printing Lists of Process Messages.................................................................................... 83
Message Detail Display............................................................................................................ 84 Displaying Process Messages............................................................................................ 85
Process Message Logs............................................................................................................ 86 Displaying Message Logs................................................................................................... 89 Displaying Transactional RFC Logs for Messages............................................................. 90
Message Processing in the Monitor......................................................................................... 91 Changing Process Messages ............................................................................................. 92 Starting Send Jobs for Process Messages......................................................................... 93
4 April 2001
SAP AG Process Management (PP-PI-PMA)
Sending Process Messages Online.................................................................................... 94 Deleting Individual Process Messages ............................................................................... 95
Deletion of Process Messages and Message Logs................................................................. 96 Deletion of all Messages/Logs Within a Range .................................................................. 97
Deleting All Messages/Message Logs Within a Range................................................. 99 Deleting Messages/Message Logs in the Background ............................................... 100 Displaying Deletion Logs ............................................................................................. 101
Process Instructions................................................................................................................. 102 Process Instruction................................................................................................................... 104 Process Instruction Category .................................................................................................. 106 Process Instruction Type ......................................................................................................... 107 Example: Structure Overview of a Process Instruction ........................................................ 110 Process Instruction Structure.................................................................................................. 111
Example: Process Parameter for Process Control System ................................................... 114 Example: Process Data Request for Process Control System.............................................. 115 Example: Process Message Subscription.............................................................................. 116
Process Instruction Maintenance............................................................................................ 117 Manual Process Instruction Maintenance.............................................................................. 120 Automatic Process Instruction Creation................................................................................. 122 Automatic Value Assignment to Process Instruction Characteristics .................................... 124
Process Instruction Download................................................................................................. 129 Control Recipes......................................................................................................................... 130 Control Recipe Destination ...................................................................................................... 132 Control Recipe Status............................................................................................................... 134 Creation of Control Recipes..................................................................................................... 136 Control Recipe Download......................................................................................................... 137 Control Recipe Monitoring ....................................................................................................... 139
Displaying of Control Recipe Lists ......................................................................................... 140 Accessing the Control Recipe Monitor.............................................................................. 141 Printing Lists of Control Recipes....................................................................................... 142
Control Recipe Logs............................................................................................................... 143 Displaying Control Recipe Logs........................................................................................ 144 Displaying Transactional RFC Log ................................................................................... 145
Control Recipe Download from Monitor ................................................................................. 146 Starting Download Job for Control Recipes...................................................................... 147 Downloading Control Recipes Online ............................................................................... 148
Control Recipe Deletion ......................................................................................................... 149 Deleting Control Recipe.................................................................................................... 150
Process Instruction Sheets (PI Sheets) .................................................................................. 151 ABAP List-Based PI Sheet........................................................................................................ 154 Browser-Based PI Sheet........................................................................................................... 158
Setting Up the Browser for PI Sheets and Cockpits .............................................................. 163 Functions in Browser-Based PI Sheets .................................................................................. 164
Recording of Actual Data in Browser-Based PI Sheets......................................................... 169 Batch Determination in the PI sheet ...................................................................................... 171 Reporting of Actual Data in Browser-Based PI Sheets.......................................................... 174 Discarding/Canceling of Browser-Based PI Sheets............................................................... 177
April 2001 5
Process Management (PP-PI-PMA) SAP AG
Completing of Browser-Based PI Sheets............................................................................... 178 Process Instructions for the R/3 PI Sheet............................................................................... 180
Type 0: Universal Process Instruction Category.................................................................... 182 Type 0: Structure of Process Instructions for PI Sheets................................................... 184 Type 0: Definition of Phase Sequences............................................................................ 189 Type 0: Definition of Data Requests ................................................................................. 190 Type 0: Definition of Message Creation............................................................................ 192 Type 0: Definition of Entries.............................................................................................. 193
Type 0: Definition of Default Values ............................................................................ 196 Type 0: Definition of Input Validations ......................................................................... 198
Check Formula Syntax for Input Validations .......................................................... 201 Type 0: Definition of Export Parameters ................................................................ 203 Type 0: Optional Parameter Transfer..................................................................... 205
Definition of Signatures in PI Sheets ........................................................................... 206 Type 0: Definition of Output Fields for Characteristic Values........................................... 210 Type 0: Definition of Output Fields for Variable Values.................................................... 212 Type 0: Definition of Calculations ..................................................................................... 213
Syntax in Process Data Calculation Formulas ............................................................ 215 Type 0: Definition of Automatic Value Assignment........................................................... 216 Type: Definition of Value Assignment Using Variables .................................................... 218 Type 0: Definition of Dynamic Function Calls ................................................................... 219
Type 0: Definition of Export Parameters...................................................................... 221 Type 0: Definition of Changing Parameters................................................................. 223 Type 0: Definition of Import Parameters...................................................................... 225 Type 0: Optional Parameter Transfer .......................................................................... 227
Type 1: Process Parameters for PI Sheets............................................................................ 228 Control Information ........................................................................................................... 229 Process Parameter: Notes................................................................................................ 230
Type 2: Process Data Requests for PI Sheets ...................................................................... 231 Types of Process Data Requests ..................................................................................... 232 Requested Message Category ......................................................................................... 233 Message Characteristics in Process Data Requests........................................................ 234
Message Characteristics: Value Assignment in Planning ........................................... 235 Message Characteristics: Automatic Value Assignment ............................................. 236 Message Characteristics - Manual Value Assignment ................................................ 237
Grouping of Input Values........................................................................................ 241 Definition of Default Values .................................................................................... 242 Definition of Variables in Process Data Requests and Calculation Formulas........ 244 Definition of Input Validations................................................................................. 246
Check Formula Syntax for Input Validations..................................................... 249 Definition of Export Parameters ........................................................................ 251 Definition of Changing Parameters ................................................................... 253 Definition of Import Parameters ........................................................................ 255
Example: Process Data Request / Message Category ............................................... 257 Message Characteristic: Value Assignment Using Variable ....................................... 258
6 April 2001
SAP AG Process Management (PP-PI-PMA)
Example: Message Characteristics - Value Assignment Using Variables ............. 259 Output Values ................................................................................................................... 260
Example: Definition of Output Values.......................................................................... 262 Definition of Signatures in PI Sheets ................................................................................ 263
Type 4: Process Data Calculation Formulas.......................................................................... 267 Requested Message Category ......................................................................................... 268 Message Characteristics in Process Data Calculation Formulas..................................... 269
Message Characteristics: Value to be Calculated....................................................... 270 Syntax in Process Data Calculation Formulas ....................................................... 272
Example: Process Data Calculation Formula / Message Category ............................ 274 Type 5: Inspection Results Requests .................................................................................... 276 Type 6: Dynamic Function Calls ............................................................................................ 277
Function to Be Called in a Dynamic Function Call ........................................................... 279 Definition of Export Parameters........................................................................................ 280 Definition of Changing Parameters................................................................................... 282 Definition of Import Parameters ........................................................................................ 284 Example: Dynamic Function Call / Function Module ........................................................ 286 Calling of any Transaction ................................................................................................ 287 Accessing of Order Confirmation...................................................................................... 288 Displaying of Material Quantity Calculation ...................................................................... 289 Displaying of Documents From Document Management System.................................... 290 Calculation of Time Intervals and Dates ........................................................................... 291 Physical-Sample Record Creation.................................................................................... 293 Processing of Physical-Sample Drawings ........................................................................ 295 Accessing Material Identification ...................................................................................... 296
Carrying Out Material Identification ............................................................................. 299 Type 7: Sequence Definitions ................................................................................................ 300 Variables in Process Instructions........................................................................................... 301
Definition of Variables ....................................................................................................... 302 Using Variables in ABAP List-Based PI Sheets ............................................................... 304 Using Variables in Browser-Based PI Sheets and Cockpits............................................. 306 Using System Variables in Browser-Based PI Sheets ..................................................... 309
Using Text Symbols in Process Instructions.......................................................................... 312 Example: Text Symbols for Automatic Value Assignment................................................ 314 Example: Text Symbols for Message Characteristics ...................................................... 315
Worklist for PI Sheets ............................................................................................................... 316 Finding PI Sheets................................................................................................................... 320 Worklist for Maintaining PI Sheets ......................................................................................... 322 Worklist for Completing PI Sheets ......................................................................................... 325 Worklist for Checking PI Sheets ............................................................................................ 328 Status of PI Sheets ................................................................................................................ 331
Processing of ABAP List-Based PI Sheets............................................................................. 334 Accessing ABAP List-Based PI Sheets ................................................................................. 336 Printing ABAP List-Based PI Sheets...................................................................................... 337 Scrolling Within ABAP List-Based PI Sheets ......................................................................... 338
Changing the Sections Displayed in ABAP List-Based PI Sheet ..................................... 339 Scrolling Between Sections of ABAP List-Based PI Sheets............................................. 340
April 2001 7
Process Management (PP-PI-PMA) SAP AG
Displaying Notes in ABAP List-Based PI Sheets................................................................... 341 Displaying of Data to Be Reported in ABAP List-Based PI Sheets ....................................... 342
Displaying Process Message in ABAP List-Based PI Sheets .......................................... 343 Recording of Actual Data in ABAP List-Based PI Sheets...................................................... 344
Recording Individual Values in ABAP List-Based PI Sheets ............................................ 346 Recording Values in Tables.............................................................................................. 348
Batch Determination in the PI sheet ...................................................................................... 350 Determining Batches in PI Sheets .................................................................................... 353
Checking Batches in PI Sheets.............................................................................................. 355 Value Calculation in ABAP List-Based PI Sheets.................................................................. 356
Calculating Values in ABAP List-Based PI Sheets........................................................... 357 Reporting of Actual Data in ABAP List-Based PI Sheets....................................................... 358
Reporting Data in ABAP List-Based PI Sheets ................................................................ 361 Executing Signatures in ABAP List-Based PI Sheets....................................................... 362 Executing Digital Signatures............................................................................................. 363 Executing Signature Strategies ........................................................................................ 365 Canceling Signature Processes........................................................................................ 368 Displaying Digital Signatures in ABAP List-Based PI Sheets........................................... 370
Recording and Displaying of Inspection Results.................................................................... 372 Recording Inspection Results ........................................................................................... 373 Displaying Inspection Results ........................................................................................... 374
Calling a Function .................................................................................................................. 375 Calling a Function ............................................................................................................. 376
Creating and Displaying of Comments in ABAP List-Based PI Sheets ................................. 377 Maintaining Comment Sheets in ABAP List-Based PI Sheets ......................................... 378 Displaying Comment Sheets in ABAP List-Based PI Sheets ........................................... 379 Maintaining Comments on Process Steps in ABAP List-Based PI Sheets ...................... 380 Displaying Comments in ABAP List-Based PI Sheets...................................................... 381
Displaying of Logs in ABAP List-Based PI Sheets ................................................................ 382 Displaying Logs in ABAP List-Based PI Sheets ............................................................... 383
Locating of Process Instructions in ABAP List-Based PI Sheets........................................... 384 Locating Process Instructions in ABAP List-Based PI Sheets.......................................... 385
Saving of ABAP List-Based PI Sheets................................................................................... 386 Saving ABAP List-Based PI Sheets.................................................................................. 387
Signing of ABAP List-Based PI Sheets.................................................................................. 388 Completion of ABAP List-Based PI Sheets............................................................................ 390
Setting ABAP List-Based PI Sheets to Complete............................................................. 391 Changing of Control Information in ABAP List-Based PI Sheets........................................... 392
Changing Control Information in ABAP List-Based PI Sheets.......................................... 393 Canceling of Order Confirmations in ABAP List-Based PI Sheets ........................................ 394
Canceling Order Confirmations Within ABAP List-Based PI Sheets................................ 395 Canceling of Material Documents in ABAP List-Based PI Sheets......................................... 396
Canceling Material Documents Within ABAP List-Based PI Sheets ................................ 397 Activating/Deactivating of Process Instructions in ABAP List-Based PI Sheets.................... 398
Activating/Deactivating Process Instructions in ABAP List-Based PI Sheets................... 399 Technical Completion of ABAP List-Based PI Sheets ........................................................... 400
Setting ABAP List-Based PI Sheets Technically Complete.............................................. 401 Deleting ABAP List-Based PI Sheets..................................................................................... 402
8 April 2001
SAP AG Process Management (PP-PI-PMA)
Monitoring and Logging of Signature Processes.................................................................. 403 Analyzing Logs for Digital Signatures .................................................................................... 404
Process Manufacturing Cockpits ............................................................................................ 406 Process Manufacturing Cockpit .............................................................................................. 408 Functions in Process Manufacturing Cockpits...................................................................... 411 Process Instructions for Process Manufacturing Cockpits.................................................. 416
Type 0: Structure of Process Instructions for Manufacturing Cockpits.................................. 417 Type 0: Definition of Data Requests ...................................................................................... 421 Type 0: Definition of Message Creation................................................................................. 423 Type 0: Definition of Entries................................................................................................... 424
Type 0: Definition of Default Values ................................................................................. 427 Type 0: Definition of Input Validations .............................................................................. 429
Check Formula Syntax for Input Validations ............................................................... 432 Type 0: Definition of Export Parameters...................................................................... 434 Type 0: Optional Parameter Transfer .......................................................................... 436
Type 0: Definition of Output Fields for Characteristic Values ................................................ 437 Type 0: Definition of Output Fields for Variable Values ......................................................... 439 Type 0: Definition of Calculations .......................................................................................... 440
Syntax in Process Data Calculation Formulas.................................................................. 442 Type 0: Definition of Automatic Value Assignment................................................................ 444 Type: Definition of Value Assignment Using Variables.......................................................... 446 Type 0: Definition of Dynamic Function Calls ........................................................................ 447
Type 0: Definition of Export Parameters........................................................................... 449 Type 0: Definition of Changing Parameters...................................................................... 451 Type 0: Definition of Import Parameters ........................................................................... 452 Type 0: Optional Parameter Transfer ............................................................................... 454
Setting Up the Browser for PI Sheets and Cockpits.............................................................. 455 Defining and Starting Process Manufacturing Cockpits....................................................... 456 Layout Definition for PI Sheets and Cockpits ........................................................................ 457 Definition of XSL Style Sheets for PI Sheets and Cockpits .................................................. 461
Reference Information for Defining Style Sheets................................................................... 463 Reference Information: Definition and Initialization of Logical Documents ...................... 466 Reference Information: Definition of R/3-Active Components .......................................... 468 Reference Information: Definition of Commands.............................................................. 481 Reference Information: Definition of Hyperlinks to Files in the R/3 System..................... 482 Reference Information: Definition of Text Symbols .......................................................... 483
Standard Files as Templates for Style Sheet Definitions....................................................... 483 Document Type Definition (DTD) for Generated XML Documents........................................ 494
Managing of Documents for Layout Definitions .................................................................... 496 Notes on Defining the Layout .................................................................................................. 499
April 2001 9
Process Management (PP-PI-PMA) SAP AG
10 April 2001
SAP AG Process Management (PP-PI-PMA)
April 2001 11
Process Management (PP-PI-PMA) SAP AG
Process Management (PP-PI-PMA)
Process Management (PP-PI-PMA) Purpose You can use this component to coordinate the exchange of production-relevant data between the R/3 System and the R/3-independent production level. The production level can be controlled as follows:
• Manually: the planned production steps are carried out manually by the process operator
• Automated: the planned production steps are carried out automatically by the process control system
• Partially automated: the planned production steps are carried out both manually by a process operator and automatically by a process control system
To settle a process order, the actual quantities produced and the time needed must be confirmed from production. Process management supports the direct confirmation from the PI sheet and process control system to the process order by sending process messages to predefined message destinations.
Implementation Considerations Install this component in process manufacturing companies.
Integration If You Want to You also Need
Exchange data between the R/3 System and a process control system
PP - PI-PCS Interface
Carry out quality inspections during production QM - Quality Management
Post goods movements to inventory management MM - Inventory Management
Create a batch during production or assign values to batch characteristics during production
LO - Batch Management
Send maintenance data to plant maintenance via the PI-PCS interface
PM - Plant Maintenance
Features You can store production-relevant data as process instructions [Page 102] in the process order [Ext.]. In the phases of the order, you specify whether the information is to be forwarded to a process operator or process control system.
Once the process order has been released for production and has been saved, the production-relevant data is combined in control recipes [Page 130] and sent to process management.
Process management receives the control recipes and sends them to the process operator or process control system responsible.
12 April 2001
SAP AG Process Management (PP-PI-PMA)
Process Management (PP-PI-PMA)
• If a control recipe is sent to a process operator, the production data stored in the control recipe is prepared as text that is displayed as PI sheets [Page 154] on the screen. The process operator can then use the PI sheet to execute the production steps manually.
• If a control recipe is sent to a process control system, the production data stored in the control recipe is sent as parameters to the production control system via the PI-PCS Interface [Ext.]. The process control system processes the data to control and regulate production.
After the process operator or process control system has carried out the production steps, process messages [Page 16] containing the current production times and quantities are automatically created in the PI sheet or process control system.
The process messages with the reported data is first sent to process management where they are checked and passed on to the corresponding process message destinations [Page 21] provided the check was successful. In addition to R/3 applications, message destinations may also be persons, programs, and machines.
In addition to this, process management comprises the message monitor [Page 78] and control recipe monitor [Page 139], tools that you can use to monitor the processing status of messages and control recipes. Furthermore, message and control recipe logs document the processing status of messages and control recipes.
In unexpected situations, such as malfunctions, you can also create process messages manually in process management and send them from there.
The following summarizes the functions supported by process management:
Receiving control recipes from released process orders •
•
•
•
•
•
Sending control recipes to process operators or process control systems
Preparing process instructions as texts so that they can be displayed and edited on the screen by the process operator
Receiving, checking, and sending process messages with actual process data
Monitoring process messages and control recipes
Manually creating process messages
April 2001 13
Process Management (PP-PI-PMA) SAP AG
Process Management (PP-PI-PMA)
R/3 R/3 ororexternal syst.external syst.
ProcessProcessplanningplanning
ProcessProcesscontrolcontrol
ProcessProcessmanagementmanagement
ExecutionExecution
PI sheet
Processcontrolsytem
Furthermessage
dest.
Processorder
Controlrecipe
Processmessages
14 April 2001
SAP AG Process Management (PP-PI-PMA)
Access Process Management
Access Process Management To access process management, proceed as follows:
From the main R/3 menu, select the menu options Logistics → Production - process → Process management.
The system branches to the initial process management menu. From here, you can access all the application functions of process management.
April 2001 15
Process Management (PP-PI-PMA) SAP AG
Process Messages
Process Messages Purpose When a process order is carried out, actual process data is needed that documents the process and is available for further processing in R/3 components and external function modules such as process control systems. You can use this component to send actual data from process control to predefined message destinations. Depending on the destination type, various business transactions are triggered in this way in the SAP System or an external system and data is reported.
Implementation Considerations Install this component in process manufacturing companies if you want to automatically report actual data from within process control and trigger business transactions.
Integration Function you want to perform Required component
Post goods movements in inventory management Inventory Management
• Create a batch during production
• Assign batch characteristics during production
Batch Management
Send maintenance data to plant maintenance via the PI-PCS interface
Plant Maintenance
Features Process messages can be used in communication with both automated and manually operated plants:
In automated plants, you must use the PI-PCS interface [Ext.] to send your process messages to the SAP System. This means that your process control systems must be able to communicate with the SAP System through this interface.
•
In manually operated plants, you can use the PI sheet [Page 151]. The process operator can enter process data directly on the screen. The process messages are automatically created in the PI sheet.
•
In addition, you can manually created unplanned process messages in the SAP System if, for example, malfunctions occur during production.
•
See: Process Message Creation [Page 70]
Each process message must be created with reference to a process message category predefined in Customizing. See: Process Message Category [Page 20]
You can send process messages to one or more predefined process message destinations, each of which supports different functions. See: Process Message Destinations [Page 21]
16 April 2001
SAP AG Process Management (PP-PI-PMA)
Process Messages
The standard system contains a number of predefined message categories and message destinations. They trigger certain business transactions in the other components of the SAP System. See: R/3 Integration Using Process Messages [Page 27]
Process management first checks all process messages to be sent (even the ones from external systems) and then sends them to the appropriate destinations provided that the check was successful. See: Sending of Process Messages [Page 72]
When the process messages have been sent, you can monitor the processing status of individual messages in the process message monitor. If necessary, you can change incorrect messages and then send them again. See: Process Message Monitoring [Page 78]
R/3 functionmodule
Qualitymgmt
Process dataevaluation
Processmanagement
SAPoffice userABAP Table:
External function:
Processorder
Process control PCSPI sheet
Updating datain R/3components
Information about processevents
Basis for evaluations
Coordination withexternal systems
Proc. operatorScheduler
Inventorymgmt Different
PCS
Processmessage
April 2001 17
Process Management (PP-PI-PMA) SAP AG
Process Message
Process Message Definition Communication structure that is used to transfer actual process data from process control to one or several destinations of the following types:
Other R/3 components •
•
•
•
User-defined ABAP tables
Users of the SAPoffice mail system:
External function modules
See also: Process Message Destinations [Page 21]
The information contained in a process message is determined by the message characteristics [Ext.] as well as the characteristic values assigned to them.
Use Depending on the destination to which the process message is sent, you can use the Process message business object for the following:
Triggering business transactions in the SAP System (for example, goods issue posting) •
•
•
•
Documenting actual data from process control and evaluating this data using internal or external functions
Sending mails to certain employees and informing them about the process status
Sending actual data from process control to an external system and triggering system reactions (such as opening a valve), if required
If process control is carried out by an external system, too, the actual data must:
a. First be sent to R/3 PP-PI (process message upload) via the PI-PCS Interface [Ext.]
b. Then be transferred to another system from R/3 PP-PI (process message download) via the same interface
Depending on the process instruction category [Page 107], you can define one or more process messages in a process instruction by assigning one ore more message categories along with the message characteristics to the process instruction during order planning. You can do so as follows:
In the process instruction categories in Customizing for Process Management by choosing Process Instructions -> Defining Process Instruction Categories (General) [Ext.]
•
In the process instructions in the master recipe [Ext.] and process order [Ext.] •
Structure A process message consists of a message header and several message characteristics as well as the characteristic values assigned to these characteristics
18 April 2001
SAP AG Process Management (PP-PI-PMA)
Process Message
Header The header of a process message contains general message data such as:
Administrative data on the message •
•
•
The plant in which the message was created
The message category [Page 20] to which the message belongs
An indicator that specifies whether the message was created for test purposes or whether it should actually be sent
•
•
Characteristics Which process data is to be contained in messages of a particular category is defined by assigning characteristics.
Process message characteristics are defined and assigned to the message categories in Customizing. In the message category, you also specify whether a characteristic is required or optional.
See Customizing for Process Management:
Process Messages -> Process Message Characteristics -> Defining Characteristics for Process Messages [Ext.]
Process Messages -> Defining and Setting Up Process Message Categories [Ext.] •
Process management checks all incoming messages against the predefined message categories. Each message must contain at least those characteristics marked as required within the message category.
When you create or change a process message manually within SAP System, the characteristics assigned to the respective message category are automatically offered for maintenance. You cannot add further characteristics to the message.
Characteristic Values In the process message, a characteristic value can be assigned to each characteristic contained in the message category. The value expresses the process-specific data for the characteristics.
The format of a characteristic value as well as the value range to which it must belong is defined in the characteristic in Customizing. Depending on the format, the value of a message characteristic can be either a date, a time, a numeric or alphanumeric key, a short text or a long text.
See: Example: Structure Overview of a Process Message [Page 26]
April 2001 19
Process Management (PP-PI-PMA) SAP AG
Process Message Category
Process Message Category Definition Process message categories are standard process messages that have been defined in Customizing for Process Management.
The standard system comprises a number of standard process message categories that you can use or copy to define your own process message categories. You can create your own process messages in Customizing for Production Planning - Process Industries by choosing Process Management -> Process Messages -> Defining and Setting Up Process Message Categories [Ext.].
See also: R/3 Integration Using Process Messages [Page 27]
Use Message categories are defined per plant when you customize your process management system.
The process message category specifies:
Which message characteristics are to be contained, which means which information is to be passed on in a process message of a certain category
•
• The message destinations [Page 21] to which the process message is to be sent
If required, the destination-specific target fields to which the individual message data is to be transferred
•
•
•
•
This offers the following advantages:
The structure and destination of similar messages need to be defined only once in a plant.
Only the users defining message categories in Customizing must have a detailed knowledge of the destinations and the data they need. The persons who create process messages during the production process can use the predefined message categories.
Each process message sent via process management must belong to a predefined message category. You need process message categories:
If you want to define process messages in a process instruction category in Customizing for Process Management under Defining Process Instruction Categories (General) [Ext.]
If you want to define process messages in the process instructions of master recipes [Ext.] and process orders [Ext.]
•
If you want to create process messages manually [Page 71] in process management •
20 April 2001
SAP AG Process Management (PP-PI-PMA)
Process Message Destination
Process Message Destination Definition User or component to which process messages are sent for processing.
The standard system comprises a number of standard message destinations of type R/3 function module that you can use or copy to define your own process message destinations. You can create your own process message destinations in Customizing for Production Planning - Process Industries by choosing Process Management -> Process Messages -> Defining and Setting Up Process Message Destinations [Ext.].
Use You can sent process messages to the following types of destinations:
Type 1: R/3 function modules defined by SAP or the user •
This option can be used to update data in other R/3 components such as material stocks in inventory management. The standard system contains a number of message destinations defined for this purpose (see R/3 Integration Using Process Messages [Page 27]).
Type 2: external functions •
•
•
•
•
•
This option mainly serves to coordinate between the different process operators and control systems involved in the execution of a process. For example, a process message can be sent to inform a control system that the manual charging of a vessel has been completed.
Type 3: Users of the SAPoffice mail system This option can be used to inform specific people within a company on the progress of the production run.
Type 4: ABAP tables Message data that has been sent to user-defined ABAP tables can be accessed for evaluation purposes using internal or external functions.
Depending on the destination type, you may need to define target fields or interface parameters for the characteristic data transferred.
For the destination type ABAP tables, you must defined additional target fields to which the characteristic data is to be transferred.
For the destination type R/3 function module you may need to define target fields depending on how the function module has been defined.
You can assign process message destinations as follows:
To a message category in Customizing for Process Management by choosing Process Messages -> Defining and Setting Up Process Message Categories [Ext.]
Directly in the process message if message destination PI07 has been assigned to the message category in Customizing
•
You can assign more than one destinations to a message category. You can assign each message destination to several message categories.
April 2001 21
Process Management (PP-PI-PMA) SAP AG
Process Message Destination
See also: Relationship Between Message and Message Destination [Page 24]
22 April 2001
SAP AG Process Management (PP-PI-PMA)
Senders of Process Messages
Senders of Process Messages The sender of a process message is normally the recipient of the process instruction which requires that the message should be sent. Depending on how process control is carried out, this can be:
• The group of process operators processing a PI sheet
• An automated control system
A process message can, however, also be created and sent manually by an individual user.
April 2001 23
Process Management (PP-PI-PMA) SAP AG
Relationship Between Message and Message Destination
Relationship Between Message and Message Destination Message destinations are defined in Customizing independently of a specific message or message category. They can be assigned to a message in two ways:
• In Customizing via the message category
• By direct assignment to the individual message when it is created
Destinations for Message Categories If all messages of a message category need to be sent to a destination, you can assign this destination to the message category in Customizing. Process management sends every process message to all the destinations assigned to the respective message category.
In the case of ABAP tables and R/3 function modules, the R/3 System supports the transfer of individual message characteristics to specific target fields within the message destination. The corresponding settings are also made in Customizing for the message category.
Process message category
......
C1 req.
C2
C3 req.
C4 req.
Target fields
T1
T2
T3
T4
Target fields
TA
TB
TC
......
......
DestinationsCharacteristics
D1
D3 ......
D2
Customizing
Destinations for Individual Messages If you assign destinations to individual messages, you can use the same message category to send messages to different destinations. For example, you can use the same message category to inform different mail users of different events during the production run.
Destinations can be assigned to individual messages:
• If the message category has been set up in Customizing for sending via the destination PI07
• If the values of the message characteristics do not have to be transferred to specific target fields within the message destination
24 April 2001
SAP AG Process Management (PP-PI-PMA)
Relationship Between Message and Message Destination
PI07 is a message destination defined by SAP which can pass on messages to other destinations defined in the message itself. You assign a destination in the individual process message by entering the name of the destination as a value for a characteristic reserved for this purpose in the message category. Assigning message characteristics to destination-specific target fields is not possible in this case.
D xyz
PI07
Customizing
Processcontrol
Destinations
Processmanagement
...
D xyz
ProcMess.: Cat. A
D2
D1
Value xValue y
Value z
Destination
Destination
ProcMessCat.ProcMessCat. A A
...
DestinationsCharacteristics
D2
D1
PI07
Destination
Target fields
...
C1
C2
C3
C1
C2
C3
If a message destination is assigned both to the message category in Customizing and to the individual process message, the message is sent only once to the destination and a corresponding entry is made in the message log.
April 2001 25
Process Management (PP-PI-PMA) SAP AG
Example: Structure Overview of a Process Message
Example: Structure Overview of a Process Message Customizing Process management
req. = required message characteristic
PPPI_PROCESS_ORDER
PPPI_ OPERATION
PPPI_ PHASE
PPPI_ SOURCE
TEMPERATURE
PPPI_UNIT_OF_MEASURE
Message category READ
req.
PPPI_EVENT_TIME
PPPI_EVENT_DATE
req.
req.
req.
req.
req.
PPPI_PROCESS_ORDER
PPPI_PHASE
PPPI_SOURCE
TEMPERATURE
PPPI_UNIT_OF_MEASURE
PPPI_EVENT_DATE
PPPI_EVENT_TIME
Proc. message 1000057, cat. READ
60000047
4020
T-11
57
°C
04/05/1996
15:26
26 April 2001
SAP AG Process Management (PP-PI-PMA)
R/3 Integration Using Process Messages
R/3 Integration Using Process Messages When a process order is carried out, actual process data must be reported and business transactions must be started to ensure consistency of data between process control and the various components of the R/3 System.
The standard system contains a number of predefined function modules and process messages that enable integration with PP, MM, and QM as well as status management for process orders and control recipes. The required transactions are triggered when the relevant message destination receives a message of the corresponding message category.
The following table provides an overview of the transactions you can trigger together with the corresponding message categories and their destinations. For information on how the messages are processed, see the corresponding sections below.
Business Transaction Message Category Destination
Posting a goods issue [Page 29] PI_CONS PI04
Posting a goods receipt [Page 33] PI_PROD PI03
Creating batches [Page 40] PI_BT_CR PI14
Assigning values to batch characteristics [Page 42] PI_BT_CL PI14
Reporting inspection results to quality management [Page 44]
PI_QMSMR PI06
Confirming time events for the phases in the process order [Page 45]
PI_PHST PI_PHACT
PI05 PI11
Confirming time events for the secondary resources of a process order [Page 48]
PI_SRST PI_SRACT
PI05 PI11
Updating the user status of an operation or a phase in the process order [Page 51]
PI_OPUST PI_PHUST
PI10
Updating the control recipe status [Page 52] PI_CRST PI02
Updating the order statuses according to the control recipe status [Page 52]
PI_CRST PI09
Confirming time tickets for the phases of a process order [Page 54]
PI_PHCON PI15
Confirming time tickets for the secondary resources of a process order [Page 58]
PI_SRCON PI15
Reporting maintenance data to plant maintenance [Page 62]
PI_PMMD PI16
Posting material flows between process orders [Page 66] PI_MFLOW PI12
Information Contained in the Messages: The above message categories as they are defined by SAP comprise all the information required to carry out the required transaction in the form of characteristics. Under certain conditions, some
April 2001 27
Process Management (PP-PI-PMA) SAP AG
R/3 Integration Using Process Messages
of this data can also be obtained from other data sources within the R/3 System. In this case, the corresponding characteristic does not have to be included in the process message.
If the batch and the storage location for a material consumed have already been maintained in the corresponding reservation, you need not repeat this information in the process message reporting the material consumption.
Refer to the subsequent sections to decide for your particular case which characteristics you must include in your process messages and in which cases you can use alternative sources of information.
28 April 2001
SAP AG Process Management (PP-PI-PMA)
Goods Issue Posting
Goods Issue Posting
When a material has been consumed in a process, a goods issue for the order must be posted in inventory management. You can trigger the goods issue posting by sending a message of the category PI_CONS to the destination PI04.
Please note the following when defining your process message:
Reservation number and item: The goods issue is only posted if backflushing has not been defined for the reservation item specified in the process message.
If the reservation number and item are not specified in the process message, the system will search for a reservation matching the order and material numbers as well as the operation or phase number contained in the process message.
If a message contains both the numbers of the phase and the superior operation and the material is assigned to both, the goods receipt is posted to the phase.
If several reservation items matching the message data are found, the goods issue is posted to the first reservation item for which a final issue indicator has not yet been set, and a corresponding warning is written to the message log. If the final issue indicator has been set for all the reservation items found, the goods issue is posted to the last reservation item.
If no valid reservation can be found using the message data, an unplanned goods issue is posted for the order and a corresponding warning message is written to the message log.
After the goods issue is posted, the numbers of the reservation and the reservation item are written to the message log, if they were not defined in the message.
Batch number: If batch management is not required for the material according to its master record, but a batch number has been specified in the message, this number is ignored.
If batch management is required for a material according to its master record, the system will search for a batch number first in the process message and then in the reservation. If the batch number has not been maintained there, an error message is written to the message log and the message status is set to “destination error”. Storage location: If no storage location is specified in the process message, the goods issue is posted to the storage location maintained in the reservation.
If this has not been maintained either, an error message is written to the message log and the message status is set to “destination error”.
Checks for consistency: As the message is processed, the system checks whether the values contained in it are valid and consistent with one another. If an inconsistency is discovered (for example, an invalid order number or a unit of measure which is not allowed for the material specified in the message):
• A corresponding error or warning message is written to the message log and
April 2001 29
Process Management (PP-PI-PMA) SAP AG
Goods Issue Posting
• The status of the process message is set to “destination error” or “sent with warning”
Material document When the goods issue is posted, the system creates a corresponding material document. The number of this material document is written to the message log.
See also: Documentation for the application component MM - Inventory Management, section Goods Issue with Reference to an Order [Ext.].
30 April 2001
SAP AG Process Management (PP-PI-PMA)
Reversing of Goods Movements
Reversing of Goods Movements Use If you have entered incorrect data when you posted a goods movement or if you want to return the quantity withdrawn because you do not need it right now, you cannot make these changes in the material document. You must reverse the goods movement and post it again.
You can use this function to trigger the reversal of goods receipts, transfer postings, and goods issues during production from within a process control system by sending a process message to function module COCI_CANCEL_MATERIAL_MOVEMENT.
You can also start goods movement reversal as follows:
• From the Materials Management component by choosing the relevant inventory management transaction
See also: Canceling a Material Document [Ext.]
• From within the PI sheet by choosing the relevant menu option
See also: Canceling Material Documents Within PI Sheet [Page 397]
Integration You can request process messages to reverse goods movements in a process instruction. For process control systems, for example, you can define a process message subscription to request reversal messages for all goods movement reversals to be posted during process order execution.
Prerequisites SAP delivers this function module without a predefined message category or message destination. For this reason, you must define them yourself in Customizing for Process Management.
You have made the following settings in Customizing for Process Management:
• You have created function module COCI_CANCEL_MATERIAL_MOVEMENT as a message destination and defined its destination-specific target fields.
• You have created a message category along with the characteristics required for the goods movement in question.
• You have assigned the destination to the message category. You have assigned the characteristics of the message category to the target fields of the message destination.
If required, make these settings together with your MM consultant to determine the fields that are important for your message. For more information, see the documentation for function module COCI_CANCEL_MATERIAL_MOVEMENT.
April 2001 31
Process Management (PP-PI-PMA) SAP AG
Reversing of Goods Movements
Features Consistency Checks When processing the messages, the system checks whether the values they contain are valid and consistent with one another. If an inconsistency (for example, an invalid order number) is discovered:
• The system writes a corresponding system message to the message log
• The system sets the process message status Destination error or Sent with warning
Reversal Document Number The system creates a material document (reversal document) for each reversal posting. The number of this document is written to the message log.
32 April 2001
SAP AG Process Management (PP-PI-PMA)
Goods Receipt Posting
Goods Receipt Posting When a material has been produced in a process, a goods receipt for the order must be posted. Whether and how you can trigger the goods receipt posting using a process message depends on the type of material produced:
Goods Receipt for Header Material and Co-Products: If you want to post a goods receipt for the header material of the order or for a co-product, you need to send a message of category PI_PROD to destination PI03. How the message data is processed depends on the inspection specifications defined for the material:
• If an inspection is to be carried out during production using inspection points, the message is sent to QM, provided that one of the following process steps is defined in QM:
− Assignment of partial lots or batches (see QM data for the recipe header, Partial-lot assign. field)
− Recording of an inspection point quantity (see QM data for operation/phase, Insp.pointCompletion field)
After the inspection, you can post a goods receipt for each inspection point based on the inspection results.
• In all other cases, the message is sent to inventory management. This means that the goods issue is posted directly.
Goods Receipt Posting via Quality Management [Page 34]
Goods Receipt Posting via Inventory Management [Page 36]
Goods Receipt for By-Products: If the material produced is a by-product for which a reservation item has been maintained, you can post the goods receipt by sending a message of category PI_CONS to destination PI04. You cannot use a process message to post a goods receipt for a by-product that is not contained in a reservation.
Goods Receipt for By-Products [Page 38]
Consistency Checks:
The system checks whether the values contained in the message are valid and consistent with one another. If an inconsistency is discovered (for example, an invalid order number or a unit of measure that is not allowed for the material specified in the message):
• The system writes a corresponding error or warning message to the message log
• The system sets the process message status Destination error or Sent with warning
April 2001 33
Process Management (PP-PI-PMA) SAP AG
Goods Receipt Posting via Quality Management
Goods Receipt Posting via Quality Management Use If an inspection is carried out during production using inspection points, you may have to post individual goods receipts for the inspection points based on their respective inspection results.
If you use inspection points, the system does not post PI_PROD messages directly to inventory management but sends them to QM in the following cases:
• In the master recipe, you have defined an assignment of partial lots or batches in QM (see QM data for the recipe header, Partial-lot assign. field)
• In the master recipe, you have defined the recording of an inspection point quantity in QM (see QM data for operation/phase, Insp.pointCompletion field)
The system proposes the reported quantity as the yield for the inspection point during results recording in QM.
You can manually post the goods receipt after you have finished inspection processing. This enables you to take into account the partial lots assigned to your inspection points as well as the assigned batches if your materials are subject to batch management.
Features In QM, the message data is processed in the following way:
Operation Number and Phase Number The message can only be assigned to an inspection point, if it contains at least one of these numbers. If a message contains neither the operation nor the phase number:
• The system writes a corresponding error message to the message log
• The system sets the process message status Destination error
If a message contains both the number of the phase and that of the superior operation and the material is assigned to both, the goods receipt is posted for the phase.
Material Quantity The system proposes the reported material quantity as the yield for the inspection point during results recording. If more than one PI_PROD messages has been created for an operation or phase, the system adds the quantities and proposes the sum for the next inspection point.
During goods issue in inventory management, the system later proposes the sum of the inspection point quantities for whose operation or phase the last partial lot assignment has been defined in the master recipe (see Last p. lot assign. indicator in the QM data for the operation/phase).
Batch Number If an inspection is carried out for a material that is subject to batch management, the batch number is assigned in QM according to the inspection results. For this reason, any batch number contained in a PI_PROD message for this material is ignored.
See also: QM in Production [Ext.] in the QM - Quality Management component
34 April 2001
SAP AG Process Management (PP-PI-PMA)
Goods Receipt Posting via Quality Management
April 2001 35
Process Management (PP-PI-PMA) SAP AG
Goods Receipt Posting via Inventory Management
Goods Receipt Posting via Inventory Management A goods receipt which is triggered by a PI_PROD message is processed in the same way as a manual goods receipt in inventory management. Please note the following when defining your process messages:
Order item: If the order item is not specified in the message, the system will search for an order item matching the order and material numbers in the message as well as the operation or phase number if you are manufacturing co-products.
If there are several valid items matching the message data, the goods receipt is posted to the first one and a corresponding warning is written to the message log.
If a message for a co-product contains both the numbers of the phase and the superior operation and the material is assigned to both, the goods receipt is posted to the phase.
If no valid order item can be found using the message data, an error message is written to the message log and the message status is set to “destination error”.
Batch number: If batch management is not required for the material according to its master record, but a batch number has been specified in the message, this number is ignored.
If batch management is required for a material according to its master record, the system will search for a batch number first in the process message and then in the order item. If the batch number has not been maintained there, an error message is written to the message log and the message status is set to “destination error”. If a batch with the specified number does not yet exist in the system, the batch is created when the goods receipt is posted.
Storage location: If no storage location is specified in the process message, the material is posted to the default storage location maintained in the order item.
If this has not been maintained either, an error message is written to the message log and the message status is set to “destination error”.
Stock type: You can determine in the process message whether a goods receipt is posted to unrestricted stock, blocked stock, or inspection stock. If you do not specify a stock type in the message, the system uses the stock type defined in the process order header.
Delivery completion indicator: If you do not set this indicator in the process message, it can be set automatically according to the logic defined in inventory management.
Fields without message characteristic: When you manually post a goods receipt, you can fill in a number of fields for which there is no corresponding characteristic in the message category PI_PROD. These entries are not required in the goods receipt and you cannot fill these fields using a PI_PROD message. However, if a default value has been defined for one of them, for example, in the order item, the default value will be posted in the goods triggered by the process message.
36 April 2001
SAP AG Process Management (PP-PI-PMA)
Goods Receipt Posting via Inventory Management
Material document When the goods receipt is posted, the system creates a corresponding material document. The number of this material document is written to the message log.
See also: Goods Receipts for Orders [Ext.] in the MM Inventory Management (MM-IM) component.
April 2001 37
Process Management (PP-PI-PMA) SAP AG
Goods Receipt Posting for By-Products
Goods Receipt Posting for By-Products When the destination PI04 receives a process message of category PI_CONS, the system normally posts a goods issue for the material. However, if the material quantity is reported for a by-product, that is, a negative material list item, a goods receipt is posted for the material.
The message data is processed in the following way:
Material quantity: The material quantity produced has to be specified as a positive number in the process message.
Reservation number and item: From the reservation item specified in the process message, the system determines the movement type to be posted, that is, “Receipt of a by-product”.
If the reservation number and item is not specified in the process message, the system will search for a reservation matching the order and material numbers as well as the operation or phase number contained in the process message.
If a message contains both the numbers of the phase and the superior operation and the material is assigned to both, the goods receipt is posted to the phase.
If several reservation items matching the message data are found, the goods receipt is posted to the first reservation item for which a delivery completion indicator has not yet been set, and a corresponding warning is written to the message log. If the delivery completion indicator has been set for all the reservation items found, the goods receipt is posted to the last reservation item.
You cannot use a PI_CONS message to post a goods receipt for a by-product if this by-product is not contained in a reservation. If the system cannot find a valid reservation item for the material specified in the process message, it will post an unplanned goods issue for the material.
After the goods receipt is posted, the numbers of the reservation and the reservation item are written to the message log, if they were not defined in the message.
Batch number: If batch management is not required for the material according to its master record, but a batch number has been specified in the message, this number is ignored.
If batch management is required for a material according to its master record, the system will search for a batch number first in the process message and then in the reservation. If the batch number has not been maintained there, an error message is written to the message log and the message status is set to “destination error”. If a batch with the specified number does not yet exist in the system, the batch is created when the goods receipt is posted.
Storage location: If no storage location is specified in the process message, the goods receipt is posted to the storage location maintained in the reservation.
If this has not been maintained either, an error message is written to the message log and the message status is set to “destination error”.
38 April 2001
SAP AG Process Management (PP-PI-PMA)
Goods Receipt Posting for By-Products
Material document When the goods receipt is posted, the system creates a corresponding material document. The number of this material document is written to the message log.
See also: Section Goods Receipts for Orders [Ext.] in the document MM Inventory Management
April 2001 39
Process Management (PP-PI-PMA) SAP AG
Batch Creation
Batch Creation Use You can create a batch from within process control by sending a message of category PI_BT_CR to destination PI14.
You need this function if you want to create a batch during production. You can also create batches as follows:
• From within the process order during planning
• After posting a goods issue when production has been completed (see Goods Issue Posting [Page 33]).
Integration You can use process instructions in the process control system or PI sheet to request process messages for batch creation. You can define the following process instructions, for example:
• A process data request for the PI sheet, which you can use to request a process message for the batch of a specific material
• A process message subscription for process control systems, which you can use to request process messages for all batches created during production
Customizing of the SAP reference client contains several sample process instruction categories for batch creation. For general information on process instructions, see process instructions [Page 102].
Prerequisites • The material for which you want to create a batch has been defined as being subject to batch
management in its master record (Work scheduling view or Storage view).
• Batch numbers can be assigned internally by the system or externally by the user.
If required, activate internal batch number assignment in Customizing for Batch Management (see IMG, section Logistics - General → Batch Management). If you do so, you can still assign numbers externally.
Features When creating the message, note the following:
Material For the system to be able to create a batch, you must at least include the corresponding material number in your process message. If the material number is missing, the system writes a corresponding system message to the process message log when processing the message; the message itself receives status Destination error.
Batch
If required, transfer a new batch number for external number assignment in the process message. If the process message contains no batch number and you have activated internal number assignment, the system assigns the number when it creates the batch.
40 April 2001
SAP AG Process Management (PP-PI-PMA)
Batch Creation
If the process message contains a batch number that already exists in the system, the system writes a corresponding system message to the process message log; the message itself receives status Destination error.
Plant If the plant has been defined as the batch level in Customizing for Batch Management, the system requires a plant to create a batch. It first searches for the plant in the process message. If it does not find it there, it searches for it in the order item.
Process Order and Order Item
You must only include the order number and item in the process message, if you want to use the customer exits for batch number assignment and batch valuation (see IMG, section Logistics - General → Batch Management).
Consistency Checks: When processing the process message, the system checks whether the values contained in it are valid and consistent with one another. If the system discovers an inconsistency (for example, an invalid order number or a material number that is not contained in the order), it:
• Writes a corresponding system message to the message log
• Sets the status of the process message to Destination error
April 2001 41
Process Management (PP-PI-PMA) SAP AG
Assigning Values to Batch Characteristics
Assigning Values to Batch Characteristics Use You can assign a value to a batch characteristic from within process control by sending a process message of category PI_BT_CL to destination PI14.
This is useful if a characteristic need not be entered in Quality Management (QM). For characteristics that are to be taken into account in quality inspections during production, we recommend transferring the inspection results from QM to the batch instead (see Link: Master Inspection Characteristic - Class Characteristic [Ext.] and Transfer of Inspection Results to Batch Class [Ext.]).
Integration You can use process instructions in the process control system or PI sheet to request process messages for assigning values to batch characteristics. You can, for example, define a process data request in which you request a process message for a specific characteristic of the batch you have produced.
Customizing of the SAP reference client contains several sample process instruction categories for value assignment to batch characteristics. For general information on process instructions, see Process Instructions [Page 102].
Prerequisites To assign values to the characteristics of a batch, the batch must have been created in the system.
Features When creating the message, note the following:
Material and Batch Number For the system to be able to assign a value to a batch characteristic, you must include the corresponding material and batch number in your process message.
The material and batch must have been created in the system. In the PI sheet and if you create process messages manually, the system uses the input validation for the characteristics to ensure that you enter allowed values. From the process control system, you can trigger input validation via the PI-PCS interface.
If the material number and batch number are missing in the process message, the system writes a corresponding system message to the message log when processing the message. The message itself is assigned status Destination error.
Plant If the plant has been defined as the batch level in Customizing for Batch Management, the system also requires the plant to identify a batch. It first searches for the plant in the process message. If it does not find it here, it searches for it in the order item.
Process Order and Order Item
You must only include the order number and item in the process message, if you want to use the customer exits for batch valuation (see IMG, section Logistics - General → Batch Management).
42 April 2001
SAP AG Process Management (PP-PI-PMA)
Assigning Values to Batch Characteristics
Batch Characteristic Name and Value
In the process message, you identify the characteristic whose value is to be assigned by including the characteristic name. The characteristic must belong to the same class as was used to classify the batch.
You must enter the characteristic value in the unit specified in the batch characteristic.
Consistency Checks: When processing the process message, the system checks whether the values contained in it are valid and consistent with one another. If the system discovers an inconsistency (for example, an invalid order number or a material number that is not contained in the order), it:
• Writes a corresponding system message to the message log
• Sets the process message status Destination error
April 2001 43
Process Management (PP-PI-PMA) SAP AG
Inspection Results Reporting to QM
Inspection Results Reporting to QM The results of in-process inspections can be recorded in the R/3 PI sheet or an external system and reported to QM using a process message of category PI_QMSMR to the destination PI06. This is possible if the following conditions are fulfilled:
• Inspection planning: An inspection during production has been defined for the material produced in the order. The inspection characteristics have been set up for summarized recording of measured results.
• Inspection processing: A corresponding inspection lot has been created for the order. The inspection lot is created automatically during order release if an inspection has been planned for the material to be produced.
The message data is processed in the following way:
Operation number and phase number: The message can only be assigned to an inspection characteristic in the inspection lot, if it contains at least one of these numbers. If a message contains neither the operation nor the phase number:
• A corresponding error message is written to the message log and
• The status of the process message is set to “destination error”
If a message contains both the numbers of the phase and the superior operation and the inspection characteristic is assigned to both, the inspection result is assigned to the phase.
Inspection result, number of inspections and inspection short text: The reported values will be available as default values within the QM function for reporting inspection results.
Checks for consistency: As the message is processed, the system checks whether the values contained in it are valid and consistent with one another. If an inconsistency is discovered (for example, an invalid inspection lot number or a characteristic which is not contained in the specified inspection lot):
• A corresponding error or warning message is written to the message log and
• The status of the process message is set to “destination error” or “sent with warning”
See also: Document QM Quality Management.
44 April 2001
SAP AG Process Management (PP-PI-PMA)
Time Event Confirmation for Phases
Time Event Confirmation for Phases Use You use this function to confirm time events for the phases of a process order control by sending a corresponding process message in process control. You can confirm the following time events:
• Processing time events for particular points in time (for example, start, finish)
• Time events for variable activities
See also: Completion Confirmations in the Process Order [Ext.]
Prerequisites • Standard values with record type group Processing or Variable activity have been maintained
in the standard value key of the corresponding primary resource.
• The control key that has been assigned to the phase allows confirmation.
• The process order has been released.
Features You can use the following process messages and destinations to confirm time events:
Time event Message category Destination
Processing time event PI_PHST PI05
Time event for variable activity PI_PHACT PI11
The following sections describe what you must bear in mind when you create process messages.
Process Messages for Processing Time Events Time event: You determine which time event you want to confirm by entering the corresponding phase status in the process message. You can confirm the following time events or statuses:
Time event / status Meaning
Start Partial confirmation: Processing of the phase has been started. You also need to set this status when you continue executing a phase after an interruption.
Finish Final confirmation: Processing of the phase has been finished.
Interruption Partial confirmation: Processing of the phase has been interrupted.
Partial finish Partial confirmation: Processing of the phase has not yet been finished, but the yield obtained so far is to be confirmed.
April 2001 45
Process Management (PP-PI-PMA) SAP AG
Time Event Confirmation for Phases
In the process message, you use the characteristics for the event date and time to specify the confirmed point in time.
Yield to be confirmed: Depending on the time event, you can also use the process message to report the yield obtained for the phase. The yield is processed as follows:
• Time events Start and Interruption:
You cannot confirm a yield.
• Time event Partial finish:
In this case, you can use the process message to confirm a yield.
• Time event Finish:
If you specify a yield in the process message, this quantity will be confirmed. Otherwise, the system confirms the planned yield, that is, the operation quantity.
Yield that you confirm using time event Finish is added to yields that have been confirmed using time event Partial finish.
Resource: For the time event Start, you can also confirm that a different primary resource was used than planned. To do so, you include the characteristics used for the resource name and plant of the resource in the process message.
Process Message for Variable Activities Time event: To determine the time event you want to confirm, you enter the corresponding status in the process message. You can confirm the following time events or statuses:
Time event / status Meaning
Partial finish Partial confirmation: Resource usage has not yet finished, but the activity performed so far is to be determined.
Finish Final confirmation: Resource usage has finished.
If no specific time event is contained in the process message, the system automatically sets status Partial finish.
Variable activity: You use the parameter ID of the standard value to determine the activity you want to confirm in the process message. The parameter must be defined in the standard value key that is assigned to the phase via the primary resource.
You enter the activity performed and, if required, the unit of measurement for this parameter in the process message.
46 April 2001
SAP AG Process Management (PP-PI-PMA)
Time Event Confirmation for Phases
General Notes on Message Processing The following applies to both processing time events and variable activities.
Additional confirmation data: If required, you can also confirm a short text for the confirmation and the reason for deviating from the planned data.
Consistency checks: When processing the message, the system checks whether the values contained in it are valid and consistent with one another. If an inconsistency is discovered (for example, an invalid order number or a time event that is not allowed at the current processing stage of the phase):
• The system writes a corresponding error or warning message to the message log
• The system sets the status of the process message to Destination error or Sent with warning
Subsequent processing: All further processing of the data confirmed is carried out according to the general logic of the confirmation function.
Confirmation number: The system assigns a unique number to each confirmation. The number is written to the message log.
April 2001 47
Process Management (PP-PI-PMA) SAP AG
Time Event Confirmation for Secondary Resources
Time Event Confirmation for Secondary Resources Use You use this function to confirm time events for the secondary resources of a process order by sending a corresponding process message in process control. You can confirm the following time events:
• Processing time events for particular points in time (for example, start, finish)
• Time events for variable activities
See also: Completion Confirmations in the Process Order [Ext.]
Prerequisites • Standard values with record type group Processing or Variable activity have been maintained
in the standard value key in the resource master.
• The control key that has been assigned to the secondary resource allows confirmation.
• The process order has been released.
Features You can use the following process messages and destinations to confirm time events:
Time event Message category Destination
Processing time event PI_SRST PI05
Time event for variable activity PI_SRACT PI11
The following sections describe what you must bear in mind when you create process messages.
Process Messages for Processing Time Events Time event: You determine which time event you want to confirm by entering the corresponding resource status in the process message. You can confirm the following time events or statuses:
Time event / status Meaning
Start Partial confirmation: Resource usage has started. You must also set this status when you continue using the secondary resource after an interruption.
Finish Final confirmation: Resource usage has finished.
Interruption Partial confirmation: Resource usage has been interrupted.
48 April 2001
SAP AG Process Management (PP-PI-PMA)
Time Event Confirmation for Secondary Resources
Partial finish Partial confirmation: Resource usage has not yet finished, but the activity performed so far is to be determined.
In the process message, you specify the confirmed point in time using the characteristics for the event date and time.
Resource:
For the time event Start, you can also confirm that a different resource was used than planned. To do so, you include the characteristics used for the resource name and plant of the resource in the process message.
Process Message for Variable Activities Time event:
You determine the secondary resource for which you confirm time events by including the characteristics used for the process order, operation or phase, and item number of the secondary resource in the process message.
To determine the time event you want to confirm, you enter the corresponding status in the process message. You can confirm the following time events or statuses:
Time event / status Meaning
Partial finish Partial confirmation: Resource usage has not yet finished, but the activity performed so far is to be determined.
Finish Final confirmation: Resource usage has finished.
If no specific time event is contained in the process message, the system automatically sets status Partial finish.
Resource: As for processing time events, you determine the secondary resource for which you confirm time events by including the characteristics used for the process order, operation or phase, and item number of the secondary resource in the process message.
For time events for variable activities however, you cannot confirm resources deviating from the planned data.
Variable activity:
You enter the activity performed and, if required, the unit of measurement for this parameter in the process message.
General Notes on Message Processing The following applies to both processing time events and variable activities.
You use the parameter ID of the standard value to determine the activity you want to confirm in the process message. The parameter must be defined in the standard value key of the secondary resource.
Additional confirmation data:
April 2001 49
Process Management (PP-PI-PMA) SAP AG
Time Event Confirmation for Secondary Resources
If required, you can also confirm a short text for the confirmation and the reason for deviating from the planned data.
Consistency checks: When processing the message, the system checks whether the values contained in it are valid and consistent with one another. If an inconsistency is discovered (for example, an invalid order number or a time event that is not allowed at the current processing stage of the phase):
• The system writes a corresponding error or warning message to the message log
• The system sets the status of the process message to Destination error or Sent with warning
Subsequent processing:
Confirmation number: The system assigns a unique number to each confirmation. The number is written to the message log.
All further processing of the data confirmed is carried out according to the general logic of the confirmation function.
50 April 2001
SAP AG Process Management (PP-PI-PMA)
User Status Update for Operations and Phases
User Status Update for Operations and Phases You can report changes to the user status of an operation or phase to order management by sending a process message of the category PI_OPUST (for operations) and PI_PHUST (for phases) to the destination PI10.
• If you send the message online, the status is set in the language in which you are currently logged on to the system.
• If the message is sent in the background, the status is set in the logon language used when defining the corresponding background job.
In both cases, a corresponding entry is made in the message log.
Since user statuses are language-dependent, you can specify the language of the user status you want to set in the process message. If the language is not specified in the process message, it is determined in the following way:
See also: Status Management
April 2001 51
Process Management (PP-PI-PMA) SAP AG
Update of Control Recipe Status and the Corresponding Order Statuses
Update of Control Recipe Status and the Corresponding Order Statuses
Permitted control recipe statuses: You can set the following control recipe statuses:
Order status: In the process order, the control recipe statuses trigger the following operations:
The status “control recipe created” is revoked in the corresponding phases. The control data for these phases is again released for maintenance.
• Control recipe status “terminated”:
The status of the corresponding phases is set to “Control recipe finished”. The control data of the phases cannot be changed again. It will be archived with the process order. If you need a new control recipe with corrected data to finish the process, you can carry out the following steps:
• Create new phases with corrected control data for this destination.
• Create a control recipe for these phases.
• Control recipe status “processed”:
You can update the control recipe status and the corresponding order statuses by sending a process message of the category PI_CRST to the destinations PI02 and PI09 respectively. The message data is processed in the following way:
Control recipe status Meaning
Discarded The control recipe has been downloaded but it cannot be processed. It is canceled before the execution starts.
Terminated The control recipe is canceled after the start of its execution.
Processed The execution of the control recipe has been completed.
• Control recipe status “discarded”:
• Create a new control recipe destination with the same address.
The status of the corresponding phases is set to “Control recipe finished”. The control data of the phases remains frozen and will be archived with the process order.
Checks for consistency: Before the control recipe status is updated in process management, the system checks whether the values contained in the process message are valid and consistent with one another. If an inconsistency is discovered (for example, if the specified control recipe does not exist or the reported status is not allowed for the control recipe):
• A corresponding error or warning message is written to the message log and
• The status of the process message is set to “destination error” or “sent with warning”
52 April 2001
SAP AG Process Management (PP-PI-PMA)
Update of Control Recipe Status and the Corresponding Order Statuses
April 2001 53
Process Management (PP-PI-PMA) SAP AG
Time Ticket Confirmation for Phases
54 April 2001
SAP AG Process Management (PP-PI-PMA)
Time Ticket Confirmation for Phases
Time Ticket Confirmation for Phases Use You can use this function to perform time ticket confirmations directly from within production by using a process message. Thus, one process message sent from production is enough to confirm all activities performed for a phase along with the resource used.
You can confirm the following data:
• Yield and scrap quantity, provided that the planning and recording of scrap has been defined for the order type
• Primary resource
You can also confirm phases as follows:
• Activities performed (for example, machine time, labor time, duration, or energy consumption)
• Time ticket confirmation
− Using function calls from within PI sheets [Page 288]
− Manually from within the area menu for process orders [Ext.]
If you use the relevant transaction for time ticket confirmation, you can also update standard values and confirm HR data.
• Time event confirmation
For more information, see:
• Time Event Confirmation for Phases [Page 45]
• Time Event Confirmation for Secondary Resources [Page 48]
− Manually from within the area menu for process orders [Ext.]
− Using a process message from within the PI sheet or the process control system
Unlike time ticket confirmation, you only confirm a single time event, such as the start or end of a phase or one activity, in every process message you send.
See also: Completion Confirmations in the Process Order [Ext.]
Integration You can request process messages for time ticket confirmation from within the PI sheet or the process control system in a process instruction.
You can, for example:
• Define a process message subscription for process control systems to request time ticket confirmations for all phases of a control recipe requiring confirmation
• Define a process data request for the PI sheet to request a time ticket confirmation for a specific phase
April 2001 55
Process Management (PP-PI-PMA) SAP AG
Time Ticket Confirmation for Phases
Customizing of the SAP reference client contains several sample process instruction categories for time ticket confirmation. For general information on process instructions, see Process Instructions [Ext.].
• The control key that has been assigned to the phase allows confirmation.
• The process order has been released.
• No time event confirmation has been created for the phase so far.
The following data is available for time ticket confirmations for phases in the standard system:
• Process message category PI_PHCON
• Message destination PI15
The following sections describe what you must bear in mind when you create the process messages:
Primary Resource If the phase was not carried out at the planned primary resource, you can confirm the resource that was actually used in the process message. If you do not specify a resource in the process message, the system automatically confirms the planned resource.
Prerequisites
Features
• Process data request PH_CON for time ticket confirmations for phases from the PI sheet
Activities You can enter up to six standard values [Ext.] in a phase. The number and meaning of the standard values depends on the standard value key assigned to the primary resource. In the process message, you can confirm the actual activity performed for each standard value entered for a phase. The characteristics for the activity confirmation are numbered in the same order in which the system displays the standard values and activities in the process order.
Indicator: Remaining Work for Activity You use this indicator to specify if you expect further confirmations for the activity in question.
Yield and Scrap Quantity In addition to activity confirmation, you can confirm the yield produced for the phase and the scrap quantity incurred, provided that scrap management is active for the order type.
In the short text, you can, for example, describe the reason for the variance.
Posting Date If you do not want to post the confirmed quantities for the current date, you can enter any other date within an allowed posting period (backdating and postdating permitted). If you do not specify a posting date in the message, the system posts the confirmation on the date when the message was created (Event date characteristic).
Confirmation Text
56 April 2001
SAP AG Process Management (PP-PI-PMA)
Time Ticket Confirmation for Phases
Status for Activity Confirmation The status shows whether phase processing has been completed.
The following table provides an overview of possible confirmation statuses:
Confirmation Status
Meaning
Partial finish Partial confirmation.
Processing of the phase has not yet been completed but the activity performed so far is to be determined.
Finish Final confirmation.
Processing of the phase has been completed.
Consistency Checks
• The system writes a corresponding system message to the message log
• The system sets the process message status Destination error or Sent with warning
Subsequent Processing
When processing the messages, the system checks whether the values they contain are valid and consistent with one another. If an inconsistency (for example, an invalid order number) is discovered:
All further processing of the data confirmed is carried out according to the general logic of the order confirmation function.
Confirmation Number The system assigns a unique number to each confirmation. The number is recorded in the message log.
April 2001 57
Process Management (PP-PI-PMA) SAP AG
Time Ticket Confirmation for Secondary Resources
58 April 2001
SAP AG Process Management (PP-PI-PMA)
Time Ticket Confirmation for Secondary Resources
Time Ticket Confirmation for Secondary Resources
You can use this function to perform time ticket confirmations directly from within production by using a process message. Thus, one process message sent from production is enough to confirm all activities performed for a secondary resource along with the resource used.
You can confirm the following data:
• Activities performed (for example, machine time, labor time, duration, or energy consumption)
You can also confirm secondary resources as follows:
• Time ticket confirmation
− Using function calls from within PI sheets [Page 288]
− Manually from within the area menu for process orders [Ext.]
If you use the relevant transaction for time ticket confirmation, you can also update standard values and confirm HR data.
− Using a process message from within the PI sheet or the process control system
For more information, see:
• Time Event Confirmation for Phases [Page 45]
Use
• Secondary resource
• Time event confirmation
• Time Event Confirmation for Secondary Resources [Page 48]
− Manually from within the area menu for process orders [Ext.]
Unlike time ticket confirmation, you only confirm a single time event, such as the start or end of a secondary resource or one activity, in every process message you sent.
See also: Completion Confirmations in the Process Order [Ext.]
Integration You can request process messages for time ticket confirmation from within the PI sheet or the process control system in a process instruction.
• Define a process data request for the PI sheet to request a time ticket confirmation for a specific secondary resource
• Define a process message subscription for process control systems to request time ticket confirmations for all secondary resources that were created during order execution
Customizing of the SAP reference client contains several sample process instruction categories for time ticket confirmation. For general information on process instructions, see Process Instructions [Ext.].
You can, for example:
April 2001 59
Process Management (PP-PI-PMA) SAP AG
Time Ticket Confirmation for Secondary Resources
Prerequisites • The control key that has been assigned to the secondary resource allows confirmation.
• The process order has been released.
• No time event confirmation has been created for the secondary resource so far.
Features The following data is available for time ticket confirmations for secondary resources in the standard system:
• Process message category PI_SRCON
• Message destination PI15
• Process data request SR_CON for time ticket confirmations for secondary resources from the PI sheet
The following sections describe what you must bear in mind when you create the process messages.
For the system to be able to identify the secondary resource, you must specify the item number of the secondary resource and the phase number to which it belongs.
Activities You can enter up to six standard values [Ext.] in a phase. The number and meaning of the standard values depends on the standard value key assigned to the primary resource. In the process message, you can confirm the actual activity performed for each standard value entered for a phase. The characteristics for the activity confirmation are numbered in the same order in which the system displays the standard values and activities in the process order.
Indicator: Remaining Work for Activity You use this indicator to specify if you expect further confirmations for the activity in question.
Confirmation Text
Posting Date If you do not want to post the confirmed quantities for the current date, you can enter any other date within an allowed posting period (backdating and postdating permitted). If you do not specify a posting date in the message, the system posts the confirmation on the date when the message was created (Event date characteristic).
Status for Activity Confirmation
Secondary Resource
In the short text, you can, for example, describe the reason for the variance.
The status shows whether secondary resource processing has been completed.
The following table provides an overview of possible confirmation statuses:
Confirmation Status
Meaning
60 April 2001
SAP AG Process Management (PP-PI-PMA)
Time Ticket Confirmation for Secondary Resources
Partial finish Partial confirmation.
Resource usage has not yet finished but the activity performed so far is to be determined.
Finish Final confirmation.
Resource usage has finished.
Consistency Checks
• The system writes a corresponding system message to the message log
• The system sets the process message status Destination error or Sent with warning
Subsequent Processing
When processing the messages, the system checks whether the values they contain are valid and consistent with one another. If an inconsistency (for example, an invalid order number) is discovered:
All further processing of the data confirmed is carried out according to the general logic of the order confirmation function.
Confirmation Number
April 2001 61
Process Management (PP-PI-PMA) SAP AG
Reporting of Maintenance Data
Reporting of Maintenance Data Use You can use this function to report measurement and counter readings taken in feeder systems (such as process control systems) to the Plant Maintenance (PM) application component using the PI-PCS Interface [Ext.]. If unexpected events such as malfunctions occur, you can also send a malfunction report to plant maintenance. This enables you to quickly respond to exceptional situations. You do so by creating a process message.
This function enables you to perform planned and condition-based maintenance of technical objects during production.
• Planned Maintenance You can use planned monitoring and maintenance of objects to react to legal or environmental requirements, or manufacturer recommendations by documenting measurement data in measurement documents.
For more information, see Measurement Document [Ext.].
• Condition-Based Maintenance Condition-based maintenance enables you to use malfunction reports to identify and rectify unplanned conditions such as malfunctions or damages in time.
You want to report the operating hours of your production line to plant maintenance. In plant maintenance, maintenance plan scheduling was used to specify the time interval at which the production line must be maintained (for example, every 2000 operating hours). You can use a message of category PI_PMMD to report the operating hours to plant maintenance.
If the line does not function properly, you can send a malfunction report in addition to the measurement data. The malfunction report requires the maintenance department to solve the problem.
For more information, see Malfunction Report [Ext.].
Generally, the PM-PCS interface [Ext.] must be used to transfer this maintenance data to plant maintenance. This function enables companies that use PP-PI and a process control system that has been certified for the PI-PCS interface to use only one interface to transfer both their production data and maintenance data to the R/3 System.
Integration You can transfer measurement and counter readings to the R/3 System as follows:
• They are automatically recorded by the process control system. This means that a process message subscription must have been defined for the process control system. It is used to send the confirmations for all measurement readings taken at specific measuring points [Ext.] in the process control system to plant maintenance.
• They are taken by the process operator and manually entered in the PI sheet. This means that a process data request must have been defined for the PI sheet. It is used to report the recorded measurement readings to plant maintenance.
62 April 2001
SAP AG Process Management (PP-PI-PMA)
Reporting of Maintenance Data
Customizing of the SAP reference client contains several sample process instruction categories for the confirmation of maintenance data. For general information on process instructions, see Process Instructions [Ext.].
Prerequisites To perform the planned and condition-based maintenance of technical objects, you must have defined a maintenance plan in plant maintenance. The maintenance plan defines the dates and the scope of the maintenance tasks.
See also: PM - Maintenance Planning [Ext.]
Features You use message category PI_PMMD and message destination PI16 to confirm maintenance data. Process instruction category PM_MDOC is available in the standard system.
The following sections describe what you must bear in mind when you create the process messages.
Required Message Data For the R/3 System to be able to process the message, you must include the following data in the message:
• Name of the data point (measuring point) or secondary index for measuring point For the system to be able to create a measurement document, you must either specify the measuring point / counter [Ext.] at which the measurement reading is taken or a secondary index for the measuring point. The secondary index is the measurement position maintained for the measuring point. The measurement position is used to identify the measuring point. Measurement positions are descriptive names that describe the position of a measuring point at an object or in the production line.
• Value of the data point (measurement reading) For measuring points that are defined as counters, you must specify the counter reading.
For measuring points that are not defined as counters, you must either enter the measurement reading to be reported or the valuation code [Ext.]. In Customizing, you can determine whether the measurement document must include either a measurement reading or a valuation code or both.
− The measurement reading is used for a quantitative valuation (for example, "25 degrees Celsius").
− The valuation code is used for a qualitative valuation (for example, "temperature is normal"). If you use a valuation code, the system automatically determines the relevant code group and code catalog based on the measuring point.
The system only accepts the following values:
− Numerical value for quantitative valuation
− Character strings for qualitative valuation
April 2001 63
Process Management (PP-PI-PMA) SAP AG
Reporting of Maintenance Data
Additional Message Data
• Measuring point: counter reading difference The system either calculates the counter reading difference or the current counter reading. By setting the X indicator, you specify that the counter reading reported is to be interpreted as the difference between the present and the last counter reading. If you do not set the indicator, the system interprets the value entered as the absolute counter reading.
If you want to report the current counter reading, report 1200 hours in the process message and do not set the Counter difference indicator.
In both cases, the system automatically calculates the difference of 200 hours and shows it in the measuring point.
• Date and time
− In process data requests for the PI sheet, the system time of the R/3 System is used.
• Type of maintenance notification If you want to send a malfunction report [Ext.] in addition to the measurement or counter reading, you must enter the corresponding notification type. The system does not create a malfunction report unless you explicitly specify a notification type. If you do not specify a notification type, the system only creates a measurement document in plant maintenance. Apart from the malfunction report, you can also use several other notification types.
You can include the following additional data in the message:
Process control systems usually represent counters that take counter readings (for example, machine hours). If the last counter reading was 1000 hours and 200 hours were now reported in the process message with the Counter difference indicator being set, the total counter reading is now 1200 hours.
− In process message subscriptions for the process control system, the process control system should transfer the date and time of the reading.
For more information, see PM - Maintenance Notifications [Ext.].
• Priority of the malfunction report In Customizing, you define the time in which the problem must be solved after notification recording for each priority. The system then calculates the start and end dates for the maintenance task. You can define further priorities in Customizing in addition to the priority values contained in the standard system.
• Unit of measure Here, you enter the unit of the recorded value or counter reading. If you do not specify a unit, the system uses the unit stored for the measuring point or counter in the R/3 System.
If you use a different unit, the system automatically converts it. The system can only do this if:
− You have defined the unit in Customizing
64 April 2001
SAP AG Process Management (PP-PI-PMA)
Reporting of Maintenance Data
− The unit you have entered and the unit defined for the measuring point are of the same dimension (for example, degree Celsius, Fahrenheit)
• Source Here, you enter the source where the measurement reading comes from.
− If the measurement reading was taken manually, this can be the name of the person who took the reading.
− If the reading was taken by a process control system, this can be the ID of that system.
• Short text You can enter any short text for the message. If you have not defined valuation codes in Customizing, you can also use the short text to enter a description of the malfunction.
• User data Here, you can enter further customer-specific data.
Consistency Checks When processing the messages, the system checks whether the values they contain are valid and consistent with one another. If an inconsistency (for example, an invalid measuring point) is discovered:
• The system writes a corresponding system message to the message log
• The system sets the process message status Destination error or Sent with warning
Measurement Document Number The system assigns a unique measurement document number to each notification as well as a malfunction report number if required. These numbers are written to the message log.
April 2001 65
Process Management (PP-PI-PMA) SAP AG
Material Flow Posting Between Process Orders
Material Flow Posting Between Process Orders Use You use this function to post material flows between process orders by sending a corresponding process message.
Scenario A material (for example, bulk material) is manufactured in a process order and is immediately used as a material component in another order where it is further processed (for example, filled). The following transactions are posted together when the first or the second order is carried out:
• Confirmation of both orders
• Goods receipt for the bulk material for the first order
• Goods issue for the bulk material for the second order
Prerequisites Both process orders have been released.
No inspection points are used in the inspection during production for the first process order.
The following applies to the material for which you want to post the material flow:
• The special procurement key Phantom assembly has not been assigned in the material master.
• No fixed lot size has been defined for the material in the BOM of the second order.
• The material has not been marked as a variable-size item in the BOM of the second order.
• The material has not been marked as an alternative BOM item in the BOM of the second order.
• Discontinued parts has not been activated for the material.
Features To post material flows, you can use message category PI_MFLOW and destination PI12.
You enter the following actual quantities in the message:
• If you create the message for the first order, the quantity of the bulk material produced with it
• If you create the message for the second order, the quantity of the finished product produced with it
The message destination processes the message as follows:
• It determines the respective missing quantity using the quantity proportions between the product and the bulk material planned in the second order
• It posts the goods receipt for the bulk material for the first order.
66 April 2001
SAP AG Process Management (PP-PI-PMA)
Material Flow Posting Between Process Orders
• It generates a process message of category PI_CONS, which is used to post the goods issue for the bulk material for the second order.
• It generates a process message of category PI_ORDCO, which is used to confirm the first order at header level.
• It generates a process message of category PI_ORDCO, which is used to confirm the second order at header level.
When you confirm the first order, the system requires the quantity of the header material to determine the activity performed. For this reason, the first order cannot be confirmed if the bulk material is a by- or co-product. In this case, the system writes a corresponding entry in the message log. The other postings are carried out nevertheless.
The following sections describe what you must bear in mind when you create process messages.
Minimum Information to be Contained in the Process Message For the system to be able to post the material flow, you must at least include the following characteristics in your process message:
• Date and time when the message was created (PPPI_EVENT_DATE and PPPI_EVENT_TIME)
• Order number of the first order (PPPI_MFS_PROCESS_ORDER)
• Order number of the second order (PPPI_MFT_PROCESS_ORDER)
When assigning a value to characteristics PPPI_MFS_PROCESS_ORDER and PPPI_MFT_PROCESS_ORDER, you can use the search help in the process order. You can use the search help, to search for a suitable order pair for the material flow according to the following selection criteria:
– Header material/product or material component
– Planned and confirmed order dates
• Material number of the bulk material for which you want to post the material flow (PPPI_MF_MATERIAL)
• Quantity and unit of measurement of the bulk material (PPPI_MF_QUANTITY and PPPI_MF_UNIT_OF_MEASURE)
You require these characteristics if you create the message for the first order. The quantity entered here is used to:
– Post the goods receipt for the first order
– Post the goods issue for the second order
– Calculate the quantity of the finished product using the quantity proportion planned in the second order
• Quantity and unit of measurement of the finished product (PPPI_MP_QUANTITY and PPPI_MP_UNIT_OF_MEASURE)
April 2001 67
Process Management (PP-PI-PMA) SAP AG
Material Flow Posting Between Process Orders
You require these characteristics if you create the message for the second order. The yield entered here is used to:
– Confirm the second order
– Calculate the quantity of the bulk material using the quantity proportion planned in the second order
The quantity calculated for the bulk material or the finished product is rounded up to the number of decimal places defined in Customizing for the unit of measure.
• Batch number (PPPI_MF_BATCH)
You use this characteristic for materials that are to be handled in batches to specify the batch for which the goods receipt is posted. If the batch number is not contained in the message, the system uses the batch planned for the material in the order. If no batch number has been maintained there either, the system automatically assigns a batch number, provided that you have activated automatic number assignment in Customizing. Otherwise, the message status is set to Destination error.
• Storage location (PPPI_MF_STORAGE_LOCATION) !
Additional Data on the First Order • Order item (PPPI_MFS_ORDER_ITEM_NUMBER)
• Final delivery (PPPI_MFS_DELIVERY_COMPLETE)
Additional Data on the Bulk Material
You use this characteristic to specify the storage location for which the goods receipt is posted. If the storage location is not contained in the message, the system uses the storage location planned for the material in the order item. Otherwise, the message status is set to Destination error.
You use this characteristic to specify the order item for which the goods receipt for the bulk material is posted. If the bulk material is a by-product, enter the reservation and reservation item instead. If the message neither contains an order item nor a reservation item, the system searches for an item that matches the order number and material. If the order does not contain an item for the material, the message status is set to Destination error.
• Reservation and reservation item of the bulk material (PPPI_MFS_RESERVATION and PPPI_MFS_RESERVATION_ITEM)
If the bulk material is a by-product, you use this characteristic to specify the reservation item for which the goods receipt is posted. For primary and co-products, enter the order item instead. If the message neither contains an order item nor a reservation item, the system searches for an item that matches the order number and material. If the order does not contain an item for the material, the message status is set to Destination error.
If you include this indicator in the message, the status of the first order is set to Final delivery and Finally confirmed.
68 April 2001
SAP AG Process Management (PP-PI-PMA)
Material Flow Posting Between Process Orders
• Clearing reservations(PPPI_MFS_CLEAR_RESERVATIONS)
If you include this indicator in the message, all reservations for the first order are cleared.
Additional Data on the Second Order • Reservation and reservation item of the bulk material
(PPPI_MFT_RESERVATION and PPPI_MFT_RESERVATION_ITEM)
You use this characteristic to specify the reservation item for which the goods issue for the bulk material is posted. If the message contains no reservation item, the system searches for a reservation item that matches the order number and material. If the system cannot find a suitable reservation item, the message status is set to Destination error.
If you include this indicator in the message, the status of the second order is set to Final delivery and Finally confirmed.
• Clearing reservations (PPPI_MFT_CLEAR_RESERVATIONS)
If you include this indicator in the message, all reservations for the second order are cleared.
• Confirmation text and reason for variance (PPPI_CONFIRMATION_SHORT_TEXT and PPPI_REASON_FOR_VARIANCE)
If you include these characteristics in the process message, the values are transferred to both order confirmations.
• Start date and time (PPPI_START_DATE and PPPI_START_TIME) as well as finish date and finish time (PPPI_END_DATE and PPPI_END_TIME)
• Final delivery (PPPI_MFT_DELIVERY_COMPLETE)
Additional Data on the Confirmation
If you include these characteristics in the process message, the values are transferred to both order confirmations as order start and finish dates. If you do not include the characteristics, the order uses the date when the message was created (PPPI_EVENT_DATE and PPPI_EVENT_TIME) as the order start and finish dates.
April 2001 69
Process Management (PP-PI-PMA) SAP AG
Process Message Creation
Process Message Creation Use Process messages are created by process control in order to report actual data on the execution of a process order. Depending on the event to which it refers, a process message can be created in either of the following ways:
• Manually within process management
Prerequisites In both cases, the structure of the process messages must correspond to the predefined message category in R/3 Customizing.
You can create test messages to check the definition of your message categories and process instructions. Within R/3, test messages are created and monitored in the same way as productive messages. However, they are neither sent to their destinations nor checked for destination errors. Messages that are created automatically are marked as test messages if the corresponding control recipe has been created for test purposes.
Features Automatic Creation
For information on how to report process data in the PI sheet, see Recording of Actual Process Data [Page 344]
Manual Creation
• Automatically in the corresponding PI sheet or control system
If a process event is planned or expected, the corresponding message can be requested in a process instruction. In this case, the operator maintaining the PI sheet or the control system processing the control recipe has to provide the process data to be reported in the message. The message of the requested message category is created automatically.
Process messages are created manually:
• In unexpected situations which could not be taken into account in the control recipe (for example, in the case of malfunctions)
• If the process control system cannot provide the required information
For a description on how to create process messages, see Creating Process Messages Manually [Page 71].
70 April 2001
SAP AG Process Management (PP-PI-PMA)
Creating Process Messages Manually
Creating Process Messages Manually To create a process message, proceed as follows:
1. On the Process Management screen, choose Message → Create.
The initial screen for creating process messages appears.
2. Enter the following data:
• Plant for which you want to create a process message
• The message category
• The test indicator if the message is to be created for test purposes
In the Sender field, your user name is displayed as a default value. You can change this value if required.
3. Choose Goto → Char. overview.
A dialog box appears where you can assign values to the message characteristics.
4. Enter the characteristic values.
You need to maintain a value for all characteristics marked as required in the message category.
If allowed values have been maintained for the characteristic in Customizing, you can display them for selection:
If your message contains the characteristics “event date” (PPPI_EVENT_DATE) and “event time” (PPPI_EVENT_TIME), the corresponding values are automatically proposed by the system. You can, however, change the proposed values.
If the message category you have chosen contains a characteristic for which you must enter a long text, proceed as follows:
a. Select the characteristic.
b. Choose Edit → Long text. The text editor appears.
c. Enter the desired text and save it.
5. Choose Back.
If your process message contains another long text characteristic, you can now repeat steps 4.a to 4.c for this characteristic.
Otherwise, the system takes you back to the characteristic overview.
6. Save your message.
By saving a message, you release it for sending. This normally means that the message is sent automatically and can therefore no longer be changed (see Starting the Send Function for Process Messages [Page 73]).
April 2001 71
Process Management (PP-PI-PMA) SAP AG
Sending of Process Messages
Sending of Process Messages Use
• Starting the send function
• Checks and error handling
• Transferring the message data to the destinations
Messages that have been created for test purposes are monitored and checked against the predefined message categories in the same way as productive messages. However, they are neither sent nor checked for destination errors.
Starting the Send Function for Process Messages [Page 73]
All process messages are sent to their destinations by process management. This means that messages from external systems are first sent to process management, where they are processed in the same way as the messages created within R/3. The individual processing steps are:
Process Message Checks [Page 75]
Message Data Transfer [Page 77]
72 April 2001
SAP AG Process Management (PP-PI-PMA)
Starting the Send Function for Process Messages
Starting the Send Function for Process Messages Use In process management, the function for sending process messages can be started in the following ways:
The send job selects all messages with the status To be sent, To be resubmitted or To be resubmitted with warning. You can choose between the following types of background jobs:
− Cross-plant sending of messages in the background
The system sends all messages in your client, that is, irrespective of the plant in which they were created.
• Automatically in a background job defined in Customizing
Depending on your Customizing settings, the job is started at one of the following occasions:
• At regular time intervals
• Whenever a new message is created or received by process management
− Plant-specific sending of messages in the background
The system only sends the messages of a specific plant in your client. The job is started whenever a new message is created in the corresponding plant or is received by process management.
If you have activated the time zone function in your client, note the following when you define background jobs:
− If possible, only schedule plant-specific jobs for process message sending.
− The time zone in the master record of the user who defines the job must be identical to the time zone of the plant in which the messages are sent. This means that different users with a suitable Personal time zone must define jobs for different time zones.
For more information on how to define background jobs for sending process messages, see R/3 Customizing for Process Management.
• Manually in the message monitor You need this function:
− If you have not defined a background job for sending process messages in Customizing
− If you have corrected an error in a message and there are no new messages to trigger your background job
If you want to send all process messages that have not yet been sent, you can manually start the background job: see Starting Send Jobs for Process Messages [Page 93].
In addition, you can also select individual messages and send them online: see Sending Process Messages Online [Page 94].
April 2001 73
Process Management (PP-PI-PMA) SAP AG
Starting the Send Function for Process Messages
For information on how to access the message monitor, see Accessing the Message Monitor [Page 82].
74 April 2001
SAP AG Process Management (PP-PI-PMA)
Process Message Checks
Process Message Checks Checks Before a process message is sent to its destinations, the system checks:
• Whether the message matches the message category defined in R/3 Customizing
• Whether the destinations that are assigned to a message exist
• For all destinations except external functions, whether a message can be processed by its destinations
• Which processing type has been specified in Customizing for the message category for messages with a destination error (see Further Message Processing below).
Documentation of Results The results of the checks are documented as follows:
• The message status is updated.
• Information, warning, and error messages are written to the message log.
• The processing type is documented in the message log.
See also:
• Information on the message status under Display of Process Message Lists [Page 80]
• Process Message Logs [Page 86]
Further Message Processing Depending on the results of the checks, the message is further processed as follows:
• Messages without errors are sent to their destinations.
• Messages with destination errors (Status To be resubmitted or Destination error) are treated differently depending on the Customizing settings you have made for the message category. You can choose between the following processing types:
In this case, the message is sent to all destinations that can process it even if an error occurred at another destination. Once the message has been sent to a destination, it can no longer be changed in the message monitor even if it cannot be processed by a destination due to incorrect message data.
Send to all destinations or not at all
Send to all destinations that can process the message
In this case, the message is not sent to any destination if an error occurred at one destination at least. Thus, you can correct the message in the message monitor and then send it to all destinations.
See also: Message Processing in the Monitor [Page 91]
April 2001 75
Process Management (PP-PI-PMA) SAP AG
Process Message Checks
76 April 2001
SAP AG Process Management (PP-PI-PMA)
Message Data Transfer
Message Data Transfer The transfer of messages to external functions is carried out via transactional remote function call (tRFC) as program-to-program communication. The tRFC ensures that each call is carried out only once. The sequence of the calls is not changed. If the target system is not active when the call takes place, the RFC is repeated according to a repetition rate or duration that can be defined by the user.
The execution of a tRFC is documented in a log which you can access from the message monitor: see Displaying Transactional RFC Logs for Messages [Page 90].
For information on how to access the message monitor, see Accessing the Message Monitor [Page 82].
See also: PI-PCS Interface [Ext.]
April 2001 77
Process Management (PP-PI-PMA) SAP AG
Process Message Monitoring
Process Message Monitoring Use To achieve truly reliable process management and documentation, it is essential that all created process messages reach their destinations. The message monitor is a tool which enables you to display all process messages, check their processing status and correct errors that may have occurred.
Features Using the message monitor, you can obtain the following information:
• An overview of existing messages with general information on their processing status
• Details on the structure and content of individual messages
• Detailed logs documenting the processing of individual messages
Based on this information, you can then carry out the following actions:
• Changing messages
• Sending messages
• Deleting messages
Log
System messages:
tRFC Log
System messages:Message Monitor
Mess.cat. Send statusCreated on Time Sender
PI_CRSTPI_PHSTREADPI_CONSPI_PRODPI_COMPI_PHSTPI_PHST
SentSent with warningIncompleteTerminatedDestination errorTo be sentTo be resubmittedTo be resubmitted with warning
03/09/199603/09/199603/09/199603/09/199603/09/199603/09/199603/09/199603/09/1996
15:1513:2313:3113:4013:4313:4713:4913:49
SYS 1CTM 1CTM 1CTM 1CTM1CTM1CTM1CTM1
SendChange Message
Display Message
Display of Process Message Lists [Page 80]
Message Detail Display [Page 84]
Process Message Logs [Page 86]
Message Processing in the Monitor [Page 91]
78 April 2001
SAP AG Process Management (PP-PI-PMA)
Process Message Monitoring
April 2001 79
Process Management (PP-PI-PMA) SAP AG
Display of Process Message Lists
Display of Process Message Lists You can display lists of process messages on the overview screen of the message monitor: see Accessing the Message Monitor [Page 82]. You can also print these lists: see Printing Lists of Process Messages [Page 83].
Maintenance data of the messages such as creation time and sender
The plant, message category, and process order for which the messages were created
The processing status of the messages
In the monitor, all messages are displayed with their creation time, message category, sender and send status. The messages are highlighted using different colors according to their status so that you can quickly spot those where an error occurred. For detailed information on the errors, you need to refer to the corresponding message logs (see Process Message Logs [Page 86] ).
All messages that exist within process management can be displayed in the monitor. You can reduce the scope of the list using the following selection criteria:
•
•
•
• An indicator for productive messages or test messages
The process order can only be used as a criterion for selecting a message if the characteristic PPPI_PROCESS_ORDER is contained in the message.
The following table lists possible message statuses and their meaning:
Icon Status Meaning
To be sent The process message is created but has not yet been sent to its destinations.
Sent The process message has been sent to its destinations.
Sent with warning The message log contains a warning message. The process message has been sent to its destinations despite the warning.
To be resubmitted One of the message destinations was temporarily not available. Whether the message was sent to its other destinations depends on the processing type defined in Customizing; see Process Message Checks [Page 75].
To be resubmitted with warning
One of the message destinations was temporarily not available. Additionally, a warning message was issued by one of the other destinations to which the message was sent.
Message incomplete The process message does not contain all required characteristics of the message category. It has not been sent.
80 April 2001
SAP AG Process Management (PP-PI-PMA)
Display of Process Message Lists
Destination error The process message could not be processed by one of its destinations. Whether the message was sent to its other destinations depends on the processing type defined in Customizing; see Process Message Checks [Page 75].
Processing terminated The processing of the message was terminated due to an error. The message has not been sent to any of its destinations.
If a process message is to be sent to an external system, its status is set to Sent or Sent with warning as soon as the message has been transferred to the corresponding tRFC (transactional remote function call). The execution of a tRFC is documented in a log which you can access from the message monitor (see Displaying Transactional RFC Logs for Messages [Page 90]).
April 2001 81
Process Management (PP-PI-PMA) SAP AG
Accessing the Message Monitor
Accessing the Message Monitor To display lists of messages in the message monitor, proceed as follows:
The initial screen of the message monitor appears.
2. Enter selection criteria to restrict the number of process messages displayed, and choose Enter.
1. On the Process Management screen, choose Message → Message monitor.
The overview screen of the message monitor appears.
New messages may be created or the status of existing messages may change after you have accessed the message monitor. These changes are not automatically updated in the monitor. Choose Refresh to display the current data without exiting the message monitor.
82 April 2001
SAP AG Process Management (PP-PI-PMA)
Printing Lists of Process Messages
Printing Lists of Process Messages To print the list of messages displayed in the message monitor, proceed as follows:
The Print Screen List screen appears.
2. Enter the print parameters.
1. On the overview screen of the message monitor, choose Messages → Print.
3. Choose Print.
April 2001 83
Process Management (PP-PI-PMA) SAP AG
Message Detail Display
Message Detail Display From the overview screen of the message monitor, you can call up detail screens for individual messages: See Displaying Process Messages [Page 85].
For information on how to access the message monitor, see Accessing the Message Monitor [Page 82].
The screens for the individual messages show the following data:
• The header data of the message
• The characteristic structure of the message including characteristic values and long texts
84 April 2001
SAP AG Process Management (PP-PI-PMA)
Displaying Process Messages
Displaying Process Messages To display individual messages in the monitor, proceed as follows:
1. On the overview screen of the monitor, select the messages you want to display:
- To select all messages, choose Edit → Selections → Select all.
- To select all messages of a specific message category or status, choose Edit → Selections → Select by cat.... or Edit → Selections → Select by status....
2. Choose Display.
The system displays the first message selected.
4. To return to the overview screen of the message monitor, choose Back.
- To select individual messages, click the corresponding check box.
Enter the desired message category or status and choose Continue.
3. To branch to the next message, choose Next message.
April 2001 85
Process Management (PP-PI-PMA) SAP AG
Process Message Logs
Process Message Logs You can display two types of logs for a process message in the message monitor:
• Message logs that document the checking and processing of a message within process management: see Displaying Message Logs [Page 89].
• The tRFC log that documents the execution of the tRFC (transactional remote function call) used to transfer a message to external functions: see Displaying Transactional RFC Logs for Messages [Page 90].
For information on how to access the message monitor, see Accessing the Message Monitor [Page 82].
As a message is processed within R/3, the system creates the following logs:
Message Logs
When a message is The system creates Containing the
Sent One checking log • Header data of the process message
• Destinations assigned to the process message
• System messages reporting the results of the destination-independent checks
• Information on whether the processing type Send to all destinations or not at all has been activated in Customizing for the message category
• Information on whether the processing type Individual processing has been activated in Customizing for the message category
Sent One or more destination-specific logs
• System messages reporting the results of the destination-specific checks
• Transaction ID for the tRFC if the destination is an external function
86 April 2001
SAP AG Process Management (PP-PI-PMA)
Process Message Logs
Changed One change log • Header data of the process message
• Characteristics added to the process message
• Old and new values of the characteristics changed
• Name of the person who changed the process message
In the message monitor, you can call up a list of the existing logs for a process message. Depending on the importance of the data they contain (for example, errors or additional information), the logs are assigned to different log classes that are marked using different colors in the list.
From the list, you can branch to the individual logs. The system messages in the logs are also highlighted using different colors that indicate whether they provide information on an error, a warning or additional information.
By displaying the long text of the system messages, you can get more detailed information on the errors they report as well as hints as to how you can correct them.
Transactional RFC Log If a process message is sent to one or more external functions, the system documents the execution of the corresponding tRFCs in a tRFC log. The tRFC log documents all tRFCs carried out in your system. It provides information on:
• The processing status of the RFC
• System messages returned by the external system when it receives the process message data
When calling up the tRFC log within the message monitor, you can select the log entries to be displayed using the following criteria:
• The time when a tRFC was carried out
• The user who started the tRFC, that is, the user who created the send job or sent the process message online
The individual entries in the log can be identified using a number of additional criteria. You can find them in the corresponding destination-specific log of the process message. The following table lists the names of these fields in the tRFC log together with the corresponding fields in the message log:
Field name in tRFC log Field name in message log
Caller User
Target system Address
April 2001 87
Process Management (PP-PI-PMA) SAP AG
Process Message Logs
Transaction ID Computer ID Process ID Time stamp Transaction ID
Tctn Tcod
Program Program
88 April 2001
SAP AG Process Management (PP-PI-PMA)
Displaying Message Logs
Displaying Message Logs
1. On the overview screen of the monitor, select the messages for which you want to display the logs:
− To display individual messages, select the relevant messages.
− To select all messages, choose .
To display the logs for a process message, proceed as follows:
− To select all messages of a specific message category or status, choose Edit → Selections → Select by message category or Edit → Selections → Select by status.
Enter the message category or select the status you want to display and choose .
2. Choose Log.
The initial screen for displaying logs appears. The initial screen comprises two areas. One area shows the logs in an overview tree. The other area displays a list (ABAP List Viewer) with the messages for the log you have selected.
3. Expand the node of the relevant log in the tree.
The different problem classes in which the messages are grouped together appear.
4. Double-click the problem class you want to display.
The list of messages appears in the second screen area. The icon in the LTxt column indicates the messages for which a long text exists.
5. To display the long text, click with the quick info Long text exists.
6. To return to the overview of the log messages, choose .
7. To branch to the next log you have selected, repeat steps 3 to 5.
8. To display the logs for the next process message, choose . To return to the overview screen of the message monitor, choose twice.
− If you have selected more than one process message, the system will ask whether you want to display the log for the next message.
If you want to display the log, choose Yes.
The initial screen for displaying logs appears. From here, you can repeat steps 3 to 5 for the next process message.
− If you have displayed the log for the last message selected, the system will take you directly to the overview screen of the monitor.
For more information on how to display logs, see the documentation on Application Logs [Ext.], section Displaying Logs [Ext.].
April 2001 89
Process Management (PP-PI-PMA) SAP AG
Displaying Transactional RFC Logs for Messages
Displaying Transactional RFC Logs for Messages
1. On the overview screen of the message monitor, choose Environment → Log for tRFC.
The initial screen for displaying the tRFC log appears.
2. Enter the display period and the name of the user (sender) for whom you want to display log entries.
The system displays the log entries for the period and user specified.
To display the tRFC log for a message proceed as follows:
3. Choose Execute.
90 April 2001
SAP AG Process Management (PP-PI-PMA)
Message Processing in the Monitor
Message Processing in the Monitor Use Once a process message has been created, all subsequent processing by the user is carried out in the monitor. Which processing steps are allowed or required depends on the status of the process message. This section describes when and how you can change, send or delete a process message in the message monitor.
For information on how to access the message monitor, see Accessing the Message Monitor [Page 82].
Features Changing Messages If a message has not yet been sent to any of its destinations, you can change it in the following way (see Changing Process Messages [Page 92]):
• You can change the characteristic values of the process message.
• If the message category contains characteristics which are not yet contained in the current message, these characteristics are also offered for maintenance.
You need this function, for example, to complete process messages that do not contain all the required characteristics of their message category.
When you save your changes, the message status is set to “to be sent”. This means that the message will be taken into account during the next run of the send job.
Sending Messages If a message has the status “to be sent”, “to be resubmitted” or “to be resubmitted with warning”, you can send it from the message monitor using one of the following functions:
• If you want to send all messages, by starting the corresponding background job: see Starting Send Jobs for Process Messages [Page 93].
• If you only want to send individual messages, via online sending: see Sending Process Messages Online [Page 94]
Normally, process messages are automatically sent in the background after they have been created (see Starting the Send Function for Process Messages [Page 73]). You need the above functions:
• If you have not defined the background job for sending in Customizing
• After you have corrected an error in a message, if there are no new messages to trigger your background job
Deleting Messages You can delete process messages within the message monitor: see Deletion of Process Messages and Message Logs [Page 96].
April 2001 91
Process Management (PP-PI-PMA) SAP AG
Changing Process Messages
Changing Process Messages To change process messages, proceed as follows:
1. On the overview screen of the monitor, select the messages that you want to change:
– To change individual messages, only select the messages you want to change.
– To select all messages, choose Edit → Selections → Select all.
– To select all messages of a specific message category or status, choose Edit → Selections → Select by cat.... or Edit → Selections → Select by status....
Enter the desired message category or status and choose Continue.
2. Choose Edit → Change.
A dialog box appears where you can maintain the characteristic values for the message.
3. Add or change values as required.
You need to maintain a value for all characteristics marked as required in the message category.
If allowed characteristic values have been maintained for the characteristic in Customizing, you can display them for selection.
If the message category you have selected contains a characteristic for which you want to enter a long text, proceed as follows:
a. Select the characteristic.
b. Choose Edit → Long text. The text editor appears
c. Enter the desired text and save it.
Choose Back to go back to the next long text or the characteristic overview.
4. Save your message.
5. If you have selected several messages, the system automatically jumps to the next message after you have saved.
Repeat steps 3 to 4 for the next message.
If you do not want to change a message, you can choose Goto → Next message to jump to the next message manually.
6. To return to the message monitor, choose Back.
By saving a message, you release it for sending. This normally means that the message is sent automatically and can therefore no longer be changed.
92 April 2001
SAP AG Process Management (PP-PI-PMA)
Starting Send Jobs for Process Messages
Starting Send Jobs for Process Messages To start the send job for process messages, proceed as follows:
On the overview screen of the message monitor, choose Utilities → Start send job.
The system sends all process messages with the status “to be sent”, “to be resubmitted” or “to be resubmitted with warning” including those that are not contained in the current list.
April 2001 93
Process Management (PP-PI-PMA) SAP AG
Sending Process Messages Online
Sending Process Messages Online To send messages in online mode, proceed as follows:
1. On the overview screen of the message monitor, select the messages that you want to send:
– To select individual messages, click the corresponding check box.
– To select all messages, choose Edit → Selections → Select all.
– To select all messages of a specific message category or status, choose Edit → Selections → Select by cat.... or Edit → Selections → Select by status....
Enter the desired message category or status and choose Continue.
2. Choose Send.
The system sends the selected messages.
If a message cannot be sent due to its status, a corresponding error message is displayed.
94 April 2001
SAP AG Process Management (PP-PI-PMA)
Deleting Individual Process Messages
Deleting Individual Process Messages To delete process messages, proceed as follows:
1. Select the messages that you want to delete:
– To select individual messages, click the corresponding check box.
– To select all messages, choose Edit → Selections → Select all.
– To select all messages of a specific message category or status, choose Edit → Selections → Select by cat.... or Edit → Selections → Select by status....
Enter the desired message category or status and choose Continue.
2. Choose Delete.
A dialog box appears in which you need to confirm that you want to delete the messages.
If a message has not yet been sent successfully, a corresponding warning message will be displayed.
3. Confirm that you want to delete the message.
April 2001 95
Process Management (PP-PI-PMA) SAP AG
Deletion of Process Messages and Message Logs
Deletion of Process Messages and Message Logs Delete Functions
• Manual or automatic deletion of all message data within a specified range. Using this function, you can delete either:
– Messages with their logs, or
– Only message logs
See: Deletion of all Messages/Logs Within a Range [Page 97].
• Manual deletion of individual messages with their logs in the message monitor. See: Deleting Individual Process Messages [Page 95]
For information on how to access the message monitor, see Accessing the Message Monitor [Page 82].
Preventing Unintentional Deletion of Data Using the above functions, you can delete any message independent of its processing status. Unintentional deletion of data relevant to subsequent functions is prevented in the following ways:
• If a message has been sent to the process message record (destination PI01), the long texts and logs created for the message cannot be deleted. This ensures that they are still available for archiving and evaluations after the message has been deleted even though they are not stored in the message record.
• When defining a range of messages to be deleted, you can exclude all messages which have not yet been sent successfully.
• When you delete messages within the monitor, a warning is issued if one of the selected messages has not yet been sent.
You can delete process messages and their logs within process management. The following functions are available for this purpose:
• Note that the message data is only deleted within process management and not in the message destinations.
96 April 2001
SAP AG Process Management (PP-PI-PMA)
Deletion of all Messages/Logs Within a Range
Deletion of all Messages/Logs Within a Range Defining the Data Scope to Be Deleted The data to be deleted with this function can be selected using the following criteria:
• Send date and plant of the messages
• All messages or only those sent successfully
• Only logs or messages and logs
You can define your selection criteria directly when you start the delete function, or you can use selection variants, that is, specific combinations of selection criteria, that you can create and save for repeated use; see Deleting All Messages/Message Logs Within a Range [Page 99].
Starting the Delete Function There are two ways of starting the delete function:
• Automatically at regular time intervals using a background job defined in Customizing:
In this case, the data to be deleted is always selected via the same selection variant which you assign to the background job in Customizing.
For more detailed information on this option, refer to the process management section of the IMG.
• Manually to be carried out at a specific time. You can do this in the following ways:
– In the online mode; see Deleting All Messages/Message Logs Within a Range [Page 99]
– In the background if you want to delete a large amount of data; see Deleting Messages/Message Logs in the Background [Page 100]
In both cases, you can use other selection criteria than those defined in the selection variant for the periodic background job
If the delete function terminates, the resulting inconsistencies and incomplete data records can be eliminated by starting the function again.
Deletion Log When you start the delete function or define a selection variant for deleting messages, you can also specify whether the execution of the function is to be documented in a deletion log.
The deletion log contains information on:
• The messages, message long texts and message logs deleted
• The messages, message texts and message logs that could not be deleted although they are within the specified selection range
• The user who started the delete function
• The processing mode used (dialog or background)
April 2001 97
Process Management (PP-PI-PMA) SAP AG
Deletion of all Messages/Logs Within a Range
• The time when the function was carried out
When you manually start the delete function, the log is displayed automatically after the function has been executed. The logs of previous deletion runs or background jobs can be called up via the menu; see Displaying Deletion Logs [Page 101].
98 April 2001
SAP AG Process Management (PP-PI-PMA)
Deleting All Messages/Message Logs Within a Range
Deleting All Messages/Message Logs Within a Range Selektionsoptionen
To delete all process messages and/or message logs within a specific range, proceed as follows:
1. On the Process Management screen, choose Message → Delete.
The system displays the screen for defining the data scope to be deleted.
2. Enter your selection criteria and specify whether a deletion log is to be created.
If you have predefined your criteria in a selection variant, choose Goto → Variants → Get... and select this variant.
Otherwise, specify your criteria on the selection screen. For the Plant field, you have the following options:
– You can enter a single value or a value range on the selection screen.
– You can use the Multiple selection function to enter more than one single value or value range.
– You can use the Selection options function to exclude the value you have entered from the selection or select all values less than or greater than the single value entered.
If you want to use the same selection criteria again later, you can save them in a selection variant. To do so, choose Goto → Variants → Save as variant.
3. Choose Execute and confirm that you want to delete all data matching the specified selection criteria.
The system deletes the data. If you have specified that a log is to be created, it now displays the deletion log.
4. To display the log messages, select the log and choose Display messages.
If the log contains messages with high and medium priority, the system will display only these.
5. To display all messages in the log, choose View → Display messages → All.
6. To display the long text for a message, position the cursor on the message and choose Goto → Long text.
7. Choose Back to exit the long text and the deletion log.
April 2001 99
Process Management (PP-PI-PMA) SAP AG
Deleting Messages/Message Logs in the Background
Deleting Messages/Message Logs in the Background
1. On the Process Management screen, choose Environment → Current settings.
A list of the Customizing functions offered for maintenance within the application appears.
2. To access documentation on how to define the delete job, double-click Define background delete job.
4. Proceed as described in the documentation, you called up in step 2.
To define a background job for deleting messages and/or message logs, proceed as follows:
3. To define the background job, double-click Execute <object> in the same line.
100 April 2001
SAP AG Process Management (PP-PI-PMA)
Displaying Deletion Logs
Displaying Deletion Logs To display a deletion log, proceed as follows:
1. From the process management menu, choose Message → Deletion Logs.
The initial screen for accessing logs appears.
2. To restrict the number of logs selected, enter:
– A creation period and/or
– The user who started the delete function or created the corresponding background job.
3. Choose Program → Execute.
The system displays a list of the logs matching your selection criteria.
4. To display a log, select it and choose Goto → Display messages.
If the log contains messages with high and medium priority only these are displayed.
5. To display all messages in the log, choose View → Display messages → All.
6. To display the long text for a message, position the cursor on the message and choose Goto → Long text.
7. Choose Back to leave the long text and the deletion log.
April 2001 101
Process Management (PP-PI-PMA) SAP AG
Process Instructions
Process Instructions Use In process instructions, you can use predefined characteristics to define process steps that you want:
To be executed manually by a process operator at a production line •
• To be executed automatically by a process control system
You assign process instructions to the phases of the master recipe and process order.
Prerequisites Process instructions that you assign to a phase in the master recipe and process order must be assigned to a certain process instruction category [Page 106]. You must first have created these process instruction categories in Customizing for Process Management [Ext.]. They serve as a kind of template for the process instruction you use in the master recipe and process order.
Every process instruction category you create in Customizing must itself be assigned to a process instruction type [Page 107].
When defining process instructions, you must decide whether you want a process operator to process them manually or whether they will be processed automatically by a process control system. Depending on where the process instructions will be processed, you can pass on different types of information in them.
• To determine that process instructions are to be processed by a process operator, you define them for the R/3 PI sheet [Page 151]. You can create two different types of PI sheets:
− The browser-based PI sheet [Page 158]
• To determine that process instructions are to be processed automatically in the production area, you define them for process control systems.
Any type of information that can be displayed in the PI sheet. This includes:
− Long texts that you have created for the long text characteristic
Features
− The ABAP list-based PI sheet [Page 154]
You can define the following information in process instructions that are transferred to the R/3 PI sheet:
•
•
•
•
•
•
− Contents of business characteristics, such as the material number, batch, and so on
The order in which the process steps (phases) are to be processed
Input fields to request data that is relevant to production and that the process operator must enter in the PI sheet
Reporting of requested data using one or several process messages
Calculation formulas to calculate values
Function modules to jump from the PI sheet to other R/3 applications
102 April 2001
SAP AG Process Management (PP-PI-PMA)
Process Instructions
For more information, see Process Instructions for the R/3 PI Sheet [Page 180].
You can define the following information in process instructions that are transferred to a process control system:
Material numbers and material quantities that the process control system needs before production can be started
•
• Actual data on material consumption that you want the process control system to report to the R/3 System
For information on how to structure the information in process instructions for process control systems and the R/3 PI sheet, see Process Instruction Structure [Page 110].
Activities When you release the process order, the system automatically performs the following activities:
It combines the process instructions to form control recipes [Page 130]. •
It creates one control recipe for each control recipe destination of a process order. •
• According to your settings for the background job, it transfers the control recipes to the control recipe destinations that need the information to control and regulate the production process.
April 2001 103
Process Management (PP-PI-PMA) SAP AG
Process Instruction
Process Instruction Definition Communication structures that are used to transfer data from the R/3 System (PP-PI) to production control.
In process instructions, you can use predefined characteristics to define process steps that you want:
•
•
To be executed manually by a process operator at a production line
You assign process instructions to the phases of the master recipe and process order.
Structure
• A header
• Characteristics
Example: Structure Overview of a Process Instruction [Page 110]
The header of a process instruction contains general information about the process instruction, such as the process instruction type and process instruction category.
Characteristics
• The type of information transferred or requested, for example, "process order number", "control recipe status" or "control instruction"
• How the requested data should be processed, for example, that a specific value should be provided by process control or which message category should be used to report this value
When you create a process instruction in a master recipe or a process order, the system copies the characteristics that are assigned to the relevant process instruction category in the process instruction. You can then assign further characteristics or delete existing assignments in the process instruction. You can assign as many characteristics to a process instruction as you like. You can assign a characteristic to the same process instruction more than once.
Use
To be executed automatically by a process control system
Process instructions consist of the following elements:
• Characteristic values
Header
In process instructions, characteristics can have two functions. They can be used to specify:
In Customizing for Process Management, you both define process instruction characteristics and assign them to the process instruction category. In the instruction category, you also specify the sequence for the characteristics.
104 April 2001
SAP AG Process Management (PP-PI-PMA)
Process Instruction
How you define the characteristic structure of your process instructions depends on whether you want to use them for PI sheets or process control systems. For more information on the structure of process instructions, see Process Instruction Structure [Page 111].
Characteristic Values You can assign values to process instruction characteristics in Customizing for Process Instruction Categories, in the master recipe, or in the process order:
In the master recipe, you can assign values to characteristics that contain process-specific information, such as the material quantity required for the process or a specific validation rule.
In the process order, you can assign values to characteristics that are only valid for the individual production run, such as the name of the device from which a measured value is to be obtained.
You can define a certain format and value range for a characteristic in Customizing. The value of a process instruction characteristic can be a numeric or alphanumeric key, a short text or a long text, or the name of a message characteristic that is to be processed in a specific way. When the characteristic values are assigned in the recipe or order, the values entered must comply with the defined format and value range.
If you assign a value assignment function or table field to a characteristic, the value of this process instruction characteristic can be assigned automatically in the process order or when you create a control recipe.
For more information see, Automatic Value Assignment to Process Instruction Characteristics [Page 124].
When you release the process order or certain phases, the system combines the process instructions to form control recipes [Page 130]. It creates one control recipe for each control recipe destination of a process order. The system then transfers the control recipes to the control recipe destinations that need the information to control and regulate the production process.
In Customizing, you can assign values to characteristics that contain general information such as the message category of the messages to be sent. If a process instruction of this category is created in the recipe or order, these values are copied into the process instruction.
•
•
•
In the process order, you must assign a value to every characteristic in a process instruction. Otherwise, you cannot create a control recipe.
Integration
April 2001 105
Process Management (PP-PI-PMA) SAP AG
Process Instruction Category
Process Instruction Category
Process instruction categories are standard process instructions that have been predefined in Customizing for Process Management and that usually do not have specific characteristic values assigned. They serve as a kind of template for the process instruction you use in the master recipe and process order.
If you want to create process instructions in the master recipe and process order, you must always enter a process instruction category that has been predefined in Customizing. The characteristics of this process instruction category are copied into the process instruction. You can, however, change or delete the characteristics and assign process-specific values to them. You can thus adjust your process instructions to the specific requirements of your master recipe or process order.
The standard system comprises a number of standard process instruction categories that your can use or copy to define your own process instruction categories. You can create your own process instruction categories in Customizing for Production Planning - Process Industries by choosing Process Management -> Process Instructions -> Define Process Instruction Categories (General) [Ext.].
Use
Definition
In the process instruction category, you define:
The process instruction type [Page 107] to which a process instruction belongs •
The information you want to convey in the process instructions, which means that you assign characteristics, and if required, characteristic values to the process instruction category
•
•
•
Using process instruction categories in the master recipe and process order has the following advantages:
You need to define the structure of similar process instructions only once in a plant.
Only users defining process instruction categories in Customizing need to have a detailed knowledge of the process control systems and the communication formats they require. All other users who create process instructions during process planning can refer to the predefined process instruction categories.
106 April 2001
SAP AG Process Management (PP-PI-PMA)
Process Instruction Type
Process Instruction Type
Definition Process instruction types are keys that have been define in Customizing for Process Management and that you must specify when you create a process instruction category. You use the process instruction type to determine which functions are to be supported in the process instruction category. Depending on whether the process instruction category is defined for the PI sheet or a process control system, you must use the corresponding process instruction type.
Use There are eight different process instruction types. Which type you can use, depends on different criteria.
The type is used to distinguish:
Where the information defined in a process instruction is transferred: •
− To a process control system
− To the ABAP list-based PI sheet [Page 154]
− To the browser-based PI sheet [Page 158]
•
•
Which functions the process instruction is to support (this means, for example, if you want to transfer information to production control or if you want to request information from production control)
Type 1: process parameter [Page 228]
• Type 2: process data request [Page 231]
• Type 3: process message subscription
For examples of process instructions for a process control system, see Process Instruction Structure [Page 111].
For information processing by process control systems, you can use the following process instruction types:
April 2001 107
Process Management (PP-PI-PMA) SAP AG
Process Instruction Type
Process management
Processparameter
Processmessage
subscriptionProcess
data request
Processcontrol
MessagesMessage(s)
Controlinformation
andnotes
Eventsto be
reported
Required actualdata
For information processing using the PI sheet, you can use the following process instruction types:
• Type 0: universal process instruction category [Page 182]
Type 1: process parameter [Page 228] •
Type 2: process data request [Page 231] •
Type 4: process data calculation formulas [Page 267] •
Type 5: inspection results requests [Page 276] •
Type 6: dynamic function calls [Page 277] •
Type 7: sequence definition [Page 300] •
For examples of process instructions for the PI sheet, see Process Instructions for the R/3 PI Sheet [Page 180].
Processcontrol
Dynamicfunction
call
Inspectionresultsrequest
Proc. data calculation
formula
Message
QM Funct. module
Requiredformularesults
Functionto becalled
Operations/phases
requiring inspection
results recording
Process management
Sequencedefinition
Pre-decessor
of superiorphase
108 April 2001
SAP AG Process Management (PP-PI-PMA)
Process Instruction Type
April 2001 109
Process Management (PP-PI-PMA) SAP AG
Example: Structure Overview of a Process Instruction
Example: Structure Overview of a Process Instruction
PPPI_MESSAGE_CATEGORY
PPPI_CONTROL_RECIPE
PPPI_REQUESTED_VALUE
PPPI_REQUESTED_VALUE
PPPI_REQUESTED_VALUE
PI_CRST
100000000000000044
PPPI_CONTROL_RECIPE_STATUS
PPPI_EVENT_TIME
PPPI_EVENT_DATE
Process instruction: cat. CRST, type 2
110 April 2001
SAP AG Process Management (PP-PI-PMA)
Process Instruction Structure
Process Instruction Structure Use Which process instruction types you can use and how you create their characteristic structure depends on the control recipe destination (that is, PI sheet or process control system) that processes them. Process instructions for process operators need to contain different information than process instructions for process control systems, which in turn differ depending on the functionality offered by the control system.
For more information on the type of information you can pass on to a process control system and the R/3 PI sheet using process instructions, see . Process Instructions [Page 102]
Features Process Instructions for Process Control Systems
You can use the following process instruction types:
•
•
•
The following paragraphs describe one possible way of using these process instruction types to control and monitor material consumption in a specific control scenario.
Type 1: process parameter
Type 2: process data request
Type 3: process message subscription
In Customizing for Process Management of the standard system, you will find further examples of the process instruction categories for process control systems. The names of these instruction categories start with A.
Type 1: process parameter Before production starts, the process control system needs information on the materials and the material quantities to be charged. Let us assume that this information is not defined in the process control system. In this case, it can be sent to process control in the form of process parameters. In the process order, you can use automatic assignment of characteristic values to transfer the information about the material contained in the material list to the process parameter.
Example: Process Parameter for a Process Control System [Page 114]
Type 2: process data request or type 3: process message subscription
During production, information on the actual material quantities consumed needs to be reported to process management. In principle, this information can be requested in one of the following ways:
In a single process message subscription for all materials •
• In one process data request for each material
Since the control system needs information about the structure of the message to be sent, your process message subscriptions and process data calculation formulas must contain the category of the message to be sent as well as the names of the characteristics to be contained in the message.
To create the requested process messages, the process control system generally also needs information on a number of characteristic values that are only stored within PP-PI:
April 2001 111
Process Management (PP-PI-PMA) SAP AG
Process Instruction Structure
Values such as order number and control recipe number are independent of the individual material. They can be sent in the process message subscriptions and transferred from there to the process messages.
•
• Values such as operation/phase number or reservation item number differ between materials. This information cannot be provided in a process message subscription. You can nevertheless use a process message subscription, provided that the functionality of your process control system allows you to obtain this data from the process parameter. Otherwise, you need to create a process data request with the relevant information for each individual material.
Example: Process Data Request for a Process Control System [Page 115]
Example: Process Message Subscriptio [Page 116]n
Process Instructions for the R/3 PI Sheet The R/3 PI sheet, is one possible tool that process operators can use to carry out process instructions. The following sections describe which process instruction types you can use for the R/3 PI sheet and how you must structure the process instructions.
How much you need to know about the characteristic structure of the individual process instruction types depends on the function you use to create and change your process instructions (see Manual Process Instruction Maintenance [Page 120] ):
If you use the process instruction assistant, you will be guided through process instruction definition by specific prompts. The characteristic structure is created by the system.
Note that at present you cannot use the process instruction assistant to define process instructions of Type 0: Universal process instruction category.
•
If you maintain your process instructions on the characteristic overview, you must create the characteristic structure yourself.
•
In Customizing for Process Management of the standard system, you will find examples of process instruction categories of all types described here.
For more detailed information about the process instruction types that you can use for the R/3 PI sheet, see Process Instructions for R/3 PI Sheets [Page 180].
Type 0: Universal Process Instruction Category [Page 182] •
Type 1: Process Parameters for PI Sheets [Page 228] •
Type 2: Process Data Requests for PI Sheets [Page 231] •
Type 4: Process Data Calculation Formulas [Page 267] •
Type 5: Inspection Results Requests [Page 276] •
Type 6: Dynamic Function Calls [Page 277] •
Type 7: Sequence Definition [Ext.] •
112 April 2001
SAP AG Process Management (PP-PI-PMA)
Process Instruction Structure
April 2001 113
Process Management (PP-PI-PMA) SAP AG
Example: Process Parameter for Process Control System
Example: Process Parameter for Process Control System
A = value can be assigned automatically in the process order
Proc. instr. characteristics Characteristic values
0060
Hydrochloric acid
300-140A
A
1000A
1010A
2.300,00A
kgA
PPPI_MATERIAL
PPPI_MATERIAL_ITEM
PPPI_MATERIAL_SHORT_TEXT
PPPI_PHASE
PPPI_MATERIAL_QUANTITY
PPPI_UNIT_OF_MEASURE
PPPI_OPERATION
Process instructionsProcess instructions AMAT AMAT_1, _1, typetype 1 1
114 April 2001
SAP AG Process Management (PP-PI-PMA)
Example: Process Data Request for Process Control System
Example: Process Data Request for Process Control System
A = value can be assigned automatically in the process order
Proc. instr. characteristics Characteristic values
PPPI_MESSAGE_CATEGORY
PPPI_PROCESS_ORDER
PPPI_DATA_POINT_NAME
PPPI_REQUESTED_VALUE
PPPI_REQUESTED_VALUE
PPPI_REQUESTED_VALUE
PPPI_DATA_REQUEST_TYPE
PPPI_OPERATION
PPPI_PHASE
PPPI_UNIT_OF_MEASURE
Process instruction,Process instruction, cat.cat. AREAD1AREAD1, , typetype 2 2
DPREAD
Y-300/PCS1
DENSITY_READ
PPPI_EVENT_DATE
PPPI_EVENT_TIME
PPPI_DATA_POINT_VALUE
A
Simple data request
1000A
1030A
kg/m3
April 2001 115
Process Management (PP-PI-PMA) SAP AG
Example: Process Message Subscription
Example: Process Message Subscription
Proc. instr. characteristics Characteristic values
PPPI_OPERATION
PPPI_PHASE
PPPI_EVENT_DATE
PPPI_EVENT_TIME
PPPI_MATERIAL
PI_CONS
PPPI_UNIT_OF_MEASURE
PPPI_MATERIAL_CONSUMED
A Y-300/PCS1
A = value can be assigned automatically in the process order
Process instruction,Process instruction, cat.cat. ACONSACONS_1, _1, typetype 3 3
PPPI_PROCESS_ORDER
PPPI_REQUESTED_VALUE
PPPI_REQUESTED_VALUE
PPPI_REQUESTED_VALUE
PPPI_REQUESTED_VALUE
PPPI_REQUESTED_VALUE
PPPI_MESSAGE_CATEGORY
PPPI_REQUESTED_VALUE
PPPI_REQUESTED_VALUE
116 April 2001
SAP AG Process Management (PP-PI-PMA)
Process Instruction Maintenance
Process Instruction Maintenance Purpose This process describes how you create and maintain process instructions during production planning. In this way, you define the information that is combined in control recipes and sent to process control when you have released the process order.
Prerequisites The following settings have been made in Customizing for Process Management:
• Process instruction categories defining the function and contents of your process instructions (that is, the process instruction type and characteristics) have been maintained.
In Customizing, you define the following for a data request:
– The number of messages you want to create for it and the message category to which these messages belong
– The characteristics of the message category you want to transfer to the message
– Where and how characteristic value assignments takes place (for example, in the process instruction or in the PI sheet)
• An appropriate value assignment function or table field has been allocated to those process instruction characteristics whose value is to be assigned automatically when you create the control recipe.
• The process instruction categories of the process instructions that are required in all control recipes and are therefore to be generated automatically when the control recipe is created have been assigned to your control recipe destinations.
Process Flow 1. In the master recipe, you create the process instructions that are not generated
automatically.
When creating process instructions, you refer to a process instruction category. The process instruction automatically obtain the same type as the process instruction category to which it refers. All other data, that is, characteristics and characteristic values, is copied to the process instruction and can still be changed.
2. You adjust the copied data to meet the requirements of the corresponding processing step. You can change or delete existing characteristics, or add new ones.
In a data request, you add:
– The values of those message characteristics that are not assigned automatically in the process order or PI sheet known to you
– The text for the input request and, if you use them, input validations
April 2001 117
Process Management (PP-PI-PMA) SAP AG
Process Instruction Maintenance
If you do not want to use all message characteristics, you delete the ones you do not need.
3. You create a process order with reference to a specific master recipe.
When copying the recipe data, the system also copies the process instructions to the process order. If required, you can add more process instructions in the order.
4. You add information to the process instruction to meet the special requirements of the process order.
In a data request that you use to report a measurement reading, you enter the name of the measuring device connected to the resource you have selected.
By now, a value must have been assigned to all process instruction characteristics whose value is not assigned automatically when the control recipe is created.
If you want, you can start characteristic value assignment in the order to check and, if necessary, change the values assigned automatically.
5. When the process instructions and other order data are complete, you release the process order.
6. You create the control recipes for the order. The system completes the process instructions as follows:
– It generates the process instructions defined in the control recipe destination and adds them to the process order and control recipe.
Characteristics whose values depend on the scope of generation have their values assigned directly.
If you specify that a process instruction containing the most important material data is generated for each reservation item, the characteristic value for the reservation item is assigned automatically.
– It assigns a value to those characteristics to which a function or table field for automatic value assignment has been allocated in Customizing, provided that a value has not yet been assigned manually.
Maintenance of Process Instruction Categories - Overview
118 April 2001
SAP AG Process Management (PP-PI-PMA)
Process Instruction Maintenance
CustomizingCustomizingProcess instruction categories
Control recipe destinations & process instructions to be generated for them
Characteristics along with their functions and tables for value assignment
Process orderProcess order
PhasenPhasenPhasesPhases
EmpfängerEmpfängerDestinations
ProzVorgProzVorgProc.instr.
VorgängeVorgängeOperationsOperations
Master recipeMaster recipe
PhasenPhasenPhasesPhases
EmpfängerEmpfängerDestinations
ProzVorgProzVorgProc.instr.
VorgängeVorgängeOperationsOperations
CopyCopyCopyCopyCopyCopyGenerateGenerate
Manually create and assign characteristic
values
Manually create and assign characteristic
values
Automatically create and assign characteristic
values
Automatically create andAutomatically create and assign characteristic assign characteristic
valuesvalues
ControlControlreciperecipe
April 2001 119
Process Management (PP-PI-PMA) SAP AG
Manual Process Instruction Maintenance
Manual Process Instruction Maintenance Use Using this function, you create process instructions manually if they contain process-specific data that cannot be transferred to the process instruction automatically.
The measurement readings to be recorded when a process order is executed vary from process to process. Since no information on this is maintained elsewhere in the process order, you must create the process instructions for the relevant phase manually.
Prerequisites The following settings have been made in Customizing for Process Management:
• Process instruction categories defining the function and contents of your process instructions (that is, the process instruction type and characteristics) have been maintained.
• An appropriate value assignment function or table field has been allocated to those process instruction characteristics whose value is to be assigned automatically when the control recipe is created.
Features You can use the following functions to maintain process instructions in the master recipe or process order:
• Maintaining process instructions on the characteristic overview
Using this function, you can maintain all process instructions. On the characteristic overview, you can:
− Delete and add characteristics
− Enter and change characteristic values
The characteristic structure required for your process instructions depends on the requirements of your process control systems. For information on designing process instructions, see Process Instruction Structure [Page 111].
A value can be assigned automatically to some characteristics when you create the control recipe. A special indicator is set for these characteristics on the characteristic overview. For more information, see Process Instructions: Automatic Characteristic Value Assignment [Page 124].
• Maintaining process instructions using the PI assistant Using this function, you can maintain process instructions for the R/3 PI sheet. The process instruction assistant (PI assistant) offer specific selection screens and prompts for every process instruction type, guiding you through process instruction definition.
120 April 2001
SAP AG Process Management (PP-PI-PMA)
Manual Process Instruction Maintenance
The entries in the process instruction assistant focus on content and do not require any knowledge of process instruction characteristics and how they are used. The system creates the characteristic structure of the process instruction when you exit the assistant.
See also: For process instruction maintenance in the master recipe:
• Maintaining Process Instructions on the Characteristic Overview [Ext.]
• Maintaining Process Instructions Using the Process Instruction Assistant [Ext.]
For process instruction maintenance in the process order:
• Changing Process Instructions [Ext.]
• Assigning Values to Process Instruction Characteristics [Ext.]
April 2001 121
Process Management (PP-PI-PMA) SAP AG
Automatic Process Instruction Creation
Automatic Process Instruction Creation Use You use this function to create process instructions if:
• The process instructions are required in all control recipes for a control recipe destination
• Process-specific data can be copied automatically to the generated process instructions
In control recipes for a specific destination, you want to transfer information on the allocated material components for each phase. The material components are defined in the material list of the process order. For this reason, the system can generate the corresponding process instructions and automatically enter the individual material data.
Prerequisites The following settings have been made in Customizing for Process Management:
• An appropriate value assignment function or table field has been allocated to those process instruction characteristics whose value is to be assigned automatically when the control recipe is created.
• Process instruction categories have been allocated to your control recipe destinations and process instructions are generated for them when you create the control recipe. In addition, the following information is also maintained for each process instruction category you allocated:
− The position at which the process instructions are inserted (for example, at the beginning or end of the control recipe, operations, or phases)
− The scope of generation to be used for the process instructions (for example, one process instruction per phase, reservation item, or inspection characteristic)
Features You can generate the process instructions defined in the control recipe destination as follows:
• When creating a control recipe
In this case, the system triggers process instruction generation automatically. It inserts the generated process instructions at the corresponding positions in the process order and control recipe.
You can only create the control recipe if a value has already been assigned to the process instruction characteristics in Customizing or if the value is assigned automatically. Otherwise, the process instructions are only copied to the process order where you must assign the missing values manually.
For information on automatic characteristic value assignment, see Process Instructions: Automatic Characteristic Value Assignment [Page 124].
122 April 2001
SAP AG Process Management (PP-PI-PMA)
Automatic Process Instruction Creation
• When maintaining the characteristic overview in the process order If you want to check and, if necessary, change the generated process instructions before you create the control recipe, you can manually start process instruction generation in the process order. The system inserts the generated process instructions in the process order where you can maintain them as follows:
− You can assign values to characteristics or change characteristic values.
− You can delete individual process instructions.
The system does not generates the process instructions again when you create the control recipe unless you have deleted all generated process instruction.
The following numbers are assigned to generated process instructions:
• 0000 if they are inserted at the beginning of a phase
• 9999 if they are inserted at the end of a phase
April 2001 123
Process Management (PP-PI-PMA) SAP AG
Automatic Value Assignment to Process Instruction Characteristics
Automatic Value Assignment to Process Instruction Characteristics Use You can use this function to transfer data maintained elsewhere in the system to your process instructions.
Using automatic characteristic value assignment, you can copy the long text maintained for a phase or the material data maintained in the material list to your process instruction.
If you want the system to generate process instructions when you create a control recipe, a value must be assigned automatically to all characteristics whose value has not yet been assigned in Customizing. Otherwise, you cannot create the control recipe.
Prerequisites There are two ways of automatic characteristic value assignment:
• Automatic value assignment during process instruction generation
You can assign values in this way if the characteristic has been defined for it in the standard system (see below).
• Automatic value assignment during control recipe creation
You can assign values in this way if a value assignment function or table field has been assigned to the characteristic in Customizing.
Features Automatic Value Assignment During Generation You can only use this type of value assignment for specific standard characteristics. It depends on the scope of generation (see table below).
If you have selected the scope of generation For all reservation items, the item for which the corresponding process instruction has been generated is assigned to characteristic PPPI_RESERVATION_ITEM (reservation item).
124 April 2001
SAP AG Process Management (PP-PI-PMA)
Automatic Value Assignment to Process Instruction Characteristics
Characteristic Value Assignment and Scope of Generation - Dependencies
Scope of Generation Characteristics with Automatic Value Assignment
For all reservation items and order items
PPPI_MATERIAL_ITEM PPPI_RESERVATION_ITEM
For all reservations PPPI_BATCH PPPI_MATERIAL (Material number) PPPI_MATERIAL_CO_PRODUCT (Co-product indicator) PPPI_MATERIAL_CONSUMED (Quantity of material consumed) PPPI_MATERIAL_ITEM PPPI_RESERVATION_ITEM PPPI_MATERIAL_PRODUCED (Quantity of material produced) PPPI_MATERIAL_QUANTITY PPPI_MATERIAL_SHORT_TEXT PPPI_STORAGE_LOCATION
For all order items PPPI_ORDER_ITEM_NUMBER (order item)
For all inspection characteristics PPPI_INSPECTION_CHARACTERISTIC
For all predecessors PPPI_PREDECESSOR
For all variable activities of phases PPPI_STD_VALUE_PARAMETER_ID (Parameter ID of the standard value)
Automatic Value Assignment During Control Recipe Creation When you create a control recipe, this type of value assignment is used for characteristics for which the corresponding Customizing settings have been made (see Prerequisites) and whose values have not yet been assigned.
If you want to check and, if necessary, correct the values determined automatically before you create the control recipe, you can also start value assignment manually in the process order. Note, however, that the characteristic values are not automatically updated when you later change the relevant object (for example, the material list for material characteristics).
The standard system contains a number of characteristics to which a value assignment function has been assigned. In these functions, the characteristic value is often determined according to values of other characteristics assigned to the same process instruction. The sections below give an overview of these dependencies.
The A indicator (automatic value assignment) is set in the characteristic overview of the process instructions for characteristics whose value is assigned automatically when you create the control recipe. For information on the value assignment logic for standard characteristics whose value is assigned using a function, see the field help for this indicator.
April 2001 125
Process Management (PP-PI-PMA) SAP AG
Automatic Value Assignment to Process Instruction Characteristics
Assigning Values to Material Characteristics - Dependencies
Characteristic to be assigned value
PPPI_MATERIALPPPI_MATERIAL_SHORT_TEXTPPPI_MATERIAL_CONSUMEDPPPI_MATERIAL_PRODUCEDPPPI_MATERIAL_QUANTITYPPPI_BATCHPPPI_STORAGE_LOCATION
Reference characteristic
PPPI_MATERIAL_ITEMPPPI_RESERVATION_ITEMPPPI_ORDER_ITEM
In automatic characteristic value assignment, material data is determined as follows:
• For the relevant material component, if the characteristic for the item number of the material components (PPPI_MATERIAL_ITEM) is contained in the process instruction
• For the relevant reservation item, if the characteristic for the reservation item (PPPI_RESERVATION_ITEM) is contained in the process instruction
• For the relevant material component, if the characteristic for the order item (PPPI_ORDER_ITEM) is contained in the process instruction
• For the header material in all other cases
If you use batch determination, note the following:
• For the system to be able to determine the batch single record, we recommend using the characteristic PPPI_RESERVATION_ITEM in the process instruction. Characteristic PPPI_MATERIAL_ITEM is not unique since there may be several batches for one material item.
• To ensure the correct value assignment of all characteristics, always use process instruction generation if you use batch determination.
Assigning Values to the Unit of Measurement - Dependencies
Characteristic to be assigned value Reference characteristic
PPPI_UNIT_OF_MEASURE Preceding characteristic to which quantity has been assigned automatically
A value is only assigned to the unit of measurement automatically if a quantity has been determined automatically in the same process instruction before.
126 April 2001
SAP AG Process Management (PP-PI-PMA)
Automatic Value Assignment to Process Instruction Characteristics
The unit of measurement of the material quantity is automatically assigned to the characteristic if a value has been automatically assigned before to one of the following characteristics in the process instructions:
• PPPI_MATERIAL_QUANTITY
• PPPI_MATERIAL_CONSUMED (quantity of material consumed)
• PPPI_MATERIAL_PRODUCED (quantity of material produced)
Assigning Values to Activity Characteristics - Dependencies
Characteristic to be assigned value Reference characteristic
PPPI_ACTIVITYPPPI_STANDARD_VALUE_TEXT PPPI_STD_VALUE_PARAMETER
A value is only assigned automatically to characteristics for variable activities if a value has been assigned to the characteristic for the corresponding parameter ID of the standard value (PPPI_STD_VALUE_PARAMETER) in the process instruction.
Assigning Values to Resource Characteristics - Dependencies
Characteristic to be assigned value Reference characteristic
Characteristic for which the followingvalue assignment function is used:COAV_RESOURCE_CHARACTERISTIC
Classification characteristic that:- Has the same name or- Has been assigned as the value to the preceding PI characteristic
Using the value assignment function COAV_RESOURCE_CHARACTERISTIC, you can copy characteristic values that have been entered during resource classification to your process instruction characteristic. One of the following requirements must be met:
• The name of the process instruction characteristic is identical to that of the classification characteristic.
• The name of the classification characteristic has been assigned as a value to the immediately preceding process instruction characteristic.
Grouping Input Values - Dependencies
Characteristic to be assigned value Reference characteristic
PPPI_INPUT_GROUPPreceding characteristic:PPPI_INSPECTION_CHARACTERISTICPPPI_MATERIAL
April 2001 127
Process Management (PP-PI-PMA) SAP AG
Automatic Value Assignment to Process Instruction Characteristics
A value is only assigned automatically to the characteristic for grouping input values if the following requirements are met:
• If the item number of an inspection characteristic (PPPI_INSPECTION_CHARACTERISTIC) is contained in the process instruction, the description of the inspection characteristic is assigned to the characteristic for grouping input values.
• If the material number (PPPI_MATERIAL) is contained in the process instruction, the material number is assigned to the characteristic for grouping input values.
128 April 2001
SAP AG Process Management (PP-PI-PMA)
Process Instruction Download
Process Instruction Download When a process order is to be executed, you can create control recipes containing the process instructions of the process order which are needed by the individual control systems. The control recipes are then transferred to the corresponding control address for processing.
For detailed information on the creation and downloading of control recipes, see Creation of Control Recipes [Page 136] and Control Recipe Download [Page 137].
April 2001 129
Process Management (PP-PI-PMA) SAP AG
Control Recipes
Control Recipes Purpose Using control recipes, you transfer control data from the process order to process control. The information contained in a control recipe and the destination to which it is sent are user-defined.
Implementation Considerations Install this component in process manufacturing companies.
Features Control recipes can be used in both automated and manually operated plants. Different types of control recipe destinations [Page 132] are available for this.
In automated plants, you must use the PI-PCS interface [Ext.] to send control recipes to the process control system (control recipe download). This means that your process control systems must be able to communicate with the SAP System through this interface. The control recipe download can be initiated by the R/3 System or the external system.
•
In manually operated plants, you send your control recipes to the R/3 PI sheet. You can choose between the ABAP list-based PI sheet [Page 154] and the browser-based PI sheet [Page 158].
•
You define the content of control recipes by assigning process instructions [Page 102] to the phases of your master recipe or process order.
Depending on the definitions in the process instructions, the following data is transferred in control recipes:
Process and control parameters •
•
•
Information about process messages that are to be returned to PP-PI
Instructions for the process operator as texts in partially automated or manually operated plants
After a process order has been released, the process instructions are combined in control recipes and transferred to process control to be carried out.
All control recipes to be sent are first checked by process management and sent to the corresponding destinations only if the checks were successful. See: Sending of Control Recipes [Page 137]
When the control recipes have been sent, you can monitor the processing status of individual recipes in the control recipe monitor. See: Monitoring of Control Recipes [Page 139]
130 April 2001
SAP AG Process Management (PP-PI-PMA)
Control Recipes
Process managementProcess management Process controlProcess controlProcess orderProcess order
PhasesPhases
Destination
HeaderHeader
ProcessProcessinstructionsinstructions
Operations
Phases
PI sheet
Process controlsystems
Controlrecipes
April 2001 131
Process Management (PP-PI-PMA) SAP AG
Control Recipe Destination
Control Recipe Destination Definition Process control system, process operator, or group of process operators that receive and execute control recipes
Use You define control recipe destinations in Customizing for Process Management by choosing Control Recipes/PI Sheets -> Define and Set Up Control Recipe Destinations [Ext.].
When creating a phase in a master recipe or process order, you assign a control recipe destination to the phase (see Assignment of Control Recipe Destinations [Ext.]).
During order processing, you create one control recipe for each control recipe destination in a process order. In the control recipe, you transfer the process instructions of all phases assigned to the corresponding destination.
Structure A control recipe destination contains the following data (see graphic below):
The destination type that specifies: •
•
•
− Type 1: Transfer to R/3 ABAP list-based PI sheet The control recipe destination is an operating group for the R/3 PI sheet that is displayed as an ABAP list on the screen.
− Type 2: Download to external system, initiated by R/3 process management The control recipe destination is an external system. The control recipe transfer to the external system is to be initiated by the R/3 System.
− Type 3: Download to external system, initiated by process control The control recipe destination is an external system. The control recipe transfer to the external system is to be initiated by the external system.
− Type 4: Transfer to R/3 browser-based PI sheet The control recipe destination is an operating group for the R/3 PI sheet that is displayed in HTML layout on the screen.
The destination address
In destinations for processing R/3 PI sheets, details on:
− The number of phases that are displayed at the same time
− Whether a password or a digital signature [Ext.] is required when a signature is executed
For external systems, the process instruction categories that are suitable for the corresponding system
•
•
•
Details on the sequence in which material-related process instructions are generated in the process order
Details on the process instructions that are automatically generated when the control recipe is created
132 April 2001
SAP AG Process Management (PP-PI-PMA)
Control Recipe Destination
Control recipe destination
Automatically generated process instructions
Download to external system
Transfer to R/3 ABAP list based PI sheet
Initiated by R/3 process managementInitiated by process control
Assignment ofinstr. categories Process instruction categories for certain PCS (input help)
Phasesdisplayed Number of phases displayed at the same time (peformance)
Address Operating group
RFC destination of the process control system
Signature
Digital signatureUser name, password (different to logon password)
Checks
Transfer to R/3 browser-based PI sheet
Type 2
Type 3
Type 4
Type 1
April 2001 133
Process Management (PP-PI-PMA) SAP AG
Control Recipe Status
Control Recipe Status Use Every control recipe has a status that documents its current processing status. In the control recipe monitor, you can obtain information on the control recipe status at any time; see Displaying of Control Recipe Lists [Page 140].
For more detailed information on the errors that have occurred, refer to the control recipe log; see Control Recipe Logs [Page 143].
Features The following control recipe statuses exist:
Status Meaning
Created The control recipe was created but has not yet been sent to its destination.
This status is also assigned to a control recipe if it could not be sent due to an error. In this case, however, the corresponding entry is highlighted in red in the monitor.
Downloaded The control recipe has been sent to its destination.
Discarded The control recipe cannot be executed. For this reason, processing is terminated before the execution is started.
Terminated The control recipe is terminated after the start of its execution.
Processed The execution of the control recipe has been completed.
Control recipes for external systems are set to Downloaded as soon as they have been transferred to the corresponding transactional remote function call (tRFC). For information on the execution of the tRFC, see the tRFC Log [Page 143].
How do you Update the Control Recipe Status? During control recipe processing, you update the control recipe status as follows:
• Automatically when creating or sending a control recipe
When you carry out these functions, the system sets the corresponding control recipe statuses to Created or Downloaded.
• By creating a corresponding process message
This is necessary if you want to set the status of control recipes for process control systems to Discarded, Terminated, or Processed.
Process Message Creation [Page 70]
• By setting the corresponding PI sheet to Complete or Technically complete
134 April 2001
SAP AG Process Management (PP-PI-PMA)
Control Recipe Status
You thus set the status of control recipes that are processed as R/3 PI sheets to Discarded, Terminated, or Processed. The corresponding status message is created internally by the system.
Setting the PI Sheet Status to “Complete” [Page 390]
Completing of Browser-Based PI Sheets [Page 178]
Setting the PI Sheet Status to “Technically Complete” [Page 400]
Integration to the Process Order If you use the status messages defined in the standard system to update the control recipe status, the system automatically updates the corresponding order status, too.
Deletion of Process Messages and Message Logs [Page 96]
April 2001 135
Process Management (PP-PI-PMA) SAP AG
Creation of Control Recipes
Creation of Control Recipes Control recipes are created in the process order. You can create control recipes for
• the entire process order
• individual destinations assigned to the process order
The system always combines the process instructions of all phases assigned to a destination in one control recipe. A control recipe can only be created if all the phases assigned to the respective destination have been released for production.
You can create test control recipes to check the definition of your process instructions. Control recipes for test purposes can be downloaded and processed in the same way as productive control recipes. However, all process messages for test control recipes are automatically are marked as test messages.
136 April 2001
SAP AG Process Management (PP-PI-PMA)
Control Recipe Download
Control Recipe Download Use After a control recipe has been created, it is downloaded to the destination assigned to the corresponding phases of the process order. This section describes
• how the download of a control recipe can be started
• how the control recipe is transferred to its destination
Features Starting the Download The function for downloading a control recipe can be started in the following ways:
• automatically via a background job defined in Customizing
The download job selects all control recipes that have not yet been downloaded according to their status. Depending on your Customizing settings, it is started either
- in regular time intervals or
- whenever a new control recipe has been created
All control recipes that can be processed without error are downloaded via this function after they have been created.
• manually within the control recipe monitor
You need this option
- if you have not defined the background job for downloading in Customizing
- if an error occurred during the download of a control recipe and there are no new control recipes to trigger your background job
If you want to download all control recipes with the status “created”, you can manually start the background job: see Starting Download Job for Control Recipes [Page 147]. However, this is only possible if the send job defined in Customizing is triggered by the event “New control recipe” (SAP_NEW_CONTROL_RECIPES).
Alternatively, you can select individual control recipes and send them online: see Downloading Control Recipes Online [Page 148].
For information on how to access the control recipe monitor, see Accessing the Control Recipe Monitor [Page 141].
Transfer of the Data The transfer of the control recipes to external systems is carried out via transactional remote function call (tRFC) as program-to-program communication. The tRFC ensures that each call is carried out only once. The sequence of the calls is not changed. If the target system is not active when the call takes place, the tRFC is repeated according to a repetition rate or duration that can be defined by the user.
The execution of a tRFC is documented in a log which you can access from the control recipe monitor: see Displaying Transactional RFC Log [Page 145].
April 2001 137
Process Management (PP-PI-PMA) SAP AG
Control Recipe Download
For information on how to access the control recipe monitor, see Accessing the Control Recipe Monitor [Page 141].
For technical details on the transfer of control recipe data and tRFCs, refer to the documents PI-PCS Interface and to the document BC Remote Communications. You can access these documents via the Further Reading menu.
138 April 2001
SAP AG Process Management (PP-PI-PMA)
Control Recipe Monitoring
Control Recipe Monitoring Use The control recipe monitor is a tool which enables you to display all control recipes and check their processing status.
Using the control recipe monitor, you can obtain the following information:
• an overview of existing control recipes with general information on their processing status
• detailed logs documenting the processing of individual control recipes
Based on this information, you can then carry out the following actions:
• send control recipes
• delete control recipes
Send
Ctrl rec. Proc.order Adr. Status Test CreatedControl Recipe Monitor
100000003110000000451000000045100000002210000000351000000035
ANLF 1PLS 1PLS 3ANLF 7ANLF 1PLS 5
ProcessedSentTerminatedSentCreatedDiscarded
09/11/199409/15/199409/15/199409/18/199409/21/199409/21/1994
100000074100000075100000077100000078100000081100000083
Log
System messages:
tRFC Log
System messages:
Displaying of Control Recipe Lists [Page 140]
Control Recipe Logs [Page 143]
Control Recipe Download from Monitor [Page 146]
Control Recipe Deletion [Page 149]
April 2001 139
Process Management (PP-PI-PMA) SAP AG
Displaying of Control Recipe Lists
Displaying of Control Recipe Lists Use You can display lists of control recipes on the overview screen of the control recipe monitor: see Accessing the Control Recipe Monitor [Page 141].
These lists can also be printed: see Printing Lists of Control Recipes [Page 142].
Features All control recipes created in your system can be displayed in the monitor. You can reduce the scope of the list using the following selection criteria:
• maintenance data of the control recipe, such as creation time
• the process order from which the control recipe was created as well as the key and address of the control recipe destination to which it is to be downloaded
• the processing status of the control recipe
• an indicator for productive control recipes or test recipes
In the monitor, all control recipes are displayed with their creation time, process order, control address and status. The control recipes are highlighted using different colors according to their status so that you can spot quickly those where an error occurred.
For detailed information on the control recipe status, refer to section Control Recipe Status [Page 134].
You can obtain detailed information on the errors which have occurred by calling up the control recipe log; see Control Recipe Logs [Page 143].
Control recipes for external systems are set to downloaded as soon as they have been transferred to the corresponding tRFC (transactional remote function call). For information on the execution of the tRFC, you need to refer to the tRFC log [Page 143].
140 April 2001
SAP AG Process Management (PP-PI-PMA)
Accessing the Control Recipe Monitor
Accessing the Control Recipe Monitor To display lists of control recipes in the control recipe monitor, proceed as follows:
1. On the Process Management screen, choose Control recipe → Control recipe monitor.
The initial screen of the control recipe monitor appears.
2. Enter selection criteria to restrict the number of control recipes displayed, and choose Enter.
The overview screen of the control recipe monitor appears.
Control recipes may be created or the status of existing control recipes may change after you have accessed the monitor. These changes are not automatically updated in the monitor. Choose Refresh to display the current data without exiting the control recipe monitor.
April 2001 141
Process Management (PP-PI-PMA) SAP AG
Printing Lists of Control Recipes
Printing Lists of Control Recipes To print the list of control recipes displayed in the control recipe monitor, proceed as follows:
1. On the overview screen of the control recipe monitor, select the menu options Control recipes → Print.
The system branches to the screen Print Screen List.
2. Enter the print parameters.
3. Press the pushbutton Print.
142 April 2001
SAP AG Process Management (PP-PI-PMA)
Control Recipe Logs
Control Recipe Logs Use You can display two types of logs for a control recipe in the control recipe monitor:
• a control recipe log which documents the processing of the control recipe within process management: see Displaying Control Recipe Log [Page 144].
• the tRFC log which documents the execution of the tRFC (transactional remote function call) used to transfer a control recipe to an external system: see Displaying Transactional RFC Log [Page 145].
For information on how to access the control recipe monitor, see Accessing the Control Recipe Monitor [Page 141].
Features Transactional RFC Log If a control recipe is downloaded to an external function, the system documents the execution of the corresponding tRFCs in a tRFC log. The tRFC log documents all tRFCs carried out in your system. It provides information on
• the processing status of the RFC
• system messages returned by the external system when it receives the control recipe data
When calling up the tRFC log within the control recipe monitor, you can select the log entries to be displayed using the following criteria:
• the time when a tRFC was carried out
• the user who started the tRFC, that is, the user who created the download job or downloaded the control recipe online
The individual entries in the log can be identified using a number of additional criteria which you can find in the log of the control recipe. The subsequent table lists the names of these fields in the tRFC logs together with the corresponding fields in the control recipe log:
Field name in tRFC log Field name in message log
Caller User
Target system Address
Transaction ID Computer ID Process ID Time stamp Transaction ID
Tctn Tcod
Program Program
April 2001 143
Process Management (PP-PI-PMA) SAP AG
Displaying Control Recipe Logs
Displaying Control Recipe Logs To display the logs for a control recipe, proceed as follows:
1. On the overview screen of the control recipe monitor, select the control recipes for which you want to display the logs:
− To display individual control recipes, select the relevant control recipes.
− To select all control recipes, choose .
− To select all control recipes of a specific status, choose Edit → Selections → Select by status.
Select the status you want to display and choose .
2. Choose Log.
The initial screen for displaying logs appears. The initial screen comprises two areas. One area shows the logs in an overview tree. The other area displays a list (ABAP List Viewer) with the messages for the log you have selected.
3. Expand the node of the relevant log in the tree.
The different problem classes in which the messages are grouped together appear.
4. Double-click the problem class you want to display.
The list of messages appears in the second screen area. The icon in the LTxt column indicates the messages for which a long text exists.
5. To display the long text, click with the quick info Long text exists.
6. To return to the overview of the log messages, choose .
7. To branch to the next log you have selected, repeat steps 3 to 5.
8. To display the logs for the next control recipe, choose . To return to the overview screen of the control recipe monitor, choose twice.
− If you have selected more than one control recipe, the system will ask whether you want to display the log for the next control recipe.
If you want to display the log, choose Yes.
The initial screen for displaying logs appears. From here, you can repeat steps 3 to 5 for the next control recipe.
− If you have displayed the log for the last control recipe selected, the system will take you directly to the overview screen of the monitor.
For more information on how to display logs, see the documentation on Application Logs [Ext.], section Displaying Logs [Ext.].
144 April 2001
SAP AG Process Management (PP-PI-PMA)
Displaying Transactional RFC Log
Displaying Transactional RFC Log To display the tRFC log for a control recipe proceed as follows:
1. On the overview screen of the control recipe monitor, select the menu options Environment → Log for tRFC.
The system branches to the initial screen for displaying the tRFC log.
2. Enter the display period and the name of the user (sender) for whom you want to display log entries.
3. Choose the function Execute.
The system displays the log entries matching your selection.
April 2001 145
Process Management (PP-PI-PMA) SAP AG
Control Recipe Download from Monitor
Control Recipe Download from Monitor If a control recipe has not yet been downloaded, you can download it from the monitor using one of the following functions:
• if you want to download all control recipes, by starting the corresponding background job; see Starting Download Job for Control Recipes [Page 147].
This is only possible if the send job defined in Customizing is triggered by the event “New control recipe” (SAP_NEW_CONTROL_RECIPES).
• if you only want to download individual control recipes, via online downloading; see Downloading Control Recipes Online [Page 148].
Normally, control recipes are automatically downloaded in the background after they have been created (see Control Recipe Download [Page 137]). You need the above functions
• if you have not defined the background job for downloading in Customizing
• if an error occurred during the download of a control recipe and there are no new control recipes to trigger your background job
146 April 2001
SAP AG Process Management (PP-PI-PMA)
Starting Download Job for Control Recipes
Starting Download Job for Control Recipes To start the download job for control recipes, proceed as follows:
• On the overview screen of the control recipe monitor, select the menu options Utilities → Start send job.
• The system sends all control recipes with the status “created” including those that are not contained in the current list.
April 2001 147
Process Management (PP-PI-PMA) SAP AG
Downloading Control Recipes Online
Downloading Control Recipes Online To download control recipes in the online mode, proceed as follows:
1. On the overview screen of the control recipe monitor, select the control recipes that you want to download:
– To select individual control recipes, click on the corresponding check box.
– To select all control recipes, choose the menu options Edit → Selections → Select all.
– To select all control recipes of a specific status, select the menu options Edit → Selections → Select by status....
Enter the desired status and press the pushbutton Continue.
2. Press the pushbutton Send.
The system downloads the selected control recipes.
If a control recipe cannot be downloaded due to its status, a corresponding error message is displayed.
148 April 2001
SAP AG Process Management (PP-PI-PMA)
Control Recipe Deletion
Control Recipe Deletion You can delete control recipes within the control recipe monitor: see Deleting Control Recipe [Page 150].
Only the control recipe data within process management is deleted. Since the same data is contained in and archived along with the process order, archiving is not affected by the delete function.
If a control recipe has not yet been downloaded successfully, a corresponding warning is issued before it is deleted.
April 2001 149
Process Management (PP-PI-PMA) SAP AG
Deleting Control Recipe
Deleting Control Recipe To delete control recipes, proceed as follows:
1. Select the control recipes that you want to delete:
– To select individual control recipes, click on the corresponding check box.
– To select all control recipes, choose the menu options Edit → Selections → Select all.
– To select all control recipes of a specific status, select the menu options Edit → Selections → Select by status....
Enter the desired status and press the pushbutton Continue.
2. Press the pushbutton Delete.
The system displays a dialog box on which you need to confirm that you want to delete the control recipes.
If a control recipe has not yet been downloaded successfully, a corresponding warning message will be displayed.
3. Confirm that you want to delete the control recipes.
150 April 2001
SAP AG Process Management (PP-PI-PMA)
Process Instruction Sheets (PI Sheets)
Process Instruction Sheets (PI Sheets) Purpose You can use PI sheets to exchange data between the partially or completely manually operated production level and the R/3 System (PP-PI). In manually operated production lines, this usually involves a process operator who uses the PI sheet to transfer production-relevant actual data to the R/3 system and receives data from the R/3 System.
You can describe the entire production process of a product or only part of it in a PI sheet. If the PI sheet only represents part of the production process, you usually need several PI sheets to manufacture a product. You can, for example, define control and picking information for the individual production steps in the PI sheets. The PI sheet is used to inform the process operator about the individual production steps that need to be performed. He or she can interactively maintain the R/3 PI sheet according to the phase sequence.
Apart from control information, the PI sheet can contain input fields and pushbuttons. You can, for example, define fields into which you want the process operator to enter the quantity of material components consumed for a phase. The material withdrawals must then be posted as goods issues in inventory management. You can use process messages to automatically carry out this function.
The process operator can use pushbuttons navigate to other R/3 applications to make entries and then return to the PI sheet. You can, for example, define a pushbutton for quality inspections during production. The process operator can then use this button to navigate to quality management, record inspection results, and then return to the PI sheet.
As of Release 4.6C, you can create two different types of PI sheets:
• The ABAP list-based PI sheet [Page 154]
• The browser-based PI sheet [Page 158] This is an enhanced version of the old ABAP list-based PI sheet. Two of its many advantages are the new user interface in HTML layout as well as new functions.
Implementation Considerations Install this component in process manufacturing companies.
Integration If You Want to You also Need
Carry out quality inspections during production QM - Quality Management
Post goods movements to inventory management MM - Inventory Management
Create a batch during production or Assign values to batch characteristics during production
LO - Batch Management
Send maintenance data to plant maintenance via the PI-PCS interface
PM - Plant Maintenance
April 2001 151
Process Management (PP-PI-PMA) SAP AG
Process Instruction Sheets (PI Sheets)
Features In the PI sheet, you can:
• Display control information such as instructions for the process operator on how to carry out the production step
• Display additional notes, such as notes on specific rules that must be kept for dangerous goods
• Use process messages to report current process data directly from the shop floor to the order (such as, post goods receipts and issues, perform time ticket confirmation)
• Use dynamic function calls to:
− Call R/3 applications outside PP-PI directly from the PI sheet, make entries there, and return to the PI sheet
− Display document from the document management system in the PI sheet
− Perform calculations (such as, calculate dates of time intervals)
• Use user-defined function modules to start a dialog or retrieve data from internal or external applications
You can use predefined process messages to trigger the following business transactions directly from the PI sheet and report process data:
Post goods issues •
•
•
•
•
•
•
•
•
•
•
•
•
Post goods receipts
Create batches
Assign values to batch characteristics
Confirm time events for the phases of an order
Confirm time events for the secondary resources of an order
Update the user status of an operation or a phase
Update the control recipe status
Update the order status according to the control recipe status
Confirm time tickets for the phases of an order
Confirm time tickets for the secondary resources of an order
Report maintenance data to plant maintenance
Post material flows between process orders
For more information on the process message categories contained in the standard system, see R/3 Integration Using Process Messages [Page 27].
You can use predefined dynamic function calls to call the following R/3 functions and make calculations:
Call any R/3 transactions •
• Record inspection results for inspection points
152 April 2001
SAP AG Process Management (PP-PI-PMA)
Process Instruction Sheets (PI Sheets)
Call order confirmation for phases •
•
•
•
•
•
•
•
Display material quantity calculation for an order
Display documents from the R/3 document management system
Create physical-sample records for quality inspections during production
Process sample drawings (for example, release, save)
Calculate the duration of time intervals
Calculate the start date of a time interval
Calculate the end date of a time interval
The above-mentioned function calls have been defined in sample process instructions of type 6. They are included in the standard system. For more information, see Type 6: Dynamic Function Calls [Page 277] and Type 0: Definition of Dynamic Function Calls [Page 447].
Sample process instructions of type 1 to 7 are contained in the standard system. You can find them in Customizing for Process Management by choosing Process Instructions -> Defining Process Instruction Categories (General) [Ext.]. You can both use the sample process instructions or copy them to define your own process instructions.
April 2001 153
Process Management (PP-PI-PMA) SAP AG
ABAP List-Based PI Sheet
ABAP List-Based PI Sheet Definition The PI sheet represents the result of a control recipe that was sent to a process operator and whose content is displayed as text on the screen. This means the PI sheet is an instruction for the process operator that describes how and in which order a product is manufactured. The PI sheet can, for example, contain information about the picking of raw materials as well as instructions about charging the mixer, filling silos, and so on.
The R/3 PI sheet is designed for processing on the screen, which means that the process operator should enter, confirm, report, or complete data interactively. In this way, the R/3 PI sheet enables communication between the R/3 System (PP-PI) and process operators in production lines that are operated manually (either fully or partially).
Beside this conventional PI sheet, you can also create a browser-based PI sheet [Page 158] as of Release 4.6C. It has all the advantages of a browser-based application that is easy-to-operate and intuitive.
Use Depending on the process instructions contained in a control recipe, the PI sheet supports the following functions:
• Displaying control information such as instructions for the process operator on how to carry out production steps
• Displaying additional notes, such as notes on specific rules that must be followed when dealing with dangerous goods
• Recording of actual process data
• Reporting of entered and calculated values using process messages, for example, posting goods issues and receipts or time-ticket confirmations
• Navigating to other R/3 applications outside of PP-PI to make entries and afterwards return to the PI sheet
• Performing calculations, such as calculating dates
• Triggering a dialog or requesting data from internal or external applications
For more information on how to define PI sheets using process instructions, see Process Instructions for R/3 PI Sheets [Page 180]. You can use process instructions of type 1 and 2 as well as type 4 to 7 for ABAP list-based PI sheets.
Structure Each PI sheet consists of a header and a number of elements defined via the process instructions in the control recipe or by the process operator when he or she maintains the PI sheet. These elements include:
Control information and notes with additional information for the process operator •
• Comments by the process operator
154 April 2001
SAP AG Process Management (PP-PI-PMA)
ABAP List-Based PI Sheet
Input fields for the actual process data to be reported •
•
•
Fields for values to be calculated by the system
Pushbuttons that enable the process operator to call user-defined function modules or the QM function for recording inspection results
The data contained in the PI sheet is displayed on an overview screen and various detail screens for the individual elements.
The following paragraphs provide details on the individual elements and their functions within the PI sheet. For information on how to define PI sheets using process instructions, see Process Instructions for PI Sheets [Page 180].
The PI sheet is made up of the following sections:
The Header The header is shown at the very top of a PI sheet's overview screen. It contains information on the following:
The status of the PI sheet •
•
•
•
•
•
•
The process order for which the PI sheet was created
The material to be produced
The process operator or group of process operators responsible for maintaining the PI sheet
The Phases The lower section of the PI sheet comprises the phases. Depending on the content of the process instructions, they can contain the following information:
Control information Control information for the process operator is displayed on the overview screen of the PI sheet. The information to be displayed is defined in a process instruction of the type “process parameter”. In the PI sheet, the number of the process instruction and the corresponding phase of the process order is displayed before the control information.
Additional information Additional information on a process step can be displayed on detail screens within the PI sheet. The information to be displayed is defined as a note in a process instruction of the type “process parameter”. On the overview screen of the PI sheet, one or more pushbuttons are displayed below the corresponding control instruction. You can use these pushbuttons to call up the information on the detail screens.
Comments Within the PI sheet, the process operator can create comments on individual process steps. These comments can either be saved in a special comment sheet within the PI sheet, or they can be reported to process management using a process message. The comment sheet can be accessed from the PI sheet's overview screen by choosing the corresponding menu option or the corresponding pushbutton in the header. Comment messages always refer to a specific process step. If a comment message has been created in the PI sheet, the document symbol as well as the beginning of the comment are displayed to the right of the corresponding control information. You can display the entire comment on a detail screen.
April 2001 155
Process Management (PP-PI-PMA) SAP AG
ABAP List-Based PI Sheet
Input values On the overview screen of the PI sheet, input fields are provided for the actual process data to be reported. The values to be reported are defined in process instructions of the type “process data request”. Single input fields are displayed to the right of the preceding control instruction. If several values of the same type are to be reported, a corresponding table is displayed below the control instruction and the other input fields.
•
• Signature A signature is a special type of input value that marks the end of a process step within the PI sheet. By executing a signature, you confirm and report the data entered or calculated in the process step. If you have made the corresponding system settings, you must execute a signature with a password or a digital signature [Ext.]. Like any other input value, the signature is defined in a process instruction of the type “process data request”.
Values to be calculated If you want the system to calculate a value in the PI sheet, a field for this value is displayed on the overview screen to the right of the preceding control instruction. If the value has not yet been calculated, the field contains a question mark (?). Values to be calculated are defined in process instructions of the type “process data calculation formula”.
•
•
•
Inspection results If inspection results are to be recorded for an operation or phase, the Record inspection results pushbutton is displayed in the PI sheet to the right of the preceding control instruction. Using this pushbutton, you can branch to the QM function for recording inspection results. The operations or phases for which inspection results are to be recorded are defined using a process instruction of the type “inspection results request”.
Dynamic function calls If an R/3 function module is to be called within the PI sheet (for example, to access order confirmation or material quantity calculation, or to start a user-defined function), a pushbutton with which you can start the function is displayed to the right of the preceding control instruction. The function to be called is defined using a process instruction of the type “dynamic function call”.
Integration To create ABAP list-based PI sheets, you must send your control recipes to a control recipe destination of type1 : control recipe transfer to R/3 PI sheet. For more information, see Control Recipe Destinations [Page 132].
Example Overview Screen of a PI Sheet
156 April 2001
SAP AG Process Management (PP-PI-PMA)
ABAP List-Based PI Sheet
PI Sheet
Comment sheetPI sheet 1000000449 ReceivedProcess order: 1234 Operating group: W01
Phase 10 / Instr. 10Heat solvent.Start agitator.Add material ABC.Note:
Phase 10 / Instr. 20Check material quality.Enter material quantity.Stop heating and slowdown agitator.
Phase 10 / Instr. 30Start cooling.Record time and temperatureevery hour.
Time Temperature 10:00 175.0 11:01 168.3
Additionalinformation
Controlinformation
Header
Input values
Input values
Signature for process step
Formula result
Material: XYZ Test material
Due to an error. ..Temp.: ______ °CRot.speed: ______Qty: ____ kgSignature: ____
Record insp. resultsCall material qty calcuationQty: ____ kgRot.speed.: ______Signature: ____
Total qty: ?___
Comments
Insp.resultsrecording
Function call
April 2001 157
Process Management (PP-PI-PMA) SAP AG
Browser-Based PI Sheet
Browser-Based PI Sheet Definition As of Release 4.6C, you can also create PI sheets in HTML layout. The browser-based PI sheet is an enhanced version of the ABAP list-based PI sheet [Page 154]. It offers a new user interface that is intuitive and easy-to-operate.
To be able to best use the browser-based PI sheet, you must install Microsoft Internet Explorer 5.0 and make some security settings in the Internet Explorer. For more information, see Setting Up the Browser for PI Sheets and Cockpits [Page 455].
The PI sheet represents the result of a control recipe that was sent to a process operator and whose content is displayed as text on the screen. This means the PI sheet is an instruction for the process operator that describes how and in which order a product is manufactured. The PI sheet can, for example, contain information about the picking of raw materials as well as instructions about charging the mixer, filling silos, and so on.
The R/3 PI sheet is designed for processing on the screen, which means that the process operator should enter, confirm, report, or complete data interactively. In this way, the PI sheet enables communication between the R/3 System (PP-PI) and process operators in production lines that are operated manually (either fully or partially).
Use Depending on the process instructions contained in a control recipe, the PI sheet supports the following functions:
• Displaying control information such as instructions for the process operator on how to carry out production steps
• Displaying additional notes, such as notes on specific rules that must be followed when dealing with dangerous goods
• Recording of actual process data
• Reporting of entered and calculated values using process messages, for example, posting goods issues and receipts or time-ticket confirmations
• Navigating to other R/3 applications outside of PP-PI to make entries and afterwards return to the PI sheet
• Performing calculations, such as calculating dates
• Triggering a dialog or requesting data from internal or external applications
For more information on how to define PI sheets using process instructions, see Process Instructions for R/3 PI Sheets [Page 180]. Apart from process instructions of type 1 and 2 as well as type 4 to 7, which you can use to define the ABAP list-based PI sheet, there is now the new universal process instruction category of type 0 [Page 182]. The new process instruction category supports new functions that are not available in the conventional PI sheet.
When creating browser-based PI sheets, you can either use the standard layout defined by SAP or use your own layouts. For more information, see Layout Definition for PI Sheets and Cockpits [Page 457].
158 April 2001
SAP AG Process Management (PP-PI-PMA)
Browser-Based PI Sheet
Structure SAP Standard Layout The following sections show you how the browser-based PI sheet is structured in the SAP standard layout and how the interface elements are displayed.
The browser-based PI sheets comprise a header (details) and the individual phases of the process order. The header and all phases are open when you call the PI sheet and can be collapsed and expanded.
All functions are available in the context menu. In addition, a menu bar in the PI sheet header contains the functions that refer to the entire PI sheet. To display the context menu, you position the cursor on the corresponding field and use the right mouse button. You can also use Ctrl + F10 to call up the context menu.
For more information on the functions that are available in the PI sheet, see Functions in Browser-Based PI Sheets [Page 164].
The Header The header is shown at the top of the PI sheet. It contains detailed information about the PI sheet that you can hide or show by choosing Details. The header contains information about:
The status of the PI sheet (test or active PI sheet) •
•
•
•
•
•
•
•
•
The process order for which the PI sheet was created
The material to be produced
The batch to be produced if the material you want to produce is subject to batch management
The number of the control recipe from which the PI sheet was created
The number of the inspection lot if a QM inspection has been defined for the process order
The Phases The lower section of the PI sheet comprises the phases of the process order. Each phase can be subdivided into several sections. Whenever a long text has been defined, a new section is created. A section ends when the next long text has been defined.
Phases can contain the following elements:
Control information, notes, and input fields for long texts that are displayed on the left side
All input fields, output fields, and pushbuttons that are displayed on the right side
Tables that are displayed over the entire PI sheet screen
Interface Elements
Interface Element Output and Meaning
April 2001 159
Process Management (PP-PI-PMA) SAP AG
Browser-Based PI Sheet
Expand Collapse
detail information
The icon next to a field indicates that you can display additional information. It can be displayed:
•
•
•
Next to the phase number to expand or collapse the phase
Next to a note to display the note text
Next to the signature strategy for input fields to display detail information for the executed signature
You can use the icon to collapse these contents again.
* Required entry A red asterisk to the right of input fields indicates that data must be entered into these fields so that, for example, a process message can be created or a process instruction can be completed.
Calculate data This icon is always displayed to the right of a field if a value is to be calculated by the system. When you choose , the calculated value is displayed in the corresponding field.
Pushbutton A pushbutton with the name of a function is displayed when a dynamic function call, such as a jump to QM inspection results recording, has been defined. When you choose the pushbutton, the corresponding function is called.
Input field Input help If the R/3 System provides an input help for an input value, the icon is displayed to the right of the relevant input field. You can also use Ctrl + H to call up input help.
Fixed values If fixed values have been defined for a characteristic, these values are offered in a dropdown list.
User-defined default values Default values that you have defined in the process instruction are displayed directly in the input field. At first, they are displayed in blue. To use the default value, position the cursor in the input field and choose Continue.
Add table line The icon at the end of a table indicates that you can add more lines to the table.
Deviations If a certain value range has been defined for an input value, the icon is used to indicate input values that deviate from this value range. When you choose , you get more information about the deviation.
In tables, the icon is displayed to the right in the table field.
160 April 2001
SAP AG Process Management (PP-PI-PMA)
Browser-Based PI Sheet
Comments Whether the icon is displayed to indicate a comment depends on the object for which your have entered a comment in the PI sheet.
• For a field: The icon is displayed to the right of the field. To display or change the comment, choose .
• For a table: The icon is displayed to the right of the table. To display or change the comment, choose .
•
•
For a table field: No icon is displayed. You can only see if a comment exists if the Display comment entry appears in the context menu.
For the entire PI sheet: No comment is displayed. You can only see if a comment exists if the Display comment entry appears in the context menu
Signature display in tables
The icon next to a table line indicates that digital signatures with a signature strategy have been executed in the table. When you choose the
icon, a dialog box appears displaying the name of the signatory, the date and time when the signature was executed and, if available, a comment by the signatory.
Using the Keyboard for Navigation You can use the mouse pointer to access all fields and call up all functions within the PI sheet. In addition to this, you can use the tab key to navigate between active fields. To trigger the function or dialog box for icons, you must choose Enter. If you set the focus to the icon, for example, and choose Enter, calculation is carried out.
The following fields in the PI sheet are active fields:
Input fields •
•
•
•
Table cells that are ready for input
Pushbuttons
Icons that can be clicked, such as:
− Expanding detail information
− Collapsing detail information
− Calculating data
− Adding table lines
− Displaying deviations
− Displaying comments
− Displaying signatures
You can also use the following key combinations:
Function Key Combination
April 2001 161
Process Management (PP-PI-PMA) SAP AG
Browser-Based PI Sheet
Calling context menu Shift + F10
Calling input help Ctrl + H
Integration To create browser-based PI sheets, you must send your control recipes to a control recipe destination of type 4 : transfer to browser-based PI sheet. For more information, see Control Recipe Destinations [Page 132].
162 April 2001
SAP AG Process Management (PP-PI-PMA)
Setting Up the Browser for PI Sheets and Cockpits
Setting Up the Browser for PI Sheets and Cockpits Use For the system to be able to best display browser-based PI sheets [Page 158] and process manufacturing cockpits [Page 406], we recommend installing Microsoft Internet Explorer 5.0 or higher. In addition, we recommend making the security settings described below in your Internet Explorer.
Procedure 1. In the Internet Explorer menu, choose Tools -> Internet Options.
2. Choose the Security tab page.
3. Choose the Web content zone Internet.
4. Choose Custom Level ...
5. Make the following settings in the Security Settings dialog box.
Function Settings
Download signed ActiveX controls Enable or prompt
Launching programs and files in an IFRAME Enable
Navigate sub-frames across different domains Enable
Note the following:
• All browser settings you make in your Internet Explorer automatically take effect in the browser-based PI sheet and process manufacturing cockpit, too.
• Certain commonly used keyboard functions, such as F4, may have a different result or may not be available at all in the browser-based PI sheet and cockpit.
April 2001 163
Process Management (PP-PI-PMA) SAP AG
Functions in Browser-Based PI Sheets
Functions in Browser-Based PI Sheets Use When maintaining the browser-based PI sheet, the process operator can use a number of different functions. Some of these functions can be performed for the entire PI sheet, others are only available for individual process steps.
Functions that can be performed for the entire PI sheet can be started as follows: •
•
•
•
•
•
− Via the menu bar in the PI sheet header
− Via the context menu
• By positioning the mouse pointer outside of input fields, output fields, and pushbuttons and then choose the right mouse button
• By choosing key combination Shift + F10
Functions that refer to individual process steps are only displayed in the context menu of the corresponding process step if they are actually relevant for it. The Display message function, for example, is only displayed in process steps for which a process message has been defined.
Which functions are available in the context menu also depends on whether you display or change the PI sheet.
Features This section provides you with information about the following:
Which functions are available in the browser-based PI sheet
Whether a function is available for a process step, a table, or for the entire PI sheet
Which functions are available in which mode (display or change mode)
Functions in the Menu Bar Most of the functions available in the menu bar are identical to the functions in the context menu that refer to the entire PI sheet (see section Functions in the Context Menu).
Only menu option Displ. -> Chnge or Chnge -> Displ. is only available in the menu bar. It shows in which mode you currently are in the PI sheet. You can use this function to switch to the opposite mode:
If the Chnge -> Displ. function is available, you are in the change mode. When you choose this function, the system takes you to the display mode.
• If the Displ. -> Chnge is available, you are in the display mode. When you choose this function, the system takes you to the change mode.
Functions in the Context Menu The following functions are available in the context menu of the browser-based PI sheet:
Functions in the Context Menu Available for Available in
164 April 2001
SAP AG Process Management (PP-PI-PMA)
Functions in Browser-Based PI Sheets
Calculate values This icon is always displayed to the right of a field if a value is to be calculated by the system. When you choose
, the calculated value is displayed in the corresponding field. If values to which you referred in a calculation formula are changed after the calculation was carried out in the PI sheet, these changes are no longer taken into account in the formula result. For this reason, the calculated value reported may sometimes not be up-to-date.
The formula used for a calculation can refer to one or more values entered or calculated previously in the PI sheet. For this reason, we recommend maintaining and calculating all preceding values before starting the calculation. If a value is missing in a calculation formula, a corresponding error message is displayed.
Process step Change mode
Call function (pushbutton) A pushbutton with the name of a function is displayed when a dynamic function call, such as a jump to QM inspection results recording, has been defined. When you choose the pushbutton, the corresponding function is called.
Display mode Change mode, provided that characteristic Function allowed in display mode has been defined
Display position This shows the number of the phase and process instruction in the process order in which the process step was defined. You need this function in the following situations:
•
•
When you find an error while testing the PI sheet, you can use this function to find the process instruction that must be changed.
System messages in the log normally specify the process instruction to which they refer. If a system message indicates an error you have made while maintaining the process instruction in the PI sheet, you can use the above function to find the relevant element of the PI sheet.
Process step Display mode Change mode
Display message You can use this function to display the message to be used to report the values entered or calculated.
Process step Display mode Change mode
April 2001 165
Process Management (PP-PI-PMA) SAP AG
Functions in Browser-Based PI Sheets
Create comment (document) You can use this function to enter a comment for the entire PI sheet. You can use the Close and send function in the dialog box to send the comment you have entered in a PI_COMM process message. Once you have send a comment, you can no longer change it but you can create a new comment. You can still create comments for the document after you have completed the PI sheet.
Entire PI sheet Change mode
Display comment (document) You can use this function to display comments that have been entered for the PI sheet. The dialog box contains all existing comments together with the names of the persons who entered them and the dates and times when they were entered.
Entire PI sheet Display mode Change mode
Create comment You can enter a comment for each input field, output field, and table line. You can use the Close and send function in the dialog box to send the comment you have entered in a PI_COMM process message. Once you have sent a comment, you can no longer change it. You can, however, enter a new comment.
Process step Change mode
Display comment The icon indicates that a comment has been entered for a process step. To display the comment, choose or Display comment in the context menu.
Process step Display mode Change mode
Create comment (table) You can also create a comment for the entire table. You can use the Close and send function in the dialog box to send the comment you have entered in a PI_COMM process message. Once you have send a comment, you can no longer change it but you can create a new comment.
Table Change mode
Display comment (table) The icon to the right of the table indicates that a comment has been entered for this table. To display the comment, choose or Display comment in the context menu
Process step Display mode Change mode
Display signatures You can use this function to display all digital signatures that have been executed (along with the signature strategy). A dialog box appears that contains the name of the signatory, the date and time when the signature has been executed, and if available, a comment by the signatory.
Process step Display mode Change mode
166 April 2001
SAP AG Process Management (PP-PI-PMA)
Functions in Browser-Based PI Sheets
Display digital signature in tables This icon is displayed for a table line if you have executed a digital signature (with a signature strategy). When you choose , a dialog box appears containing the signatory name, the date and time when the signature was executed, and, if available, a comment by the signatory.
Process step Display mode Change mode
Change (document) When you are in the display mode, you can use this function to switch to the change mode.
- Entire PI sheet - Process step
Display mode
Display (document) When you are in the change mode, you can use this function to switch to the display mode.
- Entire PI sheet - Process step
Change mode
Deactivate (process instructions) You can use this function to deactivate all input fields and pushbuttons that belong to a process instruction. This means that they are no longer ready for input. You may want to deactivate process instructions if a process cannot be executed according to the plan, (which means that some data may not be available) but you still want to complete the PI sheet. You can set the PI sheet status to Completed only after all entries have been made and all calculations have been performed. Process instructions that have been deactivated are no longer taken into account when the PI sheet is checked, and you can therefore set the PI sheet to Complete.
Process step Change mode
Activate (process instruction) You can use this function to activate input fields and pushbuttons that have been deactivated.
Process step Change mode
Deactivate (table line) You can use this function to deactivate a table line in a table. This means that this line is no longer ready for input. Deactivated fields are not taken into account when the PI sheet is checked.
Table Change mode
Activate (table line) You can use this function to activate table lines that have been deactivated.
Table Change mode
Add line (table) If lines can be added to a table, you can choose this function. You can also choose , which has the same function.
Table Change mode
Find batch(es) For more detailed information about this function, see Batch Determination in the PI Sheet [Page 350].
Process step Change mode
April 2001 167
Process Management (PP-PI-PMA) SAP AG
Functions in Browser-Based PI Sheets
Check batch If you enter the material quantities consumed for material components that are subject to batch management and have entered the batch manually, you can use this function to check whether the batch you have entered meets the selection criteria defined for batch determination [Ext.].
Process step Change mode
Discard/Cancel (document) For more detailed information on this function, see Discarding/Canceling of Browser-Based PI Sheets [Page 177].
Entire PI sheet Change mode
Complete (process instructions) You can use this function to report all process messages that belong to a process instruction.
Process step Change mode
Complete (table) You can use this function to complete an entire table. The process messages for this table are automatically created.
Table Change mode
Complete (table line) You can use this function to report all process messages that belong to a table line.
Process step Change mode
Report data (document) You can use this function to report all process messages that have been created for the entire PI sheet so far in one go. For more detailed information on this function, see Reporting of Actual Data in Browser-Based PI Sheets [Page 174].
Process step Change mode
Complete (document) For more detailed information on this function, see Completing of Browser-Based PI Sheets [Page 178].
- Entire PI sheet - Process step
Change mode
Save (document) If you need to exit a PI sheet before it has been fully processed, you can save the entered data without reporting it. You can still change the data after you have saved it.
- Entire PI sheet - Process step
Change mode
168 April 2001
SAP AG Process Management (PP-PI-PMA)
Recording of Actual Data in Browser-Based PI Sheets
Recording of Actual Data in Browser-Based PI Sheets Use You can use the input fields displayed in your PI sheet to record actual process data. You can enter data as follows:
You enter individual values in input fields. In the standard layout, these fields are displayed on the right side of the PI sheet.
•
• You enter several values in a table.
Prerequisites To be able to use the PI sheet functions described below, the following requirements must be met:
• Default value
A default value has been defined for the input field in the corresponding process instruction in the process order.
• Input help
An input help has been defined in Customizing for the process instruction characteristic to which the input field belongs.
• Input validation
An input validation has been defined for the input field in the corresponding process instruction in the process order. If it specifies that invalid input values may be accepted with a signature only, the type of signature has been define in Customizing for Control Recipe Destinations and in the process instruction. (see Type 0: Definition of Input Validations [Page 429]).
For more information about the digital signature and the required settings, see Approval Using Digital Signatures [Ext.].
Features The following functions are available for entering data in the PI sheet:
Default values •
•
In browser-based PI sheets, the default values that you have defined in the process order are already displayed in the corresponding input fields when you open the PI sheet. You can:
− Accept the default value by positioning the cursor on the input field and choosing Continue
− Replace the default value by another value
− Delete the default value
Input help
April 2001 169
Process Management (PP-PI-PMA) SAP AG
Recording of Actual Data in Browser-Based PI Sheets
You can use the input help to choose values for input fields for which the corresponding Customizing settings have been made.
Input validation •
If an input validation is defined for a value in the process order, the system checks your entries. If the value you enter is outside the defined value range, the system issues a warning. However, you can still transfer the invalid input value to the PI sheet, if this has been specified in the process instruction. You can make the following settings:
− Invalid values are accepted without any restrictions
− Invalid values are not accepted
− Invalid values are only accepted with a signature However, once you have entered a value that does not comply with the validation rule, you may from then on change the value assignment but may no longer delete it.
The PI sheet may request and depending on your system settings a signature without a password check, one digital signature [Ext.], or several individual signatures defined in a signature strategy [Ext.] are required.
When you execute digital signatures, you must also enter a comment. The signature strategies are carried out synchronously in the PI sheet. This means that the individual signatures must be executed immediately one after another. It is only then that the system saves the signatures and transfers the value.
The input value is not reported automatically when the signature is executed.
Once you've entered a deviating value, all values - this means even values that comply with the validation rule - are documented in a deviation history. However, you do not need to execute the signature again if the values are correct. The icon in the PI sheet indicates that a deviation history exists. You can display the values along with the signatures and comments in a dialog box by choosing .
Process message •
If you have defined in the process order that a process messages is to be sent to report values entered, a corresponding process message is created once you have entered a value in the PI sheet.
Activities If you must execute a digital signature during an input validation, you must initiate one of the following activities:
• Executing Digital Signatures [Page 363]
• Executing Signature Strategies [Page 365]
170 April 2001
SAP AG Process Management (PP-PI-PMA)
Batch Determination in the PI sheet
Batch Determination in the PI sheet Use You use this function in the PI sheet when you enter material consumptions for material components that are to be handled in batches. The function helps you to find suitable batches for the corresponding material component.
Batch determination is used in the whole of logistics. The basic processes and prerequisites for this are always identical. For more information, see the R/3 Library LO - Batch Management under Batch Determination [Ext.].
However, depending on where batch determination is used, certain special features may need to be taken into account. These features result from the context of the respective individual application. The following sections describe what you must bear in mind when you use batch determination in PI sheets.
Prerequisites You have installed the application component Batch Management (LO-BM). In this component, a batch search procedure together with the corresponding strategy types and search strategies has been defined for the order type (refer to Batch Search Strategy [Ext.]).
The material component for which you want to find a batch meets the following requirements:
• It has been defined as being subject to batch management in the material master record.
• If you want batch determination to use different selection criteria than those defined in the batch search strategy, the material component must have been classified accordingly in the material list of the process order.
A process data request has been defined for the PI sheet and meets the following requirements:
• It contains the following message characteristics:
– PPPI_RESERVATION and PPPI_RESERVATION_ITEM
– PPPI_BATCH as an input value
– PPPI_MATERIAL (material number)
– PPPI_MATERIAL_CONSUMED (material quantity consumed) as an input value
– PPPI_UNIT_OF_MEASURE (unit of measurement)
The value of this characteristic must be identical to the base or alternative unit of measure of the material.
• No default value has been defined for the batch in the data request.
• If you want to copy several batches to the PI sheet (batch split), the data request must be of the type “repeated data request” and must contain a sufficient number of table lines.
Features Determining Suitable Batches Having entered the required material quantity, you start batch determination manually in the PI. Just like in the process order, the following criteria are used for selection:
April 2001 171
Process Management (PP-PI-PMA) SAP AG
Batch Determination in the PI sheet
• Selection criteria for batches
The system determines the selection criteria using the following data:
– If it has been maintained in the material list of the process order, the classification data of the material component
– If no classification data has been maintained, the selection criteria of the batch search strategy determined for the order type using the batch search procedure
The system determines suitable batches by comparing the selection criteria with the classification data in the batch master record.
• Batch availability
The system checks whether the batches are available at the time when batch determination is carried out. The following checking rule is used (refer to Customizing for availability checks).
– If it has been defined, the checking rule intended for order processing of the corresponding order type
– It if has not been defined, the checking rule intended for order creation
If no checking rule has been defined, the availability check and batch determination is terminated.
• Sort sequence and proposed quantity for the batch to be used
The system uses the data defined in the batch search strategy. If no suitable search strategy has been defined, batch determination is terminated.
Copying Batches When the system has determined suitable batches, you can copy them into the PI sheet. You can use the following functions:
• Copying batches automatically
If batch determination in the background is defined in the batch search strategy, the system copies the proposed quantity it determines directly to the PI sheet.
• Copying batches manually
If batch determination in dialog is defined in the batch search strategy, the system displays the proposed quantity. You can change the quantity if you want and then copy the batch. However, a batch split, that is copying several batches, is only allowed if:
– The batch search strategy supports it
– The process instruction is a repeated data request and can accommodate a sufficient number of table line
When you copy a batch into the PI sheet, the system - unlike in the process order - does not create or update a reservation. For this reason, the wrong batches may be selected in the following cases:
– If you trigger batch determination in the PI sheet for several goods issues for the same material in a row
172 April 2001
SAP AG Process Management (PP-PI-PMA)
Batch Determination in the PI sheet
– If you also trigger batch determination for one material at another location in the system, for instance, in the process order
For this, make sure that process messages are sent immediately and thus goods issues are posted as quickly as possible when you create and maintain your PI sheets.
April 2001 173
Process Management (PP-PI-PMA) SAP AG
Reporting of Actual Data in Browser-Based PI Sheets
Reporting of Actual Data in Browser-Based PI Sheets Use You use this function to report actual data you have entered or calculated in the PI sheet. You can start data reporting as follows:
For the values of the entire PI sheet, by choosing Report data in the context menu •
•
•
•
For the values of a process step, by executing a signature to complete the step
For the values of a process instruction by choosing Complete (process instruction) in the context menu
For the values of a table line by choosing Complete (table line) in the context menu
Prerequisites Reporting Data To be able to report values you have entered, you must have defined a message creation [Page 423] in which the input value is included as a characteristic in the process instruction.
Executing Signatures A process instruction in which a signature has been specified as an input value has been defined in the PI sheet (see Definition of Signatures [Page 263]).
The type of signature to be used in the PI sheet has been defined in Customizing for Control Recipe Destinations. You have the following options:
Signature without a password check •
• Digital signature [Ext.] If several individual signature are to be executed, you also define the signature strategy [Ext.] in the control recipe destination or in the process instruction.
For more information about digital signatures and the required settings, see Approval Using Digital Signatures [Ext.].
Features When you report a value from the PI sheet, the system creates the corresponding process message and transfers it to process management. Process management then sends the message to its destinations for further processing.
Which values you can report depends on how you start the function. The system checks:
Whether a value has already been reported •
• Whether all required entries have been made The system only creates complete process messages.
After you have reported the values, you can no longer change them in the PI sheet.
The table below tells you which functions you can use to start reporting data and which prerequisites must be met for the individual data reporting functions.
174 April 2001
SAP AG Process Management (PP-PI-PMA)
Reporting of Actual Data in Browser-Based PI Sheets
Function Prerequisites and Processing
Report data The system selects all data that can be reported for the entire PI sheet. It does not check whether the input values have been maintained in sequence. This means that you do not receive a system message if by mistake some values have not been entered between the first and the last value to be reported.
Signature in input field
When you complete a process step with a signature or a digital signature, the system reports all data since the last signature or digital signature. You cannot complete a process step unless all required entries have been made. The asterisk next to the text field shows you which entries are required.
Signature in table The procedure for signing tables differs depending on whether the signatures are required or optional.
•
•
If the signatures are required, the system selects all data to be reported for the corresponding table line. You can execute the signatures in any sequence.
If the signatures are optional, you do not need to sign every table line. You can, for example, enter values in several table lines and then sign in the third line. The system automatically copies the signature you have executed to the preceding lines. It selects all data to be reported for the preceding lines that have not yet been completed.
Complete process instruction
You cannot complete a process instruction unless all required entries have been made. The asterisk next to the text field shows you which entries are required. The system then selects all data that must be reported for the process instruction.
Complete table line You cannot complete a table line unless all required entries have been made. The system then selects all data that must be reported for the table line.
Signature strategies that you use to complete a process step are carried out synchronously. This means that all individual signatures must be executed immediately one after another. It is only then that the system saves the signatures and reports the data.
Activities If you use a digital signature to complete a process step in the PI sheet, initiate one of the following activities:
• Executing Digital Signature [Page 363]
• Executing Signature Strategies [Page 365]
April 2001 175
Process Management (PP-PI-PMA) SAP AG
Reporting of Actual Data in Browser-Based PI Sheets
176 April 2001
SAP AG Process Management (PP-PI-PMA)
Discarding/Canceling of Browser-Based PI Sheets
Discarding/Canceling of Browser-Based PI Sheets Use If a process needs to be canceled, for example, due to a malfunction, the PI sheet controlling the execution of this process also needs to be canceled. In this case, you can choose Discard/Cancel in the context menu.
The SAP System distinguishes between Discarding and Canceling since different statuses are assigned to the PI sheet when you carry out the Discard/Cancel function even though technically the same function is involved.
Implications When you discard/cancel a PI sheet, the system creates and sends a corresponding message on the control recipe status (message category PI_CRST) that triggers the following changes:
If you have not yet started maintaining the PI sheet: •
•
•
•
•
− The PI sheet is assigned status Discarded
− The control recipe is assigned status Discarded
− The corresponding phases in the order are assigned status Control recipe discarded. This means that you can change the phases and create a new control recipe for them.
If you have already started maintaining the PI sheet:
− The PI sheet is assigned status Canceled
− The control recipe is assigned status Terminated
− The corresponding phases in the order are assigned status Control recipe processed
PI sheets that have status Discarded or Canceled:
Are archived in the batch record if the Batch record required indicator has been set for the order type used
Are automatically deleted when the process order is deleted
Can manually be deleted in the worklist if the No process data documentation required indicator is set for the order type used
April 2001 177
Process Management (PP-PI-PMA) SAP AG
Completing of Browser-Based PI Sheets
Completing of Browser-Based PI Sheets Use After you have fully maintained a PI sheet, you can complete it.
You can complete a PI sheet as follows:
In PI sheets with a completing signature (asynchronous signature process), the Complete function is automatically triggered when the last signature is executed.
•
•
•
•
•
In PI sheets without a completing signature, you must carry out the Complete (document) function explicitly.
Prerequisites You can only complete a PI sheet if:
All required entries have been made The asterisk next to the text field shows you which entries are required.
All calculations have been carried out successfully
All necessary process messages have been created
The following requirements must be met if you want to use a signature to complete the PI sheet.:
• A signature with an asynchronous signature process has been defined as the last process instruction of the control recipe destination in the process order (see Definition of Signatures [Page 263]).
• The signature type digital signature [Ext.] has been defined in Customizing for Control Recipe Destinations.
• A signature strategy [Ext.] has been assigned at one of the following:
− In the control recipe destination, Signature strategy for process steps field
− In the process instruction
For more information about digital signatures and the required settings, see Approval Using Digital Signatures [Ext.].
Implications When you complete a PI sheet, the system creates a message on the control recipe status (message category PI_CRST). This triggers the following changes:
The PI sheet is assigned status Completed. •
•
•
The control recipe is assigned status Processed.
The corresponding phases in the order are assigned status Control recipe completed
PI sheets with status Completed:
• Are archived in the batch record if the Batch record required indicator has been set for the order type used
• Are automatically deleted when the process order is deleted
178 April 2001
SAP AG Process Management (PP-PI-PMA)
Completing of Browser-Based PI Sheets
• Can manually be deleted in the worklist if the No process data documentation required indicator is set for the order type used
Activities If you want to use a digital signature to complete a PI sheet, perform the following activity:
Executing Signature Strategies [Page 365]
April 2001 179
Process Management (PP-PI-PMA) SAP AG
Process Instructions for the R/3 PI Sheet
Process Instructions for the R/3 PI Sheet Use You must define production-related process steps that you want the process operator to carry out manually at a production line in process instructions. These process instructions must be assigned to a process instruction type [Page 107] that specifies that a PI sheet [Page 151] is used to process the information.
Integration You assign process instructions to the phases of a master recipe and process order.
Prerequisites For the system to be able to process the process instructions correctly in the PI sheet, they must contain certain characteristics and be structured according to specific rules. The following sections describe the structure of the process instruction types that make up the individual elements of a PI sheet.
The depth of knowledge of the characteristic structure of the individual process instruction types you require depends on the function you use to create your process instructions (see Manual Process Instruction Maintenance [Page 120] ):
If you use the process instruction assistant, you will be guided through process instruction definition by specific prompts. The characteristic structure is created by the system.
•
Note that at present you cannot use the process instruction assistant to define process instructions of Type 0: Universal process instruction category.
If you maintain your process instructions on the characteristic overview, you must create the characteristic structure yourself.
•
•
Features When you define process instructions for the PI sheet, you can choose between seven different process instruction types. Which process instruction type you use, depends on the following:
Whether you want to create the PI sheet in the HTML layout or in ABAP list format Depending on the layout in which you want to display your PI sheet, you must send your control recipes to the appropriate control recipe destination type [Page 132].
Which functions you want the process instruction to support •
•
You can use the following process instruction types for browser-based and ABAP list-based PI sheets:
Type 1: Process Parameters for PI Sheets [Page 228]
Type 2: Process Data Requests for PI Sheets [Page 231] •
Type 4: Process Data Calculation Formulas [Page 267] •
Type 5: Inspection Results Requests [Page 276] •
180 April 2001
SAP AG Process Management (PP-PI-PMA)
Process Instructions for the R/3 PI Sheet
Type 6: Dynamic Function Calls [Page 277] •
Type 7: Sequence Definitions [Page 300] •
In addition, you can use the following process instruction type for browser-based PI sheets:
Type 0: Universal Process Instruction Category [Page 180] •
April 2001 181
Process Management (PP-PI-PMA) SAP AG
Type 0: Universal Process Instruction Category
Type 0: Universal Process Instruction Category Use The main advantage of universal process instructions over process instructions of type 1 to 7 is that they support the functions of all the other process instruction types. In a PI sheet, you can, for example, display control information, use process messages to report actual process data, or use dynamic function calls to make calculations and jump to other applications.
In process instruction of type 1 to 7, you must, however, create a process instruction of the appropriate type for each of these function. For example, a process instruction of Type 1: process parameter can only display information, a process instruction of Type 2: process data request can only record entries, a process instruction of Type 4: process data calculation formula can only perform calculations, and a process instruction of Type 6: dynamic function call can only execute function calls.
You can now define all these function in only one universal process instruction of type 0.
Note that at present you cannot use the process instruction assistant to define process instructions of Type 0: Universal process instruction category.
Prerequisites You can only use universal process instructions of type 0 to control recipes that are sent to control recipe destinations [Page 132] of type 4. This means that the control recipe sent to the control recipe destination of type 4 is displayed on the screen as a browser-based PI sheet [Page 158].
Features Optional Message Creation When you use process instructions of Type 2: process data request and Type 4: process data calculation formula, you need to specify which message category was to be used to report the value entered or calculated. This means that you need to report all entered or calculated values even if they are irrelevant.
In universal process instructions, you can now specify for each process instruction whether you want the system to create a process message. The system only creates process messages if the characteristic PPPI_MESSAGE_CATEGORY is contained in the process instruction. It then reports all message characteristics, that is, even those that do not belong to the message category specified.
Using universal process instructions, you can now report any characteristic, such as results from function calls, in one process instruction of type 0.
Functions The universal process instruction category supports the following functions:
Definition of Phase Sequences [Page 189] •
Definition of Data Requests [Page 421] •
182 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Universal Process Instruction Category
Definition of Message Creation [Page 423] •
Definition of Entries [Page 424] •
− Definition of Default Values for Input Values [Page 427]
− Definition of Input Validations for Input Values [Page 429]
Definition of Output Fields for Characteristic Values [Page 437] •
Definition of Output Fields for Variable Values [Page 439] •
Definition of Calculations [Page 440] •
Definition of Automatic Value Assignment [Page 444] •
Definition of Value Assignment Using Variables [Page 446] •
Definition of Dynamic Function Calls [Page 447] •
Structure of Universal Process Instructions To define universal process instructions correctly, the characteristics must be defined in a certain order in the process instruction. For more information, see Type 0: Structure of Universal Process Instructions [Page 184].
April 2001 183
Process Management (PP-PI-PMA) SAP AG
Type 0: Structure of Process Instructions for PI Sheets
Type 0: Structure of Process Instructions for PI Sheets
For the system to correctly process universal process instructions in the PI sheet, you must define the characteristic in a certain order.
In the following sections, the characteristics are grouped into characteristic blocks according to their purpose. You can combine them into process instructions in the following order:
1. First, you define phase sequences.
2. Second, you define data requests.
3. Third, you define the message creation. You can define as many process message blocks as you like.
4. Fourth, you define any of the remaining characteristic blocks. Each characteristic block can be defined any number of times. You can define these characteristic blocks in any order.
Order of Characteristic Blocks
4. Definition of dynamic function calls
4. Definition of value assignment using variables
4. Definition of automatic value assignment
4. Definition of calculations
4. Definition of output fields for variable values
1. Definition of phase sequences
2. Definition of data requests
3. Definition of message creation
4. Definition of output fields for characteristic values
4. Definition of entries
Process instructions
May
be
defin
ed s
ever
al ti
mes
Any
ord
er
Characteristic Blocks * = optional
184 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Structure of Process Instructions for PI Sheets
A) Definition of Phase Sequence [Page ] 189Characteristic Meaning
PPPI_PREDECESSOR Number of the predecessor phase
B) Definition of Data Request [Page ]421 Characteristic Meaning
PPPI_DATA_REQUEST_TYPE Type of data request: < Simple data request (value "simple") < Repeated data request (value "repeated")
PPPI_MINIMUM_TABLE_SIZE * Minimum number of table lines
PPPI_MAXIMUM_TABLE_SIZE Maximum number of table lines *
C) Definition of Message Creation [Page ]423 Characteristic Meaning
PPPI_MESSAGE_CATEGORY Message category
D) Definition of Entries [Page ] 424Characteristic Meaning
PPPI_INPUT_REQUEST * Text for input request
< PPPI_DEFAULT_VALUE or < PPPI_DEFAULT_STRING or < PPPI_DEFAULT_VARIABLE or < <Any message characteristic>
* Default value < Numerical value < Alphanumerical value < Variable < Characteristic value
* < PPPI_VARIABLE or < PPPI_GLOBAL_VARIABLE
Variable definition for value entered: < Variable < Global Variable
PPPI_REQUESTED_VALUE Characteristic to be entered < PPPI_VALIDATION_FORMULA or < PPPI_VALIDATION_FUNCTION
* Input validation: < Validation rule (max. 8 times) < Check function
> <Parameters for check function> Export parameters (see Definition of Dynamic Function Calls)
PPPI_TEXT_FOR_INVALID_INPUT * Long text for invalid entries
PPPI_ACCEPT_INVALID_INPUT * Accepting invalid entries
PPPI_SIGNATURE_AUTHORIZATION * Authorization for signature
PPPI_SIGNATURE_STRATEGY * Signature strategy
PPPI_SIGNATURE_MODE * Signature mode
April 2001 185
Process Management (PP-PI-PMA) SAP AG
Type 0: Structure of Process Instructions for PI Sheets
E) Definition of Output Fields for Characteristic Values [Page ] 437Characteristic Meaning
PPPI_OUTPUT_TEXT Text of output field *
PPPI_OUTPUT_CHARACTERISTIC Characteristic to be output
F) Definition of Output Fields for Variable Values [Page 439] Characteristic Meaning
PPPI_OUTPUT_TEXT Text of output field *
PPPI_OUTPUT_VARIABLE Variable to be output
G) Definition of Calculations [Page ] 440Characteristic Meaning
PPPI_INPUT_REQUEST Text for input request
< PPPI_VARIABLE or < PPPI_GLOBAL_VARIABLE
* Variable definition for value entered: < Variable < Global variable
PPPI_CALCULATED_VALUE Characteristic to be calculated
PPPI_CALULATION_FORMULA Calculation formula (characteristic can be assigned any number of times, the formula may, however, only be 240 characters long)
H) Definition of Automatic Value Assignment [Page ] 444Characteristic Meaning
< PPPI_VARIABLE or < PPPI_GLOBAL_VARIABLE
* Variable definition for characteristic with automatic value assignment < Variable < Global variable
PPPI_AUTOMATIC_VALUE Characteristic with automatic value assignment
I) Definition of Value Assignment Using Variables [Page ]446 Characteristic Meaning
PPPI_DEFAULT_VARIABLE Default variable
PPPI_EXTERNAL_VALUE Value received
J) Definition of Dynamic Function Calls [Page ] 447Characteristic Meaning
PPPI_FUNCTION_NAME Function module name
PPPI_BUTTON_TEXT * Button text
PPPI_FUNCTION_DURING_DISPLAY * Function call allowed in display mode
186 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Structure of Process Instructions for PI Sheets
Parameters in function module Parameters according to definition in function module: • <Export parameters> • <Changing parameters> • <Import parameters>
J-1) Definition of Export Parameters [Page 449]
Characteristic Meaning
PPPI_EXPORT_PARAMETER Name of the import parameter in the function module
< <Message characteristic> or < PPPI_STRING_CONSTANT or < PPPI_FLOAT_CONSTANT or < PPPI_DATE_CONSTANT or < PPPI_TIME_CONSTANT or < PPPI_STRING_VARIABLE or < PPPI_FLOAT_VARIABLE or < PPPI_DATE_VARIABLE or < PPPI_TIME_VARIABLE
For value assignment of fixed values: < Any message characteristic < Constant - alphanumerical value < Constant - floating point number < Constant - date < Constant - time For value assignment using variables: < Variable - alphanumerical value < Variable - floating point number < Variable - date < Variable - time
PPPI_OPTIONAL_PARAMETER Optional parameter transfer
J-2) Definition of Changing Parameters [Page ] 451
Characteristic Meaning
PPPI_CHANGING_PARAMETER Name of the changing parameter in the function module
< PPPI_STRING_VARIABLE or < PPPI_FLOAT_VARIABLE or < PPPI_DATE_VARIABLE or < PPPI_TIME_VARIABLE
Value transfer in variable: < Variable - alphanumerical value < Variable - floating point number < Variable - date < Variable - time
PPPI_OPTIONAL_PARAMETER Optional parameter transfer *
J-3) Definition of Import Parameters [Page ] 452
Characteristic Meaning
PPPI_IMPORT_PARAMETER Name of the export parameter in the function module
< PPPI_STRING_VARIABLE or < PPPI_FLOAT_VARIABLE or < PPPI_DATE_VARIABLE or < PPPI_TIME_VARIABLE or
Value transfer in variable: < Variable - alphanumerical value < Variable - floating point number < Variable - date < Variable - time
PPPI_OPTIONAL_PARAMETER Optional parameter transfer *
April 2001 187
Process Management (PP-PI-PMA) SAP AG
Type 0: Structure of Process Instructions for PI Sheets
188 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Phase Sequences
Type 0: Definition of Phase Sequences Use You can use this function to determine that the process operator may not process a certain phase in the PI sheet until another phase or several other phases have been completed.
Notes on Using Sequence Definitions
You must always insert the definition of phase sequences at the start of a phase before the other process instructions.
•
• The definition of phase sequences has been designed to transfer the phase relationships defined in a process order to the corresponding PI sheets. Sequence definitions are generated automatically if you have made the corresponding settings in Customizing for the Control Recipe Destination [Page 132]. The value of the characteristic PPPI_PREDECESSOR is assigned automatically during the generation process.
Do not use the definition of phase sequences in combination with hidden data requests. If hidden data requests are used at the start of a phase, the corresponding messages may be created at the wrong time or not created at all because their phase is still locked when the previous message is sent.
•
Activities You assign the following characteristic to the process instruction:
Characteristic Meaning Allowed Values
PPPI_PREDECESSOR Number of the phase that has to be processed first (predecessor phase)
Number of a phase in the current order for the same PI sheet
If a phase has several predecessors, characteristic PPPI_PREDECESSOR must be created for each predecessor phase in the process instruction.
April 2001 189
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Data Requests
Type 0: Definition of Data Requests Use You use this function to specify whether ordinary input and output fields or a table with input and output fields are to be created in the browser-based PI sheet [Page 158] or Process Manufacturing Cockpit [Page 406].
Features The following types are available:
Simple data request: Ordinary input and output fields are created in the PI sheet or cockpit.
•
• Repeated data request: A table for the input and output of data is created in the PI sheet or cockpit.
If you do not enter a data request type, the system sets "simple data request" by default.
If you use a repeated data request, you also have the following options:
Minimum number of table lines: You can specify the minimum number of table lines that must be edited. In the PI sheet, you cannot complete the corresponding process step unless you have entered data in these lines.
•
•
•
•
•
Maximum number of table lines: You can specify the maximum number of table lines permitted. Once data has been entered in these lines, the system does not further lines.
Activities When defining data requests, you specify the following information in the process instruction:
Type of data request
If required, the minimum number of tables lines that must be edited
If required, the maximum number of tables lines that may be edited
To enter this information, you assign the following characteristics to the process instruction in the order specified below:
Characteristic Meaning Allowed Values
PPPI_DATA_REQUEST_TYPE Data request type SIMPLE REPEATED
PPPI_MINIMUM_TABLE_SIZE Minimum number of table lines
PPPI_MAXIMUM_TABLE_SIZE Maximum number of table lines Any number
190 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Data Requests
April 2001 191
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Message Creation
Type 0: Definition of Message Creation Use You can use process messages to report actual data from production control to the process order or other R/3 components. Reporting actual data can trigger certain business transactions in the corresponding R/3 component. This ensures that the data from production control is consistent with the data of different R/3 components.
You can create process messages in any universal process instruction of type 0, irrespective of the functions it contains.
Prerequisites You must create the process message category you want to use in Customizing for Process Management under Process Messages -> Define and Set up Process Message Categories [Ext.].
Features The standard R/3 System contains a number of predefined process message destinations along with message categories.
In R/3 Integration Using Process Messages [Page 27] and the subordinate sections, you will find information about the following:
•
•
•
Allowed Values
Which predefined message categories are contained in Customizing
Which business transactions may be triggered using these message categories
How these messages are processed
Activities You can define one or more process messages in each universal process instruction, depending on whether it is a simple or a repeated data request.
You assign the following characteristic to the process instruction:
Characteristic Meaning
PPPI_MESSAGE_CATEGORY Message category Any message category
Immediately after the characteristic PPPI_MESSAGE_CATEGORY, you must define at least all required characteristics of the message category.
If you want to create several messages, you can assign this characteristic several times.
The system reports all message characteristics, that is, even those that do not belong to the message category specified.
192 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Entries
Type 0: Definition of Entries Use You can use this function to define input fields in the browser-based PI sheet [Page 15 ]8 or Process Manufacturing Cockpit [Page 406] in which you want someone to enter values.
In the PI sheet and cockpit, you can use input fields for the following:
To record specific actual values from the production environment •
•
•
In the PI sheet, you can also use input fields for the following additional functions:
To execute signatures that are to complete a process step in the PI sheet
To execute signatures that complete the entire PI sheet See also Completing Browser-Based PI Sheets [Page 178]
You can also define signatures that complete process instructions in cockpits but here Complete only means that process messages are created automatically.
You can use a process message to report the values the process operator has entered. See also Type 0: Definition of Message Creation [Page 423].
In addition, you can define the following functions for the value to be entered:
A default value •
•
•
•
An input validation
Prerequisites If you want to report the value entered, the characteristic that is marked as the input value must be contained in the message category.
Features The number of input fields to be created depends on the type of data request:
One input field is created for a simple data request.
A table column is created for a repeated data request.
If you do not enter a data request type, the system sets "simple data request" by default.
Activities When defining an input value, you specify the following information in the process instruction:
A text that is displayed before the corresponding input field or above the corresponding table column in the PI sheet or cockpit
•
April 2001 193
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Entries
The message characteristic whose value is made available as the default value for the input value in the PI sheet or cockpit See also Type 0: Definition of Default Values [Page 427]
•
A variable that refers to the input characteristic if you want to use the characteristic in another process instruction of the same process order
•
•
•
The message characteristic whose value you want to enter
If required, an input validation that is used to check the input value in the PI sheet or cockpit See also: Type 0: Definition of Input Validations [Page 429] Here you define one of the following functions:
− A check formula for numerical values
− A check function for all values
To enter this information, you assign the following characteristics to the process instruction in the order specified below:
Characteristic Meaning Value
PPPI_INPUT_REQUEST Input request Any short text
Default value < Numerical value < Alphanumerical value < Variable < Characteristic value
< PPPI_DEFAULT_VALUE or < PPPI_DEFAULT_STRING or < PPPI_DEFAULT_VARIABLE or < <Any message characteristic>
Default value: < Any numerical value < Any alphanumerical value < Existing variable name < According to characteristic definition See also: Type 0: Definition of Default Values [Page 427]
In PI sheets only: < PPPI_GLOBAL_VARIABLE (See also: Process Instructions for Process Manufacturing Cockpits [Page 416])
Input validation: Boolean formula (see Syntax of Check Formulas [Page 432]) Name of the function module See also: Type 0: Definition of Input Validations [Page 429]
Variable definition for value entered: < Variable
< PPPI_VARIABLE
Variable definition: < New variable name
< Global variable
< New variable name
PPPI_REQUESTED_VALUE Message characteristic whose value is assigned manually
Characteristics of the assigned message category
< PPPI_VALIDATION_FORMULA or < PPPI_VALIDATION_FUNCTION
Check formula Check function
> <Parameters for check function>
PPPI_TEXT_FOR_INVALID_INPUT
Long text for invalid entries
Any long text
194 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Entries
PPPI_ACCEPT_INVALID_INPUT Accepting invalid entries - Accept always - Accept never - Accept with signature only
In PI sheets only: PPPI_SIGNATURE_AUTHORIZATION
Authorization for signature
Any value for the Activity field in the authorization object C_CRPI_BER
In PI sheets only: PPPI_SIGNATURE_STRATEGY
Signature strategy
Signature strategy
A value can be assigned automatically to the characteristics for the date (PPPI_EVENT_DATE) and time (PPPI_EVENT_TIME) in the PI sheet. If you define these characteristics as input values, the system proposes the current values as possible entries in the PI sheet.
April 2001 195
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Default Values
Type 0: Definition of Default Values Use If a planned or target value is available for an input value, you can enter the planned or target value as a default value in the process instruction.
If you have defined default values for one or several input values, these default values are displayed in the corresponding input fields when you access the browser-based PI sheet [Page
] or the process manufacturing cockpit [Page 406]. You can change these default values. 158
Features You can enter a default value as follows in the process instruction:
As a constant value if it has already been specified in the process order or the cockpit definition
•
•
•
•
•
•
•
As a variable if it is only available in the PI sheet or cockpit
You can define constant default values as follows:
As a numerical value The data type of the characteristic that you want to request must then also be numerical.
As an alphanumerical value
As message characteristics
If you use a message characteristic to define constant default values, you can proceed as follows:
You can enter the required default value manually.
You can let the system assign the default value automatically. However, you can only use this option, if the settings required for automatic value assignment are made for the message characteristic in Customizing; see Process Instructions: Automatic Characteristic Value Assignment [Page 124].
Message category PI_PROD is assigned to a process data request. The following characteristics have been maintained in the process instruction for the input value Product quantity.
Number Characteristics Value
0070 PPPI_INPUT_REQUEST Product quantity:
0080 PPPI_MATERIAL_PRODUCED
0090 PPPI_REQUESTED_VALUE PPPI_MATERIAL_PRODUCED
Characteristic PPPI_MATERIAL_PRODUCED is defined as an input value in number 0090. In number 0080, this characteristic is used to define a constant default value for the input value. Since the planned order quantity is automatically assigned as the characteristic value, the planned value is proposed in the PI sheet.
196 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Default Values
You define variables as default values if you want to transfer the default value from another process instruction of the same process order or cockpit.
Activities You define constant default values in the process instruction by assigning one of the following characteristics after characteristic PPPI_INPUT_REQUEST:
Characteristic Meaning Value
< Numerical default value < Alphanumerical default value < Any message characteristic
< PPPI_DEFAULT_VALUE or < PPPI_DEFAULT_STRING or < <Any message characteristic>
< Numerical value < Alphanumerical value < According to characteristic definition, may also be automatically
You define variable as the default value in the process instruction by assigning the following characteristic after characteristic PPPI_INPUT_REQUEST:
Characteristic Meaning Value
PPPI_DEFAULT_VARIABLE Variable as a default value Variable name
April 2001 197
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Input Validations
Type 0: Definition of Input Validations Use When defining characteristics in Customizing, you can specify an allowed value range for each characteristic. The settings you make here apply to all process instructions and messages in which the characteristic is used.
If you want to restrict the value range even further for a specific input value, you can define an input validation for it in the process instruction. In the input validation, you determine:
Which validation rule is used to check the input value in the browser-based PI sheet [Page 158] or process manufacturing cockpit [Page 406]
•
• Whether invalid values are transferred to the PI sheet or cockpit and how this is done
Prerequisites • The following requirements must be met for both PI sheets and cockpits:
If you want to use a check function to check the input value, a suitable function module must have been created in the system.
To create or display function modules, go to Customizing for Process Management and choose Process Instructions -> Define PI Categories for R/3 PI Sheet Using Characteristic Overview -> Assign Characteristics to Dynamic Function Calls -> Create Function Modules for Dynamic Function Calls [Ext.].
•
−
−
The following requirements must only be met for PI sheets: If a signature must be entered to accept invalid input values in the PI sheet, you must specify in Customizing for Control Recipe Destinations which type of signature you want to use in the PI sheet. You have the following options:
Signature without a password check
Digital signature [Ext.]
If several individual signatures are to be executed, you also specify the signature strategy [Ext.] in the control recipe destination.
For more information about digital signatures and the required settings, see Approval Using Digital Signatures [Ext.].
The following requirements must only be met for cockpits: •
•
You can define Signatures without a password check in cockpits. Digital signatures may not be used.
Activities Validation Rule In the process instruction, you can define the validation rule for the input validation as follows:
As a check formula for numeric values
Characteristic Meaning Value
198 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Input Validations
PPPI_VALIDATION_FORMULA Check formula (max. 8 times) Boolean formula(see Syntax of check formulas [Page 432])
• As a check function for all values
Characteristic Meaning Value
PPPI_VALIDATION_FUNCTION Check function Function module name
You must include the parameters of the function module in the process instruction directly after the characteristic for the check function. For more information, see Type 0: Definition of Export Parameters [Page 44 ]9 .
Processing Invalid Input Values
•
•
•
In addition to the validation rule, you can also enter the following information to control how invalid input values are processed:
Warning If you enter an invalid value in the PI sheet, the system issues this warning in addition to the standard message.
Accept invalid values If you do not specify anything here, invalid values can be accepted without restrictions. You can define the following restrictions:
− Invalid values are not accepted
− Invalid values are only accepted with a signature
Depending on the settings made in the control recipe destination, the PI sheet requests a signature without a password, one digital signature, or several individual signatures defined in a signature strategy. In cockpits, you may only use signatures without a password. You must also enter a comment for digital signatures.
The input value is not reported automatically when the signature is executed. Once you have entered a correct value again, the system automatically accepts this value, which means you do not need to execute another signature.
Authorization to execute the signature For signatures without a password check or for digital signatures, you can specify that a user requires a special maintenance authorization for the PI sheet to execute the signature.
The system then checks if the activity specified in the process instruction has been included in authorization object C_CRPI_BER in the user master record.
Irrespective of the settings you make here, the system checks the following authorizations for digital signatures:
• Activity 73 (Archive) in authorization object C_CRPI_BER (PI sheet)
April 2001 199
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Input Validations
For individual signatures in a signature strategy, the authorization group for the individual signature in authorization object C_SIGN_BGR (authorization groups for digital signatures)
•
• Signature strategy for digital signatures in PI sheets You can define a signature strategy [Ext.] for digital signatures in PI sheets. This ensures that invalid values must be signed by several people. In the signature strategy, you specify which individual signatures are required. You can assign a signature strategy in the control recipe destination. This strategy is then used for all input validations. If you want to use a different strategy for a particular process instruction, you assign the strategy to this process instruction. The signature strategy must be carried out synchronously in the PI sheet. This means that the individual signatures must be executed immediately one after another.
Activities To enter this data in the process instruction, you assign the following characteristics immediately after the validation rule:
Characteristic Meaning Value
PPPI_TEXT_FOR_INVALID_INPUT Warning Long text (see also Using Text Symbols [Page 312])
PPPI_ACCEPT_INVALID_INPUT Invalid values are accepted
No Yes With signature only
PPPI_SIGNATURE_AUTHORIZATION Authorization required for signature without a password or digital signature
Any value for the Activity field in the authorization object C_CRPI_BER
In PI sheets only: PPPI_SIGNATURE_STRATEGY (See also Process Instructions for Process Manufacturing Cockpits [Page
])
Signature strategy (for digital signatures only)
Strategy defined in Customizing
416
200 April 2001
SAP AG Process Management (PP-PI-PMA)
Check Formula Syntax for Input Validations
Check Formula Syntax for Input Validations Check formulas in input validation must have the following syntax:
<relational expression><logical operator><relational expression>
Note the following:
•
•
• In relational expressions, you can use variable X for the input value.
•
• You can use variables to transfer numeric values of preceding process instructions to the check formula. For more detailed information see:
−
<rel.expression> = <arith.expression><rel.operator><arith.expression>
You can use the operators listed below.
You can enter any number of logical relationships in a check formula.
You must always use the decimal point for decimal numbers.
Using Variables in Browser-Based PI Sheets [Page 30 ]6
Using Variables in ABAP List-Based PI Sheets [Page 304] −
• In long formulas, you may use no more than 240 characters that can be separated in any number of lines.
Note that a blank character is automatically set at the end of each line. For this reason, make sure to write long number, variable names, or operators together in one line.
PPPI_VALIDATION_FORMULA x>50 AND x<100 OR PPPI_VALIDATION_FORMULA x<200 AND x>150
Logical Operators Meaning
AND Both of the linked expressions have to be true.
OR One of the linked expressions has to be true.
NOT The expressions following the operator must not be true.
Relational Operators Meaning
= Equal to
<= Less than or equal to
>= Greater than or equal to
April 2001 201
Process Management (PP-PI-PMA) SAP AG
Check Formula Syntax for Input Validations
<> Not equal to
>< Not equal to
< Less than
> Greater than
Arithmet. Operators Meaning
+ Plus
- Minus
* Multiplied by
/ Divided by
DIV Modulo division; division where the result is quoted as an integer
MOD Remainder after modulo division
ABS Absolute value
SIN Sine
COS Cosine
TAN Tangent
LOG Logarithm to base e
** To the power of
EXP Power to base e
SQRT Square root
ROUND Round to nearest integer
TRUNC Cut off decimals
202 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Export Parameters
Type 0: Definition of Export Parameters Use
Note that by export parameter we mean the export parameters of the PI sheet or cockpit (PPPI_EXPORT_PARAMETER), which are the values that are transferred from the PI sheet or cockpit to the function module. From the function module's point of view, they are import parameters.
You define export parameters (import parameters of the function module) in dynamic function calls and input validations that are carried out using a check function.
Prerequisites
•
If you want to pass on the value of a variable to the function module, the variable must be defined in the same PI sheet or in the same cockpit. For PI sheets, the variable may also have been defined for the entire process order.
For more information on how to use system variables and variables in general, see:
Using Variables in Browser-Based PI Sheets and Cockpits [Page 30 ]6
Using System Variables in Browser-Based PI Sheets [Page 309] •
Activities When defining export parameters, you specify the following information in the process instruction:
•
•
•
All required import parameters of the function module; Import parameters are required if the Optional indicator has not been set. They must be specified in the process instruction.
Optional import parameters of the function module for which you do not want to use the default value defined in the function module; Import parameters are optional if the Optional indicator has been set. They need not be specified in the process instruction.
If required, the characteristic optional parameter transfer for optional parameters whose value you do not want to pass on when the function call is executed; See also Type 0: Optional Parameter Transfer [Page 454].
The parameter name for each parameter to be passed on •
•
•
The variable, constant, or message characteristic for each parameter value to be passed on You can only pass on the value of a variable or constant to a parameter if the variable or constant has the same data type as the parameter in the function module.
Notes on Parameter Value Assignment
If the value is available in the process order, you enter it as a fixed value in the form of:
− A constant The characteristic you use to define the constant also determines the constant's data type.
April 2001 203
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Export Parameters
− A message characteristic If you want to use a message characteristic, the characteristic must have the same data type as the parameter in the function module. You may want to use a message characteristic if the characteristic value is assigned in the order.
•
• In input validations, you use variable SY_VALUE or X to transfer the input value to be checked. The variable always refers to the value entered immediately before.
Meaning
If the value is only available in the PI sheet, you transfer it from a preceding process instruction using a variable. The variable has the same data type as the value to which it refers. In the process instruction, you must assign the variable to the appropriate characteristic depending on the data type.
To enter this information, you assign the following characteristics to the process instruction in the order specified below:
Characteristic Allowed Values
PPPI_EXPORT_PARAMETER Export parameters Import parameters of the function module
< PPPI_STRING_CONSTANT or < PPPI_FLOAT_CONSTANT or < PPPI_DATE_CONSTANT or < PPPI_TIME_CONSTANT or
<
< PPPI_STRING_VARIABLE or < PPPI_FLOAT_VARIABLE or < PPPI_DATE_VARIABLE or < PPPI_TIME_VARIABLE or
< Alphanumerical value < Floating point number
Date < Time
Any fixed value of data type:
< Alphanumerical value < Floating point number < Date < Time
Existing variable of data type: < Alphanumerical value < Floating point number < Date < Time
Value transfer in constant:
Value transfer in variable: < Alphanumerical value < Floating point number < Date < Time
<Any message characteristic
For value assignment using message characteristic: < Message characteristic
< <Message characteristic>
PPPI_OPTIONAL_PARAMETER
Optional parameter transfer <Parameter transfer not optional <Parameter transfer optional
204 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Optional Parameter Transfer
Type 0: Optional Parameter Transfer Use You can assign characteristic PPPI_OPTIONAL_PARAMETER to parameters in dynamic function calls and input validations. As a result the parameter is not passed on to the function module unless a value has been assigned to it. The function module can be executed although the parameter value is missing.
Note the following: You may use characteristic PPPI_OPTIONAL_PARAMETER for optional parameters only. All required parameters must be specified in the process instructions and values must be assigned.
Activities If you want to call the function module even if no value has been assigned to a parameter, add characteristic PPPI_OPTIONAL_PARAMETER directly after the variable or constant for the parameter of the function module.
You assign the following characteristics in the process instruction in the sequence specified below:
Characteristic Meaning Allowed Values
<Parameter characteristic> Parameter of the function module
Optional import or changing parameter of the function module
Characteristic for the variable/constant that has the same data type as the parameter
Variable for the parameter value
New variable or constant
PPPI_OPTIONAL_PARAMETER Optional parameter transfer Optional parameter transfer
April 2001 205
Process Management (PP-PI-PMA) SAP AG
Definition of Signatures in PI Sheets
Definition of Signatures in PI Sheets Use If you want to sign data in the PI sheet, you define a process data request with a signature. You have the following options:
• Signature to accept invalid input values
In this case, you define the signature as part of an input validation. You only enter a signature in the PI sheet, if you want to accept an input value although it is outside the defined value range.
• Signature to complete a process step
In this case, you add the signature as an input value into the usual sequence of steps in the PI sheet. The entries and formula results of the relevant process step are reported when the signature is entered, that is, the corresponding messages are transferred to process management for sending. After this, you cannot change the values anymore.
• Signature to sign/complete the PI sheet
Technically speaking, the signature is identical to the signature that is used to sign a process step. However, it is executed at the end of the PI sheet after all process steps have been completed.
In ABAP list-based PI sheets, you can use any type of signature for this. By executing the signature, you only confirm that the data is complete and correct.
In browser-based PI sheets, you must use the digital signature [Ext.] with a signature strategy [Ext.] and an asynchronous signature process (see below). The PI sheet is completed automatically when the signature process is completed.
For statements concerning quality in the manufacturing process, you can enter a comment. If the corresponding Customizing settings are made, the comment is transferred to the batch record and can be used as a basis for the usage decision.
Prerequisites The type of signature to be used in the PI sheet has been defined in Customizing for Control Recipe Destinations.
You have the following options:
•
•
• Digital signature [Ext.]
Signature without a password check
Signature with a simple password check
You can use this type of signature for ABAP list-based PI sheets only. You define the passwords for the relevant users in Customizing for Control Recipe Destinations.
If several individual signatures are to be executed, you can also specify the following in the control recipe destination:
− Which signature strategy [Ext.] is to be used to sign process steps and PI sheets
Which signature strategy is used to accept invalid input values −
206 April 2001
SAP AG Process Management (PP-PI-PMA)
Definition of Signatures in PI Sheets
For more information about digital signatures and the required settings, see Approval Using Digital Signatures [Ext.].
If you want to use signatures to complete browser-based PI sheets, you must use digital signatures.
Features Signatures for Invalid Input Values You define these signatures if you define input validations. For more information, see: Type 0: Definition of Input Validations [Page 42 ]9 Type 2: Definition of Input Validations [Page 24 ]6
Signature for Process Step / PI Sheet You define these signatures as input values in a process data request. The structure rules for this process instruction are identical to that of all other data requests. See also: Type 0: Definition of Data Requests [Page 421] Type 2: Process Data Requests for PI Sheets [Page 231] Note the following:
• Type of data request You can define one signature for each data request. Depending on the data request, the signature is processed differently.
− In a simple data request, you use signatures to complete the preceding entries and calculations since the last signature. If a signature is preceded by a table, you cannot enter more table entries once the signature has been executed.
− In repeated data requests, signatures must be positioned in the last table column, that is, you must define the signature as the last input value of the process instruction. You use signatures to complete the preceding table entries. However, you can still enter more table entries as long as the maximum number of table lines has not been reached.
• Message category
You must assign a message category that contains characteristic PPPI_SIGNATURE to the process instruction.
Note that in repeated data requests you must enter a signature for every table line if the signature is marked as required in the message category.
• Input value for the signature
You must define characteristic PPPI_SIGNATURE as an input value in the process instruction.
The characteristic is transferred to the message that the system creates for the process instruction. The following value is assigned to the characteristic:
− If only one signature or one digital signature is executed: the signature or name of the signatory
April 2001 207
Process Management (PP-PI-PMA) SAP AG
Definition of Signatures in PI Sheets
− If signatures that consist of several individual digital signatures are executed: the key of the corresponding signature strategy You can display the signatures in the PI sheet.
• Authorization to execute a signature For the following types of signature, you can specify that a user requires a special maintenance authorization for the PI sheet to execute the signature.
− In browser-based PI sheets:
• For signatures without a password
• For digital signatures
− In ABAP list-based PI sheets:
• For signatures with a simple password check
• For digital signatures
The system then checks if the activity specified in the process instruction has been included in authorization object C_CRPI_BER in the user master record.
Irrespective of the settings you make here, the system checks the following authorizations for digital signatures:
– Activity 73 (Archive) in authorization object C_CRPI_BER (PI sheet)
– For individual signatures in a signature strategy, the authorization group for the individual signature in authorization object C_SIGN_BGR (authorization groups for digital signatures)
• Signature strategy for digital signatures
If several users must sign a process step, you use a signature strategy [Ext.] to define which individual signatures are required. You can assign a signature strategy in the control recipe destination. This strategy is then used for all process steps or for all input validations. If you want to use a different strategy for a particular process instruction, you assign the strategy to this process instruction.
If you want to use signatures to complete browser-based PI sheets, you must use a signature strategy.
• Synchronous or asynchronous signature process
In the PI sheet, signature strategies are carried out synchronously by default. This means that all signatures must be executed immediately one after another without exiting the function.
However in process instructions that are used to sign the entire PI sheet, you can determine that the signature strategy is carried out asynchronously. The system stores the signatures individually. The PI sheet can be exited after each individual signature and can be called again by the next signatory.
208 April 2001
SAP AG Process Management (PP-PI-PMA)
Definition of Signatures in PI Sheets
If you want to use signatures to complete browser-based PI sheets, you must use the asynchronous signature process.
To define the data for the signature, you assign the following characteristics in the process instruction:
Characteristic Meaning Value
PPPI_INPUT_REQUEST Input request Any short text
PPPI_REQUESTED_VALUE Input value PPPI_SIGNATURE
PPPI_SIGNATURE_ AUTHORIZATION
Required authorization (only for signatures with a password check and digital signatures)
Any value for the Activity field in the authorization object C_CRPI_BER
PPPI_SIGNATURE_STRATEGY Signature strategy (for digital signatures only)
Strategy defined in Customizing
PPPI_SIGNATURE_MODE Synchronous or asynchronous signature process (only for signing / completing PI sheets with a signature strategy)
S (synchronous) A (asynchronous)
April 2001 209
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Output Fields for Characteristic Values
Type 0: Definition of Output Fields for Characteristic Values Use You can use this function in the browser-based PI sheet [Page 158] or process manufacturing cockpit [Page 406] to display characteristic values that are usually processed in the background (such as planned values for input values).
Features You can display the following characteristic values in a PI sheet:
Values of message characteristics that have been assigned in the process instruction •
•
•
•
The date and time that is assigned automatically as the characteristic value of PPPI-EVENT_DATE and PPPI_EVENT_TIME in the PI sheet or cockpit
Planned values for input values, provided that the planned values have been defined as default values in the process instruction
Long texts with control information and notes that are used as values of long text characteristics such as PPPI_INSTRUCTION and PPPI_NOTE
Unlike Type 1: process parameter, you must explicitly specify that characteristics PPPI_INSTRUCTION and PPPI_NOTE are characteristics to be output in process instructions of type 0.
In addition to the characteristic value to be displayed, you also specify a text in the process instruction. In the PI sheet or cockpit, this text is processed as follows:
In simple data requests, the text is displayed before the output value. •
• In repeated data requests, you must define a text for every output value. The text is displayed above the relevant table column.
Activities In the process instruction, you define a characteristic value after the input value after which you want to display it in the PI sheet or cockpit. To do so, you assign the following characteristics to the process instruction:
Characteristic Meaning Allowed Values
PPPI_OUTPUT_TEXT Text that is displayed before the output values to follow
Any short text
PPPI_OUTPUT_CHARACTERISTIC
Characteristic whose value is displayed in the PI sheet or cockpit
Message characteristic to be displayed
210 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Output Fields for Characteristic Values
In the case of text characteristics (such as PPPI_OUTPUT_TEXT), you can insert the value of another characteristic into this text using a text symbol; see Text Symbols in Characteristic Texts [Page 312].
April 2001 211
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Output Fields for Variable Values
Type 0: Definition of Output Fields for Variable Values Use You can use this function in the browser-based PI sheet [Page 158] or in the process manufacturing cockpit [Page 406] to display values defined as variables that are usually processed in the background (such as variable values from calculation formulas).
Prerequisites You can display the value of a variable in the process instruction if the variable has been defined as follows::
In one of the preceding process instructions •
•
•
In the same process instruction
In one of the succeeding process instructions
For more information, see Using Variables in Browser-Based PI Sheets and Cockpits [Page 30 ]6 .
Activities In the process instruction, you define a variable value after the input value after which you want to display it in the PI sheet or cockpit. To do so, you assign the following characteristics to the process instruction:
Characteristic Meaning Allowed Values
PPPI_OUTPUT_TEXT Text displayed before the output values to follow Any short text
PPPI_OUTPUT_VARIABLE Variable whose value is to be displayed Variable name
212 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Calculations
Type 0: Definition of Calculations
Use You can use this function to perform calculations in the browser-based PI sheet [Page 158] or process manufacturing cockpit [Page 406]. You can, for example, calculate the total quantity of a material consumed in all phases. You can then use a process message to report the calculated value. You can define a variable to pass on the calculated values to a function module, for example.
Activities When defining calculations, you specify the following information in the process instruction:
•
•
•
•
A text to be displayed before the calculated value in the PI sheet or cockpit
If required, a variable that refers to the characteristic to be calculated
The message characteristic whose value you want to calculate
The calculation formula to be used to calculate the value
To enter this information, you assign the following characteristics to the process instruction in the order specified below:
Characteristic Meaning Allowed Values
PPPI_INPUT_REQUEST Text displayed before the formula result
Any short text
< PPPI_VARIABLE In PI sheets only: < PPPI_GLOBAL_VARIABLE
Variable definition for value calculated:< Variable < Global variable
New variable name see: Definition of Variables [Page 302]
Arithmetic expression; see: Syntax [Page 442]
PPPI_CALCULATED_VALUE Message characteristic to be calculated
Message characteristic
PPPI_CALCULATION_FORMULA
Calculation formula
In the case of text characteristics (such as PPPI_INPUT_REQUEST), you can insert the value of another characteristic into this text using a text symbol; see Text Symbols in Characteristic Texts [Page 312].
April 2001 213
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Calculations
214 April 2001
SAP AG Process Management (PP-PI-PMA)
Syntax in Process Data Calculation Formulas
Syntax in Process Data Calculation Formulas When defining your formula, note the following:
Always use the decimal point for decimal numbers. •
• You can use variables to transfer numeric values of preceding process instructions to the formula. For more information, see Use of Variables in Process Instructions [Page 304].
• In long formulas, you may use no more than 240 characters that can be separated in any number of lines.
Note that a blank character is automatically set at the end of each line. For this reason, make sure to write long number, variable names, or operators together in one line.
PPPI_CALCULATION_FORMULA (-B+SQRT(B**2- PPPI_CALCULATION_FORMULA (4*A*C)))/(2*A)
Arithmet. Operators Meaning
+ Plus
- Minus
* Multiplied by
/ Divided by
DIV Modulo division; division where the result is quoted as an integer
MOD Remainder after modulo division
ABS Absolute value
SIN Sine
COS Cosine
TAN Tangent
LOG Logarithm to base e
** To the power of
EXP Power to base e
SQRT Square root
ROUND Round to nearest integer
TRUNC Cut off decimals
April 2001 215
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Automatic Value Assignment
Type 0: Definition of Automatic Value Assignment Use You can use this function to determine the point of time (date and time) at which a process instruction was processed in the browser-based PI sheet [Page 15 ]8 or in the process manufacturing cockpit [Page 406]. In a process instruction, you can automatically assign a value to the date and time once for each message category block.
Features You can automatically assign the date or time as values to the following standard characteristics:
•
• PPPI_EVENT_TIME: time of the event
The system determines the date and time when you maintain the process instruction in the PI sheet.
•
PPPI_EVENT_DATE: date of the event
Activities When defining automatic value assignment, you specify the following information in the process instruction:
A variable that refers to the characteristic whose value is to be assigned automatically if you want to use the date and time in another process instruction of the same process order
Note that you may use global variables in PI sheets only.
The message characteristic whose value is to be assigned automatically •
• The characteristic PPPI_OUTPUT_CHARACTERISTIC that you can use to display the date and time in the PI sheet
You can also mark the date and time as input values. The system then proposes the current date and time in the possible entries. Unlike automatic value assignment, however, you can still change the value.
To enter this information, you assign the following characteristics to the process instruction in the order specified below:
Characteristic Meaning Value
Variable definition for the characteristic whose value is to be assigned automatically < PPPI_VARIABLE In PI sheets only: < PPPI_GLOBAL_VARIABLE
Variable Global variable
New variable name New variable name
216 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Automatic Value Assignment
PPPI_AUTOMATIC_VALUE Message characteristic whose value is to be assigned automatically
PPPI_EVENT_DATE PPPI_EVENT_TIME
Characteristic to be output
PPPI_OUTPUT_CHARACTERISTIC
PPPI_EVENT_DATE PPPI_EVENT_TIME
April 2001 217
Process Management (PP-PI-PMA) SAP AG
Type: Definition of Value Assignment Using Variables
Type: Definition of Value Assignment Using Variables Use You can use this function to transfer the value of a message characteristic that has been defined as a variable from one process instruction to another process instruction. In this way, you ensure that the current value is always passed on to the other process instruction in message characteristics whose values can constantly be changed (for example, by entries).
In this case, the variable value is not displayed as a default value, which means that you cannot change it in the browser-based PI sheet [Page 158] or process manufacturing cockpit [Page 406].
Activities When defining value assignment using variables, you specify the following information in the process instruction:
•
•
To enter this information, you assign the following characteristics to the process instruction in the order specified below:
Characteristic
The variable to be assigned to the message characteristic
The message characteristic whose value is to be obtained from a variable
Meaning Allowed Values
PPPI_EXTERNAL_VALUE Message characteristic whose value is to be assigned using variable
Message characteristic
PPPI_DEFAULT_VARIABLE
Variable to be assigned to the message characteristic
Variable name, see Using Variables in Browser-Based PI Sheets and Cockpits [Page 306]
218 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Dynamic Function Calls
Type 0: Definition of Dynamic Function Calls Use You can use this function to call certain R/3 functions from within the PI sheet or perform certain calculations and checks in the PI sheet. ABAP function calls that have been created for the corresponding use are used for the function call.
Prerequisites The function module to be called must exist and be active in the Function Builder (ABAP Development Workbench).
Features The standard system contains a number of predefined function modules that you can use in function calls. You can also create your own function modules.
To create or display function modules, go to Customizing for Process Management and choose Process Instructions -> Define PI Categories for R/3 PI Sheet Using Characteristic Overview -> Assign Characteristics to Dynamic Function Calls -> Create Function Modules for Dynamic Function Calls [Ext.].
The following table provides an overview of the function modules that you can define as dynamic function calls:
Function Function Module
Calling of any transaction COPF_CALL_TRANSACTION
Order confirmation for phases COPF_ENTER_CONFIRMATION
Displaying of material quantity calculation in the order
COPF_MATERIAL_QUANTITY_CALC
Displaying of documents created in the R/3 document management system
COPF_DOCUMENT_SHOW_DIRECT
Calculating of the duration of time intervals COPF_DETERMINE_DURATION
Calculating of the start date of a time interval COPF_DETERMINE_START_TIME
Calculating of the end date of a time interval COPF_DETERMINE_END_TIME
Creating of physical-sample records for quality inspections during production
QPRS_PI_NEW_SAMPLE_DRAW
Processing of sample drawing (for example, release/lock physical sample)
QPRS_PI_SAMPLE_DRAW_PROCESSING
COPFX_QM_INSPECTION_RESULT_REC
Sample function module for check function COPF_VALIDATION_FUNCTION_TEST
Recording of inspection results in QM
Activities When defining dynamic function calls, you specify the following information in the process instruction:
April 2001 219
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Dynamic Function Calls
•
•
•
• The parameters defined in the function module
The name of the function module you want to call
Any short text to be displayed on the pushbutton
The characteristic that specifies whether the function can be called when the PI sheet is displayed
To enter this information, you assign the following characteristics to the process instruction in the order specified below:
Characteristic Meaning Value
Name of a function module Name of the function module you want to call
PPPI_BUTTON_TEXT Text for pushbutton Any short text
PPPI_FUNCTION_DURING_ DISPLAY
Specifies whether the function can be called when the PI sheet is displayed
"0" = not allowed "1" = allowed
< <Export parameters> < <Changing parameters> < <Import parameters>
Parameters according to definition in function module: < Export parameters < Changing parameters < Import parameters
Parameters of the function module < Import parameters < Changing parameters < Export parameters
PPPI_FUNCTION_NAME
For more information on how to define the parameters of the function module in the process instruction, see:
Type 0: Definition of Export Parameters [Page 449] •
Type 0: Definition of Changing Parameters [Page 45 ]1 •
Type 0: Definition of Import Parameters [Page 452] •
220 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Export Parameters
Type 0: Definition of Export Parameters Use
Note that by export parameter we mean the export parameters of the PI sheet or cockpit (PPPI_EXPORT_PARAMETER), which are the values that are transferred from the PI sheet or cockpit to the function module. From the function module's point of view, they are import parameters.
You define export parameters (import parameters of the function module) in dynamic function calls and input validations that are carried out using a check function.
Prerequisites If you want to pass on the value of a variable to the function module, the variable must be defined in the same PI sheet or in the same cockpit. For PI sheets, the variable may also have been defined for the entire process order.
For more information on how to use system variables and variables in general, see:
Using Variables in Browser-Based PI Sheets and Cockpits [Page 306] •
Using System Variables in Browser-Based PI Sheets [Page 309] •
Activities When defining export parameters, you specify the following information in the process instruction:
All required import parameters of the function module; Import parameters are required if the Optional indicator has not been set. They must be specified in the process instruction.
•
•
•
Optional import parameters of the function module for which you do not want to use the default value defined in the function module; Import parameters are optional if the Optional indicator has been set. They need not be specified in the process instruction.
If required, the characteristic optional parameter transfer for optional parameters whose value you do not want to pass on when the function call is executed; See also Type 0: Optional Parameter Transfer [Page 454].
The parameter name for each parameter to be passed on •
•
•
The variable, constant, or message characteristic for each parameter value to be passed on You can only pass on the value of a variable or constant to a parameter if the variable or constant has the same data type as the parameter in the function module.
Notes on Parameter Value Assignment
If the value is available in the process order, you enter it as a fixed value in the form of:
− A constant The characteristic you use to define the constant also determines the constant's data type.
April 2001 221
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Export Parameters
− A message characteristic If you want to use a message characteristic, the characteristic must have the same data type as the parameter in the function module. You may want to use a message characteristic if the characteristic value is assigned in the order.
If the value is only available in the PI sheet, you transfer it from a preceding process instruction using a variable. The variable has the same data type as the value to which it refers. In the process instruction, you must assign the variable to the appropriate characteristic depending on the data type.
•
• In input validations, you use variable SY_VALUE or X to transfer the input value to be checked. The variable always refers to the value entered immediately before.
To enter this information, you assign the following characteristics to the process instruction in the order specified below:
Characteristic Meaning Allowed Values
PPPI_EXPORT_PARAMETER Export parameters Import parameters of the function module
< PPPI_STRING_CONSTANT or < PPPI_FLOAT_CONSTANT or < PPPI_DATE_CONSTANT or < PPPI_TIME_CONSTANT or
< PPPI_STRING_VARIABLE or < PPPI_FLOAT_VARIABLE or < PPPI_DATE_VARIABLE or < PPPI_TIME_VARIABLE or
< <Message characteristic>
Value transfer in constant:
< Alphanumerical value < Floating point number < Date < Time
Value transfer in variable: < Alphanumerical value < Floating point number < Date < Time
For value assignment using message characteristic: < Message characteristic
Any fixed value of data type:
< Alphanumerical value < Floating point number < Date < Time
Existing variable of data type: < Alphanumerical value < Floating point number < Date < Time
<Any message characteristic
PPPI_OPTIONAL_PARAMETER
Optional parameter transfer <Parameter transfer not optional <Parameter transfer optional
222 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Changing Parameters
Type 0: Definition of Changing Parameters Use You define changing parameters in dynamic function calls. To the changing parameter, you assign the variable whose value you want to transfer from the PI sheet or the process manufacturing cockpit to the function module. After the function has been executed, the parameter value is returned to this variable and transferred to the PI sheet or cockpit.
You can display the variable in the PI sheet or cockpit. You can use the variable to transfer the value to succeeding process instructions of the same PI sheet or the same cockpit. However, note the following:
The function can be carried out more than once in the PI sheet. •
•
•
The function may change the parameter value.
Prerequisites If you want to pass on the value of a variable to the function module or transfer it from the function module to the PI sheet or cockpit, the variable must be defined in the same PI sheet or cockpit. With PI sheets, the variable may also have been defined or for the entire process order.
For more information on how to use system variables and variables in general, see:
Using Variables in Browser-Based PI Sheets and Cockpits [Page 306]
Using System Variables in Browser-Based PI Sheets [Page 309] •
Activities When defining changing parameters, you specify the following information in the process instruction:
All required changing parameters of the function module; Changing parameters are required if the Optional indicator has not been set. They must be specified in the process instruction.
•
•
•
Optional changing parameters of the function module for which you do not want to use the default value defined in the function module; Changing parameters are optional if the Optional indicator has been set.
If required, the characteristic optional parameter transfer for optional parameters whose value you do not want to pass on when the function call is executed; See also Type 0: Optional Parameter Transfer [Page 454].
The parameter name for each parameter to be passed on •
• The variable for each parameter value to be passed on; You can only pass on the value of a variable to a parameter if it has the same data type as the parameter in the function module.
To enter this information, you assign the following characteristics to the process instruction in the order specified below:
Characteristic Meaning Allowed Values
April 2001 223
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Changing Parameters
PPPI_CHANGING_PARAMETER
Changing parameters Changing parameters of the function module
< PPPI_STRING_VARIABLE or < PPPI_FLOAT_VARIABLE or < PPPI_DATE_VARIABLE or < PPPI_TIME_VARIABLE
Value transfer in variable: < Alphanumerical value < Floating point number < Date < Time
Variable of data type: < Alphanumerical value < Floating point number < Date < Time
PPPI_OPTIONAL_PARAMETER Optional parameter transfer <Parameter transfer not optional <Parameter transfer optional
If you want to display the variable value in the PI sheet or cockpit, you must define an output field. For more information, see Type 0: Definition of Output Fields for Variable Values [Page 439] .
224 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Import Parameters
Type 0: Definition of Import Parameters Use
Note that by import parameters we mean the import parameters of the PI sheet or cockpit (PPPI_IMPORT_PARAMETER), this means, the values that are transferred from the function module to the PI sheet or cockpit. From the function module's point of view, they are export parameters.
You define import parameters (export parameters of the function module) in dynamic function calls. To the import parameter, you assign the variable whose value you want to transfer from the function module to the PI sheet or cockpit.
You can display the variable in the PI sheet or cockpit. You can also use the variable to transfer the value to succeeding process instructions of the same PI sheet or cockpit. Note, however, that the function may be carried out more than once in the course of PI sheet or cockpit maintenance.
Prerequisites If you want to transfer the value of a variable from the function module to the PI sheet or cockpit, the variable must be defined in the same PI sheet or cockpit. With PI sheets, the variable may also have been defined for the entire process order.
For more information on how to use system variables and variables in general, see:
Using Variables in Browser-Based PI Sheets and Cockpits [Page 306] •
Using System Variables in Browser-Based PI Sheets [Page 309] •
Activities When defining import parameters, you specify the following information in the process instruction:
The export parameters of the function module •
• If required, the characteristic optional parameter transfer for optional parameters whose value you do not want to pass on when the function call is executed; See also Type 0: Optional Parameter Transfer [Page 454].
The parameter name for each parameter to be passed on •
• The variable for each parameter value to be passed on; You can only pass on the value of a variable to a parameter if it has the same data type as the parameter in the function module.
To enter this information, you assign the following characteristics to the process instruction in the order specified below:
Characteristic Meaning Allowed Values
PPPI_IMPORT_PARAMETER Import parameters Export parameters of the function module
April 2001 225
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Import Parameters
< PPPI_STRING_VARIABLE or < PPPI_FLOAT_VARIABLE or < PPPI_DATE_VARIABLE or < PPPI_TIME_VARIABLE
Value transfer in variable:< Alphanumerical value < Floating point number < Date < Time
Variable of data type: < Alphanumerical value < Floating point number < Date < Time
PPPI_OPTIONAL_PARAMETER
Optional parameter transfer
<Parameter transfer not optional <Parameter transfer optional
If you want to display the variable value in the PI sheet or cockpit, you must define an output field. For more information, see Type 0: Definition of Output Fields for Variable Values [Page 439].
226 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Optional Parameter Transfer
Type 0: Optional Parameter Transfer Use You can assign characteristic PPPI_OPTIONAL_PARAMETER to parameters in dynamic function calls and input validations. As a result the parameter is not passed on to the function module unless a value has been assigned to it. The function module can be executed although the parameter value is missing.
Note the following: You may use characteristic PPPI_OPTIONAL_PARAMETER for optional parameters only. All required parameters must be specified in the process instructions and values must be assigned.
Activities If you want to call the function module even if no value has been assigned to a parameter, add characteristic PPPI_OPTIONAL_PARAMETER directly after the variable or constant for the parameter of the function module.
You assign the following characteristics in the process instruction in the sequence specified below:
Characteristic Meaning Allowed Values
<Parameter characteristic> Parameter of the function module
Optional import or changing parameter of the function module
Characteristic for the variable/constant that has the same data type as the parameter
Variable for the parameter value
New variable or constant
PPPI_OPTIONAL_PARAMETER Optional parameter transfer Optional parameter transfer
April 2001 227
Process Management (PP-PI-PMA) SAP AG
Type 1: Process Parameters for PI Sheets
Type 1: Process Parameters for PI Sheets Use You can define the following information in a process parameter [Ext.] by assigning characteristics:
• Control information displayed on the overview screen of the PI sheet
• Additional notes displayed in the PI sheet on one or more detail screens
The individual elements are displayed in the PI sheet in the following sequence:
1. All long texts according to their sort numbers
2. All other control information according to sort number
3. Pushbuttons for calling up the notes
Features Control Information [Page 229]
Process Parameter: Notes [Page 230]
228 April 2001
SAP AG Process Management (PP-PI-PMA)
Control Information
Control Information Use In process parameters, you have two options for defining control information that is to be displayed on the overview screen of the PI sheet:
• Information can be entered manually in the process instruction (usually as a long text).
• Information which is already available somewhere else in the system (for example, an operation text from an order or material data from the material list) can be obtained via automatic assignment of characteristic values in the process order.
Assign one or more of the following characteristics to suit your requirements:
Characteristic Meaning Value
PPPI_INSTRUCTION Text with control information (overview screen)
Any long text, entered manually in the process instruction
Any other characteristics According to characteristic definition, entered manually or automatically
The characteristic PPPI_INSTRUCTION can be used several times in a process parameter.
In the PI sheet, the short texts of the characteristics are displayed before the characteristic values or texts.
If the value of a characteristic is a long text or a short text, you can insert the value of another characteristic into this text using a text symbol; see Text Symbols Within Characteristic Texts [Page 312].
April 2001 229
Process Management (PP-PI-PMA) SAP AG
Process Parameter: Notes
Process Parameter: Notes Use In a process parameter, additional information can be defined as a note. In the PI sheet, notes are displayed on one or more detail screens which you can call up from the overview using pushbuttons.
Features By default, the system will offer the pushbutton Note which can be used to display all notes for a control instruction on the same detail screen. If you want to group your notes and display them on separate detail screens, you can define texts for further pushbuttons in the process instruction. In the PI sheet, the notes following the definition of a text can be accessed using the corresponding button.
Assign the following characteristics:
Characteristic Meaning Value
PPPI_BUTTON_TEXT Text for pushbutton Any short text
PPPI_NOTE Note Any long text (detail screen)
You can define any number of notes and pushbuttons in a process parameter. The texts are displayed on the detail screens in the sequence in which they are defined.
If the value of a characteristic is a long text or a short text, you can insert the value of another characteristic into this text using a text symbol; see Text Symbols Within Characteristic Texts [Page 312].
230 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 2: Process Data Requests for PI Sheets
Type 2: Process Data Requests for PI Sheets Use The following graphic shows the structure overview of a process data request [Ext.] for the R/3 PI sheet. For more detailed information on the individual structure elements, see the sections below.
Process data request
Type of data request
Value is assigned in planning
Message characteristics
Value is assigned automatically in the PI sheet
Value is assigned manually in the PI sheet
Value is assigned in the PI sheet using variables
Output values
either/or
Message category
Features Types of Process Data Requests [Page 232]
Requested Message Category [Page 233]
Message Characteristics in Process Data Requests [Page 234]
Output Values [Page 260]
April 2001 231
Process Management (PP-PI-PMA) SAP AG
Types of Process Data Requests
Types of Process Data Requests Use In process data requests for R/3 PI sheets, you first need to specify the type of the process data request. You can choose one of the following types:
• Simple data request: In this case, you can request one message of a specific message category. In the PI sheet, individual entry fields are provided for the message data to be specified.
• Repeated data request: In this case, you can request several messages of different categories. In the PI sheet, several messages can be created for every message category requested. The message data to be recorded is maintained in a table.
In the case of repeated data requests you also have the following options:
• Minimum number of table lines: You can specify the minimum number of table lines required in the table in which you maintain the requested values. In the PI sheet, you can only sign the corresponding processing step after these lines have been filled in.
• Maximum number of table lines: You can specify the maximum number of lines permitted. If these lines have been filled in, the system will not offer another line in the PI sheet.
Assign the following characteristics to suit your requirements:
Characteristic Meaning Allowed values
PPPI_DATA_REQUEST_TYPE Data request type SIMPLE REPEATED
PPPI_MINIMUM_TABLE_SIZE Minimum number of table lines Any number
PPPI_MAXIMUM_TABLE_SIZE Maximum number of table lines Any number
232 April 2001
SAP AG Process Management (PP-PI-PMA)
Requested Message Category
Requested Message Category Use In every process data request, you need to specify the message category of the message you want to send.
Assign the following characteristic:
Characteristic Meaning Allowed values
PPPI_MESSAGE_CATEGORY Message category Any message category
In the case of repeated data requests, you can specify several message categories by assigning this characteristic repeatedly.
April 2001 233
Process Management (PP-PI-PMA) SAP AG
Message Characteristics in Process Data Requests
Message Characteristics in Process Data Requests Use A process data request for a PI sheet must contain the following message characteristics:
• All required characteristics of the requested message category
• All optional characteristics which are to be included in the message
The definition of the message characteristics directly follows the corresponding message category in the data request.
How you need to assign the message characteristics to the data request depends on the way in which they are to be processed, that is, whether their values are to be assigned
• In planning
• Automatically in the PI sheet
• Manually in the PI sheet
• Using a variable defined in the PI sheet
You can define the message characteristics in any sequence. However, the process instruction characteristics pertaining to a message characteristic must be defined in the sequence described in the corresponding section below.
• A process data request can only contain either message characteristics whose value is
assigned manually in the PI sheet, or message characteristics to which the value of a variable is assigned.
• If a process data request does not contain message characteristics whose values are to be assigned manually, the data request is not displayed in the PI sheet. The message for the “hidden” data request is created and sent automatically when you send the message for the preceding data request or process data calculation formula.
Features The process data request comprises the following functions:
Message Characteristics: Value Assignment in Planning [Page 235] •
Message Characteristics: Automatic Value Assignment [Page 236] •
Message Characteristics: Manual Value Assignment [Page 237] •
• Message Characteristic: Value Assignment Using Variable [Page 258]
234 April 2001
SAP AG Process Management (PP-PI-PMA)
Message Characteristics: Value Assignment in Planning
Message Characteristics: Value Assignment in Planning Use You assign characteristic values that are available during planning when you maintain the process instruction in Customizing, the master recipe, or process order. When you maintain a process instruction in the PI sheet, the system automatically copies the message characteristics whose values have been assigned in planning to the process message.
Features Basic Functions You assign message characteristics whose values are assigned in planning directly to the process instruction.
When assigning the characteristic value, you have the following options:
You can enter the required value manually. •
• If the value has been entered elsewhere in the process order (for example, the phase or material number), it can be transferred to the process instruction by automatic value assignment when you create the control recipe. However, you can only use this option if the settings for automatic value assignment have been made for the message characteristic in Customizing: see Process Instructions: Automatic Characteristic Value Assignment [Page 124].
See also:
• Process Data Request / Message Category - Example [Page 257]
• Process Data Calculation Formula / Message Category - Example [Page 274]
Additional Functions You cannot change characteristic values that have been assigned in planning in the PI sheet. However, you can display the characteristic value in the PI sheet if you also mark the characteristic as an output value; see Output Values [Page 260].
If you want to use the characteristic value in one of the succeeding process instructions of the same process order, you can define a variable that refers to the message characteristic; see Definition of Variables [Page 244].
April 2001 235
Process Management (PP-PI-PMA) SAP AG
Message Characteristics: Automatic Value Assignment
Message Characteristics: Automatic Value Assignment Use The system can determine the date and time when a process message was created in the PI sheet. If you want to transfer these values directly to the process message, you set the indicator for automatic value assignment for the corresponding message characteristics in the process instruction.
Features Basic Functions The system can only automatically assign the date or time to the standard characteristics PPPI_EVENT_DATE and PPPI_EVENT_TIME.
You allocate the characteristics whose values are assigned automatically to the process instruction as follows:
Characteristic Meaning Value
PPPI_AUTOMATIC_VALUE Characteristic value to be assigned automatically
PPPI_EVENT_DATE PPPI_EVENT_TIME
The system determines the date and time when you maintain the process instruction in the PI sheet.
See also: Process Data Request / Message Category - Example [Page 257]
Process Data Calculation Formula / Message Category - Example [Page 274]
Additional Functions You cannot change characteristic values that have been assigned automatically in the PI sheet. However, you can display the message value in the PI sheet if you also mark the characteristic as an output value, see Output Values [Page 260].
If you want to use the date or time in one of the succeeding process instructions of the same process order, you can define a variable that refers to the message characteristic; see Definition of Variables [Page 244].
In process data requests, you can also mark the date and time as input values. The system then proposes the current date and time in the possible entries. Unlike automatic value assignment, however, you can still change the value.
236 April 2001
SAP AG Process Management (PP-PI-PMA)
Message Characteristics - Manual Value Assignment
Message Characteristics - Manual Value Assignment Use If you want to assign a characteristic value manually in the PI sheet, you mark the characteristic as an input value in the process data request. You also specify how the input value is processed in the PI sheet, that is, whether the system offers a default value or whether an input validation should take place.
In the PI sheet, the system creates an input field or - in repeated data requests - a table column for the input value.
You also define signatures that you use to sign a process step in the PI sheet as input values. For more information, see Definition of Signatures [Page 263].
Prerequisites The characteristic you mark as an input value must be contained in the message category that is assigned to the process instruction.
Features In general, you can define any message characteristic as an input characteristic in a process data request. However, note the following restrictions with respect to repeated process data requests:
• No more than 10 input values with a total of up to 150 characters are allowed, that is, the input table can have a maximum of 10 columns or a maximum table width of 150 characters.
• Input characteristics whose value is a long text may only be used in simple data request.
Basic Functions When you define an input value, you must at least enter the following information in the process instruction (see graphic below):
• A text that is to be displayed before the corresponding input field or above the corresponding table column in the PI sheet
• The key of the message characteristic whose value you want to enter
If required, you can also enter a unit of measurement for the input value. The unit of measurement is displayed after the input field or above the corresponding table column in the PI sheet.
April 2001 237
Process Management (PP-PI-PMA) SAP AG
Message Characteristics - Manual Value Assignment
Process data request
Message characteristics
Manual value assignment in the PI sheet
Input request
Mess. characteristic to be assigned value
Unit of measurement
To enter this information, you assign the following characteristics to the process instruction in the sequence specified below:
Characteristic Meaning Value
PPPI_INPUT_REQUEST Input request Any short text
PPPI_REQUESTED_VALUE Message characteristic whose value is assigned manually
Characteristics of the assigned message category
PPPI_UNIT_OF_MEASURE Unit of measurement Unit of measurement defined in the system
A value can be assigned automatically to the characteristics specifying the date (PPPI_EVENT_DATE) and time (PPPI_EVENT_TIME) in the PI sheet. If you define these characteristics as input values, the system proposes the current values as possible entries in the PI sheet. Unlike automatic value assignment, however, you can still change the value.
See also: Process Data Request / Message Category - Example [Page 257]
Additional Functions You can enter additional information that controls PI sheet processing for each input value in the process instruction (see graphic below). You can define the following:
• A heading to group several input values
• A default value for the input value
• A variable for the input value
238 April 2001
SAP AG Process Management (PP-PI-PMA)
Message Characteristics - Manual Value Assignment
• An input validation
Process data request
Grouping of input values
Manual value assignment in the PI sheet
Input request
Default value
Variable
Mess. characteristic to be assigned value
Input validation
Unit of measurement
Message characteristics
The table below gives an overview of the characteristics you can use to enter this information in the process instruction. The characteristics are listed in the order in which you must assign them to the process instruction.
For more detailed information on the individual functions, see the corresponding sections.
Function Characteristic Value
Grouping of input values [Page 241]
PPPI_INPUT_GROUP Any short text (heading)
Input request PPPI_INPUT_REQUEST Any short text
Default value [Page 242]
Mess. char. to be assigned a value
PPPI_DEFAULT_VARIABLE
Acc. to char. definition
Variable name
Variable [Page 244]
PPPI_VARIABLE
PPPI_GLOBAL_VARIABLE
New variable name, valid in PI sheet
New variable name, valid in process order
• Constant value
• Variable
• Local
• Global
April 2001 239
Process Management (PP-PI-PMA) SAP AG
Message Characteristics - Manual Value Assignment
Message characteristic whose value is assigned manually
PPPI_REQUESTED_VALUE Characteristic of the assigned message
Input validation [Page 246]
Export parameters
Parameter value
Changing parameters
Parameter value
Import parameters
Parameter value
• Authorization for signature
PPPI_VALIDATION_FORMULA
PPPI_VALIDATION_FUNCTION
PPPI_EXPORT_PARAMETER
PPPI_<data type>_CONSTANT any other characteristic PPPI_<data type>_VARIABLE
PPPI_CHANGING_PARAMETER
PPPI_<data type>_VARIABLE
PPPI_IMPORT_PARAMETER
PPPI_<data type>_VARIABLE
(<data type> = STRING, FLOAT, DATE, TIME)
PPPI_TEXT_FOR_INVALID_ INPUT
PPPI_ACCEPT_INVALID_INPUT
PPPI_SIGNATURE_ AUTHORIZATION
Boolean formula
Function module name
Import parameters of the function module
Fixed value Fixed value Variable name
Changing parameters of the function module
Variable name
Export parameters of the function module
New variable name
Long text
No Yes With signature only
Activity for authorization object C_CRPI_BER
Unit of measurement PPPI_UNIT_OF_MEASURE Unit of measurement
• Check formula
• Check function
• Warning
• Accepting invalid values
See also: Definition of Signatures [Page 263]
240 April 2001
SAP AG Process Management (PP-PI-PMA)
Grouping of Input Values
Grouping of Input Values Use If you want to group several consecutive input values in a simple data request, you define a common heading for them.
The input values following a heading are indented in the PI sheet.
Features You can define several headings in a process instruction.
To define the heading for a group of input values, you assign the following characteristic before the input request of the first input value:
Characteristic Meaning Value
PPPI_INPUT_GROUP Grouping of input values Any short text (heading)
To assign a characteristic value, you can use one of the following options:
• You can enter any short text you like manually.
• The following values can be assigned to the characteristic automatically:
− The material number if characteristic PPPI_MATERIAL for the material number has been assigned to the process instruction before
The description of the inspection characteristic if characteristic PPPI_INSPECTION_CHARACTERISTIC for the inspection characteristic number has been assigned to the process instruction before
−
• You can use a text symbol to insert the value of another characteristic into the text; see Text Symbols Within Characteristic Texts [Page 312].
April 2001 241
Process Management (PP-PI-PMA) SAP AG
Definition of Default Values
Definition of Default Values Use If a planned or target value is available for an input value, you can enter the planned or target value as a default value in the process instruction.
The system displays the default value together with the allowed values in the PI sheet when you call the possible entries for the input value. Unlike the other values, the default value is already selected. If you enter a value for a process instruction with several input values, the default values of the other input values are copied to the fields.
Features You enter a default value in the process instruction as follows:
• As a constant value if it has already been specified in the process order
• As a variable if it is only available in the PI sheet
Constant default value To define a constant default value in the process instruction, you assign the following characteristic before the input value:
Characteristic Meaning Value
Message characteristic that has been defined as an input value
Constant default value According to characteristic definition, also automatically (see below)
To assign a characteristic value, you can use the following options:
You can enter the required default value manually. •
• If the value has been entered elsewhere in the process order, you can transfer it to the process instruction by automatic value assignment when you create the control recipe. However, you can only use this option, if the settings required for automatic value assignment are made for the message characteristic in Customizing; see Process Instructions: Automatic Characteristic Value Assignment [Page 12 ]4 .
Message category PI_PROD is allocated to a process data request. The following characteristics have been maintained in the process instruction for the input value Product quantity.
Number Characteristics Value
0070 PPPI_INPUT_REQUEST Product quantity:
0080 PPPI_MATERIAL_PRODUCED
0090 PPPI_REQUESTED_VALUE PPPI_MATERIAL_PRODUCED
242 April 2001
SAP AG Process Management (PP-PI-PMA)
Definition of Default Values
0100 PPPI_UNIT_OF_MEASURE
Characteristic PPPI_MATERIAL_PRODUCED is defined as an input value in number 0090. In number 0080, this characteristic is used to define a constant default value for the input value. Since the planned order quantity is automatically assigned as the characteristic value, the planned value is proposed in the PI sheet.
Variable as a Default Value Using a variable, you can copy the default value of a preceding process instruction of the same process order.
To define a variable as a default value in the process instruction, you assign the following characteristic before the input value:
Characteristic Meaning Value
PPPI_DEFAULT_VARIABLE Variable as default value Variable name
For more detailed information, see Using Text Symbols in Process Instructions [Page 304].
April 2001 243
Process Management (PP-PI-PMA) SAP AG
Definition of Variables in Process Data Requests and Calculation Formulas
Definition of Variables in Process Data Requests and Calculation Formulas Use You define variables in process data requests and calculation formulas to transfer the value of a message characteristic to a succeeding process instruction.
Here, you can use the variable for the following, for example:
• To define default values and input validations in process data requests
• To assign values to message characteristics in hidden data requests
• To define calculation formulas in process data calculation formulas
• To define export and changing parameters in dynamic function calls
Features You can define a variable for every message characteristic of a process instruction. The data type of the variable is identical to that of the message characteristic (for example, CHAR or NUM).
Depending on how you define the variable, it is valid:
• In the PI sheet in which it has been defined
• For the entire process order
To define a variable, you assign one of the following characteristics immediately before the message characteristic in the process instruction:
Characteristic Meaning Value
PPPI_VARIABLE Variable is valid within the PI sheet
New variable name (see below)
PPPI_GLOBAL_VARIABLE Variable is valid for the entire process order
New variable name (see below)
In general, you can choose any name for a variable. To avoid conflicts with other functions, do not use:
• The variable name X
• Blanks and arithmetic operators as part of the variable name
• The following character strings at the end of the variable name:
– _<number>, for example, _1, _2
– _COUNT
– _SUM
244 April 2001
SAP AG Process Management (PP-PI-PMA)
Definition of Variables in Process Data Requests and Calculation Formulas
If a variable was defined for the entire process order, the system does not transfer its value to the process instructions of other PI sheets unless it cannot be changed anymore. This is the case after the value has been reported, that is, when the corresponding process message has been transferred to process management to be send to its destination.
April 2001 245
Process Management (PP-PI-PMA) SAP AG
Definition of Input Validations
Definition of Input Validations Use When defining characteristics in Customizing, you can specify an allowed value range for each characteristic. The settings you make here apply to all process instructions and messages in which the characteristic is used.
If you want to restrict the value range even further for a specific input value, you can also define an input validation for it in the process instruction. In the input validation, you determine:
• The validation rule that is used to check the input value in the PI sheet
• Whether invalid values are transferred to the PI sheet and how this is done
Prerequisites • If you want to use a check function to check the input value, make sure that a suitable
function module has been created in the system (see Customizing for Process Management).
• If a signature must be executed to accept invalid input values in the PI sheet (see below), you must select one of the following types of signature in Customizing for the control recipe destination.
− Signature without a password check
− Signature with a simple password check In this case, you must also define passwords for the corresponding users in Customizing for the control recipe destination.
Digital signature [Ext.] −
If several individual signatures are to be executed, you also define a signature strategy [Ext.] in the control recipe destination or in the process instruction.
For more information about digital signatures and the required settings, see Approval Using Digital Signatures [Ext.].
Features Validation Rule In the process instruction, you can define the validation rule for the input validation as follows:
• As a check formula for numeric values
Characteristic Meaning Value
PPPI_VALIDATION_FORMULA Check formula Boolean formula (see Syntax of check formulas [Page 432])
• As a check function for all values
246 April 2001
SAP AG Process Management (PP-PI-PMA)
Definition of Input Validations
Characteristic Meaning Value
PPPI_VALIDATION_FUNCTION Check function Function module name
You must include the parameters of the function module in the process instruction directly after the characteristic for the check function. For more information, see:
Definition of Export Parameters [Page 28 ]0 −
Definition of Changing Parameters [Page 282] −
− Definition of Import Parameters [Page 28 ]4
Processing Invalid Input Values In addition to the validation rule, you can also enter the following information to controls how invalid input values are processed:
• Warning
If you enter an invalid value in the PI sheet, the system issue this warning in addition to the standard message.
• Invalid values are accepted
If you do not specify anything here, invalid values can be accepted without restrictions. You can define the following restrictions:
− Invalid values are not accepted
− Invalid values are only accepted with a signature
Depending on the settings made in the control recipe destination, the PI sheet requests a signature with or without a password, one digital signature, or several individual digital signatures defined in a signature strategy. You must also enter a comment for digital signatures.
The input value is not reported automatically when you execute the signature. If you change the value, you must execute the signature again even if the changed value complies with the validation rule.
• Authorization for executing a signature
For signatures with a simple password check or for digital signatures, you can specify that a user requires a special maintenance authorization for the PI sheet to execute the signature.
The system checks whether the activity specified in the process instruction is included in authorization object C_CRPI_BER in the user master record.
Irrespective of the settings you make here, the system carries out the following authorization checks for digital signature:
– Activity 73 (Archive) in authorization object C_CRPI_BER (PI sheet)
– For individual signatures in a signature strategy, the authorization group for the individual signature in authorization object C_SIGN_BGR (authorization groups for digital signatures)
April 2001 247
Process Management (PP-PI-PMA) SAP AG
Definition of Input Validations
Signature strategy for digital signatures •
If several users must sign invalid values, you use a signature strategy [Ext.] to define which individual signatures are required. You can assign a signature strategy in the control recipe destination. This strategy is then used for all input validations. If you want to use a different strategy for a particular process instruction, you assign the strategy to this process instruction.
The signature strategy must be carried out synchronously in the PI sheet. This means that the individual signatures must be executed immediately after one another.
To enter this data in the process instruction, you assign the following characteristics immediately after the validation rule:
Characteristic Meaning Value
PPPI_TEXT_FOR_INVALID_INPUT Warning Long text (see also Using Text Symbols [Page 312])
PPPI_ACCEPT_INVALID_INPUT Invalid values are accepted
No Yes With signature only
PPPI_SIGNATURE_AUTHORIZATION Authorization required for signature with password or digital signature
Any value for the Activity field in the authorization object C_CRPI_BER
PPPI_SIGNATURE_STRATEGY Signature strategy (for digital signatures only)
Strategy defined in Customizing
248 April 2001
SAP AG Process Management (PP-PI-PMA)
Check Formula Syntax for Input Validations
Check Formula Syntax for Input Validations Check formulas in input validation must have the following syntax:
<relational expression><logical operator><relational expression>
<rel.expression> = <arith.expression><rel.operator><arith.expression>
Note the following:
•
•
•
•
•
−
You can use the operators listed below.
You can enter any number of logical relationships in a check formula.
In relational expressions, you can use variable X for the input value.
You must always use the decimal point for decimal numbers.
You can use variables to transfer numeric values of preceding process instructions to the check formula. For more detailed information see:
Using Variables in Browser-Based PI Sheets [Page 30 ]6
− Using Variables in ABAP List-Based PI Sheets [Page 304]
In long formulas, you may use no more than 240 characters that can be separated in any number of lines.
•
Note that a blank character is automatically set at the end of each line. For this reason, make sure to write long number, variable names, or operators together in one line.
PPPI_VALIDATION_FORMULA x>50 AND x<100 OR PPPI_VALIDATION_FORMULA x<200 AND x>150
Logical Operators Meaning
AND Both of the linked expressions have to be true.
OR One of the linked expressions has to be true.
NOT The expressions following the operator must not be true.
Relational Operators Meaning
= Equal to
<= Less than or equal to
>= Greater than or equal to
April 2001 249
Process Management (PP-PI-PMA) SAP AG
Check Formula Syntax for Input Validations
<> Not equal to
>< Not equal to
< Less than
> Greater than
Arithmet. Operators Meaning
+ Plus
- Minus
* Multiplied by
/ Divided by
DIV Modulo division; division where the result is quoted as an integer
MOD
Absolute value
SIN Sine
COS Cosine
TAN Tangent
LOG Logarithm to base e
** To the power of
EXP Power to base e
SQRT Square root
ROUND Round to nearest integer
TRUNC Cut off decimals
Remainder after modulo division
ABS
250 April 2001
SAP AG Process Management (PP-PI-PMA)
Definition of Export Parameters
Definition of Export Parameters Use You define export parameters in function calls and input validations for the following parameters of the function module or check function:
• Required import parameters
• Optional import parameters for which you do not want to use the default value defined in the function module
In doing so, you determine the parameter value that is transferred to the function module in the PI sheet.
Prerequisites If you want to transfer the value of a variable to the function module, you must either have defined the variable in a preceding process instruction of the same PI sheet or for the entire process order (see Use of Variables [Page 304]).
Exception: Variable X always refers to the immediately preceding input value. You must not define it in the process instruction.
Features When defining an export parameter, you specify the following information in the process instruction:
• The parameter name
• The parameter value
− If the value is available in the process order, you enter it as a constant.
− If the value is only available in the PI sheet, you transfer it from a preceding process instruction using a variable.
− In input validation, you use variable X to transfer the value to be checked.
To enter this information, you assign the following characteristics to the process instruction:
Characteristic Meaning Allowed values
PPPI_EXPORT_PARAMETER Export parameter Import parameter of the function module
Characteristic for the variable/ constant that has the same data type as the parameter (see below)
Parameter value Value to be exported: constant or variable
Notes on Parameter Value Assignment You can only transfer the value of a variable or constant to a parameter if the variable or constant has the same data type as the parameter in the function module.
April 2001 251
Process Management (PP-PI-PMA) SAP AG
Definition of Export Parameters
Constant The characteristic you use to define the constant also determines its data type. The following characteristics are available in the standard system:
Characteristic for constant Data type
PPPI_DATE_CONSTANT Date
PPPI_TIME_CONSTANT Time
PPPI_FLOAT_CONSTANT Floating point number
PPPI_STRING_CONSTANT Alphanumeric value
However, you can also use any other characteristic, provided that its data type is identical to that of the parameter. You may want to do this, for example, if the characteristic value is assigned automatically in the process order.
Variable
A variable has the same data type as the value to which it refers. Depending on the data type, you must use one of the following characteristics to allocate the variable in the process instruction:
Characteristic for variable Data type
PPPI_DATE_VARIABLE Date
PPPI_TIME_VARIABLE Time
PPPI_FLOAT_VARIABLE Floating point number
PPPI_STRING_VARIABLE Alphanumeric value
252 April 2001
SAP AG Process Management (PP-PI-PMA)
Definition of Changing Parameters
Definition of Changing Parameters Use You define changing parameters in function calls and input validations for the following changing parameters of the function module or check function:
• Required changing parameters
• Optional changing parameters for which you do not want to use the default value defined in the function module
To the parameter, you assign the variable whose value you want to transfer from the PI sheet to the function module. After the function has been carried out, the system returns the parameter value to this variable.
Changing parameters of function calls are displayed in the PI sheet. You can also use the variable to transfer the value to succeeding process instructions of the same PI sheet. However, note the following:
• The function can be carried out more than once in the PI sheet.
• The function may change the parameter value.
Prerequisites The variable you assign to the parameter has been defined in a preceding process instruction of the same PI sheet or for the entire process order (see Use of Variables [Page 30 ]4 ).
Features When defining a changing parameter, you specify the following information in the process instruction:
• A text for the parameter (in function calls)
In the PI sheet, the text is displayed before the parameter value. In input validations, you need not define a text since the parameter values are not displayed in the PI sheet.
• The parameter name
• The variable for the parameter value
To enter this information, you assign the following characteristics to the process instruction:
Characteristic Meaning Allowed Values
PPPI_INPUT_REQUEST Text (in function calls only)
Any short text (see also Using Text Symbols [Page
] )
PPPI_CHANGING_PARAMETER Changing parameters Changing parameters of the function module
Characteristic for the variable that has the same data type as the parameter (see below)
Variable for the parameter value
Name of an existing variable
312
April 2001 253
Process Management (PP-PI-PMA) SAP AG
Definition of Changing Parameters
Notes on Variable Assignment You can only transfer the value of a variable to a parameter if it has the same data type as the parameter in the function module.
The data type of a variable is identical to that of the value to which it refers. Depending on the data type, you must use one of the following characteristics to assign the variable in the process instruction:
Characteristic for Variable Data Type
PPPI_DATE_VARIABLE Date
PPPI_TIME_VARIABLE Time
PPPI_FLOAT_VARIABLE Floating point number
PPPI_STRING_VARIABLE Alphanumeric value
254 April 2001
SAP AG Process Management (PP-PI-PMA)
Definition of Import Parameters
Definition of Import Parameters Use You define import parameters in function calls and input validations for the export parameters of the function module or check function: You define a variable to which the parameter value is assigned in the PI sheet.
Import parameters of function calls are displayed in the PI sheet. You can also use the variable to transfer the value to succeeding process instructions of the same PI sheet. Note, however, that the function may be carried out more than once in the course of PI sheet maintenance.
Features When defining an import parameter, you specify the following information in the process instruction:
• A text for the parameter (in function calls)
In the PI sheet, the text is displayed before the parameter value. In input validations, you need not define a text since the parameter values are not displayed in the PI sheet.
• The parameter name
• A new variable for the parameter value
The variable is valid within the PI sheet but not in the entire process order
To enter this information, you assign the following characteristics to the process instruction:
Characteristic Meaning Allowed values
PPPI_INPUT_REQUEST Text (in function calls only)
Any short text (see also Using Text Symbols [Page
])
PPPI_IMPORT_PARAMETER Import parameter Export parameter of the function module
Characteristic for the variable that has the same data type as the parameter (see below)
Variable for the parameter value
New variable name (see below)
312
Notes on Variable Definition
Characteristics for Variables
A variable can only be assigned a parameter value if it has the same data type as the parameter in the function module. The characteristic you use to define the variable also determines its data type. The following characteristics are available:
April 2001 255
Process Management (PP-PI-PMA) SAP AG
Definition of Import Parameters
Characteristic for variable Data type
PPPI_DATE_VARIABLE Date
PPPI_TIME_VARIABLE Time
PPPI_FLOAT_VARIABLE Floating point number
PPPI_STRING_VARIABLE Alphanumeric value
Variable name
In general, you can choose any name for a variable. To avoid conflicts with other functions, do not use:
• Variable name X
• Blanks and arithmetic operators as part of the variable name
• The following character strings at the end of the variable name:
– _<number>, for example, _1, _2
– _COUNT
– _SUM
256 April 2001
SAP AG Process Management (PP-PI-PMA)
Example: Process Data Request / Message Category
Example: Process Data Request / Message Category The following graphic uses a goods issue message as an example to illustrates the relationship between the process data request and the message category.
Proc. message cat.:Proc. message cat.: PI_ PI_CONSCONS
MATERIAL_CONSUMED
PROCESS_ORDER
EVENTEVENT__TIMETIME
UNIT_OF_MEASURE
REQUESTED_VALUE
AUTOMATIC_VALUE
MATERIAL_CONSUMED
1234
AUTOMATICAUTOMATIC__VALUEVALUE
EVENTEVENT__TIMETIME
EVENTEVENT_DATE_DATE
OPERATIONPHASE
PROCESS_ORDER
Process data requestProcess data request
UNIT_OF_MEASURE kg
INPUT_REQUEST Quantity:
MESSAGE_CATEGORY
DATA_REQUEST_TYPE Simple data request
PI_CONS
PHASE 0010
Value assigned in planningValue assigned automatically
Input characteristicsOptional characteristic
Message characteristics:
MATERIAL ABC
MATERIAL
BATCHSTORAGE_LOCATION
RESERVATION
RESERVATION_ITEM
EVENTEVENT_DATE_DATE
The following information is contained in the process instruction:
• A simple data request is defined since only one goods issue is to be posted.
• A message of category PI_CONS is to be created for the process instruction.
• The order number, phase, and material are available in the process order. For this reason, values have already been assigned to the corresponding message characteristics in the process instruction.
• Automatic value assignment in the PI sheet is defined for the date and time.
• The characteristic for the material quantity is marked as an input value. The text Quantity: is defined as the input request for the input value.
• A value has already been assigned to the message characteristic for the unit of measurement in the process instruction. The characteristic is assigned after the input value. For this reason, it is displayed after the input field in the PI sheet.
• All other characteristics of the message category are not required for message processing. For this reason, they have not been included in the process instruction.
April 2001 257
Process Management (PP-PI-PMA) SAP AG
Message Characteristic: Value Assignment Using Variable
Message Characteristic: Value Assignment Using Variable Use The value of a message characteristic can be obtained from a preceding process instruction for the same PI sheet or the same PI sheet if it has been defined as a variable in this process instruction. In the data request, the message characteristic needs to be assigned to the characteristic PPPI_EXTERNAL_VALUE. The variable whose value is to be assigned to the characteristic has to be specified before the message characteristic.
You cannot have both manual value assignment to message characteristics and value assignment using a variable within the same process instruction.
Assign the following characteristics:
Characteristic Meaning Allowed values
PPPI_DEFAULT_VARIABLE Variable to be assigned to message characteristic
Variable name, see Use of Variables [Page
]
PPPI_EXTERNAL_VALUE Message characteristic whose value is to be assigned using variable
Message characteristic
304
Unlike manual value assignment, the value obtained via the characteristic PPPI_DEFAULT_VARIABLE is not proposed as a default value here. Instead, it is directly transferred to the process message, that is, you cannot change it in the PI sheet.
See also: Message Characteristic: Value Assignment Using Variable - Example [Page 259]
258 April 2001
SAP AG Process Management (PP-PI-PMA)
Example: Message Characteristics - Value Assignment Using Variables
Example: Message Characteristics - Value Assignment Using Variables Let us assume that in your plant, the material quantities produced are determined using an automatic weighing system. You want to obtain these values from the weighing system, have them displayed in the PI sheet, and report them to process management using a process message.
To implement the first two steps, you have defined:
• A function module that obtains the required data from the weighing system
• A dynamic function call that enables you to start the function module within the PI sheet
(For more information on these steps, see the section on dynamic function calls.)
To report the values obtained via the dynamic function call, you need to define a data request. The values in question can be transferred to the data request using the variable names defined for the import parameters in the function call.
The following graphic shows how the process data request could be structured if the message you want to send belongs to the category PI_PROD, and the variables MAT_WEIGHT and UNIT have been defined for the material quantity and the unit of measure in the dynamic function call.
Process message category:Process message category: PI_ PI_PRODPROD
PPPI_PROCESS_ORDER Process data requestProcess data request
Optional characteristicValue assigned automatically
Value assigned using variableValue assigned in planning
Message characteristics:
PPPIPPPI__EVENTEVENT_DATE_DATEPPPIPPPI__EVENTEVENT__TIMETIMEPPPI_OPERATIONPPPI_PHASE
PPPIPPPI__DATADATA__REQUESTREQUEST_TYPE_TYPE
PPPIPPPI_MESSAGE__MESSAGE_CATEGORYCATEGORY
SimpleSimple
PI-PI-PRODPROD
PPPI_PROCESS_ORDER 60000057
PPPIPPPI__AUTOMATICAUTOMATIC__VALUEVALUE PPPIPPPI__EVENTEVENT_DATE_DATE
PPPIPPPI__AUTOMATICAUTOMATIC__VALUEVALUE PPPIPPPI__EVENTEVENT__TIMETIME
PPPI_PHASE 9015
PPPI_MATERIAL MAT_24
PPPIPPPI_DEFAULT_VARIABLE_DEFAULT_VARIABLE MATGEWMATGEW
PPPIPPPI__EXTERNALEXTERNAL__VALUEVALUE PPPIPPPI__UNITUNIT OFOF__MEASUREMEASURE
PPPIPPPI__EXTERNALEXTERNAL__VALUEVALUE PPPIPPPI_MATERIAL__MATERIAL_PRODUCEDPRODUCED
PPPIPPPI_DEFAULT_VARIABLE_DEFAULT_VARIABLE UNITUNIT
PPPIPPPI_MATERIAL__MATERIAL_PRODUCEDPRODUCEDPPPIPPPI__UNITUNIT OFOF__MEASUREMEASUREPPPI_BATCHPPPI_STORAGE_LOCATIONPPPI_DELIVERY_COMPLETEPPPI_ORDER_ITEM_NUMBER
PPPI_MATERIAL
April 2001 259
Process Management (PP-PI-PMA) SAP AG
Output Values
Output Values Use You define output values in process data requests and calculation formulas. You must define output values if you not only want to display input values and formula results in the PI sheet but also information that is usually processed in the background, for example, planned values for input values or variable values from calculation formulas.
You cannot change output values in the PI sheet. A symbol is displayed as a placeholder of the output value until the output value is available in the PI sheet.
Features You can define characteristics and variables as output values. The sections below tell you:
• What you must bear in mind when displaying characteristics and variables
• Which characteristics you can use to define output values
Defining Characteristics as Output Values You can display the following characteristic values in a PI sheet:
• Values of message characteristics that have been assigned in the process instruction
• The date and time that is assigned automatically as the characteristic value of PPPI-EVENT_DATE and PPPI_EVENT_TIME in the PI sheet
• Planned values for input values, provided that the planned values have been defined as default values in the process instruction
• Values of message characteristics that are assigned in the PI sheet using variables
Defining Variables as Output Values You can display the value of a variable in the PI sheet, if the variable has been defined in a preceding process instruction and is valid for the PI sheet or the entire process order.
For more information, see Use of Variables in Process Instructions [Page 304].
Texts for Output Values In addition to the output value (characteristic or variable), you also specify a text in the PI sheet. In the PI sheet, this text is processed as follows:
• In simple data request, the text is displayed before the output value. If you only define one text for several consecutive output values, the values are displayed in the same line.
• In repeated data requests, you must define a text for every output value. The text is displayed above the relevant table column.
Characteristics for Defining Output Values In the process instruction, you define an output value after the input value or formula result after which you want to display it in the PI sheet. To do so, you assign the following characteristics:
260 April 2001
SAP AG Process Management (PP-PI-PMA)
Output Values
Characteristic Meaning Allowed values
PPPI_OUTPUT_TEXT Text displayed before the subsequent output values
Any short text
PPPI_OUTPUT_CHARACTERISTIC Characteristic whose value is displayed in the PI sheet
Message characteristic (see above)
Variable name (see above)
PPPI_OUTPUT_VARIABLE Variable whose value is displayed
In the case of text characteristics (for example, PPPI_TEXT_FOR_INVALID_INPUT), you can insert the value of another characteristic into this text using a text symbol; see Text Symbols Within Characteristic Texts [Page 312].
See also: Definition of Output Values - Example [Page 262]
April 2001 261
Process Management (PP-PI-PMA) SAP AG
Example: Definition of Output Values
Example: Definition of Output Values Message category PI_PROD is assigned to a process data request. You want to display an input value for the product quantity in the PI sheet. Before this input value, you want to display the planned quantity along with the material number and unit of measurement. For this reason, the following characteristics have been assigned to the process instruction:
Number Characteristic Value
0050 PPPI_MATERIAL MAT_XYZ
0060 PPPI_OUTPUT_TEXT Planned product quantity:
0062 PPPI_OUTPUT_CHARACTERISTIC PPPI_MATERIAL
0064 PPPI_OUTPUT_CHARACTERISTIC PPPI_MATERIAL_PRODUCED
0066 PPPI_OUTPUT_CHARACTERISTIC PPPI_UNIT_OF_MEASURE
0070 PPPI_INPUT_REQUESTED Actual quantity:
0075 PPPI_MATERIAL_PRODUCED 430
0080 PPPI_REQUESTED_VALUE PPPI_MATERIAL_PRODUCED
0090 PPPI_UNIT_OF_MEASURE kg
The values to be displayed are defined as characteristics in the process instruction:
• The material number and unit of measurement are assigned to the process instruction as message characteristics and a value is assigned directly (see number 0050 and 0090)
• In number 0075, the planned material quantity is defined as a default value for the input value.
For this reason, the output characteristics are defined using characteristic PPPI_OUTPUT_CHARACTERISTIC (numbers 0062 to 0066). They are defined before the input characteristic as they are to be displayed before the input field in the PI sheet. A text is defined in number 0060 that is displayed before the output values.
The following lines are displayed for the process instruction in the PI sheet:
Planned product quantity: MAT_XYZ 430 kg
Actual quantity: __________ kg
262 April 2001
SAP AG Process Management (PP-PI-PMA)
Definition of Signatures in PI Sheets
Definition of Signatures in PI Sheets Use If you want to sign data in the PI sheet, you define a process data request with a signature. You have the following options:
• Signature to accept invalid input values
In this case, you define the signature as part of an input validation. You only enter a signature in the PI sheet, if you want to accept an input value although it is outside the defined value range.
• Signature to complete a process step
In this case, you add the signature as an input value into the usual sequence of steps in the PI sheet. The entries and formula results of the relevant process step are reported when the signature is entered, that is, the corresponding messages are transferred to process management for sending. After this, you cannot change the values anymore.
• Signature to sign/complete the PI sheet
Technically speaking, the signature is identical to the signature that is used to sign a process step. However, it is executed at the end of the PI sheet after all process steps have been completed.
In ABAP list-based PI sheets, you can use any type of signature for this. By executing the signature, you only confirm that the data is complete and correct.
In browser-based PI sheets, you must use the digital signature [Ext.] with a signature strategy [Ext.] and an asynchronous signature process (see below). The PI sheet is completed automatically when the signature process is completed.
For statements concerning quality in the manufacturing process, you can enter a comment. If the corresponding Customizing settings are made, the comment is transferred to the batch record and can be used as a basis for the usage decision.
Prerequisites The type of signature to be used in the PI sheet has been defined in Customizing for Control Recipe Destinations.
You have the following options:
Signature without a password check •
•
•
Signature with a simple password check
You can use this type of signature for ABAP list-based PI sheets only. You define the passwords for the relevant users in Customizing for Control Recipe Destinations.
Digital signature [Ext.] If several individual signatures are to be executed, you can also specify the following in the control recipe destination:
− Which signature strategy [Ext.] is to be used to sign process steps and PI sheets
Which signature strategy is used to accept invalid input values −
April 2001 263
Process Management (PP-PI-PMA) SAP AG
Definition of Signatures in PI Sheets
For more information about digital signatures and the required settings, see Approval Using Digital Signatures [Ext.].
If you want to use signatures to complete browser-based PI sheets, you must use digital signatures.
Features Signatures for Invalid Input Values You define these signatures if you define input validations. For more information, see: Type 0: Definition of Input Validations [Page 429] Type 2: Definition of Input Validations [Page 246]
Signature for Process Step / PI Sheet You define these signatures as input values in a process data request. The structure rules for this process instruction are identical to that of all other data requests. See also: Type 0: Definition of Data Requests [Page 421] Type 2: Process Data Requests for PI Sheets [Page 231] Note the following:
• Type of data request You can define one signature for each data request. Depending on the data request, the signature is processed differently.
− In a simple data request, you use signatures to complete the preceding entries and calculations since the last signature. If a signature is preceded by a table, you cannot enter more table entries once the signature has been executed.
− In repeated data requests, signatures must be positioned in the last table column, that is, you must define the signature as the last input value of the process instruction. You use signatures to complete the preceding table entries. However, you can still enter more table entries as long as the maximum number of table lines has not been reached.
• Message category
You must assign a message category that contains characteristic PPPI_SIGNATURE to the process instruction.
Note that in repeated data requests you must enter a signature for every table line if the signature is marked as required in the message category.
• Input value for the signature
You must define characteristic PPPI_SIGNATURE as an input value in the process instruction.
The characteristic is transferred to the message that the system creates for the process instruction. The following value is assigned to the characteristic:
− If only one signature or one digital signature is executed: the signature or name of the signatory
264 April 2001
SAP AG Process Management (PP-PI-PMA)
Definition of Signatures in PI Sheets
− If signatures that consist of several individual digital signatures are executed: the key of the corresponding signature strategy You can display the signatures in the PI sheet.
• Authorization to execute a signature For the following types of signature, you can specify that a user requires a special maintenance authorization for the PI sheet to execute the signature.
− In browser-based PI sheets:
• For signatures without a password
• For digital signatures
− In ABAP list-based PI sheets:
• For signatures with a simple password check
• For digital signatures
The system then checks if the activity specified in the process instruction has been included in authorization object C_CRPI_BER in the user master record.
Irrespective of the settings you make here, the system checks the following authorizations for digital signatures:
– Activity 73 (Archive) in authorization object C_CRPI_BER (PI sheet)
– For individual signatures in a signature strategy, the authorization group for the individual signature in authorization object C_SIGN_BGR (authorization groups for digital signatures)
• Signature strategy for digital signatures
If several users must sign a process step, you use a signature strategy [Ext.] to define which individual signatures are required. You can assign a signature strategy in the control recipe destination. This strategy is then used for all process steps or for all input validations. If you want to use a different strategy for a particular process instruction, you assign the strategy to this process instruction.
If you want to use signatures to complete browser-based PI sheets, you must use a signature strategy.
• Synchronous or asynchronous signature process
In the PI sheet, signature strategies are carried out synchronously by default. This means that all signatures must be executed immediately one after another without exiting the function.
However in process instructions that are used to sign the entire PI sheet, you can determine that the signature strategy is carried out asynchronously. The system stores the signatures individually. The PI sheet can be exited after each individual signature and can be called again by the next signatory.
April 2001 265
Process Management (PP-PI-PMA) SAP AG
Definition of Signatures in PI Sheets
If you want to use signatures to complete browser-based PI sheets, you must use the asynchronous signature process.
To define the data for the signature, you assign the following characteristics in the process instruction:
Characteristic Meaning Value
PPPI_INPUT_REQUEST Input request Any short text
PPPI_REQUESTED_VALUE Input value PPPI_SIGNATURE
Required authorization (only for signatures with a password check and digital signatures)
Any value for the Activity field in the authorization object C_CRPI_BER
PPPI_SIGNATURE_STRATEGY Signature strategy (for digital signatures only)
Strategy defined in Customizing
PPPI_SIGNATURE_MODE Synchronous or asynchronous signature process (only for signing / completing PI sheets with a signature strategy)
PPPI_SIGNATURE_ AUTHORIZATION
S (synchronous) A (asynchronous)
266 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 4: Process Data Calculation Formulas
Type 4: Process Data Calculation Formulas Use The following graphic shows the structure overview of a process data calculation formula [Ext.]. To obtain details on the individual structure elements and the characteristics used to define them, choose the corresponding section from the list below.
Process data calculation formula
Message category
Message characteristics
Value is assigned in planning
Value is assigned automatically in the PI sheet
Value is calculated in the PI sheet
Output values
Features Requested Message Category [Page 26 ]8
Message Characteristics in Process Data Calculation Formulas [Page 26 ]9
Output Values [Page 260]
April 2001 267
Process Management (PP-PI-PMA) SAP AG
Requested Message Category
Requested Message Category In every process data calculation formula, you have to enter the message category to be used for reporting the calculated value.
Assign the following characteristic:
Characteristic Meaning Allowed values
PPPI_MESSAGE_CATEGORY Message category Message category for reporting a numeric value
268 April 2001
SAP AG Process Management (PP-PI-PMA)
Message Characteristics in Process Data Calculation Formulas
Message Characteristics in Process Data Calculation Formulas A process data calculation formula must contain the following message characteristics:
• All required characteristics of the requested message category
You can define the message characteristics in any sequence. However, the process instruction characteristics pertaining to a message characteristic must be defined in the sequence described in the corresponding section below.
• All optional characteristics which are to be included in the message
The definition of the message characteristics directly follows the corresponding message category in the process instruction.
How you need to assign the message characteristics to the process instruction depends on the way in which they are to be processed, that is, whether their values are to be assigned:
• In planning
• Automatically in the PI sheet
• Manually in the PI sheet
Message Characteristics: Value Assignment in Planning [Page 23 ]5
Message Characteristics: Automatic Value Assignment [Page 236]
Message Characteristics: Value to be Calculated [Page 270]
April 2001 269
Process Management (PP-PI-PMA) SAP AG
Message Characteristics: Value to be Calculated
Message Characteristics: Value to be Calculated Features When defining the value to be calculated, you must enter the following information in the process instruction (see graphic below):
• A text to be displayed before the calculated value
• The key of the message characteristic whose value is to be calculated
• The calculation formula to be used
If required, you can also specify a unit of measurement for the calculated value. In the PI sheet, the unit is displayed after the value.
Process data calculation formula
Message characteristics
Value is calculated in the PI sheet
Text for the formula result
Mess. characteristics to be calculated
Calculation formula
Unit of measurement
To enter this information, you assign the following characteristics to the process instruction in the sequence specified below:
Characteristic Meaning Allowed values
PPPI_INPUT_REQUEST Text displayed before the formula result
Any short text
Message characteristic
PPPI_CALCULATION_FORMULA Calculation formula Arithmetic expression; see Syntax [Page 442]
PPPI_UNIT_OF_MEASURE Unit of measurement Any unit of measurement
PPPI_CALCULATED_VALUE Message characteristic to be calculated
270 April 2001
SAP AG Process Management (PP-PI-PMA)
Message Characteristics: Value to be Calculated
In the case of text characteristics (for example, PPPI_INPUT_REQUEST), you can insert the value of another characteristic into this text using a text symbol; see Text Symbols Within Characteristic Texts [Page 312].
See also: Process Data Calculation Formula / Message Category - Example [Page 274]
Additional Function If you want to use the characteristic value in a subsequent process instruction of the same process order, you can define a variable that refers to this message characteristic; see Definition of Variables [Page 244].
April 2001 271
Process Management (PP-PI-PMA) SAP AG
Syntax in Process Data Calculation Formulas
Syntax in Process Data Calculation Formulas When defining your formula, note the following:
Always use the decimal point for decimal numbers. •
• You can use variables to transfer numeric values of preceding process instructions to the formula. For more information, see Use of Variables in Process Instructions [Page 304].
• In long formulas, you may use no more than 240 characters that can be separated in any number of lines.
Note that a blank character is automatically set at the end of each line. For this reason, make sure to write long number, variable names, or operators together in one line.
PPPI_CALCULATION_FORMULA (-B+SQRT(B**2- PPPI_CALCULATION_FORMULA (4*A*C)))/(2*A)
Arithmet. Operators Meaning
+ Plus
- Minus
* Multiplied by
/ Divided by
DIV Modulo division; division where the result is quoted as an integer
MOD Remainder after modulo division
ABS Absolute value
SIN Sine
COS Cosine
TAN Tangent
LOG Logarithm to base e
To the power of
EXP Power to base e
SQRT Square root
TRUNC Cut off decimals
**
ROUND Round to nearest integer
272 April 2001
SAP AG Process Management (PP-PI-PMA)
Syntax in Process Data Calculation Formulas
April 2001 273
Process Management (PP-PI-PMA) SAP AG
Example: Process Data Calculation Formula / Message Category
Example: Process Data Calculation Formula / Message Category The graphic below illustrates the relationship between a process data calculation formula and the message category.
Proc. message cat.:Proc. message cat.: NREAD NREAD
MATERIAL_QUANTITY
SOURCE
EVENTEVENT_DATE_DATE
EVENTEVENT__TIMETIME
CALCULATED_VALUE
CONTROL_RECIPE
AUTOMATICAUTOMATIC__VALUEVALUE
MATERIAL_QUANTITY
100000000000000309
AUTOMATICAUTOMATIC__VALUEVALUE
EVENTEVENT__TIMETIME
EVENTEVENT_DATE_DATE
value assigned automatically value assigned in planninginput characteristicoptional message characteristic
PROCESS_ORDER
OPERATION
PHASE
Process data calculation formulaProcess data calculation formula
UNIT_OF_MEASURE KG
CALCULATION_FORMULA
INPUT_REQUEST Total qty:
MESSAGE_MESSAGE_CATEGORYCATEGORY NREADNREAD
PROCESS_ORDER 400000000058
SOURCE CALC
Message characteristics:
MAT1 + MAT2
CONTROL_RECIPE
UNIT_OF_MEASURE
The following information is contained in the process instruction:
• A message of category NREAD is to be created for the process instruction.
• The order number and phase as well as the source or description of the calculated value (PPPI_SOURCE) are available in the process order. For this reason, the value has already been assigned to the corresponding message characteristics in the process instruction.
• Automatic value assignment in the PI sheet is defined for the date and time.
• The material quantity is to be calculated in the PI sheet. It equals the sum of the material quantities that are transferred from the preceding process instruction using variables MAT1 and MAT2. The text Total qty: is to be displayed before the calculated value.
• A value has already been assigned to the message characteristic for the unit of measurement in the process instruction. As the characteristic is assigned after the input value it is displayed after the input field in the PI sheet.
• All other characteristics of the message category are not required for message processing. For this, they have not been included in the process instruction.
274 April 2001
SAP AG Process Management (PP-PI-PMA)
Example: Process Data Calculation Formula / Message Category
April 2001 275
Process Management (PP-PI-PMA) SAP AG
Type 5: Inspection Results Requests
Type 5: Inspection Results Requests In an inspection results request [Ext.], you only need to specify the operations or phases for which you want to record inspection results.
Assign the following characteristics to suit your requirements:
Characteristic Meaning Allowed values
PPPI_OPERATION Operation number Number of the operation to be checked
PPPI_PHASE Phase number Number of the phase to be checked
Both characteristics can be used several times in an inspection results request.
• The QM function for results recording can only be accessed via an inspection results request,
if an inspection lot with the corresponding inspection characteristics exists for the process order. For more information on inspection lots for process orders, see Inspection Lots [Ext.] in the Production Planning - Process Industries (PP-PI) component.
• When a PI sheet is displayed or the PI sheet processed has been created for test purposes, the system will access the QM function in the display mode.
276 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 6: Dynamic Function Calls
Type 6: Dynamic Function Calls Use You can use this function to call certain R/3 functions while maintaining the PI sheet. Function modules created for the R/3 functions to be called are used to realize the function call.
Prerequisites The function module to be called must be defined in the Function Builder and must be active.
Features Function Calls Defined by SAP The standard system contains a number of predefined function modules. The corresponding function calls are defined in Customizing of the SAP reference client for Process Management.
The following table provides an overview of the functions you can call together with the corresponding function modules and the function calls.
R/3 Function Called Function Module Function Call
Calling any transaction COPF_CALL_ TRANSACTION
TA_CALL
Order confirmation for phases COPF_ENTER_ CONFIRMATION
CONF_PH (for phases)
Displaying material quantity calculation from order
COPF_MATERIAL_ QUANTITY_CALC
MAT_CALC
Displaying documents created in the in the R/3 document management system
COPF_DOCUMENT_ SHOW_DIRECT
COPF_DETERMINE_ DURATION
C_DURAT
Calculating the start date of a time interval
COPF_DETERMINE_ START_TIME
C_STRT_T
Calculating the end date of a time interval COPF_DETERMINE_ END_TIME
C_END_T
Creating physical-sample records for quality inspections during production
QPRS_PI_NEW_ SAMPLE_DRAW
QMJMP_NS
Processing sample drawing (e.g. release/lock physical sample)
QPRS_PI_SAMPLE_ DRAW_PROCESSING
QMJMP_SD
DOC_SHOW
Calculating the duration of time intervals
You can also use process instruction categories QMJMP and QMJMP_PH to call up inspection results recording from the PI sheet. In the R/3-System, however, these
April 2001 277
Process Management (PP-PI-PMA) SAP AG
Type 6: Dynamic Function Calls
process instructions are not defined as dynamic function calls but as inspection results requests.
Calling of any Transaction [Page 287]
• Accessing of Order Confirmation [Page 288]
• Displaying of Material Quantity Calculation [Page 289]
For details on the individual function modules, see the corresponding section below.
•
Displaying of Documents From Document Management System [Page 29 ]0 •
Calculation of Time Intervals and Dates [Page 291] •
Physical-Sample Record Creation [Page 293] •
• Processing of Physical-Sample Drawing [Page 295]
You must make the following settings for dynamic function calls:
• Defining Function Modules for Functions to be Called [Page 279]
• Defining Export Parameters in Dynamic Function Calls [Page 280]
• Defining Changing Parameters in Dynamic Function Calls [Page 28 ]2
• Defining Import Parameters in Dynamic Function Calls [Page 284]
For more detailed information on the required settings, see the documents listed above.
Structure of Dynamic Function Calls
278 April 2001
SAP AG Process Management (PP-PI-PMA)
Function to Be Called in a Dynamic Function Call
Function to Be Called in a Dynamic Function Call In every function call, you first have to specify the name of the function module you want to call up in the PI sheet. The function module must be defined in the function library according to the rules described in the implementation guide (IMG) for Process Management (section Define process instruction categories for R/3 PI sheet using char. overview → Assign characteristics to dynamic function calls).
In addition to this, you have the following options:
• Text for pushbutton: You can specify a text which is to be displayed on the pushbutton used in the PI sheet to call up the function module. If no text is defined in the function call, the short text of the function module to be called is displayed.
Assign the following characteristics to suit your requirements:
• Function call in display mode: You can specify whether the function can be called up during PI sheet display. If you do not specify this in the function call, the function can only be called up during PI sheet maintenance.
Characteristic Meaning Value
PPPI_FUNCTION_NAME Name of a function module Name of the function module you want to call up
PPPI_BUTTON_TEXT Text for pushbutton Any short text
PPPI_FUNCTION_DURING_ DISPLAY
Specifies whether function can be called during PI sheet display
NOT PERMITTED PERMITTED
In the case of text characteristics (such as PPPI_BUTTON_TEXT), you can insert the value of another characteristic into the text using a text symbol; see Text Symbols Within Characteristic Texts [Page 312].
April 2001 279
Process Management (PP-PI-PMA) SAP AG
Definition of Export Parameters
Definition of Export Parameters Use You define export parameters in function calls and input validations for the following parameters of the function module or check function:
• Required import parameters
• Optional import parameters for which you do not want to use the default value defined in the function module
In doing so, you determine the parameter value that is transferred to the function module in the PI sheet.
PrerequisitesIf you want to transfer the value of a variable to the function module, you must either have defined the variable in a preceding process instruction of the same PI sheet or for the entire process order (see Use of Variables [Page 304]).
Exception: Variable X always refers to the immediately preceding input value. You must not define it in the process instruction.
Features When defining an export parameter, you specify the following information in the process instruction:
• The parameter name
• The parameter value
− If the value is available in the process order, you enter it as a constant.
− If the value is only available in the PI sheet, you transfer it from a preceding process instruction using a variable.
− In input validation, you use variable X to transfer the value to be checked.
To enter this information, you assign the following characteristics to the process instruction:
Characteristic Meaning Allowed values
PPPI_EXPORT_PARAMETER Export parameter Import parameter of the function module
Characteristic for the variable/ constant that has the same data type as the parameter (see below)
Parameter value Value to be exported: constant or variable
Notes on Parameter Value Assignment You can only transfer the value of a variable or constant to a parameter if the variable or constant has the same data type as the parameter in the function module.
280 April 2001
SAP AG Process Management (PP-PI-PMA)
Definition of Export Parameters
Constant The characteristic you use to define the constant also determines its data type. The following characteristics are available in the standard system:
Characteristic for constant Data type
PPPI_DATE_CONSTANT Date
PPPI_TIME_CONSTANT Time
PPPI_FLOAT_CONSTANT Floating point number
PPPI_STRING_CONSTANT Alphanumeric value
However, you can also use any other characteristic, provided that its data type is identical to that of the parameter. You may want to do this, for example, if the characteristic value is assigned automatically in the process order.
Variable
A variable has the same data type as the value to which it refers. Depending on the data type, you must use one of the following characteristics to allocate the variable in the process instruction:
Characteristic for variable Data type
PPPI_DATE_VARIABLE Date
PPPI_TIME_VARIABLE Time
PPPI_FLOAT_VARIABLE Floating point number
PPPI_STRING_VARIABLE Alphanumeric value
April 2001 281
Process Management (PP-PI-PMA) SAP AG
Definition of Changing Parameters
Definition of Changing Parameters Use You define changing parameters in function calls and input validations for the following changing parameters of the function module or check function:
• Required changing parameters
• Optional changing parameters for which you do not want to use the default value defined in the function module
To the parameter, you assign the variable whose value you want to transfer from the PI sheet to the function module. After the function has been carried out, the system returns the parameter value to this variable.
Changing parameters of function calls are displayed in the PI sheet. You can also use the variable to transfer the value to succeeding process instructions of the same PI sheet. However, note the following:
• The function can be carried out more than once in the PI sheet.
• The function may change the parameter value.
Prerequisites The variable you assign to the parameter has been defined in a preceding process instruction of the same PI sheet or for the entire process order (see Use of Variables [Page 30 ]4 ).
Features When defining a changing parameter, you specify the following information in the process instruction:
• A text for the parameter (in function calls)
In the PI sheet, the text is displayed before the parameter value. In input validations, you need not define a text since the parameter values are not displayed in the PI sheet.
• The parameter name
• The variable for the parameter value
To enter this information, you assign the following characteristics to the process instruction:
Characteristic Meaning Allowed Values
PPPI_INPUT_REQUEST Text (in function calls only)
Any short text (see also Using Text Symbols [Page
] )
PPPI_CHANGING_PARAMETER Changing parameters Changing parameters of the function module
Characteristic for the variable that has the same data type as the parameter (see below)
Variable for the parameter value
Name of an existing variable
312
282 April 2001
SAP AG Process Management (PP-PI-PMA)
Definition of Changing Parameters
Notes on Variable Assignment You can only transfer the value of a variable to a parameter if it has the same data type as the parameter in the function module.
The data type of a variable is identical to that of the value to which it refers. Depending on the data type, you must use one of the following characteristics to assign the variable in the process instruction:
Characteristic for Variable Data Type
PPPI_DATE_VARIABLE Date
PPPI_TIME_VARIABLE Time
PPPI_FLOAT_VARIABLE Floating point number
PPPI_STRING_VARIABLE Alphanumeric value
April 2001 283
Process Management (PP-PI-PMA) SAP AG
Definition of Import Parameters
Definition of Import Parameters Use You define import parameters in function calls and input validations for the export parameters of the function module or check function: You define a variable to which the parameter value is assigned in the PI sheet.
Import parameters of function calls are displayed in the PI sheet. You can also use the variable to transfer the value to succeeding process instructions of the same PI sheet. Note, however, that the function may be carried out more than once in the course of PI sheet maintenance.
Features When defining an import parameter, you specify the following information in the process instruction:
• A text for the parameter (in function calls)
In the PI sheet, the text is displayed before the parameter value. In input validations, you need not define a text since the parameter values are not displayed in the PI sheet.
• The parameter name
• A new variable for the parameter value
The variable is valid within the PI sheet but not in the entire process order
To enter this information, you assign the following characteristics to the process instruction:
Characteristic Meaning Allowed values
PPPI_INPUT_REQUEST Text (in function calls only)
Any short text (see also Using Text Symbols [Page 312])
PPPI_IMPORT_PARAMETER Import parameter Export parameter of the function module
Variable for the parameter value
New variable name (see below)
Characteristic for the variable that has the same data type as the parameter (see below)
Notes on Variable Definition
Characteristics for Variables
A variable can only be assigned a parameter value if it has the same data type as the parameter in the function module. The characteristic you use to define the variable also determines its data type. The following characteristics are available:
284 April 2001
SAP AG Process Management (PP-PI-PMA)
Definition of Import Parameters
Characteristic for variable Data type
PPPI_DATE_VARIABLE Date
PPPI_TIME_VARIABLE Time
PPPI_FLOAT_VARIABLE Floating point number
PPPI_STRING_VARIABLE Alphanumeric value
Variable name
• Variable name X
• Blanks and arithmetic operators as part of the variable name
– _<number>, for example, _1, _2
– _COUNT
– _SUM
In general, you can choose any name for a variable. To avoid conflicts with other functions, do not use:
• The following character strings at the end of the variable name:
April 2001 285
Process Management (PP-PI-PMA) SAP AG
Example: Dynamic Function Call / Function Module
Example: Dynamic Function Call / Function Module
Function module: YTS01_READ_YPPPI1
UNIT_OF_MEASURE
PROCESS_ORDER
Export parameters
PH_VALUE
Import parameter
MATERIAL_CONSUMED
PPPI_IMPORT_ PARAMETER
PPPI_INPUT_REQUEST
PPPI_STRING_VARIABLE
Dynamic function callHeaderCharacteristics
PPPI_INPUT_REQUEST
PPPI_BUTTON_TEXT
PPPI_FUNCTION_NAME
PPPI_FLOAT_VARIABLE
PPPI_EXPORT_ PARAMETER
PPPI_STRING_VARIABLE
PPPI_IMPORT_ PARAMETER
MATERIAL_CONSUMED
Quantity MAT32:
AUFTR
YTS01_READ_ YPPPI1Read quantity MAT32
INTRA2
PROCESS_ ORDER
UNIT_OF_ MEASURE
Quantity unit:
UN1
286 April 2001
SAP AG Process Management (PP-PI-PMA)
Calling of any Transaction
Calling of any Transaction Use You can use this function from within the PI sheet to call all R/3 transactions that start a task function.
Features You can use function call TA_CALL (function module COPF_CALL_TRANSACTION) available in the standard system to call a transaction from the PI sheet.
You use the parameters of the function call to specify the following:
• The transaction code of the transaction you want to call
Note that function call TA_CALL only supports transactions that call a specific task function, such as the Goods issue function (transaction MB1A). It does not support transactions that you use to branch to an area menu, such as the Inventory Management menu (transaction MB00).
In the master recipe or process order, you define the function call for the phase for which you want to call the transaction in the PI sheet.
• The indicator that specifies whether the transaction is called in a second session
The transaction is started in a new session if you assign value x to the NEW_SESSION parameter.
April 2001 287
Process Management (PP-PI-PMA) SAP AG
Accessing of Order Confirmation
Accessing of Order Confirmation You can access order confirmation for phases from within a PI sheet using the dynamic function call CONF_PH. In the function call, the following information is transferred to the function module COPF_ENTER_CONFIRMATION:
• Process order for which the confirmation function is to be called up
• Phase for which the confirmation is to be called up
• Transaction to be used for calling up the confirmation function. You can use the following transactions:
− Enter confirmation for time ticket
− Enter confirmation for time event
− Display confirmation
The function module calls up order confirmation according to the specifications made in the dynamic function call. Note, however, that maintaining confirmations is not possible in the following cases even if you have specified a maintenance transaction in the function call:
• When you process a PI sheet for test purposes
• When you display a PI sheet
288 April 2001
SAP AG Process Management (PP-PI-PMA)
Displaying of Material Quantity Calculation
Displaying of Material Quantity Calculation You can display the material quantity calculation of an order in the PI sheet using the dynamic function call MAT_CALC (function module COPF_MATERIAL_QUANTITY_CALC). The function module displays the material quantity calculation for the process order specified in the function call. You cannot change the calculation data from within the PI sheet.
April 2001 289
Process Management (PP-PI-PMA) SAP AG
Displaying of Documents From Document Management System
Displaying of Documents From Document Management System You can display documents that have been created within the document management system using the function call DOC_SHOW (function module COPF_DOCUMENT_SHOW_DIRECT). In the function call, the following information is transferred to the function module:
• Document type
• Document name
• Document version
This function can be used, for example, to display standard operating procedures within the PI sheet which you have stored in an optical archive according to the guidelines on Good Manufacturing Practices (GMP).
• Document part
Using this information, the desired document is identified within the document management system. The system then locates the corresponding original and displays it.
290 April 2001
SAP AG Process Management (PP-PI-PMA)
Calculation of Time Intervals and Dates
Calculation of Time Intervals and Dates
The calculation is carried out on the basis of the valid calendar, that is weekends and public holidays are not included in the duration. They are, however, used to calculate the start and end dates.
Features
You can use function call C_DURAT (function module COPF_DETERMINE_DURATION) for this.
The function module contains the following export parameters:
You transfer these values from a preceding process instruction using variables; see Use of Variables in Process Instructions [Page 304].
Use If you have entered the duration, start or end dates of time intervals in the PI sheet, you can use a function call to calculate the missing data from this (for example, calculate the end date from the start and duration).
Calculating the Duration from the Start and End Date
Start and end dates (date and time) •
• The time unit of the duration if it is not to be calculated in days
• If required, a factory calendar
If you do not assign a calendar, the Gregorian calendar is used.
The duration is defined as an import parameter in the function call. It is calculated by the function module and transferred to the PI sheet in the time unit you have specifies. It is displayed after the corresponding pushbutton.
Calculating the End Date from the Duration and Start Date
•
You can use function call C_END_T (function module COPF_DETERMINE_END_TIME) for this.
The function call contains the following export parameters:
Start date (date and time) and duration (without weekends and public holidays)
You transfer these values from a preceding process instruction using variables; see Use of Variables in Process Instructions [Page 304].
• The time unit of the duration if it is not specified in days
• If required, a factory calendar
If you do not assign a calendar, the Gregorian calendar is used.
The end date and time are defined as import parameters in the function call. They are calculated by the function module and transferred to the PI sheet. They are displayed after the corresponding pushbutton.
April 2001 291
Process Management (PP-PI-PMA) SAP AG
Calculation of Time Intervals and Dates
Calculating the Start Date from the Duration and End Date You can use function call C_STRT_T (function module COPF_DETERMINE_START_TIME) for this.
The function call contains the following export parameters:
End date (date and time) and duration (without weekends and public holidays) •
You transfer these values from a preceding process instruction using variables; see Use of Variables in Process Instructions [Page 304].
• The time unit of the duration if it is not to be specified in days
• f required, a factory calendar
If you do not assign a calendar, the Gregorian calendar is used.
The start date and time are defined as import parameters in the function call. They are calculated by the function module and transferred to the PI sheet. They are displayed after the corresponding pushbutton.
292 April 2001
SAP AG Process Management (PP-PI-PMA)
Physical-Sample Record Creation
Physical-Sample Record Creation
See also:
Prerequisites For you to create physical-sample records from within the PI sheet, the following requirements must be met:
• An in-process quality inspection has been defined for the material you want to produce in the material master record (Quality Management view)
• Sample management has been activated in the master recipe of the corresponding process order (see Planning the Physical Samples [Ext.]).
• An inspection lot for quality inspection during production has been created for the process order
In the master recipe or process order, you include the function call at the position at which you may require additional physical samples.
The function module contains the following import parameters:
• The number of the operation or phase for which you want to create an inspection point for the physical sample
Use
In a physical-sample record, you document and manage all data required for the inspection of a specific physical sample, such as sample-drawing instructions and inspection results. You record the inspection results for the relevant physical sample for the project.
If you use sample management of the Quality Management (QM) component for quality inspections during production, the system also creates data records for all planned physical samples together with the inspection lot. You can use this function to create additional data records for unplanned physical samples together with inspection points for these samples from within the PI sheet. The system takes you directly to the Create physical-sample drawing function in quality management.
Sample Management [Ext.]
Features
• The inspection lot number for which you want to create a physical-sample drawing
If you assign the number of an operation or phase to the Operation number parameter, the system automatically sets the Create inspection points indicator on the Create New Physical-Sample Drawing with Reference screen and displays the operation number or phase number you have specified in the Operation field. You can change these settings.
You can use function call QMJMP_NS (function module QPRS_PI_NEW_SAMPLE_DRAW) available in the standard system to create physical-sample records.
As a result of these settings, the system creates an inspection point for the physical sample. This inspection point is displayed in the worklist of results recording below the relevant operation or phase. From here, you can jump directly to results recording for the physical sample.
April 2001 293
Process Management (PP-PI-PMA) SAP AG
Physical-Sample Record Creation
If you do not specify an operation or phase, the system creates an inspection point for each physical sample and each operation and phase.
In automatic characteristic value assignment, the system transfers the inspection lot number and the operation or phase number from the process order to the function call.
In the PI sheet, you use the function call to start the QM transaction for manually creating physical-sample records. For more information on how to carry out this transaction, see New Physical-Sample Drawing with Reference [Ext.] ). The system does not execute the function call:
• When you process a PI sheet for test purposes
• When you display a PI sheet
294 April 2001
SAP AG Process Management (PP-PI-PMA)
Processing of Physical-Sample Drawings
Processing of Physical-Sample Drawings Use If you use sample management of quality management (QM) for quality inspections during production, the system assigns a physical-sample drawing number when it creates the inspection lot. This number combines the data records of all physical samples of an inspection lot.
See also:
You can use this function to jump to physical-sample drawing of the relevant inspection lot from within the PI sheet and process the physical-sample records. You can, for instance, release or lock physical samples or print labels.
Sample Management [Ext.]
Prerequisites
•
For you to process the physical-sample drawing of an inspection lot from within the PI sheet, the following requirements must be met:
An in-process quality inspection has been defined for the material you want to produce in the material master record (Quality Management view).
• Sample management has been activated in the master recipe of the corresponding process order (see Planning the Physical Samples [Ext.]).
The sample-drawing procedure specifies whether the drawing of physical samples must be confirmed, that is, whether the samples must be released after sample drawing.
• An inspection lot and a physical-sample drawing number for inspection during production has been created for the process order.
Features You can use function call QMJMP_SD (function module QPRS_PI_SAMPLE_DRAW_PROCESSING) available in the standard system to process physical-sample drawings.
In the master recipe or process order, you include the function call at the stage at which you want to release or lock your physical samples or process them in any other way. The function call’s only export parameter is the inspection lot number for the inspection during production. It is passed on during automatic characteristic value assignment in the process order.
In the PI sheet, you use the function call to start the QM transaction for processing the physical-sample drawing. For more information on how to carry out this transaction, see Processing a Physical-Sample Drawing [Ext.]. The system does not execute the function call:
• When you process a PI sheet for test purposes
• When you display a PI sheet
April 2001 295
Process Management (PP-PI-PMA) SAP AG
Accessing Material Identification
Accessing Material Identification Use You can use this function to identify and verify ingredients at the production line.
The system uses the material list of the process order to check whether the components that flow into production belong to the process order. This prevents the wrong materials from entering production.
The material identification check does not include a check of the staged quantities.
Integration
Material identification is carried out using a dynamic function call in the PI sheet.
The standard process instruction category MI_MATBA must be maintained in the master recipe for material identification to be carried out.
The following parameters are variable:
Material identification is based on the material list of the process order.
Prerequisites
Characteristic Characteristic Values Options
Standard text that appears on a button in the PI sheet
PPPI_FUNCTION_DURING_DISPLAY -/0/1 Function during the display: -> No entry 0 -> Not allowed 1 -> Allowed
PPPI_EXPORT_PARAMETER
PPPI_MI_IDENT_LEVEL
I_CHECK Material identification level: -> No entry A -> For the order V -> For the operation P -> For the phase
I_COMPL Type of check: -> No entry N -> Component check Y -> Start quantities
PPPI_EXPORT_PARAMETER PPPI_MI_BATCH_SPLIT
I_BATCH_SPLITT Batch split allowed: -> No entry Y -> Yes N -> No
PPPI_EXPORT_PARAMETER PPPI_MI_GET_ALLOWED_VALUES
I_VALREQ Activate F4-help for required material: -> No entry Y -> Yes N -> No
PPPI_BUTTON_TEXT MI for material / batch
PPPI_EXPORT_PARAMETER PPPI_MI_CHECK_FOR_START_QUY
296 April 2001
SAP AG Process Management (PP-PI-PMA)
Accessing Material Identification
PPPI_EXPORT_PARAMETER PPPI_MI_DISPLAY_MATLIST
I_SHOW Display of required material allowed: -> No entry Y -> Yes N -> No
PPPI_EXPORT_PARAMETER PPPI_MI_MAT_TYPE_IN_RESERV_LIST
I_RESBTYP Variable is alphanumeric: No entry A -> All materials P -> Pipeline materials R -> Backflushed materials X -> Backflushed materials and pipeline materials N -> All materials except backflushed and pipeline
The following parameters are not variable or are copied:
Characteristic Characteristic Values Options
PPPI_FUNCTION_NAME MI_MATERIAL_CHECK_DIALOG
Function module name
I_AUFNR Order number is copied
PPPI_EXPORT_PARAMETER PPPI_RESERVATION
I_RSNUM Reservation number is copied
PPPI_EXPORT_PARAMETER PPPI_OPERATION
I_VORNR Operation number is copied
PPPI_EXPORT_PARAMETER PPPI_PHASE
I_PHASE Phase number is copied
PPPI_EXPORT_PARAMETER PPPI_STRING_CONSTANT
I_INPUT Is not used at this time: SPACE
PPPI_IMPORT_PARAMETER
PPPI_STRING_VARIABLE
MATBA_RESULT_&0065&
E_TEXT Text result: start quantity check (irrelevant for component check):
PPPI_EXPORT_PARAMETER PPPI_PROCESS_ORDER
Features 1. Material identification includes the following checks:
− Start quantity check
At the beginning of production, an amount of each component for the process order must be available, independent of the total required quantity for the process order. The system does not enter the quantity of the identified material.
The start quantity check implies a component check.
− Component check
The system only checks whether or not the identified components belong to the process order.
2. Material identification can be carried out at different times in the process order. The checks take place as defined in the master recipe
April 2001 297
Process Management (PP-PI-PMA) SAP AG
Accessing Material Identification
− For the entire process order
− For the operation or phase
3. Each successful start quantity check and component check are entered in the batch record (EBR).
The start quantity check data is automatically transferred to the batch record when you save. Messages are transferred to the message destination PI01 by way of the standard process message category PI_MIREC.
The following characteristics are transferred:
Characteristic Description
PPPI_BATCH Batch
PPPI_EVENT_DATE Date of event
PPPI_EVENT_DATE Time of event
Level of identification
PPPI_MATERIAL Material number
PPPI_MATERIAL_QUANTITY Material quantity
PPPI_MI_MAT_TYPE_IN_RESER_LIST Selection of reservation item
PPPI_OPERATION Operation number
PPPI_PHASE Phase number
PPPI_PROCESS_ORDER Process order
PPPI_RESERVATION_ITEM Item number of the reservation
PPPI_UNIT_OF_MEASURE Unit of measure
PPPI_USER User
PPPI_MI_IDENT_LEVEL
4. Batch split
If the batch of a component is not specified in the material list of the process order, a batch split can be carried out during material identification. The identified batch is transferred to the material list of the process order when you save the material identification.
In this case, one unit of measurement of the identified batch is always transferred to the material list. However, the quantity that actually flows into production is not saved.
The batch split can theoretically be carried out until the requirements quantity of the component is covered by the identified batch.
The selection criteria for batch determination can be used to specify and limit the number of possible batches that are allowed for production.
298 April 2001
SAP AG Process Management (PP-PI-PMA)
Carrying Out Material Identification
Carrying Out Material Identification Start Quantity Check 1. From the PI sheet, call up the start quantity check.
The Material Identification: Start Quantity Check dialog box appears.
2. Enter the material to be identified and, if possible, the batch.
− If the material belongs to the process order, this is confirmed with a green checkmark.
− If the material does not belong to the process order, an error message appears.
− If a partial quantity could be identified from each component of the process order, this is confirmed in the PI sheet.
The identification of the materials is saved and the identified materials are marked with a green dot in the start quantity check.
− If not all of the components of the process order could be identified, an error comment appears in the PI sheet. In this case, the start quantity check is not considered to be executed.
1. From the PI sheet, call up the component check.
The Material Identification: Component Check dialog box appears.
Depending on how it was defined in the master recipe, the components are displayed from the material list of the process order.
− If the material belongs to the process order, this is confirmed with a green checkmark.
− If the material does not belong to the process order, an error message appears.
3. To complete the component check, choose Save.
Depending on how it was defined in the master recipe, the components are displayed from the material list of the process order.
3. To complete the start quantity check, choose Save.
Component Check
2. Enter the material to be identified and, if possible, the batch.
This results in the following:
− Batch splits that were carried out are transferred to the material list of the process order
− The identified materials are entered in the batch record.
April 2001 299
Process Management (PP-PI-PMA) SAP AG
Type 7: Sequence Definitions
Type 7: Sequence Definitions
The characteristic PPPI_PREDECESSOR can be used only once in a sequence definition. If a phase has several predecessors, a separate sequence definition has to be created for each of them.
Notes on Using Sequence Definitions
In a sequence definition [Ext.], you need to specify the number of the phase which has to be finished before the phase containing the sequence definition can be processed in the PI sheet.
Allowed values
Assign the following characteristic:
Characteristic Meaning
PPPI_PREDECESSOR Number of the phase which has tobe processed first (predecessor phase)
Number of a phase contained in the current order
• Always insert sequence definitions at the start of a phase before the other process instructions.
• Sequence definitions have been designed in order to transfer the phase relationships defined in a process order to the corresponding PI sheets. They are generated automatically if you have made the corresponding settings in Customizing for the control recipe destination. The value of the characteristic PPPI_PREDECESSOR is assigned automatically during the generation process.
• Do not use sequence definitions in combination with hidden data requests for the following reasons:
– Hidden data requests are not taken into account when the system checks whether a phase has been fully processed.
– If hidden data requests are used at the start of a phase, it is possible that the corresponding messages are created at the wrong time or that they are not created at all because their phase is still locked when the previous message is sent.
300 April 2001
SAP AG Process Management (PP-PI-PMA)
Variables in Process Instructions
Variables in Process Instructions Use
Variables that you define yourself and use to transfer characteristic values from one process instruction to another. You have the following options:
− Within one control recipe simple variables
− Between different control recipes of a process order global variables
User-Defined VariablesTo use variables to transfer values, you must define the value to be transferred. For more information on how to define a variable for a characteristic value, see Definition of Variables [Page 302].
You can use the following types of variables in process instructions:
•
• Variables whose values have been predefined by SAP system variables
You can now use the characteristic value that you have defined by way of the variable somewhere else in the control recipe. When you want to use variables, you must distinguish between simple and global variables.
•
•
−
Simple variables To use simple variables, you need to specify the variable name.
Global variables When you use global variables, you must distinguish between variables that you want to use in the ABAP list-based PI sheet or in the browser-based PI sheet.
In ABAP list-based PI sheets (control recipe destination type 1), you only need to specify the variable name to use global variables. For more information, see Using Variables in ABAP List-Based PI Sheets [Page 304].
− In browser-based PI sheets (control recipe destination type 4), you must first declare the global variable that you have defined in another control recipe in the control recipe in which you want to use it. Only then can you specify the variable name at the position where you want to use the variable. For more information, see Using Variables in Browser-Based PI Sheets [Page 306].
You can use system variables in browser-based PI sheets only. To use them, you need to specify the name of the system variable you want to use in the process instruction. For more information, see Using System Variables in Browser-Based PI Sheets [Page 309].
SAP System Variables
April 2001 301
Process Management (PP-PI-PMA) SAP AG
Definition of Variables
Definition of Variables Use You define variables if you want to transfer the value of a message characteristic to another process instruction.
You can define variables in the following cases, for example:
• Variables in entries to refer to the values to be entered See also: Type 0: Definition of Entries [Page 42 ]4
Variables in calculations to refer to the values to be calculated See also: Type 0: Definition of Calculations [Page 44 ]0
•
Variables that refer to characteristics whose values are assigned automatically; See also: Type 0: Definition of Automatic Value Assignment [Page 44 ]4
•
Variables in dynamic function calls to refer to the import parameters that are transferred to the PI sheet; See also: Type 0: Definition of Import Parameters [Page 452]
•
Features You can define a variable for every message characteristic of a process instruction. The data type of the variable is identical to that of the message characteristic (for example, CHAR or NUM).
The following types of variables are distinguished:
Simple variables (PPPI_VARIABLE) •
•
− Can be defined in PI sheets and process manufacturing cockpits
− Are only valid for the PI sheet or cockpit in which they have been defined
Global variables (PPPI_GLOBAL_VARIABLE)
− May only be defined in PI sheets and there may only be used in simple data requests
Activity In PI Sheets To define a variable, you assign one of the following characteristics immediately before the message characteristic in the process instruction:
Characteristic Meaning Value
PPPI_VARIABLE Variable that is valid within the PI sheet New variable name
PPPI_GLOBAL_VARIABLE Global variable that is valid for the entire process order
New variable name
In Process Manufacturing Cockpits To define a variable, you assign one the following characteristic immediately before the message characteristic in the process instruction:
302 April 2001
SAP AG Process Management (PP-PI-PMA)
Definition of Variables
Characteristic Meaning Value
PPPI_VARIABLE Variable that is valid within the PI sheet or cockpit New variable name
In general, you can choose any name for a variable. To avoid conflicts with other functions, do not use:
•
•
•
•
−
Variable name X
Variable names that start with SY_ since these are system variables predefined by SAP
Blanks and arithmetic operators as part of the variable name
The following character strings at the end of the variable name:
− _<number>, for example, _1, _2
− _COUNT
_SUM
For more information, see Using Variables in Browser-Based PI Sheets [Page 30 ]6 .
April 2001 303
Process Management (PP-PI-PMA) SAP AG
Using Variables in ABAP List-Based PI Sheets
Using Variables in ABAP List-Based PI Sheets Use You use variables in process instructions if you want to refer to a characteristic of a preceding process instruction. Using the variable, you transfer the value of this characteristic to the current process instruction. You can use variables:
• In process data requests to define default values [Page 242] and input validations [Page 246]
• In hidden process data requests to assign characteristic values using variables [Page ] 258
In process data requests and process data calculation formulas to define output values [Page 260]
•
In process data calculation formulas to define calculation formulas [Page 270] •
• In dynamic function calls to define export parameters [Page 280] and changing parameters [Page 282]
Prerequisites
•
• The variable has been defined in a preceding process instruction and is valid for the PI sheet or the entire process order.
Exception: In input validations, variable X always refers to the preceding input value. You need not define it in the process instruction.
• The variable’s data type is suitable for the purpose for which you want to use the variable. You need:
− Data type NUM for check formulas of input validations and for calculation formulas
− The data type of the corresponding parameter for check functions of input validations and for dynamic function calls
− The data type of the relevant input value for default values
− Any data type for output values
− The data type of the message characteristic to be assigned a value for hidden data requests
The data type of a variable is identical to that of the characteristic or parameter to which it refers.
See also:
Definition of Variables in Process Data Requests and Calculation Formulas [Page 244]
• Definition of Import Parameters [Page 28 ]4
Features Variables defined in a simple data request or function call refer to exactly one value. In this case, you must only enter the variable name to transfer the value of another process instruction.
304 April 2001
SAP AG Process Management (PP-PI-PMA)
Using Variables in ABAP List-Based PI Sheets
Variables defined in a repeated data request, however, represent an entire table column. To refer to a specific table entry, you must extend the variable name. The following rules apply:
<Variable name>_1 -> Value in first line of table
<Variable name>_2 -> Value in second line of table
And so on And so on
<Variable name>_SUM -> Sum of the values in the table column
<Variable name>_COUNT -> Number of values in the table column
If a variable was defined for the entire process order, the system does not transfer its value to the process instructions of other PI sheets unless it cannot be changed anymore. This is the case after the value has been reported, that is, when the corresponding process message has been transferred to process management to be send to its destination.
April 2001 305
Process Management (PP-PI-PMA) SAP AG
Using Variables in Browser-Based PI Sheets and Cockpits
Using Variables in Browser-Based PI Sheets and Cockpits Use When defining process instructions, you can use simple or global variables that you have defined in another process instruction:
You can use simple variables in both browser-based PI sheets [Page 158] and process manufacturing cockpits [Page 406]. They are valid for the same control recipe or cockpit.
•
You may use global variables in PI sheets but not in cockpits. They are valid for the same process order which means they can be used across different control recipes.
•
•
You can use variables in the following functions, for example:
To display a characteristic value as the default value in entries See also: Type 0: Definition of Default Values [Page 427]
• To transfer a character value that is only available in the PI sheet or cockpit as a parameter value in input validations See also: Type 0: Definition of Input Validations [Page 429]
• To display values in the PI sheet or cockpit that are usually processed in the background (for example, in calculations) See also: Type 0: Definition of Output Fields for Variable Values [Page 439]
• To transfer a characteristic value from one process instruction to another See also: Type 0: Definition of Value Assignment Using Variables [Page 446]
• To transfer the value of an export or changing parameter that is not yet available in the PI sheet or cockpit to the function module See also: Type 0: Definition of Export Parameters [Page 449] and Type 0: Definition of Changing Parameters [Page 451]
− The simple variable must be defined in the same PI sheet or cockpit
Prerequisites • If you want to transfer the value of a variable to the current process instruction, the following
requirements must be met:
− The global variable must be defined for the entire process order
Exception: The following system variables that are defined by SAP and start with SY_ need not be defined in the process instruction:
System Variable Meaning
SY_MODE Current mode of the PI sheet
SY_TEST Status of the PI sheet (test or active)
SY_ROW Current table line
SY_VALUE and X Refers to the immediately preceding input value
306 April 2001
SAP AG Process Management (PP-PI-PMA)
Using Variables in Browser-Based PI Sheets and Cockpits
See also: Using System Variables [Page 309]
• The variable’s data type is suitable for the purpose for which you want to use the variable. You need:
− Data type NUM for check formulas of input validations and for calculation formulas
− The data type of the relevant input value for default values
− Any data type for output values
− The data type of the message characteristic to be assigned a value for hidden data requests
See also: Definition of Variables [Page 30 ]2
Activities
In simple data requests Simple variables defined in a simple data request or function call refer to exactly one value. In this case, you must only enter the variable name to transfer the value into another process instruction.
In repeated data requests
− The data type of the corresponding parameter for check functions of input validations and for dynamic function calls
The data type of a variable is identical to that of the characteristic or parameter to which it refers.
Using Simple Variables •
•
Simple variables defined in a repeated data request, however, represent an entire table column. To refer to a specific table entry, you must extend the variable name. The following rules apply:
<Variable name>_1 -> Value in first line of table
-> Value in second line of table
And so on And so on
<Variable name>_SUM -> Sum of the values in the table column
<Variable name>_COUNT -> Number of values in the table column
<Variable name>_2
Using Global Variables •
You may define and use global variables in simple data requests of PI sheets only. You must first declare the global variable in the control recipe in which you want to use it. You can declare and use as many global variables in a process instruction as you like.
To do so, you define the following information in the process instruction:
In simple data requests
− The variable name you want to declare
− The characteristic that specifies the type of variable used
April 2001 307
Process Management (PP-PI-PMA) SAP AG
Using Variables in Browser-Based PI Sheets and Cockpits
To enter this information, you assign the following characteristics to the process instruction in the order specified below:
Characteristic Meaning Allowed Values
PPPI_DECLARE_VARIABLE Declaration of global variable Existing variable name
PPPI_VARIABLE_TYPE Type of variable Characteristic used to define the global variable
• In repeated data requests
However, you can refer to individual values in a table. To do so, you must define a variable with an extension for the relevant table line for each table value by adding _1, _2, _3, and so on to the variable name for each table line.
Example:
VALUE_1 -> Value in the first table line VALUE_2 -> Value in the second table line and so on
You cannot use global variables to transfer entire tables (repeated data request) to another control recipe.
To be able to use the variables in a control recipe, you must then first declare each name (along with the above extension) in the recipe in which you want to use the variable.
308 April 2001
SAP AG Process Management (PP-PI-PMA)
Using System Variables in Browser-Based PI Sheets
Using System Variables in Browser-Based PI Sheets Use System variables have been predefined by SAP. You can use these variables in formulas or, for example, to pass on certain pieces of information to a function module. How the function called by the function module behaves depends on the type of information passed on.
At present, you can use the following system variables:
System Variable Use Meaning
SY_MODE In function modules Current mode of the PI sheet
SY_TEST In function modules Status of the PI sheet (test or active)
SY_ROW In function modules Current table line
SY_VALUE or X
Generally Refers to the immediately preceding input value
Features Variable SY_MODE You use variable SY_MODE to tell the function module in which mode you currently are the PI sheet. Depending on this information, the function called by the function module is either started in the display or change mode.
You can pass on the following values for SY_MODE:
Variable Value Meaning
'EDIT' For change mode
'SHOW' For display mode
For simulation mode 'SIMULATION'
Variable SY_TEST You use variable SY_TEST to tell the function module whether you currently are in an active PI sheet or a test PI sheet. Depending on this information, the function called by the function module is either started in the display or change mode.
You can pass on the following values for SY_TEST:
Variable Value Meaning
' ' (blank) For active PI sheet
'X' For test PI sheet
Variable SY_ROW If you have defined dynamic function calls in a repeated data request (table), you can use variable SY_ROW to tell the function module in which table line you currently are.
April 2001 309
Process Management (PP-PI-PMA) SAP AG
Using System Variables in Browser-Based PI Sheets
Variable SY_VALUE or X Variable SY_VALUE or X always refer to the value entered immediately before.
Example If you want to be able to jump to inspection results recording for the inspection point in quality management in the PI sheet, you must use function module COPFX_QM_INSPECTION_RESULT_REC to define a function call.
For the function module to be able to know in which mode the called transaction is to be started, you must use system variables SY_MODE and SY_TEST to pass on the information about the current status of the PI sheet to the function module. In this function module, you use parameters MODE and TEST_FLAG to pass on the variables.
To specify this information in the process instruction, you assign the following characteristics:
Characteristic Value
...
PPPI_FUNCTION_NAME COPFX_QM_INSPECTION_RESULT_REC
...
PPPI_EXPORT_PARAMETER MODE
PPPI_STRING_VARIABLE SY_MODE
PPPI_STRING_VARIABLE SY_TEST
...
PPPI_EXPORT_PARAMETER TEST_FLAG
Depending on the mode in which you currently are in the PI sheet, the corresponding mode is called in inspection results recording:
Variable Value Transaction Called
SY_TEST SY_MODE
SHOW = display Display Results for Inspection Point: Initial Screen
' ' (blank) = active EDIT = change Change Results for Inspection Point: Initial Screen
' ' (blank) = active SIMULATION = simulation Display Results for Inspection Point: Initial Screen
'X' = test SHOW = display Display Results for Inspection Point: Initial Screen
'X' = test EDIT = change Display Results for Inspection Point: Initial Screen
'X' = test SIMULATION = simulation Display Results for Inspection Point: Initial Screen
' ' (blank) = active
310 April 2001
SAP AG Process Management (PP-PI-PMA)
Using System Variables in Browser-Based PI Sheets
April 2001 311
Process Management (PP-PI-PMA) SAP AG
Using Text Symbols in Process Instructions
Using Text Symbols in Process Instructions Use You use this function in process instructions for the R/3 PI sheet to refer to the value of another characteristic from a short text or long text (or from an alphanumeric characteristic value).
In the process order, the system replaces the text symbol with the corresponding characteristic value:
• When you start automatic characteristic value assignment
• When you create the control recipe that contains the process instruction
Prerequisites The text field is long enough and can accommodate the text symbol (see information on the syntax in the Features section).
In addition, one of the following requirements is met:
• The value of the characteristic to which the text symbol refers can be assigned automatically in the process order or when you create a control recipe.
• You maintain a process data request or process data calculation formula. The characteristic to which the text symbol refers is assigned as a message characteristic in the same process instruction.
The process instruction assistant does not support text symbols that refer to the value of a control characteristic.
Features Depending on whether you maintain your process instructions in the process instruction assistant or on the characteristic overview, you create the text symbols with the help of the system or manually (see the Activities section). If you create text symbols manually, you must use the following syntax:
For characteristics whose values can be assigned automatically: &<characteristic name in capital letters>& (refer to Text Symbols for Automatic Value Assignment - Example [Page 314])
•
• For message characteristics that are assigned to the same process instruction: &<four-digit sort number assigned to the characteristic in the process instruction>& (refer to Text Symbols for Message Characteristics - Example [Page 315])
Activities In the process instruction assistant, you insert text symbols in short texts with the help of the system (refer to Inserting Text Symbols in the PI Assistant [Ext.]).
In the following cases, you must insert text symbols manually following the syntax described above:
• In short texts, if you maintain your process instructions on the characteristic overview
312 April 2001
SAP AG Process Management (PP-PI-PMA)
Using Text Symbols in Process Instructions
• In long texts, irrespective of whether you use the process instruction assistant or the characteristic overview
To manually insert the text symbol, you proceed as follows:
If you use the SAPscript editor, you directly insert the text symbol in the text field. −
− For more information on how to insert text symbols in the PC editor, see Inserting Text Symbols in the PC Editor [Ext.].
April 2001 313
Process Management (PP-PI-PMA) SAP AG
Example: Text Symbols for Automatic Value Assignment
Example: Text Symbols for Automatic Value Assignment An operation has resource R_1110 assigned to it. For the first phase assigned to this operation, you have defined a process parameter containing the following control instruction:
Characteristic
Value
PPPI_INSTRUCTION Turn on resource &PPPI_PHASE_RESOURCE&...
When the corresponding control recipe is created, the name of the resource assigned to the superior operation is automatically assigned to characteristic PPPI_PHASE_RESOURCE. The text symbol &PPPI_PHASE_RESOURCE& is replaced by this value. Consequently, the control instruction in the PI sheet reads as follows:
Turn on resource R_1110....
314 April 2001
SAP AG Process Management (PP-PI-PMA)
Example: Text Symbols for Message Characteristics
Example: Text Symbols for Message Characteristics A process data requests for a material consumption message contains the following characteristics, for example:
Sort no. Characteristic
Value
0060 PPPI_MATERIAL M1506
0300 PPPI_INPUT_REQUEST Quantity of material &0060&:
When the corresponding control recipe is created, text symbol &0060& is replaced by the value assigned to characteristic no. 0060. Consequently, the input request in the PI sheet reads as follows:
Quantity of material M1506:
April 2001 315
Process Management (PP-PI-PMA) SAP AG
Worklist for PI Sheets
Worklist for PI Sheets Use You can use several different transactions available in the PI Sheet menu in process management to select PI sheets.
•
•
•
−
•
You can use the Find PI Sheets transaction for a general PI sheet selection. After calling the transaction, a selection screen appears on which you can enter your selection criteria. The worklist appears only after you have chosen Execute.
The following transactions are available for a specific PI sheet selection:
− Worklist - Maintain
− Worklist - Complete
− Worklist - Check
In this way, the functions provided are tailored according to your role in the plant. The shift manager, for example, is mainly interested in checking and completing PI sheets, whereas the process operator is responsible for maintaining them. Each of the three worklists provides a special selection of PI sheets for the processing type you have chosen. When you choose Worklist - Complete, for example, the system only displays PI sheets that have status To be completed.
Features SAP has defined a selection variant and a display variant for each of the above-mentioned transactions. Each of the three selection variants for worklists is assigned to one user parameter. You can also define your own selection and display variants.
You can enter the user parameters in your user master record and assign the appropriate standard selection variant or your own selection variant to it. The selection variants themselves can have your own or standard display variants assigned to them.
You can create selection variants as follows:
− In Customizing for Process Management by choosing Control Recipes/PI Sheets -> Selection Variants for PI Sheets -> Define Selection Variants for PI Sheets
On the selection screen of the relevant transaction by choosing Goto -> Variant -> Save as variant...
You can create display variants in the worklist's list overview. For more information, see the SAP Library by choosing Getting Started -> Lists -> SAP List Viewer (ALV) Grid Control -> Display Variants [Ext.].
You can enter user parameters in your user master record in Customizing for Process Management by choosing Control Recipes/PI Sheets -> Selection Variants for PI Sheets -> Assign Selection Variant to User.
•
Depending on the settings you have made in your user master record, one of the following screens appears after you have called the relevant transactions:
• The selection screen containing predefined selection criteria for the processing type you have chosen. You can change these criteria. The worklist only appears after you have chosen Execute.
316 April 2001
SAP AG Process Management (PP-PI-PMA)
Worklist for PI Sheets
• The worklist with the standard selection variant and the standard display variant
• The worklist with the standard selection variant and your own display variant
• The worklist with your own selection variant and the standard display variant
• The worklist with your own selection variant and your own display variant
For information about the user parameters you can use and the criteria defined in the standard selection variants and standard display variants, see:
Worklist for Maintaining PI Sheets [Page 322] •
Worklist for Completing PI Sheets [Page 325] •
Worklist for Checking PI Sheets [Page 328] •
Selection Criteria for the Worklist You can define the following criteria on the selection screen to define which PI sheets will be included in the worklist:
•
•
−
•
PI sheet data, such as:
− The plant in which the PI sheet was created
− The number of the control recipe from which the PI sheet was created
− The operating group that is responsible for maintaining the PI sheet
− The control recipe destination to which the PI sheet was sent
− The date and time when the PI sheet was created
Mode of the PI sheet
− Active PI sheets (no test)
− Test PI sheets
Active and test PI sheets (all)
Status of the PI sheet [Page 331]
− New
− In process
− To be completed
− Canceled
− Discarded
− Completed
− Archived (EBR)
Order data, such as: •
− Order number
− The resource to which the PI sheet refers
− Basic dates and scheduled start and finish
April 2001 317
Process Management (PP-PI-PMA) SAP AG
Worklist for PI Sheets
Further material-related data, such as: •
•
•
•
•
•
− The material to be produced
− The batch to be produced
The inspection lot if a quality inspection is to carried out for the process order
In you want, a display variant that determines how the list is prepared for display in the worklist
Worklist Functions The worklist is displayed in a table-like overview. In the worklist, you can do the following, for example:
Sort PI sheets according to different criteria
Display or maintain individual PI sheets
Delete PI sheets
For more information about the general list handling, see the SAP Library by choosing Getting Started -> Lists -> SAP List Viewer (ALV) Grid Control -> Display Variants [Ext.].
Information in the Worklist Depending on the type of worklist you have called, the following additional information is displayed for the individual PI sheets:
The Traffic lights icons in the Messages column indicate whether a process message was sent successfully for a PI sheet. The icons mean the following:
•
Icons in Messages Column Meaning
No messages available No messages have been created so far.
All messages sent All messages have been sent. There may be messages with warnings.
At least 1 message to be sent
- At least one message has been created but not yet been sent. - At least one message must be resubmitted. - At least one message must be resubmitted and contains warnings.
At least 1 message with errors
At least one message could not be sent because: - It is incomplete - It could not be processed by one of the destinations - An error occurred and message processing was terminated.
The message monitor provides information about the error that may have occurred. For more information about the process message statuses and their meaning, see Display of Process Message Lists [Page 80].
The icon indicates that there are deviations in entries in the PI sheet. •
The icon indicates that there is at least one comment in the PI sheet. •
318 April 2001
SAP AG Process Management (PP-PI-PMA)
Worklist for PI Sheets
April 2001 319
Process Management (PP-PI-PMA) SAP AG
Finding PI Sheets
Finding PI Sheets Use If you do not want to select PI sheets for a specific processing type, you can use this search function.
Features Standard Selection Variant and Standard Display Variant The following standard selection variant and standard display variant has been predefined by SAP for the Find PI Sheet transaction:
Standard Selection Variant Standard Display Variant
SAP&PI_SEARCH 0PI_SEARCH
The SAP&PI_SEARCH selection variant comprises the following predefined selection criteria:
• Plant-independent search (the Plant field therefore is not required)
• PI sheets that have not been created for test purposes
• PI sheets that have statuses New, In Process; To be Completed, Canceled, Discarded, Completed, Archived (EBR)
The 0PI_SEARCH display variant defines the following list structure:
• The PI sheets are sorted by plant, order number, and operating group.
• For a PI sheet, you also see the control recipe number, status, test indicator, batch, and inspection lot as well as the date and time at which the PI sheet was created.
No user parameter has been defined for the Find PI Sheet transaction since it is not user-specific. This means that when you call the transaction, the selection screen with criteria defined in the standard selection variant SAP&PI_SEARCH appears. You can, however, change these criteria.
After choosing Execute, the worklist appears:
With the selection criteria defined in the SAP&PI_SEARCH selection variant •
• With the list structure defined in the 0PI_SEARCH display variant
Activities To find PI sheets, proceed as follows:
1. In the SAP menu, choose Logistics -> Production - Process -> Process Management -> PI Sheet -> Find.
2. The selection screen with the predefined criteria appears. Change the criteria, if required, and choose . The worklist appears.
3. You can carry out the following functions in the worklist by choosing the corresponding icon:
Function Procedure
320 April 2001
SAP AG Process Management (PP-PI-PMA)
Finding PI Sheets
Display PI sheet Select a PI sheet and choose .
Maintain PI sheet Select a PI sheet and choose .
Delete PI sheets Select one or more PI sheets and choose .
April 2001 321
Process Management (PP-PI-PMA) SAP AG
Worklist for Maintaining PI Sheets
Worklist for Maintaining PI Sheets Use You can use this function to create a worklist of only those PI sheets that need to be maintained. You can, for example, use this function if you are a process operator and only want to select PI sheets whose status permits maintenance.
Features Standard Selection Variant and Standard Display Variant For the Worklist - Maintain transaction, SAP has defined the following standard selection variant and standard display variant and assigned them to a user parameter:
User Parameter Standard Selection Variant Standard Display Variant
PI_VAR_WL_WRK SAP&PI_WL_WRK 0PI_WL_WRK
The SAP&PI_WL_WRK selection variant comprises the following predefined selection criteria:
Plant-specific search (the Plant field is a required field) •
•
•
•
•
•
•
•
•
operator-specific search (the operating group field is a required field)
PI sheets that have not been created for test purposes
PI sheets that have status New and are planned for the next 24 hours
PI sheets that have status In process
The 0PI_WL_WRK display variant defines the following list structure:
The PI sheets are sorted by the earliest production start (date and time)
For a PI sheet, you also see the order number, the material number, the material short text, the batch, and the status.
User-Specific Settings Depending on the settings you have made in Customizing for Process Management by choosing Control Recipes/PI Sheets -> Selection Variants for PI Sheets, either a selection screen or the worklist appears directly when you call the Worklist - Maintain transaction.
No settings If you have not made any settings in your user master record, the selection screen with the criteria defined in the standard selection variant SAP&PI_WL_WRK first appears. You can change these criteria.
After choosing Execute, the worklist appears:
− With the selection criteria defined in the SAP&PI_WL_WRK selection variant
− With the list structure defined in the 0PI_WL_WRK display variant
PI_VAR_WL_WRK user parameter, SAP&PI_WL_WRK selection variant, and 0PI_WL_WRK display variant If you have entered the PI_VAR_WL_WRK user parameter and the SAP&PI_WL_WRK standard selection variant with the 0PI_WL_WRK display variant in your user master record,
322 April 2001
SAP AG Process Management (PP-PI-PMA)
Worklist for Maintaining PI Sheets
the system first prompts you for the plant and operating group. You must enter the plant and operating group before the system takes you directly to the worklist:
− With the selection criteria defined in the SAP&PI_WL_WRK selection variant
− With the list structure defined in the 0PI_WL_WRK display variant
PI_VAR_WL_WRK user parameter, SAP&PI_WL_WRK selection variant, and your own display variant If you have entered the PI_VAR_WL_WRK user parameter and the SAP&PI_WL_WRK standard selection variant with the your own display variant in your user master record, the system first prompts you for the plant and operating group. You must enter the plant and operating group before the system takes you directly to the worklist:
•
− With the selection criteria defined in the SAP&PI_WL_WRK selection variant
− With the list structure defined in your display variant
If you use the SAP&PI_WL_WRK standard selection variant, you can also enter a plant and an operating group in your user master record. If you do so, the system does not prompt you for the plant and operating group after you have called the transaction but takes you directly to the worklist. The system automatically takes into account the plant and operating group assigned in your master record when selecting PI sheets. Use the following parameters for the plant and operating group:
• The WRK parameter for the plant
• The STADR parameter for the operating group
PI_VAR_WL_WRK user parameter, your own selection variant, and PI_VAR_WL_WRK display variant If you have entered the PI_VAR_WL_WRK user parameter and your own selection variant with the 0PI_WL_WRK display variant in your user master record, the system takes you directly to the worklist:
•
•
− With the selection criteria defined in your selection variant
− With the list structure defined in the 0PI_WL_WRK display variant
PI_VAR_WL_WRK user parameter, your own selection variant, and your own display variant If you have entered the PI_VAR_WL_WRK user parameter and your own selection variant with your own display variant in your user master record, the system takes you directly to the worklist:
− With the selection criteria defined in your selection variant
− With the list structure defined in your display variant
Activities To call up the worklist for maintaining PI sheets, proceed as follows:
4. In the SAP menu, choose Logistics -> Production - Process -> Process Management -> PI Sheet -> Worklist - Maintain.
− If the system takes you directly to the worklist, continue with step 3.
April 2001 323
Process Management (PP-PI-PMA) SAP AG
Worklist for Maintaining PI Sheets
− If it first takes you to the selection screen with predefined selection criteria, continue with step 2.
2. Change the criteria on the selection screen, if required, and choose . The worklist appears.
3. You can carry out the following functions in the worklist by choosing the corresponding icon:
Function Procedure
Display PI sheet Select a PI sheet and choose .
Maintain PI sheet Select a PI sheet and choose .
Delete PI sheet Select one or more PI sheets and choose .
324 April 2001
SAP AG Process Management (PP-PI-PMA)
Worklist for Completing PI Sheets
Worklist for Completing PI Sheets Use You can use this function to create a worklist of only those PI sheets that need to be completed. You can, for example, use this function if you are a shift manager and only want to select PI sheets whose status permits completion.
Features Standard Selection Variant and Standard Display Variant For the Worklist - Complete transaction, SAP has defined the following standard selection variant and standard display variant and assigned them to a user parameter:
User Parameter Standard Selection Variant Standard Display Variant
PI_VAR_WL_CLS SAP&PI_WL_CLS 0PI_WL_CLS
The SAP&PI_WL_CLS selection variant comprises the following predefined selection criteria:
• Plant-specific search (the Plant field is a required field)
• PI sheets that have not been created for test purposes
• PI sheets that have status To be completed
The 0PI_WL_CLS display variant defines the following list structure:
The PI sheets are sorted by the earliest production start (date and time) •
•
•
For a PI sheet, you also see the order number, the operating group, the material number, the batch, and the inspection lot. In addition, you obtain information about the following:
− Whether messages have been sent
− Whether deviations occurred in entries
− Whether a comment has been entered
User-Specific Settings Depending on the settings you have made in Customizing for Process Management by choosing Control Recipes/PI Sheets -> Selection Variants for PI Sheets, either a selection screen or the worklist appears directly when you call the Worklist - Complete transaction.
No settings If you have not made any settings in your user master record, the selection screen with the criteria defined in the SAP&PI_WL_CLS standard selection variant first appears. You can change these criteria.
After choosing Execute, the worklist appears:
− With the selection criteria defined in the SAP&PI_WL_CLS selection variant
− With the list structure defined in the 0PI_WL_CLS display variant
April 2001 325
Process Management (PP-PI-PMA) SAP AG
Worklist for Completing PI Sheets
PI_VAR_WL_CLS user parameter, SAP&PI_WL_CLS selection variant, and 0PI_WL_CLS display variant If you have entered the PI_VAR_WL_CLS user parameter and the SAP&PI_WL_CLS standard selection variant with the 0PI_WL_CLS display variant in your user master record, the system first prompts you for the plant. You must first enter the plant before the system takes you directly to the worklist:
•
•
− With the selection criteria defined in the SAP&PI_WL_CLS selection variant
− With the list structure defined in the 0PI_WL_CLS display variant
PI_VAR_WL_CLS user parameter, SAP&PI_WL_CLS selection variant, and your own display variant If you have entered the PI_VAR_WL_CLS user parameter and the SAP&PI_WL_CLS standard selection variant with your own display variant in your user master record, the system first prompts you for the plant. You must first enter the plant before the system takes you directly to the worklist:
− With the selection criteria defined in the SAP&PI_WL_CLS selection variant
− With the list structure defined in your display variant
If you use the SAP&PI_WL_CLS standard selection variant, you can also enter a plant in your user master record. If you do so, the system does not prompt you for the plant after you have called the transaction but takes you directly to the worklist. When selecting PI sheets, the system automatically takes the plant into account that has been assigned to your user master record. Use the WRK parameter for the plant.
PI_VAR_WL_CLS user parameter, your own selection variant, and 0PI_WL_CLS display variant If you have entered the PI_VAR_WL_CLS user parameter and your own selection variant with the 0PI_WL_CLS display variant, the system takes you directly to the worklist:
•
•
− With the selection criteria defined in your selection variant
− With the list structure defined in the 0PI_WL_CLS display variant
PI_VAR_WL_CLS user parameter, your own selection variant, and your own display variant If you have entered the PI_VAR_WL_CLS user parameter and your own selection variant with your own display variant in your user master record, the system takes you directly to the worklist:
− With the selection criteria defined in your selection variant
− With the list structure defined in your display variant
Activities To call up the worklist for completing PI sheets, proceed as follows:
5. In the SAP menu, choose Logistics -> Production - Process -> Process Management -> PI Sheet -> Worklist - Complete.
− If the system takes you directly to the worklist, continue with step 3.
326 April 2001
SAP AG Process Management (PP-PI-PMA)
Worklist for Completing PI Sheets
− If it first takes you to the selection screen with predefined selection criteria, continue with step 2.
4. Change the criteria on the selection screen, if required, and choose . The worklist appears.
5. You can carry out the following functions in the worklist by choosing the corresponding icon:
Function Procedure
Display PI sheet Select a PI sheet and choose .
Maintain PI sheet Select a PI sheet and choose .
Delete PI sheet Select one or more PI sheets and choose .
April 2001 327
Process Management (PP-PI-PMA) SAP AG
Worklist for Checking PI Sheets
Worklist for Checking PI Sheets Use You can use this function to create a worklist of only those PI sheets that you want to check. You can use this function, for example, if you are the shift manager and only want to select PI sheets that still need to be checked.
Features Standard Selection Variant and Standard Display Variant For the Worklist - Check transaction, SAP has defined the following standard selection variant and standard display variant and assigned them to a user parameter:
User Parameter Standard Selection Variant Standard Display Variant
PI_VAR_WL_CHK SAP&PI_WL_CHK 0PI_WL_CHK
The SAP&PI_WL_CHK selection variant comprises the following predefined selection criteria:
Plant-specific search (the Plant field is a required field) •
•
•
•
•
•
PI sheets that have not been created for test purposes
PI sheets that have status To be completed
The 0PI_WL_CHK display variant defines the following list structure:
The PI sheets are sorted by the earliest production start (date and time)
For a PI sheet, you also see the order number, the operating group, the material number, the batch, and the inspection lot. In addition, you obtain information about the following:
− Whether messages have been sent
− Whether deviations occurred in entries
− Whether a comment has been entered
User-Specific Settings Depending on the settings you have made in Customizing for Process Management by choosing Control Recipes/PI Sheets -> Selection Variants for PI Sheets, either a selection screen or the worklist appears directly when you call the Worklist - Check transaction.
No settings If you have not made any settings in your user master record, the selection screen with the criteria defined in the SAP&PI_WL_CHK standard selection variant first appears. You can change these criteria.
After choosing Execute, the worklist appears:
− With the selection criteria defined in the SAP&PI_WL_CHK selection variant
− With the list structure defined in the 0PI_WL_CHK display variant
328 April 2001
SAP AG Process Management (PP-PI-PMA)
Worklist for Checking PI Sheets
PI_VAR_WL_CHK user parameter, SAP&PI_WL_CHK selection variant, and 0PI_WL_CHK display variant If you have entered the PI_VAR_WL_CHK user parameter and the SAP&PI_WL_CHK standard selection variant with the 0PI_WL_CHK display variant in your user master record, the system first prompts you for the plant. You must first enter the plant before the system takes you directly to the worklist:
•
•
− With the selection criteria defined in the SAP&PI_WL_CHK selection variant
− With the list structure defined in the 0PI_WL_CHK display variant
PI_VAR_WL_CHK user parameter, SAP&PI_WL_CHK selection variant, and your own display variant If you have entered the PI_VAR_WL_CHK user parameter and the SAP&PI_WL_CHK standard selection variant with your own display variant in your user master record, the system first prompts you for the plant. You must first enter the plant before the system takes you directly to the worklist:
− With the selection criteria defined in the SAP&PI_WL_CHK selection variant
− With the list structure defined in your display variant
If you use the SAP&PI_WL_CHK standard selection variant, you can also enter a plant in your user master record. If you do so, the system does not prompt you for the plant after you have called the transaction but takes you directly to the worklist. When selecting PI sheets, the system automatically takes the plant into account that has been assigned to your user master record. Use the WRK parameter for the plant.
PI_VAR_WL_CHK user parameter, your own selection variant, and 0PI_WL_CHK display variant If you have entered the PI_VAR_WL_CHK user parameter and your own selection variant with the 0PI_WL_CHK display variant, the system takes you directly to the worklist:
•
•
− With the selection criteria defined in your selection variant
− With the list structure defined in the 0PI_WL_CHK display variant
PI_VAR_WL_CHK user parameter, your own selection variant, and your own display variant If you have entered the PI_VAR_WL_CHK user parameter and your own selection variant with your own display variant in your user master record, the system takes you directly to the worklist:
− With the selection criteria defined in your selection variant
− With the list structure defined in your display variant
Activities To call up the worklist for checking PI sheets, proceed as follows:
6. In the SAP menu, choose Logistics -> Production - Process -> Process Management -> PI Sheet -> Worklist - Check.
− If the system takes you directly to the worklist, continue with step 3.
April 2001 329
Process Management (PP-PI-PMA) SAP AG
Worklist for Checking PI Sheets
− If it first takes you to the selection screen with predefined selection criteria, continue with step 2.
6. Change the criteria on the selection screen, if required, and choose . The worklist appears.
7. You can carry out the following functions in the worklist by choosing the corresponding icon:
Function Procedure
Display PI sheet Select a PI sheet and choose .
Maintain PI sheet Select a PI sheet and choose .
Delete PI sheet Select one or more PI sheets and choose .
330 April 2001
SAP AG Process Management (PP-PI-PMA)
Status of PI Sheets
Status of PI Sheets Every PI sheet has a status that documents its current processing status. Every status permits one or more processing types. You may, for example, only complete PI sheets whose status is To be completed.
When you call up a worklist for a particular processing type in the PI Sheets menu, the system only selects those PI sheets whose statuses permit the relevant processing type.
For more information on how to use worklists, see Worklists for PI Sheets [Page 316]. PI sheets can have one of the following statuses:
Status Meaning
New The PI sheet has been created but has not yet been maintained. To delete PI sheets with status New, you first have to perform the Discard/Cancel function.
In process Part of the PI sheet has been maintained (for example, entries have been made and values have been calculated). To delete PI sheets with status In process, you first have to cancel them.
To be completed
The PI sheet has been maintained and can be completed. The PI sheet can obtain the status To be completed as follows:
To delete PI sheets with status To be completed, you first have to cancel or complete them.
Canceled The PI sheet was in process and was then canceled (Discard/Cancel function).
PI sheets with status Canceled:
In PI sheets with completing signatures (asynchronous signature), all entries except for the last completing signature, which automatically completes the PI sheet, have been made.
•
• In PI sheets without completing signatures, all entries have been made but the Complete function has not yet been carried out.
Are archived in the batch record if the Batch record required indicator has been set for the order type used
•
•
•
Are automatically deleted when the process order is deleted
Can manually be deleted in the worklist if the No process data documentation required indicator is set for the order type used.
April 2001 331
Process Management (PP-PI-PMA) SAP AG
Status of PI Sheets
Completed The PI sheet was completed. PI sheets can be completed as follows:
PI sheets with status Completed:
Discarded The PI sheet had status New and was discarded (Discard/Cancel function). PI sheets with status Discarded:
Archived (EBR)
The PI sheet was canceled, discarded, or completed. A batch record was archived for the PI sheet.
Depending on the settings made in Customizing for Process Data Documentation under Batch Record -> Contents and Layout -> Define Document Profiles, the status Archived (EBR) can mean the following in the batch record archiving:
PI sheets with status Archived (EBR):
In PI sheets with completing signatures (asynchronous signature), the PI sheet is automatically completed when all entries have been made and the last completing signature has been executed.
•
•
•
•
•
In PI sheets without completing signatures, the PI sheet is not completed until you explicitly carry out the Complete function.
Are archived in the batch record if the Batch record required indicator has been set for the order type used
Are automatically deleted when the process order is deleted
Can manually be deleted in the worklist if the No process data documentation required indicator is set for the order type used.
Are archived in the batch record if the Batch record required indicator has been set for the order type used
•
•
•
Are automatically deleted when the process order is deleted
Can be deleted manually in the worklist if the No process data documentation required indicator is set for the order type used
If document type PI sheet has not been selected, the archiving function is carried out but the PI sheet itself is not contained in the batch record.
•
•
•
•
If document type PI sheet has been selected, the archiving function is carried out and the PI sheet is included in the batch record.
Are automatically deleted when the process order is deleted
Can be deleted manually in the worklist
332 April 2001
SAP AG Process Management (PP-PI-PMA)
Status of PI Sheets
April 2001 333
Process Management (PP-PI-PMA) SAP AG
Processing of ABAP List-Based PI Sheets
Processing of ABAP List-Based PI Sheets When accessing a PI sheet in the R/3 System, you have the following options:
You can directly access a specific PI sheet by entering its number (see Accessing PI Sheets [Page 336]).
•
• You can create a worklist for PI sheets using search criteria such as material, resource and operating group (see Finding PI Sheets [Page 320]).
In both cases, you can decide whether you want to display or maintain the PI sheet. Your choice of processing types depends on your authorizations and the functions you want to carry out. You will find information on the functions you can carry out in the subsequent sections.
For an overview of the PI sheet elements relevant to the individual processing steps, see Overview Screen of a PI Sheet - Graphic [Ext.].
Display Mode
In the display mode, you can display all the data available in the PI sheet but you cannot change it. The following functions are available in this mode:
Printing PI Sheets [Page 337]
Scrolling Within a PI Sheet [Page 338]
Displaying Notes [Page 341]
Displaying of Data to Be Reported [Page 342]
Displaying of Inspection Results [Page 372]
Displaying of Comments [Page 377]
Change Mode
In change mode, you can display and edit data in the PI sheet. In the case of unplanned events, you can also change the original setup of the PI sheet. You can use all the functions available in the display mode as well as the following:
Functions Carried Out by the Process Operator During Normal Processing
Recording of Actual Process Data [Page 344]
Calculating of Values [Page 356]
Reporting of Data [Page 358]
Recording of Inspection Results [Page 372]
Calling a Function [Page 375]
Entering of Comments [Page 377]
Displaying of Logs [Page 382]
Locating of Process Instructions in the PI Sheet [Page 384]
Saving of PI Sheets [Page 386]
Setting the PI Sheet Status to “Complete” [Page 390]
334 April 2001
SAP AG Process Management (PP-PI-PMA)
Processing of ABAP List-Based PI Sheets
Functions Needed in the Case of Errors and Unplanned Events
Changing of Control Information in the PI Sheet [Page 392]
Canceling of Order Confirmations [Page 394]
Canceling of Material Documents [Page 396]
Activating/Deactivating of Process Instructions in the PI Sheet [Page 398]
Setting the PI Sheet Status to “Technically Complete” [Page 400]
In general, the functions described here are not used by the process operator but by the person responsible for planning your production processes. You need a special authorization to carry out these transactions.
PI Sheet Maintenance Completed
Once you have completed maintaining the PI sheet, you can delete it if the following requirements are met:
• PI sheets for test purposes can be deleted any time.
• PI sheets for production can be deleted:
- After they have been archived by way of process data documentation
- After they have been set to “complete” or “technically complete” if they do not have to be transferred to process data documentation
Deleting PI Sheets [Page 402]
April 2001 335
Process Management (PP-PI-PMA) SAP AG
Accessing ABAP List-Based PI Sheets
Accessing ABAP List-Based PI Sheets The PI sheet menu has been revised for Release 4.6C. The following transaction to access PI sheets are now no longer available in the menu but you can still access them by entering the appropriate transaction code. However, you can only use these transactions to access ABAP list-based PI sheets:
Display PI Sheet (transaction CO56) •
• Maintain PI Sheet (transaction CO58)
As of Release 4.6C, there are a number of different transactions in the PI Sheet menu that you can use to select PI sheets.
For more information, see Worklist for PI Sheets [Page 316].
After you have called transaction CO56 or CO58, proceed as follows:
1. Enter the number of the PI sheet you want to display or maintain.
The number of the PI sheet is the same as the number of the control recipe from which it is created.
2. To access the PI sheet, choose Continue.
The overview screen of the PI sheet appears.
336 April 2001
SAP AG Process Management (PP-PI-PMA)
Printing ABAP List-Based PI Sheets
Printing ABAP List-Based PI Sheets To print a PI sheet, proceed as follows:
1. On the overview screen of the PI sheet, choose PI sheet → Print.
The Print Screen List screen appears.
2. Enter the print parameters.
3. Choose Print.
The system prints the data displayed on the overview screen of the PI sheet with the note texts listed at the end.
April 2001 337
Process Management (PP-PI-PMA) SAP AG
Scrolling Within ABAP List-Based PI Sheets
Scrolling Within ABAP List-Based PI Sheets Use To improve system performance when maintaining long PI sheets, only a section of a PI sheet is displayed at a time. For this reason, you need to observe the following when displaying data on a PI sheet:
• A default value for the number of phases to be displayed is defined in Customizing for the operating group (control recipe destination). You can change this value when maintaining a specific PI sheet; see Changing the Sections Displayed in a PI Sheet [Page 33 ]9 .
The changed value is only valid until you leave the PI sheet.
Each time the PI sheet is prepared for display, that is, whenever you choose Enter or choose a function, the current cursor position is taken as the middle of the section to be displayed.
•
• The scroll bar as well as the scroll keys and symbols can only be used to scroll within the section currently displayed. You can, however, branch to another section via the menu; see Scrolling Between Sections of ABAP List-Based PI Sheets [Page 340].
338 April 2001
SAP AG Process Management (PP-PI-PMA)
Changing the Sections Displayed in ABAP List-Based PI Sheet
Changing the Sections Displayed in ABAP List-Based PI Sheet To increase or reduce the number of phases prepared at the same time for display on a PI sheet, proceed as follows:
1. On the overview screen of the PI sheet, choose Settings → Section displayed.
A dialog box appears in which you can make the required settings.
2. Enter the number of phases whose process instructions should be prepared at the same time.
3. Choose Continue.
The display is adjusted according to your entry.
April 2001 339
Process Management (PP-PI-PMA) SAP AG
Scrolling Between Sections of ABAP List-Based PI Sheets
Scrolling Between Sections of ABAP List-Based PI Sheets To scroll between different sections of a PI sheet, proceed as follows:
On the overview screen of the PI sheet, choose one of the following:
• If you want to branch to the start of the PI sheet: Goto → First section.
• If you want to branch to the end of the PI sheet: Goto → Last section.
• If you want to branch to the next section: Goto → Next section
• If you want to branch to the previous section: Goto → Previous section
340 April 2001
SAP AG Process Management (PP-PI-PMA)
Displaying Notes in ABAP List-Based PI Sheets
Displaying Notes in ABAP List-Based PI Sheets If a pushbutton is displayed below an instruction text, you can display one or more notes with additional information on a separate screen. Proceed as follows:
1. Double-click the pushbutton.
A detail screen appears on which the corresponding notes are displayed.
2. To return to the overview, choose Back.
April 2001 341
Process Management (PP-PI-PMA) SAP AG
Displaying of Data to Be Reported in ABAP List-Based PI Sheets
Displaying of Data to Be Reported in ABAP List-Based PI Sheets Use The values entered and calculated in a PI sheet are displayed on the overview screen of the PI sheet.
For each of these values, a process message exists that is used to report the value to process management. To obtain more detailed information about the individual messages, you can display a detail screen for each of them containing the following information:
• Header data such as the message category, sender, and time of creation
• All characteristics and their values including those that were obtained from the PI sheet or entered automatically by the system
All long texts created for the message •
See: Displaying Process Messages in ABAP List-Based PI Sheets [Page 343]
342 April 2001
SAP AG Process Management (PP-PI-PMA)
Displaying Process Message in ABAP List-Based PI Sheets
Displaying Process Message in ABAP List-Based PI Sheets You can display individual process messages or all process messages that exist for a PI sheet.
Individual Messages
To display individual process messages, proceed as follows:
1. On the overview screen of the PI sheet, position the cursor on the value for which you want to display the process message.
2. Choose Edit → Display message → Acc. to selection.
The detail screen for this message appears.
3. To return to the overview screen of the PI sheet, choose Back.
All Messages for a PI Sheet To display all process messages for a PI sheet, proceed as follows:
1. On the overview screen of the PI sheet, choose Edit → Display message → All.
The system displays the detail screen for the first message, created in the PI sheet.
2. To branch to the next message, choose Back.
3. When you have reached the last message, choosing Back will take you back to the overview screen of the PI sheet.
April 2001 343
Process Management (PP-PI-PMA) SAP AG
Recording of Actual Data in ABAP List-Based PI Sheets
Recording of Actual Data in ABAP List-Based PI Sheets Use You can use the entry fields offered in your PI sheet to record actual process data. You can enter data as follows:
You can enter individual values in the fields displayed on the right side of the PI sheet; see Recording Individual Values [Page 34 ]6 .
•
• You can enter several values in tables; see Recording Values in Tables [Page 348].
Once you have entered a value in the PI sheet, the system creates a process message of the message category defined in the corresponding process instruction. The value you have entered is copied to the message.
Signatures have a special function within the PI sheet. They are used to confirm and report data for a process step. For information on how they are processed, see Reporting of Data [Page 35 ]8 .
Prerequisites To carry out an input validation when data is entered in the PI sheet, the following requirements must be met:
• An input validation has been defined for the input field in the relevant process instruction in the process order (see Definition of Input Validations [Page 246]).
If the process instruction specifies that a signature is required to accept invalid input values, the type of signature has been defined in Customizing for the control recipe destination and in the process instruction.
•
For more information about the digital signature and the required settings, see Approval Using Digital Signatures [Ext.].
Features Input Validation If an input validation is defined for a value in the process instruction, the system checks your entries. If the value you enter is outside the defined value range, the system issues a warning.
However, you can still transfer the invalid input value to the PI sheet, if this has been specified in the process instruction. You can make the following settings:
• Invalid values are accepted without any restrictions
• Invalid values are not accepted
Invalid values are only accepted with a signature •
The PI sheet may request a signature. Depending on your system settings, this may be a signature with or without a password, one digital signature [Ext.], or several individual digital signatures defined in a signature strategy [Ext.]. When you execute a digital signature, you must also enter a comment.
344 April 2001
SAP AG Process Management (PP-PI-PMA)
Recording of Actual Data in ABAP List-Based PI Sheets
Signature strategies are carried out synchronously in the PI sheet. This means that the individual signatures must be executed immediately after one another. It is only then that the system saves the signatures and transfers the value.
The input value is not reported automatically when the signature is executed. If you change the value, you must execute the signature again even if the changed value complies with the validation rule.
Input values with signatures are marked by a special symbol in the PI sheet. You can display the signature from within the PI sheet any time.
Further Data Processing Once a value has been transferred to the PI sheet, the system creates a process message that is used to report this value to process management; see Reporting of Data [Page 358].
If several values need to be recorded in the PI sheet for one message and you do not maintain all of them at once, the system automatically transfers any default values defined for the values not yet recorded to the corresponding fields and thus to the process message. You can change the values but cannot delete value assignment.
April 2001 345
Process Management (PP-PI-PMA) SAP AG
Recording Individual Values in ABAP List-Based PI Sheets
Recording Individual Values in ABAP List-Based PI Sheets 1. Enter the desired value in the entry field.
Using field help, you can display information on the format and template of the requested value.
Using the input help, you obtain the following data on separate screens in the following sequence:
– A default value, provided it has been defined in the process instruction
– Allowed values, provided that allowed individual values, value ranges, a value assignment function, or value table have been allocated to the characteristic in Customizing
– Matchcodes, provided that a matchcode object has been assigned to the characteristic in Customizing
Choose Further values to go to the next possible entries screen.
2. When you have entered the input value, choose Continue.
If an input validation is defined for the value, and your entry does not match the validation rule, a corresponding warning is displayed.
3. Choose:
– Change to correct the value
– Transfer if you want to use the value nevertheless
If the corresponding setting has been made in the process instruction and control recipe destination, a dialog box for signatures or digital signatures [Ext.] appears.
4. If required, enter a signature, execute one digital signature, or execute the required signature strategy [Ext.].
Do this in exactly the same way as when you complete a process step. Note, however, that data is not reported when you enter a signature in an input validation.
Entering Signatures [Page 362]
Executing Digital Signatures [Page 36 ]3
Executing Signature Strategies [Page 365]
The input value is then marked by a special symbol in the PI sheet.
From within the PI sheet, you can display the signatures executed in the PI sheet any time. For more information, see Displaying Digital Signatures [Page 37 ]0 .
346 April 2001
SAP AG Process Management (PP-PI-PMA)
Recording Individual Values in ABAP List-Based PI Sheets
April 2001 347
Process Management (PP-PI-PMA) SAP AG
Recording Values in Tables
Recording Values in Tables 1. Enter values in all fields of a table line.
Using the field help, you can get information on the format and template of the individual values.
Using the possible entries help, you obtain the following data on separate screens in the following sequence:
– A default value, provided it has been defined in the process instruction
– Allowed values, provided that allowed individual values, value ranges, a value assignment function, or value table have been allocated to the characteristic in Customizing
– Matchcodes, provided that a matchcode object has been allocated to the characteristic in Customizing
Choose Further values to go to the next possible entries screen.
2. When you have entered the input values, choose Continue.
If an input validation is defined for the values, your entries are now checked for validity. Depending on the results of these checks, processing is continued as follows:
– If the system did not find any errors, the values are copied to the PI sheet and a new table line is displayed. Continue as in step 5.
– If you have entered an invalid value, a warning is displayed. Continue as in step 3.
3. Choose:
– Change to correct the value
– Transfer if you want to use the value nevertheless
If the corresponding setting has been made in the process instruction and control recipe destination, a dialog box for signatures or digital signatures [Ext.] appears.
4. If required, enter a signature, execute one digital signature, or the required signature strategy [Ext.].
Do this in exactly the same way as when you complete a process step. Note, however, that data is not reported when you enter a signature in an input validation.
Entering Signatures [Page 362]
Executing Digital Signatures [Page 36 ]3
Executing Signature Strategies [Page 365]
The input value is then marked by a special symbol in the PI sheet.
After the value has been copied, a new table line is displayed on the overview screen of the PI sheet.
5. If you want to enter further values, repeat steps 1 to 4.
You need to fill in at least the minimum number of table lines defined in the process instruction. Otherwise, you will not be able to sign the process step.
You can no longer add new table entries:
348 April 2001
SAP AG Process Management (PP-PI-PMA)
Recording Values in Tables
– After the maximum number of lines defined for the table in the control recipe has been reached
– After you have entered a signature below the table
From within the PI sheet, you can display the signatures executed in the PI sheet any time. For more information, see Displaying Digital Signatures [Page 37 ]0 .
April 2001 349
Process Management (PP-PI-PMA) SAP AG
Batch Determination in the PI sheet
Batch Determination in the PI sheet Use You use this function in the PI sheet when you enter material consumptions for material components that are to be handled in batches. The function helps you to find suitable batches for the corresponding material component.
Batch determination is used in the whole of logistics. The basic processes and prerequisites for this are always identical. For more information, see the R/3 Library LO - Batch Management under Batch Determination [Ext.].
However, depending on where batch determination is used, certain special features may need to be taken into account. These features result from the context of the respective individual application. The following sections describe what you must bear in mind when you use batch determination in PI sheets.
Prerequisites You have installed the application component Batch Management (LO-BM). In this component, a batch search procedure together with the corresponding strategy types and search strategies has been defined for the order type (refer to Batch Search Strategy [Ext.]).
The material component for which you want to find a batch meets the following requirements:
• It has been defined as being subject to batch management in the material master record.
• If you want batch determination to use different selection criteria than those defined in the batch search strategy, the material component must have been classified accordingly in the material list of the process order.
A process data request has been defined for the PI sheet and meets the following requirements:
• It contains the following message characteristics:
– PPPI_RESERVATION and PPPI_RESERVATION_ITEM
– PPPI_BATCH as an input value
– PPPI_MATERIAL (material number)
– PPPI_MATERIAL_CONSUMED (material quantity consumed) as an input value
– PPPI_UNIT_OF_MEASURE (unit of measurement)
The value of this characteristic must be identical to the base or alternative unit of measure of the material.
• No default value has been defined for the batch in the data request.
• If you want to copy several batches to the PI sheet (batch split), the data request must be of the type “repeated data request” and must contain a sufficient number of table lines.
Features Determining Suitable Batches Having entered the required material quantity, you start batch determination manually in the PI. Just like in the process order, the following criteria are used for selection:
350 April 2001
SAP AG Process Management (PP-PI-PMA)
Batch Determination in the PI sheet
• Selection criteria for batches
The system determines the selection criteria using the following data:
– If it has been maintained in the material list of the process order, the classification data of the material component
– If no classification data has been maintained, the selection criteria of the batch search strategy determined for the order type using the batch search procedure
The system determines suitable batches by comparing the selection criteria with the classification data in the batch master record.
• Batch availability
The system checks whether the batches are available at the time when batch determination is carried out. The following checking rule is used (refer to Customizing for availability checks).
– If it has been defined, the checking rule intended for order processing of the corresponding order type
– It if has not been defined, the checking rule intended for order creation
If no checking rule has been defined, the availability check and batch determination is terminated.
• Sort sequence and proposed quantity for the batch to be used
The system uses the data defined in the batch search strategy. If no suitable search strategy has been defined, batch determination is terminated.
Copying Batches When the system has determined suitable batches, you can copy them into the PI sheet. You can use the following functions:
• Copying batches automatically
If batch determination in the background is defined in the batch search strategy, the system copies the proposed quantity it determines directly to the PI sheet.
• Copying batches manually
If batch determination in dialog is defined in the batch search strategy, the system displays the proposed quantity. You can change the quantity if you want and then copy the batch. However, a batch split, that is copying several batches, is only allowed if:
– The batch search strategy supports it
– The process instruction is a repeated data request and can accommodate a sufficient number of table line
When you copy a batch into the PI sheet, the system - unlike in the process order - does not create or update a reservation. For this reason, the wrong batches may be selected in the following cases:
– If you trigger batch determination in the PI sheet for several goods issues for the same material in a row
April 2001 351
Process Management (PP-PI-PMA) SAP AG
Batch Determination in the PI sheet
– If you also trigger batch determination for one material at another location in the system, for instance, in the process order
For this, make sure that process messages are sent immediately and thus goods issues are posted as quickly as possible when you create and maintain your PI sheets.
352 April 2001
SAP AG Process Management (PP-PI-PMA)
Determining Batches in PI Sheets
Determining Batches in PI Sheets Prerequisites A batch search procedure together with the corresponding strategy types and search strategies has been defined for the order type (refer to Batch Search Strategy [Ext.]).
The material component for which you want to find a batch meets the following requirements:
• It has been defined as being subject to batch management in the material master record.
• If you want batch determination to use different selection criteria than those defined in the batch search strategy, the material component must have been classified accordingly in the material list of the process order.
A process data request has been defined for the PI sheet and meets the following requirements:
• It contains the following message characteristics:
– PPPI_RESERVATION and PPPI_RESERVATION_ITEM
– PPPI_BATCH as an input value
– PPPI_MATERIAL (material number)
– PPPI_MATERIAL_CONSUMED (material quantity consumed) as an input value
– PPPI_UNIT_OF_MEASURE (unit of measurement)
The value of this characteristic must be identical to the base or alternative unit of measure of the material.
• No default value has been defined for the batch in the data request.
• If you want to copy several batches to the PI sheet (batch split), the data request must be of the type “repeated data request” and must contain a sufficient number of table lines.
Procedure 1. Enter the material quantity for which you want to find suitable batches in the PI sheet.
2. Place the cursor on the process instruction, for example, on the field for the material quantity or the batch, and choose Environment → Batch → Find.
The system determines suitable batches and proposes a quantity to be adopted for each batch. Depending on the settings you have made in the batch search strategy, the proposed quantity is:
– In simple data requests, you can only copy one batch.
– Directly copied to the PI sheet
– Displayed in batch determination where it can be changed
3. If required, change the batch quantities you want to copy.
Note the following:
– In repeated data requests, the number of batches may not exceed the maximum number of table lines.
April 2001 353
Process Management (PP-PI-PMA) SAP AG
Determining Batches in PI Sheets
4. Choose Copy.
The system copies the batch number and quantity into the PI sheet.
354 April 2001
SAP AG Process Management (PP-PI-PMA)
Checking Batches in PI Sheets
Checking Batches in PI Sheets Use You use this procedure in the PI sheet when you enter material consumptions for material components that are to be handled in batches and have entered the batch manually. It enables you to check whether the batch you have entered matches the selection criteria defined for batch determination [Ext.]. The system does not check availability during the batch check.
Prerequisites You have installed the application component Batch Management (LO-BM). In this component, a batch search procedure together with the corresponding strategy types and search strategies has been defined for the order type (refer to Batch Search Strategy [Ext.]).
Batch check has been activated for the order type in Customizing for Process Orders.
The material component for which you want to find a batch meets the following requirements:
• It has been defined as being subject to batch management in the material master record.
• If you want batch determination to use different selection criteria than those defined in the batch search strategy, the material component must have been classified accordingly in the material list of the process order.
A process data request has been defined for the PI sheet and contains the following message characteristics:
• PPPI_RESERVATION and PPPI_RESERVATION_ITEM
• PPPI_BATCH as an input value
• PPPI_MATERIAL (material number)
• PPPI_MATERIAL_CONSUMED (material quantity consumed) as an input value
• PPPI_UNIT_OF_MEASURE (unit of measurement)
The value of this characteristic must be identical to the base or alternative unit of measure of the material.
Procedure 1. Enter the required material quantity and the batch number in the PI sheet.
2. Place the cursor on the process instruction in the PI sheet, for example, on the field for the batch, and choose Environment → Batch → Check.
The system checks whether the batch you have entered matches the selection criteria defined for batch determination. If it does not match the criteria, the system issues a corresponding message.
April 2001 355
Process Management (PP-PI-PMA) SAP AG
Value Calculation in ABAP List-Based PI Sheets
Value Calculation in ABAP List-Based PI Sheets If your PI sheet contains fields that start with a question mark (?), the values in these fields need to be calculated by the system. You can start the calculation:
• For individual values
For all values that need to be calculated in a PI sheet •
See Calculating Values [Page 35 ]7 .
The calculated value will be displayed in the field. At the same time, a process message is created which will be used to report the value to process management when you start the corresponding function.
When you report the data for a processing step, all values calculated within this processing step are automatically recalculated. This ensures that if you change the values recorded in the PI sheet and these values are used in a calculation formula, the changes will be effective in the formula result.
The formula used for a calculation can refer to one or more values entered or calculated previously on the PI sheet. For this reason, you should first maintain and calculate all preceding values before starting the calculation. If a value is missing in a calculation formula, a corresponding error message is issued.
356 April 2001
SAP AG Process Management (PP-PI-PMA)
Calculating Values in ABAP List-Based PI Sheets
Calculating Values in ABAP List-Based PI Sheets To calculate values in the PI sheet, proceed as follows:
For individual values: Double-click the field for the formula result.
The value is calculated and displayed in the field.
For all values to be calculated in the PI sheet:
On the PI sheet overview, choose Edit → Calculate formulas.
The system calculates all values on the PI sheet. The calculated values are displayed on the PI sheet overview.
April 2001 357
Process Management (PP-PI-PMA) SAP AG
Reporting of Actual Data in ABAP List-Based PI Sheets
Reporting of Actual Data in ABAP List-Based PI Sheets Use You use this function to report actual data you have entered or calculated in the PI sheet. You can start data reporting as follows:
• For all values, by using the Report data function
• For the values of a process step, by entering a signature to complete the step
Prerequisites ... for Executing a Signature A process instruction in which a signature has been specified as an input value has been defined in the PI sheet (see Definition of Signatures [Page 263]).
The type of signature to be used in the PI sheet has been defined in Customizing for Control Recipe Destinations. You have the following options:
• Signature without password check
• Signature with a password check In this case, you must also define passwords for the corresponding users in Customizing for Control Recipe Destinations.
To execute the signature, you may also need a maintenance authorization for the PI sheet, which is defined in the process instruction.
Digital signature [Ext.] •
If several individual signatures are to be executed, you also define a signature strategy [Ext.] in the control recipe destination or in the process instruction.
For more information about digital signatures and the required settings, see Approval Using Digital Signatures [Ext.].
Features When you report a value from the PI sheet, the system transfers the corresponding process message to process management. Process management then sends the message to its destinations for further processing.
Which values you can report depends on how you start the function (see below). No matter how you start reporting, the system always carries out the following steps:
• The system checks:
− Whether a value has already been reported
− Whether the corresponding message is complete, that is, whether values have been assigned to all required characteristics of the message category
The system only transfers complete process messages that have not yet been reported at an earlier stage.
358 April 2001
SAP AG Process Management (PP-PI-PMA)
Reporting of Actual Data in ABAP List-Based PI Sheets
• The system carries out all calculations once again based on the latest data. This ensures that only current data is reported.
After you have reported the values, you can no longer change them in the PI sheet.
Reporting Data You start this function from the PI sheet menu. The system selects all data that can be reported for the entire PI sheet. It does not check whether the process instructions have all been maintained one after another.
Executing a Signature When you complete a process step with a signature or a digital signature, the system reports all data since the last signature (see graphic).
You can only complete a process step if all process messages have been created for the process instructions of this step. If several input values have been defined for a message, you must only enter data for the required values of the message category. You must, however, enter at least one value.
Processmanagement
PI Sheet
PI sheet 100449 ReceivedProcess order: 1234 Material: XYZ Test material
Operating group: W01
Heat solvent. Temp: 57.00 °CStart agitator. Rot.speed.: 180.00Add material ABC. Quantity: 200.00 kg Note Signature: JonesPhase 20 / Instr. 10
Comment sheet
Password: ___
Signature
PI Sheet
PI sheet 100449 ReceivedProcess order: 1234 Material: XYZ Test material
Operating group: W01
Phase 10 / Instr. 10Heat solvent. Temp: 57.00 °CStart agitator. Rot.speed.: _____Add material ABC. Quantity: _____ kg Note Signature: _____
Comment sheetPI sheet Edit Goto ...
EditDisplaySaveReport dataPrint
..
Messages ontemperature values
Processmanagement
Triggers
Sent to
Sent to
Triggers
Messages inprocess step
Temperature readingRotation speed readingMaterial consumption }
Special Features for Signature Strategy Processing
If the process instruction requires a signature strategy, the PI sheet does not contain an input field but a symbol that takes you to signature maintenance.
Signature strategies for process steps are carried out synchronously. This means that all signatures must be executed immediately after one another. It is only then that the system saves them and completes the process step.
The signatory name is transferred to the PI sheet after the strategy has been completed. If required, you can display detail data on the signatures and the signature strategy used from within the PI sheet.
April 2001 359
Process Management (PP-PI-PMA) SAP AG
Reporting of Actual Data in ABAP List-Based PI Sheets
You can also enter a signature or execute a digital signature at the end of a PI sheet and sign the entire PI sheet in this way. In this case, signature strategies can also be carried our asynchronously. For more information, see Signing of PI Sheets [Page
]. 388
360 April 2001
SAP AG Process Management (PP-PI-PMA)
Reporting Data in ABAP List-Based PI Sheets
Reporting Data in ABAP List-Based PI Sheets To report the actual process data maintained in a PI sheet, proceed as follows:
1. On the overview screen of the PI sheet, choose PI sheet → Report data.
A list of the process messages ready for sending from within this PI sheet appears. All messages on this list are selected.
2. To send the messages, choose Report.
April 2001 361
Process Management (PP-PI-PMA) SAP AG
Executing Signatures in ABAP List-Based PI Sheets
Executing Signatures in ABAP List-Based PI Sheets Prerequisites In Customizing for Control Recipe Destinations, it has been specified that one of the following types of signature is used in the PI sheet:
• Signature without password check
• Signature with a simple password check
In this case, you must also define passwords for users to execute signatures in Customizing for the control recipe destination.
To execute the signature, you may also need an authorization for the PI sheet, which is defined in the process instruction.
Procedure 1. Enter your signature in the corresponding field and choose Enter.
If you have not maintained all data for a process step yet, the system does not transfer the signature. It issues an error message.
If you have maintained all data, processing is continued as follows:
– If the password check has not been activated, the data for the process step is reported without any further checks.
– If the password check has been activated, the signature you entered must match the user name. If this is the case, the dialog box for the password appears.
2. Enter your password.
The system checks whether:
– The password is correct
– You have the authorization required to enter a signature
If this is the case, the data is reported.
Result The process messages of this process step are transferred to process management, which sends them to the corresponding destinations. You can no longer change the data pertaining to the message in the PI sheet.
362 April 2001
SAP AG Process Management (PP-PI-PMA)
Executing Digital Signatures
Executing Digital Signatures Use You carry out this procedure in the PI sheet if only one digital signature [Ext.] is required for the following functions:
• To complete a process step
• To accept an input value in an input validation
Prerequisites • If you use the user signature as your signature method [Ext.], you need an external security
product that is linked to your SAP System using the basis component Secure Store and Forward (SSF) [Ext.].
In Customizing for Control Recipe Destinations, it has been specified that you must execute a digital signature [Ext.] to sign a process step in the PI sheet.
•
• No signature strategy [Ext.] has been assigned to the control recipe destination or the process instruction, that is, only one signature must be executed.
• The following authorizations have been assigned to you (authorization object C_CRPI_BER):
− The authorization to execute digital signatures in PI sheets
− If required, a maintenance authorization for the PI sheet, which is defined in the process instruction
Procedure 1. Enter your user name as the signature.
The system checks whether you have maintained all data for the process step. If this is the case, the dialog box for executing the digital signature appears.
2. If required, enter a comment in the text field.
3. If you use the user signature as your signature method [Ext.], make sure that the system can access your Personal Security Environment (PSE) [Ext.].
How you do this depends on your security product. If you use a smart card reader, for example, insert your smart card in the reader.
4. Enter your password in the dialog box for the digital signature and choose Continue.
The system checks:
− Whether you are authorized to execute a digital signature
− Whether your entries match the data in your user master record
− Whether your entries match the data in your PSE (if you use user signatures)
Depending on the results of these checks, processing is continued as follows:
− If your entries are invalid or the system cannot access your PSE, it takes you back to the dialog box where you can execute your signature again (step 4).
April 2001 363
Process Management (PP-PI-PMA) SAP AG
Executing Digital Signatures
The function is canceled after a certain number of unsuccessful attempts that can be defined specifically for each customer. The user is locked and can no longer execute digital signatures. If a system signature was used, the user is even locked against logging on to the system again.
− If your entries are correct, the data is reported or the input value is accepted.
Result The process messages of this process step are transferred to process management, which sends them to the corresponding destinations. You can no longer change the data pertaining to the message in the PI sheet.
The signatory name is transferred to the PI sheet. Detailed data about the signature, such as the signatory's name and user ID, comment, date, and time, are saved along with the signature.
364 April 2001
SAP AG Process Management (PP-PI-PMA)
Executing Signature Strategies
Executing Signature Strategies Use You carry out this procedure in the PI sheet if several individual digital signatures defined in a signature strategy [Ext.] are required for the following functions:
• To complete a process step
• To accept an input value in an input validation
If a signature process has already been started by someone else and you want to cancel it for some reason, you can withdraw the signatures executed so far (see Canceling Signature Processes [Page 368]).
Prerequisites • If you use the user signature as your signature method [Ext.], you need an external security
product that is linked to your SAP System using the basis component Secure Store and Forward (SSF) [Ext.].
In Customizing for the control recipe destination, it has been specified that you must execute a digital signature [Ext.] when you sign a process step in the PI sheet.
•
• A signature strategy [Ext.] has been assigned to the control recipe destination or the process instruction, that is, several individual signatures must be executed.
• The process instruction specifies how the signature process is carried out:
− Synchronously, that is, the individual signatures must be executed immediately after one another
− Asynchronously, that is, several other functions can be carried out in between the individual signatures
You can only use this procedure for signing PI sheets.
• The following authorizations have been assigned to you:
− The authorization to execute digital signatures in PI sheets (authorization object C_CRPI_BER)
− If required, a maintenance authorization for the PI sheet, which is defined in the process instruction (authorization object C_CRPI_BER)
− The authorization for the relevant individual signature (authorization object C_SIGN_BGR)
• You have not yet executed a signature for the object you have selected.
If the same authorization or user group is used more than once in a signature strategy, the individual signatures must be executed by different members of the group.
Procedure 1. Enter your user name as the signature.
April 2001 365
Process Management (PP-PI-PMA) SAP AG
Executing Signature Strategies
In ABAP list-based PI sheets, choose the icon for the digital signature instead.
The dialog box appears in which you can execute digital signatures. The Signatures to be executed section shows which individual signatures must be executed next and which authorization or user group is responsible for it. If required, notify the user who must execute the signature.
2. If required, enter a comment in the text field.
3. In the Signatures to be executed section, select the individual signature assigned to your authorization group.
4. If you use the user signature as your signature method [Ext.], make sure that the system can access your Personal Security Environment (PSE) [Ext.].
How you do this depends on your security product. If you use a smart card reader, for example, insert your smart card in the reader.
5. Enter your user ID and password and choose Continue.
The system checks:
− Whether you are authorized to execute a digital signature
− Whether your entries match the data in your user master record
− Whether your entries match the data in your PSE (if you use user signatures)
Depending on the results of these checks, processing is continued as follows:
− If you do not have the required authorization or your entries are invalid, or if the system cannot access your PSE, the system takes you back to the dialog box where you can execute your signature again (steps 3 to 5).
The function is canceled after a certain number of unsuccessful attempts that can be defined specifically for each customer. The user is locked and can no longer execute digital signatures. If a system signature was used, the user is even locked against logging on to the system again.
− If your entries are correct, the dialog box for digital signatures appears if you follow a synchronous signature process. In this case, you must continue the signature process immediately.
In asynchronous signature processes, the system takes you to the overview screen of the PI sheet where you can cancel the signature process. The next signatory continues the process later.
6. Notify the person who must execute the next individual signature. He or she must carry out the following steps:
− In synchronous signature processes, steps 2 to 5
− In asynchronous signature processes, steps 1 to 5
Result As soon as a release status of the signature strategy has been reached and no more signatures are required, the system completes the signature process.
366 April 2001
SAP AG Process Management (PP-PI-PMA)
Executing Signature Strategies
The process messages of this process step are transferred to process management, which sends them to the corresponding destinations. You can no longer change the data pertaining to the message in the PI sheet.
The signatory names are transferred to the PI sheet. Detailed data about the signatures, such as the signatory's name and user ID, comment, date, and time, are saved along with the signature.
April 2001 367
Process Management (PP-PI-PMA) SAP AG
Canceling Signature Processes
Canceling Signature Processes Use You carry out this procedure in the PI sheet if, for some reason, you want to cancel a signature process that has been started by somebody else and withdraw the signatures executed so far.
Prerequisites • If you use the user signature as your signature method [Ext.], you need an external security
product that is linked to your SAP System using the basis component Secure Store and Forward (SSF) [Ext.].
In Customizing for the control recipe destination, it has been specified that you must execute a digital signature [Ext.] when you sign a process step in the PI sheet.
•
• A signature strategy [Ext.] has been assigned to the control recipe destination or the process instruction, that is, several individual signatures must be executed.
• The following authorizations have been assigned to you:
− The authorization to execute digital signatures in PI sheets (authorization object C_CRPI_BER)
− If required, a maintenance authorization for the PI sheet, which is defined in the process instruction (authorization object C_CRPI_BER)
− The authorization for the relevant individual signature (authorization object C_SIGN_BGR)
• You have not yet executed a signature for the object you have selected.
Procedure 2. Enter your user name as the signature.
In ABAP list-based PI sheets, choose the icon for the digital signature instead.
The dialog box appears in which you can execute digital signatures.
5. In the Signatures to be executed section, select the individual signature assigned to your authorization group.
When you cancel a signature process, the system does not save any comments. For this reason, do not enter a text.
6. If you use the user signature as your signature method [Ext.], make sure that the system can access your Personal Security Environment (PSE) [Ext.]. How you do this depends on your security product. If you use a smart card reader, for example, insert your smart card in the reader.
4. Enter your user ID and password and choose Signature process.
The system checks:
− Whether you are authorized to execute the individual signature
368 April 2001
SAP AG Process Management (PP-PI-PMA)
Canceling Signature Processes
− Whether your entries match the data in your user master record
− Whether your entries match the data in your PSE (if you use user signatures)
Depending on the results of these checks, processing is continued as follows:
− If you do not have the required authorization or your entries are invalid, or if the system cannot access your PSE, the system takes you back to the dialog box where you can enter your data again (steps 2 to 4).
The function is canceled after a certain number of unsuccessful attempts that can be defined specifically for each customer. The user is locked and can no longer execute digital signatures. If a system signature was used, the user is even locked against logging on to the system again.
− If your entries are correct, the signature process is canceled and you return to the PI sheet.
Result All signatures executed during the signature process are withdrawn. This transaction is documented in the log for the digital signature.
April 2001 369
Process Management (PP-PI-PMA) SAP AG
Displaying Digital Signatures in ABAP List-Based PI Sheets
Displaying Digital Signatures in ABAP List-Based PI Sheets Use You use this procedure to display digital signatures that have been executed in a PI sheet. You have the following options:
• You can display the signatures for a specific process instruction: The system displays:
− In simple data requests, all signatures for the process instruction
− In repeated data request, the signatures for the line you have selected
• You can display all signatures executed for the PI sheet.
Procedure Displaying Signatures for a Specific Process Instruction:
1. In the PI sheet, position the cursor on the process instruction or the line for which you want to display digital signatures.
2. Choose Edit → Display signature.
An overview appears that contains the following information:
− The signatures executed for the process instruction together with user name, date and time
− Details on the signature strategy [Ext.] used
3. If required, display the following detail information for the signatures:
− The signature sequence of the signature strategy used
Choose Goto → Signature sequence.
− The release statuses of the signature strategy used
Choose Goto → Release statuses.
− The comment entered for the individual signature
Choose Goto → Display comment.
Displaying all Signatures for PI Sheet 1. In the PI sheet, choose Extras → Display dig. signature.
An overview appears that contains the following information:
− All process instructions or their values that have been signed in the PI sheet
− The executed signatures together with user name, date and time
− Details on the signature strategy used
2. If required, display the following detail information for the signatures:
370 April 2001
SAP AG Process Management (PP-PI-PMA)
Displaying Digital Signatures in ABAP List-Based PI Sheets
− The signature sequence of the signature strategy used
Choose Goto → Signature sequence.
− The release statuses of the signature strategy used
Choose Goto → Release statuses.
− The comment entered for the individual signature
Choose Goto → Display comment.
April 2001 371
Process Management (PP-PI-PMA) SAP AG
Recording and Displaying of Inspection Results
Recording and Displaying of Inspection Results If you are maintaining a PI sheet,... ... and the Record inspection results pushbutton is displayed on the overview screen, you can branch to the QM module to record inspection results for the operations and phases specified in the corresponding process instruction; see Recording Inspection Results [Page 373].
The inspection characteristics assigned to these operations or phases in the master recipe are automatically offered for maintenance.
Inspection results request
PI Sheet
PI sheet 100449 ReceivedProcess order: 1234 Material: XYZ Test material
Operating grp: W01
Add material ABC. Qty: 200.00 kg Note Signature: ____
Phase 20 / Instr. 10Check material quality. Record inspection resultsRecord material quantity. Call mat. qty calculationStop heating and slow Qty: 350.00 kgdown agitator. Rot. speed: ______
Signature: ____
Comment sheet
QM inspection results
recording
Insp.lot
• The QM function for results recording can only be accessed from within the PI sheet, if an
inspection lot with the corresponding inspection characteristics exists for the process order. For more information about inspection lots for process orders, see Inspection lots/Inspection characteristics [Ext.] in the process order documentation.
• If you are processing a PI sheet that has been created for test purposes, the system will access the QM function in the display mode.
If you are displaying a PI sheet,... ... you can call up the recorded inspection results, by choosing Display inspection results; see Displaying Inspection Results [Page 37 ]4 .
372 April 2001
SAP AG Process Management (PP-PI-PMA)
Recording Inspection Results
Recording Inspection Results To record inspection results, proceed as follows:
1. On the overview screen of the PI sheet, double-click the Record inspection results pushbutton.
The system branches to the function for recording inspection results and lists the inspection characteristics for the first operation or phase specified in the process instruction.
2. Record the inspection results for these characteristics, valuate them, and close the results processing.
For more information on how to carry out these functions, see the R/3 Library QM Quality Management, section Inspection Processing section of the document. You can access this document via the Further Reading menu.
3. Choose Back.
The Security query dialog box appears.
4. Specify whether the entered data should be saved.
5. If there are more operations or phases for which you need to record inspection results, the system will display the inspection characteristics for the next operation.
Repeat steps 2 to 4.
When you have reached the last operation or phase specified in the inspection results request, the system returns to the PI sheet.
April 2001 373
Process Management (PP-PI-PMA) SAP AG
Displaying Inspection Results
Displaying Inspection Results To display inspection results within the PI sheet, proceed as follows:
1. On the overview screen of the PI sheet, double-click the Display inspection results pushbutton.
A dialog box appears containing the inspection results recorded for the first operation or phase specified in the process instruction.
2. Choose Choose.
If the process instruction refers to more than one operation or phase, the inspection results for the next operation or phase are displayed.
If you have already reached the last operation or phase, the system returns to the overview screen of the PI sheet.
374 April 2001
SAP AG Process Management (PP-PI-PMA)
Calling a Function
Calling a Function If a pushbutton with the name of a function is displayed on the right-hand side of your PI sheet, you can call up this function using the pushbutton; see Calling a Function [Page 376].
Depending on the function called, the system will then start a dialog or retrieve data from internal or external applications.
Dynamic function callPI Sheet
PI sheet 100449 receivedProcess order: 1234 Material: XYZ Test material
Operating group: W01
Add material ABC. Quantity: 200,00 kg Note Signature: ____
Phase 20 / Instr. 10Check material quality. Record inspection resultsEnter material quantity. Call mat.qty calculationStop heating and slow Quantity: 350,00 kgdown agitator. Rot.speed.: ______
Signature: ____
Comment sheet
Import/exportparameters
COPF_MATERIAL_QUANTITY_CALC
Function module:
Internal/external application:
Display materialquantity calculation
April 2001 375
Process Management (PP-PI-PMA) SAP AG
Calling a Function
Calling a Function To call a function, proceed as follows:
On the overview screen of the PI sheet, double-click the pushbutton for the desired function.
The function is called and the actions defined in it are carried out. For example, if the function retrieves data from another application, this data is now displayed on the PI sheet.
376 April 2001
SAP AG Process Management (PP-PI-PMA)
Creating and Displaying of Comments in ABAP List-Based PI Sheets
Creating and Displaying of Comments in ABAP List-Based PI Sheets Use During a process, unplanned events such as delays or malfunctions may occur which affect the execution of the process instructions on your PI sheet. During PI sheet maintenance, you can create comments explaining, for example, these events and their effects.
Features The R/3 System distinguishes between two types of comment:
Comments that are stored along with the PI sheet on a comment sheet. •
The comment sheet is not linked to a specific object within the PI sheet. It can be changed until the status of a PI sheet is set to “complete”; see Maintaining Comment Sheets [Page 378].
If you have maintained a comment sheet, this is indicated via the pushbutton Comment sheet in the PI sheet header. You can use this pushbutton to access existing comments both in the maintenance and in the display mode; see Displaying Comment Sheets [Page 379].
Comments on specific processing steps (control instructions) that are reported to process management.
•
This type of comment is always linked to a specific processing step (control instruction) within the PI sheet. If you have maintained a comment on a processing step, the document symbol and the start of the comment are displayed at the right of the corresponding control instruction. You can call up and change a comment until it is reported; see Maintaining Comments on Processing Steps [Page 380].
The comments are reported using process messages of a category PI_COMM which has been predefined for this purpose by SAP. They are reported along with the other data for the respective processing step (see Reporting of Data [Page 358]).
When you display a PI sheet, you cannot create or report new comments, but you can display the existing ones; Displaying Comments [Page 381].
April 2001 377
Process Management (PP-PI-PMA) SAP AG
Maintaining Comment Sheets in ABAP List-Based PI Sheets
Maintaining Comment Sheets in ABAP List-Based PI Sheets To maintain the comment sheet of a PI sheet, proceed as follows:
1. From the overview screen of the PI sheet, call up the comment sheet in one of the following ways:
– If you have already maintained the comment sheet for the current PI sheet, double-click the Comment sheet pushbutton in the PI sheet header.
– If you are maintaining the comment sheet for the first time, choose Extras → Comments → Comment sheet.
The text editor appears.
2. Enter your comment and save it.
3. Choose Back to return to the overview screen of the PI sheet.
378 April 2001
SAP AG Process Management (PP-PI-PMA)
Displaying Comment Sheets in ABAP List-Based PI Sheets
Displaying Comment Sheets in ABAP List-Based PI Sheets To display existing comments on the comment sheet, proceed as follows:
1. From the overview screen of the PI sheet, double-click the Comment sheet pushbutton in the PI sheet header.
The system displays the comment sheet for the PI sheet.
2. Choose Back to return to the overview screen of the PI sheet,.
April 2001 379
Process Management (PP-PI-PMA) SAP AG
Maintaining Comments on Process Steps in ABAP List-Based PI Sheets
Maintaining Comments on Process Steps in ABAP List-Based PI Sheets To maintain a comment on a process step, proceed as follows:
1. From the overview screen of the PI sheet, call up the text editor in one of the following ways:
– If you are creating a new comment, position the cursor on the corresponding control instruction and choose Extras → Comments → General.
– If you want to change an existing comment, double-click the document symbol or the start of the comment displayed in the overview.
The text editor appears.
2. Enter your comment and save it.
3. Choose Back to return to the overview screen of the PI sheet.
380 April 2001
SAP AG Process Management (PP-PI-PMA)
Displaying Comments in ABAP List-Based PI Sheets
Displaying Comments in ABAP List-Based PI Sheets To display existing comments in the PI sheet, proceed as follows:
1. On the overview screen of the PI sheet, double-click the line in which the start of the comment is displayed.
The system displays a detail screen with the entire comment.
2. Choose Back to return to the overview screen of the PI sheet.
April 2001 381
Process Management (PP-PI-PMA) SAP AG
Displaying of Logs in ABAP List-Based PI Sheets
Displaying of Logs in ABAP List-Based PI Sheets When you display a PI sheet, the system creates the following logs:
• A display log which documents errors found when the PI sheet was edited for display (for example, that a long text referred to in the PI sheet does not exist in the system)
• A loading log which documents errors found when the data for the individual process instruction was loaded (for example, that the message category requested in a process instruction does not exist)
When you maintain a PI sheet, the following additional logs are created:
• A maintenance log which documents errors discovered during data maintenance
• A calculation log which documents all errors found during calculations
Whenever new entries are made in a log, a corresponding system message is displayed.
The display log always contains the information relevant to the PI sheet section currently displayed. The data in all other logs is retained until you leave the PI sheet or change from display to maintenance or vice versa.
Displaying Logs [Page 383]
382 April 2001
SAP AG Process Management (PP-PI-PMA)
Displaying Logs in ABAP List-Based PI Sheets
Displaying Logs in ABAP List-Based PI Sheets To display one of the logs in a PI sheet, proceed as follows:
1. On the overview screen of the PI sheet, choose Goto → Logs and the log type you would like to display.
The system displays the header information of the log.
2. Select the log and choose Display messages.
The system messages contained in the log are displayed.
3. To call up the long text for a message in a log, position the cursor on the message and choose Long text.
4. From here, you can return to the overview of the log messages by choosing Continue.
5. Choose Back to return to the PI sheet.
April 2001 383
Process Management (PP-PI-PMA) SAP AG
Locating of Process Instructions in ABAP List-Based PI Sheets
Locating of Process Instructions in ABAP List-Based PI Sheets Use Within PI sheet maintenance, the system offers a function which allows you to determine the phase and process instruction in which a specific element of the PI sheet was defined; Locating Process Instructions in ABAP List-Based PI Sheets [Page 385].
You need this function in the following situations:
• If you are testing your PI sheet and you have found an error in the definition of a specific element, you can use this function to find the process instruction you need to change.
• System messages in the log normally specify the process instruction to which they refer. If a system message indicates an error you have made when maintaining the process instruction in the PI sheet, you can use the above function to find the relevant element of the PI sheet.
384 April 2001
SAP AG Process Management (PP-PI-PMA)
Locating Process Instructions in ABAP List-Based PI Sheets
Locating Process Instructions in ABAP List-Based PI Sheets
2. Choose Extras → Current position.
To determine the process instruction to which a specific element of a PI sheet corresponds, proceed as follows:
1. On the overview screen of your PI sheet, position the cursor on the element for which you want to determine the process instruction.
A dialog box appears containing the numbers of the phase and the process instruction corresponding to the selected element.
3. Choose Continue to return to the overview screen of the PI sheet.
April 2001 385
Process Management (PP-PI-PMA) SAP AG
Saving of ABAP List-Based PI Sheets
Saving of ABAP List-Based PI Sheets Use If you need to leave a PI sheet before it has been fully processed, you can save the entered data without reporting it; see Saving ABAP List-Based PI Sheets [Page 387].
You can still change the data after you have saved it.
Besides the values, the system also saves the cursor position. This means that on accessing the PI sheet again, you will be taken to the place where you were before leaving the PI sheet.
386 April 2001
SAP AG Process Management (PP-PI-PMA)
Saving ABAP List-Based PI Sheets
Saving ABAP List-Based PI Sheets To save a PI sheet, proceed as follows:
On the overview screen of the PI sheet, choose PI sheet → Save or the corresponding icon.
The system saves the data and returns to the initial screen for maintaining PI sheets.
April 2001 387
Process Management (PP-PI-PMA) SAP AG
Signing of ABAP List-Based PI Sheets
Signing of ABAP List-Based PI Sheets Use You use signatures or digital signatures [Ext.] at the end of PI sheets to confirm that the data entered in the PI sheet is correct and complete.
For statements concerning quality in the manufacturing process, you can enter a comment. If the corresponding settings have been made in Customizing for Batch Records, this comment is included in the PI sheet document and the Deviation document of the batch record. It can be used as a basis for the usage decision.
Prerequisites A process instruction in which a signature has been specified as an input value has been defined in the PI sheet (see Definition of Signatures [Page 263]).
The type of signature to be used in PI sheets has been defined in Customizing for the control recipe destination. You have the following options:
• Signature without a password check
• Signature with a password check In this case, you must also define passwords for the corresponding users in Customizing for the control recipe destination.
To execute the signature, you may also need a maintenance authorization for the PI sheet, which is defined in the process instruction.
Digital signature [Ext.] [Ext.] •
If several individual signatures are to be executed, you also define a signature strategy [Ext.] in the control recipe destination or in the process instruction.
The process instruction can specify whether the signature strategy is carried out
For more information about digital signatures and the required settings, see Approval Using Digital Signatures [Ext.].
Features The system processes signatures or digital signature that you use to sign a PI sheet in exactly the same way as signatures that you enter to complete a process step (see Reporting of Actual Data in ABAP List-Based PI Sheets [Page 358]).
Unlike signatures you use to completes process steps, you can carry out signature strategies in two different ways:
• Synchronous procedure
This procedure is carried out by default. All individual signatures must be executed immediately after one another. It is only then that the system saves the signatures and completes the process step.
• Asynchronous procedure
388 April 2001
SAP AG Process Management (PP-PI-PMA)
Signing of ABAP List-Based PI Sheets
You must activate this procedure in the process instruction. It can only be carried out when completing the PI sheet. The system immediately saves each individual signature. You can carry out several other functions in between the individual signatures.
Activities Entering Signatures [Page 362]
Executing Digital Signatures [Page 36 ]3
Executing Signature Strategies [Page 365]
Canceling Signature Process [Page 36 ]8
Displaying Digital Signatures [Page 37 ]0
April 2001 389
Process Management (PP-PI-PMA) SAP AG
Completion of ABAP List-Based PI Sheets
Completion of ABAP List-Based PI Sheets Use
After you have fully processed a PI sheet, you can set the status of the PI sheet to Complete; see Setting ABAP List-Based PI Sheets to Complete [Page 391].
Prerequisites
•
A PI sheet can only be set to Complete if:
• All entries required on the PI sheet have been made
• All calculations have been carried out successfully
• All the data on the PI sheet has been reported
Implications When you set the status of a PI sheet to Complete, the system creates a message on the control recipe status (message category PI_CRST). This triggers the following changes:
• The status of the control recipe is set to Processed.
• The status of the corresponding order phases is set to Control recipe processed.
You need to set the status of your PI sheets to Complete or Technically complete if you want to:
Archive them via process data documentation
• Delete the PI sheet (see the corresponding section in PI Sheet Processing [Page 334])
390 April 2001
SAP AG Process Management (PP-PI-PMA)
Setting ABAP List-Based PI Sheets to Complete
Setting ABAP List-Based PI Sheets to Complete To set a PI sheet to Complete, proceed as follows:
On the overview screen of the PI sheet, choose PI sheet → Set to complete.
If the PI sheet has been fully processed, the system now sets the PI sheet status to Complete. Otherwise, a corresponding error message is displayed.
April 2001 391
Process Management (PP-PI-PMA) SAP AG
Changing of Control Information in ABAP List-Based PI Sheets
Changing of Control Information in ABAP List-Based PI Sheets Use You can change the control information displayed in an existing PI sheet if this information was defined in the process instruction using the characteristic PPPI_INSTRUCTION. The change is only relevant for the PI sheet. It has no effect on the process order from which the PI sheet was created.
See: Changing Control Information in ABAP List-Based PI Sheets [Page 393].
392 April 2001
SAP AG Process Management (PP-PI-PMA)
Changing Control Information in ABAP List-Based PI Sheets
Changing Control Information in ABAP List-Based PI Sheets To change a control instruction in a PI sheet, proceed as follows:
1. On the overview screen of the PI sheet, position the cursor on the control instruction you want to change.
2. Choose Edit → Edit text.
The text editor appears.
3. Make the desired changes and save them.
April 2001 393
Process Management (PP-PI-PMA) SAP AG
Canceling of Order Confirmations in ABAP List-Based PI Sheets
Canceling of Order Confirmations in ABAP List-Based PI Sheets Use There are two ways in which you can create an order confirmation from within the PI sheet:
• With a data request, by reporting the phase status in a process message
• Using a function call that provides direct access to order confirmation
If you have entered a confirmation and you notice that the data confirmed is incorrect, you can cancel the data from within the PI sheet.
For information about how to access the cancel function, see Canceling Order Confirmations Within ABAP List-Based PI Sheets [Page 395].
Features To carry out the function, you need to proceed in the same way as when you cancel a confirmation within order maintenance; see How to Cancel a Completion Confirmation [Ext.].
• If the confirmation you want to cancel was entered using a process message, you will find the
confirmation number in the destination-specific message log of the corresponding process message; see Process Message Logs [Page 86].
• If when confirming an operation you also activate user statuses, they are not automatically canceled when you cancel the confirmation.
394 April 2001
SAP AG Process Management (PP-PI-PMA)
Canceling Order Confirmations Within ABAP List-Based PI Sheets
Canceling Order Confirmations Within ABAP List-Based PI Sheets To cancel an order confirmation from within the PI sheet, proceed as follows:
1. On the overview screen of the PI sheet, choose Environment → Cancel → Confirmation.
The initial screen for canceling confirmations appears.
2. From here, proceed in the same ways as when canceling a confirmation during order processing. For more information, see Canceling Confirmations [Ext.].
April 2001 395
Process Management (PP-PI-PMA) SAP AG
Canceling of Material Documents in ABAP List-Based PI Sheets
Canceling of Material Documents in ABAP List-Based PI Sheets
Use There are two ways in which you can post goods movements from within the PI sheet:
• With a data request, by reporting a material quantity produced or consumed in a process message
• When you enter an order confirmation either via a process message or using a function call
If you have posted a goods movement, and you notice that the data posted is incorrect, you can cancel the data from within the PI sheet.
For information about how to access the cancel function, see Canceling Material Documents Within ABAP List-Based PI Sheets [Page 397].
Features To carry out the function, you need to proceed in the same way as when you cancel a material document within inventory management; see Entering a Reversal Document with Reference to a Material Document [Ext.].
If the goods movement you want to cancel was triggered using a process message, you will find the number of the material document in the destination-specific message log of the corresponding process message; see Process Message Logs [Page 86].
396 April 2001
SAP AG Process Management (PP-PI-PMA)
Canceling Material Documents Within ABAP List-Based PI Sheets
Canceling Material Documents Within ABAP List-Based PI Sheets To cancel a material document from within the PI sheet, proceed as follows:
1. On the overview screen of the PI sheet, choose Environment → Cancel → Material doc.
The initial screen for canceling material documents appears
2. From here, proceed in the same way as when canceling a material document manually in inventory management. For more information, see Entering Reversal Documents with Reference to Material [Ext.].
April 2001 397
Process Management (PP-PI-PMA) SAP AG
Activating/Deactivating of Process Instructions in ABAP List-Based PI Sheets
Activating/Deactivating of Process Instructions in ABAP List-Based PI Sheets Use The status of a PI sheet can only be set to Complete if:
•
• All entries required on the PI sheet have been made
All calculations have been carried out successfully
If a process cannot be carried out according to plan, some of this data may not be available. In this case, you can deactivate individual process instructions in the PI sheet; see Activating/Deactivating Process Instructions in ABAP List-Based PI Sheets [Page 399].
Process instructions which have been deactivated are no longer taken into account when the PI sheet is checked, and the PI sheet can be set to "complete".
Prerequisites A process instruction can only be deactivated if the corresponding data has not yet been reported.
A deactivated process instruction can no longer be processed in the PI sheet. You can, however, reactivate the process instruction.
398 April 2001
SAP AG Process Management (PP-PI-PMA)
Activating/Deactivating Process Instructions in ABAP List-Based PI Sheets
Activating/Deactivating Process Instructions in ABAP List-Based PI Sheets To activate or deactivate a process instruction, proceed as follows:
1. On the overview screen of the PI sheet, position the cursor on the process instruction.
2. Choose Edit → Activate or Edit → Deactivate.
The selected function is carried out.
April 2001 399
Process Management (PP-PI-PMA) SAP AG
Technical Completion of ABAP List-Based PI Sheets
Technical Completion of ABAP List-Based PI Sheets Use If a process needs to be canceled, for example, due to a malfunction, the PI sheet controlling the execution of this process also needs to be canceled.
You can cancel a PI sheet by assigning the status Technically complete to it; see Setting ABAP List-Based PI Sheets to Technically Complete [Page 401].
Implications When you set the status of a PI sheet to Technically complete, the system creates and sends a corresponding message on the control recipe status (message category PI_CRST) which triggers the following changes:
• If you have not yet started processing the PI sheet,
– The status of the control recipe is set to Discarded
– The status of the corresponding order phases is set to Control recipe discarded
This means that the phases can be changed again and a new control recipe can be created for them.
• If you have already started processing the PI sheet,
– The status of the control recipe is set to Terminated
– The status of the corresponding order phases is set to Control recipe processed
You need to set the status of your PI sheets to Technically complete or Complete if you want to
Archive them via process data documentation •
• Delete the PI sheet (see the corresponding section in PI Sheet Processing [Page 334])
400 April 2001
SAP AG Process Management (PP-PI-PMA)
Setting ABAP List-Based PI Sheets Technically Complete
Setting ABAP List-Based PI Sheets Technically Complete To set a PI sheet to Technically complete, proceed as follows:
On the overview screen of the PI sheet, choose PI sheet → Set to tech.complete.
April 2001 401
Process Management (PP-PI-PMA) SAP AG
Deleting ABAP List-Based PI Sheets
Deleting ABAP List-Based PI Sheets The PI sheet menu has been revised for Release 4.6C. The Delete PI Sheet transaction is now no longer available in the menu but you can still access it by entering transaction code CO59. However, you can only use the transaction for ABAP list-based PI sheets.
As of Release 4.6C, there are a number of different transactions in the PI Sheet menu that you can use to select PI sheets.
For more information, see Worklist for PI Sheets [Page 316].
After you have called transaction CO59, a selection screen appears on which you can enter the selection criteria for the PI sheets you want to delete
1. If you have predefined your selection criteria in a selection variant, choose Goto → Variants → Get and select this variant.
If you still need to define your selection criteria, you have the following options:
– You can enter a single value or a value range directly on the selection screen.
– You can use the Multiple selection function to enter more than one single value or value range.
– You can use the Selection options function to exclude the value you have entered from the selection or to select all values less than or greater than the single value entered.
If you want to use the same selection criteria again, you can save them as a selection variant by choosing Goto → Variants → Save as variant.
2. Choose Execute.
The system deletes the PI sheets you have selected.
A list of PI sheets matching the specified selection criteria appears.
3. In this list, select the PI sheets you want to delete and choose PI sheet → Delete.
4. Confirm that you want to delete the PI sheets.
402 April 2001
SAP AG Process Management (PP-PI-PMA)
Monitoring and Logging of Signature Processes
Monitoring and Logging of Signature Processes Use Digital approval processes must be reliable and transparent in order to comply with security requirements. For this reason, the SAP System offers the following:
• You can lock users after a customer-specific number of unsuccessful attempts has been reached.
• You can monitor security-relevant activities that occurred during the signature process.
• You can analyze all activities performed in the context of the signature process.
Features User Lock When a signature is executed, unsuccessful attempts can take place for a number of different reasons (for example, the user has entered the wrong password, the user is not authorized to execute the signature, or the system could not verify the signature). After a certain number of unsuccessful attempts has been exceeded, the user is locked as follows:
• When a system signature is executed, the user is locked by the SAP System. The lock applies to the digital signature and a new system logon. You set up the number of unsuccessful attempts in the system profile (see Limiting Logon Attempts and Defining Clients [Ext.]).
• When a user signature is executed, the user is locked by the external security product. The lock only applies to the digital signature. The number of allowed unsuccessful attempts is managed by the external security product.
Security Audit Log Any failed signature attempt is logged in the Security Audit Log along with other security-relevant events of the SAP System. The system documents, for example, the reason for the error, date and time, and the signatory's user ID. The security administrator can use the CCMS alert monitor to evaluate the Security Audit Log.
Log for Digital SignatureThe log for the digital signature documents all relevant steps in a signature process. This includes successful and canceled signatures as well as signatures that were deleted when the signature process was canceled. You can evaluate the signature log, for example, by signature object, signature time, and the signatory's user ID (see Analyzing Logs for Digital Signatures [Page 404]). It contains the result of the signature steps along with all messages and the data that is transferred to the signed document if the signatures were successful.
April 2001 403
Process Management (PP-PI-PMA) SAP AG
Analyzing Logs for Digital Signatures
Analyzing Logs for Digital Signatures Use You can use this procedure to get an overview of the course signature processes took and evaluate all activities performed in the course of the signature process.
If you only want to analyze the security-relevant events that occurred both in the context of digital signatures and during other activities in the SAP System, use the CCMS alert monitor to analyze the Security Audit Log instead (see The Alert Monitor [Ext.]).
Procedure 1. Call up the log for the digital signature as follows:
Area Choose:
Engineering Change Management (ECH) Reporting → Log for Digital Signature
Process management (PP-PI) Evaluations → Log for Digital Signature
Batch record (PP-PI) Goto → Log for digital signature
2. Enter the criteria for log selection and choose .
The overview of the logs that the system selected appears. The following data is displayed:
− In the top screen area, the logs' header data, that is, the date and time, the signatory name, the number or log messages, and the reason for signature
There is exactly one log for each signature attempt.
− In the bottom screen area, the messages of the logs selected, that is, the result of the signature steps and all relevant signature data
Messages are marked according to their type and logs are marked according to the most serious message type they contain:
Symbol Message Type
Information
Warning
Error
404 April 2001
SAP AG Process Management (PP-PI-PMA)
Analyzing Logs for Digital Signatures
Abend
In addition, the following log classes are highlighted in different colors:
Log or Error Class Text Color
Signature process canceled Log red, message highlighted in yellow
Wrong password, name not maintained, missing SSF info
Log and message highlighted in yellow
3. Use the following functions to analyze the logs:
− If you only want to display messages of a particular type, choose the corresponding icon in the symbol bar at the bottom of the screen.
− If you only want to display messages of a particular log, double-click the log in the top screen area. By double-clicking the higher-level node, the system again displays all logs of the corresponding object type.
− To display the long text for a message, choose in the corresponding line in the bottom area of the screen.
April 2001 405
Process Management (PP-PI-PMA) SAP AG
Process Manufacturing Cockpits
Process Manufacturing Cockpits Use Process manufacturing cockpits are screen templates that you can define in Customizing using process instruction characteristics.
You can use cockpits, for example, for the following:
You can use a cockpit as an input template to record measurement readings or malfunction reports and send this data to plant maintenance using process messages.
•
•
•
You can use a cockpit as a toolbox to make information and function calls that are needed over and over again available at a central position.
You can define different cockpits for different purposes, for example, one in which a specific Internet page is displayed. You can then include these cockpits in PI sheets.
The same cockpit may be used more than once at the same time.
You can:
•
•
Integrate cockpits in PI sheets and other cockpits
Use cockpits as separate input templates
PrerequisitesTo be able to use the process manufacturing cockpit correctly, you must install Microsoft® Internet Explorer Version 5 or higher and make a few security settings in the Internet Explorer. For more information, see Setting Up the Browser for PI Sheets and Cockpits [Page 45 ]5 .
Features
•
•
•
•
Functions You can do the following in process manufacturing cockpits:
Display information as a long text, such as instructions on how to carry out a particular process step
Use process messages to report current data to another R/3 application, such as malfunction reports to plant maintenance
Use dynamic function calls to:
− Call up other R/3 applications from within the cockpit, make entries there, and afterwards return to the cockpit
− Display documents from the document management system in the cockpit
− Perform calculations (such as, calculate dates of time intervals)
Use user-defined function modules to start a dialog or retrieve data from internal or external applications
You use process instructions of type 0 to define these functions in Customizing. For more information, see Process Instructions for Process Manufacturing Cockpits [Page 416].
406 April 2001
SAP AG Process Management (PP-PI-PMA)
Process Manufacturing Cockpits
The standard system contains a number of predefined process message categories and dynamic function calls. Most of them have been designed for use in the PI sheet. Values can be assigned automatically to many data of a process message or parameters of a function module in the PI sheet or even in the process order.
You can use the order-related standard message categories and function calls in the manufacturing cockpit, too. However, you must assign the values of the order-related data manually.
For more information about process message categories and dynamic function calls, see:
R/3 Integration Using Process Messages [Page 27] •
Type 0: Definition of Dynamic Function Calls [Page 44 ]7 •
Layout You can define your own layout for process manufacturing cockpits. To do so, you must declare a layout in Customizing for cockpit definitions. For more information, see Layout Definition for PI Sheets and Cockpits [Page 457].
If you do not specify a layout definition, the system uses the standard layout defined for manufacturing cockpits. For more information on the structure of process manufacturing cockpits in the SAP standard layout, see Process Manufacturing Cockpit [Page 408].
Activities • Defining Cockpits
You define process manufacturing cockpits in Customizing for Process Management. For more information on the procedure, see Defining and Starting Process Manufacturing Cockpits [Page 456].
Copying Cockpits Between Clients •
•
To copy manufacturing cockpits from the logon client to any other client, you need to execute the RCOPOC_COCKPIT_CLIENT_COPY report program. The cockpit is then copied to the same plant in the target client to which it belongs in the source client.
Copying Cockpits Between Plants To copy manufacturing cockpits between the different plants of a client, you must execute the RCOPOC_COCKPIT_PLANT_COPY report program.
SAP plans to make the above report program functions available as Customizing activities in the next functional release.
April 2001 407
Process Management (PP-PI-PMA) SAP AG
Process Manufacturing Cockpit
Process Manufacturing Cockpit Definition Process manufacturing cockpits are screen templates that you can define in Customizing using process instruction characteristics.
Structure The SAP Standard Layout You can define your own layout for process manufacturing cockpits. To do so, you must declare a layout in Customizing for cockpit definitions. For more information, see Layout Definition for PI Sheets and Cockpits [Page 457].
If you do not specify a layout definition, the system uses the standard layout defined for manufacturing cockpits.
The cockpit consists of one or more sections that can be expanded and collapsed. Each section is generated from one process instruction. Each section has a separate heading. In a section, all input fields, output fields, pushbuttons, tables, short texts, and long texts for a process instruction are displayed in the sequence in which they have been defined on the characteristic overview.
Label Text for Sections Which label text is used for which section depends on the contents you have defined in the process instructions. You can specify your own label text. The system follows the following logic:
1. Your own label text is used if you have defined the following characteristics in the process instruction:
Characteristic Meaning Allowed Values
<any long text characteristic> Text displayed in the section Any text; If you only want to define a label text, enter blank characters instead of text.
PPPI_OUTPUT_TEXT Text displayed in the label for the section
Any text
PPPI_OUTPUT_CHARACTERISTIC or
Long text characteristic whose text is displayed in the section
Long text characteristic to be displayed
PPPI_OUTPUT_VARIABLE Variable whose value is displayed in the section
Variable to be displayed
For the system to be able to display the label text you have defined in the label for a section, you must define characteristics PPPI_OUTPUT_CHARACTERISTIC and PPPI_OUTPUT_VARIABLE before the following functions in the process instruction:
• Input fields
• Output fields
• Calculations
408 April 2001
SAP AG Process Management (PP-PI-PMA)
Process Manufacturing Cockpit
• Function calls
2. The Entry label is automatically used:
a. If you have not defined your own label text
b. If one of the following characteristics has been defined in the process instruction:
• PPPI_REQUESTED_VALUE (message characteristic whose value is to be assigned manually)
• PPPI_CALCULATED_VALUE (message characteristic to be calculated)
3. The ?Activity label is automatically used:
a. If none of the characteristics mentioned in point 1 has been found
b. If none of the characteristics mentioned in point 2 has been found
c. If the following characteristic has been defined in the process instruction:
• PPPI_FUNCTION_NAME (name of an ABAP function module)
4. The Information label is automatically used if none of the characteristics mentioned in points 1, 2, and 3 is defined in the process instruction.
Interface Elements
Interface Element
Output and Meaning
Expand Collapse
sections
The icon indicates that a section can be expanded. You can use the to collapse expanded sections.
* Required entry A red asterisk to the right of input fields indicates that data must be entered into these fields so that, for example, a process message can be created.
This icon is always displayed to the right of a field if a value is to be calculated by the system. When you choose , the calculated value is displayed in the corresponding field.
Calculate data
A pushbutton with the name of a function is displayed whenever a dynamic function call, for example, a jump to different R/3 application, has been defined. When you choose the pushbutton, the corresponding function is called.
Pushbutton
Input help If the R/3 System provides an input help for an input value, the icon is displayed to the right of the relevant input field. You can also use Ctrl + H to call up input help.
Input field
Fixed values If fixed values have been defined for a characteristic, these values are offered in a dropdown list.
User-defined default values Default values that you have defined in the process instruction are displayed directly in the input field. At first, they are displayed in blue. To use the default value, position the cursor in the input field and choose Continue.
April 2001 409
Process Management (PP-PI-PMA) SAP AG
Process Manufacturing Cockpit
The icon at the end of a table indicates that you can add more lines to the table. When you choose , the system adds a new line at the end of the table. This function is identical to the Add line (table) function in the context menu.
Add table line
The icon is displayed at the end of a section whenever at least one process message has been defined in the process instruction.
Close
When you have entered all required values for this section (process instruction) in the cockpit, you can choose the New entries icon. The process messages for this section are automatically created. All input fields are deactivated. This function is identical to the Complete (process instruction) function in the context menu. You cannot complete a process instruction unless all required entries have been made. The asterisk next to the text field shows you which entries are required.
The icon is displayed at the end of a section, whenever: - Entries have been made or functions have been executed - The relevant process instruction has been completed and the input fields have been deactivated. When you choose New entries, all input fields become ready for input again. This function is identical to the New entries (process instruction) function in the context menu.
New entries
Navigation Using the Keyboard In the cockpit, you can use the mouse to access all the fields and call up all the functions. In addition, you can use the TAB key to navigate between active fields. With icons, you need to choose Enter to start the corresponding function or open the dialog box. If you set the focus to the icon, for example, and then choose Enter, values will be calculated.
The following fields are active fields in the cockpit:
Input fields •
•
•
•
Table lines that are ready for input
Pushbuttons
Icons that can be clicked, such as:
− Expanding sections
− Collapsing sections
− Calculating data
− Adding table lines
− Completing a process instruction
− New entries (process instruction)
You can also use a key combination to call up the following functions:
410 April 2001
SAP AG Process Management (PP-PI-PMA)
Functions in Process Manufacturing Cockpits
Function Key Combination
Call up context menu Shift + F10
Call up input help Ctrl + H
Integration You can integrate a cockpit in PI sheets and other cockpits in any way you like. To do so, you must define a layout with a frameset. For more information, see Layout Definition for PI Sheets and Cockpits [Page 457].
Functions in Process Manufacturing Cockpits Use This section provides information about the functions in the process manufacturing cockpit that:
•
•
• Lead to the automatic creation of process messages
Prerequisites
•
•
•
Can be executed using the context menu or icons
Support data entry
To be able to use the functions described below in the cockpit, the following requirements must be met:
Recording Data
Default value A default value has been defined for the input field in the corresponding process instruction in the cockpit definition.
Input help An input help has been defined in Customizing for the process instruction characteristic to which the input field belongs.
Input validation An input validation has been defined for the input field in the corresponding process instruction in the cockpit definition. See Type 0: Definition of Input Validations [Page 42 ]9
Reporting Data • To report data
To be able to report values you have entered, you must have defined a message creation [Page 423] in which the input value is included as a characteristic in the process instruction.
To execute a signature A process instruction in which the signature is defined as an input value has been included in the cockpit definition. See Type 0: Definition of Entries [Page 424]
•
April 2001 411
Process Management (PP-PI-PMA) SAP AG
Functions in Process Manufacturing Cockpits
Features Functions in the Context Menu The following functions are available in the context menu of the manufacturing cockpit:
Functions in the Context Menu Available for
Process step Display position The line number of the process instruction and of the process instruction characteristic in which the proces step was defined is displayed.When you find an error while testing the cockpit, you can use this function to find the process instruction that must be changed.
Process step Display message You can use this function to display the message to be used to report the values entered or calculated.
Table New entries (table line) If you have entered a value in a table line or completed a value that you have entered, you can use this function to make the table line ready for input again.
Complete (table line) You can use this function to complete individual table lines. The process messages for this table line are automatically created. The table line is deactivated. You cannot complete a table line unless all required entries have been made.
Table
Add line (table) If lines can be added to a table, you can choose this function. You can also use the icon to perform this function.
Table
Complete (table) You can use this function to complete an entire table. The process messages for this table are automatically created. All input fields in the table are deactivated. You cannot complete a table unless all required entries have been made.
Table
412 April 2001
SAP AG Process Management (PP-PI-PMA)
Functions in Process Manufacturing Cockpits
Section New entries (process instruction) If you have entered a value in a process instruction (section) or completed the values you have entered, you can use this function to make the process instruction ready for input again.
Section Complete (process instruction) You can use this function to complete a process instruction (section). The process messages for this section are automatically created. All input fields in the section are deactivated. You can also use the icon to perform this function. You cannot complete a process instruction unless all required entries have been made. The asterisk next to the text field shows you which entries are required.
Entire cockpit New entries (document) If you have entered values in the cockpit or completed the values you have entered, you can use this function to make the entire cockpit ready for input again.
Entire cockpit Complete (document) You can use this function to complete the entire cockpit. All process messages for the cockpit are automatically created. All input fields are deactivated. You cannot complete a cockpit unless all required entries have been made. The asterisk next to the text field shows you which entries are required.
When you perform the New entries function, bear in mind the hierarchy according to which the objects in a cockpit are structured. Individual sections (process instructions) are, for example, subordinate to the entire cockpit and individual tables are subordinate to a process instruction.
If the entire cockpit has been completed, you cannot edit the table in a section directly. You first need to reset the cockpit (New entries )document)) before you can make new entries in the table.
April 2001 413
Process Management (PP-PI-PMA) SAP AG
Functions in Process Manufacturing Cockpits
Recording Data In the cockpit, you can record individual values in individual input fields or several values in a table. When recording data, you can use the following funtions:
•
•
•
If an input validation is defined for a value in the cockpit definition, the system checks your entries. If the value you enter is outside the defined value range, the system issues a warning.
However, you can still transfer the invalid input value to the cockpit, if this has been specified in the process instruction. You can make the following settings:
Implications
Default values The input fields for which you have defined default values in the cockpit definition already contain these default values when you open the cockpit. You can:
− Accept the default value by positioning the cursor on the input field and choosing Continue
− Replace the default value by another value
− Delete the default value
Input help If the appropriate Customizing settings have been made, you can use input help to choose a value for input fields.
Input validation
− Invalid values are accepted without any restrictions
− Invalid values are not accepted
− Invalid values are only accepted with a signature
Once you have entered a value that does not comply with the validation rule, you may from then on change the value assignment but may no longer delete it.
In the cockpit, you can only define signatures without a password check.
Reporting Data You can trigger the automatic creation of process messages as follows in the cockpit:
Function
Complete (table line)
Complete (table)
Complete (process instruction)
All process messages are automatically created. All input fields are deactivated, which means they are no longer ready for input.
Complete (document)
Signature in input field All process messages as of the preceding signature are automatically created. All input fields as of the preceding signature are deactivated, which means they are no longer ready for input.
414 April 2001
SAP AG Process Management (PP-PI-PMA)
Functions in Process Manufacturing Cockpits
The procedure for signing tables differs depending on whether the signature is required or optional.
Signature in table
• If the signatures are required, the system selects all data to be reported for the corresponding table line. You can execute the signatures in any sequence.
• If the signature is optional, you can, for example, enter values in several table lines and then sign in the third line. The system automatically copies the signature you have executed to the preceding lines. It selects all data to be reported for the preceding lines that have not yet been completed.
All input fields are deactivated, which means they are no longer ready for input.
April 2001 415
Process Management (PP-PI-PMA) SAP AG
Process Instructions for Process Manufacturing Cockpits
Process Instructions for Process Manufacturing Cockpits Use To define process manufacturing cockpits, you can use universal process instruction categories [Ext.] of type 0 available in Customizing. You cannot use the other process instruction types in the cockpit definition.
Integration In Customizing for the cockpit definition, you can define process instructions as follows:
You create a new process instruction category of type 0. •
•
The process instruction categories that you create in the cockpit definition are only available there and cannot be used in master recipes or process orders.
You refer to existing process instructions in the Customizing activity Define Process Instruction Categories [Ext.] in the cockpit definition.
You can refer to all process instruction categories of type 0 contained in this Customizing activity. When you refer to existing process instruction categories, changes that are made in the Customizing activity Define Process Instruction Categories also affect the process instruction in the cockpit definition.
You copy existing process instructions of the Customizing activity Define Process Instruction Categories.
•
You can copy all process instruction categories of type 0 contained in Customizing. When you do so, the link to the original process instruction category is lost.
Prerequisites For the system to be able to process the process instructions correctly in the cockpit, they must contain certain characteristics and be structured according to specific rules. Note that some process instruction characteristics may not be used in cockpit definitions.
The following sections describe the structure of universal process instruction categories (type 0) that are used in cockpits.
• Defining phase sequences
•
• Using digital signatures
Note that at present you cannot use the process instruction assistant to define process instructions of Type 0: Universal process instruction category.
Features You can use process instruction type 0 both in PI sheets and manufacturing cockpits. However, the following functions though available in PI sheets are not supported in cockpits:
Using global variables
416 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Structure of Process Instructions for Manufacturing Cockpits
This means that you may not use the following characteristics in cockpits:
Characteristic Meaning
PPPI_GLOBAL_VARIABLE Defining a value as a global variable
PPPI_DECLARE_VARIABLE Declaring existing global variables
PPPI_VARIABLE_TYPE Type of the global variable you have declared
PPPI_SIGNATURE_STRATEGY Signature strategy for digital signatures
PPPI_SIGNATURE_MODE Signature mode (synchronous or asynchronous)
PPPI_PREDECESSOR Number of the predecessor phase
The following functions are supported in process manufacturing cockpits:
Definition of Data Requests [Page 421] •
Definition of Message Creation [Page 42 ]3 •
Definition of Entries [Page 424] •
Definition of Default Values for Input Values [Page 427] −
Definition of Input Validations for Input Values [Page 429] −
Definition of Output Fields for Characteristic Values [Page 437] •
Definition of Output Fields for Variable Values [Page 439] •
Definition of Calculations [Page 440] •
Definition of Automatic Value Assignment [Page 444] •
Definition of Value Assignment Using Variables [Page 446] •
Definition of Dynamic Function Calls [Page 447] •
Type 0: Structure of Process Instructions for Manufacturing Cockpits For the system to be able to correctly process universal process instructions in the process manufacturing cockpit, the characteristics must be defined in a particular sequence.
In the following sections, the characteristics are grouped into characteristic blocks according to their purpose. You can combine them into process instructions in the following sequence:
5. First, you define data requests.
6. Second, you define the message creation. You can define as many process message blocks as you like.
7. Fourth, you define any of the remaining characteristic blocks. Each characteristic block can be defined any number of times. You can define these characteristic blocks in any order whatever.
April 2001 417
Process Management (PP-PI-PMA) SAP AG
Type 0: Structure of Process Instructions for Manufacturing Cockpits
Order of Characteristic Blocks
3. Definition of dynamic function calls
3. Definition of value assignment using variables
3. Definition of automatic value assignment
3. Definition of calculations
3. Definition of output fields for variable values
3. Definition of output fields for characteristic values
3. Definition of entries
Process instructions
1. Definition of data request
2. Definition of message creation
Can
be
defin
ed m
ore
than
onc
e
Any
seq
uenc
e
Characteristic Blocks * = Optional
Definition of Data Requests [Page ] 421Characteristic Meaning
PPPI_DATA_REQUEST_TYPE Type of data request: < Simple data request (value "simple") < Repeated data request (value "repeated")
PPPI_MINIMUM_TABLE_SIZE * Minimum number of table lines
PPPI_MAXIMUM_TABLE_SIZE * Maximum number of table lines
Definition of Message Creation [Page ] 423Characteristic Meaning
PPPI_MESSAGE_CATEGORY Message category
Definition of Entries [Page 424] Characteristic Meaning
418 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Structure of Process Instructions for Manufacturing Cockpits
PPPI_INPUT_REQUEST * Text for input request
* Default value < Numerical value < Alphanumerical value < Variable < Characteristic value
< PPPI_DEFAULT_VALUE or < PPPI_DEFAULT_STRING or < PPPI_DEFAULT_VARIABLE or < <Any message characteristic>
< PPPI_VARIABLE
* Variable definition for the value you have entered< Variable
PPPI_REQUESTED_VALUE Characteristic to be entered
* Input validation: < Validation rule (max. 8 times) < Check function
< PPPI_VALIDATION_FORMULA or < PPPI_VALIDATION_FUNCTION
Export parameters (see Definition of Dynamic Function Calls)
> <Parameters for check function>
PPPI_TEXT_FOR_INVALID_INPUT * Long text for invalid entries
PPPI_ACCEPT_INVALID_INPUT * Accepting invalid entries
PPPI_SIGNATURE_AUTHORIZATION * Authorization for signature
Definition of Output Fields for Characteristic Values [Page ] 437Characteristic Meaning
PPPI_OUTPUT_TEXT * Text of output field
PPPI_OUTPUT_CHARACTERISTIC Characteristic to be output
Definition of Output Fields for Variable Values [Page ] 439Characteristic Meaning
PPPI_OUTPUT_TEXT * Text of output field
PPPI_OUTPUT_VARIABLE Variable to be output
Definition of Calculations [Page ] 440Characteristic Meaning
PPPI_INPUT_REQUEST Text for input request
PPPI_VARIABLE * Variable definition for value you have entered
PPPI_CALCULATED_VALUE Characteristic to be calculated
PPPI_CALULATION_FORMULA Calculation formula (characteristic may be assigned any number of times, the formula may, however, only be 240-character long)
Definition of Automatic Value Assignment [Page ] 444Characteristic Meaning
April 2001 419
Process Management (PP-PI-PMA) SAP AG
Type 0: Structure of Process Instructions for Manufacturing Cockpits
PPPI_VARIABLE * Variable definition for characteristic whose values is to be assigned automatically
PPPI_AUTOMATIC_VALUE Characteristic with automatic value assignment
Definition of Value Assignment Using Variables [Page ] 446Characteristic Meaning
PPPI_DEFAULT_VARIABLE Default - variable
PPPI_EXTERNAL_VALUE Value received
Definition of Dynamic Function Calls [Page 447] Characteristic Meaning
PPPI_FUNCTION_NAME Function module name
PPPI_BUTTON_TEXT * Button text
PPPI_FUNCTION_DURING_DISPLAY * Function call allowed in display mode
Parameters according to definition in function module: • <Export parameters> • <Changing parameters> • <Import parameters>
Parameters in function module
Definition of Export Parameters [Page ] 449
Characteristic Meaning
PPPI_EXPORT_PARAMETER Name of the import parameter in the function module
For value assignment of fixed values: < Any message characteristic < Constant - alphanumerical value < Constant - floating point number < Constant - date < Constant - time For value assignment using variables: < Variable - alphanumerical value < Variable - floating point number < Variable - date < Variable - time
< <Message characteristic> or < PPPI_STRING_CONSTANT or < PPPI_FLOAT_CONSTANT or < PPPI_DATE_CONSTANT or < PPPI_TIME_CONSTANT or < PPPI_STRING_VARIABLE or < PPPI_FLOAT_VARIABLE or < PPPI_DATE_VARIABLE or < PPPI_TIME_VARIABLE
PPPI_OPTIONAL_PARAMETER Optional parameter transfer
Definition of Changing Parameters [Page ] 451
Characteristic Meaning
PPPI_CHANGING_PARAMETER Name of the changing parameter in the function module
420 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Data Requests
Value transfer in variable: < Variable - alphanumerical value < Variable - floating point number < Variable - date < Variable - time
< PPPI_STRING_VARIABLE or < PPPI_FLOAT_VARIABLE or < PPPI_DATE_VARIABLE or < PPPI_TIME_VARIABLE
PPPI_OPTIONAL_PARAMETER * Optional parameter transfer
Definition of Import Parameters [Page ] 452
Characteristic Meaning
PPPI_IMPORT_PARAMETER Name of the export parameter in the function module
Value transfer in variable: < Variable - alphanumerical value < Variable - floating point number < Variable - date < Variable - time
< PPPI_STRING_VARIABLE or < PPPI_FLOAT_VARIABLE or < PPPI_DATE_VARIABLE or < PPPI_TIME_VARIABLE or
PPPI_OPTIONAL_PARAMETER * Optional parameter transfer
Type 0: Definition of Data Requests Use You use this function to specify whether ordinary input and output fields or a table with input and output fields are to be created in the browser-based PI sheet [Page 158] or Process Manufacturing Cockpit [Page 406].
Features The following types are available:
Simple data request: Ordinary input and output fields are created in the PI sheet or cockpit.
•
• Repeated data request: A table for the input and output of data is created in the PI sheet or cockpit.
If you do not enter a data request type, the system sets "simple data request" by default.
If you use a repeated data request, you also have the following options:
Minimum number of table lines: You can specify the minimum number of table lines that must be edited. In the PI sheet, you
•
April 2001 421
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Data Requests
cannot complete the corresponding process step unless you have entered data in these lines.
Maximum number of table lines: You can specify the maximum number of table lines permitted. Once data has been entered in these lines, the system does not further lines.
•
•
•
•
Activities When defining data requests, you specify the following information in the process instruction:
Type of data request
If required, the minimum number of tables lines that must be edited
If required, the maximum number of tables lines that may be edited
To enter this information, you assign the following characteristics to the process instruction in the order specified below:
Characteristic Meaning Allowed Values
PPPI_DATA_REQUEST_TYPE Data request type SIMPLE REPEATED
PPPI_MINIMUM_TABLE_SIZE Minimum number of table lines
PPPI_MAXIMUM_TABLE_SIZE Maximum number of table lines Any number
422 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Message Creation
Type 0: Definition of Message Creation Use You can use process messages to report actual data from production control to the process order or other R/3 components. Reporting actual data can trigger certain business transactions in the corresponding R/3 component. This ensures that the data from production control is consistent with the data of different R/3 components.
You can create process messages in any universal process instruction of type 0, irrespective of the functions it contains.
Prerequisites You must create the process message category you want to use in Customizing for Process Management under Process Messages -> Define and Set up Process Message Categories [Ext.].
Features The standard R/3 System contains a number of predefined process message destinations along with message categories.
In R/3 Integration Using Process Messages [Page 27] and the subordinate sections, you will find information about the following:
•
•
•
Characteristic Meaning Allowed Values
Which predefined message categories are contained in Customizing
Which business transactions may be triggered using these message categories
How these messages are processed
Activities You can define one or more process messages in each universal process instruction, depending on whether it is a simple or a repeated data request.
You assign the following characteristic to the process instruction:
PPPI_MESSAGE_CATEGORY Message category Any message category
Immediately after the characteristic PPPI_MESSAGE_CATEGORY, you must define at least all required characteristics of the message category.
If you want to create several messages, you can assign this characteristic several times.
The system reports all message characteristics, that is, even those that do not belong to the message category specified.
April 2001 423
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Entries
Type 0: Definition of Entries Use You can use this function to define input fields in the browser-based PI sheet [Page 15 ]8 or Process Manufacturing Cockpit [Page 406] in which you want someone to enter values.
In the PI sheet and cockpit, you can use input fields for the following:
To record specific actual values from the production environment •
•
•
In the PI sheet, you can also use input fields for the following additional functions:
To execute signatures that are to complete a process step in the PI sheet
To execute signatures that complete the entire PI sheet See also Completing Browser-Based PI Sheets [Page 178]
You can also define signatures that complete process instructions in cockpits but here Complete only means that process messages are created automatically.
You can use a process message to report the values the process operator has entered. See also Type 0: Definition of Message Creation [Page 423].
In addition, you can define the following functions for the value to be entered:
A default value •
•
•
•
An input validation
Prerequisites If you want to report the value entered, the characteristic that is marked as the input value must be contained in the message category.
Features The number of input fields to be created depends on the type of data request:
One input field is created for a simple data request.
A table column is created for a repeated data request.
If you do not enter a data request type, the system sets "simple data request" by default.
Activities When defining an input value, you specify the following information in the process instruction:
A text that is displayed before the corresponding input field or above the corresponding table column in the PI sheet or cockpit
•
424 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Entries
The message characteristic whose value is made available as the default value for the input value in the PI sheet or cockpit See also Type 0: Definition of Default Values [Page 427]
•
A variable that refers to the input characteristic if you want to use the characteristic in another process instruction of the same process order
•
•
•
The message characteristic whose value you want to enter
If required, an input validation that is used to check the input value in the PI sheet or cockpit See also: Type 0: Definition of Input Validations [Page 429] Here you define one of the following functions:
− A check formula for numerical values
− A check function for all values
To enter this information, you assign the following characteristics to the process instruction in the order specified below:
Characteristic Meaning Value
PPPI_INPUT_REQUEST Input request Any short text
Default value < Numerical value < Alphanumerical value < Variable < Characteristic value
< PPPI_DEFAULT_VALUE or < PPPI_DEFAULT_STRING or < PPPI_DEFAULT_VARIABLE or < <Any message characteristic>
Default value: < Any numerical value < Any alphanumerical value < Existing variable name < According to characteristic definition See also: Type 0: Definition of Default Values [Page 427]
Variable definition for value entered: < Variable
< PPPI_VARIABLE
Variable definition: < New variable name
In PI sheets only: < PPPI_GLOBAL_VARIABLE (See also: Process Instructions for Process Manufacturing Cockpits [Page 416])
Input validation: Boolean formula (see Syntax of Check Formulas [Page 432]) Name of the function module See also: Type 0: Definition of Input Validations [Page 429]
< Global variable
< New variable name
PPPI_REQUESTED_VALUE Message characteristic whose value is assigned manually
Characteristics of the assigned message category
< PPPI_VALIDATION_FORMULA or < PPPI_VALIDATION_FUNCTION
Check formula Check function
> <Parameters for check function>
PPPI_TEXT_FOR_INVALID_INPUT
Long text for invalid entries
Any long text
April 2001 425
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Entries
PPPI_ACCEPT_INVALID_INPUT Accepting invalid entries - Accept always - Accept never - Accept with signature only
In PI sheets only: PPPI_SIGNATURE_AUTHORIZATION
Authorization for signature
Any value for the Activity field in the authorization object C_CRPI_BER
In PI sheets only: PPPI_SIGNATURE_STRATEGY
Signature strategy
Signature strategy
A value can be assigned automatically to the characteristics for the date (PPPI_EVENT_DATE) and time (PPPI_EVENT_TIME) in the PI sheet. If you define these characteristics as input values, the system proposes the current values as possible entries in the PI sheet.
426 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Default Values
Type 0: Definition of Default Values Use If a planned or target value is available for an input value, you can enter the planned or target value as a default value in the process instruction.
If you have defined default values for one or several input values, these default values are displayed in the corresponding input fields when you access the browser-based PI sheet [Page 158] or the process manufacturing cockpit [Page 406]. You can change these default values.
Features You can enter a default value as follows in the process instruction:
•
•
You can define constant default values as follows:
• As a numerical value The data type of the characteristic that you want to request must then also be numerical.
•
• As message characteristics
If you use a message characteristic to define constant default values, you can proceed as follows:
•
•
As a constant value if it has already been specified in the process order or the cockpit definition
As a variable if it is only available in the PI sheet or cockpit
As an alphanumerical value
You can enter the required default value manually.
You can let the system assign the default value automatically. However, you can only use this option, if the settings required for automatic value assignment are made for the message characteristic in Customizing; see Process Instructions: Automatic Characteristic Value Assignment [Page 124].
Message category PI_PROD is assigned to a process data request. The following characteristics have been maintained in the process instruction for the input value Product quantity.
Number Characteristics Value
0070 PPPI_INPUT_REQUEST Product quantity:
0080 PPPI_MATERIAL_PRODUCED
0090 PPPI_REQUESTED_VALUE PPPI_MATERIAL_PRODUCED
Characteristic PPPI_MATERIAL_PRODUCED is defined as an input value in number 0090. In number 0080, this characteristic is used to define a constant default value for the input value. Since the planned order quantity is automatically assigned as the characteristic value, the planned value is proposed in the PI sheet.
April 2001 427
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Default Values
You define variables as default values if you want to transfer the default value from another process instruction of the same process order or cockpit.
Activities You define constant default values in the process instruction by assigning one of the following characteristics after characteristic PPPI_INPUT_REQUEST:
Characteristic Meaning Value
< PPPI_DEFAULT_VALUE or < PPPI_DEFAULT_STRING or < <Any message characteristic>
< Numerical default value < Alphanumerical default value < Any message characteristic
< Numerical value < Alphanumerical value < According to characteristic definition, may also be automatically
You define variable as the default value in the process instruction by assigning the following characteristic after characteristic PPPI_INPUT_REQUEST:
Characteristic Meaning Value
Variable name PPPI_DEFAULT_VARIABLE Variable as a default value
428 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Input Validations
Type 0: Definition of Input Validations Use When defining characteristics in Customizing, you can specify an allowed value range for each characteristic. The settings you make here apply to all process instructions and messages in which the characteristic is used.
If you want to restrict the value range even further for a specific input value, you can define an input validation for it in the process instruction. In the input validation, you determine:
Which validation rule is used to check the input value in the browser-based PI sheet [Page 158] or process manufacturing cockpit [Page 406]
•
•
•
To create or display function modules, go to Customizing for Process Management and choose Process Instructions -> Define PI Categories for R/3 PI Sheet Using Characteristic Overview -> Assign Characteristics to Dynamic Function Calls ->
Whether invalid values are transferred to the PI sheet or cockpit and how this is done
Prerequisites The following requirements must be met for both PI sheets and cockpits:
If you want to use a check function to check the input value, a suitable function module must have been created in the system.
Create Function Modules for Dynamic Function Calls [Ext.].
•
−
−
The following requirements must only be met for PI sheets: If a signature must be entered to accept invalid input values in the PI sheet, you must specify in Customizing for Control Recipe Destinations which type of signature you want to use in the PI sheet. You have the following options:
Signature without a password check
Digital signature [Ext.]
If several individual signatures are to be executed, you also specify the signature strategy [Ext.] in the control recipe destination.
For more information about digital signatures and the required settings, see Approval Using Digital Signatures [Ext.].
The following requirements must only be met for cockpits: •
•
You can define Signatures without a password check in cockpits. Digital signatures may not be used.
Activities Validation Rule In the process instruction, you can define the validation rule for the input validation as follows:
As a check formula for numeric values
Characteristic Meaning Value
April 2001 429
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Input Validations
PPPI_VALIDATION_FORMULA Check formula (max. 8 times) Boolean formula(see Syntax of check formulas [Page 432])
As a check function for all values •
Characteristic Meaning Value
PPPI_VALIDATION_FUNCTION Check function Function module name
You must include the parameters of the function module in the process instruction directly after the characteristic for the check function. For more information, see Type 0: Definition of Export Parameters [Page 449].
Processing Invalid Input Values In addition to the validation rule, you can also enter the following information to control how invalid input values are processed:
•
• Accept invalid values If you do not specify anything here, invalid values can be accepted without restrictions. You can define the following restrictions:
•
Warning If you enter an invalid value in the PI sheet, the system issues this warning in addition to the standard message.
− Invalid values are not accepted
− Invalid values are only accepted with a signature
Depending on the settings made in the control recipe destination, the PI sheet requests a signature without a password, one digital signature, or several individual signatures defined in a signature strategy. In cockpits, you may only use signatures without a password. You must also enter a comment for digital signatures.
The input value is not reported automatically when the signature is executed. Once you have entered a correct value again, the system automatically accepts this value, which means you do not need to execute another signature.
Authorization to execute the signature For signatures without a password check or for digital signatures, you can specify that a user requires a special maintenance authorization for the PI sheet to execute the signature.
The system then checks if the activity specified in the process instruction has been included in authorization object C_CRPI_BER in the user master record.
Irrespective of the settings you make here, the system checks the following authorizations for digital signatures:
• Activity 73 (Archive) in authorization object C_CRPI_BER (PI sheet)
430 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Input Validations
•
• Signature strategy for digital signatures in PI sheets You can define a
For individual signatures in a signature strategy, the authorization group for the individual signature in authorization object C_SIGN_BGR (authorization groups for digital signatures)
signature strategy [Ext.] for digital signatures in PI sheets. This ensures that invalid values must be signed by several people. In the signature strategy, you specify which individual signatures are required. You can assign a signature strategy in the control recipe destination. This strategy is then used for all input validations. If you want to use a different strategy for a particular process instruction, you assign the strategy to this process instruction. The signature strategy must be carried out synchronously in the PI sheet. This means that the individual signatures must be executed immediately one after another.
Value
Activities To enter this data in the process instruction, you assign the following characteristics immediately after the validation rule:
Characteristic Meaning
PPPI_TEXT_FOR_INVALID_INPUT Warning Long text (see also Using Text Symbols [Page 312])
PPPI_ACCEPT_INVALID_INPUT Invalid values are accepted
No Yes With signature only
PPPI_SIGNATURE_AUTHORIZATION Authorization required for signature without a password or digital signature
Any value for the Activity field in the authorization object C_CRPI_BER
In PI sheets only: PPPI_SIGNATURE_STRATEGY (See also Process Instructions for Process Manufacturing Cockpits [Page
])
Signature strategy (for digital signatures only)
Strategy defined in Customizing
416
April 2001 431
Process Management (PP-PI-PMA) SAP AG
Check Formula Syntax for Input Validations
Check Formula Syntax for Input Validations Check formulas in input validation must have the following syntax:
<relational expression><logical operator><relational expression>
<rel.expression> = <arith.expression><rel.operator><arith.expression>
Note the following:
•
•
•
•
•
−
You can use the operators listed below.
You can enter any number of logical relationships in a check formula.
In relational expressions, you can use variable X for the input value.
You must always use the decimal point for decimal numbers.
You can use variables to transfer numeric values of preceding process instructions to the check formula. For more detailed information see:
Using Variables in Browser-Based PI Sheets [Page 306]
− Using Variables in ABAP List-Based PI Sheets [Page 304]
In long formulas, you may use no more than 240 characters that can be separated in any number of lines.
•
Note that a blank character is automatically set at the end of each line. For this reason, make sure to write long number, variable names, or operators together in one line.
PPPI_VALIDATION_FORMULA x>50 AND x<100 OR PPPI_VALIDATION_FORMULA x<200 AND x>150
Logical Operators Meaning
AND Both of the linked expressions have to be true.
OR One of the linked expressions has to be true.
NOT The expressions following the operator must not be true.
Relational Operators Meaning
= Equal to
<= Less than or equal to
>= Greater than or equal to
432 April 2001
SAP AG Process Management (PP-PI-PMA)
Check Formula Syntax for Input Validations
<> Not equal to
>< Not equal to
< Less than
> Greater than
Arithmet. Operators Meaning
+ Plus
- Minus
* Multiplied by
/ Divided by
DIV Modulo division; division where the result is quoted as an integer
MOD Remainder after modulo division
ABS Absolute value
SIN Sine
COS Cosine
TAN Tangent
LOG Logarithm to base e
** To the power of
EXP Power to base e
SQRT Square root
ROUND Round to nearest integer
TRUNC Cut off decimals
April 2001 433
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Export Parameters
Type 0: Definition of Export Parameters Use
Note that by export parameter we mean the export parameters of the PI sheet or cockpit (PPPI_EXPORT_PARAMETER), which are the values that are transferred from the PI sheet or cockpit to the function module. From the function module's point of view, they are import parameters.
You define export parameters (import parameters of the function module) in dynamic function calls and input validations that are carried out using a check function.
Prerequisites If you want to pass on the value of a variable to the function module, the variable must be defined in the same PI sheet or in the same cockpit. For PI sheets, the variable may also have been defined for the entire process order.
For more information on how to use system variables and variables in general, see:
Using Variables in Browser-Based PI Sheets and Cockpits [Page 306] •
Using System Variables in Browser-Based PI Sheets [Page 309] •
Activities When defining export parameters, you specify the following information in the process instruction:
All required import parameters of the function module; Import parameters are required if the Optional indicator has not been set. They must be specified in the process instruction.
•
•
•
Optional import parameters of the function module for which you do not want to use the default value defined in the function module; Import parameters are optional if the Optional indicator has been set. They need not be specified in the process instruction.
If required, the characteristic optional parameter transfer for optional parameters whose value you do not want to pass on when the function call is executed; See also Type 0: Optional Parameter Transfer [Page 454].
The parameter name for each parameter to be passed on •
•
•
The variable, constant, or message characteristic for each parameter value to be passed on You can only pass on the value of a variable or constant to a parameter if the variable or constant has the same data type as the parameter in the function module.
Notes on Parameter Value Assignment
If the value is available in the process order, you enter it as a fixed value in the form of:
− A constant The characteristic you use to define the constant also determines the constant's data type.
434 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Export Parameters
− A message characteristic If you want to use a message characteristic, the characteristic must have the same data type as the parameter in the function module. You may want to use a message characteristic if the characteristic value is assigned in the order.
If the value is only available in the PI sheet, you transfer it from a preceding process instruction using a variable. The variable has the same data type as the value to which it refers. In the process instruction, you must assign the variable to the appropriate characteristic depending on the data type.
•
• In input validations, you use variable SY_VALUE or X to transfer the input value to be checked. The variable always refers to the value entered immediately before.
To enter this information, you assign the following characteristics to the process instruction in the order specified below:
Characteristic Meaning Allowed Values
PPPI_EXPORT_PARAMETER Export parameters Import parameters of the function module
< PPPI_STRING_CONSTANT or < PPPI_FLOAT_CONSTANT or < PPPI_DATE_CONSTANT or < PPPI_TIME_CONSTANT or
< PPPI_STRING_VARIABLE or < PPPI_FLOAT_VARIABLE or < PPPI_DATE_VARIABLE or < PPPI_TIME_VARIABLE or
< <Message characteristic>
Value transfer in constant:
< Alphanumerical value < Floating point number < Date < Time
Value transfer in variable: < Alphanumerical value < Floating point number < Date < Time
For value assignment using message characteristic: < Message characteristic
Any fixed value of data type:
< Alphanumerical value < Floating point number < Date < Time
Existing variable of data type: < Alphanumerical value < Floating point number < Date < Time
<Any message characteristic
PPPI_OPTIONAL_PARAMETER
Optional parameter transfer <Parameter transfer not optional <Parameter transfer optional
April 2001 435
Process Management (PP-PI-PMA) SAP AG
Type 0: Optional Parameter Transfer
Type 0: Optional Parameter Transfer Use You can assign characteristic PPPI_OPTIONAL_PARAMETER to parameters in dynamic function calls and input validations. As a result the parameter is not passed on to the function module unless a value has been assigned to it. The function module can be executed although the parameter value is missing.
Note the following: You may use characteristic PPPI_OPTIONAL_PARAMETER for optional parameters only. All required parameters must be specified in the process instructions and values must be assigned.
Activities If you want to call the function module even if no value has been assigned to a parameter, add characteristic PPPI_OPTIONAL_PARAMETER directly after the variable or constant for the parameter of the function module.
You assign the following characteristics in the process instruction in the sequence specified below:
Characteristic Meaning Allowed Values
<Parameter characteristic> Parameter of the function module
Optional import or changing parameter of the function module
Characteristic for the variable/constant that has the same data type as the parameter
Variable for the parameter value
New variable or constant
PPPI_OPTIONAL_PARAMETER Optional parameter transfer Optional parameter transfer
436 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Output Fields for Characteristic Values
Type 0: Definition of Output Fields for Characteristic Values Use You can use this function in the browser-based PI sheet [Page 158] or process manufacturing cockpit [Page 406] to display characteristic values that are usually processed in the background (such as planned values for input values).
Features You can display the following characteristic values in a PI sheet:
Values of message characteristics that have been assigned in the process instruction •
•
•
•
The date and time that is assigned automatically as the characteristic value of PPPI-EVENT_DATE and PPPI_EVENT_TIME in the PI sheet or cockpit
Planned values for input values, provided that the planned values have been defined as default values in the process instruction
Long texts with control information and notes that are used as values of long text characteristics such as PPPI_INSTRUCTION and PPPI_NOTE
Unlike Type 1: process parameter, you must explicitly specify that characteristics PPPI_INSTRUCTION and PPPI_NOTE are characteristics to be output in process instructions of type 0.
In addition to the characteristic value to be displayed, you also specify a text in the process instruction. In the PI sheet or cockpit, this text is processed as follows:
In simple data requests, the text is displayed before the output value. •
• In repeated data requests, you must define a text for every output value. The text is displayed above the relevant table column.
Activities In the process instruction, you define a characteristic value after the input value after which you want to display it in the PI sheet or cockpit. To do so, you assign the following characteristics to the process instruction:
Characteristic Meaning Allowed Values
PPPI_OUTPUT_TEXT Text that is displayed before the output values to follow
Any short text
PPPI_OUTPUT_CHARACTERISTIC
Characteristic whose value is displayed in the PI sheet or cockpit
Message characteristic to be displayed
April 2001 437
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Output Fields for Characteristic Values
In the case of text characteristics (such as PPPI_OUTPUT_TEXT), you can insert the value of another characteristic into this text using a text symbol; see Text Symbols in Characteristic Texts [Page 312].
438 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Output Fields for Variable Values
Type 0: Definition of Output Fields for Variable Values Use You can use this function in the browser-based PI sheet [Page 158] or in the process manufacturing cockpit [Page 406] to display values defined as variables that are usually processed in the background (such as variable values from calculation formulas).
Prerequisites You can display the value of a variable in the process instruction if the variable has been defined as follows::
In one of the preceding process instructions •
•
•
In the same process instruction
In one of the succeeding process instructions
For more information, see Using Variables in Browser-Based PI Sheets and Cockpits [Page 306].
Activities In the process instruction, you define a variable value after the input value after which you want to display it in the PI sheet or cockpit. To do so, you assign the following characteristics to the process instruction:
Characteristic Meaning Allowed Values
PPPI_OUTPUT_TEXT Text displayed before the output values to follow Any short text
PPPI_OUTPUT_VARIABLE Variable whose value is to be displayed Variable name
April 2001 439
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Calculations
Type 0: Definition of Calculations
Use You can use this function to perform calculations in the browser-based PI sheet [Page 158] or process manufacturing cockpit [Page 406]. You can, for example, calculate the total quantity of a material consumed in all phases. You can then use a process message to report the calculated value. You can define a variable to pass on the calculated values to a function module, for example.
Activities When defining calculations, you specify the following information in the process instruction:
A text to be displayed before the calculated value in the PI sheet or cockpit •
•
•
•
If required, a variable that refers to the characteristic to be calculated
The message characteristic whose value you want to calculate
The calculation formula to be used to calculate the value
To enter this information, you assign the following characteristics to the process instruction in the order specified below:
Characteristic Meaning Allowed Values
PPPI_INPUT_REQUEST Text displayed before the formula result
Any short text
< PPPI_VARIABLE In PI sheets only: < PPPI_GLOBAL_VARIABLE
Variable definition for value calculated:< Variable < Global variable
New variable name see: Definition of Variables [Page 302]
PPPI_CALCULATED_VALUE Message characteristic to be calculated
Message characteristic
PPPI_CALCULATION_FORMULA
Calculation formula Arithmetic expression; see: Syntax [Page 442]
In the case of text characteristics (such as PPPI_INPUT_REQUEST), you can insert the value of another characteristic into this text using a text symbol; see Text Symbols in Characteristic Texts [Page 312].
440 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Calculations
April 2001 441
Process Management (PP-PI-PMA) SAP AG
Syntax in Process Data Calculation Formulas
Syntax in Process Data Calculation Formulas When defining your formula, note the following:
Always use the decimal point for decimal numbers. •
• You can use variables to transfer numeric values of preceding process instructions to the formula. For more information, see Use of Variables in Process Instructions [Page 304].
• In long formulas, you may use no more than 240 characters that can be separated in any number of lines.
Note that a blank character is automatically set at the end of each line. For this reason, make sure to write long number, variable names, or operators together in one line.
PPPI_CALCULATION_FORMULA (-B+SQRT(B**2- PPPI_CALCULATION_FORMULA (4*A*C)))/(2*A)
Arithmet. Operators Meaning
+ Plus
- Minus
* Multiplied by
/ Divided by
DIV Modulo division; division where the result is quoted as an integer
MOD Remainder after modulo division
ABS Absolute value
SIN Sine
COS Cosine
TAN Tangent
LOG Logarithm to base e
** To the power of
EXP Power to base e
SQRT Square root
ROUND Round to nearest integer
TRUNC Cut off decimals
442 April 2001
SAP AG Process Management (PP-PI-PMA)
Syntax in Process Data Calculation Formulas
April 2001 443
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Automatic Value Assignment
Type 0: Definition of Automatic Value Assignment Use You can use this function to determine the point of time (date and time) at which a process instruction was processed in the browser-based PI sheet [Page 158] or in the process manufacturing cockpit [Page 406]. In a process instruction, you can automatically assign a value to the date and time once for each message category block.
Features You can automatically assign the date or time as values to the following standard characteristics:
PPPI_EVENT_DATE: date of the event •
•
•
PPPI_EVENT_TIME: time of the event
The system determines the date and time when you maintain the process instruction in the PI sheet.
Activities When defining automatic value assignment, you specify the following information in the process instruction:
A variable that refers to the characteristic whose value is to be assigned automatically if you want to use the date and time in another process instruction of the same process order
Note that you may use global variables in PI sheets only.
The message characteristic whose value is to be assigned automatically •
• The characteristic PPPI_OUTPUT_CHARACTERISTIC that you can use to display the date and time in the PI sheet
You can also mark the date and time as input values. The system then proposes the current date and time in the possible entries. Unlike automatic value assignment, however, you can still change the value.
To enter this information, you assign the following characteristics to the process instruction in the order specified below:
Characteristic Meaning Value
Variable definition for the characteristic whose value is to be assigned automatically < PPPI_VARIABLE In PI sheets only: < PPPI_GLOBAL_VARIABLE
Variable Global variable
New variable name New variable name
444 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Automatic Value Assignment
PPPI_AUTOMATIC_VALUE Message characteristic whose value is to be assigned automatically
PPPI_EVENT_DATE PPPI_EVENT_TIME
PPPI_OUTPUT_CHARACTERISTIC
Characteristic to be output
PPPI_EVENT_DATE PPPI_EVENT_TIME
April 2001 445
Process Management (PP-PI-PMA) SAP AG
Type: Definition of Value Assignment Using Variables
Type: Definition of Value Assignment Using Variables Use You can use this function to transfer the value of a message characteristic that has been defined as a variable from one process instruction to another process instruction. In this way, you ensure that the current value is always passed on to the other process instruction in message characteristics whose values can constantly be changed (for example, by entries).
In this case, the variable value is not displayed as a default value, which means that you cannot change it in the browser-based PI sheet [Page 158] or process manufacturing cockpit [Page
]. 406
Activities When defining value assignment using variables, you specify the following information in the process instruction:
The variable to be assigned to the message characteristic •
• The message characteristic whose value is to be obtained from a variable
To enter this information, you assign the following characteristics to the process instruction in the order specified below:
Characteristic Meaning Allowed Values
PPPI_DEFAULT_VARIABLE
Variable to be assigned to the message characteristic
Variable name, see Using Variables in Browser-Based PI Sheets and Cockpits [Page 306]
PPPI_EXTERNAL_VALUE Message characteristic whose value is to be assigned using variable
Message characteristic
446 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Dynamic Function Calls
Type 0: Definition of Dynamic Function Calls Use You can use this function to call certain R/3 functions from within the PI sheet or perform certain calculations and checks in the PI sheet. ABAP function calls that have been created for the corresponding use are used for the function call.
Prerequisites The function module to be called must exist and be active in the Function Builder (ABAP Development Workbench).
Features The standard system contains a number of predefined function modules that you can use in function calls. You can also create your own function modules.
To create or display function modules, go to Customizing for Process Management and choose Process Instructions -> Define PI Categories for R/3 PI Sheet Using Characteristic Overview -> Assign Characteristics to Dynamic Function Calls -> Create Function Modules for Dynamic Function Calls [Ext.].
The following table provides an overview of the function modules that you can define as dynamic function calls:
Function Function Module
Calling of any transaction COPF_CALL_TRANSACTION
Order confirmation for phases COPF_ENTER_CONFIRMATION
Displaying of material quantity calculation in the order
COPF_MATERIAL_QUANTITY_CALC
Displaying of documents created in the R/3 document management system
COPF_DOCUMENT_SHOW_DIRECT
Calculating of the duration of time intervals COPF_DETERMINE_DURATION
Calculating of the start date of a time interval COPF_DETERMINE_START_TIME
Calculating of the end date of a time interval COPF_DETERMINE_END_TIME
Creating of physical-sample records for quality inspections during production
QPRS_PI_NEW_SAMPLE_DRAW
Processing of sample drawing (for example, release/lock physical sample)
QPRS_PI_SAMPLE_DRAW_PROCESSING
Recording of inspection results in QM COPFX_QM_INSPECTION_RESULT_REC
Sample function module for check function COPF_VALIDATION_FUNCTION_TEST
Activities When defining dynamic function calls, you specify the following information in the process instruction:
April 2001 447
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Dynamic Function Calls
The name of the function module you want to call •
•
•
•
Any short text to be displayed on the pushbutton
The characteristic that specifies whether the function can be called when the PI sheet is displayed
The parameters defined in the function module
To enter this information, you assign the following characteristics to the process instruction in the order specified below:
Characteristic Meaning Value
PPPI_FUNCTION_NAME Name of a function module Name of the function module you want to call
PPPI_BUTTON_TEXT Text for pushbutton Any short text
PPPI_FUNCTION_DURING_ DISPLAY
Specifies whether the function can be called when the PI sheet is displayed
"0" = not allowed "1" = allowed
< <Export parameters> < <Changing parameters> < <Import parameters>
Parameters according to definition in function module: < Export parameters < Changing parameters < Import parameters
Parameters of the function module < Import parameters < Changing parameters < Export parameters
For more information on how to define the parameters of the function module in the process instruction, see:
Type 0: Definition of Export Parameters [Page 449] •
Type 0: Definition of Changing Parameters [Page 451] •
Type 0: Definition of Import Parameters [Page 452] •
448 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Export Parameters
Type 0: Definition of Export Parameters Use
Note that by export parameter we mean the export parameters of the PI sheet or cockpit (PPPI_EXPORT_PARAMETER), which are the values that are transferred from the PI sheet or cockpit to the function module. From the function module's point of view, they are import parameters.
You define export parameters (import parameters of the function module) in dynamic function calls and input validations that are carried out using a check function.
Prerequisites If you want to pass on the value of a variable to the function module, the variable must be defined in the same PI sheet or in the same cockpit. For PI sheets, the variable may also have been defined for the entire process order.
For more information on how to use system variables and variables in general, see:
Using Variables in Browser-Based PI Sheets and Cockpits [Page 306] •
Using System Variables in Browser-Based PI Sheets [Page 309] •
Activities When defining export parameters, you specify the following information in the process instruction:
All required import parameters of the function module; Import parameters are required if the Optional indicator has not been set. They must be specified in the process instruction.
•
•
•
Optional import parameters of the function module for which you do not want to use the default value defined in the function module; Import parameters are optional if the Optional indicator has been set. They need not be specified in the process instruction.
If required, the characteristic optional parameter transfer for optional parameters whose value you do not want to pass on when the function call is executed; See also Type 0: Optional Parameter Transfer [Page 454].
The parameter name for each parameter to be passed on •
•
•
The variable, constant, or message characteristic for each parameter value to be passed on You can only pass on the value of a variable or constant to a parameter if the variable or constant has the same data type as the parameter in the function module.
Notes on Parameter Value Assignment
If the value is available in the process order, you enter it as a fixed value in the form of:
− A constant The characteristic you use to define the constant also determines the constant's data type.
April 2001 449
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Export Parameters
− A message characteristic If you want to use a message characteristic, the characteristic must have the same data type as the parameter in the function module. You may want to use a message characteristic if the characteristic value is assigned in the order.
If the value is only available in the PI sheet, you transfer it from a preceding process instruction using a variable. The variable has the same data type as the value to which it refers. In the process instruction, you must assign the variable to the appropriate characteristic depending on the data type.
•
• In input validations, you use variable SY_VALUE or X to transfer the input value to be checked. The variable always refers to the value entered immediately before.
To enter this information, you assign the following characteristics to the process instruction in the order specified below:
Characteristic Meaning Allowed Values
PPPI_EXPORT_PARAMETER Export parameters Import parameters of the function module
< PPPI_STRING_CONSTANT or < PPPI_FLOAT_CONSTANT or < PPPI_DATE_CONSTANT or < PPPI_TIME_CONSTANT or
< PPPI_STRING_VARIABLE or < PPPI_FLOAT_VARIABLE or < PPPI_DATE_VARIABLE or < PPPI_TIME_VARIABLE or
< <Message characteristic>
Value transfer in constant:
< Alphanumerical value < Floating point number < Date < Time
Value transfer in variable: < Alphanumerical value < Floating point number < Date < Time
For value assignment using message characteristic: < Message characteristic
Any fixed value of data type:
< Alphanumerical value < Floating point number < Date < Time
Existing variable of data type: < Alphanumerical value < Floating point number < Date < Time
<Any message characteristic
PPPI_OPTIONAL_PARAMETER
Optional parameter transfer <Parameter transfer not optional <Parameter transfer optional
450 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Changing Parameters
Type 0: Definition of Changing Parameters Use You define changing parameters in dynamic function calls. To the changing parameter, you assign the variable whose value you want to transfer from the PI sheet or the process manufacturing cockpit to the function module. After the function has been executed, the parameter value is returned to this variable and transferred to the PI sheet or cockpit.
You can display the variable in the PI sheet or cockpit. You can use the variable to transfer the value to succeeding process instructions of the same PI sheet or the same cockpit. However, note the following:
The function can be carried out more than once in the PI sheet. •
•
•
The function may change the parameter value.
Prerequisites If you want to pass on the value of a variable to the function module or transfer it from the function module to the PI sheet or cockpit, the variable must be defined in the same PI sheet or cockpit. With PI sheets, the variable may also have been defined or for the entire process order.
For more information on how to use system variables and variables in general, see:
Using Variables in Browser-Based PI Sheets and Cockpits [Page 30 ]6
Using System Variables in Browser-Based PI Sheets [Page 309] •
Activities When defining changing parameters, you specify the following information in the process instruction:
All required changing parameters of the function module; Changing parameters are required if the Optional indicator has not been set. They must be specified in the process instruction.
•
•
•
Optional changing parameters of the function module for which you do not want to use the default value defined in the function module; Changing parameters are optional if the Optional indicator has been set.
If required, the characteristic optional parameter transfer for optional parameters whose value you do not want to pass on when the function call is executed; See also Type 0: Optional Parameter Transfer [Page 454].
The parameter name for each parameter to be passed on •
• The variable for each parameter value to be passed on; You can only pass on the value of a variable to a parameter if it has the same data type as the parameter in the function module.
To enter this information, you assign the following characteristics to the process instruction in the order specified below:
Characteristic Meaning Allowed Values
April 2001 451
Process Management (PP-PI-PMA) SAP AG
Type 0: Definition of Import Parameters
PPPI_CHANGING_PARAMETER
Changing parameters Changing parameters of the function module
< PPPI_STRING_VARIABLE or < PPPI_FLOAT_VARIABLE or < PPPI_DATE_VARIABLE or < PPPI_TIME_VARIABLE
Value transfer in variable: < Alphanumerical value < Floating point number < Date < Time
Variable of data type: < Alphanumerical value < Floating point number < Date < Time
PPPI_OPTIONAL_PARAMETER Optional parameter transfer <Parameter transfer not optional <Parameter transfer optional
If you want to display the variable value in the PI sheet or cockpit, you must define an output field. For more information, see Type 0: Definition of Output Fields for Variable Values [Page 439] .
Type 0: Definition of Import Parameters Use
Note that by import parameters we mean the import parameters of the PI sheet or cockpit (PPPI_IMPORT_PARAMETER), this means, the values that are transferred from the function module to the PI sheet or cockpit. From the function module's point of view, they are export parameters.
You define import parameters (export parameters of the function module) in dynamic function calls. To the import parameter, you assign the variable whose value you want to transfer from the function module to the PI sheet or cockpit.
You can display the variable in the PI sheet or cockpit. You can also use the variable to transfer the value to succeeding process instructions of the same PI sheet or cockpit. Note, however, that the function may be carried out more than once in the course of PI sheet or cockpit maintenance.
Prerequisites If you want to transfer the value of a variable from the function module to the PI sheet or cockpit, the variable must be defined in the same PI sheet or cockpit. With PI sheets, the variable may also have been defined for the entire process order.
For more information on how to use system variables and variables in general, see:
Using Variables in Browser-Based PI Sheets and Cockpits [Page 306] •
Using System Variables in Browser-Based PI Sheets [Page 309] •
452 April 2001
SAP AG Process Management (PP-PI-PMA)
Type 0: Definition of Import Parameters
Activities When defining import parameters, you specify the following information in the process instruction:
•
• If required, the characteristic optional parameter transfer for optional parameters whose value you do not want to pass on when the function call is executed; See also Type 0: Optional Parameter Transfer [Page
The export parameters of the function module
454].
•
•
The parameter name for each parameter to be passed on
The variable for each parameter value to be passed on; You can only pass on the value of a variable to a parameter if it has the same data type as the parameter in the function module.
To enter this information, you assign the following characteristics to the process instruction in the order specified below:
Characteristic Meaning Allowed Values
PPPI_IMPORT_PARAMETER Import parameters Export parameters of the function module
< PPPI_STRING_VARIABLE or < PPPI_FLOAT_VARIABLE or < PPPI_DATE_VARIABLE or < PPPI_TIME_VARIABLE
Value transfer in variable:< Alphanumerical value < Floating point number < Date < Time
Variable of data type: < Alphanumerical value < Floating point number < Date < Time
PPPI_OPTIONAL_PARAMETER
Optional parameter transfer
<Parameter transfer not optional <Parameter transfer optional
If you want to display the variable value in the PI sheet or cockpit, you must define an output field. For more information, see Type 0: Definition of Output Fields for Variable Values [Page 439].
April 2001 453
Process Management (PP-PI-PMA) SAP AG
Type 0: Optional Parameter Transfer
Type 0: Optional Parameter Transfer Use You can assign characteristic PPPI_OPTIONAL_PARAMETER to parameters in dynamic function calls and input validations. As a result the parameter is not passed on to the function module unless a value has been assigned to it. The function module can be executed although the parameter value is missing.
Note the following: You may use characteristic PPPI_OPTIONAL_PARAMETER for optional parameters only. All required parameters must be specified in the process instructions and values must be assigned.
Activities If you want to call the function module even if no value has been assigned to a parameter, add characteristic PPPI_OPTIONAL_PARAMETER directly after the variable or constant for the parameter of the function module.
You assign the following characteristics in the process instruction in the sequence specified below:
Characteristic Meaning Allowed Values
<Parameter characteristic> Parameter of the function module
Optional import or changing parameter of the function module
Characteristic for the variable/constant that has the same data type as the parameter
Variable for the parameter value
New variable or constant
PPPI_OPTIONAL_PARAMETER Optional parameter transfer Optional parameter transfer
454 April 2001
SAP AG Process Management (PP-PI-PMA)
Setting Up the Browser for PI Sheets and Cockpits
Setting Up the Browser for PI Sheets and Cockpits Use For the system to be able to best display browser-based PI sheets [Page 158] and process manufacturing cockpits [Page 40 ]6 , we recommend installing Microsoft Internet Explorer 5.0 or higher. In addition, we recommend making the security settings described below in your Internet Explorer.
Procedure 6. In the Internet Explorer menu, choose Tools -> Internet Options.
7. Choose the Security tab page.
8. Choose the Web content zone Internet.
9. Choose Custom Level ...
10. Make the following settings in the Security Settings dialog box.
Function Settings
Download signed ActiveX controls Enable or prompt
Launching programs and files in an IFRAME Enable
Navigate sub-frames across different domains Enable
Note the following:
• All browser settings you make in your Internet Explorer automatically take effect in the browser-based PI sheet and process manufacturing cockpit, too.
• Certain commonly used keyboard functions, such as F4, may have a different result or may not be available at all in the browser-based PI sheet and cockpit.
April 2001 455
Process Management (PP-PI-PMA) SAP AG
Defining and Starting Process Manufacturing Cockpits
Defining and Starting Process Manufacturing Cockpits Procedure 1. Go to Customizing and call up activity Production Planning for Process Industries -> Process
Management -> Define Process Manufacturing Cockpits [Ext.].
2. Create a new cockpit.
3. Assign process instruction categories to the cockpit. If you want to change the layout of the cockpit, you must enter a layout definition (characteristic PPPI_LAYOUT).
For more information, see Layout Definition for PI Sheets and Cockpits [Page 457].
4. Assign characteristics to the process instructions.
5. Check the cockpit after you have made all settings.
6. Simulate the cockpit if it does not contain any errors.
7. Activate the cockpit.
8. To start the cockpit, go to the Process Management menu and choose Process Manufacturing Cockpit -> Start.
9. Enter the cockpit name and the corresponding plant and choose Start.
456 April 2001
SAP AG Process Management (PP-PI-PMA)
Layout Definition for PI Sheets and Cockpits
Layout Definition for PI Sheets and Cockpits Purpose You can define the layout for browser-based PI sheets and process 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 process 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 [Page 457]
The XSL file and all files to which you refer in the XSL file have been stored in the Business Document Service of the R/3 System. See: Managing of Documents for Layout Definitions [Page 496]
•
Process Flow To change the standard layout or replace it with a different layout, you proceed as follows:
1. 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 [Ext.]
− For cockpits:
• In Customizing for Cockpit Definitions, you can define PPPI_LAYOUT in the first process instruction (of type 0).
2. 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:
<?xml version="1.0"?>
− The XML definition must be start and end with the <LAYOUT> tag:
April 2001 457
Process Management (PP-PI-PMA) SAP AG
Layout Definition for PI Sheets and Cockpits
<LAYOUT> ... </LAYOUT>
− If you want to use your own XSL style sheet, you must specify the XSL file in the <LAYOUT>/<STYLE> tag.
<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.
<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.
<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.
<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. In the frameset definition, the PI sheet or cockpit itself must always be specified. You do so by using #DOCUMENT#.
<FRAME SRC="#DOCUMENT#"> </FRAME>
• To display another cockpit in a frame, you specify the corresponding cockpit name in the frame source.
458 April 2001
SAP AG Process Management (PP-PI-PMA)
Layout Definition for PI Sheets and Cockpits
The following URL convention must be adhered to: SAPR3-PIDOC-<plant>PI<cockpit name>
<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>
<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://...
<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.
Note the following:
• All tag names must be written in capital letters
• File names are case-sensitive
Example You will find an example for 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.
April 2001 459
Process Management (PP-PI-PMA) SAP AG
Layout Definition for PI Sheets and Cockpits
<?xml version="1.0"?>
<LAYOUT>
<STYLE>SAPR3-BDS-POC_TEMPLATE-OT-MYDOC-MYSTYLE.XSL</STYLE>
<ARCHIVE> <STYLE>SAPR3-BDS-POC_TEMPLATE-OT-MYDOC-MYSTYLE_A.XSL</STYLE> </ARCHIVE>
<HEADER> <PHASES>1</PHASES> </HEADER>
<FRAMESET ROWS="50%,50%"> <FRAME SRC="#DOCUMENT#"> </FRAME> <FRAME SRC="http://www.sap.com"> </FRAME> </FRAMESET>
</LAYOUT>
460 April 2001
SAP AG Process Management (PP-PI-PMA)
Definition of XSL Style Sheets for PI Sheets and Cockpits
Definition of XSL Style Sheets for PI Sheets and Cockpits Purpose You define XSL style sheets if you want to replace the standard layouts used for browser-based PI sheets and process manufacturing cockpits by your own layouts. You can use the following standard layouts as templates:
•
•
•
PMC_STY_C_DEFAULTX.XSL for process manufacturing cockpits
PMC_STY_DEFAULTX.XSL for PI sheets
PMC_STY_A_DEFAULTX.XSL for archiving PI sheets
Process Flow1. You can find the standard style sheets that you can use as templates in the Business
Document Service (BDS) in class POC_TEMPLATE under object key (or object ID) SAP. For information on the file names of all the files that you can use as templates when defining your own XSL style sheets, see Standard Files as Templates for Layout Definitions [Page
]. 483
You copy one of the XSL files that start with PMC_STY_*.XSL or create your own file.
2. You copy the dependent data:
− That you want to change
− That you want to add as a separate copy
3. You update the links to the files you reference in your XSL style sheet.
Note the URL conventions described in Managing of Documents for Layout Definitions [Page 496]. They vary depending on where the documents are stored (BDS or Web Repository).
4. You modify the files that you want to change.
Note the document type definition [Page 494] (DTD) that contains a description of the structure of generated XML files for cockpits and PI sheets. For examples of XML files, see class POC_PIDOC in the BDS.
5. The system creates XML documents for each control recipe that was sent or each cockpit that was activated. The XSL style sheet is used to convert the XML documents to an HTML document. The browser creates the HTML document at runtime and displays it directly. The HTML document must contain additional information that the runtime environment can use to identify R/3-active components [Page 46 ]8 .
Make sure that in your XSL style sheet you have correctly defined that this information is added.
The HTML document for PI sheet number 100000000000004711 must contain:
<META NAME="_bfw_document_" CONTENT="100000000000004711">
April 2001 461
Process Management (PP-PI-PMA) SAP AG
Definition of XSL Style Sheets for PI Sheets and Cockpits
Write the following in the XSL style sheet: <META NAME="_bfw_document_"> <xsl:attribute name="CONTENT"> <xsl:value-of select="/DOCUMENT/@id"/> <xsl:attribute> </META>
For a description of the additional information required, see Reference Information for the Definition of Style Sheets [Page 463] and the lower-level sections.
6. You link your style sheet to a process order, master recipe, cockpit definition, or process instruction category in Customizing.
Note the XML definition described in Layout Definition for PI Sheets and Cockpits [Page ] that you must define in the long text for characteristic PPPI_LAYOUT. 457
462 April 2001
SAP AG Process Management (PP-PI-PMA)
Reference Information for Defining Style Sheets
Reference Information for Defining Style Sheets This and the subordinate sections provide an overview of how you can use XSL style sheets and Cascading Style Sheets (CSS) to define your own layout for browser-based PI sheets [Page 406] and process manufacturing cockpits [Page 15 ]8 .
Two XML documents are created in the system for each control recipe to be sent or for each cockpit you have activated: one document for the layout definition and one document that contains the data from the control recipe. The latter of these files is converted to an HTML document directly in the browser using an XSL style sheet. The following files are used:
•
This file contains all the layout-relevant information from the control recipe or cockpit definition. This means it comprises all the information from the process instructions that are required to generate the layout. XML tags along with attributes, if available, are used to describe meta data, phases, process instructions, output and input fields (including long texts), calculation fields, function calls as well as requested signatures and digital signatures in the XML document.
•
The XML document The system automatically generates two XML documents when a control recipe is sent or when a cockpit is activated. These documents are stored in the Business Document Service.
− data.xml
− layout.xml
This file contains the layout definition that you have stored in the long text for characteristic PPPI_LAYOUT. If you have not specified a layout definition there, the system uses the relevant standard layout.
The Document Type Definition (DTD) The Document Type Definition [Ext.] determines rules on how the individual XML elements, attributes, and other data can be defined and represented in a logical relationship in an XML document. The XML documents generated in PP-PI follow a DTD that has been stored under the object ID "PMC_DTD_DATA.DTD" in the Web Repository.
The XSL Style Sheet •
An XSL style sheet for PI sheets or cockpits defines how the XML document (data.xml) is to be converted to an (X)HTML document before it is displayed. The conversion takes place directly in the browser (Internet Explorer version 5 or higher).
The XSL style sheets generally contain references to Cascading Style Sheets (CSS), images, and other files. These files are then integrated with the (X)HTML document when it is loaded. Files that are loaded from the R/3 System can never be accessed through the file system of the client server.
An XSL style sheet can be used for any number of PI sheets or cockpits with completely different contents.
If you do not define your own layout based on your own XSL style sheet or if you do not declare your own XSL style sheets correctly in the layout definition, the system automatically uses the standard style sheets shipped with PP-PI. The Business
April 2001 463
Process Management (PP-PI-PMA) SAP AG
Reference Information for Defining Style Sheets
Document Service contains the following copies of these standard style sheets that you can use as templates to develop your own solutions:
− "PMC_STY_C_DEFAULTX.XSL" for cockpits
− "PMC_STY_DEFAULTX.XSL" for PI sheets
− "PMC_STY_A_DEFAULTX.XSL" for archiving PI sheets
For more information on: How to manage the PI documents within the R/3 System, see Managing of Documents for Layout Definitions [Page 496]
•
The files that you can use as templates to define your own XSL style sheets, see Standard Files as Templates for Layout Definitions [Page 483]
•
How the DTD file "PMC_DTD_DATA.DTD" is structures, see Document Type Definition for Generated XML Documents [Page 494]
•
Communication Between the Browser and the R/3 System To make sure that the HTML document displayed at runtime supports all the functions of a PI sheet or cockpit and guarantee the communication with the R/3 System, you must define the XSL style sheet in such a way that certain types of information are correctly included in the HTML document.
The first step that ensures communication between the HTML document and the R/3 System is the integration of a JavaScript. In addition, there are elements in the HTML document (such as pushbuttons, input fields, and so on) that trigger certain transactions in the R/3 System and as a result change their statuses. This communication is initialized by using additional element IDs and attributes defined by SAP.
Note the following when defining style sheets:
There may be several, nested HTML documents for each PI sheet and cockpit. At runtime, the R/3 System must know which of these documents are the main documents of a PI sheet or manufacturing cockpit. The logical document is initialized by means of the document ID, that is identical to the PI sheet number or cockpit name.
•
For more information, see Reference Information: Definition and Initialization of Logical Documents [Page 466].
PI sheets and cockpits contain different elements that communicate with the R/3 System (for example, input fields, pushbuttons, and so on). An adequate HTML component must be created for each of these elements in the HTML document. In the XSL style sheet, you must also take into account that the runtime environment in the HTML document expects additional information for each component.
•
For more information, see Reference Information: Definition of R/3-Active Components [Page 466].
The context menus of PI sheets and cockpits contain functions that refer to the entire document or individual fields within the document. You can use the XSL style sheet to determine which menu functions should also be available as commands (pushbuttons).
•
For more information, see Reference Information: Definition of Commands [Page 481].
You can define hyperlinks that refer to documents in the R/3 System (such as work instructions) in PI sheets and cockpits. In the XSL style sheet, you can define that these
•
464 April 2001
SAP AG Process Management (PP-PI-PMA)
Reference Information for Defining Style Sheets
documents are only provided by the R/3 System when they are actually called and not before. Otherwise, all R/3 documents belonging to a PI document are loaded directly when the PI sheet or cockpit is loaded.
For more information, see Reference Information: Definition of Hyperlinks to Files in the R/3 System [Page 482].
Some texts in PI sheets and cockpits must be made available in several different languages (for example, menu functions). This means that when you log on to the SAP System in a different language, these texts must come up in the correct language. In the XSL style sheet, you can use text symbols that you have created in an ABAP program for these multilingual texts. These text symbols can then be translated using the R/3 translation tools.
•
For more information, see Reference Information: Using Text Symbols [Page 483].
April 2001 465
Process Management (PP-PI-PMA) SAP AG
Reference Information: Definition and Initialization of Logical Documents
Reference Information: Definition and Initialization of Logical Documents Runtime Environment To initialize communication between the HTML document and the R/3 System, the document must be registered at runtime. You can do so by including the following JavaScript in the header tag of the HTML document:
<SCRIPT LANGUAGE=“JavaScript“ SRC=“SAPR3-WR-BFW_INC_TOP.JS“></SCRIPT>
The runtime environment automatically reserves the following JavaScript event handlers. You cannot use these events for your own functions.
Object Event
window onload, onunload
window.document onhelp, oncontextmenu, onkeypress, onclick
Initializing the Logical Document Each PI sheet and cockpit can consist of a hierarchical nesting of several HTML documents. In addition, a PI sheet can call up one or more cockpits, which in turn can use several other cockpits and thus HTML documents. At runtime, the R/3 System must know which of these HTML documents it is to use as main documents and with which logical document they correspond.
A logical document is identified by the following attributes in the META tag of the HTML document:
NAME="_bfw_document_“ •
• CONTENT="value of the 'ID' attribute from the XML document"
The document ID is identical to the PI sheet number or cockpit name. The generated XML document provides this document ID as the attribute of the DOCUMENT tag. In the HTML document, the document ID must be declared by a META tag that must be written before the JavaScript include SAPR3-WR-BFW_INC_TOP.JS.
You could include the following statement for a META tag in the DOCUMENT tag in the XSL style sheet, for example:
Example for an XSL definition
XML Document XSL Document HTML Document
466 April 2001
SAP AG Process Management (PP-PI-PMA)
Reference Information: Definition and Initialization of Logical Documents
... <DOCUMENT id="10000000000004711"> .... </DOCUMENT> ...
... <META NAME=“_bfw_document_“> <xsl:attribute name=“CONTENT“> <xsl:value-of select=“/@id“/> </xsl:attribute></META>
<SCRIPT LANGUAGE=“JavaScript“ SRC=“SAPR3-WR-BFW_INC_TOP.JS“> </SCRIPT> ...
... <META NAME=“_bfw_document_“ CONTENT=“100000000000004711“>.
<SCRIPT LANGUAGE=“JavaScript“ SRC=“SAPR3-WR-BFW_INC_TOP.JS“></SCRIPT> ...
Explanation of the XSL definition:
• The NAME="_bfw_document_" attribute in the META tag specifies that the document with the document ID to be added is to be identified as the logical document.
• The <xsl:attribute name=“CONTENT“> tag specifies that an attribute with the name "CONTENT" is to be added to the META tag in the HTML document.
The <xsl:value-of select=“/@id“/> tag determines that the value of the "id" attribute is to be selected from the XML document and word for word inserted as the value of the "CONTENT" attribute in the HTML document
•
HTML documents that do not declare a logical document are assigned to the higher-level logical document. For this, the system performs a bottom-up search of the browser's frame hierarchy. You can use this mechanism, for example, to link further HTML documents with iFrames that may contain hyperlinks to files in the R/3 System [Page 482] or buttons for menu functions (see Reference Information: Definition of Commands [Page 481]). The runtime environment can only access HTML documents that are loaded from the R/3 System.
At runtime, the document ID must be unique for all loaded documents. The runtime environment guarantees that this requirement is met. If an error occurs, the system creates a message in the log. If the same document ID comes up more than once, only the first instance is initialized.
April 2001 467
Process Management (PP-PI-PMA) SAP AG
Reference Information: Definition of R/3-Active Components
Reference Information: Definition of R/3-Active Components Some elements in the HTML document (for example, pushbuttons, input fields etc.) trigger certain transactions in the R/3 System and as a result change their statuses as a reaction to certain events on the screen, such as clicking the mouse button or choosing a specific key.
To ensure communication with the R/3 System, the following requirements must be met:
Identifying R/3-active components •
These HTML components must be identified as R/3-active components in the R/3 System. Element IDs and attributes defined by SAP are used for this.
Any HTML tag ("grouping" tag) can be used to declare an R/3-active component. This tag must contain the following parts of the component as an attribute. Each attribute must then be assigned certain attribute values.
Attribute Attribute Value Explanation
Identification as HTML component
_BFW_TYPE_
"bfwInput" "bfwOutput" "bfwExecute" "bfwCalculation" "bfwSignature" "bfwTable"
Identification as: Input field Output field Function call Calculation field Input field for signatures and digital signatures Table
_BFW_KEY_ <Value of the ID attribute from XML document>
The value of the ID attribute for an XML element is to be inserted here. It is made up of the line numbers of the phase, process instruction, and characteristic as well as additional line numbers for generated process instructions. We do not recommend using this information for creating a function since any value can be transferred as the key.
_BFW_PARAMS_ (optional)
"paramName1:param Value1; paramName2:param Value2;..."
Can be used in tables to show the number of lines to be displayed, for example. Example for bfwTable: _BFW_PARAMS_="HBASE:20px;HLINE:20px;HMIN:100px:LINES:10;"
ID (HTML attribute)
"_bfw_component_"
We recommend making the following assignments between the elements defined in the XML document and the component classes of the runtime environment:
Element in the XML Document Component Class of the Runtime Environment
<INPUT ...>... bfwInput
468 April 2001
SAP AG Process Management (PP-PI-PMA)
Reference Information: Definition of R/3-Active Components
<OUTPUT ...>... bfwOutput
<EXECUTE ...>... bfwExecute
<CALCULATION ...>... bfwCalculation
<SIGNATURE ...>... bfwSignature
<TEXTINPUT ...>... bfwInput
<TEXTOUTPUT ...>... bfwOutput
<INSTRUCTION type=“repeat“ ...>... bfwTable
Depending on the component class assigned, individual component tags that must be declared through special IDs are expected within the "grouping" tag. Each input field, for example, must contain a tag with the "_bfw_field_" ID, which defines the actual input field. In addition, an input field may, for example, have a text that is specified by an element with the "_bfw_label_" ID.
•
•
• Synchronizing R/3-active components As a result of communicating with the R/3 System, HTML components may change their statuses. You can display each status by assigning different formatting options to individual elements. For input fields, you can, for example, change the background color, font color, type of frame or font for different statuses. You can use Cascading Style Sheets (CSS) to control this layout information.
In the HTML document, you then need to store additional information that specifies which CSS class is to be used for which component status. You can use the following attributes for the statuses of HTML components:
Defining adequate HTML components The XSL style sheet must be used to define adequate components in the HTML document for the elements defined in the XML documents (such as, input and output fields).
The runtime environment manages the components irrespective of the layout you have chosen. It only performs basic checks. An HTML element must, for example, be created for an input field and this element must allow to enter values, this means, an INPUT tag (type = text), a SELECT tag, or a TEXTAREA tag. For a function call, on the other hand, an HTML element must be created that supports the onkeypress and onclick events.
Event handling The R/3-active components react to certain user interactions such as clicking a field with the mouse or pressing a key. At runtime, an instance of a JavaScript class (constructor function) is assigned to each component that has been fully and consistently declared. This instance deals with automatically defined events (such as onclick, onkeypress, and so an) that you may not use elsewhere. These events control the component's behavior and the synchronization with the runtime objects of the ABAP environment.
Attributes Meaning
_BFW_CSS_ACTIVE_ Active, for example, in the change mode
_BFW_CSS_INACTIVE_ Inactive, for example, in the display mode
_BFW_CSS_DEFAULT_ Default values
April 2001 469
Process Management (PP-PI-PMA) SAP AG
Reference Information: Definition of R/3-Active Components
_BFW_CSS_ERROR_ Contains errors
_BFW_CSS_DISABLED_ Not ready for input, for example, when deactivating
Example for the definition of a component of type "input field" in the HTML document that is created by the XSL style sheet:
<SPAN ID=“_bfw_component_“ _BFW_TYPE_=“bfwInput“ _BFW_KEY_=“....“> <SPAN ID=“_bfw_label_“>text</SPAN> <INPUT ID=“_bfw_field_“ TYPE=“TEXT“ SIZE=“10“ MAXLENGTH=“20“ _BFW_CSS_ACTIVE_=“myStyle1“ _BFW_CSS_ERROR_=“myStyle2“ _BFW_CSS_DEFAULT_=“myStyle3“ _BFW_CSS_INACTIVE_=“myStyle4“ _BFW_CSS_DISABLED_=“myStyle5“></INPUT> </SPAN>
The following sections provide an overview of the features of the component classes that the runtime environment supports. The tables must be read from the top to the bottom and from the left to the right. Each table describes the following:
Which elements the system expects for which component class. The elements must be defined as the attribute value of the "ID" attribute in an HTML tag.
•
•
•
•
•
Which HTML tags you may use for which elements
Which elements you can use optionally
Which events are supported by which element
Which status attributes exist and for which elements you may use them
470 April 2001
SAP AG Process Management (PP-PI-PMA)
Reference Information: Definition of R/3-Active Components
Class
bfwInput
Functionality
The component controls an input field. It may not contain further components.
Component tag
"Grouping" tag
Elements of a component The element names must be assigned as attribute values of the "ID" HTML attribute of a tag.
See "Identifying R/3-active components" above
_bfw_label_ Provides the text through the innerText property
_bfw_icon_ Indicates whether the entry is required (_bfw_css_active_) or optional (_bfw_css_inactive_).
_bfw_field_ Defines the input field itself.
_bfw_button_ Controls the input help button, which means that it becomes active when the focus is set to the input field. Input help can also be called up using Ctrl + H.
HTML tags supported
All All, provided that the innerText property is supported
All INPUT type=text SELECT TEXTAREA
All, provided that the onclick event is supported
Optional
X X X
Event handlers used
onkeypress onclick oncontextmenu
onchange onhelp onfocus onblur
April 2001 471
Process Management (PP-PI-PMA) SAP AG
Reference Information: Definition of R/3-Active Components
Status change
- _bfw_css_active_ _bfw_css_inactive_ _bfw_css_disabled_ _bfw_css_error_ _bfw_css_default_
_bfw_css_active_ _bfw_css_inactive_
_bfw_css_active_ _bfw_css_inactive_ _bfw_css_disabled_ _bfw_css_error_ _bfw_css_default_
_bfw_css_active_ _bfw_css_inactive_
Explanation of the "bfwSignature" table: The tags and elements mentioned under "bfwInput" are also valid for component class "bfwSignature". In addition, you must take into account the elements that are listed in the "bfwSignature" below:
472 April 2001
SAP AG Process Management (PP-PI-PMA)
Reference Information: Definition of R/3-Active Components
Class
bfwSignature
Functionality
The component controls an input field for signatures or digital signatures. It may not contain further components.
Component tag
"Grouping" tag
Elements of a component The element names must be assigned as attribute values of the "ID" HTML attribute of a tag.
As for "bfwInput"
_bfw_list_ _bfw_sign_ _bfw_date_ _bfw_time_ _bfw_comment_
* See below The innerText property is used to output the corresponding values.
HTML tags supported
As for "bfwInput"
TBODY All, provided that the innerText property is supported
Optional
As for "bfwInput"
X
Event handlers used
As for "bfwInput"
- - - - -
April 2001 473
Process Management (PP-PI-PMA) SAP AG
Reference Information: Definition of R/3-Active Components
* Belongs to _bfw_list_ (see above) The component is like an input field with additional functionality to be able to display signatures that have been executed. A BODY tag that contains exactly one table line is expected along with _bfw_list_. This line is used as a template for the signature to be displayed. It is hidden when the component is initialized successfully. The template line is copied for every new signature to be displayed. Entering _bfw_list_ is optional. If it is missing, the component is like a normal input field. If it exists, further tags to display the signature data are expected.
474 April 2001
SAP AG Process Management (PP-PI-PMA)
Reference Information: Definition of R/3-Active Components
Class
bfwOutput
Functionality
The component controls an output field. It may not contain further components.
Component tag
"Grouping" tag
Elements of a component The element names must be assigned as attribute values of the "ID" HTML attribute of a tag.
_bfw_label_ The innerText property of _bfw_label_ outputs the text. The value can be a string of any length.
_bfw_field_ If no INPUT tag is used for _bfw_field_, the innerText property is used to output the value.
HTML tags supported
All All, provided that the innerText property is supported
INPUT type=text TD SPAN DIV
Optional
X
Event handlers used
onkeypress oncontextmenu
Status change
- _bfw_css_inactive_ _bfw_css_disabled_
_bfw_css_inactive_ _bfw_css_disabled_
April 2001 475
Process Management (PP-PI-PMA) SAP AG
Reference Information: Definition of R/3-Active Components
Class
bfwCalculation
Functionality
The component controls a calculation field. It may not contain further components.
Component tag
"Grouping" tag
Elements of a component The element names must be assigned as attribute values of the "ID" HTML attribute of a tag.
_bfw_label_ The innerText property is used to output the text.
_bfw_icon_ Indicates whether the execution is required (_bfw_css_active_) or optional (_bfw_css_inactive_).
_bfw_field_ _bfw_button_The calculation is triggered with this.
HTML tags supported
All All, provided that the innerText property is supported
All INPUT type=text All, provided that the onclick and onkeypress events are supported
Optional
X X
Event handlers used
onkeypress onclick oncontextmenu
onhelp
Status change
- _bfw_css_active_ _bfw_css_inactive_ _bfw_css_disabled_ _bfw_css_error_
_bfw_css_active_ _bfw_css_inactive_
_bfw_css_active_ _bfw_css_inactive_ _bfw_css_disabled_ _bfw_css_error_
_bfw_css_active_ _bfw_css_inactive_
476 April 2001
SAP AG Process Management (PP-PI-PMA)
Reference Information: Definition of R/3-Active Components
Class
bfwExecute
Functionality
The component controls a function call. It may not contain further components.
Component tag
"Grouping" tag
Elements of a component The element names must be assigned as attribute values of the "ID" HTML attribute of a tag.
_bfw_label_ Outputs the text through the innerText property.
_bfw_button_ Marks the pushbutton as such.If no _bfw_button_ is defined, the "grouping" tag is used as the button.
HTML tags supported
All All, provided that the innerText property is supported
All, provided that the onclick and onkeypress events are supported
Optional
X X
Event handlers used
onhelp onhelp onkeypress onclick oncontextmenu
Status change
- _bfw_css_active_ _bfw_css_inactive_ _bfw_css_disabled_
_bfw_css_active_ _bfw_css_inactive_ _bfw_css_disabled_
April 2001 477
Process Management (PP-PI-PMA) SAP AG
Reference Information: Definition of R/3-Active Components
Class
bfwTable
Functionality
The component controls a table. A table may contain components of all classes described before.
Component tag
"Grouping" tag Elements of a component The element names must be assigned as attribute values of the "ID" HTML attribute of a tag.
_bfw_tab_label_ Outputs the text through the innerText property.
_bfw_tab_scroll_ See * below. Outputs the
column heading. A _bfw_tab_text_ line is expected at any position in the header.
_bfw_tab_body_ A TABLE tag is expected for this. This table must comprise a header (THEAD) and at least one body (TBODY). See ** below.
_bfw_tab_text_
HTML tags supported
All All, provided that the innerText property is supported
DIV TABLE TR
Optional
X X
onhelp oncontextmenuonresize
onhelp Event handlers used
478 April 2001
SAP AG Process Management (PP-PI-PMA)
Reference Information: Definition of R/3-Active Components
Status change
- _bfw_css_active_ _bfw_css_inactive_ _bfw_css_disabled_
_bfw_css_active_ _bfw_css_inactive_ _bfw_css_disabled_
_bfw_css_active_ _bfw_css_inactive_ _bfw_css_disabled_
April 2001 479
Process Management (PP-PI-PMA) SAP AG
Reference Information: Definition of R/3-Active Components
480 April 2001
* Belongs to _bfw_tab_scroll_ (see above) _bfw_tab_scroll_ can be used to declare a DIV tag, which enables scrolling in the table. The component controls the visible area. For this, the _bfw_params_ attribute must be used to pass on further parameters in the "grouping" tag: HBASE: base height (pixel) HLINE: line height (pixel) HMIN: total height (pixel) that the scrollable area is to have at least LINES: number of lines to be displayed without scroll function Example: ... _BFW_PARAMS_=“HBASE:22;HLINE:22;HMIN:88;LINES:10;“ ...
** Belongs to _bfw_tab_body_ (see above ) The first table body (TBODY) is used to represent the table lines. Before it is initialized, this body must comprise exactly one line,
SAP AG Process Management (PP-PI-PMA)
Reference Information: Definition of Commands
Reference Information: Definition of Commands The menu functions available in the PI sheet or cockpit refer to the entire document (global commands) or individual components in the document (local commands). The system only displays those menu functions that can actually be carried out when the document or component is called. You can use the XSL style sheet to determine which menu functions should also be available as commands (pushbuttons).
In addition, you can define HTML elements of your choice in the entire document. Cascading style sheets (_bfw_css_active_ or _bfw_css_inactive_ attribute) are used to synchronize these elements with the status of the command assigned. These elements must support the onclick or onkeypress JavaScript events.
You can use any HTML tags to declare menu functions for the entire document or individual components. Menu functions for a particular component, however, must be defined in the "grouping" tag of the relevant component. This HTML tag must contain the following parts of the component as an attribute. Each attribute must then be assigned certain attribute values.
Attribute Attribute Value Explanation
ID (HTML attribute)
_BFW_CODE_ <command> (see below)
Each command is valid for one or several usages.
_BFW_CSS_ACTIVE_ Any CSS style Active, for example, in the change mode
_BFW_CSS_INACTIVE_
Any CSS style
•
•
•
•
_bfw_g_command_ Valid for the entire document. Can be defined at any position in the document. _bfw_l_command_ Valid for a component only. Can be defined within the corresponding component "grouping" tag.
Optional
Inactive, for example, in the display mode
You can use the following commands:
Command Available for Function
COMMENT_GET Document, all components Display comments entered
Document, all components Enter new comment
DEVIATION_SHOW Input field with input validation Display deviations
SIGNATURE_SHOW Signature field Display signatures executed
POSITION_SHOW All components Display position
MESSAGE_SHOW All components Display messages
ADD_LINE Table Add line
Document Switch to change mode
COMMENT_SET
EDIT
April 2001 481
Process Management (PP-PI-PMA) SAP AG
Reference Information: Definition of Hyperlinks to Files in the R/3 System
SHOW Document Switch to display mode
REPORT Document Report data
SAVE Document Save
DISCARD Document Cancel or discard
PRINT Document Print document
Definition of a global command in the HTML document that is created by the XSL style sheet:
<INPUT ID=“_bfw_g_command_“ TYPE=... _BFW_CODE_=“SAVE“ _BFW_CSS_ACTIVE_=“myStyle1“ _BFW_CSS_INACTIVE_=“myStyle2“></INPUT>
Definition of a local command in the HTML document that is created by the XSL style sheet:
<SPAN ID=“_bfw_component_“ _BFW_TYPE_=“...“ _BFW_KEY_=“...“ ...> ... <INPUT ID=“_bfw_g_command_“ TYPE=... _BFW_CODE_=“COMMENT_SET“ _BFW_CSS_ACTIVE_=“myStyle1“ _BFW_CSS_INACTIVE_=“myStyle2“></INPUT> ... </SPAN>
Reference Information: Definition of Hyperlinks to Files in the R/3 System You can define hyperlinks that refer to documents in the R/3 System (such as work instructions) in PI sheets and cockpits. To do so , you must define an HTML tag that supports hyperlinks. Note the following:
You must mark the component as a hyperlink. You do so by adding the ID=“_bfw_link_“ attribute in the HTML tag.
•
•
•
We recommend specifying a separate frame as the target for hyperlinks.
You specify the URL to be called. Depending on the document, you must follow the following naming convention:
− For documents in the R/3 System:
"SAPR3-WR-file name"
"SAPR3-WR-MYFILE.HTML"
− For PI documents:
"SAPR3-PIDOC- plantPIcockpit name"
"SAPR3-PIDOC-001PIMYCOCKPIT"
482 April 2001
SAP AG Process Management (PP-PI-PMA)
Reference Information: Definition of Text Symbols
The documents referred to in this way are automatically provided by the R/3 application server when the PI sheet or cockpit is loaded. This may cause performance problems when the PI document is loaded for the first time.
Example for the definition of a link to a cockpit in the HTML document <A ID=“_bfw_link_“ HREF=“SAPR3-PIDOC-001PIMYCOCKPIT “ TARGET=“FRAME2“>MyLink</A>
See also: Managing of Documents for Layout Definitions [Page 496] •
Layout Definition for PI Sheets and Cockpits [Page 45 ]7 •
Loading Resources on Demand You can also specify that you do not want the R/3 System to provide the documents unless they are actually called by the user. To do so, you put an asterisk (*) instead of a hyphen (-) after SAPR3 in the URL:
"SAPR3*WR-file name" •
• "SAPR3*PIDOC- plantPIcockpit name"
Reference Information: Definition of Text Symbols Some texts in PI sheets and cockpits must be made available in several different languages (for example, menu functions). This means that when you log on to the SAP System in a different language, these texts must come up in the correct language.
You can use text symbols that you have created in an ABAP program for all files of MIME type TEXT. These texts can then be translated using the R/3 translation tools. The text symbols are automatically replaced in the HTML document before it is loaded. This means that the text is displayed in the language in which the user has logged on to the SAP System.
Text symbols are defined as follows in the XSL style sheet: <!--#text-TextID(Program name)#-->
<!--#text-001(SAPLPOC_MAIN)#--> In this example, text symbol 001 is provided by the ABAP program SAPLPOC_MAIN.
Standard Files as Templates for Style Sheet Definitions Below you will find the names of all files that you can use as templates to define your own XSL style sheets.
April 2001 483
Process Management (PP-PI-PMA) SAP AG
Standard Files as Templates for Style Sheet Definitions
The XSL files used for browser-based PI sheets are different from those for process manufacturing cockpits but the CSS style sheets and images (GIF files) are the same for both documents.
Browser-Based PI Sheets Process Manufacturing Cockpits
Archiving of Browser-Based PI Sheets
PMC_STY_DEFAULTX.XSL PMC_STY_C_DEFAULTX.XSL
PMC_STY_A_DEFAULTX.XSL
PMC_STY_DEFAULTS.CSS (screen layout)
PMC_STY_A_DEFAULTS.CSS (screen layout)
PMC_STY_DEFAULTP.CSS (print layout)
PMC_STY_A_DEFAULTP.CSS (print layout)
The list below contains the files along with their hierarchical relationships and information about where they are stored in the R/3 System:
Level
Files
Stored in the R/3 System in
484 April 2001
SAP AG Process Management (PP-PI-PMA)
Standard Files as Templates for Style Sheet Definitions
1.
PMC_STY_DEFAULTX.XSL or PMC_STY_C_DEFAULTX.XSL or PMC_STY_A_DEFAULTX.XSL
BDS and Web Repository
April 2001 485
Process Management (PP-PI-PMA) SAP AG
Standard Files as Templates for Style Sheet Definitions
2. PMC_STY_DEFAULTFC.JS
BDS and Web Repository
2. PMC_STY_DEFAULTP.CSS or PMC_STY_A_DEFAULTP.CSS
BDS and Web Repository
3. PMC_IMG_CUBE.GIF Web Repository
3. PMC_IMG_CUBE_S.GIF Web Repository
486 April 2001
SAP AG Process Management (PP-PI-PMA)
Standard Files as Templates for Style Sheet Definitions
2. PMC_STY_DEFAULTS.CSS or PMC_STY_A_DEFAULTS.CSS
BDS and Web Repository
3. PMC_IMG_CUBE.GIF
3. PMC_IMG_CUBE_S.GIF
3. PMC_IMG_TATAMI.GIF
Web Repository
2. PMC_IMG_1X1.GIF
April 2001 487
Process Management (PP-PI-PMA) SAP AG
Standard Files as Templates for Style Sheet Definitions
2. PMC_IMG_AH_CLOSED.GIF
2. PMC_IMG_A_CLOSED.GIF
2. PMC_IMG_A_OPENED.GIF
2. PMC_IMG_B_D_BACK.GIF
488 April 2001
SAP AG Process Management (PP-PI-PMA)
Standard Files as Templates for Style Sheet Definitions
2. PMC_IMG_B_D_LEFT.GIF
2. PMC_IMG_B_D_RIGHT.GIF
2. PMC_IMG_B_U_BACK.GIF
2. PMC_IMG_B_U_LEFT.GIF
April 2001 489
Process Management (PP-PI-PMA) SAP AG
Standard Files as Templates for Style Sheet Definitions
2. PMC_IMG_B_U_RIGHT.GIF
2. PMC_IMG_CORNER.GIF
2. PMC_IMG_CORNER3D.GIF
490 April 2001
SAP AG Process Management (PP-PI-PMA)
Standard Files as Templates for Style Sheet Definitions
2. PMC_IMG_F4BUTTON.GIF
2. PMC_IMG_S_B_ANNO.GIF
2. PMC_IMG_S_B_CALC.GIF
2. PMC_IMG_S_B_INSR.GIF
April 2001 491
Process Management (PP-PI-PMA) SAP AG
Standard Files as Templates for Style Sheet Definitions
2. PMC_IMG_S_B_NODP.GIF
2. PMC_IMG_S_B_STAT.GIF
2. PMC_IMG_S_B_ERRO.GIF
2. PMC_IMG_S_T_MAIL.GIF
492 April 2001
SAP AG Process Management (PP-PI-PMA)
Standard Files as Templates for Style Sheet Definitions
2. PMC_IMG_S_B_CREA.GIF
April 2001 493
Process Management (PP-PI-PMA) SAP AG
Document Type Definition (DTD) for Generated XML Documents
Document Type Definition (DTD) for Generated XML Documents XML documents are generated for each browser-based PI sheet and each process manufacturing cockpit. The DTD file "PMC_DTD_DATA.DTD", whose structure is illustrated below, is valid for these XML documents. The document type definition [Ext.] describes which elements within the XML document refer to each other.
<!DOCTYPE DOCUMENT [
<!ELEMENT DOCUMENT ( LABEL, HEADER, CONTENT ) > <!ATTLIST DOCUMENT id NMTOKEN #REQUIRED > <!ATTLIST DOCUMENT mode ( simulation | test ) #IMPLIED >
<!ELEMENT HEADER ( META* , PHASE* ) >
<!ELEMENT META ( LABEL , VALUE ) > <!ATTLIST META domain NMTOKEN #REQUIRED > <!-- CHARACTERISTIC -->
<!ELEMENT CONTENT ( PHASE* ) >
<!ELEMENT PHASE ( LABEL? , INSTRUCTION* ) > <!ATTLIST PHASE id NMTOKEN #REQUIRED >
<!ELEMENT INSTRUCTION ( LINE* | ( INPUT | OUTPUT | CALCULATION | EXECUTE | TEXTINPUT | TEXTOUTPUT | SIGNATURE )* ) > <!ATTLIST INSTRUCTION id NMTOKEN #REQUIRED > <!ATTLIST INSTRUCTION type ( simple | repeat ) #REQUIRED > <!ATTLIST INSTRUCTION category NMTOKEN #REQUIRED > <!ATTLIST INSTRUCTION min NMTOKEN #IMPLIED > <!ATTLIST INSTRUCTION max NMTOKEN #IMPLIED >
<!ELEMENT LINE ( ( INPUT | OUTPUT | CALCULATION | EXECUTE | TEXTINPUT | TEXTOUTPUT | SIGNATURE )* ) >
<!ELEMENT INPUT ( LABEL?, TIP?, HELPVALUE* ) > <!ATTLIST INPUT id NMTOKEN #REQUIRED > <!ATTLIST INPUT domain NMTOKEN #REQUIRED > <!ATTLIST INPUT format NMTOKEN #REQUIRED > <!ATTLIST INPUT lenvis NMTOKEN #REQUIRED > <!ATTLIST INPUT lendef NMTOKEN #REQUIRED > <!ATTLIST INPUT vhelp ( true | false ) "false" > <!-- value help defined --> <!ATTLIST INPUT check ( true | false ) "false" > <!-- input validation -->
<!ELEMENT OUTPUT ( LABEL?, TIP?, VALUE? ) > <!ATTLIST OUTPUT id NMTOKEN #REQUIRED > <!ATTLIST OUTPUT domain NMTOKEN #REQUIRED > <!ATTLIST OUTPUT format NMTOKEN #REQUIRED > <!ATTLIST OUTPUT lenvis NMTOKEN #REQUIRED > <!ATTLIST OUTPUT lendef NMTOKEN #REQUIRED > <!ATTLIST OUTPUT constant ( true | false ) "false" > <!-- constant value -->
<!ELEMENT CALCULATION ( LABEL?, TIP? )> <!ATTLIST CALCULATION id NMTOKEN #REQUIRED >
494 April 2001
SAP AG Process Management (PP-PI-PMA)
Document Type Definition (DTD) for Generated XML Documents
<!ATTLIST CALCULATION domain NMTOKEN #REQUIRED > <!ATTLIST CALCULATION format NMTOKEN #REQUIRED > <!ATTLIST CALCULATION lenvis NMTOKEN #REQUIRED > <!ATTLIST CALCULATION lendef NMTOKEN #REQUIRED >
<!ELEMENT EXECUTE ( LABEL? )> <!ATTLIST EXECUTE id NMTOKEN #REQUIRED > <!ATTLIST EXECUTE function NMTOKEN #REQUIRED > <!ATTLIST EXECUTE ondisplay ( true | false ) "false" >
<!ELEMENT TEXTINPUT ( LABEL?, TIP? ) > <!ATTLIST TEXTINPUT id NMTOKEN #REQUIRED > <!ATTLIST TEXTINPUT domain NMTOKEN #REQUIRED > <!ATTLIST TEXTINPUT vhelp ( true | false ) "false" > <!ATTLIST TEXTINPUT check ( true | false ) "false" >
<!ELEMENT TEXTOUTPUT ( LABEL?, TIP?, VALUE? ) > <!ATTLIST TEXTOUTPUT id NMTOKEN #REQUIRED > <!ATTLIST TEXTOUTPUT domain NMTOKEN #REQUIRED > <!ATTLIST TEXTOUTPUT constant ( true | false ) "false" >
<!ELEMENT SIGNATURE ( LABEL?, TIP?, HELPVALUE* ) > <!ATTLIST SIGNATURE id NMTOKEN #REQUIRED > <!ATTLIST SIGNATURE domain NMTOKEN #REQUIRED > <!ATTLIST SIGNATURE format NMTOKEN #REQUIRED > <!ATTLIST SIGNATURE lenvis NMTOKEN #REQUIRED > <!ATTLIST SIGNATURE lendef NMTOKEN #REQUIRED > <!ATTLIST SIGNATURE strategy ( true | false ) "false" > <!ATTLIST SIGNATURE vhelp ( true | false ) "false" > <!ATTLIST SIGNATURE check ( true | false ) "false" >
<!ELEMENT LABEL ( #PCDATA )>
<!ELEMENT TIP ( #PCDATA )>
<!ELEMENT HELPVALUE ( #PCDATA )>
<!ELEMENT VALUE ( #PCDATA )>
]>
April 2001 495
Process Management (PP-PI-PMA) SAP AG
Managing of Documents for Layout Definitions
Managing of Documents for Layout Definitions Use To use your own layout for browser-based PI sheets [Page 158] and process manufacturing cockpits [Page 406], you must create and manage a number of different files in the R/3 System. For the system to be able to access the right XSL style sheet and other files while creating the PI sheet or cockpit, these files must be stored centrally in the R/3 System.
In the same way, all generated XML documents are stored in the R/3 System until the corresponding process orders or cockpits from Customizing are deleted.
You can store your documents for document management purposes as follows in the R/3 System:
In the Business Document Service (BDS) [Ext.] •
In the Web Repository •
•
•
We recommend managing your documents in the BDS when you define your own style sheets.
Features Business Document Service (BDS)
Initial screen You can find the initial screen for the Business Document Navigator in the SAP Menu by choosing Tools -> Business Documents ->Miscellaneous -> Business Documents. On the Business Document Navigator selection screen, you must enter a class name and class type to get to the detail screen containing the documents.
Structure The BDS is structured hierarchically. The first level contains classes and the second level contains object keys (or object IDs). You can use the object keys to create your own directories with any names you like in the BDS.
The files for PI sheets and cockpits are stored in the classes POC_TEMPLATE and POC_PIDOC. They are assigned to class type OT. The object key SAP is below the class POC_TEMPLATE. Here, you can find the templates for style sheets. Below the object key, you can find the documents.
− Class POC_TEMPLATE
Store all documents that serve as master data (such as your own XSL files, CSS files, GIF files, and so on) in this class. Versions can be created for these documents and they can have different language variants. You can also find the following templates under the object key "SAP":
• Standard XSL style sheets - "PMC_STY_C_DEFAULTX.XSL" for manufacturing cockpits - "PMC_STY_DEFAULTX.XSL" for PI sheets - "PMC_STY_A_DEFAULTX.XSL" for archiving PI sheets
• Standard CSS style sheets
496 April 2001
SAP AG Process Management (PP-PI-PMA)
Managing of Documents for Layout Definitions
For PI sheets and process manufacturing cockpits − Screen layout: "PMC_STY_DEFAULTS.CSS" − Print layout: "PMC_STY_DEFAULTP.CSS" For the archiving of PI sheets: − Screen layout: "PMC_STY_A_DEFAULTS.CSS" − Print layout: "PMC_STY_A_DEFAULTP.CSS"
• Standard JavaScript files For PI sheets and process manufacturing cockpits "PMC_STY_DEFAULTFC.JS"
Changes you make to the above-mentioned files do not have any effects since they only serve as templates to define your own XSL style sheets. The original files are loaded from the Web Repository.
− Class POC_PIDOC
All documents that serve as transactional data (such as XML files that are automatically created for a PI sheet or cockpit) are stored here.
− Class SAP_ICONS
This class contains icons that are used in the standard R/3 System. You can copy them and use them for your style sheets. The icons used in the standard style sheets, are stored in the Web Repository only (see below).
URL convention •
You must adhere to the following URL convention when naming references to documents that are stored in the BDS:
SAPR3-BDS-<class name>-<class type>-<object ID>-<file name>-<version number>-<variant number> SAPR3-BDS-POC_TEMPLATE-OT-MYDOC-MYTEST.DOC SAPR3-BDS-POC_TEMPLATE-OT-MYDOC-MYTEST2.HTML-31-3 (version 31, variant 3) Version number and variant number are optional. If you do not specify a version number, the system automatically uses the latest version.
Note that files names are case-sensitive.
• Transferring standard files from the SAP Reference Client Since the BDS is client-specific, the standard files mentioned above are usually only available in the SAP Reference Client. To copy the files from the SAP Reference Client to your logon client, you must execute the RCOPOC_SAP_LAYOUT_CLIENT_COPY report program.
This is a preliminary solution. SAP plans to make this function available as a Customizing activity in the next functional release.
Web Repository Initial screen •
April 2001 497
Process Management (PP-PI-PMA) SAP AG
Managing of Documents for Layout Definitions
You can find the initial screen for the Web Repository in the SAP Menu by choosing Tools -> Web Development -> Web Repository. On the initial screen, you must select the Web object type. The Object selection screen appears on which you must enter a development class.
Structure •
•
The Web Repository is structured according to development classes. All original files that are accessed when the standard layouts for PI sheets and cockpits are used are stored as follows in the Web Repository:
− Web object: binary data for WebRFC applications
− Development class: COPOC
The GIF files to which the standard style sheets refer only exist in the Web Repository.
You can use the original files stored in the Web Repository as templates but you should not store your own files here. The Web Repository is designed for SAP objects.
URL convention You must adhere to the following URL convention when naming references to documents that are stored in the Web Repository:
SAPR3-WR-<file name>
SAPR3-WR-MYTEST.GIF
You can use standard files from both the Web Repository and the Business Document Service as templates. Just make sure that the paths for the references in your style sheets are always adjusted to the appropriate location where your document is stored.
For a list of all files that you can use for PI sheets and cockpits and how they are related to each other hierarchically, see Standard Files as Templates for Layout Definitions [Page 496].
498 April 2001
SAP AG Process Management (PP-PI-PMA)
Notes on Defining the Layout
Notes on Defining the Layout How do you indicate the mode of a document (display/change)? The commands EDIT and SHOW have, for example, been assigned to the document. You can synchronize all HTML elements of your choice with these commands.
See also: Reference Information: Definition of Menu Functions [Page 481]
How do you control the number of lines displayed in a table? The XSL style sheet is used to create a table component in the HTML document for each process instruction of type repeated data request defined in the XML document. You can pass on suitable parameters to the bfwTable component class used for this.
See also: Reference Information: Definition of R/3-Active Components [Page 46 ]8
How do you control colors, fonts, and font sizes? The XSL style sheet is used to link Cascading style sheets that define the font, font size, and color palette for print-out and display on the screen.
See also: Standard Files as Templates for Layout Definitions [Page 483]
How do you link PI documents and documents from the intranet? You can use characteristic PPPI_LAYOUT to define a frameset that is automatically displayed along with the corresponding PI document. Reserve a separate frame to output intranet documents. Using characteristics for the long text output (SAPscript editor: format HAT), you can define hyperlinks in HTML format in the PI document.
See also: Layout Definition for PI Sheets and Cockpits [Page 457]
When would you use a hyperlink with the _bfw_link_ ID? The runtime environment controls the navigation by way of these hyperlinks. You can also define that files or documents that are directly taken from the R/3 System are only loaded when requested. For this reason, always use _bfw_link_ for documents taken from the R/3 System.
See also: Reference Information: Definition of Hyperlinks to Files in the R/3 System [Page 482]
April 2001 499