Forms

You can set up forms where you can enter, change, and view the data in a database.

Forms are made up of controls, such as text boxes, buttons and drop-down lists, grouped in a way that makes them easy to use and helps you get work done.

After defining a Form object, you can either access it directly from My documents folder, include it in a Dashboard (see Create a Web Dashboard) or you can use it in a Dynamic link (see Dynamic links) to navigate from a Report to Form.

Create a form

  1. On the Main menu, click Dashboard design > Form to access the list of existing forms.
  2. Click the New document button to create a new Form.
  3. A new document opens and the Description tab displays.
  4. Specify values for the following fields:
  5. Field Description
    Name A unique identifier for the form object.
    Description A user-friendly label for your form to be used throughout the UI. You can internationalize the description.
    Entity

    Owning entity (see User access managment).

    This value will impact the access rights for this form. Depending on the entity, the form designer will be able to select one data dictionary accessible from this entity. Also, only users that have access to this entity will be able to use the form.

    Query The data dictionary used to access the data. Only standard data dictionaries can be used to define forms. The selected data dictionary should use a world (database connection) that allows table content modification (no “read-only” option) and user access with appropriate DB privileges.
    Table A table from the selected data dictionary on which the form will be based. The table should have a primary key.
    Allow insert Allows users to insert data in the form. This would allow the user to add a line in the table selected above.
    Allow update Allows users to modify data in the form. This would allow the user to update a line in the table selected above.
    Allow delete Allows users to delete data from the from. This would allow the user to delete a line in the table selected above.
  6. On the Design tab, define and configure the columns to be used in the form:
    1. Add columns from the Available fields section in the Used fields sections if you want use them in the form.
    2. Delete columns in the Used fields section if you do not want to display them in the form. Several properties of each column can be configured by clicking on the columns in the Used fields section:
    3. FieldDescription
      Prompt type

      Two prompt types are available:

      • Simple value prompt type: allows the user to manually enter a value in the input box when adding new lines in the form.
      • Simple select: allows the user to select a value from a list when adding new lines in the form. This type of prompt is available when joining a dependent table to your table to fulfill the form value list. For example you could display a ClientID value list if your table has a foreign key that will be joined with the client table.
      DescriptionSet the label of the column to be displayed in the form.
      CommentAdd a comment to the column. The comment will be available on the prompt used by dynamic links.
      Display type

      Two display types are available:

      • Visible: if this option is unselected the column won't be displayed when visualizing the form.
      • Updatable: if this option is unselected the values in the column cannot be modified.
      Field nameThe name of the column as it is in the database. This field cannot be modified.
      Default valueThe default value of the column. This will be the value added by default when you add a new row to the form.
      Min valueThe minimum value that can be inserted in the column. You are not allowed to insert smaller values in this column.
      Max valueThe maximum value that can be inserted in the column. You are not allowed to insert grater values in this column.
      In SQL insert statementsNew values can be inserted in the data base.
      In SQL update statementsExisting values can be modified in the database.
      NullableShows if the column support null values or not.
      Usable in linksThe column can be used when defining dynamic links. For more details see Dynamic links.
      RequiredWhen you a new line in a form, you must insert values in the columns marked as required. This option is mandatory for the primary key fields and all the fields with the nullable option disabled.

Visualize Forms

You can visualize forms by accessing them directly from the My documents folder, by including them in a Dashboard or by using them in a Dynamic link allowing navigation from a Report to Form.

When you visualize a form, you see a spreadsheet where you can update, add, or remove rows. Alternatively, if you use dynamic links and the pop-up options, you can update fields related to the source you selected in a prompt window.

After modifying the form, you can save the changes. If you do so, these changes will also be reflected at database level. Attention! After the last value you update in the form, make sure that you press the Enter key or change the focus from that cell to another cell on the form. Otherwise the value you last entered may be lost.

You can also refresh the page in order to bring new data from the database or you can go to edit the form at design level.

Related Links