Skip to main content

Business Rule Type

OneStream Business Rules (BRs) are written in VB.NET or C# and are integral to the functionality of OneStream applications, providing the primary logic behind various solutions and actions within dashboards, workflows, and data management. BRs automate processes, manage data, and enhance user interaction by executing specific functions based on user actions or system events. Business rules are categorized into different types, which are: Finance, Parser, Connector, Derivative, Cube View Extender, Dashboard Data Set, Dashboard Extender, Dashboard XFBR String, Extensibility, and Spreadsheet.

Finance​

  • Finance Functionality is designed to facilitate multi-dimensional “cube” calculations and enable complex financial data analysis and processing. Refer to the Finance Usage Guide for additional information.

Parser​

  • The Parser Business Rule type is a versatile business rule used primarily for integration tasks, such as data parsing and transformation. These rules are linked to data sources and are called during import events to facilitate the parsing of data. This type of business rule performs tasks such as parsing debit and credit field values from a source General Ledger file, character trimming, concatenation, and deriving a Source ID from a source file name. They are essential for enabling data integration that is complex.

Connector​

  • A Connector Business Rule is designed to facilitate data integration from external systems into the Import Workflow Profile type. These rules enable sourcing data from external databases, cloud service providers that offer a REST API for data retrieval, or data sources that can be securely queried programmatically with .NET. This type of rule is configured on a connector data source and is triggered when a user clicks import in a workflow and can be automated through the use of an Extensibility rule and Task Scheduler. Additionally, Connector Business Rules can enable detailed drill back functionality, enriching a user's data investigation and analysis in OneStream.
  • Connector Business Rules use specific action types to define their capabilities, including:
    • GetFieldList: Defines the field names that will be returned to the source data table.
    • GetData: Processes (queries) the incoming source data.
    • GetDrillBackTypes: Enables the design of custom drill backs to additional detail that is accessible from an external source.
    • GetDrillBack: Handles the drill back processing to retrieve the drill detail and present it in a specific display.

Conditional Rule​

  • The Conditional Rule type of business rule is used during the data transformation process. Designed to evaluate mapping criteria based on specific conditions, these rules are written as Shared Business Rules or Logical Expressions and are applied to Transformation Rules. Particularly applicable to Transformation Rules of types such as Composite, Range, List, or Mask, either as a Business Rule or Complex Expression.
  • Conditional Rules enable dynamic data mapping during import events and execute when a transformation starts during an import event. This type of rule enables mapping of data based on specific conditions, enhancing the accuracy of data processing.

Derivative Rule​

  • A Derivative Business Rule is a type of rule that performs specific tasks related to data manipulation and validation. These rules enable the creation, modification, or deletion of records when imported, as well as the capability to apply calculations to set amounts, and provide data validation checks during workflow validation steps. Here are some key aspects of Derivative Business Rules:
    • Record Creation, Modification, and Deletion: Derivative Business Rules can derive, add, or remove a record during import. For a record that is created or derived, the resulting record's amount can be set with a calculation. This derived record can be temporary, used for Check Rule validations, or final, which means it can be transformed and loaded into a Cube.
    • Data Validation: These rules support data validation checks during workflow validation steps, enabling a pass or fail, commonly referred to as Check Rules during validation. For example, a Derivative Rule can ensure the trial balance is in balance before allowing a user to complete validation.
    • Integration with Transformation Rules: Derivative Business Rules are linked to Transformation Rules and can be triggered during import or validation steps. They are attached to a Derivative Transformation Rule in the Logical Operator setting.
  • Overall, Derivative Business Rules are essential for data events, providing flexibility and control over data processing and validation.

Cube View Extender​

  • Cube View Extenders are designed to enhance Cube View presentation and improve the user experience by providing detailed formatting adjustments that go beyond standard Cube View settings. Some key features and uses of Cube View Extenders are:
    • Advanced Report Options: Cube View Extenders enable configuration of report elements: headers, footers, page layout, and report headers.
    • User Interface Options: These extenders offer options for advanced formatting needs, such as varying images, moving/removing headers or footers by Entity or Cube View, and applying conditional formatting to highlight significant data variances.
  • Methods of Application: Cube View Extenders can be applied using two methods:
    • Inline Formula: This method is recommended for customizing a single Cube View or when customization differs by Cube View. It involves setting the Custom Report Task property to Execute Cube View Extender Inline Formula and using the Formula Editor to apply specific formatting.
    • Business Rule: This method is used for applying formatting to multiple Cube views without manually inserting the Inline Formula into each report. It involves setting the Custom Report Task property to Execute Cube View Extender Business Rule and selecting the appropriate Business Rule.

Dashboard Data Set​

  • Dashboard Data Set Rules enable the management and enhancement of data within dashboards. This functionality provides a flexible and efficient method for creating custom datasets and data tables for advanced parameters, reports, and dashboards. Here are some key aspects of Dashboard Data Set Rules:
    • Data Presentation and Manipulation: Dashboard Data Set Rules are used to present, manipulate, and enrich data sets. The functionality enables the execution of SQL queries, Method queries, and OneStream BRApis to develop configured datasets.
    • Performance and Flexibility: Designing datasets using Dashboard Data Set Rules is recommended for optimal performance and flexibility, especially when creating reports or bound list parameters. These rules avoid complex SQL joins and leverage OneStream BRApis for efficient data handling.
    • Integration with Dashboards: Dashboard Data Set Rules can be called directly in a data adapter to enable dashboard reporting or in a bound list parameter to create custom lists for user selection in dashboard components

Dashboard Extender​

  • Dashboard Extender Business Rules are designed to enhance the functionality of dashboards and components by automating tasks and creating interactive elements. Some key features and uses of this Business Rule type are:
    • Automating User Interactions: Dashboard Extenders can automate user interactions, such as sending notifications or executing tasks when a user clicks a button. For example, this functionality can be used to design button click actions that send emails to OneStream users.
    • Task Execution: These rules are used to perform tasks like updating values, processing data, or launching workflows when a dashboard component is interacted with. This functionality is applied to components such as buttons, combo boxes, charts, cube views, and grid views.
    • Enhancing Workflow Automation: Dashboard Extender Rules can streamline user navigation through workflow steps by automating status updates and messages. For instance, a Dashboard Extender can transition users from a Workspace step to Input Forms by updating the workflow status and displaying completion messages.
    • Custom Logic Implementation: Extender Rules allow for the implementation of custom logic when interacting with dashboard components, such as executing SQL scripts or launching data management jobs

Dashboard XFBR Sting​

  • Dashboard XFBR String Rules is a versatile business rule type used to manage text-based logic across an application dynamically. Key aspects of Dashboard XFBR String Rules are:
    • Dynamic Configuration: These rules allow for the dynamic configuration of dashboard components based on specified conditions. For example, they can be used to format buttons dynamically, changing colors based on workflow step status to provide visual cues for task completion.
    • Flexibility and Adaptability: Dashboard XFBR String Rules can be applied nearly anywhere an application expects text, such as report books, formatting properties, headers, or row/column names in cube views.

Extensibility Rules​

  • Extensibility Rules enable the configuration and automation of application behavior.
  • There are two main types of Extensibility Rules:
    • Extender Rules: Common use cases for this rule type are: automation of workflows, data extraction, data acquisition, data loading, and email notifications. Extensibility rules can be executed from the Business Rule UI, which simplifies the design and testing of automation logic, as well as through Dashboards.
    • Event Handler Rules: As the name implies, this type of rule responds to specific events within the platform, allowing for custom tasks or processes to be triggered. This unique functionality compared to other business rule types is because this rule type does not need to be called from another user interface element to be triggered, as the OneStream Event Engine listens to specific events and triggers the rule. Also unique to Event Handler is that an application can have one and only one of each event handler type.
  • The Event Handler Rule Types with an explanation of each follow:
    • DataManagementEventHandler is designed to respond to specific events related to data management processes such as StartSequence, ExecuteStep, and StopSequence.
    • DataQualityEventHandler is a method used to enhance standard data quality actions with configurable functionality, such as notifying appropriate users that data was loaded, consolidated, and whether the load and consolidation resulted in a balanced Balanced Sheet.
    • FormsEventHandler is activated before, during, or after Form events, an example of which is saving a form. This functionality enables configurable actions to be executed at different points in the form lifecycle, ensuring comprehensive control over form-related processes.
    • JournalsEventHandler is functionality used
    • TransformationEventHandler is designed to manage and automate data transformation processes within the platform. This functionality can ensure efficient data processing. An example of this functionality is adding a member to a dimension during an automated data load.
    • WcfEventHandler is a capability that facilitates communication management within the platform leveraging Microsoft's Windows Communication Foundation (WCF) to enhance integration capabilities and system responsiveness. The WCF Event Handler allows direct interaction with Microsoft's Windows Communication Foundation, enabling seamless communication management within the OneStream environment. This direct interaction helps in managing and intercepting communications between the client and the web server. This capability enhances application management by ensuring that specific actions are taken when certain conditions are met.
    • WorkflowEventHandler is functionality designed to manage and enhance workflow processes. This event handler executes before or after a workflow execution step, enabling logic to be applied at different stages of the workflow; therefore, optimizing process control and efficiencyThe Workflow Event Handler is an integral part of OneStream's platform, providing the tools necessary to manage complex workflow processes and ensure efficient data handling

Spreadsheet​

  • Spreadsheet Rules are designed to facilitate data interaction and analysis using the familiar spreadsheet interface. This rule type enables authorized users to perform read/write actions and analysis on data sets. Spreadsheet Rules have the following key aspects:
    • Data Interaction: Spreadsheet Rules enable users to read or write to database tables based on security and authorization. This interaction is facilitated through the Spreadsheet component or Excel Add-In, providing users with a familiar interface to manage data.
    • Use Cases: Common use cases for Spreadsheet Rules include designing reports that enable users to analyze and modify data from custom data tables such as Specialty Planning register tables.
    • Function Types: Spreadsheet Rules support several function types, including:
      1. GetCustomSubstVarsInUse: Allows users to apply filters to underlying data using bound-type parameters.
      2. GetTableView: Defines the source(s) for the Table View and shows filtered data.
      3. SaveTableView: Supports data modification in the Table View, allowing users to write back to the database.
Last updated on by Jeremy Meiss

Was this page helpful?