Selection Compontent – Search UI Building Block with ... · Using the Selection Screen ( 1) –...

Analytic Reuse Components for Floorplan Manager Selection Compontent – Search UI Building Block with Analytic Feeder Class Products & Solutions / SAP Business Suite Continuous Innovation / Foundation September 2011

Hierarchy Value Help Configuration / Customizing

Selection Variants

Overview Selection


© 2011 SAP AG. All rights reserved. 4 Confidential

Search UIBB with Analytic Feeder Class

The Search UIBB with analytic feeder class allows to enter variable values for analytic queries.

Typically this is being used as a selection screen to parameterize other analytical components of an WebDynpro application such as an Analytic List UIBB or a Analytic Chart UIBB.

The Search UIBB can expose variables of one or several analytic queries.

Users can save user specific selection variants they want to reuse. These variants do not only contain variable values but can also be used to hide variables which are not relevant.

Pressing ‘Execute’ launches the analytic query with the selected variable values.

The application controller of a WebDynpro application may contain logic, when to display the Search GUIBB. In the delivered Analytic List application the ‘Selection’ is for example only offered if the selected query contains (a) variables which are mandatory and not prefilled or (b) only optional variables and none of them is prefilled.

Configuration / Customizing

Basic Tips for Selection

Hierarchy Value Help

Prerequisites and Technical Background

Selection Variants

Overview Selection



Using the Selection Screen (1) – Adding and Removing Selection Criteria

The selection initially offers all variables defined in the query. If variable values are already pre-set in the analytic query or parameterized e.g. via parameter handover, the variables are offered with this initial values in the selection.

The initial sequence of the variables corresponds to the definition in the analytic query.

To change the sequence, you can use the dropdown menu on the variable. You can also remove a variable by pressing the ‘-’ icon and adding the variable in a different place by pressing the ‘+’ icon and selecting the respective variable in the occurring new line.

In the dropdown menu of each variable field, in principle always all variables of the related analytic queries are offered. However if a variable allows only a single value, it occurs in the dropdown menu only, if it has not been selected already.

Pressing ‘Hide Selection Criteria’ you can show selection variants only.


Using the Selection Screen (2) – Calling Value Help

In the entry field you can either directly enter variable values or use the search help to find suitable values.


Using the Selection Screen (3) – Features of Value Help

On the value help screen menu,

You can display additional search criteria (e.g. attributes of a characteristic)

You can show and maintain a personal value list

You can set your preferences, e.g. whether you want initially display the personal value list, or all values


Using the Selection Screen (4) – Searching by Attributes of a Characteristic 1. Open the value help for a characteristic

2. On the value help screen displaying characteristic values, press “Show Search Criteria”.

3. Attributes of the characteristic will be offered as additional search criteria.

Use case: This helps to find characteristic values with certain attribute values (e.g. all materials of a certain material group, provided by a certain business partner).


Using the Selection Screen (5) – Selection Operators

The selection of an operator allows you to define the ‘type’ of the value selection (e.g. whether you want to define a single value, a range, etc. for the variable).

The possible operators depend on the type of the variable, determined in the variables definition in the analytic query. Only appropriate operators are offered. This avoids selections which can’t be handled by the analytic query afterwards.

Depending on the selected operator, additional fields may occur. For example for variables representing an interval the operator ‘is between’ will be offered. When this operator is selected, an additional field is offered to enter the upper value of the interval.


Using the Selection Screen (6) – Maintain Multiple Values

To maintain multiple values, you can add additional variable selection fields by clicking the ‘+’ icon.

An additional line is inserted, prefilled with the variable of the line you clicked the ‘+’.

You can then either enter additional values for this variable, or change the variable to be restricted.

Only those variables are offered in additional lines, which are possible due to the variable definition in the analytic query (e.g. a variable representing a single value can occur only in one line).

The selected line is deleted by clicking the ‘-’ icon. This allows to display only variables which are relevant for your selection. You can add a removed variable again by adding a new line and selecting the respective variable in the dropdown menu.


Using the Selection Screen (7) – Excluding Values

Clicking ‘Add Criteria To Exclude’ enables you to maintain negative selections as well. (Availability of this button depends on customizing settings.)

Excluding values works only for variables representing a ‘Selection option’.

Selection Variants


Searching by Attributes of a Characteristic


Operators on Selection Screen - Implemented Logic

Overview Selection




Prerequisite - How to get Selection Criteria

In the query definition in the BEx Query Designer a variable has to be assigned to the characteristic. When the variable is set Ready for Input an input field for entering variable value(s) will be generated in the selection area at runtime. Possible default value(s) of the variable will be displayed and can be overwritten by the user.


Prerequisite - How to Enable Selection of Multiple Values

Adding a new line by pressing ‚+‘ on a multiple value variable will add a new line for the same variable. The drop down value help offers only those variables which either support multiple value selection or variables which do not yet occur in the selection screen.

If a variable in the BEx Query Designer is set to Several Single values or Selection Option a selection of multiple values using multiple selection fields will be supported.


Prerequisite - How to Enable Excluding Selections

If the variable in the BEx Query Designer is set to Selection Option the „Exclude from Results“ area is displayed. Here you can restrict variable values. (A prerequisite is that the option „Exclude Criteria“ is set in the General Settings of the compontent configuration of FPM_SEARCH_UIBB.)

Selection Variants





Overview Selection




Operators on Selection Screen – Depending on Type of Variable and Characteristic in BW

In order to provide users with certain selection operators please obey the implementation logic

on the following slides.


Variable Type

Characteristic Type Dynamic Filter

Possible Operators

Characteristic Value

Characteristic Unit of Measure Data packet characteristics

"is” "is empty”

Time unit "is"

Hierarchy "is” "is empty"

Hierarchy Node

"is" "is empty"

Text Variable "is"

Formula "is”

Operators on selection screen


Variable Type


Possible Operators



"is" "is empty"

Time unit "is"

Hierarchy Node "is" "is empty"



Variable Type


Possible Operators



"is" "is empty" "is between"

Time unit "is" "is empty" "is between"



Variable Type


Possible Operators



yes

"is" "is empty" "is between" "is greater than" "is less than" "is greater than or equal to" "is less than or equal to"

no

"is" "is not" "is empty" "starts with" "contains" "is between" "is greater than" "is less than" "is greater than or equal to" "is less than or equal to"

Time unit

"is" "is empty" "is between" "is earlier than" "is later than" "is earlier than or on" "is later than or on"


Selection Variants



Technical Background


Overview Selection





1. Open the value help for a characteristic

2. On the value help screen displaying characteristic values, press “Show Search Criteria”.

3. Attributes of the characteristic will be offered as additional search criteria.

Use case: This helps to find characteristic values with certain attribute values (e.g. all materials of a certain material group, provided by a certain business partner).


Prerequisite - How to get Searchable Attributes

Attributes of the characteristic with maintained “Order for F4 Help” will be offered as additional search criteria.

Prerequisite is that in the maintenance of the characteristic attributes (e.g. transaction RSD1) the “Order for F4 Help” has been maintained for the attribute. (Value “0” indicates that the attribute will not be shown as search criteria.)


Selection Variants

Overview Selection



A set of displayed variables with entered values can be saved as ‘Variant’.

To do so, enter the values, the name of the variant and press ‘Save Variant As’. Also variables without value selection can be part of a variant.

The saved variant is user and query specific, so next time the same analytic query is called by the same user, all variable values can be set via selecting the variant.

Selection variants can also differ in the number of displayed selection variables (you may define a standard selection variant with only the most important selection variables and other variants with more selection variables for more detailed selections).

Selection Variants

1. Delete Criteria not needed for selection.

2. Set default values for criteria.

3. Save criteria with default values as variant.

4. Use selection variant when calling the query again.


Selection Variants


Hierarchy Value Help Handling of Hierarchy Value Help

Overview Selection



Purpose of Hierarchy Value Help

Characteristics can be configured to contain hierarchies. This means that characteristic values can be organized in a hierarchical structure. For example materials can be organized in a material group hierarchy. The material groups represent hierarchy nodes and a single material represents a leaf in the hierarchical structure. Purpose of hierarchy value help is to make hierarchical information available during value selection. For example single values can be found and selected by traversing the hierarchy. Selection of hierarchy nodes is also possible.

Material Group Single Materials


Hierarchy Value Help in the Selection UI

Depending on characteristic configuration and query definition, selection UI may offer selection fields for following hierarchy related properties Hierarchy Name

• A characteristic may have several different hierarchies assigned that are identified by name

Hierarchy Version • There is the possibility to define several versions per hierarchy

Hierarchy Node • Value of selected hierarchical node. For example specific material group

Hierarchy Date • The date for which time dependent hierarchical information should be evaluated

Each hierarchy related selection field is supported by a specific value help


Selection Variants



Overview Selection



Hierarchy Value Help - Hierarchy Name Variable

This selection appears, if a hierarchy variable is modeled in the query and not restricted to a fix value Pressing the value help icon opens a dialog-box showing the available hierarchies that have been defined for the characteristic

Select hierarchy name and press O.K.


Hierarchy Value Help - Hierarchy Version Variable

Pressing the value help icon opens a dialog-box showing the available hierarchy versions that have been defined for the characteristic.

Select a version and press O.K.


Value Help for Hierarchy Node Variable – History Tab (1)

Clicking “Search in Selected Subtree” opens "Search" tab and uses selected entry to restrict scope of search.

Pressing “Show Selected Node in Hierarchy” opens the "Browse Hierarchy" tab and shows selected entry in the hierarchy

The header area contains general hierarchy related information.

Pressing the value help icon opens a dialog-box allowing to search and select hierarchy elements in a varying manner.

The tab with a personal history contains a list of previously selected hierarchy nodes. This tab is shown by default. .


Select an entry and press O.K. to transfer the value to the variable field.

Value Help for Hierarchy Node Variable – History Tab (2)

Clicking Details opens a dialog-box containing information about hierarchy node info object and hierarchical path


Value Help for Hierarchy Node Variable– Browse Hierarchy Tab

The “Browse Hierarchy” tab displays a hierarchical list showing

nodes and leaves of the hierarchy allows to select a single node or leaf



Value Help for Hierarchy Node Variable – Search Tab

Search term (use of '*' possible but not needed).

Choose radio button to perform search in master data attributes.

Choose radio button to perform search in hierarchical structure.

Specify whether search should be executed in characteristic value key or description or both

Restricts search to specified hierarchy node and its sub-nodes (Hierarchy node value can be transferred from 'History' or 'Browse Hierarchy' tab to this field by using button 'Search in Selected Subtree‘)

The “Search” tab allows to search in hierarchical

structure using a search pattern allows to search in master data

attributes



Hierarchy Value Help - Hierarchy Date Selection

Selected date will determine matching time dependent hierarchy information

Whole hierarchy could be time dependent

Hierarchy structure could be time dependent


Selection Variants



Overview Selection



Prerequisite - Hierarchy Settings for Characteristic

Choose hierarchy tab

Settings for version and time dependency

Controls availability of hierarchies Access hierarchy

definitions (details on next slide)

Prerequisite for the hierarchy value help is the maintenance of hierarchy properties of the characteristic (e.g. in SAP GUI transaction 'RSD1')


Prerequisite - Hierarchy Settings for Characteristic Maintain Hierarchies

Technical hierarchy name

Two versions for the same hierarchy name

Time dependency of the hierarchies


Prerequisite - Hierarchy Settings for Characteristic Definition of Hierarchy Structure

Double Click on selected hierarchy opens a window with the definition of the hierarchy structure


Prerequisite - Hierarchy Node Variable in BEx Query Designer (1)

Right-click on characteristic you want to maintain hierarchy node variable for and choose 'Restrict' from the context menu


Prerequisite - Hierarchy Node Variable in BEx Query Designer (2)

3. Assign hierarchy node variable

2. Maintain Detail view for hierarchy node variable

1. Create or change hierarchy node variable


BEx Query Designer – Hierarchy Name, Hierarchy Version and Hierarchy Date Variables

1. Choose characteristic in filter or rows/columns area

2. Choose hierarchy tab in properties area

3. Choose F4-help icon to display hierarchy properties

4. Set fixed values or variables for hierarchy properties

Choose F4-help icons to access variable settings

Starting from the characteristic properties you can also maintain the hierarchy specific properties such as hierarchy name, hierarchy version and hierarchy date. Both, fixed values and variables as well can be used.


Selection Variants

Overview Selection



Basic Configuration / Customizing – How to Add Search UIBB to an Application - Part 1

1. Add an ‘Search Component’ to your FPM application (e.g. FPM OVP page).

2. A new UIBB is added to your FPM OVP page. The component name and the window name are preselected.



3. Enter a name for the Search UIBB configuration (Configuration Name) and a title.

4. Choose ‘Configure UIBB’ to create the configuration.

6. Create the new Search UIBB configuration.

5. Save your FPM component configuration.


Basic Configuration / Customizing – How to Add Search UIBB to a Application - Part 3

7. Enter a description.

8. Select a package and a transport request if necessary.



9. Select the analytic feeder class (CL_BS_ANLY_LIST_SEARCH_FEEDER) and click “Edit Parameters”.

10. At least enter one analytic query for which variables shall be displayed in the Search UIBB.

11. In case of operational planning you may enter Filters, Planning Functions and Planning Sequences if used for the query.

12. For each parameter there is the option of entering multiple values in a table.


Basic Configuration / Customizing of Search Component

In the Customizing of the Search UIBB you can e.g. set the visibility of buttons and enable or disable functions like saving search variants or excluding search criteria.

To enter the configuration/customizing select the search component and press the Configure UIBB button


Value Help for Hierarchy Node Variable Format of Chosen Values

Hierarchy node value that has been chosen in value help Value in brackets indicates the technical name of the info

object of the hierarchy node The info object name is omitted, if it is a leaf has been selected.


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 and Java are registered trademarks of Oracle and/or its affiliates. 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.

© 2011 SAP AG. All rights reserved.

SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP BusinessObjects Explorer, StreamWork, 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 Software Ltd. Business Objects is an SAP company.

Sybase and Adaptive Server, iAnywhere, Sybase 365, SQL Anywhere, and other Sybase products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Sybase, Inc. Sybase 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.

The information in this document is proprietary to SAP. No part of this document may be reproduced, copied, or transmitted in any form or for any purpose without the express prior written permission of SAP AG.

Selection Compontent – Search UI Building Block with ... · Using the Selection Screen ( 1) –...

Documents

Transcript of Selection Compontent – Search UI Building Block with ... · Using the Selection Screen ( 1) –...