OneStop Reporting 4.5 OSR Report Designer and OSR Player …products.onestopreporting.com/Downloads/files/OSR... · · 2014-12-10OSR Report Designer and OSR Player User Guide

OneStop Reporting 4.5

OSR Report Designer and OSR Player

User Guide

Doc. Version 1.2

Updated: 10-Dec-14

Copyright OneStop Reporting A

Page | i

Contents

Introduction ..................................................................................................................................................... 1

Who should read this manual .............................................................................................................................. 1

What’s included in this manual ............................................................................................................................ 1

Symbols and conventions..................................................................................................................................... 2

Installation ........................................................................................................................................................... 2

OSR Report Designer Overview ........................................................................................................................ 3

The OSR Report Designer interface ...................................................................................................................... 3

OneStop Reporting Excel ribbon .................................................................................................................. 4

Layout Editor ................................................................................................................................................ 8

Report Designer menu ................................................................................................................................. 9

Logging in ........................................................................................................................................................... 10

Connecting to a database................................................................................................................................... 13

Creating reports using OSR Report Designer .................................................................................................. 14

Report building options ...................................................................................................................................... 14

Modules ............................................................................................................................................................. 14

Data items .......................................................................................................................................................... 15

Functions ............................................................................................................................................................ 16

Expressions ......................................................................................................................................................... 16

Using expressions in reports ...................................................................................................................... 18

KPIs ..................................................................................................................................................................... 18

Examples of expressions and KPIs ...................................................................................................................... 20

Creating expressions for INCOME and COGS ............................................................................................. 20

Combining expressions INCOME and COGS in the KPI GROSSMARGIN % ................................................. 22

Creating expression for GROSS MARGIN ................................................................................................... 25

Combining expressions GROSS MARGIN and INCOME in the KPI GROSS MARGIN - in % ......................... 27

Expression Trees ................................................................................................................................................ 28

Manage trees ............................................................................................................................................. 29

Expression Tree Editor ............................................................................................................................... 30

Node/branch properties ............................................................................................................................ 31

Global Values ..................................................................................................................................................... 34

Drill-To Definitions ............................................................................................................................................. 35

Customizing the default drilldown view .................................................................................................... 35

Report parameters ............................................................................................................................................. 35

Report Parameters Wizard ........................................................................................................................ 36

Doc. Version 1.2

Updated: 10-Dec-14

Copyright OneStop Reporting A

Page | ii

Layout Editor ...................................................................................................................................................... 39

Filters ......................................................................................................................................................... 40

Grouping and sorting ................................................................................................................................. 43

Functions.................................................................................................................................................... 46

Expanding Groups ...................................................................................................................................... 47

Property hierarchy ............................................................................................................................................. 50

Executing reports ........................................................................................................................................... 52

Running a report ........................................................................................................................................ 52

Publishing a static reporting ...................................................................................................................... 53

Staging ................................................................................................................................................................ 53

Updating a staging definition ..................................................................................................................... 54

Run a report according to a dimension tree structure .............................................................................. 54

Linking sheets ..................................................................................................................................................... 57

Copy and paste ................................................................................................................................................... 59

Drilldown ............................................................................................................................................................ 60

Customizing the default drilldown view .................................................................................................... 61

Drill-To ....................................................................................................................................................... 61

Macros ............................................................................................................................................................... 67

Built-in Excel security ......................................................................................................................................... 68

Formatting data with leading zeros in Excel .............................................................................................. 69

OSR Player ..................................................................................................................................................... 70

Excel ribbon ........................................................................................................................................................ 70

Options ...................................................................................................................................................... 71

Login tab ............................................................................................................................................................. 73

Report tab .......................................................................................................................................................... 74

Running reports via a staging database ............................................................................................................. 75

Updating a staging definition ..................................................................................................................... 75

Appendix A: Expand Types ............................................................................................................................. 76

OSR Report Designer and OSR Player User Guide

Page | 1

Introduction

OSR Report Designer is the report design application in the OneStop Reporting product suite. You can also execute reports from the OSR Report Designer. OSR Report Designer is a full-blown Excel-based report writer enabling the user to report directly on top of their ERP database, OSR Data Warehouse, or any other data source where an integration package has been or will be set up. In very short time, business users with basic Microsoft Excel experience will be able to create presentation-quality financial statements, operational reports and KPI reports with charts and graphical indicators.

OSR Report Designer provides complete financial and operational report writing based on the familiar Microsoft Excel user interface. As long as an integration (either existing or custom built) exists, users can use OSR Report Designer to report on all of the following data sources:

The organization's ERP system (GL, sub-ledgers, and custom tables)

Other SQL-based transactional databases

SQL-based data warehouses (i.e. OSR Data Warehouse)

OSR Player can be described as the "read-only version" of OSR Report Designer. In other words, the user can execute reports with the ability to apply simple modifications to reports.

Who should read this manual

This manual is designed for OSR administrators and power users who are responsible for designing budget and report templates.

What’s included in this manual

This manual is designed to give an in-depth understanding of how to use the features of OSR Report Designer/OSR Player. When navigating in this user guide, the following information about the three main sections of the user guide may be helpful:

OSR Report Designer Overview: this section gives an introduction to OSR Report Designer and includes information about menus and toolbars as well as information about logging in and creating a connection to a database.

Creating reports using OSR Report Designer: this section explains the functions available in OSR Report Designer for designing and executing reports, including expanding groups, summation, and drill down.

OSR Player: This section describes the functionality of OSR Player.


Page | 2

Symbols and conventions

This manual uses the special symbols to make specific types of information stand out:

Symbol Description

The sunlight symbol indicates helpful tips, shortcuts, and suggestions.

The warning symbol indicates situations we recommend to be aware of when completing tasks. Typically, this includes cautions about completing steps in their proper order or important reminders about how other information in OSR may be affected.

Installation

Please consult the OSR installation guide for details on installing the OneStop Reporting application. Manuals can be downloaded from the Downloads area on www.onestopreporting.com.

The first time you go to Downloads you must register an account. You can then immediately log in using the user name and password you registered.

Prior to running any of the OneStop Reporting applications administrators must create a repository and assign access to the users through the OSR Administration application. See the user guide for OSR Administration for more information.

http://www.onestopreporting.com/


Page | 3

OSR Report Designer Overview

Using OSR Report Designer, users can create formatted Excel-based reports that any Designer or Player user can run live from their own desktop. OSR Report Designer uses the familiar Microsoft Excel user interface and an easy to learn drag-and-drop functionality for creating high quality reports. Furthermore, Excel formatting, calculations, and charts can be applied to the reports. With each execution of the report, users can group and filter information based on report parameters, making the reports dynamic.

The OSR Report Designer interface

Prior to designing a report, users should have a good understanding of the OSR Report Designer interface. The next sections cover the three most important components of OSR Report Designer: the OneStop Reporting Excel ribbon, the Layout Editor window and the Designer menu.


Page | 4

OneStop Reporting Excel ribbon

The OneStop Reporting Excel ribbon can be found at the top of the Excel window and provides easy navigation and access to the key functions in OSR Report Designer.

Excel ribbon button Function

Creates a new report in a new workbook.

Uses the current workbook as the foundation for a new report.

Allow you to upload a report to OSR Portal. (Can only be used if you have access to OSR Portal.)

Allows users to change user accounts by opening the login window.

Opens the Report Configuration window, which allows the user to configure the source database and company. Generally, the user is prompted to perform report configuration when creating a new report.

Allows users to input optional additional information such as the report title and description. Also allows users to enter the password for protected worksheets.

Provides access to report behavior settings, details on the version of OSR Report Designer, and miscellaneous options. The Report Designer Options will be described in more detail later in this user guide.

Opens and closes the Designer menu on the left side of the screen, where users may find the integrated fields from the database as well as pre-defined period functions, trees, and more.

Opens and closes the Layout Editor window, where users can apply filters, sorting, and grouping for the report.

Enables and disables layout comments that display the filters, groupings, and functions used on the sheet, row, column, or cell level of the report.


Page | 5

Excel ribbon button Function

Opens and closes the Report Parameters window, where users can manage the properties for the parameters that have been applied to the report definition.

Enables and disables automatic creation of parameters. When disabled, report parameters will not be created unless the user explicitly creates one using the Report Parameters window.

Options

Choosing the Options button opens the Report Designer Options window. This window contains three tabs.

The Designer tab

Always open Designer in Run mode If the box is checked and a saved report is opened, OSR Report Designer will always open the with the Run tab active.

Insert field title above cell on drop If the box is checked, when a data field is dragged into Excel sheet, OSR Report Designer will automatically create a title one cell above the data field. The title can be modified or deleted in the cell.

Show ‘Create new group’ button in Layout Editor window

If the box is checked, the Layout Editor window will display a new button, which allows the user to manually create a group from the Layout Editor.


Page | 6

Create Group dialog The vertical slider has three settings (Always, Conditionally, and On CTRL). Dependent on the position, OSR Report Designer will always, conditionally, or never prompt the user to create a new group when a data field is dragged into the report definition. If the slider is set to On CTRL, OSR Report Designer will never prompt the user and the user must manually create a group by holding the CTRL key while dragging the field.

Application Allows the user to select language for the OSR application using a dropdown list.

Integration Dictionary Allows the user to select language for the integration package using a dropdown list.

The Application tab

Auto-connect If checked, OSR Report Designer or OSR Player will always connect when Excel is run. However, if unchecked, users will be required to manually connect OSR Report Designer or OSR Player before designing or running a report.


Page | 7

Auto-start report Opening Excel by double-clicking an OSR report via Windows Explorer overrides the setting under Auto-connect, and the OSR Report Designer Excel COM add-in starts automatically when Excel is opened. To prevent the OSR Report Designer Excel COM add-in from starting even when Excel is opened by double-clicking an OSR Report, users can check the Auto-start report option.

To prevent the OSR Report Designer Excel COM add-in from starting automatically no matter how Excel is started, both the Auto-connect and the Auto-start report options must be unchecked.

Sign in automatically If the box is checked, OSR Report Designer will automatically sign-in with the previously logged-on user.

License (Licensed to/Company) Displays the license information.

About… Clicking this button opens a new window with information about the OSR Report Designer version and build number, and the license information.

The Misc tab

Report query timeout Users can setup the duration of time a report should be allowed to query the database before it times out (the default is 300 seconds).


Page | 8

Show RQL output & Show SQL output If this box is checked, a new window will open that displays the query during the report definition. Generally, this option is used for technical analysis or troubleshooting.

Export definition file on save If this box is checked, an ‘.OSR’ formatted file will be created in the same file path as the saved file.

Layout Editor

The Layout Editor allows users to create, edit, and delete business rules. The Layout Editor window can be accessed through the Layout Editor button in the OneStop Reporting Excel ribbon.

The Layout Editor window contains several areas:

Report Level (Sheet filters) (1)

Selects the entire report so that rules (parameter) can be applied to the entire Excel report.

Column/ Row Level (Column selections/Row selections) (2)

Users can select a column or row to create, edit, or delete business rules at the column or row level.

Data display settings (3)

Users may specify the settings for displaying the data in the report.

Expanding If checked, the report will list the details of dimension and create what is known as an expanding group (i.e. list each account rather than grouping the accounts together and displaying a total). Only available at row or column level.

Display blank records If checked, the report will display dimensions with blank records in the report (i.e. if unchecked, empty datasets will not be displayed). Only available at row or column level.


Page | 9

Limit If checked, the report will display dimensions with blank records in the report (i.e. if unchecked, empty datasets will not be displayed). Only available at row or column level.

Edit area for filters, grouping/sorting and functions (4)

Users can specify settings for the filters, grouping/sorting and functions in this area.

Tabs (Filters, Grouping/Sorting, Functions) (5)

The tabs allow users to configure different rules for the selected level.

For details on the various options, see the section Layout Editor on page 39.

Report Designer menu

The Report Designer menu contains two tabs. The Design tab generates the modules and dimensions based on the integration of the database that the user is connected to. The other tab is a Run tab that allows the user to select parameters and execute reports. Each tab contains unique interfaces as explained below.


Page | 10

The Report Designer menu contains several areas:

Tabs (1)

The user can switch between the Design tab and the Run tab.

Dependent on which tab is active, certain functions within OSR Report Designer will be deactivated.

The Design tab

Data items (2a) A list of data items in the database. Data items are dragged into the Excel sheet to create a report template. When you hold the cursor over a data item name, you can see the system name of the data item.

Modules (2b) A list of modules integrated from the ERP system using the metadata. The modules contain the dimensions and measures that can be used to create a report. In addition, functions, expression trees, and report parameters are included below the list of modules. When you hold the cursor over a module name, you can see the system name of the module.

The Run tab

Parameters (3a) Parameters defined in the report design will be listed. Users have the option to specify a parameter by using the Lookup button.

Run button (3b) In order to execute the report, the Run button must be used. Users have the option of running the report in OSR Report Designer or it can be published to a regular Excel worksheet by clicking the drop-down arrow.

Staging If you have chosen a staging database as your data connection and the report you are about to execute is part of a staging definition and you have sufficient permissions, you will see a Staging button next to the Run button. Choosing Staging allows you to update a staging definition by setting the required options.

Logging in

OSR Report Designer utilizes the access management configuration created through OSR Administration to create a secure environment for the organization. Therefore, the user will be prompted for authentication each time OSR Report Designer is opened unless the Sign me in automatically option is activated.

Users may login using the OneStop or Windows User Authentication in the login window as shown below.


Page | 11

Depending on the authentication, users will have access to data as described.

OneStop Admin: the built-in administrator has access to all modules and dimensions in the connected database.

Windows User: the Windows user will have restricted access as configured in the Access Management in the OSR Administration (see the user guide for OSR Administration for details on configuration).

As mentioned above, users may activate the Sign me in automatically option to automatically sign-in to OSR Report Designer as the previously logged in user. Users may activate this option in one of two ways.

The first method is to check the box next to Sign me in automatically in the login window.


Page | 12

The second method is by accessing the Options menu in the OneStop Reporting ribbon, selecting the Application tab, and checking the box next to Sign in automatically.

The second method can also be used to deactivate the Sign me in automatically option.

Users may change login authentication after the initial start-up of OSR Report Designer by selecting the Change Login button in the OneStop Reporting Excel ribbon.

1 2

3

4


Page | 13

Note that if the Auto-login with Windows User option is flagged in the OSR Administration all users will be automatically logged-in with their Windows user when opening OSR Report Designer for the first time. However, after the initial access, the Sign me in automatically option specified in OSR Report Designer will override the Auto-login with Windows User option specified in OSR Administration.

The best practice is to never log in with the built-in Administrator for the purpose of accessing data in a reporting module. Instead, an admin level role should be created in OSR Administration so that all end-users are using Windows Authentication as their login, thus preventing any security breaches.

This is the safest way to use the login structure because if an admin-level user accidentally clicks on sign-in automatically for OSR Report Designer on a terminal server, the next user will be automatically logged in with their AD user. On the other hand, if a user logs in with the built-in Administrator and checks the Sign-in automatically box, the next user will be automatically logged in as the built-in Administrator, thus giving access to all data.

Connecting to a database

Each time a new report is created OSR Report Designer will prompt the user to connect to a database through the Report Configuration window. In addition, users may manually open this window by clicking the Report Configuration button in the OneStop Reporting Excel ribbon.

Available database connections will be displayed in the drop-down list. Choose the required connection to connect to the database.

If no connection has been configured, a connection must be created. For information about how to create a new database connection, see the user guide for OSR Administration.


Page | 14

Creating reports using OSR Report Designer

Report building options

Through the use of OSR Report Designer, users have several different ways of building a report:

Copy an existing report definition and modifying the report.

Import a report definition from a partner or someone outside of the organization.

Use OSR Composer to design the basis for the report and transfer the report to OSR Report Designer.

Paste an Excel export from another report writer into the OSR Report Designer Excel window and add OSR Report Designer properties to the report.

Open an Excel report from another Excel report writer (for example FRx, XL Reporter, SQL Reporting Services, Crystal Reports) and use the New Current option.

Build a report from scratch in OSR Report Designer and use a pre-defined Excel template (which could contain company logo, header styles, etc.).

Build a report from scratch in OSR Report Designer starting with an empty Excel sheet by using the New Blank option.

Modules

Modules can be found in the Design tab in the Designer Menu area of the screen as shown in the illustration below. Modules represent the first layer of organization in the database and contain attributes and dimensions, which can be dragged into the report definition. They can be managed in the organization’s ERP system or the OSR Data Warehouse. See the Report Designer menu section on page 9 for more details.


Page | 15

Data items

Data items can be found in the Design tab in the Designer Menu area of the screen. Data items are considered to be sub-groups and contain information pertaining to the specific module. While designing a report template, users will drag different types of data items into the Excel worksheet.

The three types of data items are explained below.

Dimension

Dimensions represent a table in the connected database. If the dimension is expanded by clicking the button to the left of the dimension name, all attributes of the dimension will be displayed. All attributes and the dimension can be used as filters or displayed in the report view.

Light dimension

Represents a descriptive field in the transaction table of the connected database. Light dimensions can be used as a filter or displayed in the report view.

Measure

Represents a value field in the transaction table of the connected database. Measures can be used as a filter or displayed in the report view.

It is important to note that the different types of data items will trigger certain features such as grouping or filters.


Page | 16

Functions

Currently, all functions are period based and allow the designer to control the group’s displayed data by period. Functions may be dragged into the report definition or the Layout Editor.

Expressions

Expressions can be created and managed through the Designer Menu under Expressions.

Expressions is a way of referring to dimension values outside single reports and are typically used to refer to a selection that will be used in multiple reports. By using an expression instead of an ordinary selection within the report you can easily update multiple reports by editing the expression instead of having to edit each report individually.

For example, if you add an account to your general ledger and you need to include this new account in your reports, it is very time consuming to have to open multiple reports and make sure the new account is included in the selection. If, however, you use an expression and you


Page | 17

need to add an account you simply edit the expression and all the reports where this expression is used will automatically be updated.

It is possible to crate expressions on all dimensions and multiple dimensions can be combined in one expression. Expressions are organized in groups. An expression group may consist of one or multiple expressions.

From the Expression Groups window, users will have access to the following options to manage expressions:

Button Function

Click to create a new expression in the Expression Dialog. Make sure to enter an expression name before starting to select fields for the expression. You may also enter a description for the expression.

Click to open the Expression Dialog and edit the currently selected expression group.

Click to delete the selected expression group.

Click to create a copy of the selected expression group. The newly created expression group may be modified with the Change… function.

Click to open a network browser window and import an expression group. Valid files are other OSR expressions with the *.xml format.

Click to open a network browser window and export an expression group to the location. The newly exported expression group will be in the *.xml format.


Page | 18

Using expressions in reports

To use an expression instead of creating an ordinary selection/filter you do the following:

1. Drag out the relevant dimension from the list of dimensions as usual (for example Account).

2. In the Layout Editor click the X symbol to delete the filter that was created when you dragged in the dimension.

3. Open Expressions from the Designer menu and drag the relevant expression into the filter area.

Note that the expression values cannot be changed in Layout Editor. Any changes must be done via Manage Expressions.

KPIs

KPIs can be created and managed through the Designer Menu under KPIs.

A KPI is a calculation/key figure that you want to reuse across multiple reports. KPIs are used in the same way as measures (amount, quantity). Instead of dragging amount or quantity into the report you drag out the complete KPI.

KPIs can be based on:

1) Expressions (simple or complex selection of dimensions)

2) Measures (amount, quantity)

KPIs based on expressions

When a KPI is based on an expression it must include information about which measure (amount, quantity) it will have effect on. Example: GrossProfit is Sales – Costs. When creating this KPI it will be significant whether you choose actual amount or budget amount as your measure.

A KPI has a formula. The formula is based on expressions and normal mathematical operators (+, -, /, *) and constants.

It is also possible to add period functions to a KPI.


Page | 19

KPIs based on measures

For KPIs based on measures you must select a Factset (module) that the measures you want to use are included in. For example, if you want to use Actual amount from General Ledger you must select the General ledger factset. An example of a measure-based KPI is average price, which is amount divided by quantity.

From the KPI Groups window, users will have access to the following options to manage KPIs:

Button Function

Click to create a new KPI group. In the KPI Groups dialog make sure to enter a KPI group name before starting to select values for the KPI. You may also enter a description for the KPI.

Click to open the KPI Groups dialog and edit the currently selected KPI group.

Click to delete the selected KPI group.

Click to create a copy of the selected KPI group. The newly created expression group may be modified with the Change… function.

Click to open a network browser window and import a KPI group. Valid files are other OSR expressions with the *.xml format.

Click to open a network browser window and export a KPI group to the location. The newly exported expression group will be in the *.xml format.


Page | 20

Examples of expressions and KPIs

To illustrate the creation of expressions and KPIs, we will look at some examples.

Expressions can be created in OSR Report Designer or OSR Composer.

First we will create two expressions called INCOME and COGS. We will then create a KPI called GROSSMARGIN % which uses these two expressions to show the gross margin in %.

Then we will create an expression that shows the gross margin amount and then create a variant of the KPI that shows gross margin in %, using the GROSSMARGIN and the INCOME expressions.

Creating expressions for INCOME and COGS

1. In the Report Designer menu or Composer navigation pane, select Expressions and then Manage Expressions.

2. Expressions are organized in groups so in the dialog that opens click New to create a new expression group. (Our two expressions INCOME and COGS (Cost of Goods Sold) will be added in this group.)

3. In the next dialog, enter an expression group name. (In the example we use Financial Expressions.)


Page | 21

4. Click Add and replace the default text New expression with the name of the first expression; INCOME.

5. Select the INCOME expression, locate your account dimension, drag it into the filters area and set the required accounts that should be part of the INCOME expression. (In the example, accounts 400000:499999.)

6. Then click Add again and call this expression COGS. Repeat the process of dragging your account dimension into the filter area and enter the relevant account information. (In the example, accounts 500000:599999.)


Page | 22

7. Click OK to confirm and exit the dialog.

8. Click Close to exit the Expressions Groups dialog.

Combining expressions INCOME and COGS in the KPI GROSSMARGIN %

Now we will go on to create a KPI that shows gross margin in %. This KPI will be based on the expressions INCOME and COGS.

1. In the Report Designer menu or Composer navigation pane, select KPIs and then Manage KPIs.

2. In the dialog that opens, click New.

3. In the next dialog, enter a KPI group name (in the example Financial KPIs). You may also add a description.


Page | 23

4. Click Add and enter a name of the KPI; GROSS MARGIN %. You may also enter a comment.

5. Our KPI will be based on expressions, so make sure that the Based on Expressions option is selected.

6. Next, you must indicate which measure the expressions that will be included in the KPI are based on. Click the symbol to the right of the Measure box and then find and select the measure that the expressions INCOME and COGS are based on. In our case, this is Amount MST (under Ledger Transactions). Click OK to confirm.


Page | 24

7. Now click the symbol to the right of the Formula box. This will take you to the KPI editor where you can build your KPI.

8. The KPI GROSS MARGIN % will consist of the expression INCOME minus the expression COGS divided by INCOME to get the result in percent. The formula will look as illustrated below:

To build the formula, perform the following steps:

a. In the operators section, click ( (left parenthesis) twice.

b. Drag the expression INCOME into the Formula area.

c. In the operators area, click * (multiply by) and type -1. This is to convert the income amounts that are negative in the ERP system into positives, so that the entities that will be calculated are both positive in order to give the correct result.

d. In the operators area, click ) (right parenthesis).

e. In the operators area, click – (minus).

f. Drag the expression COGS into the Formula area.

g. In the operator section, click ) (right parenthesis).


Page | 25

h. In the operation section, click / (divide by).

i. Drag the expression INCOME into the Formula area.

j. In the operators area, click * (multiply by) and type -1. (Again to convert the income amounts into positives.)

k. In the operator section, click ) (right parenthesis).

l. Click OK to confirm.

9. Click OK and then Close to exit the KPI dialogs.

Creating expression for GROSS MARGIN

1. In the Report Designer menu or Composer navigation pane, select Expressions and then Manage Expressions.


Page | 26

2. In the dialog that opens, select the expression group Financial Expressions and then choose Change.

3. Click Add and replace the default text New expression with the name of the expression; GROSS MARGIN.

4. Select the GROSS MARGIN expression, locate your accounts dimension, drag it into the filters area and set the required accounts that should be part of the GROSS MARGIN expression. (In the example, accounts 400000:599999.)

5. Click OK to confirm and exit the dialog.

6. Click Close to exit the Expression Groups dialog.


Page | 27

Combining expressions GROSS MARGIN and INCOME in the KPI GROSS MARGIN - in %

Now we will create a variant of the KPI GROSS MARGIN % based on the expressions GROSS MARGIN and COGS. To separate it from the first KPI we created we will call this one GROSS MARGIN - in %.

1. In the Report Designer menu or Composer navigation pane, select KPIs and then Manage KPIs.

2. In the dialog that opens, select the KPI group Financial KPIs and choose Change.

3. Click Add and enter a name of the KPI; GROSS MARGIN- in %. You may also enter a comment.

4. Make sure that the Based on Expressions option is selected.

5. Next, click the symbol to the right of the Measure box, find and select the measure that the expressions GROSS MARGIN and INCOME are based on. In our case, this is Amount MST from Ledger Transactions. Click OK to confirm.

6. Now click the symbol to the right of the Formula box. This will take you to the KPI editor where you can build your KPI.

7. The KPI GROSS MARGIN - in % will consist of the expression GROSS MARGIN divided by the expression INCOME. The formula will look as illustrated below:


Page | 28

To build the formula, perform the following steps:

a. Drag the expression GROSS MARGIN into the Formula area.

b. In the operators area, click / (divided by).

c. Drag the expression INCOME into the Formula area.

d. Click OK to confirm.

8. Click OK and then Close to exit the KPI dialogs.

Expression Trees

Expression Trees are predefined structures based on one or more dimensions. The Expression Trees can be used in reports in the same way as ordinary dimensions.

Expression trees can be created and managed through the Designer Menu under Expression Trees.


Page | 29

Manage trees

After accessing the Expression Trees module, users will be able to see a list of existing trees and the link to Manage Trees. Clicking on the link to Manage Trees will open a new window as shown below.

From the Expression Trees window, users will have access to the following options to manage the Expression Trees:

Button Function

Click to create a new expression tree in the Expression Tree Editor. Make sure to enter an expression tree name before starting to select fields for the expression tree. You may also enter a description for the expression tree.

Click to open the Expression Tree Editor and edit the currently selected tree.

Click to delete the selected tree. It is recommended to export the tree before deleting it because deleted trees will not be recoverable.

Click to create a copy of the selected tree. The newly created tree may be modified with the Change… function.

Click to open a network browser window and import a tree. Valid files are other OSR expression trees with the *.xml format.

Click to open a network browser window and export a tree to the location. The newly exported tree will be in the *.xml format.


Page | 30

Expression Tree Editor

The Expression Tree Editor may be accessed when creating a new expression tree or modifying an existing tree. From the Expression Tree Editor, the user is able to create new nodes and branches and has the ability to modify their properties.

The table below explains the options available in the Expression Tree Editor.

Button Function

Allows users to enter a name for the expression tree.

An optional field that allows users to enter additional information regarding the expression tree.

Adds a new node or branch to the expression tree.

Deletes the highlighted node or branch.

Moves the highlighted branch up one level on the expression tree.

Moves the highlighted branch down one level on the expression tree.

When right-clicking on a node or branch, the user will have the option to rename the node or branch.

When right-clicking on a node or branch, the user may display the combined filters in a new window.


Page | 31

Node/branch properties

From the Expression Tree Editor, users will be able to configure the property for each node or branch on the right side of the window.

Each property and their functions will be explained in detail in the below.

Common for OSR Report Designer and OSR Composer

Code Displays the name entered on the node/branch in the tree.

The Code property is an important property the report uses to create the link to the node. It is recommended not to change the Code property manually. Instead, users should rename the node or branch using the Rename function in the tree view.

In addition, users should avoid using the same name for different nodes or branches.

Description An optional field that allows users to enter additional information regarding the node or branch.

Filters Users may define the selection to be included in the report. This is similar to configuring a filter in the Layout Editor window. For more details, refer to the Filters section on page 40.

The Filter field is only active when Expand Type is set to None, Group, or Expanding Group.


Page | 32

OSR Composer only

Reverse Sign Only applies when the tree is used in OSR Composer. Setting this option to True will reverse the sign (+ or -) for the ad-hoc report.

This option is available because GL accounts are posted with opposite signs (negative for revenue and positive for expenses). For OSR Report Designer signs may be reversed by manually entering a formula, such as (=OSRGet(“Amount”)*-1), into the report definition.

OSR Report Designer only

Expand Type Users can select the expand type from the drop-down menu. This is one of the most important properties of nodes and branches and will dictate exactly how rows are grouped and expanded in the report definition and the generated report. The table below shows a summary matrix of each expand type available for the user. For more details of each expand type see Appendix A: Expand Types.

Expand Type

Functionality Node None Text Group

Expanding

Group

Row Group created Expanding flag checked Filter capability

(aggregate

accounts)

(aggregate

accounts)

(list accounts)

Automatic Update

If Add/delete BRANCHES?

If Add/delete FILTERS? n/a n/a

Display

Branch displays in Tree Design

Branch displays in Report Design (when tree


Page | 33

dragged out)

Branch displays in finished report (when report is run)

(only

displays

accounts

from

children)

(one

aggregate

row of

filtered

accounts

(placeholder

description or

result of

associated

formula)

(one

aggregate

row of

filtered

accounts)

(list with each

account in

filter on its

own row)

Expanding Field This field is only active if Expand Type is set to Expanding Group. Users can specify which dimension or attribute the expansion will group on and be displayed in the report definition and generated report.

The process to choose the dimension or attribute is similar to using the Designer Menu. Simply select the desired module and browse for the dimension or attribute.

If Expand Type is set to Node, the Expanding Field will automatically be filled as Node Name and may not be changed by the user.

Style Configures the row with the selected Excel formatting style. Customized styles can be created by the user in Excel and used here as well. The illustration below displays the pre-set styles offered in Excel.


Page | 34

Global Values

Version 4.5 introduces the ability to define shared Global Values that can be used across multiple reports and forms. The picture below shows how a Global Value is defined and how it may be referred to in a report/form.

Global Values support the string, integer and float data types.

Styles

20% - Accent 1 1000 60% - Accent 4 1000 Currency [0] 1,000$

20% - Accent 2 1000 60% - Accent 5 1000 Explanatory Text 1000

20% - Accent 3 1000 60% - Accent 6 1000 Good 1000

20% - Accent 4 1000 Accent 1 1000 Heading 1 100020% - Accent 5 1000 Accent 2 1000 Heading 2 1000

20% - Accent 6 1000 Accent 3 1000 Heading 3 1000

40% - Accent 1 1000 Accent4 1000 Heading 4 1000

40% - Accent 2 1000 Accent5 1000 Input 1000

40% - Accent 3 1000 Accent6 1000 Linked Cell 1000

40% - Accent 4 1000 Bad 1000 Neutral 1000

40% - Accent 5 1000 Calculation 1000 Normal 1000

40% - Accent 6 1000 Check Cell 1000 Note 1000

60% - Accent 1 1000 Comma 1,000.00 Output 1000

60% - Accent 2 1000 Comma [0] 1,000 Percent 100000%

60% - Accent 3 1000 Currency 1,000.00$ Title 1000Total 1000 Warning Text 1000


Page | 35

Drill-To Definitions

Drill-to definitions created in the report definition will be displayed in the Drill-To Definitions pane. Furthermore, drill-to definitions created in the Layout Editor can be reused throughout various sections of the report design by dragging drill-to definitions from the Drill-To Definitions pane into the Drill-To tab of the Layout Editor.

In the Drill-To Definitions pane, users can Edit and Delete definitions by highlighting the desired definition and clicking on the appropriate option presented near the bottom of the pane.

New Drill-To Definitions must be created from the Layout Editor.

For more details on how to use the drill-to feature, see

Customizing the default drilldown view

You can customize the default drilldown view to display fields of your choice and in the order of your preference. Customization of the default drilldown view is done in the OSR Administration module. See the user guide for OSR Administration for instructions how to set up a customized drilldown view.

Drill-To on page 61.

Report parameters

The parameters created in the report are displayed in the Report Parameters pane. These parameters can be dragged into the report definition so that the reader can identify which parameters were used to generate the report.

It is important to note that the Report Parameters pane is different than the Report Parameters Window which can be accessed through the OneStop Reporting ribbon.


Page | 36

Report Parameters Wizard

Report parameters allow designers to create a dynamic report so that the same report template can be used for multiple reports with minimal adjustments. For instance, a departmental budget report can be created for multiple departments by changing the Department parameter at the time of execution.

Manage parameters via the Report Parameters button

Report parameters can be managed in two different ways. The first method is to access the Report Parameters button in the OneStop Reporting Excel ribbon. The new window will allow users to create, modify, and delete parameters.

To create a parameter, drag a data item from the Designer Menu into the Report Parameter window. In order to modify a parameter, click the button with the pencil. To delete a parameter, click the button with the red x. Parameters can be reordered by using the arrow buttons, which in turn affects the display order of parameters in the Run tab.

Whether users are creating or modifying a parameter, they will access the Report Parameter Wizard. The wizard is composed of three pages that are explained below.

On the first page, users can specify the name of the parameter and the prompt text that should be displayed in the Run tab.


Page | 37

The parameter name cannot be changed after the initial creation of the parameter.

The next page allows users to select the parameter prompt style. By default, Lookup Edit is selected, but this can be modified to fit the requirements of the report.


Page | 38

On the last page of the Wizard, users can modify several options:

Default value The value or values entered into the text box or those selected through the Lookup button will automatically be inserted for the parameter when the Run tab is accessed. However, the value can be changed at run time.

Lookup filter Power-users can manage the data users are able to view in the Lookup window for the particular parameter. For instance, this feature may be useful when reports are supposed to be run only for the last two periods. Keep in mind that this feature does not override restrictions set in Access Management. If a value is excluded in Access Management, it will never be displayed in the Lookup window for the particular user.

Hidden Enabling this feature will hide the parameter in the Run tab. This feature is useful when the parameter is required for testing, but in actual deployment, the parameter will always be the same value.

Note! If the Hidden feature is enabled, users are required to choose a default value.

Allow empty (=All) If the box is checked, the report may be executed even if this parameter is left empty. If the parameter is left empty, the report will contain all values in the parameter.

Allow multi-selection If the box is checked, multiple values can be selected in the parameter prompt (i.e. multiple accounts vs. one account)


Page | 39

Create sheet per value If this box is checked, OSR Report Designer will create a new Excel sheet in the same workbook for each of the unique values chosen for the parameter (i.e. selection of multiple departments will result in a sheet for each selected department).

Note! This feature cannot be used with OSR Planning templates, as it will prevent the templates from working correctly.

Sheet name field If the Create sheet per value is active, users can specify the name for the new sheets by using the Lookup option.

Managing parameters via the Layout Editor

The second method for managing parameters is through the Layout Editor. When filters are created on sheet, column, or row level, users can specify parameters by using the Lookup button and accessing the Parameters tab.

Users may create a parameter by assigning a parameter to the filter or selecting Create a new Parameter which will open the Report Parameter Wizard.

Existing parameters can be found by selecting the Report Parameters button in the OneStop Reporting Excel ribbon or by selecting the Report Parameters module in the Designer Menu.

Layout Editor

The Layout Editor is primarily used for managing filters, grouping/sorting and functions for cell, row, column, and sheet level business rules. The Layout Editor can be accessed by clicking the


Page | 40

Layout Editor button in the OneStop Reporting Excel ribbon. The various functions in the Layout Editor are explained in the next sections.

Filters

Filters maybe applied to groups created on sheet, row, column, or cell level. In order to create filters, the user may drag an item from the Designer Menu into the appropriate area in the Layout Editor (area below the text Drag fields into area below to create filters). An example is shown in the illustration below.

Creating and managing filters is a key feature in designing a report definition. The next sections will cover the basics of configuring filters. Existing filters can be accessed by clicking on the boxes on the respective row or column as shown in the illustration below. Also, filters can be modified or deleted from the Layout Editor window.


Page | 41

Operators

Using operators is one way that designers can create a customized filter for their need. Similar to operators in mathematics or programming languages, the operators dictate an action or procedure taken by OSR Report Designer.

In the first drop-down box, two options are available:

Blank This selection will include all data inside the specified filter.

Not This selection will include all data outside the specified filter.

If there are multiple filters in the same group, the following options will be available in the first drop-down box:

And Will filter the first condition AND the second condition.

Or Will filter the first condition OR the second condition.

And Not Will filter the first condition AND NOT the second condition.

Or Not Will filter the first condition OR NOT the second condition.

The filter operators contained in the second drop-down box are explained below:

In dimension is In… (the selected parameters)

<> dimension is Not equal to…

< dimension is Less than… (for numerical values)

> dimension is Greater than… (for numerical values)

<= dimension is Less than or equal to… (for numerical values)


Page | 42

>= dimension is Greater than or equal to… (for numerical values)

Begins with dimension Begins with… (for any phrase contained in the dimension)

Ends with dimension Ends with… (for any phrase contained in the dimension)

Contains dimension Contains… (any part of the phrase contained in the dimension)

Like OSR Report Designer will retrieve any data using “LIKE …” in SQL. For more information on the LIKE operator, consult a SQL server guide.

The Like operator is for advanced users and requires knowledge of SQL.

Dimension Lookup

Filters can further be configured by using the dimension lookup function. The attributes available to filter for the specific dimension will be displayed when the designer clicks on the dimension lookup button. (The button with the magnifying glass.)

From the Lookup window, the user may specify the dimension to remain static or dynamic depending on the report requirements.

To create a static filter, select the List tab in the Lookup window. Select the desired account, department, entity, etc. and click OK.

Use ranges If this box is checked and multiple data items are selected, the selected data will be displayed as a range in the text box at the bottom of the


Page | 43

window. If this box is not checked, all selected data will be displayed individually in the bottom text box.

Include empty If this box is checked, the filter will include data associated with the NULL data set.

To create a dynamic filter, select the Parameter tab in the Lookup window. See Report parameters on page 35 for information on how to set up a parameter.

In order to manually create a parameter, designers can type “{@Dimension_Name}”.

For Period dimensions, users can specify the value current period +/- for single period parameters. This allows OSR Report Designer to select the correct period based on the computer date; therefore, report parameters do not need to be updated manually prior to running a scheduled report.

Grouping and sorting

Grouping and sorting can be accessed by clicking the Grouping/Sorting tab near the bottom of the Layout Editor window.

Note! The Grouping/Sorting tab is unavailable if the report level is selected. In addition, grouping will not occur if the Expanding box is unchecked.


Page | 44

Icons in the Grouping/Sorting tab:

Icon Function

Increase or decrease the precedence of the data item in the sorting order.

The drop-down menu allows users to select the display option of the row, column, or cell. Options available are None, Group, Sum, Min, Max, and Count.

If this icon is displayed, the sorting will be in ascending order for the group. Click on this icon to cycle through sorting options.

If this icon is displayed, the sorting will not exist for the group. Click on this icon to cycle through sorting options.

If this icon is displayed, the sorting will be in descending order for the group. Click on this icon to cycle through sorting options.

Delete the data item from the Grouping/Sorting tab.

Grouping

OSR Report Designer will automatically display data items on row or column level if a dimension or light dimension has been dragged into a cell and a group already exists on row or column level. An example is shown in the illustration below.


Page | 45

In essence, grouping the account dimension displays results at the account level even if there are detailed sub-accounts. If the account data field is not grouped, the report will display all sub-accounts at the time of execution.

For more details on grouping, see Expanding Groups on page 47.

Sorting

On column and row level, dimensions can be reordered to create a hierarchy of sorting by clicking the arrow buttons next the dimension name. For instance in the settings shown in the illustration above, the generated report will be presented in numerical order of account number (as shown in the illustration to the left below). However, if the Description dimension is moved to take precedence over Account, the generated report will be presented in alphabetical order of the account description (as shown in the illustration to the right below).

In addition, OSR Report Designer will automatically display data items in the Layout Editor on cell level if a measure has been dragged into a cell and a group already exists on row or column level. The same options are available for cell level grouping and sorting. The illustration below shows an example.


Page | 46

Functions

Functions can be accessed by clicking the Functions tab at the bottom of the Layout Editor window. The Functions tab generates a list of functions applied to the selected column or row.

In order to insert functions, which are found under Functions in the Designer Menu, users have two options. The first is to drag the function into a cell of a report. Dragging a function into a report will automatically create a function for the column. The other method is to drag the function into the Layout Editor window under the Functions tab. Both methods are shown in the illustrations below.

Method 1:


Page | 47

Method 2:

Currently, all functions are period based and allow the user to control the group’s displayed data by period.

Expanding Groups

Expanding groups are an essential part of OSR Report Designer.

As explained in a previous section, checking the Expanding box in the Layout Editor window will create expanding groups in the specified row or column for data items that have been set to Group in the Grouping/Sorting tab.

The quickest way of creating an expanding group is by dragging a data item, such as Sales Person into the report definition and select Create a new selection group on the Row or Create a new selection group on the Column.

By default, OSR Report Designer will create an expanding group show the group in the Grouping/Sorting tab in the Layout Editor window.


Page | 48

The process is illustrated below:

If the row/column is an expanding group, it will be indicated by a small green plus sign in the box of the respective row or column.

When the report is generated and an expanding group is not created, the report will result in consolidation of all data in the account, as shown in the illustration below.


Page | 49

On the other hand, if an expanding group is created, the details of the account will be given, as shown in the illustration below).

Expanding Groups in expanding groups

In order to create more flexible reporting, expanding groups can be created inside other expanding groups (nested expanding groups).

An expanding group inside another expanding group can be thought of as a hierarchy. Imagine there are two data sets, one alphabetical and the other numerical (A, B, C… & 1, 2, 3…), and one is an attribute of the other. In order to create a nested expanding group, follow the steps below:

1. Drag the relevant data items into the report definition and when prompted, choose Create a new selection group on the Row. The two data items must be placed on consecutive rows.

2. By default, OSR Report Designer has created two separate expanding groups. However, in order to create a nested expanding group, go to the Layout Editor window and drag the expanding group box so that it extends over multiple rows.


Page | 50

The reports for separate expanding groups (left) and a nested expanding group (right) are shown below.

Property hierarchy

Before designing a report with OSR Report Designer, it is important to understand how OSR Report Designer applies dimensions so that reports can be created efficiently.

Essentially, OSR Report Designer asserts more control over the workbook than traditional Excel add-ins that only apply business rules on cell level. OSR Report Designer allows users to insert business rules at four levels:

Report level: applies to the entire report

Column level: applies to all cells in the applicable column

Row level: applies to all cells on the applicable row

Cell level: applies only to the applicable cell


Page | 51

A very typical example would be a financial statement with the following location for business rules:

Period and department/company parameters (filters): report level

Account selections: row level

Period selections (Current Period, Year-to-Date, etc.): column level

Sum and variance formulas: cell level

Users can see business rules in the Layout Editor window by clicking on the boxes displayed for the sheet level and the row or column level as shown below. To see the cell level business rule, users simply need to click in the particular cell in the Excel worksheet.


Page | 52

Executing reports

After a report definition is completed, it can be run (executed) in OSR Report Designer or OSR Player. From OSR Report Designer a report can also be published as a static Excel file for distribution to individuals without a Report Designer or Player license.

Reports can also be executed in OSR Portal. For information about using the web-based OSR Portal, see the user guide for OSR Portal.

When the Run tab is active in OSR Report Designer users will be unable to save any changes made to the document. Report definitions may only be saved while the Design tab is active.

Running a report

From OSR Report Designer the report definition can be executed from the Run tab in the Designer Menu as shown in the illustration below.

Depending on the report definition, there may be multiple parameters. For each parameter, the viewer can use the Lookup button to select the desired parameter. (See Report parameters on page 35 for more details.)

After the parameters are chosen, the report can be executed by clicking the Run button.


Page | 53

Publishing a static reporting

Static reports are normal Excel reports without connection to the ERP database that can be e-mailed to non-licensed users. The user follows the same steps as dynamic reporting, except on the last step where they must click the drop-down arrow in the Run button and select Publish. After clicking the Publish button, the Designer Menu will disappear and the static report may now be saved as a regular Excel file and shared with non-licensed users.

If the connection to the database is stopped or disconnected at any point, the report will not be generated correctly. This will occur even if the connection is reestablished.

Staging

When executing reports in OSR Report Designer you can choose to either run reports live from the database or use a staging database. (Provided your organization has set up one or more staging databases.)

The staging option only applies to reports or queries that are part of a staging definition. For more information about creating a staging definition, see the user guide for OSR Administration.


Page | 54

The purpose of staging is to improve performance during report execution and remove load from the ERP production databases. If you have very large ERP databases and are running complex reports, staging is recommended in order to improve the reporting process.

A staging definition appears as a data connection and can be selected under Report Configuration which can be accessed either by clicking the Report Configuration icon in the OneStop Reporting Excel ribbon or by clicking the link above the Designer menu.

If you select a staging definition as your data connection, you will only see the company that the staging definition is created for.

You can easily switch between live execution of reports and staged execution using the link in the Designer menu.

If you choose to run a report that is part of a staging definition when staging is in process, the execution will fail and you will see an error message.

Updating a staging definition

If a user has been given sufficient permissions in OSR Administration the user can refresh the staging database.

The user can edit the time span that the staging database should collect data for and if required, edit the update mode.

To update the staging definition, choose Staging from the Run tab, make the required changes and then choose Run to execute the report from the staging database.

Run a report according to a dimension tree structure

Some integration packages support tree structures on dimensions. For users running on these integration packages it is possible to run a report according to a tree structure.


Page | 55

The example below shows how to use the Tree parameter selection. In this example we want to be able to select one Entity node in a tree and would like all sub-entities for the selected Entity to have their results distributed per sheet in the report. It is also possible to consolidate all the nodes in one sheet.

How to run a report according to a BI360 tree

1. Design your report according to your requirements.

2. If you want one sheet per node in your report, select the Sheet filters level in the Layout Editor. Then drag the Entity attribute out to the filter selection area.

3. The Parameter Wizard will appear.

4. The integration knows that there is a tree structure associated with the Entity dimension and it will offer you to choose a Tree-selector as the parameter type:


Page | 56

5. Select the Tree parameter type and select the option Create sheet per value since you want to have one sheet per entity in the report.

6. You can now run the report. Simply select the node representing the parent of all nodes in the tree structure you want to generate the report for:

The result is a report with a sheet per node (in this case Entity) including the parent node:


Page | 57

Linking sheets

Linking sheets in OSR Report Designer cannot be done in the same manner as in a regular workbook. To link sheets in OSR Report Designer formulas are required because of the complexities of expanding groups and references between worksheets. This section will explain the steps of setting up a simple linked sheet. The concept can be applied to design more complex reports.

In this example, two identical sheets will be created, but the second sheet will reference cells from the first sheet.

1. First, create a simple report by accessing the General Ledger folder and inserting department, account, description (under the account dimension), and amount into cells B8 through E8. In addition, drag the Period dimension into cell E6 and the Year to date function from the Functions module into cell E3. The report should look like the illustration shown below. Make sure that a group is created on row 8 and column E.


Page | 58

2. Create a copy of the worksheet by right-clicking on the sheet tab, then selecting OneStop Reporting >> Copy. Next, right-click on a new sheet tab, then select OneStop Reporting >> Paste as new.

3. Now, reference names must be created on the first sheet. Access the first sheet (Sheet 1) and highlight cells E6 and F6. In the name box, rename this set of cells as Period2.

The reason for selecting an extra cell to the right is because the group in column E contains an expanding group that will result in an unknown number of columns. Selecting the extra cell ensures that all columns created by the expansion is included in the reference. The same would apply if an expanding group existed in the row group. However, for an expanding group on a row, the extra cell selected should be one cell below.

4. Next, access the copied version of the report in Sheet1(1). Erase the contents of cell E6 and link the period from the original sheet by inserting the formula =INDIRECT(“Sheet1!Period2”).


Page | 59

5. The report may now be executed and the sheets will look identical because the Period dimension in the second sheet is referencing the Period dimension in the original sheet.

Copy and paste

In a report definition created through OSR Report Designer, copying and pasting can be different than in a regular workbook in Excel. This traces back to the fact that business rules are applied not only on cell level, but also on report, row, and column level. This section will explain the rules of copy and paste for various business rule levels.

Cell level

The copy and paste rules in OSR Report Designer are the same as for a regular workbook. By default, formulas and groupings are preserved.

Row/Column level

The copy and paste rules in OSR Report Designer are the same as for a regular workbook when working in a single worksheet. By default formulas and groupings are preserved.

Note! If rows/columns are pasted into a different tab than the original source, groupings will not be preserved.

Report level

The copy and paste rules in OSR Report Designer for an entire new tab requires designers to use a special copy button. By using this button, all formulas, groupings, and parameters will be preserved.

1. The button can be found by right-clicking the desired tab to copy, then selecting OneStop Reporting>>Copy.

2. Next, right click on a blank tab, then select OneStop Reporting ->Paste as new.


Page | 60

Pasting the tab will overwrite all information on the tab that was selected when taking the second step. It is very important to create a blank worksheet so that no data will be lost.

Drilldown

The simple Drilldown option allows users to see the underlying detail of the value presented in the report. To enable this feature, users can select a measure field in the report definition, click on the Drill-To tab in the Layout Editor, and select the Use Default Drilldown feature.

To drill-down on any number to see the underlying journal entry level details from the same module, simply right-click any number in the executed report. In the pop-up menu, choose OneStop Reporting and then Drilldown. The result of the drill-down will appear on a new tab


Page | 61

(new worksheet) in Excel called #DrillDown and each resulting column will automatically be given filters.

Customizing the default drilldown view

You can customize the default drilldown view to display fields of your choice and in the order of your preference. Customization of the default drilldown view is done in the OSR Administration module. See the user guide for OSR Administration for instructions how to set up a customized drilldown view.

Drill-To

Drill-To is an advanced drilldown feature that will allow users to drill down across multiple modules. For example, users can begin with a report showing values from the General Ledger, and can then drill down to see the underlying values from the Accounts Receivable sub-ledger.

In order to use the Drill-To feature, users must configure the Drill-To Definition in the report template. Drill-To Definitions must be created on the cell level selecting a cell that will be the common dimension between the two different modules. For instance, the shared dimension could be the Account number or the Voucher number. When the Drill-To feature is used, OSR Report Designer will use the specified dimension to retrieve entries from the sub-ledger.


Page | 62

The illustration below shows the interfaces involved in configuring the Drill-To feature.

Button Function

Drill-To tab This tab is only available when the user has selected a cell.

Create This button will create a new Drill-To definition and open the Drill-To Builder.

Drill-To item A list of Drill-To definitions applied to the specific cell is generated. Users may edit or delete the definition by clicking on the appropriate buttons.

Users will configure the Drill-To Definition through the Drill-To builder. Configuration is required so that OSR Report Designer is able to filter through to the proper sub-ledger using parameters or drill source dimensions.


Page | 63

Interface Name Function

Name Users are able to create a descriptive name so they are able to easily identify the Drill-To Definition.

Module list In this section, the selection of Modules is displayed. From the list of Modules, users can drag dimensions into the Drill-To details and filters section to configure the Drill-To Definition.

Drill-To details

Data items can be drag into this section to create column headers in the resulting Drill-To worksheet. The column headers can be reordered by dragging the header title. Moreover, the data item can be removed by clicking on the header title once.

Drill-To filters Data items can be dragged into the filters section so that the Drill-To Definition can be configured to filter to the correct detailed transactions.


Page | 64

When using the Lookup button in the Drill-To filters, users will have the following options:

Tab Description

List In this pane a filter based on a constant value can be selected.

Parameter In this pane a filter based on a parameter from the report definition can be selected.

Drill-To

In this pane a filter based on the attribute context of the Drill-To originating cell can be selected. The availability of fields in this pane is based on the dimensions and attributes that are used on the particular row or column in the report definition.

How to configure a simple Drill-To Definition

In this section, a simple Drill-To Definition will be created that allows users to run a simple P&L statement using the OSR Data Warehouse integration and drill to the HR sub-ledger. In the HR sub-ledger, there are details of the employee salaries. However, in the simple P&L statement, only a summary value exists.

Begin with a simple P&L statement as shown in the illustration below. The Drill-To Definition will be created on cell E12 and will be configured to drill to the HR sub-ledger.


Page | 65

To create the P&L statement above, refer to the OSR Planning User Guide and follow the steps in the Exercise section.

Now, the Drill-To Definition will be configured.

1. The Drill-To configuration can be accessed in the Layout Editor. Click on the cell that corresponds to the Amount field for the Expenses section and access the Drill-To tab.

2. Create a new definition by clicking on the Create button.

3. The Drill-To builder window is displayed. In the Name section, enter GL to HR Drill.

4. In the Module List, open the Payroll sub-ledger. From the Payroll sub-ledger, drag dimensions into the Drill-To details area that the user wants to display in the Drill-To report. An example is shown in the illustration below. Note that this is very similar to creating column headers in OSR Composer.


Page | 66

5. Next, configure the filters used to drill to the values in the sub-ledger. These filters are crucial for setting up the correct Drill-To Definition. Dimensions used in the original report template can be used so that data from unrelated dimension codes can be filtered out.

For this particular example, the Account and Period filters reference the drill source account and periods. This means that OSR Report Designer will reference the dimension code found in the particular row or column when the Drill-To feature is used.

The Category dimension uses a static filter, whereas the Department, Entity, and Scenario filters are using the parameters from the report definition.

The Drill-To Definition has now been configured and the report is ready to be run. The illustrations below show the generated report and the Drill-To sheet.

Drill-To cell E15 by right-clicking the cell and selecting the Drill-To feature from the OneStop Reporting option.


Page | 67

The Drill-To result will create a new tab and will display values based on the Drill-To details and filters that were configured in the above steps.

Macros

Excel allows users to program custom Macros through the user of VBA (Visual Basic for Applications). OSR Report Designer allows users to configure a report definition so that a macro will be called after the report is generated.

In order to set a macro to run automatically, follow these simple steps:

1. Press Alt+F11 to open the VBA window.

2. Double-click This Workbook to open the coding window.

3. Create a macro in VBA under This Workbook.


Page | 68

4. Name the macro OSR_ReportComplete().

5. Generate the report and the macro will be triggered automatically.

See the illustration below for specific details.

Built-in Excel security

Excel has two different built-in security features.

The first is security on the Excel file level. Users may protect the entire file by requiring a password to open and modify the workbook. This type of security does not interact with OSR Report Designer and purely restricts who can access the report definition. For more information on security on the file level, refer to the appropriate Microsoft Excel documentation.

The second type of built-in security for Excel is the protect worksheet or protect workbook feature. By using either of these features, users can lock the worksheet cells so that users may not modify the contents of locked cells unless the worksheet or workbook is unprotected. If this feature is used, there is a direct interaction with OSR Report Designer reading the protected report definition. Therefore, report designers must provide the password used to lock the worksheet/workbook in the Report Properties -> Protection tab (see illustration below). Otherwise, the report will not be generated and an error message will be shown.


Page | 69

Formatting data with leading zeros in Excel

If data generated in the report contains leading zeros (i.e. Department numbered 000), Excel will only display a single 0. However, users can properly display leading zeros by simply adding parenthesis before and after the OSR function in the formula bar. (See illustrations below.)


Page | 70

OSR Player

OSR Player can be described as the "read-only version" of OSR Report Designer. Users with access to OSR Player will be able to run reports and specify parameters similar to the features in the Run tab in OSR Report Designer. The OSR Player interface includes the OneStop Reporting Excel ribbon, the Login tab, and the Report tab. These features will be explained below.

Excel ribbon

OSR Player features a OneStop Reporting Excel ribbon similar to the one in OSR Report Designer. However, functionality is limited to three buttons for OSR Player.

Button Function

Opens the Report Configuration window, which allows the user to configure the source database and company.

Provides access to report behavior settings, details on the version of OSR Player, and miscellaneous options. See more details regarding Options below.

Opens and closes the OSR Player menu bar on the right side of the screen, where users may find the Login and Report tab.


Page | 71

Options

The Report Player Options window contains the following options:

The Player tab

Application Allows the user to select language for the OSR application using a dropdown list.

Integration Dictionary Allows the user to select language for the integration package using a dropdown list.

The Application tab

Auto-connect If checked, OSR Report Designer or OSR Player will always connect when Excel is run. However, if unchecked, users will be required to manually connect OSR Report Designer or OSR Player before designing or running a report.

Auto-start report Opening Excel by double-clicking an OSR report via Windows Explorer overrides the setting under Auto-connect, and the OSR Report Designer Excel COM add-in starts automatically when Excel is opened.


Page | 72

To prevent the OSR Report Designer Excel COM add-in from starting even when Excel is opened by double-clicking an OSR Report, users can check the Auto-start report option.

To prevent the OSR Report Designer Excel COM add-in from starting automatically no matter how Excel is started, both the Auto-connect and the Auto-start report options must be unchecked.

Sign in automatically If the box is checked, OSR Report Designer will automatically sign-in with the previously logged-on user.

License (Licensed to/Company) Displays the license information.

About… Clicking this button opens a new window with information about the OSR Report Designer version and build number, and the license information.

The Misc tab

Report query timeout Users can setup the duration of time a report should be allowed to query the database before it times out (the default is 300 seconds).

Show RQL output & Show SQL output If this box is checked, a new window will open that displays the query during the report definition. Generally, this option is used for technical analysis or troubleshooting.


Page | 73

Login tab

When OSR Player is opened, the application will prompt the user for authentication. As opposed to the OSR Report Designer interface where a separate login window is displayed, OSR Player prompts the user for login through the Login tab to the right in the Excel window.

The Login tab features three options:

Use Windows Authentication By default, OSR Player uses OneStop Reporting authentication. However, Windows User authentication can be used by checking the box next to Use Windows Authentication. If this option is used, the user name and password fields will be completed automatically.

Remember my credentials If this box is checked, OSR Player will automatically insert the user name of the previously logged-in user.

Sign me in automatically If this box is checked, the previous user will be logged in automatically at the start of the application. Configuration of this feature is also available under the Application tab in the Options menu.


Page | 74

Report tab

After entering the proper credentials, the user can access the Report tab.

The Report tab has three functions as shown in the illustration above.

Parameters The parameters are presented in the Report tab, allowing the user to execute dynamic reports.

Depending on the report definition, there may be multiple parameters. For each parameter, the user can use the Lookup button to select the desired parameter.

After the parameters are chosen, the report can be executed by clicking the Run/Publish button.

Run/Publish Clicking this button will execute the report in dynamic or static reporting mode dependent on the user’s preference. Modes can be switched by pressing the drop-down arrow on the button.

In order to run a dynamic report, execute the report in Run mode.

In order to run a static report, execute the report in Publish mode.

Dynamic reports are only accessible for Designer and Player users.

Static reports are normal Excel reports that can be shared with non-licensed users.

1

2

1 3

1


Page | 75

Running reports via a staging database

When executing reports in OSR Player you can choose to either run reports live from the database or use a staging database. (Provided your organization has set up one or more staging databases.)

The staging option only applies to reports or queries that are part of a staging definition. For more information about creating a staging definition, see the user guide for OSR Administration.

The purpose of staging is to improve performance during report execution and remove load from the ERP production databases. If you have very large ERP databases and are running complex reports, staging is recommended in order to improve the reporting process.

A staging definition appears as a data connection and can be selected under Report Configuration which can be accessed either by clicking the Report Configuration icon in the OneStop Reporting Excel ribbon or by clicking the link above the Designer menu.

If you select a staging definition as your data connection, you will only see the company that the staging definition is created for.

If you choose to run a report that is part of a staging definition when staging is in process, the execution will fail and you will see an error message.

Updating a staging definition

If a user has been given sufficient permissions in OSR Administration the user can refresh the staging database.

The user can edit the time span that the staging database should collect data for and if required, edit the update mode.

To update the staging definition, choose Staging from the Run tab, make the required changes and then choose Run to execute the report from the staging database.


Page | 76

Appendix A: Expand Types

Expand Type

Functionality Node None Text Group

Expanding

Group

Row Group created Expanding flag checked Filter capability

(aggregate

accounts)

(aggregate

accounts)

(list accounts)

Automatic Update

If Add/delete BRANCHES?

If Add/delete FILTERS? n/a n/a

Display

Branch displays in Tree Design

Branch displays in Report Design (when tree dragged out)

Branch displays in finished report (when report is run)

(only

displays

accounts

from

children)

(one

aggregate

row of

filtered

accounts

(placeholder

description or

result of

associated

formula)

(one

aggregate

row of

filtered

accounts)

(list with each

account in

filter on its

own row)

Before going into the details of expanding types, the user should be familiar with the terms used in this section.

Row Group If an expand type creates a row group, data will be pulled from the database. In addition, a row group will be displayed inside a cell on the report definition and a group on the row will be created in the Layout Editor. The illustration below contains two nodes. The first is an expand type that creates a row group and the second does not create a row group.


Page | 77

Expanding If the box next to Expanding is checked for the particular expand type, the row will create an expanding group when the report is generated. In other words, individual accounts will be displayed in their own rows. For more details on expanding groups, see the section on on Expanding Groups on page 47.

Filter capability

The filter capability simply determines if the expand type allows users to create a filter similar to those seen in OSR Report Designer. When a filter is created, those dimension/attribute values will be the only ones pulled from the database.

Dependent on the expanding setting, the filtered data will be consolidated or expanded on each row.

Automatic Update

Expression trees may be used in multiple reports and their capability to automatically update makes them extremely useful. However, there are specific restrictions on when the trees will automatically update.

If filters are modified Changes to filters in any expand type will automatically update in any existing report using the specific tree.

If nodes/branches are modified

Trees will not be automatically updated unless they use a combination of Node and None types.

If the layout of the report definition will be changed due to the modification of the tree, the tree will not automatically update to avoid unwanted changes to the report definition.


Page | 78

Each expanding types have specific purposes in the expression tree and have restrictions on when they can be used. The next paragraphs will explain each expand type and special characteristics associated with each one.

Node

By default, the top-level of any tree will have its Expand Type set to Node. However, users may freely change the expand type. Most often, the Node type is used with the combination of the None type so that trees may be automatically updated.

A row group will be created, but the user will not be able to set a filter for the expand type. Rather, the filter of the node is determined by the child branches and their filters. For any child branch, the Node type will create an expanding group.

None

The None expand type cannot be used at a parent level or the summary level of an expression tree. In addition, if the child branch/node is the None type, then the parent must be a Node type.

A row group will not be created. In fact, the node or branch with the None expand type will not be displayed on the report definition. However, generating the report will cause the Node type to expand and display the None types.

Also, the user may set a filter, which will be referenced by the parent node and retrieve data from the database.


Page | 79

Since the parent branch of the None expand types must be Node types and Node types will expand the group, each child branch will be displayed in the generated report.

However, filters set on multiple accounts for the None expand type will consolidate the data onto one row.


Page | 80

In summary, the None type must follow these rules:

Cannot be used for parent level node or branch.

Must be a child node or branch of a Node parent.

The Expression Tree cannot be composed of all None types.

Filters on children of the None type cannot overlap.

Text

The simplest Expand Type which creates a row on the report definition with the name of the node or branch. The most common use is to create a placeholder for a subtotal or grand total. However, the summations must be created in the report definition and not in the Expression Tree.

The Text type will not create a row group nor allow the user to set filters. The illustration below shows how a Text Expand Type works between the tree editor and report definition.

Group

The Group Expand Type is used for creating an aggregation, or a summary, of several accounts onto a single row in a generated report. A simpler way of looking at the Group type is that it functions the same way as having the Expanding box unchecked in the Layout Editor when creating a report definition.

A row group will be created and the user may set a filter. All values associated with the set filter will be consolidated onto a row. For instance, if a node is created with the Group type and the filter is set to five accounts (100, 200, 300, 400, and 500), the generated report will display one unique row summarizing the data from all five accounts.

For more details on the difference between Groups and Expanding Groups, refer to the section on section on Expanding Groups on page 47.

Expanding Group

The Expanding Group Expand Type is the only type that creates an expanding group dependent on the filter set by the user. Therefore, the Expanding Group type will be used when creating a report that requires a row for every unique account set in the filter. For instance, a detailed P&L statement would utilize the Expanding Group type. Users will be able to specify the field that the group will expand on by accessing the Expanding Field option.


Page | 81

A row group will be created and the user may set a filter. All values associated with the set filter will be displayed on a unique row. For instance, if a node is created with the Expand Group type and the filter is set to five accounts (100, 200, 300, 400, and 500), the generated report will display five unique rows for each account.

For more details on the difference between Groups and Expanding Groups, refer to the section on Expanding Groups on page 47.

Documents

OneStop Reporting 4.5 OSR Report Designer and OSR Player …products.onestopreporting.com/Downloads/files/OSR... · · 2014-12-10OSR Report Designer and OSR Player User Guide