Using Custom Data Items in a Query

About Custom Data Items

When a data source does not contain a calculation that you want to use in a query, you can use the measures that are contained in the data source to create a custom data item. There are two types of custom data items that you can create:
  • You can use one or more measures in a selected data source to create a new calculation. For example, you could create a custom data item called Profit, which is created by using this expression: [Revenue]-[Cost], where Revenue and Cost are measures in a data source. You also could create this expression: [Total_Retail_Price] / 1000000, where Total_Retail_Price is the measure divided by 1 million. For more information, see Create a Custom Data Item By Entering an Expression.
  • If your query includes a time hierarchy from a multidimensional data source, then you can create a custom data item that is based on relative time. For example, you might create these expressions: Percent change (parallel periods)[Revenue], where [Revenue] is the selected measure, or Rolling Total (period to date)[COST_N], where [COST_N] is the selected measure. For more information, see Create a Custom Data Item That Is Based on Relative Time.
Measures used in a custom data item expression are always calculated by using the default aggregation method. (Within SAS Web Report Studio, it is not possible to produce a detailed calculation.)

Create a Custom Data Item By Entering an Expression

To create a custom data item by entering an expression, complete these steps:
  1. In the Section Data panel, select Optionsthen selectSelect Data to open the Select Data dialog box.
  2. Select the Custom tab.
  3. A data source is selected by default. If you want to use a different data source, complete these steps:
    1. Click Select Data Source.
    2. In the Select Data Source dialog box, select a new data source. This will also change the data source for standard data items.
    3. Click OK.
  4. Type the Name of the custom data item. You cannot use these characters: < > ( ) & # \
  5. Type an arithmetic expression into the Expression field. The expression is evaluated based on the aggregated values of the measures that you selected. (Within SAS Web Report Studio, it is not possible to produce a detailed calculation.)
    The following table contains some items that you can include in an expression.
    Items That Can Be Included in a Custom Data Item Expression
    Items
    Examples
    Notes
    measure names, enclosed in square brackets
    [Profit]
    [Cost of Goods Sold]
    If you select a measure from the Available measures list box and click single right arrow icon to move it to the Expression field, then the brackets are automatically included.
    parentheses
    2 * ([COST_N] + [Sales_Cost])
    Use parentheses when you need to perform a calculation outside of the normal order of operations.1
    You can type the parentheses or highlight the appropriate part of the expressions and then click parentheses icon.
    the following symbols: + (plus sign), - (minus sign), * (multiplication sign), and /(division sign)
    [Retail_Price] - [Cost]
    You can type the symbols or use the symbol buttons: addition iconsubtraction iconmultiplication icondivision icon.
    numeric constants
    [Total_Retail_Price] / 1000000
    You cannot create a data item that is a constant value such as 500 or 500+300.
    1In the normal order of operations, working from left to right, multiplication and division are performed first, followed by addition and subtraction.
  6. After you have written the expression, click Add to add your custom data item to the Custom items box. A custom data item displays with this icon: custom data item icon.
  7. Click OK.
    The custom data item that you created is listed in the Section Data panel with any other selected or created data items.

Create a Custom Data Item That Is Based on Relative Time

If your query includes a time hierarchy from a multidimensional data source, then you can create a custom data item that is based on relative time. Complete these steps:
  1. In the Section Data panel, select Optionsthen selectSelect Data to open the Select Data dialog box.
  2. Select the Custom tab.
  3. A data source is selected by default. If you want to use a different data source, complete these steps:
    1. Click Change Source.
    2. In the Select Data Source dialog box, select a new data source.
    3. Click OK.
  4. Type the Name of the custom data item. You cannot use these characters: < > ( ) & # \
  5. Select a measure in the Available measures field.
  6. Select one of the options in the Relative time-based functions drop-down list. You can create the following calculations for the selected measure:
    Difference (consecutive periods)
    the difference between the previous period and the current period.
    Difference (parallel periods)
    the difference between the current period and the equivalent period from the previous year. For example, you might calculate the difference between the third quarter of the current year and the third quarter of the previous year.
    Percent change (consecutive periods)
    the difference between the previous period and the current period, expressed as a percentage of the previous period's value.
    Percent change (parallel periods)
    the difference between the current period and the equivalent period from the previous year, expressed as a percentage of the previous year's value. For example, you might calculate the percentage change between the third quarter of the current year and the third quarter of the previous year.
    Rolling Total (period to date)
    the sum of the values for the current period and all of the preceding periods. (This function starts over with each calendar year.)
    Relative Time-Based Functions Drop-down List in the Select Data Dialog Box
    Relative Time-Based Functions Drop-down List in the Select Data Dialog Box
  7. Click right arrow icon to place your relative time expression in the Expression field. The expression is evaluated based on the aggregated values of the measures that you selected. (Within SAS Web Report Studio, it is not possible to produce a detailed calculation.)
    Custom Data Item in the Select Data Dialog Box
    Custom Data Item in the Select Data Dialog Box
  8. Click Add to add your custom data item to the Custom items box.
  9. Click OK.
    The custom data item that you created is listed in the Section Data panel with any other selected or created data items.

Modify a Manually Entered Expression

Note: You cannot modify an expression that uses a relative time function. However, you can click Clear to clear it from the Expression field.
To modify a custom data item, complete these steps:
  1. In the Section Data panel, select Optionsthen selectSelect Data to open the Select Data dialog box.
  2. Select the Custom tab.
  3. Select a custom data item in the Custom items box.
  4. Click Clear and then retype the expression. Then click Change.
  5. Click OK.

Remove a Custom Data Item

To remove a custom data item from a report section, complete these steps:
  1. In the Section Data panel, select Optionsthen selectSelect Data to open the Select Data dialog box.
  2. Select the Custom tab.
  3. Select a custom data item in the Custom items box, and then click Remove.
    Note: If you remove a custom data item, it is no longer available to use in the report. If you change your mind, you must re-create the custom data item. For a list of consequences associated with removing data items, see Remove Standard Data Items.
  4. Click OK.