Editing a Business Rule in Script Mode (Financial Management, Planning, and Essbase Block Storage Application Users Only)

By default, you create a business rule in graphical mode using the Rule Designer to design the graphical flow of the business rule. After you create and save a business rule, you can edit it in graphical mode or script mode. If you choose to edit it in script mode, you can return to editing in graphical mode later.

For Financial Management business rules, after you edit a graphical business rule in script mode, you are prompted to save the changed rule as a separate script component. The original graphical rule remains unchanged in the database.

  To edit a business rule in script mode:

  1. In the System View, expand the Financial Management, Planning, or Essbase block storage application type, the application, the calculation type, plan type, or database, and Rules. Do one of these tasks:

    • Right–click the rule you want to edit, and select Open.

    • Select the rule you want to edit, and select File, Open.

  2. After the rule opens, select Edit, Script.

    You can switch back to graphical mode by selecting Edit, Graphical.

    Note:

    When you switch from editing in graphical mode to script mode, if the business rule contains shared components (such as formula and script components) or templates, the script of the business rule contains only references to the shared components and templates in the Script Editor. The complete generated script of the shared components and templates is displayed on the Script tab in the bottom pane.

  3. In the Script Editor, do one or more of the following tasks:

  4. On Properties, edit properties of the rule.

    • Optional: Enter or edit the name by entering a new one of up to 50 characters. (The name defaults from the New Rule dialog.)

    • Optional: Enter or edit a description of up to 255 characters for the rule.

    • Optional: Enter or edit a caption for the rule. The caption displays below the rule's icon in the flow chart.

    • Optional: Enter or edit comments for the rule. For example, you may want to add a comment that describes what the business rule does in detail.

    • Financial Management users only:

      • Select Enable Logging so, if the rule has log text, it is included in the log file when the rule is launched. You can enable logging for rules, rulesets, and components. However, you specify what log text to include, if any, with a business rule's formula statements.

        Note:

        If logging is not enabled for a ruleset, but is enabled for a rule and component that belong to the ruleset, no log file is created; the log setting for the ruleset overrides the settings for the rule and component.

      • Select Enable Timer so the time taken to process the rule is recorded in the log file when the rule is launched. You can enable the timer for rules, rulesets, and components. The process time is included in the log file for every object whose timer is enabled. For example, if you have a ruleset whose timer is enabled and the ruleset contains three rules whose timers are enabled, the time taken to process the ruleset, and each rule in the ruleset, is recorded.

      • Select Disabled to temporarily disable the business rule while the script is generated.

      • Select Is Function so the rule is used as a function that can include execution variables that you specify as parameters on the Parameters tab.

  5. Financial Management users only: On Parameters, you can view the execution variables that are used in the business rule and select any execution variables you want to use as parameters. Complete these steps:

    Note:

    When you first open a new business rule, this tab is empty. If you add components to the business rule, and any of those components use variables, the variables are displayed on this tab.

    1. Select Is Parameter to use the execution variable as a parameter. If the execution variable has a ruleset scope (that is, it is passed from one business rule to another business rule within the same ruleset) Is Parameter is selected by default. If the variable has a rule scope (that is, it may be used only in the business rule for which it is created and is not passed to another business rule) Is Parameter is not selected.

      Note:

      If a business rule contains at least one execution variable for which Is Parameter is selected, when you include this business rule in another or the same business rule, you can specify values for its execution variables on the Parameters tab. See Using Parameters as a Business Rule (Financial Management Users Only).

    2. In Passing Method, select By Reference or By Value. (By Reference is the default.)

  6. Planning and Essbase block storage application users only: On Variables, you can create variables for the rule. (See Working with Variables.)

  7. Planning and Essbase block storage application users only: On Script, you can view the entire generated script of the business rule and any components and templates it contains.

    Note:

    You cannot make changes on this tab; you can edit the script only in the Script Editor.

  8. On Usages, you can view which rules and rulesets (Financial Management and Planning users only) use the rule, if any. This is the information you can view about the rules and rulesets (Financial Management and Planning users only) that use the rule:

    Note:

    You cannot edit any of the information on this tab.

    • The names of the business rules, templates, and business rulesets (Financial Management and Planning users only) that are using the business rule

    • The calculation, plan type, or database of the business rules, templates, and business rulesets (Financial Management and Planning users only) that are using the business rule

    • The application name of the business rules, templates, and business rulesets (Financial Management and Planning users only) that are using the business rule

    • Whether the business rules, templates, and business rulesets (Financial Management and Planning users only) that are using the business rule are deployed

    • Whether the business rules, templates, and business rulesets (Financial Management and Planning users only) that are using the business rule are validated

    • A description of the business rules, templates, and business rulesets (Financial Management and Planning users only) that are using the business rule

  9. Select File, Save.