Table of Contents
Setup
Basic configuration about the form is defined on the Setup page.
Information
- Name is a unique name for this form.
- Title is displayed in the Versago user menus
- Category is the grouping mechanism used in the default Versago menu structure.
- Previously defined categories can be selected from the drop-down list. A new category can be created by typing the desired value and selecting Add from the drop-down.
- Description is an optional internal explanation of the data view.
- Instruction is displayed at the top of the user data view page.
- Form Type defines the structure of the data.
Availability
- Roles define the group of users that have access to the data view.
- 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.
- The most common use of this option is when the form is called from a data view using a link.
- Activate the Read only option when you have a form for data display purposes.
Connection
- Select the Connection Name from the list of configured connections. See the Connections page for information on configuring database connections.
- When a connection is selected, the associated database name is displayed to the right.
- Select Existing table or New tables to store the data.
- Select or name the Header and/or Detail table
Tables
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
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.
Primary Table
- 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 (v2) and 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.
One field must be selected as the Primary Field. This field is used by Versago to identify each unique record.
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.
The detail table cannot have a Primary Key. This is an important consideration when using existing tables.