Application Tools

Application Tools Overview

  • Application tools are used to manage and configure the OneStream application to suit specific needs.

  • These tools include setting application security roles, properties, and scheduling data management sequences.

Application Security Roles

  • Application-level security roles control various aspects of application access and management.

Specific Application-Level Security Roles:

  • Administer Application

    • Allows users to administer the application and load zip files.

    • Useful in environments with multiple applications where different administrators manage separate applications.

  • Administrator Database

    • Designed for a limited number of users.

    • Permits mass deletion of metadata and data via the database page.

    • Administrators are not automatically granted access to operations requiring this role.

  • Open Application

    • Enables users to see and open the application.

  • Modify Data

    • Allows users to modify data within the application.

    • Without this role, users are essentially read-only.

  • View All Data

    • Permits a group of users to view all data in the application.

  • Create Audit Attachments

    • Allows users to create data attachments for supporting documentation in audits.

  • Create Footnote Attachments

    • Enables users to create footnote attachments for supporting documentation.

  • Certify and Lock Descendants

    • Allows users to certify and lock descendants from the Workflow.

    • Typically an administrator function.

  • Unlock and UnCertify Ancestors

    • Enables users to uncertify and unlock ancestors from the Workflow.

    • Typically an administrator function.

  • Preserve Import Data

    • Allows administrators to lock Workflows and preserve imported data during changes.

    • The Workflow can be unlocked after preserving data so changes can be made.

  • Restore Import Data

    • Allows administrators to restore imported data to the original state after the Preserve Import process.

  • Unlock Workflow Unit

    • Enables users to unlock a Workflow Unit.

    • Requires Workflow Execution access to lock a Workflow Unit.

  • View Source Data Audit

    • Allows users to view the Source Data Audit Report within the Import Workflow.

  • Encrypt Business Rules

    • Enables users to encrypt and decrypt rules from the Business Rule screen in the Application tab after the role has been granted.

  • Manage Application Properties

    • Allows users to update the application's properties.

  • Manage Metadata

    • Allows users to edit metadata under the Dimension Library for the application.

  • Manage FX Rates

    • Allows users to update FX Rates.

  • Manage Data

    • Allows users to manage all aspects of data including exporting and clearing data through Data Management.

    • Typically an administrator function.

  • Manage Cube Views

    • Allows users to create new Cube Views and manage Cube View Groups and Profiles.

  • Manage Data Sources

    • Allows users to create new Data Sources.

  • Manage Transformation Rules

    • Allows users to create new Transformation Rules and manage Transformation Rules Groups and Profiles.

  • Manage Confirmation Rules

    • Allows users to create new Confirmation Rules and manage Confirmation Rules Groups and Profiles.

  • Manage Certification Questions

    • Allows users to create new Certification Questions and manage Certification Question Groups and Profiles.

  • Manage Workflow Channels

    • Allows users to create new Workflow Channels.

  • Manage Workflow Profiles

    • Allows users to create new Workflow Profiles.

  • Manage Journal Templates

    • Allows users to create new Journal Templates and manage Journal Groups and Profiles.

  • Manage Form Templates

    • Allows users to create new Form Templates and manage Forms Groups and Profiles.

  • Manage Application Dashboards

    • Allows users to create new Application Dashboards and manage Dashboard Groups and Profiles.

  • Manage Application Database Files

    • There are two file systems which are stored in the Framework database (i.e., the System database) and each Application database.

    • Users in the security roles for ManageSystemDatabase Files and ManageApplication Database Files have full read and write access to his/her user folders in those two database file systems, respectively.

    • These folders are private to the user and access is intentionally restricted to just the user and managers. Security cannot be edited for a user folder.

    • Users can be given read and/or write access to specific folders in the database file systems using the individual folders' security settings, however this excludes access to User folders and sub-folders.

  • AnalyticsApi

    • Allows users to access OneStream connectors to pull data into external systems.

    • Controls who can use the connectors.

    • Becomes available when access to the Power BI Connector is granted.

    • May be used with additional connectors in the future.

Specific Application-Level User Interface Roles:

  • Application-Level User Interface Roles control access to specific screens and functionalities within the OneStream application.

  • Application Load Extract Page

    • Gives access to the Load/Extract screen located in [Application | Tools].

    • Typically restricted to administrators.

  • Application Properties Page

    • Gives access to the Application Properties screen located in [Application | Tools].

    • Typically restricted to administrators.

  • Application Security Roles Page

    • Gives access to the Application Security screen located in Application | Tools.

    • Typically restricted to administrators.

  • BookAdminPage

    • Gives access to the Book Designer screen located in Application | Presentation.

    • Typically restricted to administrators or users who create Report Books.

  • Business Rules Page

    • Gives access to the Business Rules screen located in Application | Tools.

    • Typically restricted to administrators.

  • Certification Questions Page

    • Gives access to the Certification Questions screen located in |Application| Workflow.

    • Typically restricted to administrators.

  • Confirmation Rules Page

    • Gives access to the Confirmation Rules screen located in Application |Workflow.

    • Typically restricted to administrators.

  • Cube Admin Page

    • Gives access to the Cube Admin screen located in Application |Cube.

    • Typically restricted to administrators.

  • Cube Views Page

    • Gives access to the Cube Views screen located in |Application |Presentation.

    • Typically restricted to administrators or users who create Cube Views.

  • Dashboard Admin Page

    • Gives access to the Dashboard Admin screen located in Application |Presentation.

    • Typically restricted to administrators.

  • Data Management Admin Page

    • Gives access to the Data Management Admin screen located in Application |Tools.

    • Typically restricted to administrators.

  • Data Sources Page

    • Gives access to the Data Sources screen located in Application |Data Collection.

    • Typically restricted to administrators.

  • Dimension Library Page

    • Gives access to the Dimension Library screen located in Application |Cubel.

    • Typically restricted to administrators.

  • FX Rates Page

    • Gives access to the FX Rates screen located in Application |Cube].

    • Typically restricted to administrators.

  • Form Templates Page

    • Gives access to the Form Templates screen located in Application |Data Collection.

    • Typically restricted to administrators.

  • Journal Templates Page

    • Gives access to the Journal Templates screen located in |Application |Data Collection.

    • Typically restricted to administrators.

  • Transformation Rules Page

    • Gives access to the Transformation Rules screen located in |Application |Data Collection.

    • Typically restricted to administrators.

  • Workflow Channels Page

    • Gives access to the Workflow Channels screen located in |Application |Workflow.

    • Typically restricted to administrators.

  • Workflow Profiles Page

    • Gives access to the Workflow Profiles screen located in |Application Workflow.

    • Typically restricted to administrators.

Security Group Selection Tip:

  • To select a Security Group, begin typing the name in the blank field.

  • The Groups are filtered as you type, making it easier to find the desired Group.

  • Once selected, click CTRL and Double Click to enter the correct name into the appropriate field.

Application Properties

  • Application Properties are where default properties are configured for the application, including properties that vary by Scenario Type.

General Properties:

  • Global Point of View

    • Global Point of View are enabled when forcing Global Scenario and Global Time through Transformation settings.

    • An initial value should be configured even if the Transformation setting is not being used.

  • Global Scenario

    • This is the default Scenario users will see when looking at Workflow.

  • Global Time

    • This is the default Time users will see when looking at Workflow.

  • Company Information

    • Company Name

      • Place company name here for it to appear on automatically generated reports from Cube Views.

    • Logo File (png, height 50 pixels)

      • Attach a logo file in order for it to appear on Cube Views and Reports.

      • An image format of PNG is required approximately 50 pixels high.

  • Workflow Channels

    • UD Dimension Type for Workflow Channels

      • The Origin Dimension controls data load, but in some cases other User Defined Dimensions require their own layer of locking.

      • For example, a company plans by Entity by Product. One Entity can have five products done by different people.

      • Each channel can be locked separately to protect that layer of data instead of locking the entire Entity.

  • Formatting

    • Number Format

      • This shows the format for numeric values displayed throughout the application.

      • Configure to show additional degrees of precision to the right of the decimal point.

      • This setting can be overridden through Cube View formatting.

      • NO: This setting will not show any decimals or zeroes

      • N1-N6: These settings will show X amount of decimals. If N2 is chosen, two decimals are displayed, N5 will display five decimals, etc.

      • The N in the above settings indicates that these settings are international.

      • The following formats use 10000.001 as an example.

      • #,###,0%: This returns 10,000% and -10,000%

      • #,###,0: This returns 10,000 and -10,000

      • The three sections in a number format, separated by semi-colons, represent the format for positive numbers, negative numbers and zeros.

      • #,###,0;(#,###,0);0: This returns 10,000 and (10,000)

      • #,###,0.00%: This returns 10,000.00% and -10,000.00%

      • #,###,0.00: This returns 10,000.00 and -10,000.00

      • #,###,0.00; (#,###,0.00);0.00: This returns 10,000.00 and (10,000.00)

      • Include trailing spaces in the positive number format to vertically align positive and negative numbers in reports where parenthesis are used for negative values. This will account for the trailing parenthesis used by negative numbers. Example: #,###,0.00 ;(#,###,0.00);0.00

      • Click and begin typing to select the desired format, and click CTRL and Double Click. This will enter the correct format into the appropriate field.

  • Currencies

    • All currencies used in the application must be listed here in order to be used on the Entity, to do any translation of currency, or enter any rates.

    • The list of currencies will include any available currencies that are pre-Euro, or phased out currencies for historical data loading purposes.

    • If a now defunct or new currency is not listed and is needed for the application, call OneStream Support.

  • Transformation

    • Enforce Global POV

      • If set to True, this will enforce the current Global Scenario and Time setting for all users, so they cannot change their Workflow View.

      • If the Global POV is enforced, will display @ on the Import task during the Workflow.

    • Allow Loads Before Workflow View Year

      • If set to True, this will enforce the current Workflow View setting to allow data loading to time periods prior to the current Workflow year.

      • If this is set to False, data cannot be imported to time periods prior to the current Workflow year and will display on the Import task during the Workflow.

    • Allows Loads After Workflow View Year

      • If set to True, this will enforce the current Workflow setting to allow data loading to time periods after the current Workflow year.

      • If this is set to False, data cannot be imported to time periods after the current Workflow year and will display on the Import task during the Workflow.

    • Certification

      • Lock after Certify

        • If set to True, this will auto lock after certification in the Workflow.

  • Dimension Properties

    • Dimensions Standard Reports

      • General

      • Time Dimension

      • Start Year

      • End Year

      • User Defined Dimensions

      • UD1 Description

      • UD2 Description

      • UD3 Description

      • UD4 Description

      • UD5 Description

      • UD6 Description

      • UD7 Description

      • UD8 Description
        Starting and ending year of the application.

  • Time Dimension

    • Start Year

      • The starting year of the application.

    • End Year

      • The ending year of the application.

    • User Defined Dimensions (Descriptions)

      • Applies a custom description to the eight User Defined dimensions.

      • The description applies to the dimension type, not to each dimension and will be visible to the user in various interfaces in the OneStream Application.

      • The descriptions display in the hover/tool-tips, pop-up windows and other dimension interfaces. These are viewable in:

        • Point of View

        • Dimension Library

        • Cube View Member Filters

        • Drill Down Dimension headers

        • Excel Add-in / Spreadsheet

        • Journals

      • UD1-8 Description: Enter a generic description that best describes the purpose of each User Defined dimension. See example above.

  • Standard Reports

    • These settings will be applied with auto-generating a report from a Cube View.

      • Logo

      • Height

      • Enter a numerical value to determine the Height of the report. (e.g. 105 pixels)

      • Bottom Margin

      • Enter a numerical value to determine the Bottom Margin size.

      • Title

      • Top Margin

      • Enter a numerical value to determine the Top Margin size.

      • Font Family

      • The font displayed in the Title of the report.

      • Font Size

      • Enter a numerical value to determine the size of the font.

      • Bold

      • If set to True, the Title will be bold in the report.

      • Italic

      • If set to True, the Title will be in italics in the report.

      • Text Color

      • Use the ellipsis icon to choose a text color for the report Title.

      • Header Labels

    • This is where the default Header Label properties are defined for all the reports in the application.

      • Top/Bottom Margin

      • Enter a numerical value to determine the Top/Bottom Margin size.

      • Font Family

      • The font displayed in the Header Labels of the report.

      • Font Size

      • Enter a numerical value to determine the size of the font.

      • Bold

      • If set to True, the Header Labels will be bold in the report.

      • Italic

      • if set to True, the Header Labels will be in italics in the Report.

      • Text Color

      • Use the ellipsis icon to choose a text color for the Header Labels.

      • Header Bar

      • Background Color

      • Use the ellipsis icon to choose a Header Background color.

      • Line Color

      • Use the ellipsis icon to choose a Header Line color.

      • Footer

      • Text

      • An open field to enter footer text.

      • Font Family

      • The font displayed in the Footer.

      • Font Size

      • Enter a numerical value to determine the size of the font in the Footer.

      • Show Line

      • If set to True, the report will show a line in the Footer.

      • Show Date

      • If set to True, the report will show the date in the Footer.

      • Show Page Numbers

      • If set to True, the report will show page numbers in the Footer.

      • Line Color

      • Use the ellipsis icon to choose the color of the line in the Footer.

      • Text Color

      • Use the ellipsis icon to choose a text color in the Footer.

Business Rules

  • Business Rules contain calculation logic configured to run against different parts of an application.

  • These rules are compiled with VB.NET or C# code and are created within a rich integrated development environment, or IDE.

  • There are several areas in the product using the exact same rule syntax and applying it to how data is imported, how the Cubes are calculated, and other operations.

  • Once this syntax is understood, logic can be written.

  • There are three ways to write this calculation logic:

    • Business Rules: These can be stored, secured, and then assigned to multiple areas of the product with the ability to re-use them.

    • Complex Expression: The syntax is the same with the only difference being that a Business Rule can be shared across multiple application artifacts where a Complex Expression is contained within the artifact.

    • Member Formula: The same Business Rule syntax can be applied to Member Formulas as well. This logic stays with the Member and cannot be shared.

  • There are also three utility groups available when writing Business Rules:

    • BRAPI: BRAPI provides application programming interface to commonly used functions involving all areas of the product where a Business Rule can be used.

    • API: The more specific API provided as a Parameter to a Business Rule provides functions specific to the type of Business Rule being written.

    • ARGS: An argument represents the value passed to a Business Rule when the procedure is called and the calling code supplies the arguments.

  • Business Rule Encryption (Decryption)

    • Functionality exists to encrypt and decrypt Business Rules with password protection during creation and saving.

    • Users with proper authorization can encrypt Business Rules by clicking the encrypt button to open an Encrypt Business Rule dialog, where a password is created and re-entered for confirmation.

    • The system encrypts the Business Rule and displays a message