versago:report_configuration

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
versago:report_configuration [2020/01/08 10:45]
runger
versago:report_configuration [2020/12/01 12:32] (current)
dlee [Report and Data Source Information]
Line 88: Line 88:
 {{  :versago:reports3.png?400  |}} {{  :versago:reports3.png?400  |}}
  
-  **Report Name** is a unique name for this report. +  **Report Name** is a __unique__ name for this report. 
-    This value is what is displayed in the Versago menus and at the top of the report page. +    This value is what is displayed in the Versago menus and at the top of the report page. 
-  **Description** is optional but can be useful for explaining the purpose or contents of the report. It is only displayed on this page. +  **Description** is optional but can be useful for explaining the purpose or contents of the report. It is only displayed on this page. 
-  **User Instructions** is displayed at the top of the report page. This is optional but can be helpful in providing guidance to the user on how to navigate the report. +  **User Instructions** is displayed at the top of the report page. This is optional but can be helpful in providing guidance to the user on how to navigate the report. 
-  **Report Categories** are the grouping mechanism used in the default Versago menu structure. +  **Report Categories** are the grouping mechanism used in the default Versago menu structure. 
-    Previously defined categories can be selected from the drop-down list. +    Previously defined categories can be selected from the drop-down list. 
- A new category can be created by typing the desired value in the blank drop-down box. This category will then be displayed in the list the next time the drop-down is selected. +      A new category can be created by typing the desired value in the blank drop-down box. This category will then be displayed in the list the next time the drop-down is selected. 
-  **Database** is the database connection to be used for the report.  See the **//[[versago:database_connection_configuration|Database Connections Configuration]]//** page for information on configuring database connections. +  **Database** is the database connection to be used for the report.  See the **//[[versago:database_connection_configuration|Database Connections Configuration]]//** page for information on configuring database connections. 
- When a connection is selected, the associated database name is displayed in the “Database Name” field. +      When a connection is selected, the associated database name is displayed in the “Database Name” field. 
-  **Report Object Types** are the various ways to obtain data from a database. The values displayed in the **Report Data Source** area will vary depending on the selected Report Object Type.  See the **//[[#report_object_types|Report Object Types]]//** section for information on how the different types are used.+  * **Data Source Type** are the various ways to obtain data from a database. The values displayed in the **Data Source** area will vary depending on the selected Report Object Type.  See the **//[[report_object_types|Report Data Source Types]]//** page for information on how the different types are used.
  
 ===== Availability ===== ===== Availability =====
Line 103: Line 103:
 {{  :versago:reports4.png?400  |}} {{  :versago:reports4.png?400  |}}
  
-  **Roles** define the group(s) of users that can use this report. +  **Roles** define the group(s) of users that can use this report. 
-    Click in the blank area of the “Role” field to see a list of roles and select as needed. +    Click in the blank area of the “Role” field to see a list of roles and select as needed. 
- A report may be associated with multiple roles. +      A report may be associated with multiple roles. 
- Click the <color #ed1c24>**X**</color> on a role to remove it from this report. +      Click the <color #ed1c24>**X**</color> on a role to remove it from this report. 
-  Select the **Public** option if this report should be displayed in the menu section of Versago’s initial landing page prior to a user logging in. +  Select the **Public** option if this report should be displayed in the menu section of Versago’s initial landing page prior to a user logging in. 
-    **Use caution with this option**. No restriction on data content will be applied as may occur once a use is logged in. Whatever the report returns will be displayed to the user. + 
- An example of how this option might be used is to provide a list of company locations with address and telephone numbers. This information would be general and not necessarily pose a security or data risk. +<WRAP center round important 80%> 
-  Select the **Do not show in menu** option when you have a report that you do not want to be displayed in the standard Versago menu structure. +**Use caution with this option**. No restriction on data content will be applied as may occur once a use is logged in. Whatever the report returns will be displayed to the user. 
-    The most common use of this option is when the report is only used as a lookup tool in Versago Forms, or as a sub-report in other Versago Reports. + 
- Use of this option is typically not needed if you are using custom menus for all non-admin users.+An example of how this option might be used is to provide a list of company locations with address and telephone numbers. This information would be general and not necessarily pose a security or data risk. 
 +</WRAP> 
 + 
 +  Select the **Do not show in menu** option when you have a report that you do not want to be displayed in the standard Versago menu structure. 
 +    The most common use of this option is when the report is only used as a lookup tool in Versago Forms, or as a sub-report in other Versago Reports. 
 +      Use of this option is typically not needed if you are using custom menus for all non-admin users.
  
 ===== Presentation Format ===== ===== Presentation Format =====
Line 265: Line 270:
 See the //**[[versago:chart_configuration|Chart Configuration]]**// page for information on creating charts. See the //**[[versago:chart_configuration|Chart Configuration]]**// page for information on creating charts.
  
-====== Report Object Types ====== 
  
-**Report Object Types** are the mechanisms that can be used to obtain desired data from a database. Only one method (object type) can be selected for a report. 
  
-{{  :versago:reports20.png?200  |}} 
  
-The image above shows the list of methods displayed as of Versago version 2.2. However, some of these methods are slated for removal in upcoming versions. Use only the options described below. 
  
-===== SQL Select ===== 
- 
-The **SQL Select** method is the most commonly used option. When it is selected, a text box is presented where standard SQL script can be entered. The script can be entered manually or pasted from another source such as SQL Server Management Studio. 
-<WRAP center round important 60%> 
-Note that only SELECT statements may be used. 
-</WRAP> 
- 
-{{  :versago:reports21.png?600  |}} 
- 
-  - Enter the SQL SELECT statement in the “Query Statement” area. 
-  - Once the SQL statement has been entered, click [**Execute**] to validate the statement. 
-    - Standard SQL error messages will be displayed if errors are encountered. 
-    - If the statement is correct, the first 50 records of the dataset are displayed in the “Output Results” area. 
-      - Date values are shown in a rather strange format as show in the image above. This is normal. The dates will be displayed correctly in the report presentation. 
-  - Click [**Save**] to confirm that the results are what you wanted and to save the SQL statement. The SQL Select dialog area will close automatically. 
-  - Click [**Close**] to close the SQL Select dialog box without saving any changes that may have been made. 
- 
-When working with an existing report the first part of the current SQL Select statement is displayed. Click on the [**…**] button to open the editing window.  You can also "grab" the lower-right corner of the window and drag to make it larger. 
- 
-{{  :versago:reports22.png?300  |}} 
- 
-<WRAP center round important 60%> 
-The SQL statement can be changed at any time. However, remember that changes may affect other areas of the report defined in subsequent steps. Be sure to complete the [**Execute**] and [**Save**] steps if you do make changes. Otherwise your new selection station will not be saved. Then be sure you continue the wizard through the “Display” step to ensure any data changes are reflected in the formatted report output. 
-</WRAP> 
- 
- 
-==== SQL Statement Restrictions ==== 
- 
-Certain SQL statements are not allowed in the SQL Select function. 
- 
-  * An **Order By** clause cannot be used except in cases where the statement contains a TOP operator. The ordering (sorting) is handled by the report output process. See //**[[#supplemental field controls|Supplemental Field Controls]]**// for additional information on sorting. 
-  * A **Select Distinct** statement cannot be used directly. This is due to some internal constraints used in the Versago SQL processing. If “Select Distinct” is needed it will need to be done using a sub-query.  An example is found >> here. 
-  * **Computed values** in the SQL statement must be assigned an alias. For example, the statement “ColA + ColB” will not work. Instead, you would need to use something like “ColA + ColB as [CalcValue]” where [CalcValue] is the alias. “CalcValue” is then seen as a valid column in the subsequent report definition steps. 
- 
-===== Crystal Report ===== 
- 
-A different data presentation option is provided through the **Crystal Report** method. In this case a Crystal Report is developed outside of Versago. The report is then registered in Versago and used as the presentation method. 
- 
-  - Select the Crystal Report object type. 
-  - A dialog box is presented to select the desired Crystal Report. 
- 
-{{  :versago/reports23.png?352x137  }} 
- 
-  - Click [**Choose File**] to open the standard Windows Explorer tool. 
-  - Locate and “open” the desired Crystal Reports file (.RPT). 
-    - The file name is displayed in the Versago dialog. 
-  - Click [**Select**] to associate the Crystal Report file with the Versago report. 
-    - Once the file has been selected you will see file path information displayed in the Report Data Source box. 
- 
-{{  :versago/reports24.png?166x82  }} 
- 
-The Crystal Report source file is copied from the original location to the folder “C:\Program Files (x86)\TWBS\Versago\Websites\Versago Administration Web Site\Reports.” A number is added in front of the file name to ensure it always unique. If the Crystal Report needs to be modified, you can either modify this file or modify it elsewhere and re-register the new version in Versago. 
- 
-===== B1 Saved Query ===== 
- 
-The **B1 Saved Query** option is only available for sites using the SAP Business One business management system. This option provides a method to use queries developed in SAP Business One as a Versago data source. 
- 
-The database connection (“Database” as described earlier in this document) must include the credentials required to connect to SAP Business One for this option to work. This configuration is described in the //Versago – Database Connections Configuration// document. 
- 
-  - Select the “B1 Saved Query” option. 
-  - Click the “Report Data Source” drop-down to see a list of available saved queries from SAP Business One. 
-  - Select the desired query. 
- 
-While this option is available, the preferred approach is to copy the query from Query Manager in SAP Business One and paste it into Versago as a SQL Select statement. 
- 
-===== Stored Procedure ===== 
- 
-In some rare instances it may be necessary to use a SQL Stored Procedure as the data source. This approach is not recommended if any other option is available. However, it is available. 
- 
-  - Select the “Stored Procedure” option. 
-  - Click the “Report Data Source” drop-down to see a list of available stored procedures in the designated database. 
-  - Select the desired procedure. 
- 
-Keep in mind that if the procedure is changed so that different/additional column names are returned, you must step through the report configuration process again to be sure these changes are accounted for in the “Display” step. 
- 
-===== View ===== 
- 
-The “View” option is no longer needed since a SQL View can be referenced in the SQL Select option. The “View” option will be dropped in a future release of Versago. 
- 
-===== Visual Query Editor ===== 
- 
-The “Visual Query Editor” is no longer supported in Versago and should not be used. 
  
  
Line 415: Line 334:
  
 The “refresh” process can be done using a scheduled job in SQL or setting up workflow in Third Wave’s Bizweaver application to execute the processing. The “refresh” process can be done using a scheduled job in SQL or setting up workflow in Third Wave’s Bizweaver application to execute the processing.
- 
-====== Files for Download through Versago ====== 
- 
-As noted in the //**[[#supplemental_field_controls|Supplemental Field Controls]]**// section, Versago can be used as a mechanism to allow users to download files. This is a particularly attractive way to make documents available to various partners on a “self-serve” basis. 
- 
-===== MIME Types ===== 
- 
-**Technical Topic** 
- 
-Multipurpose Internet Mail Extensions (**MIME**) types identify the types of content that can be served to a browser or a mail client from a Web server. Since Versago is a browser-based application, any file types that may be downloaded must be defined to the web server. 
- 
-The most common file types (PDF, XLXS, TXT, DOCX, etc.) are already defined in IIS (the Windows web server). The general process to add/maintain MIME types is described here: https://technet.microsoft.com/en-us/library/cc725608(v=ws.10).aspx. 
- 
-One MIME type that is not defined by default is for Outlook email messages. These files have the extension **.msg**. Specific steps to add this MIME type are found here: http://blogs.catapultsystems.com/rhutton/archive/2013/10/25/unable-to-open-outlook-message-file-in-web-browser-msg/. 
  
 ====== Setting Static Filter Values ====== ====== Setting Static Filter Values ======
versago/report_configuration.1578498347.txt.gz · Last modified: 2020/01/08 10:45 by runger