versago3:form_setup

Differences

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

Link to this comparison view

Next revision
Previous revision
versago3:form_setup [2022/10/31 10:34]
dlee created
versago3:form_setup [2023/04/11 11:43] (current)
dlee
Line 1: Line 1:
 ====== Setup ====== ====== Setup ======
  
-Basic configuration about the data view is defined on the Setup page. +Basic configuration about the form is defined on the Setup page. 
  
-{{ :versago3:dv_setup01.png?direct&1000 |}}+{{ :versago3:form_setup01.png?direct&1000 |}}
  
  
 ==== Information ==== ==== Information ====
  
-  * **Name** is a __unique__ name for this data view.+  * **Name** is a __unique__ name for this form.
   * **Title** is displayed in the Versago user menus   * **Title** is displayed in the Versago user menus
   * **Category** is the grouping mechanism used in the default Versago menu structure.   * **Category** is the grouping mechanism used in the default Versago menu structure.
Line 14: Line 14:
   * **Description** is an optional internal explanation of the data view.   * **Description** is an optional internal explanation of the data view.
   * **Instruction** is displayed at the top of the user data view page.   * **Instruction** is displayed at the top of the user data view page.
 +  * **Form Type ** defines the structure of the data.
      
 ==== Availability ==== ==== Availability ====
Line 20: Line 21:
   * Activate the **Public** option if the data view should be available prior to a user logging in.   * Activate the **Public** option if the data view should be available prior to a user logging in.
   * Activate 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.   * Activate 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 lookup tool in Versago Forms, or as sub-report in other Versago Reports. +    * The most common use of this option is when the form is called from data view using link
-     +  * Activate the **Read only** option when you have form for data display purposes
-==== Presentation Format ==== + 
- +
-  * **List or Chart** format is the default “row & column” presentation. +
-  * **Enable Paging** is used in conjunction with **Page Count** if you want to ensure that specific number of records are displayed on each page+
-  * The **Schedule** format presents the data view in a calendar. See the **//[[versago3:dataview_schedule#Schedule]]//** page for additional configuration information.+
  
 ==== Connection ==== ==== Connection ====
Line 32: Line 29:
   * Select the **Connection Name** from the list of configured connections. See the **//[[versago3:connections|Connections]]//** page for information on configuring database connections.   * Select the **Connection Name** from the list of configured connections. See the **//[[versago3:connections|Connections]]//** page for information on configuring database connections.
       * When a connection is selected, the associated database name is displayed to the right.       * When a connection is selected, the associated database name is displayed to the right.
-  * Select the **Data Source Type**  +  * Select **Existing table ** or **New tables** to store the data.  
- +  * Select or name the **Header ** and/or **Detail** table
-===== Data Source Types ===== +
- +
-{{  :versago3:dv_setup02.png?200  |}} +
- +
-==== SQL Query ==== +
- +
-When this option is selected, a SELECT SQL statement can be entered manually or pasted from another source such as SQL Server Management Studio. +
- +
-{{  :versago3:dv_setup03.png?direct  |}} +
- +
-  Enter the SELECT statement in the “Editor” area. +
-  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 “Results” area. +
- +
-=== SQL Statement Restrictions === +
- +
-  An **Order By** clause cannot be used except in cases where the statement contains a TOP operator. The ordering (sorting) is handled by the data view's Field Display settings +
-  * **Computed values** in the SQL statement must be assigned an alias.  +
- +
-==== B1 Query ==== +
- +
-This option should only be used with connections to SAP Business One. This option allows to select user queries built in SAP Business One. +
- +
-==== Stored Procedure ==== +
- +
-In some rare instances it may be necessary to use an SQL Stored Procedure as the data source. This approach is not recommended if any other option is available. +
- +
-Store procedure parameters must be configured in the **//[[versago3:dataview_filters|Filters]]//** page. +
-====View==== +
- +
-This option allows the use of a database View as the data source +
-   +
-==== Crystal Report ==== +
- +
-A Data View can be configured to display a Crystal Report. When this option is selected, the Crystal Report definition file is uploaded to the Versago site and used as the presentation method. +
- +
-<WRAP center round important 80% > +
-The data source used in the Crystal Report definition **must** be the same as that of the Versago Data View connection. +
-</WRAP> +
  
-  * Select Crystal Report as the data source type. +===== Tables =====
-  * A dialog box is presented where a Crystal Report definition file (.RPT) can be selected.+
  
-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 prefixed to the file name to ensure it uniqueness. If the Crystal Report needs to be modifiedyou can either modify this file or modify it elsewhere and re-register the new version in Versago.+This section of the form set up pages allows to define the columns of the new tables if the **New tables** option is selected. 
 +If existing tables are selected, the page displays the selected table structure
  
---- +{{  :versago3:form_setup02.png?direct  |}}
-=====**Need to review**=====+
  
-===SQL Server=== +<WRAP center round important 80%> 
-When designing a Crystal Report that will use a __SQL Server__ database as its data source, the report connection type must be **OLE DB (ADO)**. This connection type has three options for the data provider: **SQL Native Client**, **Microsoft OLE DB Driver for SQL Server**, and **Microsoft OLE DB Provider for SQL Server**.  Any of these options should work with Versago.+The process described below can only be used to create tables. It cannot be used to modify an existing table. This must be done directly in SQL. 
 +</WRAP>
  
-===HANA=== 
-When designing a Crystal Report that will us a __HANA__ database as its data source, the report connection type be **ODBC (RDO)**.  **{{ :versago:b1h_90_ht_setupdsforcrl.pdf |This document }}** explains how to configure this type of connection for use with HANA.  Two options are described in the document.  Be sure to use the **B1CRHPROXY32** option.  Here is a sample connection string to use as a starting point. 
  
-<code> +==== Primary Table ====
-DRIVER={B1CRHPROXY32};SERVERNODE=<YourServer>:30015;DATABASE=<YourDB> +
-</code>+
  
-Replace <YourServer> and <YourDB> (without the < > symbolswith the appropriate values.+  - **FieldName** is the column name used in the database, not what appears to the user on the form 
 +    - The name can use letters, numbers, and the underscore (_) character. Spaces and other special characters are not permitted. 
 +  - **Data Type** is selected from the drop-down option list. 
 +    - Use of the Binary option is not supported in Versago Forms (v2and should not be used. 
 +    - Date is always created in the database as a DateTime data type. 
 +    - The data type for Number is set based on the Format (below). 
 +  - **Format** is used for data types of Date and Numeric. 
 +    - Date data type 
 +      - The Date data type is always created in the database as a DateTime data type, irrespective of format. 
 +    - Number data type 
 +      - Format of Integer is always created in the database as an Integer (whole number) data type. 
 +      - Format of Decimal is always created in the database as Decimal data type. 
 +    - Text data type 
 +      - Text format is created as nvarchar data type. 
 +      - Text(max) is created as nvarchar(max) data type. 
 +  - **Size** is the number of characters of the column in the database. 
 +    - For Text fields this is the maximum number of characters that can be entered. 
 +  - **Precision** indicates the number of decimals for Numeric/Decimal columns.
  
 +<WRAP center round important 80%>
 +One field must be selected as the **Primary Field**. This field is used by Versago to identify each unique record.
 +</WRAP>
  
 +==== Recommended fields ====
 +We recommend the creation of the following fields using the shown naming convention.
  
 +^Field Name         ^Usage                                                                                                                               ^Comments                                                                                                              ^
 +|vgoRecNum          |Primary key                                                                                                                         |Required for any form table. Must be Numeric/Integer.                                                                 |
 +|vgoCreatedBy       |Email of user creating a new record                                                                                                 |Should be included in any header form table                                                                           |
 +|vgoCreateDate      |Date a new record is created                                                                                                        |Should be included in any header form table                                                                           |
 +|vgoCreatedById     |Versago User ID of user creating a new record                                                                                       |Should be included in any header form table. Used for reporting and profile access control                            |
 +|vgoLastModifiedBy  |Email of user modifying an existing record                                                                                          |Only needed if records will be updated using the same form where they were created, and if change tracking is desired.|
 +|vgoLastModifiedDate|Date an existing record is modified                                                                                                 |Only needed if records will be updated using the same form where they were created, and if change tracking is desired.|
 +|vgoLastModifiedById|Versago User ID of user modifying an existing record                                                                                |Only needed if records will be updated using the same form where they were created, and if change tracking is desired.|
 +|vgoProcessStatus   |“Flag” value to indicate if a record has been processed in some way (e.g. via Bizweaver)                                            |                                                                           |
 +|vgoProcessDate     |Date a record has been processed in some way (e.g. via Bizweaver)                                                                                                                                            |
 +|vgoLinkID          |Can be used to capture the ID of a record created in another system when the form record is processed in some way (e.g. Bizweaver)  |                                                                                                                      |
 +|vgoLinkDate        |Can be used to capture the date a record is created in another system when the form record is processed in some way (e.g. Bizweaver)|Like vgoProcessDate but used if two separate date stamps are desired.                                                 |
 +|                                                                                                                                                      |
 +===== Detail Table =====
  
 +A detail table is only used when the form type is Header/Detail. The definition process is the same as shown for the primary table. The only differences are the table name and the definition of the **Link** field to connect the header table record with the detail table records. The Linked Field must be the same name, data type, and format as the Primary Key in the header table.
  
 +<WRAP center round important 80%>
 +The detail table cannot have a **Primary Key**. This is an important consideration when using existing tables. 
 +</WRAP>
 ---- ----
-**[[versago3:form#Add/Edit Data View]]**+**[[versago3:forms#Add/Edit Form]]**
  
 **[[versago3:Home|Home]]** **[[versago3:Home|Home]]**
      
versago3/form_setup.1667226899.txt.gz · Last modified: 2022/10/31 10:34 by dlee