OSR Administration 3.7 User Guide. Updated:

Transcription

1 OSR Administration 3.7 User Guide Updated: Copyright OneStop Reporting AS

2 Table of Contents Introduction... 1 Who should read this manual... 1 What s included in this manual... 1 Symbols and conventions... 1 Installation... 1 OSR Administration Overview... 2 How to use OSR Administration... 2 Login... 2 Home Page and OSR Administration Features... 3 System Settings... 4 Repository Connection... 4 Data Connections... 6 Setting Up a New Data Connection... 7 Settings... 9 Maximum Concurrent Queries... 9 Application Language... 9 License Management Install License How to install a license: Managing Licenses Integration Management Integration Packages Installing an integration package Integration Customization Add/Edit Module Add/Edit Dimension Add/Edit Factset Add/Edit Enumeration Dimension Edit Terms Export Integration Customizations Page i

3 Support for multiple extensions Security Management Change Admin Password Changing the built-in Administrator password Access Management System Integration, Data Connection, and Company Creating and Managing Roles Copy filters from one company to another Application Management Interface Granting and Removing Application Access Rights How to grant application access rights Removing Application Access Rights Appendix A: Glossary Page ii

4 Introduction OSR Administration is the application for users with administrative access to the OneStop Reporting product suite. OSR Administration can be used to setup and manage the system settings, licenses, ERP integrations, security features, and application assignments. OSR Administration centralizes the administrative feature for the Reporting components within the OSR suite, including Report Designer/Player, Composer, and Publisher. Who should read this manual This manual is designed for OSR administrators, who are responsible for tasks such as repository setup, license, security, and application management. 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 Administration Tool. 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 OneStop Reporting application. Manuals can be downloaded from the Downloads area on 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. Page 1

5 OSR Administration Overview How to use OSR Administration OSR Administration allows the system administrator to set up, install, or manage repositories, licenses, integrations, data connections, security, and application assignments. After installation, OSR Administration should be the first application opened - prior to attempting to use any other OSR applications in order to ensure that all reporting applications are secure and properly configured. Login Anytime OSR Administration is opened, the application will prompt the user for the built-in Administrator password. For first-time users, the default login user name and password is Admin and admin respectively. It is important to note that both the user name and password are casesensitive. After the initial login, follow the steps in the Changing the built-in Administrator password section on page 38 to create a more secure environment. Page 2

6 Home Page and OSR Administration Features When logged in correctly, the user will be taken to the OSR Administration Home page. From this page, the user will be able to access the five areas within OSR Administration. 1. System Settings: Allows administrators to configure the repository and database connection as well as customize additional settings. 2. License Management: Allows administrators to install, view, update, and delete licenses for OneStop Reporting applications. 3. Integration Management: Allows administrators to install, update, and uninstall the integration packages. Also, there is an option to customize the dimensions and attributes for integration packages. 4. Security Management: Allows administrators to change the built-in Administrator password and manage user access. 5. Application Management: Allows administrators to manage application assignments for different users on the network. This user guide will explain how to setup and administer each of the functions listed above. Page 3

7 System Settings In this pane users will be able to configure connections for the repository and database for all integration systems that have been installed. In addition, some additional settings that apply across all OSR modules are configured here. Repository Connection The repository database holds metadata information so that the OSR applications will have the correct references to the ERP database or the OSR Data Warehouse. A repository must be set up in order to use any of the OSR applications. If OSR applications were previously installed, the existing repository and connection can used. Type: Select repository type. Available options are SQL server database and Integrated database. The difference between the two types will be explained below. Server: Enter the server and instance information. The dropdown box will automatically display available servers in the domain. The server name will consist of the SQL server name and instance in the standard SQL Server format (i.e. ServerName\SQLInstance). If a green check mark appears next to the server dropdown box, a previously created database has been found. If a red x appears, either the server name or the instance is misspelled, the SQL Server cannot be found, or Page 4

8 the repository database does not exist in the specified SQL Server. Create new : Selecting this option will prompt the user for additional information regarding the server and authentication method. If the correct information was entered, a new repository will be created. The steps below explain how to configure a brand new repository: 1. In the Repository Connection section, select the type of repository to use from the dropdown list. o o Typically, the SQL server database option should be selected in order to centralize any configuration between users of the environment. If the Integrated database is selected, it will create a local database on the computer, which cannot be shared among users. In most cases, the SQL server database option should be selected and not Integrated database option. The Integrated database is included to give flexibility for the specific need of the organization. 2. After selecting the type of repository, users need to create a new repository or connect to an existing repository from a prior installation. The server name will consist of the SQL server name and instance in the standard SQL Server format (i.e. ServerName\SQLInstance). If a green check mark appears next to the server dropdown box, a previously created database has been found. If a red x appears, either the server name or the instance is misspelled, the SQL Server cannot be found, or the repository database does not exist in the specified SQL Server. 3. An existing repository can be found in the dropdown box or manually entered into the text box. If an existing repository is found, click Apply to save the repository connection information. Page 5

9 4. To create a new repository, click Create New and fill in the information for the SQL server. o This will prompt a new window where users can enter server information, authentication method and credentials. o When choosing between Windows Authentication and SQL Authentication, it is important that the chosen user has rights to create a database. When choosing Windows Authentication, any user that will be using the OSR Reporting applications will need to have read and write permission for their Active Directory profile against the OSR_Repository database. This can be managed via the SQL Server Management Studio. It is recommended that the database reside on the same SQL server as the ERP system. This will reduce the time for reports to execute, as the communication delay between the repository and ERP databases is minimized. o A new database called OSR_Repository is created on the specified SQL server. Data Connections Although data connection management is still available in each reporting application of the OSR suite, OSR Administration also offers a data connection setup. Page 6

10 Setting Up a New Data Connection In the Data Connections section of the System Settings page there is a drop-down list containing integration packages that have previously been installed under Integration Management (see the Integration Management section for more details) and a Setup button to create and manage database connections. Setup 1. To create a new connection click the Setup button and then click New. Page 7

11 2. Enter the information required to create a new connection and click Test to confirm access to the database. A new window will display the result of the test. The illustration below shows an example. User and Password information is only required if a SQL Authentication was created. If the User and Password fields are left blank, Windows Authentication will be used. If the connection test is unsuccessful, consult the organization s IT department for the correct server and database information. After the new connection has been created, click OK to close the window. In the Data Connedtion section, the newly created connection will be displayed in the drop-down list and can be modified or deleted using the Change and Delete options. If a connection is modified or deleted in OSR Administration it will affect data connections across all OSR applications. Page 8

12 Settings In the Settings section, users can manage additional settings that will apply across all OSR applications. Maximum Concurrent Queries By default, OSR Report Designer, OSR Player and OSR Composer do not perform parallel queries. However, users can enable this by setting the Maximum Concurrent Queries to a value other than 0. Executing queries in parallel normally optimizes performance when generating a report in the OSR Reporting applications. If you would like to try out this feature, we recommend starting with the value 8 for Maximum Concurrent Queries. The optimal number of parallel queries depends on a number of variables such as memory on the server running the SQL server, the number of processors on the server, and other SQL Server related options. For more details, please refer to the Microsoft documentation to learn more about optimizing parallel queries. A high number does not automatically imply the best performance. Depending on the different variables mentioned above, a peak will be reached at a certain value. The peak could also be dependent on the nature of the report since the number of generated SQL Statements play an important role. When running a simple report that only generates one query, no performance improvements would be achieved using this option. The best way to find the peak is to simply test different values and different reports. If the desired results are not achieved, you disable this feature by choosing the default value, 0. Application Language By default, the OSR applications displays in the same language as the Windows operating system on the computer (if available). If the user wants to use another available language for the application, the language can be changed here. The application language must not be confused with the integration language which is the language provided for a particular integration package for an ERP system (i.e. the names of tables, fields etc. from the ERP system). Page 9

13 License Management After the initial setup, license management allows administrators to install additional licenses, update current licenses, view details of licenses, and delete licenses. The information in this section builds on the assumption that a license key has been provided and that the administrator is setting up the OSR applications for the first time. Install License Prior to the use of any OSR application, the proper license key must be installed through OSR Administration and assigned to users. Assigning users to applications will be covered in the Application Management section. Remember that licenses are assigned to a specific repository and not the local computer. How to install a license: 1. Start OSR Administration and enter the built-in Administrator login credentials. 2. On the Home page, choose License Management. 3. Choose Install License, and in the window that opens enter the license key for the OSR application to be used. Page 10

14 a. If a license file (.lic) was provided click I have a license file and locate the license file. 4. Click OK to install the license. 5. The list of installed licenses will be updated and the new license will be displayed. Managing Licenses When installed, licenses can be viewed, updated and deleted. View Viewing the license will display the following: License Number. Expiry Date. Company licensed to. Number of users under the license. To view the license, click the dropdown arrow to the right of the license name: Page 11

15 Update Licenses can be updated in one of two ways. 1. The first method is to update all licenses installed in the repository by clicking Update all Licenses and choosing Yes in the pop-up window. 2. The second method updates licenses for individual applications (see illustration below). a. Click the dropdown arrow to the right of the license name for the application that should be updated. b. Click Update. A confirmation window will be displayed. Deleting To delete a license, click the dropdown arrow to the right of the license name for the application that should be deleted. Click Delete to unregister the license from the current repository. The license can be installed again by following the license installation process described in the previous section. Page 12

16 Page 13 OSR Administration User Guide

17 Integration Management In this pane, users can manage integration packages and customization. OSR Administration User Guide Integration Packages Integration packages include the pre-built logic that integrates OSR to the ERP systems and are essential for communication between the SQL server and OSR applications. Installing an integration package From the Home in OSR Administration, choose Integration Management and then Integration Packages. 1. A list of available integration packages will be generated. 2. Select and highlight the ERP system that is installed in your organization's environment. 3. Click the Install Selected button at the bottom of the page to finish installing the selected integration packages. Page 14

18 2 1 The illustration above shows how the window would look when choosing to install the OSR Data Warehouse integration package. 3 The buttons at the bottom of the window are explained in the following chart: Button Function Refreshes the list of downloadable packages and installed packages. Allows the installation of a custom integration package. Displays the changelog. Installs the highlighted integration package. This option is inactive if a package is already installed, unless there are updates available for the integration package. In that case, this option is used to upgrade an already installed integration package. Uninstalls the highlighted integration package. This is inactive if a package is not installed. Integration Customization Many customers have ERP systems that allow users to define user-defined tables and fields. These user-defined tables and fields can be included in OSR via customized integration metadata. One way of creating such metadata is to use the Integration Customization feature in OSR Administration. From the Home page, select Integration Management and then Integration Customization. This opens the Integration Customization page. Page 15

19 First, users need to specify the integration, database, and company they want to customize. The Integration Customization feature will use this connection for any custom settings the user creates. If the desired connection has not been configured, users can choose Go to Connections Setup to create the data connection. Add/Edit Module This option allows users to view and edit existing modules and add new modules. Page 16

20 Add Module: choosing this option will prompt the user to name the new module. The name entered for the module will be used for Name and Display Name. After the user has entered a name and confirmed by clicking OK, the new module will appear in the Modules list. Edit Module: choosing this option will prompt the user to rename the module that is highlighted in the Modules list. Note that it is only possible to rename the Display Name of the module, not the system name. Delete Module: choosing this option will delete the selected module from the Modules list. Users can only delete modules that have been created using this tool. Changes made under Add/Edit Module are stored automatically. Users may therefore use the links on top of the page to navigate back to the desired menu or press the Done button to return to the previous screen. Add/Edit Dimension This option allows users to view and edit existing modules and add new dimensions and to convert dimensions to a factset. Page 17

21 Add Dimension: choosing this option will open the Dimension Wizard. Through the Dimension Wizard, users can create a new dimension from a table or a view that already exists in the database. The Dimension Wizard is explained in more detail below. Edit Dimension: choosing this option will open the Dimension Editor, which allows users to modify the attributes of the dimension and module associations. More details on the Dimension Editor can be found below. Page 18

22 Convert to Factset: choosing this option will convert the dimension to a factset. This function should be used if an added dimension contains many transactions (measures) rather than master data. Alternatively, users may delete the dimension and re-add as a factset on the Add/Edit Factset page. Delete Dimension: clicking this button will delete the selected dimension from the Dimensions list. Users can only delete dimensions that have been created using this tool. Dimension Wizard The Dimension Wizard assists in configuring a new dimension to be displayed for the end-user. 1. In the first page of the Dimension Wizard, users will be able to select the table or view that will be configured as a dimension. a. In the top section of this page, users are able to filter tables by schema (leave the text box blank to see all tables/views) and determine if they want to only see tables or tables and views. (If the Include views box is checked the list will include both tables and views). b. From the list, users can select the table or view that will be configured to become a dimension. c. The Name text box will display the selected table/view. Users can customize the default Display Name, which will be displayed in the Dimension list on the Add/Edit Dimension page. Page 19

23 2. In the second page of the Dimension Wizard users will select the attributes for the new dimension. The main screen will display the columns of the table/view that was selected on the previous page of the Dimension Wizard. Use: If checked, the column will be used as an attribute for the dimension. Name: The system name of the column will be displayed here. Default Display Name: In this cell, users can enter a customized attribute name to be displayed in the OSR application interface. If the Default Display Name field is left blank, the system name (as displayed in the Name column) will be used as the display name. Note however that if a term has been defined in the Dictionary for this attribute, the Dictionary term will be used as display name, as Dictionary terms override both customized names and system names. Data Type: Shows the data type of the column. This is inherited from the columns in the table and cannot be changed. o All numeric SQL data types (int, float, double, numeric, decimal etc.) are mapped into the common Number type. o All string SQL types (nchar, nvarchar, char, varchar etc.) are mapped into the common Text type. o Other high level types are Long and DateTime. Attribute Type: The attribute type is also inherited from the table. If the column is a primary or foreign key, users will not be able to change the type. However, the attribute type can be changed if the column is not a key. Users can choose between Group or Measure. Page 20

24 o o Group: The attribute will be displayed as a light dimension in the OSR application interface. An attribute that should not be summarized or aggregated should have the type Group (for example Text, Integer data, Prices, Costs). Measure: The attribute will be displayed as a measure in the OSR application interface. Attributes that should be summarized or aggregated should have the type Measure (for example Amounts and Quantities). Visibility: The visibility of an attribute can be changed between Always, Optional, and Never. If the visibility is set to Always, users will be able to see the attribute when the dimension is accessed in the OSR application. If the visibility is Optional, the attribute will be placed in the More Fields folder. If visibility is set to Never, the end-user will never be able to see the attribute across the OSR applications. Page 21

25 Lookup Display: if a 0 is displayed in this setting, the attribute will not be displayed in the Lookup window for the dimension. If an integer value (beginning with 1) is inserted, the attribute will be displayed in the Lookup Window in the order of increasing value. The order can be modified on the Edit Lookup page, which will be the next page of the Dimension Wizard. If an attribute has been set to 1 under Lookup Display it is this term that will be displayed in the parent factset/dimension. (See the illustrations above and below where Salesperson ID has been set to 1 under Lookup Display and is the terms displayed under the parent dimension Sales Order in the illustration below.) Sequence Number: Values entered for this property will affect the display order for the attributes in the navigation pane of the OSR applications. The display order will be from the lowest to the highest sequence number. Attributes that have the value 0 for this property will be displayed after the attribute with the highest sequence number in alphabetical order. Note that data fields are always organized by data field types in the following order: Foreign Key (i.e. Dimension), Group, and Measure. The sequence number will only affect the order within the data field type. Therefore, a measure cannot be displayed before a Dimension. Page 22

26 3. The next page of the Dimension Wizard configures the Lookup window. Users will be able to specify which dimension attributes should be displayed in the Lookup window and in what order. All attributes with the Use box checked on the previous page will be displayed in the Dimension Attributes list. From this list, users can highlight and press Add to add the attribute in the Lookup Attributes list. The Lookup Attributes list can be sorted using the Up and Down buttons. Lookup attributes can be removed by using the Delete button. 4. The final page allows users to Add Links to join tables in order to link one dimension to another dimension. Note that only 1 link can be created initially. However, choosing Links in the Edit Dimension page users can create additional links between different attributes. Page 23

27 Link Name: This field automatically displays the To Dimension. From dimensions: This field automatically displays the system name of the table chosen from the first page of the Factset Wizard. Dimensions: Select the dimension configured in the integration that should be linked to this factset. Link Conditions: The link condition is normally setup on a Primary Key to Foreign Key relation between a dimension and a factset. If necessary, the condition can involve more than a one-to-one relation between the dimension and facset. To add multiple conditions, use the Add button. The first column always displays the factset and its attributes in the dropdown box. The second column is the operator used to relate the dimension and factset to each other. The third column displays the dimension and its attributes in a drop-down box. Logical op, the fourth column, allows users to specify a logical operator (And/Or) between multiple rows in the link condition. Page 24

28 Link Formula: This field allows users to show the link condition as it is defined in the Link Condition. Often, users will not need to modify the link formula. However, if desired, users can to enter their own custom link formula in this text box. 5. Link Type: users may choose between the link types InnerJoin, LeftOuterJoin, RightOuterJoin, FullOuterJoin. For a definition of the different join types, consult a SQL resource. Dimension Editor The Dimension Editor offers similar functionality to the Dimension Wizard. The major difference is that the user is not able to select the table or view associated with the dimension. However, there is an additional function that allows users to associate the dimension with multiple modules. Attributes: In this tab, users can modify the dimension attributes similar to the second page of the Dimension Wizard. Lookup Attributes: In this tab, users can modify the Lookup Attributes similar to the last page of the Dimension Wizard. Module Associations: This tab allows users to assign the Dimension to one of the defined Modules. Normally, dimensions are not assigned directly to a module. Rather, the dimension will be available indirectly via a Factset in the Module. For instance, Financial GL Accounts will be available through the GL Transactions Factset as a foreign key lookup to the Accounts. Dimensions Page 25

29 can be associated with a module by placing a check mark in the box, and the dimension will be displayed as a folder in the module similar to how Factsets are displayed. Add/Edit Factset Factsets contain facts and measure for reporting. Most often, factsets contain foreign keys to dimensions so that the proper transactions can be found in the database. Page 26

30 Add Factset: Choosing this option will open the Factset Wizard. Through the Factset Wizard, users can configure a new factset from a table or a view that already exists in the database. The Factset Wizard is explained in more detail below. Edit Factset: Choosing this option will open the Factset Editor which will allow users to modify the attributes of the factset and module associations. More details on the Factset Editor can be found below. Convert to Dimension: Choosing this option will convert the factset to a dimension. This function should be used if an added factset contains master data rather than measures. Alternatively, users may delete the factset and re-add as a dimension in the Add/Edit Dimension menu. Delete Factset: Choosing this option will delete the selected factset from the Factset list. Users can only delete factsets that have been created using this tool. Factset Wizard The Factset Wizard assists users in configuring a new dimension to be displayed for the end-user. 1. In the first page of the Factset Wizard, users will be able to select the table or view that will be configured as a factset. a. In the top section of this page, users are able to filter tables by schema (leave the text box blank to see all tables/views) and determine if they want to only see tables or tables and views. (If the Include views box is checked the list will include both tables and views). Page 27

31 b. From the list displayed, users can select the table or view that will be configured to become a Factset. c. The Name textbox will display the selected table/view. Users can customize the default Display Name, which will be displayed in the Factset list on the Add/Edit Factset page. 2. In the second page of the Factset Wizard, users will select the attributes for the new factset. The main screen will display the columns of the table/view that was selected on the previous page of the Factset Wizard. Use: If checked, the column will be used as an attribute for the factset. Name: The system name of the column will be displayed here. Default Display Name: In this cell, users can enter a customized attribute name to be displayed in the OSR application interface. If the Default Display Name field is left blank, the system name (as displayed in the Name column) will be used as the display name. Note however that if a term has been defined in the Dictionary for this attribute, the Dictionary term will be used as display name, as Dictionary terms override both customized names and system names. Data Type: Shows the data type of the column. This is inherited from the columns in the table and cannot be changed. o All numeric SQL data types (int, float, double, numeric, decimal etc.) are mapped into the common Number type. Page 28

32 o o All string SQL types (nchar, nvarchar, char, varchar etc.) are mapped into the common Text type. Other high level types are Long and DateTime. Attribute Type: The attribute type is also inherited from the table. If the column is a primary or foreign key, users will not be able to change the type. However, the attribute type can be changed if the column is not a key. Users can choose between Group or Measure. o Group: The attribute will be displayed as a light dimension in the OSR application interface. An attribute that should not be summarized or aggregated should have the type Group (for example Text, Integer data, Prices, Costs). o Measure: The attribute will be displayed as a measure in the OSR application interface. Attributes that should be summarized or aggregated should have the type Measure (for example Amounts and Quantities). Visibility: The visibility of an attribute can be changed between Always, Optional, and Never. If the visibility is set to Always, users will be able to see the attribute when the factset is accessed in the OSR application. If the visibility is Optional, the attribute will be placed in the More Fields folder. If visibility is set to Never, the end-user will never be able to see the attribute through across the OSR applications. Page 29

33 Lookup Display: Normally, the Lookup function is not used for factsets. Filters are commonly applied to Dimensions and it is therefore unnecessary to specify the Lookup Display values for factsets. Users may leave all values as 0. Sequence Number: Values entered for this property will affect the display order for the attributes in the navigation pane of the OSR applications. The display order will be from the lowest to the highest sequence number. Attributes that have the value 0 for this property will be displayed after the attribute with the highest sequence number in alphabetical order. Note that data fields are always organized by data field types in the following order: Foreign Key (i.e. Dimension), Group, and Measure. The sequence number will only affect the order within the data field type. Therefore, a measure cannot be displayed before a Dimension. 3. The third page allows users to Add Links to join tables so that the proper dimensions are associated with the factset. Note that only 1 link can be created initially. However, choosing Links on the Edit Factset page users can create additional links between different attributes. Page 30

34 Link Name: This field automatically displays the To Dimension. From dimensions: This field automatically displays the system name of the table chosen from the first page of the Factset Wizard. Dimensions: Select the dimension configured in the integration that should be linked to this factset. Link Conditions: The link condition is normally setup on a Primary Key to Foreign Key relation between a dimension and a factset. If necessary, the condition can involve more than a one-to-one relation between the dimension and facset. To add multiple conditions, use the Add button. The first column always displays the factset and its attributes in the dropdown box. The second column is the operator used to relate the dimension and factset to each other. The third column displays the dimension and its attributes in a drop-down box. Logical op, the fourth column, allows users to specify a logical operator (And/Or) between multiple rows in the link condition. Page 31

35 Link Formula: This field allows users to show the link condition as it is defined in the Link Condition. Often, users will not need to modify the link formula. However, if desired, users can to enter their own custom link formula in this text box. 4. Link Type: users may choose between the link types InnerJoin, LeftOuterJoin, RightOuterJoin, FullOuterJoin. For a definition of the different join types, consult a SQL resource. 5. The final page of the Factset Wizard is the Associate with modules page. On this page, users can assign the factset to a module defined under Add/Edit Module. Place a checkmark next to the module that the factset will be associated with. Factset Editor The Factset Editor offers the same functionality as the Factset Wizard. The major difference is that the user is not able to select the table or view associated with the dimension as this was already defined when the factset was created. Attributes: In this tab, users can modify the dimension attributes similar to the second screen of the Factset Wizard. Links: In this tab, users can modify and add links between dimensions and the factset similar to the third screen of the Factset Wizard. Module Associations: This tab allows users to assign the factset to one of the defined Modules similar to the last screen of the Factset Wizard. Page 32

36 Add/Edit Enumeration Dimension An enumeration dimension contains values not found as master data in the database. For instance, data such as Account Type and ID can be used to make data in reports more readable. You can use the add/edit enumeration dimension functions to create or edit such data. All Enumeration Dimensions Existing enumeration dimensions will be listed in the drop-down box next to the Select dimension. The default display name and system name can be modified and will be reflected on the Add/Edit Dimension page and in the dictionary of terms. Add new Enumeration Dimension If users want to create a new enumeration dimension, they can simply enter the name of the new enumeration dimension on the right-hand side of the window and click Add New. The newly created dimension will be available for selection under the All Enumeration Dimensions option. Row Editor The row editor allows users to create an Id field (enumerator index) and a name corresponding to the Id field. If multiple dictionaries are available, users will be able to specify the term for the row names. Note that the Id field does not have to be a numerical value. After an enumeration dimension has been created it will become available on the Add/Edit Dimensions page. From that page, users can configure the dimension to fit their specific use. Page 33

37 Edit Terms The Edit Terms page allows users to edit all dictionaries for all different terms in the integration. This includes names for Dimensions, Factsets, Attributes, Enumerated Dimensions, and Modules. If a new dictionary needs to be added to the integration, please contact your administrator. The purpose of terms is to define a user-friendly display name so that end-users will be able to interact with the data fields without memorizing the system names. Page 34

38 Selection options: These options allow users to filter terms by characteristics to find them more quickly. Terms: In this section the user is able to use filters to find the desired term and enter a name for each dictionary listed in the columns displayed on the right-hand side of the page. If the Name field is left blank, the OSR applications will automatically display the DefaultDisplayName. Export Integration Customizations After creating custom configurations for the integration, users need to export the custom model. The exported custom model can be installed on the Integration Packages page. Once the custom model has been exported and installed, end-users will see the changes to the integration package in the OSR application interfaces. By exporting integration customizations users will be able to create a backup file of the customization. Note that customizations will be deleted if a user uninstalls the integration from the Integration Packages page. Therefore, it is extremely important to create a backup of the customization. Page 35

39 Name: In this tool, the Name field is always disabled, as the tool automatically creates a name. The default name for all customizations made in this tool will be added to the identifier META_CUSTOMIZATION. Integration Customizations file name: In this text box, users can specify the folder location for saving the custom model and the file name. Support for multiple extensions It is possible to import more than one Integration Extension. If the extensions are created using OSR Meta Designer, the names of the Extensions are listed in the Description column in the list, as shown in the illustration below. If you have used the Integration Customization functionality in OSR Administration to create an extension, the Description column displays the default name Customized Integration to indicate that the customization was created using Integration Customization. Page 36

40 Security Management OSR has a robust set of features that allow the administrators of the OSR applications to establish security settings across the reporting environment. These settings enable the assignment of security rights associated with user logins that will grant or restrict access to data and modules based on each user's area of responsibility, their role in the reporting process, and other factor that should be taken into consideration regarding their access to financial and operational information. The Security Management section in OSR Administration centralizes data access management for all OSR applications. Security Management can be accessed from the Home page of OSR Administration. Change Admin Password When first installed, OSR has a built-in Administrator role and a default password established for this user. The built-in Administrator has access to everything across the OSR Reporting environment and is the only user with access to OSR Administration. This administrator is unique and remains intact even if another admin-level user, who has access to all modules and data, is created. The difference is that only the built-in Administrator has rights to access OSR Administration. Since this built-in Administrator comes with a default password, which is the same across all OSR installations, it should be changed for greater security to your installation. Default built-in Administrator credentials: Login = Admin (case sensitive) Password = admin (case sensitive) Page 37

41 Make sure to remember the new built-in administrator password, as this is the only way to gain access to OSR Administration and all of its functions. If the password is forgotten or lost, you must contact OSR Support who can assist in resetting the password to the default. Changing the built-in Administrator password Access the Security Management function from the Home page of OSR Administration. Choose Change Admin Password. Insert the old password, the new password, and confirm the new password in the window that is displayed. Remember to store information about the password in a secure way. Access Management The Access Management functionality provides control to keep sensitive data secure, while simultaneously allowing the finance team and other employees to gain the insight needed to make informed decisions that ultimately drive timely, productive, and efficient execution of work across the organization. Page 38

42 Here are some key concepts and rules regarding Access Management in OSR Administration: Windows user authentication (Active Directory) must be used for the OSR Access Management feature: o Access Management takes advantage of the Windows login credentials already established in Active Directory to streamline the setup and the application. o Specific users and/or groups which have already been established within the Active Directory environment can be used. Security is per company and per role: o This means that if multiple companies are set up in the ERP system, security must be set up for each company independently. o Access Management was established this way due to the fact that many ERP users are granted different rights to users in different companies, therefore, access can be segregated based on the company need. Security is set at the company and the role level. o Security is not set at the user level. o Instead users are associated to roles, thus inheriting the rights of the role. The order of security setup is the following; o Log in to OSR Administration and choose Access Management. o Create roles. o Assign users to roles. o Assign access rights (filters) to roles. Access Filter (Connection Setting 1) Access Filter (Connection Setting 2) Access Filter (Connection Setting 3) Access Filter (Connection Setting 4) Users Rol e 1 Rol e 2 Users Access Filter (Connection Setting 1) Access Filter (Connection Setting 2) Access Filter (Connection Setting 3) Access Filter (Connection Setting 4) If a user switches the System Integration, Data Connection, or Company before clicking the Apply button and saving the role settings, the configuration will be lost. However, users may switch between configuring different roles within the same data connection configuration without losing their settings. System Integration, Data Connection, and Company In the upper section of the Access Management page, users are able to create new roles for a specific ERP database and company using the drop-down lists. Page 39

43 System Integration Select the proper integration package from the System Integration drop-down list. OSR Administration User Guide If the desired integration package is not displayed in the drop-down list, it can be installed under Integration Management >> Integration Packages. Data Connection Select the proper database from the Data Connection drop-down list. This list is generated based on the system integration package selected in the previous step and previous data connections created through OSR Administration or any other OSR applications such as OSR Report Designer or OSR Composer. If the desired database is not available, a new connection can be setup by choosing Go to Connections Setup. Refer to the Setting Up a New Data Connection section on page 7 for more details on setting up a data connection. Company Select the proper company from the Company drop-down list. The list is generated based on the system integration package and the database selected in the previous two steps. Companies are automatically generated based on the integration package. For instance, OSR Data Warehouse only contains one company. However, different ERP systems may contain multiple companies and will generate all companies associated with the database. Creating and Managing Roles In order to explain the security setup for different types of roles, three examples will be presented: 1. The administrator of the system, which is different than the built-in Administrator. a. This administrator is a person allowed to see all data, modules, and departments (for example the CFO or President/Managing Director), but is not an administrator of the OSR system. 2. A role from department 100, who designs and/or views reports and budgets in OSR, but should only have the ability to see data associated with their department An accounts payable department role, who designs and/or views reports and budgets in OSR, but who should only be able to see data associated with accounts payable modules or posting data. Creating a New Role The following steps will explain how to create roles, to which the administrator will later assign users and assign rights. Initially, as the steps to create the roles are performed, placeholders will be created with a role title. The assignment of users and rights will take place in succeeding steps. 1. From the OSR Administration Home page choose Security Management >> Access Management. 2. Under Roles clink the New button. Page 40

44 3. In the window that is displayed, enter the name of the role (for example administrator). 4. Click OK to create the new role. 5. Repeat this process for any other roles you wish to create (for example department 100, accounts payable, etc.). 6. Existing roles can be modified by clicking Edit and erased by clicking Delete. Click the Apply button any time to save changes. Role Properties In the [Role] Properties section of the Access Management page, the built-in Administrator can assign members to roles and manage the access level for each role. Page 41

45 The title of the property section will change to Role_name Properties. ( for example Administrator Properties, Accounts Payable Role Properties, etc.) Assigning Active Directory Users/Groups to Roles The next step is to assign users to the newly created roles. In this step, integration to Windows Active Directory comes into play. Active Directory users, Active Directory groups, or the combination of the two can be used when making user assignments to the roles. The example below explains how to assign an Active Directory user to a role. 1. In the Roles section to the left in the window, highlight the name of the role created in the previous step. 2. Choose the Members tab on the right and click Edit Members (see illustration below). 3. This will cause OSR to activate integration with Windows Active Directory and open a new window called Add Users and Groups. 4. Follow the steps below to add a user or group to the role. Page 42

46 a. In the Domain drop-down list, select the proper domain and click the Refresh button to generate a list of established users and groups within the specified network. b. Find the user/group that the new role should be assigned to. c. Select the user/group name and assign them to the role by clicking Add. This will create a list of assigned users at the bottom of the window. d. Repeat this step as necessary. e. Once all users/groups have been properly assigned, click OK to save the assignment. This will associate the Windows Active Directory user/group with the Reporting role (see illustration below). 5. Repeat this process to assign members to any other roles. The Members button is only available when a group is selected from the list. It enables the user to observe the members of a group from the OSR Administration interface. Page 43

47 Note that a single Active Directory user can be assigned to multiple roles. This can occur when the user is directly assigned to multiple roles or when they are part of multiple Active Directory groups. When a user is assigned to multiple roles, the user will be able to access data that is filtered by each role. In other words the user will be able to see information that is in role 1 or role 2. Setting Access Rights for Roles In this next step, security and access restrictions will be established for each role. Users associated with each role will inherit the access restrictions, and this will create a secure environment across OSR applications. The steps associated with setting access rights in OSR are similar to the concept of setting filters in OSR Report Designer and OSR Composer. The difference is that the various modules and dimensions are filtered dependent on the level of restriction for each role instead of filtering various accounts, periods or departments for specific data in a report. Below we explain three different examples of assigning access rights; one for an administrative role, one for restrictions based on module, and another based on restricting a role s access to one specific department. Setting Access Rights for an administrator role In general, an administrator role would be granted full access to all data. (Remember that this administrator role is different from the built-in Administrator, who has access to OSR Administration.) 1. Begin by highlighting the Administrator role in the Roles section to the left on the Access Management page. 2. Click the Data Access Filters tab in the Properties area. 3. Note: See the hints at the bottom of the Data Access Filters tab: o No filters provide no access o Create filters to limit access o Create a filter In to give full access Page 44

48 4. For full access, locate and expand the Modules folder on the Access Management page. 5. Drag the Module filter into the blue shaded area below the heading Drag fields into area below to create filters. 6. As specified by the hint at the bottom of the section, select In (which will be selected by default) and enter * in the text box as shown in the illustration below. 7. Click Apply to save the settings. Setting Access Rights for a module restricted role Another type of role that you may wish to define is a role where access is restricted to certain modules. The next example will explain how to filter by module by setting access rights for an accounts payable role. 1. Begin by highlighting the Accounts Payable role under Roles to the left on the Access Management page. 2. Click the Data Access Filters tab in the Properties area. Page 45

49 3. Locate and expand the Modules folder in the Properties section of the Access Management page. 4. From the Modules folder, drag the Module filter into the shaded area below the heading Drag fields into area below to create filters. o The Module dimension is added to the filters and users may now specify restrictions through the filter. 5. Click the Lookup button to display a Lookup window with a list of options for filters (see the illustration below). 6. Select the module that the role's access should be restricted to (in this example, the AP Purchasing module). Now, role's access is restricted so that only the specified module can be accessed. 7. Click OK to save and close the Lookup window. Page 46

50 8. Click Apply to save the role settings. Setting Access Right for a departmental role The last example explains setting access rights based on data associated with postings to certain departments. The role access will be limited to the specific dimension department (department 100) for all modules. 1. Begin by highlighting the Department 100 role in the Role section to the left on the Access Management page. 2. Click the Data Access Filters tab in the Properties area. 3. Expand the Dimensions folder. o The dimensions folder is similar to the General Ledger Actuals Summary or any other folder in which dimensions can be found in OSR Report Designer or OSR Composer. 4. Under the Dimensions folder, locate and drag Department filter into the shaded area below the heading Drag fields into area below to create filters (see illustration below). Page 47

51 o The department dimension is added to the filters and may now be restricted through the filter. 5. Click on the Lookup button to display a Lookup window with a list of options for filters. 6. Select and highlight the relevant department to restrict the role s access. (in this example, department 100). 7. Click OK to save the setting and close the Lookup window. 8. The Department 100 role now has a restriction that only allows users assigned to this role to access data associated with postings done to department 100. Users must be assigned to at least one role before they are able to access an application in the OSR suite. In addition, they must be assigned a role to become a subscriber in the OSR Page 48

52 Publisher application. Note that role assignments apply across all companies and databases, so it is not necessary to assign member to a role every time a different company/database/integration package is chosen. However, for a single role, access filters must be created for each company and database. Copy filters from one company to another It is possible to copy Access Management (security) settings from one company to another. On the Access Management page choose Copy filters and select the companies that the access filters should be copied to. Application Management From the Application Management page, administrators can grant or deny access to the different applications in the OneStop Reporting suite for individual users in their network. Before access can be granted, the proper license must be installed for each application. For instructions on installing licenses, see the Install License section on page 10. Page 49

53 The function of Application Management is similar to that of assigning roles. However, whereas roles limit access to data, application management limits access to complete applications in the OneStop Reporting product suite. Unlike for roles, where groups of users can be assigned the same role, groups cannot be granted access to an application. Access to applications must be done for each individual user. Page 50

54 Interface The Application Management page is split into three main areas: 1. The left side of the page is dedicated to generating a user list doe the domains available to the administrator. From the user list, administrators can add specific users to the application assignments list. In addition, there are three selectable options which apply to all users. a. Auto-login with Windows user: If checked, users will be prompted for Windows Authentication any time they open an OSR application instead of for the OneStop authentication. If the OSR implementation utilizes Access Management, this feature becomes useful. b. Auto-connect Excel add-in: If checked, the 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. c. Always show Excel Ribbon: If checked, the OneStop Reporting Excel ribbon is always displayed in Excel independent of the applications assigned to the user. If the user does not have access to OSR Report Designer or OSR Player, the ribbon will not display any buttons. However, if unchecked and the user is not assigned rights to OSR Report Designer or OSR Player, the OneStop Reporting Excel ribbon will not be displayed on the Excel interface. Page 51

55 2. The mid-section of the page contains four buttons: Button OSR Administration User Guide Function Adds the highlighted user from the Windows Users list to the Application Assignments list. Removes the highlighted user from the Application Assignments list. Allows the administrator to manually search for Windows Users. Deletes the current Application Assignments list and creates a blank list. 3. The section to the right of the page displays the list of application assignments for unique users. The number of licenses remaining is displayed under each application and is updated as the administrator creates application assignments. Application assignments from previous versions can be automatically imported by using the Migrate users from previous version option. Granting and Removing Application Access Rights How to grant application access rights From the Home page, choose Applications Management. 2. Locate the proper domain in the Windows Users interface dropdown menu. o If the proper domain is not listed, domain information can be found under System Information in the Control Panel. 3. Click the Refresh button to generate the list of users in the specified domain. 4. Highlight the desired user and click the Add >> button to add the user to the Application Assignments list. o Repeat until all users that should be added have been added to the Application Assignments list. o If a user is not displayed in the generated list, you can click the Advanced button to manually search for the user. 5. From the Application Assignments list, application assignments can be created by checking the boxes associated with the relevant application for each of the users. Page 52