1. Background
When a production unit or utility company runs its operation 24X7 and 365 days a year, it operates in shift. It is normally expected to get an overall view of the shift as a dashboard to middle management and details at transaction level for front line managers and supervisors. Though SAP Plant Maintenance module and its functionalities thereof are capable of handling the scenarios of breakdown maintenance, preventive maintenance, adhoc maintenance with resource scheduling and integration with other SAP module like MM, FI/CO and many more to have integrated view across the enterprise however, this expectation from customer was always a customized solution.
2. Objective
Recent Enhancement Packages bring some additional features in SAP PM+ (which is EAM- Enterprise Asset Management) like Log book (LBK1) and shift note/shift report. This document will highlight about the features in details, its customizability in terms of BADIs & configurations available, advantages and disadvantages and integration with advances SAP solutions.
3. Pre Requisite
The prerequisite to understand this document is to have working knowledge of SAP PM Module. Working experience in shift will have added advantage to understand the context of the requirement.
4. Document Usage
This document can be used as a reference by the Functional consultants/Technical Consultants for understanding the functionalities available as part SAP log book or shift note/shift report. This document is produced during exploring various functionalities available in SAP.
5. Details of the Context
To further detail the requirement followings KPIs/information are minimum for any logbook for a shift at a section of plant. The same can be aggregated at plant level as a dashboard view for higher management.
Maintenance perspective
1. Breakdowns, faults, emergencies with details
2. Adhoc job carried out
3. Major material withdrawn with cost details
4. Inspection round details and finding of exceptions with readings
5. Message to next shift
6. Any major incident with Environment/occupational Health and safety
7. Any other performance measurement to be measured
Operation/Production Prospective
1. Production figures
2. Any major quality rejections
3. Machines performances figures
4. Any other performance measurement to be measured
Above requirement is just a list of minimum expectations, however can be further added or modified based on the specific requirement.
6. System Prerequisite and Activating Business Functions
You have to activate the below business functions (T. Code SFW5)
Technical Name of Business Function | LOG_EAM_ELBK, LOG_EAM_POM_2 (log book) LOG_PP_SRN_CONF – Shift note/Shift report |
Type of Business Function | Enterprise business function |
7. SAP Solution of Log book – LBK1
SAP designed LBK1 with following features for DIMP and is now available in ECC with enterprise business function LOG_EAM_ELBK, LOG_EAM_POM_2. This can be activated by SFW5.
New configuration and transaction in to SPRO and SAP easy access path is shown as below.
- SPRO-> Plant Maintenance and Customer Service-> Maintenance and Service Processing-> Logbook
- Logistics->Plant Maintenance-> Maintenance Processing -> Logbook -> LBK1 - Logbook
Log book is designed based on the structure as below.
SAP Log book is created at either for equipment or functional location level which we designate as a log book folder. Log book hierarchy is built based on Object Hierarchy Framework(Fig-1). The hierarchy is shown as the left side of the screen based on the selection screen button . This can be defaulted based on the variant of report DIACL_SELECTION_NEW. Left hand side of the screen shows the objects and its hierarchy and the right hand side will be shown the details of the object. Like in this case the right hand side shows functional location (FLOC)fig -2
As SAP has not provided any standard screen and functionalities, screen shown here is possible by activating few BAdis and importing example code into the implementation.
Customer sub screens can be activated at below level with following BADI.
No | Level | BADI Name | Functionality available and what can be done |
1 | Log Entry folder –FLOC | FLL_SUBSCR_ACL | As this directly refers to FLOC master data and any new field to be stored in CI_IFLO |
2 | Log Entry folder –EQPT | EQL_SUBSCR_ACL | As this directly refers to FLOC master data and any new field to be stored in CI_EQUI |
3 | Log Entry Main | LGETY_SUBSCR_ACL | Any new screen fields added will be added to include structure of DDIC table DIACL_LOG_ENTRY. There is example code available and screen which is shown fig 3 are related to flight log. |
4 | Log Notifications | LGN_SUBSCR_ACL | As SAP standard has provided 4 tab pages(Fig 4). 1. Notification – related to notification 2. Operation – related to order 3. Component - related to order 4. Fast data capturing - related to order and Notification BADi can hide above tab(s) and introduce new tab. However the data needs to be stored either in CI_QMEL or CI_AUFK based its relevance. It can also have new buttons based on the BADi. |
5 | Log Measuring documents | MDC_SUBSCR_ACL | In fig 5, example field ‘shift’ is added for log measurement document and additional field will be stored in CI_IMRG |
Below table shows additional BADis which are available.
No | BADI Name | Functionality available and what can be done |
1. | CNTR_DFLT_ACL | Default Counter Update Values |
2. | HIER_CHECK_LBK | Hierarchy Checks for Logbook Actions |
3. | NAVIGATION_ACL | Manipulation of Logbook Tree Columns |
4. | TOOLBAR_ACL | Addition/Removal of Toolbar Function |
5. | TOOLBAR_FUNC_OHFW | Define Toolbar Function Processing. All implementations for this BADI are default called for the above functionalities. |
6. | AUTHORITY_CHECK_ACL | Check User Authorization for Logbook Activity |
7. | POST_ACTION_ACL | Automatic Actions When Saving Logbook Objects |
8. | BADI_CCM_CLIST_APL, BADI_CCM_CLIST_CBTNS, BADI_CCM_CLIST_FLD | BADis related to component list |
7.1 Main Log Entry
Once sub screen BADI (LGETY_SUBSCR_ACL) is implemented with relevant fields, log entry can be made and the data are saved in DIACL_LOG_ENTRY its entire hierarchy is stored DIOHFW_NODES. Various sub functionalities are associated with main log entries.
a) Status Control
Various system statuses are activated and deactivated based on the standard functionality. Below table show the status control. User status can be configuredand assigned to log entry type level.
Status | Desc | Even when activated |
INPC | In Progress | As soon as log entry is created |
DOCC | Document Created | Measurement document is created |
MDRQ | Measurement document creation required | · It prohibits changing a measurement document if this document is assigned to a completed log entry. · When setting the reversal indicator on a mandatory log measurement document using the standard transaction, the MDRQ (measurement document creation required) system status needs to be reset on the assigned log entry. · When removing the reversal indicator, if this was the final mandatory log measurement for this log entry, the MDRQ status needs to be removed on the Log entry screen. |
COMP | Completed | When log entry is completed. This can be revoked. |
COCE | Completion Certified | When the completed log entry is digitally signed |
CACL | Cancelled | When the log entry is cancelled |
b) Log entry hierarchy
Log entry can be created as ‘follow up’ or ‘preceding’ so that hierarchy of the same is made.
c) Digital Signature
Log entries can be digitally signed. For this we need to create signature strategy and assign it to log entry type.
In SPRO -> Plant Maintenance and Customer Service-> Maintenance and Service Processing-> Logbook-> Controlling Digital
Signature Process.
We can digitally certify log entry, log notification and can be configured as below(Fig-6).
Create signature strategy as below(Fig-7).
When the log book is completed, then this can be certified as shown below(Fig-8) through SAP digital signature methodology.
7.2 Log Notification
a) Log notifications can be created with respect to a log entry. This can be any notification type. However the screen fields available in the header screen are limited. For more fields user need to click the button beside notification text(Fig-9).
A new field is available in notification as ‘Reference no’ in log book and the same is not available in standard screen(Fig-10).
In operation tab, we can identify any task list or without task list we can create work order with respect to the log notification. The log notification can have all standard functionalities and its life cycle of a maintenance notification(Fig-11).
We can release the order from log book screen and after release we can put the actual work and the save the same and this will post confirmation to the work order(Fig-12).
We can certify the order operation confirmation digitally by clicking . The status of the operation list line item in log book becomes PCNF COCE REL.
In components tab, we can install, consume, remove, and exchange materials and equipment into or from superior technical objects. The process is performed with a synchronized goods movement (an issue from or to a receipt to stock). The functionality is similar to IE4N. Following major functionalities are available in component list.
Minimum configuration required to use Component list().
SPRO->Plant Maintenance and Customer Service ->Maintenance and Service Processing ->Configuration Contrl->Determine Properties of Notifications for Installing and Dismantling Parts
BADI (BADI_CCM_CLIST_APL and BADI_CCM_NOTIF_GENER)example code should be imported.
· ‘Consume’ material for an order in component list which creates a reservation and post the 261 movement type to order from inventory when we save the same. For this we have to use ‘Material On’ related fields in ALV. For the same serialization is not mandatory.
· We can also return the material to Inventory by posting 262 movement type to inventory from order by using ‘Material Off’ related fields in ALV.
· We can ‘Remove’ (dismantle) serialized material (Equipment) which create reservation and post 262 movement to inventory from order. During this also one more notification will be created for dismantling. The text for the notification can be transferred from the Component list ALV
· We can ‘install’ serialized material (Equipment) which creates reservation and post 261 movement to order from inventory. During this also one more notification will be created for dismantling. The text for the notification can be transferred from the Component list ALV
· We can also exchange one equipment from one location another location which posts two material documents (261 and 262). This will also create 2 notifications.
A typical screen for the same is shown below(Fig-13).
In ‘Fast data capturing’ tab functionalities related to notification, operation and component tab is available in a single tab and confirmation for the 1st operation can be posted from this tab. A typical screen is shown below(Fig-14).
7.3 Log Measurement Document
Log measurement documents can be posted automatically when a log entry is saved if the BADI CNTR_DFLT_ACL is activated with example code. Standard code will update counters as FH1 (Flying hours) and LC1 (No. of cycles).
The measuring points for the technical object (FLOC/EQPT) for FH1 and LC1 need to be created.
Below Configuration needs to be maintained for the same(Fig-15).
Plant Maintenance and Customer Service-> Maintenance and Service Processing-> Logbook->Controlling Counter Updates
FH1 is calculated time difference in Hrs between takeoff and landing timings (Fig-16)
LC1 is calculated from field ‘ No of Cycles’ field which is shown below(Fig-17).
7.4 Warranty Details
Warranty details can be seen from log book screen for the equipment and functional location. Standard SAP warranty screen appears as below(Fig-18).
7.5 Solution Mapping for the Context
After seeing the standard functionalities available and capabilities log book has got, the requirement with which we started from section 5, needs to be mapped in the below matrix
No | Requirement | Solution | Change |
Generic | Note: As Log book is created with respect to FLOC or EQPT, but there is no collated view with respect to a shift to use LBK1. For shift log book purpose we may have to create dummy FLOC/EQPT as Shift and create log entry with respect to them. Log notification can be created for different equipment/ different FLOC(while changing technical object, SAP gives warning, but can be ignored.) Apart from log notification, we may have to add to link notification and link order functionality. LBK1 should be used as transaction, however to make the details bit more presentable, we can think of some DASHBOARD. | ||
1 | Maintenance Perspective Breakdowns, faults, emergencies with details | This can be achieved with log notification functionality linked with log entry for any FLOC/EQ | Medium change. Note shift field needs to be added in to Log entry and should be propagated to log notification screen and log measurement document. |
2 | Adhoc job carried out | This can be achieved with log notification functionality linked with log entry for any FLOC/EQ | Same as 1 |
3 | Major material withdrawn with cost details | This can be achieved by component list with consumption functionality. | BADI_CCM_CLIST_APL needs to be activated with example code. Medium development |
4 | Inspection round details and finding of exceptions with readings | This can be achieved by a customer tab for order assignment and by activating standard business function LOG_EAM_CI_4 for inspection round Or Measurement entry list can be called from log entry and measurement document can be linked to log entry | Major development is needed in the both the options |
5 | Message to next shift | A long text in the log entry screen | For this we can standardize that for a shift a single log entry will be created with dummy asset (this might be a major disadvantages). |
6 | Any major incident with Environment/occupational Health and safety | In any of the customer tab, if we can link the SAP EHS module related data | Medium development |
7 | Any other performance measurement to be measured | This can be achieved by modifying the logic in BADi CNTR_DFLT_ACL with measurement entry list. | Major development. This could be simple measurement or it could be available from any 3rd party process control system which integrated through SAP MII. |
8 | Operation/Production Prospective Production figures | Data related to PP module can be retrieved and shown. | Major development |
9 | Any major quality rejections | Data related to QM module can be retrieved and shown. | Major development |
10 | Machines performances figures | Same as 7 | Same as 7 |
11 | Any other performance measurement to be measured | Same as 7 | Same as 7 |
7.6 Analysis
From the above matrix, it is clear that the requirement can be achieved by major development. There are no APIs available for creating log entry, log notification, order related to notification, component list, hence the front end transaction functionality of LBK1 needs to be enhanced.
8. SAP Solution for Shift Note/Shift Report
When short note is to be recorded for a shift which can’t be recorded as per current standard SAP functionalities available throughout life cycle of notification or work order process with respect to a shift, then Shift note can be used.
Shift report is digitally signed collated information of shift notes in PDF format for a shift. This PDF format can be changed with more details like production figures and can be integrated with SAP MII.
This is activated by business function LOG_PP_SRN_CONF. New configuration and transaction in to SPRO and SAP easy access path is as below.
- Logistics-> Central Functions->Shift Report and Shift Note for Technical Objects
- SPRO->Plant Maintenance and Customer Service-> Maintenance and Service Processing-> Shift Reports/Notes
Shift note is conceived to be a special type of notification with minimum screen fields available for configuration. This can be created with respect to a work centre or a FLOC/EQPT. For this to happen, we need to maintain the ‘shift note type’ and ‘shift report type’ in the respective master data of work centre or FLOC/EQPT(Fig-19 & 20 ).
8.1 Shift Note
For creating shift note either the for EQPT/FLOC or for the work centre, a notification type needs to be configured as shift note. This can be done in two ways.
1. Independent Shift Note:
a. Creating a notification type as shift note type and assigning shift note related screen area (path: SPRO-> Plant Maintenance and Customer Service-> Maintenance and Service Processing-> Shift Reports/Notes-> Define Screen Templates - for 10\TAB01 – screen area 130 and 131) and in-> Make Settings for Shift Note Type
b. Assign ‘Use’ for the shift note as ‘Independent Shift Note’ as below. For this we have to use transaction SHN1 or ISHN1 for creating shift note for work centre and FLOC/EQPT respectively(Fig-21).
Transaction screen looks like below(Fig-22).
1. 2. Generic Notification with other screen area
a. Repeat step 1 a and add more tabs whichever is needed.
b. Repeat step 1b and assign ‘Use’ to radio button ‘Screen Area of Notific’ and origin as either work center or Floc/EQPT based on the requirement. For this notification type, we can use IQS1/IQS2 etc for transacting notification.
Transaction screen looks like below.
Note: for the both above cases the notification will be created as shift note however they are of ‘General Notification’ category. In case of 2, though additional tabs are added and we can transact the data as general notification however creating maintenance order from this notification is not allowed. Moreover all functionalities of General Notification’ category will be available.
In addition the above configuration, configuration is needed for controlling shift start and end, long text control, category as part of catalog as below. These additional functionalities related to shift note gives control over shift start and shift end. If shift grouping is done in HR module, then it is further integrated with Shift report.
Following RFCs are available to use to create shift note from 3rd party systems.
COCF_SN_CREATE_EAM | Create Shift Note for Technical Objects/Equipment |
COCF_SN_CREATE_PP | Create Shift Note for Work Centers/Hierarchies |
COCF_SN_GET_CATEGORIES | Determines Possible Categories for Shift Note |
COCF_SN_GET_CUSTOMIZING | Determines Shift Note Settings |
COCF_SN_GET_LIST_PP | List of Shift Notes for Work Center/Hierarchy |
COCF_SN_GET_TEXT_MODULE | Determines Text Module for Shift Note |
COCF_SRN_GET_ALL_WORKPLACES | All Work Centers for Which Shift Reports/Shift Notes Can Be Created |
COCF_SRN_GET_USER_WORKPLACES | Work Centers for Which User Has Permission for Shift Reports/Notes |
8.2 Shift Report
Shift report is collated view in PDF of shift notes with functionality of approval, digital certification and open integration of other customer specific data through BADi. The shift report is always with respect to a FLOC/EQUP or work centre for which shift report type needs to be configured as below (Fig-24) and assigned to individual master data of FLOC/EQPT or work centre.
This makes the shift report output configurable with respect to shift note, confirmations, list good movement, Maintenance notification, Maintenance orders, Measuring document, WCM objects,
Note: The data will be shown based on the above configuration if the shift notes, maintenance notification, order or measuring document are created with respect to the FLOC/EQPT or Work centre. Measuring document, WCM objects are not available in the configurations for shift report type related to work center/hierarchy.
A typical shift report is as below (Fig-27).
Additional BADis and enhancement spots are available in package COCF as below.
BADI/Enh. Spots | Functionality |
COCF_BD_SHIFT_REPORT | We can influence shift report before generation, before change, before display and after change. This is applicable for Work centre shift report. |
COCF_BD_SN_BO | This can additional reference e objects in Shift note |
COCF_BD_SR_PDF_CUSTOMER | This triggers when the report is generated and in this customer specific content (list, text etc)can be passed to shift report. |
COCF_BD_SR_SN_SECTION | This influences the list of shift note selection |
COCF_ORDCNF | This influences the confirmation section of the shift report |
COCF_WCM | This influences the WCM section of the shift report |
COCF_WORKLIST | This gives flexibility of additional functions |
Shift note and shift report can used for PP and/or PM, hence confirmation, good movements, missing parts etc related functionalities with respect to Production Planning module can be further explored to suit business requirements.
8.3 Solution mapping for the context
After seeing the standard functionalities available and capabilities shift note/report has got, the requirement with which we started from section 5, needs to be mapped in the below matrix.
No | Requirement | Solution | Change |
Generic | Note: Shift note/report is created with respect to FLOC or EQPT and there is collated view(shift report pdf) with respect to a shift for individual technical object. For shift log book purpose we may have to create dummy FLOC/EQPT as Shift or we can create various shift note and a shift report for a work centre. Shift report is a physical file which is digitally signed information which is static information for the shift. | ||
1 | Maintenance Perspective Breakdowns, faults, emergencies with details | This can be achieved by creating breakdown notification and can be pulled as part of the shift report if created for the specific work centre or FLOC/EQPT. List of orders, confirmations can be part of shift report. Grouping of shift notes can be explored. | Medium change. Note shift field needs to be added in to be added to notification additional field. If the representation or collation of shift note and other details to create a shift report is not as expected, then major development needs to be done in shift report. |
2 | Adhoc job carried out | Same as 1 | Same as 1 |
3 | Major material withdrawn with cost details | This can be achieved by list of good movement in shift report. | No development |
4 | Inspection round details and finding of exceptions with readings | This can be achieved by a customer tab for order assignment and by activating standard business function LOG_EAM_CI_4 for inspection round Or Measurement entry list can be called from log entry and measurement document can be linked to log entry However these details can be picked in shift report. | Medium development, assuming only list of measuring document can be picked and listed for various equipment/floc. Measuring document creation is not part of this development. Note: For work centre measurement documents cannot be picked in shift report. |
5 | Message to next shift | Shift note with specific category | No development |
6 | Any major incident with Environment/occupational Health and safety | In any of the customer tab, if we can link the SAP EHS module related data | Part of 4 |
7 | Any other performance measurement to be measured | Same as 4 | Major development. This could be simple measurement or it could be available from any 3rd party process control system which integrated through SAP MII. |
8 | Operation/Production Prospective Production figures | Data related to PP module can be retrieved and shown. | Major development |
9 | Any major quality rejections | Data related to QM module can be retrieved and shown. | Major development |
10 | Machines performances figures | Same as 7 | Same as 7 |
11 | Any other performance measurement to be measured | Same as 7 | Same as 7 |
8.4 Analysis
From the above matrix, it is clear that the requirement can be achieved by major development. Shift report gives the maximum flexibility of including data related to notification, order, confirmation, list of goods movement, measurement document, however the definition of structuring of FLOC/EQUIP or work centre or creation of dummy FLOC/EQPT or dummy work center to be critically considered. APIs are available to create shift note, maintenance notification, maintenance order, measuring document, confirmation, goods movement etc.
9. Conclusion
From section 7 and 8, it is clear that none of the solution is a perfect match for the requirement, however each solution has got its advantages and disadvantages. Below table details out the same for log book and shift note/shift report SAP solution.
Log book | Details |
Pros | – In a single SAP transaction(screen), we can create log entries and carry it forward to its life cycle – Measurement counter can be automatically updated while saving the log entry with example code and functionality. – Log entries are managed through system status and user status control. – Log entries can be digitally signed – Log notification can be created for any notification types and can be linked to a log entry. |
Cons | – There is no BAPI to create log entries and functionalities of LBK1 can be transacted in SAP transaction screen. – Log entries can be created only with respect a functional location/EQPT. – A lot of BADIs need to be activated as SAP has not provided any standard fields. |
Shift Note/Shift Report | Details |
Pros | – Shift note/ report can be created for work centre as well as FLOC/EQPT. – Shift report is collated view of a shift and is a PDF which can be digitally signed – There are BAPIs available to create shift notes. – Shift report is flexible and configurable. – Shift report can link objects like Measuring document, notification and order, goods movement in a single output PDF. |
Cons | – Shift note is a special notification type of ‘General Notification’ category. Some functionalities of Maintenance notifications are not allowed – No BAPI is available for shift report creation. – Individual shift note don’t have much functionalities other than long text, attachment, shift timing control and link to reference objects. |