This article will summarize how to use the Project Component in Template Builder.
This article summarizes the various settings available for a "Project Component" in Corfix. This component is specifically designed to select one or more projects from your pre-existing list of projects in Corfix.
Where to Find It
In your Corfix Form Builder, click on a Project Component to access the configuration panel. You’ll see four tabs:
-
Display
-
Data
-
Validation
-
Conditional
1. Display Tab
The Display tab controls how the Project Component appears to the user.
-
Label:
-
This is the visible title for your project selection field that users will see. It is a required field.
-
Example: "Associated Project", "Project Name", "Contract Project".
-
-
Label Position:
-
Determines where the label is displayed relative to the project selection input (e.g., Top, Left, Right, Bottom).
-
Default: Top.
-
-
Widget Type:
-
Specifies the type of user interface element used for selecting projects. "ChoicesJS" suggests a more advanced dropdown with search and possibly multi-select capabilities.
-
-
Placeholder:
-
Text that appears inside the input field before the user makes a selection. It's a hint to the user about what to do.
-
Example: "Select a project...", "Search for a project".
-
-
Description:
-
Provides additional explanatory text for the field, typically displayed below the label.
-
Example: "Choose the project this record belongs to."
-
-
Tooltip:
-
Text that appears when the user hovers their mouse over the field. Useful for providing quick help or context.
-
-
Custom CSS Class:
-
Allows advanced users to apply custom styling to the component using CSS classes.
-
-
Hide Label:
-
If checked, the label for the component will not be displayed.
-
-
Modal Edit:
-
(Details not fully visible in screenshot, but typically relates to editing in a pop-up modal window).
-
-
Reportable:
-
If checked, the data from this field (the selected project(s)) will be included in reports.
-
2. Data Tab
The Data tab manages how project data is handled and stored.
-
Multiple Values:
-
If checked, allows the user to select more than one project for this field. This is useful if a record or item can relate to multiple projects.
-
-
Default Value:
-
Allows you to pre-select a specific project or projects when the form loads. Users can change this selection.
-
3. Validation Tab
The Validation tab defines rules for the project selection field.
-
Required:
-
If checked, the user must select at least one project before submitting the form.
-
4. Conditional Tab
The Conditional tab allows you to set up rules for when this Project Component should be displayed or hidden based on the values of other components in the form.
-
Simple:
-
This is typically a toggle or a dropdown to select between simple and advanced conditional logic.
-
-
This component should Display:
-
Choose whether the component should "Show" or "Hide" (implied options) based on the condition.
-
-
When the form component:
-
Select another component in your form whose value will trigger the condition.
-
-
Has the value:
-
Specify the exact value that the selected form component must have for the condition to be met.
Example: You could set up a rule so that the "Project Component" only displays when a "Related to Project?" checkbox is checked.
-
Preview Window
The Preview Panel on the right side of the dialog box shows you how the "Project" selection field will visually appear on your form. It typically looks like a dropdown or search box, updating instantly as you change display settings.
Actions at the bottom of the dialog:
-
Save: Saves all changes made to the Project Component's settings.
-
Cancel: Discards any unsaved changes and closes the dialog.
-
Remove: Deletes the Project Component from the form.
Best Practices for Project Component:
-
Clear Label: Use a specific label (e.g., "Related Project," "Project ID") so users know exactly which project they're selecting.
-
Allow Multiple if Applicable: If a record can genuinely link to several projects, enable "Multiple Values" for flexibility.
-
Make it Required for Core Records: For records that must be tied to a project, check the "Required" box in the Validation tab.
-
Use Placeholders: Provide a helpful placeholder like "Select a project..." to guide users, especially if they need to search a long list.
-
Conditional Display: Show the project field only when it's relevant to previous inputs, making the form more dynamic and user-friendly.