Doc. Version 1.0 Updated:

Transcription

1 OneStop Reporting Report Composer 3.5 User Guide Doc. Version 1.0 Updated:

2 Table of Contents Introduction... 2 Who should read this manual... 2 What s included in this manual... 2 Symbols and conventions... 2 Installation... 2 Report Composer (Ad-Hoc)... 3 Overview... 3 Composer Toolbar... 3 Composer Menu... 6 Logging In... 8 Connecting to a Database... 9 Creating a Report Using Report Composer Modules Functions Data Fields Filter Report Viewer Appendix Glossary Copyright OneStop Reporting AS Page 1 OSR Report Composer User Guide

3 Introduction The OneStop Reporting (OSR )Composer is the ad-hoc reporting module in the OSR product suite. It is an intuitive and easy to use query tool for quick reporting that can work directly on top of the organization s ERP database, OSR Data Warehouse, or any other data source where integration has been or will be setup. In less than an hour, any novice business user without technical background or formula knowledge can use the Composer to create report queries by extracting, grouping, and filtering data. When Composer is deployed, users can combine data from different ERP modules into reports, including data analysis and reconciliation. The cursor is used to point to fields to be included in the report in the left menu bar. Then, the users may drag-and-drop these fields into the report area of Report Composer and group or filter them to create the report. Who should read this manual This manual is designed for OSR administrators, who are responsible for creating ad-hoc reports. What s included in this manual This manual is designed to give an in-depth understanding of how to use the features of the OSR Composer. The manual is divided into the following parts: Overview: Introduction to the OSR Report Composer user interface. Report Composer usage: explains how to use each function of the OSR Report Composer such as modules, filters, functions, data items, and report viewer. Symbols and conventions This manual uses the following 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 OSR Reporting application package. The installation guide can be found at Copyright OneStop Reporting AS Page 2 OSR Report Composer User Guide

4 Report Composer (Ad-Hoc) The OSR Report Composer is a stand-alone program for quick and easy report creation. It primarily uses drag-and-drop controls to create meaningful reports. The following sections will explain the interface of Report Composer (shown in the image below) and the function of each button so that users understand how to navigate around the application. Composer Menu Composer ToolBar Composer Filters Composer Groupings Navigation Pane Composer View Overview First, the two most important navigation tools will be explained. From these two areas, users will be able to configure all functions of Report Composer. Composer Toolbar The Composer Toolbar, shown in the image below, is located near the top of the window and allows access to many functions such as creating, opening, saving, exporting a report and configuring options. Each button and its function are described in the table below. Button Function New: creates a blank report in a new tab. By default the new tab shares the same name as the integration. Copyright OneStop Reporting AS Page 3 OSR Report Composer User Guide

5 Open : allows users to browse and open a Composer report (*.rcv) in a new tab. Recent Files: the dropdown arrow opens a list of recently used files in the Composer Views Folder configured in the Options menu. Save: saves the current report to the original file path. Save as : saves the current report as a new file. Export to Excel : saves the current report as an *.xls file to a specified location. Export to PDF : saves the current report as an *.pdf file to a specified location. Export to Report Designer : saves the current report as a Report Designer template named RCExport to the folder specified as the Composer Views Folder tab of the Options menu. By default, the file will be saved to: \MyDocuments\OneStopReporting\Contents\ For each filter, Composer will prompt the user to create a new parameter using Report Parameter Wizard (see the OSR Report Designer user guide for more information). Configure : opens the data connection window Add calculated column : Opens the Formula Builder, where users can create a custom formula into a new column (see the section on Formula Builder for more details). Options : opens the Options menu. Features in the Options menu are explained in detail below. Clear: clears all data items and data in the Composer View. Refresh Data: updates the data in the Composer View. Options Window Each tab and their features in the options window are explained in the following sections. Style Copyright OneStop Reporting AS Page 4 OSR Report Composer User Guide

6 The Style tab allows users to customize the user interface of Report Composer. Users have the option of applying a new style by selecting the drop-down box under the Application Style section. Moreover, users may upload a custom background image by checking the box next to Use Background Image. Then browsing for the desired image by clicking on the button. The new background will be applied after pressing OK in the options window. Folders The Folders tab allows users to specify the location of the Composer Views Folder, where the Recent Files and the exported files are saved. The file path can be entered manually in the text box or users may browse for the location by pressing the button. Application The Application tab contains many features ranging from tooltips, logs, and query time. Copyright OneStop Reporting AS Page 5 OSR Report Composer User Guide

7 Show Tooltips in Tree/Show Tooltips in Grid: tooltips are functions saved for later development. Show Trace Output: opens a Trace Output window, which displays RQL code that can be sent to development for troubleshooting. Ask for name when creating a new view: Report Composer will always ask the user to name the new report view at the time of creation. 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). Dictionary: the dropdown list allows the user to select the integration language. Application Update: the setting for checking for updates to Report Composer is automatically set to every seven days. Composer Menu The Composer Menu, shown in the image below, is located near the top of the window and allows access to many functions. Each drop-down menu is explained in the following sections. File All functions in the File drop-down menu are available in the Composer Toolbar. Refer to the Composer Toolbar section for details on each function. Edit Copyright OneStop Reporting AS Page 6 OSR Report Composer User Guide

8 The Edit drop-down menu contains methods to modify the data in Composer View. The Add Calculated Column, Clear, and Refresh Data are functions featured in the Composer Toolbar. View Add Sum Column: creates a Totals column for each row in Composer View, displaying a sum for numerical values. Show Row Totals: a Totals row will be added at the bottom of the report, displaying a sum for numerical values. Rename View : prompts a new window that allows users to rename the current Composer View. Refresh Data for All Views: pressing this button will refresh data for all Composer Views that are open. The View drop-down menu only has the Show as Card View feature. Selecting this will change the organization of the Composer View as shown in the next page (Top: Card view, Bottom: Default view) Copyright OneStop Reporting AS Page 7 OSR Report Composer User Guide

9 Tools The Tools drop-down menu has four different features. Configure and Options are also available from the Composer Toolbar (see the section Composer Toolbar for details on these features). Help System Integration: the selection is only available when multiple integration packages are configured in the OSR Administration Tool. Selecting this feature will allow users to switch integration between different ERP systems. The report will use the specified integration package from this option. Set User : prompts the OSR Reporting login window and allows the user to log into as a different user. Import License File : prompts the license registration window where users may install license for other OSR Reporting applications. The Help drop-down menu contains the About Report Composer selection. Clicking on this feature will open a new window with details on the version, build, and license of the installed Report Composer. Logging In By default, Report Composer automatically logs in with the previously used account. However, users may change accounts by selecting Tools (in the Composer Menu) -> Set User. The user will be prompted with the familiar OSR login window as depicted on the following page. Copyright OneStop Reporting AS Page 8 OSR Report Composer User Guide

10 OSR Report Composer utilizes the Access Management configuration created through the OSR Administration Tool to create a secure environment for the organization. Similar to other OSR applications users may login using the OneStop or Windows User Authentication in the login window. Dependent 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 Tool (see the user guide for the OSR Administration Tool for details on configuration). Connecting to a Database In Report Composer, the connection to a database is automatically configured for each new view to the previously used connection. However, users may manually change the connection by selecting Report Configuration ( ) either in the Composer Toolbar or in Composer Menu (Tools -> Configure). Once in the Report Configuration window users may select the data connection and the company for the specific report. If a connection to the desired database has been previously configured, the database will be generated in the drop-down list. Copyright OneStop Reporting AS Page 9 OSR Report Composer User Guide

11 However, if a connection has not been configured, follow the steps below: 1. In the Report Configuration window, select Data Connection, then click on the Setup button as shown in the following image. 2. Click New in the newly prompted window to add a new connection. Copyright OneStop Reporting AS Page 10 OSR Report Composer User Guide

12 3. In the new window, enter the information required to create a new connection and click on Test to confirm access to the database. An example is given in the image below. User and Password is only required if an SQL Authentication was created. For Windows Authentication, login information is not needed. After the new connection is created, click on OK to close the prompted windows. In the Report Configuration window, the newly created connection will be generated in the drop-down list and can be selected for the report. If the database contains multiple companies, the proper company can be selected under the Company tab, as shown in the image on the following page. Copyright OneStop Reporting AS Page 11 OSR Report Composer User Guide

13 Creating a Report Using Report Composer Modules Modules can be found in the Report Composer s Navigation Pane and are available for users to dragand-drop into the Composer View to create essential components of a report such as filters and groupings. Modules can also be hidden using the Configuration button function at the bottom of the module list. Modules Functions Configuration Each module contains sub-modules associated with various data items (see section Data Items for more information). The modules and their data items can be managed through the organization s ERP system or the OSR Data Warehouse. Functions Functions available to the user can be accessed by clicking on the Functions button near the bottom of the navigation pane (see the image in the Modules section). Currently all functions have the period syntax and may be drag-and-dropped over the measure data field column header. Copyright OneStop Reporting AS Page 12 OSR Report Composer User Guide

14 Data Fields Data Fields can be found in the navigation pane of Report Composer. Data Fields are considered to be sub-groups and contain information pertaining to the specific module. While creating an ad-hoc report, users will drag-and-drop different types of data items into Composer View. Data Items 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. Filter Report Composer allows users to set static filters for each report. This feature is highly beneficial so that reports can be created for the desired department, account, period, etc. The filters can be created by drag-and-dropping data items to the Composer Filter section as shown in the image below. Copyright OneStop Reporting AS Page 13 OSR Report Composer User Guide

15 In the image above, the Period dimension is used as a filter. However, the filter has not been specified to the desired period. If left blank, the report will display all periods. The following sections explain how to configure a filter. Operators Operators are one way that users 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 Report Composer. In the first drop-down box, two options are available if it is the first filter in the same group: 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 additional filters, the following options are available: 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) Copyright OneStop Reporting AS Page 14 OSR Report Composer User Guide

16 >: dimension is Greater than (for numerical values) <=: dimension is Less than or equal to (for numerical values) >=: 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: 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 generated when the user clicks on the Dimension Lookup button ( ). From the Dimension Lookup window, the user may specify the parameter dependent on the report need. To create a filter, select the desired (can select one or multiple) account, department, entity, etc. and click OK. Copyright OneStop Reporting AS Page 15 OSR Report Composer User Guide

17 o Use ranges: If this box is checked and multiple data are selected, the selected data will be displayed as a range at the bottom text box. If this box is not checked, all selected data will be displayed individually at the bottom text box. o o Include empty: If this box is checked, the filter will include data associated with the NULL data set. Current: A new feature is the ability to specify the value current period +/- for single period parameters. This allows the OSR Report Composer to select the correct period based on the computer date; therefore, report parameters do not need to be updated manually prior to running a report. Report Viewer Users will have the most interaction with the Composer View area when designing an ad-hoc report. By dragging-and-dropping data items (as shown in the image below), users will be able to create a simple report. More advanced features such as grouping, row totals, and formula builders are available and are explained in the following sections. Copyright OneStop Reporting AS Page 16 OSR Report Composer User Guide

18 Drag and Drop All reports are designed through the drag-and-drop action. Desired data items may be selected from the navigation pane and dragged into the blank area of the Composer View. The columns can be rearranged dependent on the user need. After all column headers are added to the Composer View and the proper filter is set, users may press the Refresh Data button to generate the ad-hoc report. Right-clicking on column headers will bring up several options: Delete column header : this selection deletes the selected column header from the Composer View. Edit column header : only available for columns built by formula builder. This will open the formula builder window and allow users to edit the formula. Set Alias: this selection allows the user to rename the column header. Expand column header: this selection is similar to the grouping function except it creates a new column for each unique dimension member in the data item. The images below show a non-expanded column header (left image) and an expanded column header (right) Copyright OneStop Reporting AS Page 17 OSR Report Composer User Guide

19 Expand column header - with totals column: this selection has the same function as expand column header except that it adds a totals column in the last column. Expanded column headers can be undone by right clicking and unchecking the Expand column header option. Grouping Grouping presents another method to organize the report in a presentable manner. Columns can be grouped by dragging a column header already in the Composer View to the area where it states Drag a column header here to group by that column. Below is an image of a grouping by the account dimension. As can be seen, the image on the right creates a group for each account and nests the column headers per account. Grouped column headers can be ungrouped by dragging the column header back into the original location. Data items cannot be directly dragged into the grouping area. It must first be dragged into the Composer View. In addition, grouping may take place any time before or after the report is generated. Moreover, grouping hierarchies can be built by dragging multiple column headers into the grouping area. The image above organizes the report by Period, then Account. Copyright OneStop Reporting AS Page 18 OSR Report Composer User Guide

20 Row Totals Row totals can be created by selecting Edit -> Show Row Totals. Displaying row totals will create a row titled Totals and sum the values for each column as shown in the image below. Row totals Row totals can be disabled by unchecking the Show Row Totals option in the Edit drop-down menu bar. Expanded Periods Expanded periods are created when a period parameter is included in the ad-hoc report and the user right-clicks on the period column header, then selects Expand Period with totals column. The result will be a report with a column for each unique period value as shown in the image below. Formula Builder Formula Builder is accessible by clicking the Add Calculated Column button ( ) on the Composer Toolbar or by selecting Edit -> Add Calculated Column in the Composer drop-down menu. Formula Builder allows users to create customized formulas to compute values using data items in the report. For each formula created, a new column will be produced. Copyright OneStop Reporting AS Page 19 OSR Report Composer User Guide

21 2 1 3 The formula builder contains three areas. 1. The first is the tabbed section where users will have access to the operands and functions tab. The operands tab gives access to data items in the ad-hoc report. The functions tab gives access to various functions ranging from mathematic to date/time functions. 2. The second area is where the formula is created by drag-and-dropping operands or functions and using the buttons to create a formula. 3. The third area contains messages that help the user create the formula. If the formula is valid, then it will display Formula Compiled Successfully. Otherwise, the formula builder will display an error message dependent on the error. As an example, if the hourly rate and annual hours are available for employees, formula builder can be used to calculate the annual salary of the employee. The above image displays the starting report. The Formula Builder in the image below shows the formula used to compute the annual salary. It is important to note that the data fields are displayed with their original system name. Copyright OneStop Reporting AS Page 20 OSR Report Composer User Guide

22 Clicking OK will prompt a new window asking the user to name to column. After naming the column, it will be displayed in the report as shown in the image below. To edit a formula, right click on the column header and select Edit Copyright OneStop Reporting AS Page 21 OSR Report Composer User Guide

23 Appendix Glossary Ad-hoc reporting: Ad-hoc reporting is created through the Composer application. As opposed to template based reporting, Ad-hoc reporting means that the report is created specifically for one purpose. Application: An application refers to a product within OSR suite. This term is used because some of the products are stand-alone programs (Data Warehouse, Report Composer, Publisher, Administrative Tool), whereas others are add-ins to already-existing programs (Planning, Report Designer, Player). Composer View: Also known simply as the View, Composer creates an ad-hoc report on separate tabs called views. This is similar to the concept of multiple worksheets in Microsoft Excel. However, OSR Composer creates multiple Composer Views. built-in Administrator: The built-in Administrator is automatically installed. The initial password is established automatically, but administrators should change the password through the Administration Tool as soon as possible to ensure security. Data item: Data item refers to any item that can be dragged from the Designer Menu into the report definition. This includes dimensions, light dimensions, and measures. ERP Database: Also known as enterprise resource planning, the ERP database contains information for across the entire organization. MS Dynamics AX, GP, NAV, and SL are all considered to be ERP software. Integration Packages: Integration packages include the logic to integrate to the ERP system and are required for communication between the SQL server and OSR applications. Licenses: A unique code that is provided to the user under a software license agreement. The key grants access to a limited number of users for the specified OSR application. Module: A component of the database, which is organized by financial modeling such as General Ledger, Accounts Payable, Accounts Receivable, etc. Users can define modules via Data Warehouse. Copyright OneStop Reporting AS Page 22 OSR Report Composer User Guide