Create custom forms

1. From the Administration menu, open the form layout editor with which you want to work:

   • Agency profile > APO form layout editor

   • Agency profile > Custom fields form layout editor

   • Application > Custom fields form layout editor

   • Assets > Form layout editor

   • Structures and establishments > Form layout editor

   • Workflow and activity > TSI form layout editor

2. Identify which users you are granting access to your new form. Select the tab that corresponds with the access-level you are creating for the form: Agency, Module, Group, or User tab.

   Tip: Best practice is to design a form on the Agency tab and then restrict access based on any other user access: Module, User Group, and User.

   If you choose the User tab, you can limit access to just one user, which eliminates the possibility for other groups to access the form.

3. Choose from the Portlet, Agency, Module, Group, and User menus to specify where you want the form to display.

   Example: if you selected the Module tab, choose the module from the menu.

   With each selection, Form Designer refreshes and displays available options. Also, depending on which tab you selected, the fields vary.

   Example: If you selected the Agency tab, you only need to choose an item from the Agency and Portlet menus.

   

4. Select New.

5. Complete these fields.

   Field	Description
   Filter name	Enter a descriptive name for the filter, so that you can identify it if you need to locate it later. After you save a form, the Filter Name displays in the Name column.
   Description	Enter a descriptive name to help identify the purpose of the form.
   Source view	The Source View Name is read-only and you cannot modify it.

6. Arrange the fields on the form in the same order you want them to appear for users when they complete the form.

7. Rename any of the field labels, according to your agency's business objectives, as follows:

   1. Double-click a field name to access the properties page for the field.

   2. Modify the text that displays in the Label field.

      Note: You cannot change the database label (DB label).

   3. Select OK.

8. Select Save when finished.

When you create or edit a form in the Form Designer, you can use the different controls to show, hide, move, make read-only, and alter the available fields according to your business objectives. This section explains the controls you can use to customize forms in the Form Designer.

To customize a form

1. Open the form designer by either creating or editing a form layout.

2. Select Available fields.

   

3. To display or hide fields:

   1. To display fields, from the list of Available fields, double-click each field you want to add to the form, and then select OK.

      Notes: 

      • The Available fields list also provides the address template, parcel template, or owner template options. If you select any of those options, Civic Platform removes the option from the list and displays all active attributes of the selected template as additional fields on the form. The APO form layout editor defines the layout and display of each field in a template.

      • On the record search form, only record-searchable attributes display as available fields. You can specify which attributes are record-searchable when creating or editing a template.

   2. To hide a field, select the field on the layout page and select Delete.

4. To change the location of a field, drag the field to its new location on the layout page.

   Note: If your field arrangement causes any fields to overlap, the overlapping fields display with red borders, enabling you to easily identify them.

   

   If you have any overlapping fields on your form when you attempt to save it, Civic Platform returns an error. To save the form, you must locate the overlapping fields (see the above example) and separate them.

5. To change a field name (Label) or any of the field’s properties:

   1. Double-click the field you want to change.

      

   2. Modify the field properties as necessary.

      Note: You cannot modify the database label (DB Label).

      Field	Description
      Access key	Enter the shortcut key that users can press together with the ALT key to position the cursor in this field. Example: if you want users to be able to access the Asset ID field by pressing ALT+I, enter the letter I in this field.
      By range	When applicable, allows the user to search this field based on a range of values. The default is Yes. If you select No, the field allows for searching on a single field, not on a range. (Optional)
      DB label	This field is display-only. It shows the actual name of the field as it displays in your database.
      Default value	Set a default value for the field on a search form portlet. The default value you set appears in the field whenever users navigate to the search form portlet. If you do not supply a value, the field can either be blank (null) or it can display the value that the user entered during his or her last search, depending on the field type. If you want this type of field to always appear as blank (null) in a new search, select Set null in the Default value property setting for the desired field. This property is only available for fields on search form portlets. The default value varies depending on the By range field property. When you set the By range field property to Yes, Civic Platform displays the Default from and Default to properties instead of the Default value property. When you set it to No, Civic Platform displays the Default value property only. For more information on setting a default value for a search field, see Set default values for fields in a search form.
      Label	Enter a label for the field as you want it to display on the form.
      Mask	Choose a mask type from the list of masks to apply to the field.
      Read only	The default is No. Use the drop-down list and choose Yes to make the field read-only when users access the form. Whichever level you design the form for, the read-only characteristic then affects all of its sub-levels. Example: If you design the form for the agency level, the read-only attribute applies to the sub-levels of module, user group, and individual users. However, if you design the form at the module level, then the read-only characteristic applies to the sub-levels of user group and users.
      Required	Specify if you want to make the field to be required. When completing a form, users must enter information in a required field. Required fields display in the Form Layout Editor as well on the actual form with a red asterisk.
      Tab index	Enter a number to determine the position of this field in a tab sequence. When a user is working with a form, they can press the TAB key to move from field to field. The index number determines the order in which this field becomes active in relation to other fields on the same form.

   3. Select OK.

6. To add a URL link to the form:

   1. Select Text, which adds a dynamic label to the form.

   2. Double-click the dynamic label.

   3. In the Label field, enter the text name of the link.

   4. In the URL field, enter the URL for the website that opens when a user selects the link.

      

7. Select Preview to review the layout of your form.

   

8. Close the preview page when finished.

The default values you set appear in the field whenever users open the search form.

You can set default values in the Form Designer, in the Edit view feature, or any fields that allow you to enter a value in the Default value property. If you do not supply a value, the field can either be blank (null) or it can display the value predefined by the search logic. To configure this type of field to always appear as blank (null) in a new search, select Set null in the Default value property setting for the desired field.

You can set a default value for a field of the text, numeric, date, radio button, or check box type. You can also set a default option for a drop-down list field. However, the Default value property setting is not available for data picker fields such as Record type, Department, and User, because the options for those fields vary by agency. For radio button fields, check box fields, and drop-down list fields, the default value must be a valid database value instead of a label text.

Some numeric fields support a range of values as the search criteria. You can allow a range of values for a numeric field by setting the By range property for the desired field to Yes. This way, you can specify a default minimum value, a maximum value, or both that you want to apply to the range of acceptable values.

To set a default value for a search field

• From the Administration menu, open the form layout editor with which you want to work.

  • Agency profile > APO form layout editor

  • Agency profile > Custom fields form layout editor

  • Application > Custom fields form layout editor

  • Assets > Form layout editor

  • Structures and establishments > Form layout editor

  • Workflow and activity > TSI form layout editor

1. In the Portlet field, select the search form you want to customize.

2. Double-click field you want to change.

   • Date fields

     

     Note: The Set null default value setting of the date field on a search form overrides the FIND APP DATE RANGE standard choice setting. For example, if Set null is enabled for the Opened date field on the Search Form Designer, and the FIND APP DATE RANGE standard choice value is set to 120 days, the Opened date field on the form will be set to null.

   • Fields of other types that do not support searches based on a range of values

     

   • Fields of other types that support searches based on a range of values

     

3. Enter a default value for the field.

4. Select OK.

   Field type	Example default value	Notes
   Check box	Y	Enter the key value of the check box status as stored in your database.
   Date	Today + 90 Days	Specify a date range in the Today + n Days field. If you enter a positive integer, the default search criteria is within X days after the current date. If you enter a negative integer, the default search criteria is within X days before the current date.
   Drop-down list	North	Enter the key value of a valid option as stored in your database. Tip: You can identify the correct key value by viewing the source code for the search form in your browser and locate the content of the option value.
   Numeric	8887222352	If you set the By range property for the field to Yes, enter a valid number in the Default value property setting. If you set it to No, enter a valid number in the Default from property setting, the Default to property setting, or both.
   Radio button	Y	Enter the key value of a valid option that you have stored and identified in your database. Tip: You can identify the correct key value by viewing the source code for the search form in your browser and locate the content of the option value.
   Text	New	Enter valid alphanumeric characters in the Default value property setting.

Civic Platform provides the Edit view feature to customize how information displays in a form.

To edit the view of a form portlet

1. Locate the form portlet you want to customize and select Menu.

2. Choose the Edit view option from the drop-down menu.

   

3. Complete these fields:

   Field	Description
   Filter name	Enter a descriptive name for the form portlet. This filter name is the name you can use to locate the form using the Form Designer.
   Source view name	This field is not editable.
   Description	Enter a description to help identify the purpose of the form.
   Align command	Use this drop-down list after you have added fields to the form. Select one or more fields and choose the desired option from the drop-down list.
   Effect scope	Specify the availability of the customized filter for the desired module, user group, or user with the corresponding drop-down list.

4. To show an available field:

   1. Select Available fields.

      

   2. Select a field from the list.

      Note: To select multiple fields, double-click each field.

   3. Select OK.

      Note: The Available fields list also provides the address template, parcel template, or owner template options. If you select any of those options, Civic Platform removes the option from the list and displays all active attributes of the selected template as additional fields on the form. The APO form layout editor defines the layout and display of each field in a template.

      On the record search form, only record-searchable attributes display as available fields. You can specify which attributes are record-searchable when creating or editing a template.

5. To hide a selected field, select the field on the form and select Delete.

6. To change the position of a field, drag the field to the new position on the form.

7. To change a field's name or its properties:

   1. Double-click the field you want to change.

      Note: Depending on the type of form you are editing, your options vary.

      

   2. Complete the field properties as necessary.

      Field	Description
      Access key	Enter the shortcut key that users can press together with the ALT key to position the cursor in this field. Example: if you want users to be able to access the Asset ID field by pressing ALT+I, enter the letter I in this field.
      By range	When applicable, allows the user to search this field based on a range of values. The default is Yes. If you select No, the field allows for searching on a single field, not on a range. (Optional)
      DB label	This field is display-only. It shows the actual name of the field as it displays in your database.
      Default value	Set a default value for the field on a search form portlet. The default value you set appears in the field whenever users navigate to the search form portlet. If you do not supply a value, the field can either be blank (null) or it can display the value that the user entered during his or her last search, depending on the field type. If you want this type of field to always appear as blank (null) in a new search, select Set null in the Default value property setting for the desired field. This property is only available for fields on search form portlets. The default value varies depending on the By range field property. When you set the By range field property to Yes, Civic Platform displays the Default from and Default to properties instead of the Default value property. When you set it to No, Civic Platform displays the Default value property only. For more information on setting a default value for a search field, see Set default values for fields in a search form.
      Label	Enter a label for the field as you want it to display on the form.
      Mask	Choose a mask type from the list of masks to apply to the field.
      Read only	The default is No. Use the drop-down list and choose Yes to make the field read-only when users access the form. Whichever level you design the form for, the read-only characteristic then affects all of its sub-levels. Example: If you design the form for the agency level, the read-only attribute applies to the sub-levels of module, user group, and individual users. However, if you design the form at the module level, then the read-only characteristic applies to the sub-levels of user group and users.
      Required	Specify if you want to make the field to be required. When completing a form, users must enter information in a required field. Required fields display in the Form Layout Editor as well on the actual form with a red asterisk.
      Tab index	Enter a number to determine the position of this field in a tab sequence. When a user is working with a form, they can press the TAB key to move from field to field. The index number determines the order in which this field becomes active in relation to other fields on the same form.

   3. Select OK.

8. When you are satisfied with the appearance of your form select Submit.