1927414 - Improvements for Modification of IPC JSP UI

3
SAP Note Header Data Symptom You face one of the following issues when trying to modify the configuration user interface (IPC JSP UI) of release 7.0 and higher: 1. You want to modify data and/or logic in the integration of the DynamicUI-Framework and the UI-Bean-layer without changing the SAP standard code. User exits are not available. 2. You want to modify JavaServerPages (JSP) and you need access to objects of the configuration runtime. Configuration objects are not accessible in the JSP-layer. Other Terms IPC JSP UI, Configuration UI, User Exits, MergeVisitor, Code Improvements Reason and Prerequisites User exits were not available and access to configuration objects was not possible in the JSP-layer. Solution User-Exits User-exits have been added for each UI-element in their corresponding visit()-method in the MergeVisitor class. The methods are: l visit(InstanceUIBean) l visit(GroupUIBean) l visit(CharacteristicUIBean) l visit(ValueUIBean) The user-exits have been typically added in these points in the methods: l After the framework object has been created for the first time. l After iterating through the object list to update all framework objects. l Before processing sub element of that UI element. All user-exits pass the corresponding UI-bean and the DynamicUI-Framework object as the parameters. The user-exits can be used by extending the MergeVisitor class and implementing the needed user-exit-methods. Furthermore the UIBeanFactory class (package com.sap.isa.ipc.ui.jsp.beans) needs to be extended and the method newMergeVisitor (IPCUIModel uiModel, UIContext uiContext, PageContext pageContext) has to be implemented so that an instance of the extended MergeVisitor class is returned. The extended UIBeanFactory class has to be registered in factory-xml. Access to configuration objects on JSPs DynamicUI-Framework objects now contain references to the corresponding UI-Bean objects. In order to modify/create custom JSPs, it is useful to be able to access UI-Bean objects from the corresponding DynamicUI-Framework objects. This has now been added. Every Dynamic UI Framework element now contains the UI-Bean-object as well as getter- and setter-methods to access them. The UI-Beans are set into the DynamicUI-Framework objects during its creation in the MergeVisitor class. Changed/Added files This note contains Java Correction(s) for the IPC JSP UI. Software component: sap.com_SAP-SHRJAV Development Component: sap.com/crm/ipc/ipc Changed Files: l com/sap/isa/ipc/ui/jsp/dynamicui/IPCPropertyGroup.java l com/sap/isa/ipc/ui/jsp/action/visitor/MergeVisitor.java 1927414 - Improvements for modification of IPC JSP UI Version 4 Validity: 17.10.2013 - active Language English (Master) Released On 17.10.2013 13:35:48 Release Status Released for Customer Component CRM-BF-CFG Product Configuration Priority Correction with medium priority Category Exit added

description

1927414 - Improvements for modification of IPC JSP UI.pd

Transcript of 1927414 - Improvements for Modification of IPC JSP UI

  • SAP Note

    Header Data

    Symptom

    You face one of the following issues when trying to modify the configuration user interface (IPC JSP UI) of release 7.0 and higher:

    1. Youwanttomodifydataand/orlogicintheintegrationoftheDynamicUI-Framework and the UI-Bean-layer without changing the SAP standard code. User exits are not available.

    2. You want to modify JavaServerPages (JSP) and you need access to objects of the configuration runtime. Configuration objects are not accessible in the JSP-layer.

    Other Terms

    IPC JSP UI, Configuration UI, User Exits, MergeVisitor, Code Improvements

    Reason and Prerequisites

    User exits were not available and access to configuration objects was not possible in the JSP-layer.

    Solution

    User-Exits

    User-exits have been added for each UI-element in their corresponding visit()-method in the MergeVisitor class.

    The methods are:

    l visit(InstanceUIBean) l visit(GroupUIBean) l visit(CharacteristicUIBean) l visit(ValueUIBean)

    The user-exits have been typically added in these points in the methods:

    l After the framework object has been created for the first time. l After iterating through the object list to update all framework objects. l Before processing sub element of that UI element.

    All user-exits pass the corresponding UI-bean and the DynamicUI-Framework object as the parameters. The user-exits can be used by extending the MergeVisitor class and implementing the needed user-exit-methods.

    Furthermore the UIBeanFactory class (package com.sap.isa.ipc.ui.jsp.beans) needs to be extended and the method newMergeVisitor(IPCUIModel uiModel, UIContext uiContext, PageContext pageContext) has to be implemented so that an instance of the extended MergeVisitor class is returned. The extended UIBeanFactory class has to be registered in factory-xml.

    Access to configuration objects on JSPs

    DynamicUI-Framework objects now contain references to the corresponding UI-Bean objects. In order to modify/create custom JSPs, it is useful to be able to access UI-Bean objects from the corresponding DynamicUI-Framework objects. This has now been added. Every Dynamic UI Framework element now contains the UI-Bean-objectaswellasgetter- and setter-methods to access them. The UI-Beans are set into the DynamicUI-Framework objects during its creation in the MergeVisitor class.

    Changed/Added files

    This note contains Java Correction(s) for the IPC JSP UI.

    Software component: sap.com_SAP-SHRJAV Development Component: sap.com/crm/ipc/ipc Changed Files:

    l com/sap/isa/ipc/ui/jsp/dynamicui/IPCPropertyGroup.java l com/sap/isa/ipc/ui/jsp/action/visitor/MergeVisitor.java

    1927414 - Improvements for modification of IPC JSP UI

    Version 4 Validity: 17.10.2013 - active Language English (Master)

    Released On 17.10.2013 13:35:48 Release Status Released for Customer Component CRM-BF-CFG Product Configuration Priority Correction with medium priority Category Exit added

  • l com/sap/isa/ipc/ui/jsp/action/visitor/UserExitDefinition.java l com/sap/isa/ipc/ui/jsp/dynamicui/IPCAllowedValue.java l com/sap/isa/ipc/ui/jsp/dynamicui/IPCProperty.java l com/sap/isa/ipc/ui/jsp/dynamicui/IPCUIComponent.java

    Please implement the SP Patch Level attached to this note by obtaining the patch from the SAP Service Marketplace. For more information on patching the IPC Web Application (IPC JSP UI) refer to note 1686175.

    Validity

    Causes - Side Effects

    Software Component From Rel. To Rel. And Subsequent

    SAP-CRMJAV 700 700

    701 701

    702 702

    731 731

    730 730

    732 732

    733 733

    SAP-CRMWEB 700 700

    701 701

    702 702

    731 731

    730 730

    732 732

    733 733

    SAP-SHRWEB 700 700

    701 701

    702 702

    731 731

    730 730

    732 732

    733 733

    SAP-SHRJAV 700 700

    701 701

    702 702

    731 731

    730 730

    732 732

    733 733

    SAP-CRMAPP 700 700

    701 701

    702 702

    731 731

    730 730

    732 732

    733 733

    SAP-SHRAPP 700 700

    701 701

    702 702

    731 731

    730 730

    732 732

    733 733

    Notes / Patches corrected with this note

    Note Reason From Version To Version Note Solution Version Support Package The table does not contain any entries

    The following SAP Notes correct this Note / Patch

    Note Reason From Version To Version Note Solution Version Support Package

    1927414 0 0 1949372 1

  • Support Packages & Patches

    References

    This document refers to:

    SAP Notes

    This document is referenced by:

    SAP Notes (2)

    Support Package Patches

    Software Component Support Package Patch Level

    CRM JAVA APPLICATIONS 7.0 SP012 000045

    CRM JAVA APPLICATIONS 7.01 SP009 000045

    CRM JAVA APPLICATIONS 7.02 SP004 000056

    CRM JAVA APPLICATIONS 7.30 SP012 000046

    CRM JAVA APPLICATIONS 7.31 SP009 000048

    CRM JAVA APPLICATIONS 7.32 SP004 000046

    CRM JAVA COMPONENTS 7.0 SP012 000045

    CRM JAVA COMPONENTS 7.01 SP009 000045

    CRM JAVA COMPONENTS 7.02 SP004 000056

    CRM JAVA COMPONENTS 7.30 SP012 000046

    CRM JAVA COMPONENTS 7.31 SP009 000048

    CRM JAVA COMPONENTS 7.32 SP004 000046

    CRM JAVA WEB COMPONENTS 7.0 SP012 000045

    CRM JAVA WEB COMPONENTS 7.01 SP009 000045

    CRM JAVA WEB COMPONENTS 7.02 SP004 000056

    CRM JAVA WEB COMPONENTS 7.30 SP012 000046

    CRM JAVA WEB COMPONENTS 7.31 SP009 000048

    CRM JAVA WEB COMPONENTS 7.32 SP004 000046

    SAP SHARED JAVA APPLIC. 7.0 SP012 000045

    SAP SHARED JAVA APPLIC. 7.01 SP009 000045

    SAP SHARED JAVA APPLIC. 7.02 SP004 000056

    SAP SHARED JAVA APPLIC. 7.30 SP012 000046

    SAP SHARED JAVA APPLIC. 7.31 SP009 000048

    SAP SHARED JAVA APPLIC. 7.32 SP004 000046

    SAP SHARED JAVA COMP. 7.01 SP009 000045

    SAP SHARED JAVA COMP. 7.02 SP004 000056

    SAP SHARED JAVA COMP. 7.30 SP012 000046

    SAP SHARED JAVA COMP. 7.31 SP009 000048

    SAP SHARED JAVA COMP. 7.32 SP004 000046

    SAP SHARED JAVA COMP. 7.33 SP000 000007

    SAP SHARED JAVA COMPONENTS 7.0 SP012 000045

    SAP SHARED WEB COMPONENTS 7.0 SP012 000045

    SAP SHARED WEB COMPONENTS 7.01 SP009 000045

    SAP SHARED WEB COMPONENTS 7.02 SP004 000056

    SAP SHARED WEB COMPONENTS 7.30 SP012 000046

    SAP SHARED WEB COMPONENTS 7.31 SP009 000048

    SAP SHARED WEB COMPONENTS 7.32 SP004 000046

    1881862 Issues when modifying IPC JSP UI

    2009761 IPC JSP UI Extension Guide 2038822 Better modification of actions in IPC JSP UI