Can Text Be Used in a Runtime Prompt in an Essbase Calculation? An Interactive Guide

This page clarifies a common question for Essbase developers: **can text be used in a runtime prompt in a calculation script?** While you can’t use arbitrary text strings, you can use text to select members. This interactive tool simulates how it works.

Essbase Runtime Prompt (RTP) Text Usage Simulator

What is Using Text in an Essbase Runtime Prompt?

The question, **”can text be used in a runtime prompt in an Essbase calculation,”** is a frequent point of confusion. The direct answer is nuanced: No, you cannot pass an arbitrary, free-form text string like “My custom text” into a calculation script and use it for string operations. However, the powerful ‘yes’ part of the answer is that you can absolutely use a runtime prompt (RTP) to present a user with a list of text choices, where each choice corresponds to a member in your database outline.

When a user selects a text label (e.g., “Cola” from our calculator), Essbase internally translates that selection into a specific member (e.g., `[Product].[Cola]`). The calculation script then uses this member within its logic, typically inside a `FIX` statement, to perform calculations on the data associated with that member. This provides immense flexibility, allowing users who are not Essbase experts to run complex calculations for different entities, products, or regions just by selecting a name from a list. A common misunderstanding is thinking RTPs can handle any string. They are fundamentally designed for member selection, not for general-purpose string manipulation within a calculation script. For those needs, other tools like Groovy scripting are more appropriate.

The “Formula” and How Essbase Handles Text Prompts

There isn’t a traditional mathematical formula for this process. Instead, it’s a conceptual and syntactic one within Essbase. The magic happens through Runtime Substitution Variables and functions that can interpret a string as a member. An administrator defines a variable in a calculation script that is designated as a runtime prompt, often specifying its type as ‘member’ and linking it to a dimension.

A simplified representation of the calculation script logic looks like this:

SET RUNTIMESUBVARS {rtp_ProductName};

FIX(@NAME({rtp_ProductName}))

    "Projected Sales" = "Sales" * (1 + (&rtp_GrowthFactor/100));

ENDFIX

Variables Table

Variable	Meaning	Unit	Typical Range
rtp_ProductName	The string name of the member selected by the user in the runtime prompt.	Text (Member Name)	Any valid member name from the specified dimension (e.g., “Cola”, “Juice”).
@NAME(…)	An Essbase function that converts a string into a valid member name for use in the calculation.	Function	N/A
rtp_GrowthFactor	A numeric value, also provided via an RTP, for the calculation.	Number/Percentage	-100 to 1000+

Practical Examples

Example 1: Regional Budget Adjustment

An analyst needs to apply a cost-of-living adjustment to the budget for a specific region. Instead of writing a separate script for each region, they run a single script with an RTP.

• Inputs:
  • Region RTP (Text): User selects “North”
  • Adjustment RTP (Numeric): User enters 3.5 (%)
• Logic: The script fixes on the “North” member from the Region dimension and increases the ‘Budget’ member by 3.5%.
• Result: The budget for the “North” region is accurately updated without modifying the script itself.

Example 2: Product Scenario Modeling

A product manager wants to see the effect of a competitor’s new product launch on their own product’s sales forecast. See our guide on Essbase Analytics Link for advanced scenarios.

• Inputs:
  • Product RTP (Text): User selects “VideoGameConsole”
  • Impact RTP (Numeric): User enters -20 (%)
• Logic: The script fixes on the “VideoGameConsole” member and applies a -20% change to the “Forecast” scenario.
• Result: A new ‘what-if’ forecast is generated instantly for the selected product, allowing for quick analysis.

How to Use This Essbase RTP Calculator

This calculator simulates the process of using a text-based runtime prompt in an Essbase calculation.

1. Select Product: Use the dropdown menu to choose a product. This mimics an Essbase RTP where you select a member by its name (text).
2. Enter Base Sales: The numeric inputs represent the current sales data stored in the Essbase cube for each product member.
3. Set Growth Factor: Input the growth percentage you wish to apply. This simulates a second, numeric RTP used in the same calculation.
4. Review Results: The primary result shows the ‘Projected Sales’. The intermediate values break down how the calculation was performed, showing the member you selected and the values used. For details on script syntax, you may consult resources on Essbase calculation script syntax.
5. Analyze Chart: The bar chart provides a quick visual comparison between the original base sales and the newly calculated projected sales.

Key Factors That Affect Runtime Prompt Usage

1. Member vs. String Type: The RTP must be defined correctly in Calculation Manager or with `SET RUNTIMESUBVARS` to accept a member or a string that resolves to a member. A pure ‘string’ type has different uses and limitations.
2. Dimension Hierarchy: The members available in the prompt are pulled directly from the dimension hierarchy. The structure and depth of the dimension affect what the user can select.
3. Security: Essbase security is always enforced. Users will only see members in the runtime prompt to which they have at least read access.
4. @NAME vs. @MBRNAME: Using the `@NAME` function is crucial for converting the text string from the RTP into a member that the `FIX` statement can understand.
5. Performance: On extremely large, sparse dimensions, generating the list of members for the RTP can sometimes have a minor performance impact.
6. Application Type (ASO/BSO): While the concept is similar, the underlying implementation and performance characteristics can differ between Block Storage (BSO) and Aggregate Storage (ASO) cubes. For more on BSO, check out our BSO optimization guide.

Frequently Asked Questions (FAQ)

1. Can I type any random text into an RTP?

No. If the RTP is configured for a member, the text you enter must exactly match a member name or alias in the specified dimension. Otherwise, the calculation will fail.

2. How are the choices in the text prompt populated?

Essbase automatically populates the list of choices based on the members of the dimension the RTP variable is associated with.

3. Can I use this for concatenating strings in a calculation?

No, standard Essbase calculation scripts are not designed for string manipulation like concatenation. This functionality is better suited for Groovy-based calculations.

4. What is the difference between an RTP and a Substitution Variable?

A standard substitution variable has a single, fixed value set at the server, application, or database level. A runtime prompt (which is a type of substitution variable) is dynamic, allowing the user to provide the value every time the script is executed.

5. Can a single calculation have multiple text-based RTPs?

Yes. You can have multiple RTPs to select members from different dimensions (e.g., one for ‘Region’ and one for ‘Product’) within the same calculation script.

6. Does the case (uppercase/lowercase) of the text matter?

Yes, member names in Essbase are case-sensitive by default. The text entered in the prompt must match the member name’s case exactly.

7. Can I select multiple members from one text RTP?

Yes, RTPs can be configured to allow single or multiple member selections. If multiple are selected, they are typically passed as a comma-separated list that functions can iterate over (like `@LIST`).

8. Where can I learn more about designing these scripts?

The Oracle documentation on Calculation Manager and the `SET RUNTIMESUBVARS` command are the best resources. Exploring MaxL scripting for automation can also be very helpful.

Related Tools and Internal Resources

Explore other related topics and tools to enhance your Essbase knowledge:

• Essbase Performance Tuning Guide: Learn how to optimize your cube calculations and retrievals.
• Groovy vs. Calculation Scripts: A detailed comparison of when to use each scripting language in Essbase.
• Advanced Smart View Guide: Master the client tool for interacting with Essbase, including using runtime prompts.
• Essbase Security Best Practices: Understand how to properly secure your applications and data.
• ASO vs. BSO Deep Dive: A comprehensive look at the two cube types and their ideal use cases.
• Automating Essbase Data Loads: Techniques for creating robust, automated data loading processes.