Forms

Expand

Overview

This section provides a comprehensive overview of Forms section. Forms play a pivotal role in organizing and processing data for investigative case management. They are customizable and enable users to capture necessary information during case management.

Form Types:

Simple Form - A form with a single entity and its related fields.

Example: Investigation Create form.

Composite Form - A form with multiple entities.

Example: Adding address entity to an Investigation form.

Accessing the Interface

To access the Forms page:

Log into the Hubstream instance.

Click the gear icon in the top-right corner of the screen.

Click Admin.

Select the Forms option from the left navigation panel.

Sections of the Forms list Page

Header – Displays the page label (Forms) and plus (+) icon to create a new list.
Left Pane - Contains a local search widget to filter the list based on predefined filters.
Right Pane – Displays the list of existing forms with their corresponding columns.
Footer – Displays the total row count, a pagination dropdown and navigation buttons.

List page

Create a New Form

To create a new form:

Navigate to Forms list page.

Click the plus (+) icon on the right.

Enter the Form Name.

Select the Entity Name from the drop-down menu.

Example: Investigation, Media, Note etc.

Select the First Field from the drop-down menu.

Example: Name, Given Name, Last Name etc.

Click Save and close.

You will be redirected to the form fields list page of the newly created form, where you can add additional fields.

Sections of Form fields list Page

To access the Form fields list page:

Navigate to Forms list page.

Click on the desired form’s hyperlink button.

List page

Header – Displays the form name with the following icons:

Add a Form Field - Click the icon to add a field to an existing form.
Reorder Sequence - Sort the field sequence by clicking Reorder Sequence icon from the Forms list Page header.
Validation Errors - Click the Validation Errors icon in the header to view error messages for form fields.

Left Pane - Contains a local search widget to filter fields by Category and Entity Name.
Right Pane – Displays the list of existing fields with their details.
Footer – Displays the total row count, a pagination dropdown and navigation buttons.

Add a Form Field

To add a new field to an existing form:

Navigate to the Forms list page.

Click the desired form’s hyperlink button.

Click plus (+) icon.

Add Form field popup form will be displayed.

Choose Entity from the drop-down menu.

Select a field you want to add.

Add a Label.

Select a Parent Entity to link (if applicable).

Add a Link Name if required.

add form field

Advanced Options

Basic field Info

Entity – Select an entity from the list.
Field - Add the required field to the form.
Label – Enter a field label.

Field Properties

You can control the basic properties of an element as below:

Default Value – Set a default value to be displayed for a field.
View only - Make the field non-editable.
Mandatory – Mark the field as required.
Hidden – Hide the field in a form.
Use Default Settings – Check this box to use the system default settings.
Allow Add Only from Search – Restrict the user to add values from search results for entity fields.

Layout Properties

Configure the field’s arrangement in the form, such as width, section and sequence.

Parent Details

Link the field to a parent entity and provide a link Name.

Visibility Condition

Set conditions to control a specific field. Visibility conditions are of the following types:

Simple Condition

Enter the Entity and Field Label.

Set Condition as Equals or Not Equals.

Enter the Value for the condition.

Complex Condition

Configure expressions using AND/OR operations.

Example

In this example, we demonstrate how to setup visibility condition for a form field.

Scenario:

Display the Case Name field when Status is set to Open.

Description:

The user needs to get a field with case name if the status is open. The admin’s task is to create a visibility condition to display the form field.

Prerequisites:

Ensure you have admin access to the instance.

Form with corresponding fields is available.

Steps:

Navigate to Forms list page.

Click the desired form’s hyperlink button.

Click plus (+) icon.

Add form field popup form will appear.

Configure the field details:

Entity - Select Case.
Field - Status.
Label - Enter Case Name.
Parent Entity - Complaint.
Field - Select Case Name.

Click Advanced Options hyperlink. Navigate to Visibility conditions and select Simple Condition.

Condition - Equals.
Value - Open.

Click Save.

Expected Outcomes:

After completing the steps above,

Create a New Case.

In the New Case form, select Status as Open.

The Case Name field will appear.

Edit a Form field

accordion

Navigate to the forms list page.

Click the desired form’s hyperlink button.

Select any Item from the list displayed. Actions contextual menu will appear on the right.

Click Edit option.

Modify the necessary details and click Save.

Click Delete to remove the selected field.

Edit an Entity specific Form field

Select the Entity Types option from the left navigation panel of the admin menu.

Click Settings field hyperlink button of the desired entity.

All Entity Settings list page will be displayed.

Select any Item from the list displayed. Actions contextual menu will appear on the right.

Click Edit option.

Modify the current value to the newly created form if required.

Click Save.

Download a Form

accordion

Navigate to the forms list page.

Select the desired field.

Click Download from the Actions contextual menu displayed in the right. The selected form will be downloaded as a ZIP file.

Need Help?For assistance, please visit our support center.