Wiki

Scale Your Enterprise

User Tools

Site Tools


versago:form_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:form_configuration [2019/08/29 13:15]
runger [Calling a Bizweaver Workflow]
versago:form_configuration [2020/07/27 11:03] (current)
dlee [User Information]
Line 19: Line 19:
 The following documents contain additional information that may be helpful with understanding these processes. The following documents contain additional information that may be helpful with understanding these processes.
  
-  * [[versago:database_connection_configuration|Database Connections]]+  * **//[[versago:database_connection_configuration|Database Connections]]//**
  
 ====== Special Terminology ====== ====== Special Terminology ======
Line 47: Line 47:
  
   * A listing of existing forms is displayed when the function is opened.   * A listing of existing forms is displayed when the function is opened.
-  * Click the [**Add New Form**] button to create a new form.  Detailed information is found [[Create New Form|here]].+  * Click the [**Add New Form**] button to create a new form.  Detailed information is found //**[[Create New Form|here]]**//.
   * Click the __link__ for the menu in the Form Name column to edit an existing form.   * Click the __link__ for the menu in the Form Name column to edit an existing form.
   * Click the [**Delete**] button (the X) to remove a form.   * Click the [**Delete**] button (the X) to remove a form.
     * When a form is deleted in the Admin Console, its references in Versago are removed as are associated SQL Stored Procedures in the database. However, the associated data table(s) are left in place. If these tables are no longer needed they must be removed manually.     * When a form is deleted in the Admin Console, its references in Versago are removed as are associated SQL Stored Procedures in the database. However, the associated data table(s) are left in place. If these tables are no longer needed they must be removed manually.
-  * Click the [**Clone Form**] button to create a copy of the current form.  The cloning process is discussed [[Clone Form|here]].+  * Click the [**Clone Form**] button to create a copy of the current form.  The cloning process is discussed //**[[Clone Form|here]]**//.
  
 ====== Form Layout ====== ====== Form Layout ======
  
-**Form Layout** is the process of positioning fields for optimal end-user interaction. //This process in v2 Forms is quite different than in previous versions.//  The form layout process is described [[Form Layout|here]].+**Form Layout** is the process of positioning fields for optimal end-user interaction. //This process in v2 Forms is quite different than in previous versions.//  The form layout process is described //**[[Form Layout|here]]**//.
  
 ====== Form Controls (Types, Properties, Buttons, Managing)====== ====== Form Controls (Types, Properties, Buttons, Managing)======
Line 61: Line 61:
 A form layout consists of rows as described above. Each row can consist of one to twelve columns. Form input controls are then placed (drag and drop) in the columns. The controls provide the mechanisms for data input presented to the end user. Form controls have various properties that define their presentation and behavior. A form layout consists of rows as described above. Each row can consist of one to twelve columns. Form input controls are then placed (drag and drop) in the columns. The controls provide the mechanisms for data input presented to the end user. Form controls have various properties that define their presentation and behavior.
  
-**Control Types** are discussed [[Control Types|here]].+**Control Types** are discussed //**[[Control Types|here]]**//.
  
-**Control Properties** are discussed [[Control Properties|here]].+**Control Properties** are discussed //**[[Control Properties|here]]**//.
  
-**Standard Buttons** are discussed [[Standard Buttons|here]].+**Standard Buttons** are discussed //**[[Standard Buttons|here]]**//.
  
-The process of **managing controls** is discussed [[Managing Controls|here]].+The process of **managing controls** is discussed //**[[Managing Controls|here]]**//.
  
  
Line 76: Line 76:
 Creating database tables using Versago is described in the following sections. However, keep in mind one key caveat: Creating database tables using Versago is described in the following sections. However, keep in mind one key caveat:
  
-<WRAP center round tip>+<WRAP center round important>
 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. 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> </WRAP>
Line 91: Line 91:
 Data columns are added using the [+Add Field] button to open a new line in the grid. Data columns are added using the [+Add Field] button to open a new line in the grid.
  
-{{::versago:formv2image80.png?576x111}}+{{  ::versago:formv2image80.png?576x111  }}
  
   - **FieldName** is the column name used in the database, not what appears to the user on the form   - **FieldName** is the column name used in the database, not what appears to the user on the form
Line 117: Line 117:
     - Only one primary field should be identified.     - Only one primary field should be identified.
   - **Precision** indicates the number of decimals for Numeric/Decimal columns.   - **Precision** indicates the number of decimals for Numeric/Decimal columns.
-    - All decimal columns are created with six (6) decimal points. The precision value is only used as a starting point in the form layout process when a control for this column is added. \\ \\ The values in the following image are typical basic columns for a Versago form. The names are not significant, but the data captured is relevant. Names for all other data can be created as desired. However, standard SQL Server naming restrictions will apply. \\ {{::versago:formv2image81.png?576x211}} \\ +    - All decimal columns are created with six (6) decimal points. The precision value is only used as a starting point in the form layout process when a control for this column is added. \\ \\ The values in the following image are typical basic columns for a Versago form. The names are not significant, but the data captured is relevant. Names for all other data can be created as desired. However, standard SQL Server naming restrictions will apply. \\  
 + {{  ::versago:formv2image81.png?576x211  }} \\ 
  
 ^Field Name         ^Usage                                                                                                                               ^Comments                                                                                                              ^ ^Field Name         ^Usage                                                                                                                               ^Comments                                                                                                              ^
Line 142: Line 143:
 The following images illustrate this setup. The following images illustrate this setup.
  
-{{::versago:formv2image82.png?576x96}}+{{  ::versago:formv2image82.png?576x96  }}
  
 In the detail table the column that links to the key value in the header is named “Linked Field.” In the detail table the column that links to the key value in the header is named “Linked Field.”
  
-{{::versago:formv2image83.png?576x80}}+{{  ::versago:formv2image83.png?576x80  }}
  
 ====== Versago Form Tables (SQL) ====== ====== Versago Form Tables (SQL) ======
Line 205: Line 206:
 Lookups (also called Lookup List) are used when the list of values is extensive and is prone to change on a regular basis. An example where a lookup might be used is to show a list of customers. When a lookup list is used, the user can only select from these values, so consistency of input data is ensured. A field with a lookup list displays a “filter” indicator at the right end of the field. Lookups (also called Lookup List) are used when the list of values is extensive and is prone to change on a regular basis. An example where a lookup might be used is to show a list of customers. When a lookup list is used, the user can only select from these values, so consistency of input data is ensured. A field with a lookup list displays a “filter” indicator at the right end of the field.
  
-{{::versago:formv2image85.png?409x45}}+{{  ::versago:formv2image85.png?409x45  }}
  
 ===== Create the Versago Report ===== ===== Create the Versago Report =====
Line 228: Line 229:
 In this example, we use a lookup to present a list of U.S. states. We want the user to select the state by name, but we want to capture both the name and the associated code. In this example, we use a lookup to present a list of U.S. states. We want the user to select the state by name, but we want to capture both the name and the associated code.
  
-{{::versago:formv2image86.png?384x161}}+{{  ::versago:formv2image86.png?384x161  }}
  
 In this example the value “Name” is placed in the Column (control) named “Lookup1” and the associated code is placed in the Column (control) named “Lookup2.” In this example the value “Name” is placed in the Column (control) named “Lookup1” and the associated code is placed in the Column (control) named “Lookup2.”
Line 238: Line 239:
 The configuration of a Dynamic DDL is more complicated than a Static DDL in that it uses a Versago report as the source for the list of values. It also allows values to be placed in other controls as needed. The configuration of a Dynamic DDL is more complicated than a Static DDL in that it uses a Versago report as the source for the list of values. It also allows values to be placed in other controls as needed.
  
-<WRAP center round important>+<WRAP center round tip>
 Even though this DDL uses a report as its source for the list of values, the list of values should be relatively short. Having too many values in a DDL makes it difficult for the user to find the value they need. Even though this DDL uses a report as its source for the list of values, the list of values should be relatively short. Having too many values in a DDL makes it difficult for the user to find the value they need.
  
-In many cases, using a Lookup report instead of a Dynamic DDL is a better approach. The Lookup report provides some functionality, such as “search”, that the Dynamic DDL does not.+In most cases, using a Lookup report instead of a Dynamic DDL is a better approach. The Lookup report provides some functionality, such as “search”, that the Dynamic DDL does not.
 </WRAP> </WRAP>
 +
 +
 +
  
  
Line 267: Line 271:
 ===== Configure a Single Value DDL ===== ===== Configure a Single Value DDL =====
  
-{{::versago:formv2image87.png?576x73}}+{{  ::versago:formv2image87.png?576x73  }}
  
   - On the “Control Settings” tab, select “Drop-downlist” as the Control Type.   - On the “Control Settings” tab, select “Drop-downlist” as the Control Type.
Line 279: Line 283:
 ===== Configure a Two Value DDL ===== ===== Configure a Two Value DDL =====
  
-{{::versago:formv2image88.png?576x76}}+{{  ::versago:formv2image88.png?576x76  }}
  
   - Follow steps 1 – 4 for the Single Value DDL described above.   - Follow steps 1 – 4 for the Single Value DDL described above.
Line 285: Line 289:
   - Select the report value to be saved to the database for “DataValueField.”   - Select the report value to be saved to the database for “DataValueField.”
  
-The [ …] button to the right of the Report selection drop-down can used to set up additional values to be captured and, if appropriate, the control(s) that provide input to any report parameters. This process is the same as described in [[versago:form_configuration#lookup_reports|Lookup Reports]].\\+The [ …] button to the right of the Report selection drop-down can used to set up additional values to be captured and, if appropriate, the control(s) that provide input to any report parameters. This process is the same as described in //**[[versago:form_configuration#lookup_reports|Lookup Reports]]**//. \\
  
 ====== Using Custom Form Buttons ====== ====== Using Custom Form Buttons ======
Line 312: Line 316:
 ===== Configuring a Button ===== ===== Configuring a Button =====
  
-{{::versago:formv2image89.png?384x72}}+{{  ::versago:formv2image89.png?384x72  }}
  
 Click the [**Action**] button to open the configuration dialog. Click the [**Action**] button to open the configuration dialog.
  
-{{::versago:formv2image90.png?384x288}}+{{  ::versago:formv2image90.png?384x288  }}
  
 ==== Create a New Action ==== ==== Create a New Action ====
Line 332: Line 336:
 ==== Modifying an Existing Action ==== ==== Modifying an Existing Action ====
  
-{{::versago:formv2image91.png?576x342}}+{{  ::versago:formv2image91.png?576x342  }}
  
   - Open the **Control Properties** for the button, then open the **Actions**.   - Open the **Control Properties** for the button, then open the **Actions**.
Line 363: Line 367:
 ===== System Information as Defaults ===== ===== System Information as Defaults =====
  
-<WRAP center round info>+<WRAP center round tip>
 **Note that** **the format and case of the User Information, Date, and header-to-row commands is critical**. **Note that** **the format and case of the User Information, Date, and header-to-row commands is critical**.
 </WRAP> </WRAP>
Line 369: Line 373:
 ==== User Information ==== ==== User Information ====
  
-"UserProfile" values are related to the current user. “Id” and “UserName” are typically captured to identify which user created the record.+"UserProfile" values are related to the current user's Versago profile. “Id” and “UserName” are typically captured to identify which user created the record.
  
   * {UserProfile**.**$Id} – returns the internal user ID code (integer)   * {UserProfile**.**$Id} – returns the internal user ID code (integer)
Line 375: Line 379:
   * {UserProfile**.**$FirstName} – returns the user’s first name   * {UserProfile**.**$FirstName} – returns the user’s first name
   * {UserProfile**.**$LastName} – returns the user’s last name   * {UserProfile**.**$LastName} – returns the user’s last name
 +  * {UserProfile**.**$CopmpanyName} – returns the user’s Company name
  
 ==== Date Information ==== ==== Date Information ====
Line 398: Line 403:
 **Bizweaver** is a companion product to Versago that is used for data management and integration.  The processes that execute the work to be done are called **workflows**.  A Bizweaver workflow can be initiated using a Versago form button action. This process uses a web service (API) provided by Bizweaver. The button can either be a standard form button (Save & Close, Save & New, Save, Delete) or a custom button. **Bizweaver** is a companion product to Versago that is used for data management and integration.  The processes that execute the work to be done are called **workflows**.  A Bizweaver workflow can be initiated using a Versago form button action. This process uses a web service (API) provided by Bizweaver. The button can either be a standard form button (Save & Close, Save & New, Save, Delete) or a custom button.
  
-There are two methods available to initiate a Bizweaver workflow**POST** and **GET**.+Bizweaver workflow is initiated using a **POST** transaction. Information on using this method is found **//[[Invoke Bizweaver Using POST|here]]//**.
  
-The **POST** method is introduced in v2.3.  It provides authentication for the request and is the preferred method.  Information on using this method is found **//[[Invoke Bizweaver Using POST|here]]//**. +<WRAP center round important 80%> 
- +Any forms that were created using the v1 Form Builder tool will need to be rebuilt using the v2 Form Builder tool in order to use the POST functionality.  v1 forms only allow use of the GET transaction, which is no longer supported.
-The **GET** method was introduced in v2.2.  It provides similar functionality to the POST method, but does not provide authentication. +
- +
-<WRAP center round important 60%> +
-Any forms using the GET method will continue to function, but changing to the POST method is strongly recommended.+
 </WRAP> </WRAP>
  
-Information on using this method is found **//[[Invoke Bizweaver Using GET|here]]//**. 
  
 ====== Read-Only Forms ====== ====== Read-Only Forms ======
Line 441: Line 441:
 |5 |12      |1       | |5 |12      |1       |
 |  |        |        | |  |        |        |
 +
 +"Attachment" files can be converted back to their original form and stored on disk using Bizweaver.  Information on this process can be found **//[[bw:file_writer_tool#binary_output|here]]//**.
  
 ====== Examples of Creating a Form ===== ====== Examples of Creating a Form =====
versago/form_configuration.1567098957.txt.gz · Last modified: 2019/08/29 13:15 by runger