Business Rule Types

Finance

Finance Business Rules are used to generate multi-Dimensional calculations.  These Business Rules are written as Shared Business Rules and applied to a Cube or Member Formulas.

Invoking Engine
Finance

API Object Type
FinanceAPI

Args Object Type
FinanceRulesApi

These contain multiple child objects that are populated based on how the rule type is called.

  • FinanceRulesApi.MemberListHeadersArgs

  • FinanceRulesApi.MemberListArgs

  • FinanceRulesApi.DataCellArgs

  • FinanceRulesApi.FXRateArgs

  • FinanceRulesApi.ConfirmationRuleArgs

  • FinanceRulesApi.CalculateArgs

  • FinanceRulesApi.DrillDownArgs

Common Usage

The list below details the common use cases that apply to Finance Business Rules:

  • Stored Calculation of a Member Value

  • Dynamic Calculation of a Member Value

  • Programmatic Member Filters

  • Scenario Copy Logic

  • Allocation Logic

  • Conditional No Input Rules

  • Custom Consolidation Logic (Shared Business Rule only)

  • Custom Translation Logic (Shared Business Rule only)

  • Custom Elimination Logic (Shared Business Rule only)

  • Confirmation Rule Logic

  • Custom Calculations (Done via Dashboard Parameter Components)

Parser

Parser Business Rules are used to evaluate and/or modify field values being processed by the Stage Parser Engine as it reads source data.  These Business Rules are written as Shared Business Rules or Logical Expressions and applied to a Data Source Dimension.

Invoking Engine
Stage

API Object Type
ParserDimension

Args Object Type
ParserArgs

Common Usage

The list below details the common use cases that apply to Parser Business Rules.

  • Custom Parsing Logic

  • Field Value Concatenation

  • Field Value Bypassing

  • Evaluate Field other than Current Field being Parsed

Connector

Connector Business Rules are used to communicate with, collect data from, and drill back to external systems.  These Business Rules are written as Shared Business Rules and applied to a Data Source.

Invoking Engine
Stage

API Object Type
Transformer

Args Object Type
ConnectorArgs

Common Usage

The list below details the common use cases that apply to Connector Business Rules.

  • Source System Connection Logic

  • Source System Field List Logic

  • Source System GetData Logic

  • Source System DrillBack Logic

Conditional Rule

Conditional Rules (mapping) are used to conditionally evaluate mapping criteria during the data transformation process.  These Business Rules are written as Shared Business Rules or Logical Expressions and applied to a Transformation Rule definition.

Invoking Engine
Stage

API Object Type
Transformer

Args Object Type
ConditionalRuleArgs

Common Usage

The list below details the common use cases that apply to Conditional (mapping) Business Rules.

  • Evaluate Source Values and Conditional Map Target

  • Evaluate Other Mapped Value and Conditional Map Target

DerivativeRule

Derivative Rules (derive data prior to mapping) are used to evaluate and/or calculate values during the data derivation process.  These Business Rules are written as Shared Business Rules or Logical Expressions and applied to a Derivative Rule definition.

Invoking Engine
Stage

API Object Type
Transformer

Args Object Type
DerivativeRuleArgs

Common Usage

The list below details the common use cases that apply to Derivative (derived data) Business Rules.

  • Calculate Mathematical Expressions

  • Lookup Value from Transformation Cache for use in Calculations

  • Lookup Value from Cube for use in Calculations

  • Source System Check Rule Logic (validation rules on source data)

Cube View Extender

Cube View Extender Rules are used to apply advanced Cube View formatting to any Cube View Report.  Using custom formatting allows the Cube View design to go beyond the standard Cube View formatting properties and provides flexibility for specific formatting needs.  The Extender Rule is used in conjunction with the Custom Report Formatting properties on the Cube View under General Settings|Report Tab. 

Invoking Engine
Presentation

API Object Type
No specific API (used General BRApi)

Args Object Type

CubeView

CubeViewExtenderFunctionType

CubeViewExtenderReport

CustomSubVars

FunctionType

Common Usage

  • Display different logos on select reports based on conditional logic or security and manage their placement and size

  • Customize the page number in the header or footer
    Page numbers can be on the top or bottom row of a report and the horizontal position can be specified for rows.  This only applies to the top or bottom rows.

  • Format individual header and footer fields

  • Customize the Cube View Header

    • Control the Left, Right, Center Subtitle widths

    • Control the font size of Title and Subtitles

  • Customize the date display

  • Customize bottom text alignment

  • Apply Conditional Formatting
    Format cells based on their contents.  Change the text color of a value in order to effectively hide the result.

  • Customized Report row and column formatting such as borders, background and text colors and alignment

DashboardDataSet

DashboardDataSet Rules are used to create programmatic query results. This rule type combines multiple types of data into a single result set using the full syntax capability of VB.Net or C#. These Business Rules are written as Shared Business Rules and applied to Dashboard Data Adapters or Dashboard Parameters.

Invoking Engine
Presentation

API Object Type

No specific API (used General BRApi)

Args Object Type
DashboardDataSetArgs

Common Usage

The list below details the common use cases that apply to DashboardDataSet Business Rules.

  • Combine Different Types of Data for a Report

  • Build Programmatic Data Queries (e.g., analytic plus SQL)

  • Conditionally Build Data Query Reports

  • Conditionally Build Data Query Parameters

DashboardExtender

DashboardExtender Rules are used to perform a variety of tasks associated with custom Dashboards and MarketPlace Solutions. These Business Rules can be thought of as multi-purpose rules and make up the majority of the code written in a MarketPlace Solution. In addition, they are written as Shared Business Rules and applied to Application Dashboard Parameter Components (Buttons, Combo Boxes, etc.).

Invoking Engine
Presentation

API Object Type
No Specific API (uses General BRApi)

Args Object Type
DashboardExtenderArgs

Common Usage

The list below details the common use cases that apply to DashboardExtender Business Rules.

  • Execute a Task when the User Clicks a Button

  • Perform a Task and Show a Message to the User

  • Perform a Custom Calculation

  • Upload a File from the End User’s Machine

  • Automate a Workflow

  • Build a Custom Workflow

  • Create Custom Data Tables

  • These rules are basically limited to the imagination of the developer

DashboardStringFunction

DashboardStringFunction (reference as XFBR) Rules are used to process conditional Dashboard Parameters. These rules inspect and alter a Dashboard Parameter value using the full syntax capabilities of VB.Net or C#. DashboardStringFunctions are written as Shared Business Rules and called by using a XFBR(BusinessRuleName, FunctionName, UserParam=[UserValue]) specification anywhere a standard Dashboard Parameter is used.

Invoking Engine
Presentation

API Object Type
No Specific API (uses General BRApi)

Args Object TypeDashboardStringFunctionArgs

Common Usage

The list below details the common use cases that apply to DashboardStringFunction (i.e., conditional Parameters) Business Rules.

  • Evaluate a Dashboard Parameter and conditionally return another Value

  • Evaluate a Cube View Parameter and conditionally return another Value

  • This Business Rule can be substituted anywhere a Dashboard Parameter is used in order to evaluate the Supplied Parameter value and return a different value

Extender

Extender Rules are the most generalized type of Business Rule in the platform.  Use these to write a simple utility function or a specific helper function called as part of a Data Management Job. These Business Rules are written as Shared Business Rules and executed directly from the code editor, a data management job or the Finance Engine during an external Dimension request (i.e., read Dimension Members from an external list).

Invoking EngineBusiness Rule, Data Management, Finance

API Object TypeNo Specific API (uses General BRApi)

Args Object Type

ExtenderArgs

This contains multiple child objects that are populated based on how the rule type is called.

  • ExtenderArgs.DataMgmtArgs

  • ExtenderArgs.ExternalDimSourceArgs

Common Usage

The list below details the common use cases that apply to Extender Business Rules.

  • Create a General Helper Rule for Administrators Only

  • Create Data Management Business Rule Step Logic

  • Create a Query to fill an External Dimension List