Enhancements of Message Monitoring in DOE

Transcription

1 SAP NetWeaver How-To Guide How to Enhancements of Message Monitoring in DOE Applicable Releases: SAP NetWeaver 7.3 and above Disclaimer : SAP Netweaver Mobile 7.3 is currently in Rampup Topic Area: Enhancements of message monitoring - SAP Netweaver Mobile This document aims to explain the new features available in message monitoring tool of SAP Netweaver Mobile administration and monitoring portal. This version of the product is current in ramp up. Capability: Mobile Author: Shruthi R Shruthi R is a member of the SAP NetWeaver Mobile development team for the past 5 years. Version 1.00 December 2010

2 Copyright 2009 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, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. IBM, DB2, DB2 Universal Database, OS/2, Parallel Sysplex, MVS/ESA, AIX, S/390, AS/400, OS/390, OS/400, iseries, pseries, xseries, zseries, z/os, AFP, Intelligent Miner, WebSphere, Netfinity, Tivoli, Informix, i5/os, POWER, POWER5, OpenPower and PowerPC are trademarks or registered trademarks of IBM Corporation. Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe Systems Incorporated in the United States and/or other countries. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C 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. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mysap, mysap.com, xapps, xapp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. These materials are provided as is without a warranty of any kind, either express or implied, including but not limited to, the implied warranties of merchantability, fitness for a particular purpose, or non-infringement. SAP shall not be liable for damages of any kind including without limitation direct, special, indirect, or consequential damages that may result from the use of these materials. SAP does not warrant the accuracy or completeness of the information, text, graphics, links or other items contained within these materials. SAP has no control over the information that you may access through the use of hot links contained in these materials and does not endorse your use of third party web pages nor provide any warranty whatsoever relating to third party web pages. SAP NetWeaver How-to Guides are intended to simplify the product implementation. While specific product features and procedures typically are explained in a practical business context, it is not implied that those features and procedures are the only approach in solving a specific business problem using SAP NetWeaver. Should you wish to receive additional information, clarification or support, please refer to SAP Consulting. Any software coding and/or code lines / strings ( Code ) included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or grossly negligent. Disclaimer Some components of this product are based on Java. Any code change in these components may cause unpredictable and severe malfunctions and is therefore expressively prohibited, as is any decompilation of these components. Any Java Source Code delivered with this product is only to be used by SAP s Support Services and may not be modified or altered in any way.

3 Document History Document Version Description 1.00 First official release of this guide

4 Typographic Conventions Type Style Example Text Example text Example text Example text <Example text> EXAMPLE TEXT Description Words or characters quoted from the screen. These include field names, screen titles, pushbuttons labels, menu names, menu paths, and menu options. Cross-references to other documentation Emphasized words or phrases in body text, graphic titles, and table titles File and directory names and their paths, messages, names of variables and parameters, source text, and names of installation, upgrade and database tools. User entry texts. These are words or characters that you enter in the system exactly as they appear in the documentation. Variable user entry. Angle brackets indicate that you replace these words and characters with appropriate entries to make entries in the system. Keys on the keyboard, for example, F2 or ENTER. Icons Icon Meaning Caution Note / Important Example Recommendation / Tip

5 Table of Contents 1. Business Scenario Prerequisites Step-by-Step Solution UI Enhancements for better usability New UI for showing the message contents in a single view Existing operations to work with this new UI Enhancing and inclusion of some new operations Other Links Copyright December

6 1. Business Scenario Enhancements to the Administration and Monitoring portal of DOE targets at improving the end user experience of DOE and reducing the TCO. The New UI adheres to the user interface standards and ideally reduces the waste of real estate of the screen and improves the user interface. The new UI also makes the navigation patters more identifiable and user friendly. During trouble shooting, the administrator searches for data which is unqiue and sometimes may lead tos cenarios where the adminstrator has no idea what he is exactly looking for. This may result in a search which is not unique and the adminsitrator may have to search through thousands of records before he finds the exact record he is looking for. The above usecase is handled in the new user interface of message monitoring where new functionalities have been provided to the administrator which he can use to perform his day to day activities which is simplified.. December

7 2. Prerequisites Required/recommended expertise or prior knowledge Administration and Monitoring of Data Orchestration Engine Message monitoring Troubleshooting Messages December

8 3. Step-by-Step Solution You will find the following topics being discussed in detail in the below sections UI enhancements for better usability New UI for showing the message contents in a single view Existing operations to work with this new view Enhancing and inclusion of some new operations December

9 3.1.1 UI Enhancements for better usability Navigation to message monitoring The User improvement has resulted in a change of path to access the new message monitoring user interface. A snapshot of the same is given below Search results and Details The search results of message monitoring are displayed in the same view. The following guidelines are used to display the search, search results and Details of search results. 1. The number of search results is displayed in the title of the table. This helps the administrator to determine the number of hits his search resulted in 2. Allow Select All in selection column only if there is an action that can apply to multiple selection 3. Allow default filtering to narrow down the number of results 4. Specify the selection of the search results in the details table in the table title/header December

10 . December

11 Master Detail Layout The Master Detail layout guideline captures the typical UI interaction paradigm followed by most expert administration applications and suggests standard UI layout for these uses cases Well-suited for Professional Applications which are used for the inspection and maintenance of simple structured administrative, monitoring, logging, and analytical tasks. The New user interface of message monitoring follows this paradigm. The Selected Data/field is dynamically displayed in the Header of the details table Provision to sort all the columns of the table is provided. Detail table displays a heading. Heading follows the norm of Details for Xyz or Details of Xyz or Details about Xyz. Information displayed in the table is not repeated in the details area. Only some key fields is repeated. The tables and detailed tables have the sorting option. The tables are ALV tables, so all features present in ALV tables are by default available in the message monitoring layout. December

12 Message handling Message are displayed in the in the corresponding message area defined the UI. The criteria for search is always dsiplayed to the user. December

13 3.1.2 New UI for showing the message contents in a single view The new UI creation is predominantlygovern by 2 guiding factors Reducing the no of clicks/ traversals required to execute the scenario Ensuring that the new Screen design doesn t force any additional complexity in execution of various operations supported in the current message monitoring Screen The following requirements are met in the new user interface that has been developed to reduce the time taken by the administrator for trouble shooting. 1. The entire message is displayed in a single view 2. It is possible to see the message in Full Screen mode hiding other unwanted elements of the Portal page and rendering only the message contents. 3. The hierarchical structure of the message body is maintained in the new view 4. It is possible to view more than one messages in the same view 5. While viewing multiple messages it is possible to pick messages from different or same Data Objects. 6. It is possible to expand and collapse individual node/messages in the view. 7. It is possible to Show or hide the fields displayed for the data object and save it as a search folder 8. It is possible to search for contents in the message 9. It is possible to export the contents of the message. December

14 10. It is possible to support View Messages of multiple version of Data objects. All operations shall be available for multiple versions. The message monitoring user interface is changed to ensure that the message details are viewed in the same view without navigations to other views as with the existing user interface. On click of the View Message button the message details for the selected message is displayed as shown below. The message details isshown as columns within a table. The first column displays the structure of the message with all the fields. The second column displays the value of the message received and persisted in the Message Store, The third column will displays CDS value of the message, the fourth column displays the modified message, the fifth column will be shown only when the end-user clicks on the Show Backend Data will display the data for that message in the BE system, the last column will display the message details as a PopIn UI element. December

15 More details about the message can be viewed on clicking the Message Details against each message. This view show a pop-in with the message details as shown below. The message details shown as pop-in are nothing but the message header details. December

16 3.1.3 Existing operations to work with this new UI Its utmost important that the new UI design doesn t compromise on the operations supported in the earlier releases and should enhance the execution of various operation utilizing the ease of use of new UI. As a result there is a change in the placement of these buttons from main page to the new Screen based on the agreed upon implementation. 1. It is possible to edit the contents of each field across nodes. 2. It is possible to reset the contents of each field across nodes. 3. It is possible to delete child node while browsing through the nodes. 4. It is possible to restart message from any place based on the selected message. i.e. there should be no re-selection of messages when restart is pressed. 5. It is possible to view the restart message history and visible in the same UI. 6. For the message Details and Receivers tabs, they are included in this new UI and it is possible to hide them and view them at the data object level of each message. The table will have a Toolbar to perform various operations on the selected messages. The toolbar will be as shown below Edit Messages There is an edit option provided which will enable the administrator to edit the messages that are received from the Client or the Backend. The edit functionality will enable the administrator to edit the fields as existed in the old View. However the edit button will only be displayed when an attribute of a particular node is selected. Whenever an attribute is selected and if that attribute is editable then the visibility of this context attribute will be set, so that the Edit button is visible and the administrator can edit the fields. Once a message is edited the administrator has to re-start the message to process the message Check Consistency There will be an option to check consistency of the messages at the message details level. The administrator can select the message from the message details and perform a consistency check Troubleshoot Message This functionality will display a troubleshooting document if any for the error code will be displayed Show CDS Data This functionality will show the CDS data for all the messages displayed in the message details view. By default the CDS will not be shown when the View Message button is clicked. Only on click of the Show CDS Data will the CDS data will be shown. December

17 ... How To Monitor and Tracking of DOE Show Backend Data This functionality will show the backend data for all the messages displayed in the message details view. By default the backend will not be shown when the View Message button is clicked. Only on click of the Show backend Data will the backend data be shown Comparison between Message received and CDS State When the messages received and the value of the CDS for a data object is different the difference will be made visible to the administrator. There will be an additional column which will display the same as not equal sign as shown below. This will be displayed for all the messages by default Status of the message A snap shot of the status icon is as shown below. The status should be shown only at the root node of the tree to indicate the overall status of the message. December

18 3.1.4 Enhancing and inclusion of some new operations The New UI provides a mechanism to not only ease the usage of current message monitoring UI but can also aid in adding additional capabilities which are always needed during day to day administration. The message monitoring main page View Message button click takes the user to detailed UI where it shows the selected messages as described above. It is possible to search for contents within the messages; this shall filter out the messages in which the value is present in at least one field of the message. It is possible to custom filter the fields of various nodes of a Data Object which shall be visible in the new UI, this helps in easy navigation to the searched contents and also reduces the page size when viewing multiple messages. This shall be saved as a configuration/search folder. It is possible to view messages of different sets of Data objects correspondning to different SWCV s in the same view It is possible to export the contents to an Excel file for the selected messages Restart messages The current re-start message functionality that exists to re-start selected messages in the user interface is a synchronous process. This process resulted in time when multiple messages are selected and re-started. To avoid the same, the re-start message functionality is now executed as a background process. -Status of message in the search result has been changed -Success/Error message which is more descriptive December

19 Filter fields The Tool bar will also have a new ToolBarPopin which is used to hide fields from the Message Details so that end-user can see only the fields that he/she desires to view. The ToolBarPopin will is visible only on click of the button with the text Filter Fields. The ToolBarPopin will have a table displaying the selected SWCV; Data Object fields so that the end-user can hide the fields that he/she desires. The SWCV s and data objects displayed will only be the SWCV s and data objects sfrom the message details. An example of the same is shown below Search for Message Details A free-style search input field is provided where the administrator can search for data within the fields of the message details displayed. The search will search for all the fields in the message details and will show only the messages which match the search results List of all Filters The filters will be displayed as a drop down, as shown below. The list of filters displayed will be only for the user who is logged into the DOE portal. When a filter is selected and the Apply Filter is clicked the filter will be applied to the message details. If the filter is not applicable to the message details this can happen when the filter was created for a set of Data Objects and those data objects are not present in the message details then a warning message stating that the filter cannot be applied is displayed Multi Version handling of Message Details It is possible that the messages send from the client use a different version of the active data object in the DOE. This is possible in case there are multiple versions of the applications used by devices and a device is still using an older version of the data object. In such cases the message details will ensure that it displays the message details correctly. December

20 Deletion of Child Nodes It is possible to delete child node instances of a message. It can some times happen that child instances inserted in the Client (for example) are rejected by the Backend in such cases it might be required to delete child instances and reprocess the message. The deletion of child instances will result in deleting the child instances and also restarting the message. Only on selection of the child instance should the Delete button be visible. When the administrator deletes the child instance a warning message as shown below will be displayed Multiple messages of different Data objects Multiple messages of different data objects belonging to different SWCV s is possible in the new user interface. This drastically reduces the TCO by reducing the number of clicks to troubleshoot and helps the administrator to troubleshoot effectively Export Message Contents Export the contents to an Excel file for the selected messages is possible. December

21 4. Other Links Mobile Articles : Administration and Monitoring Overview: < December

22 5. Copyright Copyright 2009 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, Excel, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. IBM, DB2, DB2 Universal Database, System i, System i5, System p, System p5, System x, System z, System z10, System z9, z10, z9, iseries, pseries, xseries, zseries, eserver, z/vm, z/os, i5/os, S/390, OS/390, OS/400, AS/400, S/390 Parallel Enterprise Server, PowerVM, Power Architecture, POWER6+, POWER6, POWER5+, POWER5, POWER, OpenPower, PowerPC, BatchPipes, BladeCenter, System Storage, GPFS, HACMP, RETAIN, DB2 Connect, RACF, Redbooks, OS/2, Parallel Sysplex, MVS/ESA, AIX, Intelligent Miner, WebSphere, Netfinity, Tivoli and Informix are trademarks or registered trademarks of IBM Corporation. Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe Systems Incorporated in the United States and/or other countries. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C 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, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP Business ByDesign, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries. Business Objects and the Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Business Objects S.A. in the United States and in other countries. Business Objects is an SAP company. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. December

23