Learn how to create a custom form and use the Form Builder.
User Permissions Needed: Account Administrator
The Form Builder
The Form Builder is where you can manage and configure forms and their details.
You can access the Form Builder from multiple locations within Kantata OX:
- After creating a Form, the Form Builder opens.
- Go to Projects > Forms > [Form Name]. On the Form page, select Edit Form.
- Go to Settings > Forms. The Forms page opens. Select the [Form Name] to open the Form Builder.
- In a project workspace, select an editable tab. Within the editable tab, select Edit Form to open the Form Builder.
The Form Builder is divided into two sections, with the Details, Fields, and Rules tabs on the left and the Form Builder Canvas on the right:
- The Details tab provides general information about your form. You can edit the Title, Description, and Default Status of your form from this tab. Changes made to the Title and Description appear on the canvas immediately.
- The Fields tab lists all the fields you can add and configure to the form. If you're on the Enterprise or Premier plan, custom fields are also included.
- The Rules tab allows you to edit or remove rules for the form.
- The Form Builder Canvas is an editable area where you can add, configure, and rearrange fields.
See the Form Builder Keyboard Shortcuts section for details on more Form Builder tools.
How to Create a Form
- In the left navigation, hover over Settings, then select Forms.
- Click Add Form.
- Select the Form Location:
- Project Form
- Enter the form Title.
This title is what appears under the Forms section in the left navigation after publication. If the form is added to a project as a project tab, the form title will also appear as a tab name in the project.Note: The form title has a 255 character limit. - Select Configure Form. The Form Builder opens.
- or -
Select Save & Add Another to save the current form and create any other desired additional forms. Once you have added all of your forms, select Configure Form within the page of your final form. The Form Builder opens.
How to Add or Edit Form Details
In the Details tab, you can edit the Title, Description, and Default Status of the form.
- Within the Form Builder, go to the Details tab.
-
The Details tab includes the following information:
- Status—Whether the form is published or a draft. Published forms appear in the Forms section in the Project > Forms section in the left navigation.
- Location—The area within the Kantata OX user interface where the form is displayed.
- Title
- Description—A field that appears directly underneath the Form title. You can add an external reference to this description by including a hyperlink.
- Set as Default—When you set a project form as the default form, the form will open when you click the Add New Project List. The form replaces the default Kantata OX form for new projects. This allows you to tailor the project creation process to match your business workflows. project button in the left navigation or the Add Project button in the ”)
- Enter or edit information within the fields as desired.
- Once you finish adding or editing fields, select one of the save options at the top:
- Save Draft—Saves changes and saves the form as a draft. The form will not appear in the left navigation.
- Publish—Saves changes and activates the form. The form will appear in the Forms section in the Project > Forms section in the left navigation.
How to Arrange or Remove Fields from the Fields Tab
- Within Kantata OX, go to the Form Builder.
- Within the Form Builder Canvas, located on the right side of the page, you can perform the following actions:
- To move a field, hover over the field then use the move icon that appears to drag the field to another area on the canvas.
- To remove a field from the form, click on the field in the canvas, then click Delete field in the configuration modal.
- To add a field to a form, drag a field from the Fields tab and drop it in a highlighted area in the canvas.
- Once a field is on the form, you can click the field to configure it.
- or -
If you want to save your canvas progress before configuring fields, select one of the save options at the top:
- Save Draft—Saves changes and saves the form as a draft. The form will not appear in the left navigation.
- Publish—Saves changes and activates the form. The form will appear in the Forms section in the Project > Forms section in the left navigation.
How to Configure Fields in the Form Builder Canvas
- To configure a field after adding it, click on the field in the Form Builder Canvas.
- You can set the following options:
- Label—The label that will appear on the page when the form is used.
- Placeholder—You can use the placeholder to provide a brief description or hint for the field.
- Default Value—The value that pre-populates in the field when the form is opened. If the field has a commonly used value, enter it as the default value.
- Tooltip—Use the tooltip to provide detailed guidance on how to complete the field. The tooltip appears as a question mark icon beside the field label. Hovering over the tooltip displays the tooltip text.
- Required—If checked, the user must enter a value in the field in order to submit the form. Use this setting to ensure people fill out all fields that are essential for your organization's processes.
- Read Only—If checked, the field will appear on the form but users won't be able to enter or select a value. This setting can be used in combination with a default value: If there’s information that should always be submitted and should not be changed by users, you can add a default value and mark the field as read-only.
- Hidden—If checked, the field will be hidden on the form. This setting can be used in combination with a default value and the read-only option: If there’s information that should always be submitted and not changed by users, you can hide the field to reduce the number of fields that appear on the form.
- Add a rule—You can configure a rule for the field to change the display and behavior of other fields based on the values entered or selected in the field.
- Click the Close icon when you are finished configuring a rule. ”)
- Once you finish adding and configuring fields, select one of the save options at the top:
- Save Draft—Saves changes and saves the form as a draft. The form will not appear in the left navigation.
- Publish—Saves changes and activates the form. The form will appear in the Forms section in the Project > Forms section in the left navigation.
Field Availability
The following table lists all of the fields on the default Create a New Project page and maps them to their respective field in forms. Some fields are available only on the default Create a New Project page and, inversely, some fields are available only in forms.
Section on the Default Create Project Page | Default Field Name | Forms Field Name |
---|---|---|
General
|
Project Name | Project Name |
Start project in Estimate stage | Project Stage | |
I am the Provider I am the Client |
Creator Role * | |
Provider Name | Provider Name | |
Client Name | Client Name | |
Start Date | Start Date | |
Due Date | Due Date | |
Description | Description | |
Project Color | Project Color | |
Task Status Set | Not available in forms | |
Include archived tasks in percentage complete | Include Archived Tasks In Percentage Complete | |
Include non-billable time on invoices | Include non-billable time on invoices | |
Privacy
|
Who can participate | Who can participate |
Who Can See Communications | Who Can See Communications | |
Organizations | Organizations | Organizations * |
Template
|
Select a Project Template | Select a Project Template |
Start Date | Start Date | |
Template resource to team member mapping table with the following columns: Template Resource, Map To, Project Role | Assignment Mappings | |
Include weekends as workdays | Include Weekends as Workdays | |
Convert checklist items to To Dos | Replace checklists with To Dos | |
Resource Plan | Add Unnamed Resource | Not available in forms |
Provider Team
|
Provider Team | Provider Team * |
Lead | Provider Lead * | |
Financials
|
Budget | Budget * |
Activate Expense Budgets | Not available in forms | |
Include Billable Expenses in Actual Fees Calculation Include Additional Line Items in Actual Fees Calculation |
Include Expenses Note: The field in forms combines the functionality of the two fields on the default create page. |
|
Target Margin | Target Margin | |
Currency | Currency * | |
Rate Card | Rate Card | |
Revenue Recognition Method | Revenue Recognition Method | |
Task Billing Mode | Task Billing Mode | |
Task Default | Task Default | |
Schedule and budget changes must be approved | Schedule and budget changes must be approved | |
Allow tracking time | Not available in forms | |
Require notes on time entries | Not available in forms | |
Time entries must be approved before invoicing | Time entries must be approved before invoicing * | |
Expenses must be approved before invoicing | Expenses must be approved before invoicing * | |
Edit invoicing preferences Invoicing Preferences |
Invoice Preference | |
Approvals | Project Approver(s) | Approvers |
Groups
|
Select Primary Group | Primary Workspace Group |
Select Groups | Select Groups | |
Additional Tabs
|
Forms | Project Tabs |
Dynamic Dashboards | Not available in forms | |
Custom Fields | Custom Fields | Custom Fields |
N/A | Not available in the default project create project page | External Reference |
N/A | Not available in the default project create project page | Project Tabs |
N/A | Not available in the default project create project page | File Uploader * |
* Only available when the form is used to create a new project.
How to Configure Field Rules
In the Rules tab, you can add, edit, and delete field rules that change the display and behavior of fields based on the values entered in specific fields. See the Custom Forms: Field Rules article for more information.
Form Builder Keyboard Shortcuts
Form Builder Keyboard Shortcuts
The following keyboard shortcuts are available when in the Form Builder.
Navigating the Canvas
• Tab to select a field, select its move
icon, or navigate through its configuration options.• Space to close configuration options, when the close icon is selected.
• Tab Tab Tab Space to navigate across fields.
The first Tab selects a field, the second Tab selects the move icon, the third Tab opens configuration options, and Space closes configuration options.
Editing a Field
When a field is selected:
• Enter / Return to open the field configuration options.
• Backspace / Delete to remove the field from the canvas.
Moving a Field
Once a field's move
icon is selected:• Space to enter move mode. Highlighted areas will appear in the canvas where you can place the field. While in move mode, the field you're moving will not be visible in the canvas.
While in move mode:
• ↑ ↓ ← → to navigate through the locations you can move the field to.
• Enter / Return to place the field in a highlighted area.
• Esc to remove the field and exit move mode.
Comments
0 comments
Please sign in to leave a comment.