Templates

Field Properties

Last Updated: Aug 18, 2017 10:21AM PDT


GoFormz provides a wide variety of field types that you can use to build a form. Each type of field has many different properties, allowing you to fine-tune the field’s look-and-feel, layout, and functionality. This document has three parts:

  • Field Types: Lists and describes all the available field types.
  • Common Properties: Describes properties shared across many different Field Types, separated by property type (e.g. size and position, look and feel, etc.).
  • Field-Specific Properties: Describes properties that are unique to just one or two field types.

Common Properties

The properties below are common to most GoFormz fields.

Reporting Metadata

  • Name - The name by which the field will be referenced in reports. The name does not appear in the form itself when it is being filled out.
  • Description - A short text snippet that elaborates on the field name, describing what kind of information the user should enter in this field. The description appears as a tooltip when you hover on the field name in the Reporting interface.
  • Identifier - Choose “Yes” if you want this field to serve as a unique identifier for your form -- perhaps the customer name, or purchase order number. The contents of this field will appear in the Identifier column of the Forms list, making it easier for you to quickly find a specific form. Note that you can only have one Identifier per template. If several fields are set up as Identifiers, only one of them will appear in the Forms list.

 

Size and Position

 

Field position is set using pixels from the upper left corner of the form, while field size is set via pixel width and height:

  • Left - The offset of the left edge of the field from the left edge of the form, in pixels.
  • Top - The offset of the top edge of the field from the top edge of the form, in pixels.
  • Width - The width of the field, in pixels.
  • Height - The height of the field, in pixels.

 
Together, these 4 properties determine exactly where on your form the field will be located, and how large it will be. We recommend sizing and positioning your field using the drag-and-drop features of the Template Editor, and then using these 4 properties to fine-tune the size and position if necessary.
 

Look and Feel

Note that the background colors (see Background and Focus Color below) only appear while the form is being filled out -- they are no longer visible after the form is completed. All other look and feel properties persist after form completion.
 

  • Align - The alignment of content within the field. Text can be aligned with the Left or Right side of the field, or Centered within the field. Other items (e.g. Images or Sketches) can be Centered or aligned with the Top Left corner.
  • Font - The font of any text inside the field. Our standard set of web fonts include: Arial, Courier New, Georgia, Helvetica, Times, Trebuchet MS, and Verdana.
  • Size - The size of any text inside the field.
  • Color - The color of the text or symbol inside the field.
  • Background - The color of the background behind the field while the form is being filled out. When the form is completed, all background colors disappear.
  • Focus Color - The color of the background when the user selects this field. When the field is not selected, the background color is determined by the Background property. This property is available for Text Box, Number, and Table fields.

 

Input Management - Defaults, Formatting, and Permissions

  • Allow Override - This property is only useful if a formula (calculation or data source) is used to as the Default Value for this field. Choose “Yes” to allow a user to enter their own value for the field, overriding the formula. Otherwise, the field will always default to the calculated value.
  • Author Only - Choose “Yes” if you want this field to be editable only by the user who started the form. This is useful for enforcing user permissions for particular fields in a workflow. Your form may have to go through several people before it is complete; this lets you specify that certain fields can only be filled out by the person who initiated the form.
  • Default Value - The value that appears in this field by default when the form is first opened. For text-based fields, this value can be a formula that either repeats a value from another form field, gets a value from a database column, or performs a calculation based on one or more other fields. See here for documentation on calculation syntax.
  • Formatting - The format in which the user's input should be displayed. The user doesn't have to enter text in this format, but it will be converted to this format whenever possible. GoFormz provides several pre-built format types for you to choose from, or you can enter a custom formatting string. The available format types are:
    • Social Security Number: e.g. 123-45-6789
    • Phone Number: e.g. 555-5555
    • Percentage: e.g. 34%
    • Currency: e.g. $123,456.50
    • The formatting string syntax is very similar to Excel. For instance:
      • "hh:mm:ss" stands for time in hours, minutes and seconds -- "10:05:32"
      • "##,###.00" stands for a number with thousands separators and two significant digits after the decimal point -- "1,234,567.89"
      • etc.
  • Lock First Value - Choose “Yes” if you want the first value set in this field to become permanent. When this property is set, the field value becomes uneditable as soon as it has been set once. This property does not apply to admin users (users not in a group) on the website.
  • Required - Choose “Yes” if you want to make this field required for all users. A user will not be able to mark this form as Complete until this field is entered.

 

Additional Functionality

  • Availability - This property lets you share a field across multiple forms. If you have a field that you plan to use in many different forms -- e.g. Customer Name or Address -- this feature lets you build the field just once, and then reuse it in as many forms as you like. The available values are:
    • Shared: The field will appear in the Shared Form Fields section of the Template Editor, and can be included in other forms.
    • This Form: The field can only be used in this form.
  • Tab Index - The index of this field when tab-navigating through the form. Tab navigation is done using the Next button on a mobile device, or the Tab key on a keyboard. For instance, if your form has 3 fields A, B, and C indexed 4, 2, and 7 respectively -- then the tabbing order will be B, A, C. This is handy for users who want to quickly fill out the form without having to select each field individually. This property is available for Text Box, Number, and Table fields. You should set the Focus Color in conjunction with Tab Index, because it makes it easier to see which field is currently selected.

 

Field-Specific Properties

Some GoFormz fields are specific to just one or several types of fields. These are documented below, for each field type.

Auto Number

  • Seed Number - The number of the first form created from this template. This number will be incremented by 1 for each successive form that is created.
  • Other Properties - See Common Properties

 

Check Box

  • Display - The symbol that is used to fill in the box. Available options are Checkmark, Xmark, Circle, and Oval. A circle or oval may be handy if you want to circle an element on your form.
  • Other Properties - See Common Properties

 

Check Box Group

  • Group Name - The name by which this group will be referenced in reports. See “Name” under Common Properties.
  • Group Desc - See “Description” under Common Properties.
  • Group Items - The names of the check boxes in this group. These names are added to the "This Form Fields" section of the Toolbox on the left side of the Template Editor. After creating the check box group, you will need to add each individual check box from the group into your form.
  • Item Name - The name of this check box. This should be one of the names that was specified in the Group Items property.
  • Multi Select - Specifies whether or not you are allowed to select multiple check boxes from the group in the same form.
  • Display - The symbol that is used to fill in the box. Available options are Checkmark, Xmark, Circle, and Oval. A circle or oval may be handy if you want to circle an element on your form.
  • Other Properties - See Common Properties

 

Database

  • Data Source - The name of the Goformz Data Source from which you want to source data for this field. Click here for more on Goformz databases, including further documentation on how to use the Display Column and Filter properties.
  • Display Column - The name of the database column that contains the list of options for this field. You can only select columns that have been set as indexes, or keys, in the Data Source. See Data Source documentation for more.
  • Filter - A filter string that determines the subset of Display Column values that should be available as choices. For instance, suppose you have a large customer database, but for this field you only want users to be able to select customers from California. You might set Display Column to Customer, and Filter to ="State"="CA". See Data Source documentation for more on filter string syntax.
  • Other Properties - See Common Properties

 

Date, Date Time, and Time

  • Default Value - Choose "Current Date/Time" to display the current date and/or time on load. Choose "None" if you don't want this field to display anything on form load.
  • Use Current - Choose "Yes" to populate this field with today's date. Choose "No" otherwise. Note that if this field is set to "Yes" and Default Value is "None" -- then the current date/time will not appear until the user clicks on the field. If Default Value is set to "Current", the current date/time will appear on load.
  • Other Properties - See Common Properties

Drop Down

  • Select Items - The set of items that should appear in the dropdown. Clicking this property brings up a dialog where you can add/delete items. Each item has 4 settings:
    • Default: If you want this item to appear by default when the form loads, check this box. Please only select one default per Drop Down.
    • Value: The value corresponding to this item. This value will appear in reports, and will be passed to any formulas referencing this field.
    • Display Name: The name that will appear in the list.
    • Sort Number: The position in which this item will appear in the drop-down list (1=top, 2=second from top, etc.)
    • There are two additional buttons at the top and bottom of the dialog:
      • Save values as a reusable collection: Click this to save your dropdown items, allowing them to be reused elsewhere in this form, as well as in other forms that you create. This is handy if you have frequently used drop down lists.
      • Use values from an existing collection: Click this to bring up a dropdown of previously saved collections of items. Then select the collection that you wish to use.
  • Allow Other - Choose "Yes" to let the user write in an entry. Choose "No" to limit the set of responses to just the entries on the Select Items list.
  • Other Properties - See Common Properties

 

Image

  • Image Quality: This functionality is available by request to Advanced and Premier users.
    The quality of the image captured in this field. There are two options:
    • Fit-To-Field: Scale the image down to fit in the field and store only this scaled image.
    • Fit-To-Field + Attach Original: Scale the image down to fit in the field and also store the original captured image as an attachment. There are two main benefits to storing the unaltered image: 1) Higher image resolution, and 2) Image metadata (e.g. EXIF or GPS data). Select this option if you require either of these benefits. However, note that the attachment can be only retrieved via the Formz endpoint of the GoFormz API v3 — look for the “retainedImage” element in the JSON response.
  • Other Properties - See Common Properties.

 

Location

  • Default Value - Choose “Auto” to show the user’s location in this field by default, whenever it is available. Choose "None" if you don't want this field to display anything by default.
  • Display - Choose "Map" to display the location as a snapshot of a pin on a map. Choose "Text" to display it as latitude and longitude coordinates.
  • Date Stamp - Choose "Yes" to include the current date and time in the upper left corner of the map snapshot. Choose "No" otherwise. Note that this field only applies when the Display property is set to "Map".
  • Other Properties - See Common Properties

 

Number

  • Keyboard - The keyboard that appears when a user selects this field on a mobile device. Choose "Alpha" for a keyboard with letters, or "Numeric" for a keyboard with numbers. This property has no effect on a desktop device.
  • Mask on complete - Choose "Yes" to hide the text in this field after the user submits the form. This can be handy when dealing with sensitive information like Social Security numbers -- "123-45-6789" would appear as "***********" when masked. Choose "No" if you want the text to be available after the form is completed.
  • Focus Color - The color of the background when the user selects this field. When the field is not selected, the background color is determined by the Background property.
  • Other Properties - See Common Properties

 

Sketch

  • Background Quality: This functionality is available by request to Advanced and Premier users.
    The quality of the background image captured in this field (if one was captured). There are two options:
    • Fit-To-Field: Scale the image down to fit in the field and store only this scaled image.
    • Fit-To-Field + Attach Original: Scale the image down to fit in the field and also store the original captured image as an attachment. There are two main benefits to storing the unaltered image: 1) Higher image resolution, and 2) Image metadata (e.g. EXIF or GPS data). Select this option if you require either of these benefits. Note that the attachment can be only retrieved via the Formz endpoint of the GoFormz API v3 — look for the “retainedBackgroundImage” element in the JSON response.
  • Other Properties - See Common Properties.

 

Signature

  • Clear on form edit - Choose "Yes" if you want to clear the signature as soon as any other form fields are edited. This is useful for approval workflows -- you don't want an approval signature to persist after the form has been edited. Choose "No" otherwise.
  • Other Properties - See Common Properties

 

Table

  • Columns - Column specifications for this table. Clicking this property brings up a dialog where you can add/delete columns. Once a column is added, you must set a Field Type for the column, along with its other properties.
    • Field Types. All field types that are available independently are also available within a Table column, with the exception of Auto Number and Check Box Group. The field types within a table have most of the same properties as their independent counterparts, so they are not documented again here. However, there is a set of properties that are unique to table columns of all types; these are documented in the Table Column Properties subsection below.
    • Additionally, note that a few properties are set on a per row basis, rather than for all rows in the column at once. For instance, if your Table has 4 rows, you will see 4 instances of each of these properties in the column properties list. These properties are:
      • Default Value: Each row in a column can have a different Default Value.
      • Filter: This is for the Database field type. Each row can be filtered to access a different database subset.
  • Rows - The height (in pixels) of each row in the table can be set individually here. These values override the default height set in the Row Height property.
  • Row Count - The number of rows in this table.
  • Row Height - The height of your table rows, in pixels, unless overridden in the Rows property.
  • Padding - The number of pixels that should be left blank along the left and right edges of each table cell. Including some padding can make a table easier to read, because it makes sure the text inputs in different table cells don't run into each other.
  • Other Properties - See Common Properties

 

Table Column Properties

There is a set of properties that is common to all columns in a Table field, but do not appear in any independent fields outside of a Table. These properties are documented here.
 

  • Field Type - The type of field in this column. All field types that are available independently are also available within a Table column, with the exception of Auto Number and Check Box Group.
  • Column Name - The name by which this column will be referenced in reports. The full name of the field in reports will be "<Table Name>/<Column Name>".
  • Locked - Choose “Yes” to lock this column. A user cannot edit a locked column.
  • Hidden - Choose “Yes” to hide this column, so that it is not displayed in the table. This is a lot like hiding a column in Excel -- the column is hidden, but can still be referenced in a calculation.
  • Transparent - Choose “Yes” to make this column transparent. A transparent column takes up space in the table -- but does not display any data, and users cannot input data into it. This can be useful if your table has a column with some pre-filled information, for example. As with Hidden columns, a Transparent column’s values can still be referenced in calculations.
  • Left - The offset of the left side of the column from the leftmost side of the table, in pixels. This is how column widths are determined -- a column’s width is equal to its Left value subtracted from the next column’s Left value.

 

Text Box

  • Multi Line - Choose "Yes" if you want text to wrap when it reaches the end of a line, creating multiple lines of text. Choose "No" if you don't want text to wrap.
  • Mask on complete - Choose "Yes" to hide the text in this field after the user submits the form. This can be handy when dealing with sensitive information like Social Security numbers -- "123-45-6789" would appear as "***********" when masked. Choose "No" if you want the text to be available after the form is completed.
  • Line Height - The amount of vertical space, in pixels, reserved for each line. For multi-line text boxes, the difference between Line Height and Size will give you the amount of space between lines.
  • Keyboard - The keyboard that appears when a user selects this field on a mobile device. Choose "Alpha" for a keyboard with letters, or "Numeric" for a keyboard with numbers. This property has no effect on a desktop device.
  • Other Properties - See Common Properties
f96791875af3f069482b7b5788b9b70b@goformz.desk-mail.com
http://assets1.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete?b_id=13873