Start of Content Area

Object documentation Filter Locate the document in its SAP Library structure

Definition

Filter is a command for a data provider in the Web template.

Use

Filter values can be set for characteristics and structures for a data provider. When calling the command you can set several filters for the same characteristic/structure, or the same filter for several different characteristics/structures. Filter is a generic command, which means you do not have to set the ‘CMD’ parameter.

Note

The filter parameters can be added to any command, with the exception of calling the variable screen and changing the values of variables.

The actual filtering process is carried out at the end of the operation.

Note

In the internal display (see table below) you can easily determine the name of the characteristic and the filter value using the URL parameter &snippet_operations=%20 (see also Object Tag for the Properties of Web Templates). Call the Web application with this URL parameter. If you filter using the context menu, the parameters FILTER_IOBJNM and FILTER_VALUE are automatically added to the URL in the Web browser. You can then use the desired values with Command URLs in hyperlinks.

Structure

Parameter

Description

FILTER_IOBJNM

FILTER_IOBJNM_N (optional)

 

Name of the characteristic / structure by which the system is to filter

Specify the technical name of the characteristic (for example, 0COUNTRY) or the structure (25 characters)

FILTER_COLLAPSE (optional)

 

 

‘X’ = Yes, ‘  ’ = No

Removing filter characteristics from the drilldown

The characteristics that are specified under FILTER_IOBJNM are taken from the axes after the filter has been applied. If you do not specify the parameters, the system assumes you want to use the value ‘X’ = Yes.

FILTER _SIGN_N (optional)

Row properties

'I' found values are added,

 'E' found values are removed.

Note

If the parameter is not specified, then the system assumes you want to use the value 'I'.

Note

If FILTER_IOBJNM_N is not specified for index n, the value from FILTER_IOBJNM is used, if available.

For filtering individual values, the following parameters are also specified:

Parameter

Description

FILTER_VALUE

FILTER_VALUE_N

FILTER_VALUE_EXT

FILTER_VALUE_EXT_N

 

Filter Value

Value, by which the system is to filter.

Note

If the variant with ending 'EXT' is selected, the fully compounded value has to be entered in the external format, for example, 24.12.2000.

If the ending 'EXT' is not used, the fully compounded value has to be entered in the internal format, for example, 20001224 for 24.12.2000.

FILTER_VALUE_TYPE (optional)

FILTER_VALUE_TYPE_N (optional)

Type of value specified under FILTER_VALUE

‘VALUE’ : Characteristic value key

'VARIABLE_EXIT' : Exit variable name. The filter is set using the values returned by the variable exit. Parameter, interval, and selection option variables are allowed for customer and SAP exit variables, as well as for default values.

FILTER_OPERATOR (optional)

FILTER_OPERATOR_N (optional)

An operator

'EQ' = Individual value

'LT' = Less than

'LE' = Less than or equal to

'GT' = Greater than

'GE' = Greater than or equal to

Note

If no operator is specified, then the system assumes you want to use the value 'EQ'.

The following parameters are also accepted for filtering intervals:

Parameter

Description

FILTER_VALUE_LOW

FILTER_VALUE_LOW_N

FILTER_VALUE_LOW_EXT

FILTER_VALUE_LOW_EXT_N

 

Filter value – lower limit (not compounded)

 

FILTER_VALUE_HIGH

FILTER_VALUE_HIGH_N

FILTER_VALUE_HIGH_EXT

FILTER_VALUE_HIGH_EXT_N

 

Filter value – upper limit (not compounded)

 

The following parameters are also accepted for filtering hierarchy nodes:

parameter

Description

FILTER_VALUE

FILTER_VALUE_N

 

Hierarchy node name

FILTER_NODE_IOBJNM (optional)

FILTER_NODE_IOBJNM_N (optional)

Node characteristic name

This parameter must be specified if the system filters by hierarchy nodes. The characteristic name has to be specified for characteristic nodes and for text nodes (0HIER_NODE).

Examples

Filter Data Provider ’View1’ by Country: Germany

<SAP_BW_URL DATA_PROVIDER='View1' FILTER_IOBJNM='0COUNTRY' FILTER_VALUE='DE'>

Filter Data Provider ’View1’ by First 3 Months

<SAP_BW_URL DATA_PROVIDER='View1' FILTER_IOBJNM='0CALMONTH' FILTER_VALUE_LOW_EXT='1' FILTER_VALUE_HIGH_EXT='3'>

Filter All Data Providers by Costs and Countries: Germany and USA

<SAP_BW_URL DATA_PROVIDER='*' MULTI='X' FILTER_IOBJNM_1='DRB9ZVVMBCHVX4F04Z1JGKYVC' FILTER_VALUE_1='DTG057U7OQ8K2ALKCMR2AWM14' FILTER_IOBJNM_2='0COUNTRY' FILTER_VALUE_2='DE' FILTER_IOBJNM_3='0COUNTRY' FILTER_VALUE_3='US'>

Filter All Data Providers by Current Month

<SAP_BW_URL DATA_PROVIDER='*' MULTI='X' FILTER_IOBJNM='0CALMONTH' FILTER_VALUE='0CMONTH' FILTER_VALUE_TYPE='VARIABLE_EXIT'>

 

End of Content Area