Create an Input Parameter in a Graphical View

Create an input parameter to prompt the user to enter a value for use in filtering or other calculations when the view is run. If the view is consumed in an SAP Analytics Cloud story the user will be prompted to enter a value for the input parameter in the Set Variables dialog.

Context

You can use input parameters when creating graphical and SQL views:

  • In the graphical view editor, you can use input parameters to require user input in any sql expression, including those used in filter, calculated columns, and aggregation nodes.

  • In the SQL view editor, you can use input parameters in your WHERE clause or anywhere else in your SQL code.

Views that contain input parameters require special treatment in the following situations:

  • Previewing data - Accept the default value, if one is provided, or enter a value for each input parameter (see Viewing Object Data).

    You cannot view data in an SQL view if any of its sources is shared from another space and has an input parameter.

  • Adding a view as a source for a graphical view - Map each input parameter in the source view to a value or an input parameter in the new view (see Add a Source to a Graphical View).

  • Adding a view as a source for a SQL view - Complete the syntax to map each input parameter in the source view to a value or an input parameter in the new view (see Process Source Input Parameters in an SQL View).

  • Adding a table as a source for an analytic model - Map each input parameter in the source table to a variable in the model (see Create a Variable in an Analytic Model).

  • Consuming view data via the OData API - Set a value for each input parameter using the (<param>='<val>'[,...])/Set syntax (see Consuming Data via the OData API).

  • Using a view as a data source in an SAP Analytics Cloud story - Enter a value for each input parameter in the Set Variables dialog (see Setting Story Variables in the SAP Analytics Cloud Help Library).

Procedure

  1. Select the output node of your view to display its properties in the side panel, scroll down to the Input Parameters section, and click (Input Parameters).
  2. In the Input Parameters dialog, click (Add) to create a new parameter.
  3. Complete the properties of the input parameter:

    Property

    Desription

    Business Name

    Enter a descriptive name to help users identify the object. This name can be changed at any time.

    Technical Name

    Displays the name used in scripts and code, synchronized by default with the Business Name.

    To override the default technical name, enter a new one in the field. Technical names can contain only alphanumeric characters and underscores.

    Data Type

    Specify the type of data that the input parameter will contain (see Column Data Types), and which should be appropriate for the contexts in which it will be used. Some data types require you to specific a length and or precision.

    Default Value

    [optional] Enter a default value for the input parameter. Each time that a user is required to enter a value for the parameter, they can accept the default value or override it with their own chosen value.

    Default Value Help

    Define if your input parameter needs a default value help or not:

    • If not, select No Value Help.

    • If yes, select Predefined Value from an Object. The predefined value comes from an attribute from any table or view of the type dimension. Once this option is selected, you must define:

      1. Object: Click to open the Add Objects dialog. Select an object among the list of available items and click Add Object.

      2. Column: Click to open the Value Help Dialog and see the list of available columns from which you want to propagate the default value.

    All records are loaded by default. You can see more by using the Search bar or scrolling down. You may experience performance issues if too many records are to be loaded.
  4. Click OK to close the dialog and return to the side panel, where the input parameter is available for use.
    The output symbol displays the number of input parameters present in the view. In this example, the source view and output view both contain two input parameters::
  5. Use the input parameter as appropriate in your view:
    • In graphical views, input parameters can be used in the following nodes:

      Example

      Description

      Country = :IP_Country

      Filter node (see Filter Data in a Graphical View)

      This filter expression takes the value entered by the user for IP_Country and uses it to restrict the data returned by the view to only those rows where the Country column contains this value.

      Total*((100-IP_Discount)/100)

      Calculated Columns node (see Create a Calculated Column in a Graphical View)

      This expression will fill the column with a value calculated by taking the value in the Total column and deducting the percentage value entered by the user.

      SUM(Revenue) >IP_Min_Rev

      Aggregation node (see Aggregate Data in a Graphical View)

      This HAVING expression will limit the values aggregated to only those with a total Revenue over the value entered by the user.

    • In SQL views, input parameters can be used in your WHERE statement and any other appropriate context.

      In this example, two input parameters are defined and used:

      • IP_DISCOUNT - is used to calculate the new column, Discounted Sale.

      • IP_CITY - is used in the WHERE clause to prompt the user to specify a city to filter on.

      SELECT "ID",
	"Date",
	"City",
	"Product",
	"Customer",
	"Net Sale",
	"Gross Sale",
	"Quantity",
	"Net Sale" * ((100 - :IP_DISCOUNT) / 100) AS "Discounted Sale"
FROM "Sales"
WHERE "City" = :IP_CITY