This article will summarize how to use the Document Component in Template Builder.
This component allows users to upload and attach files to a form.
Where to Find It
In your Corfix Form Builder, click on a Document Component to access the configuration panel. You’ll see four tabs:
-
Display
-
Data
-
Validation
-
Conditional
1. Display Tab
The Display tab controls how the Documents Component appears to the user.
-
Label:
-
This is the visible title for your document upload field that users will see. It is a required field.
-
Example: "Upload Files", "Attach Supporting Documents", "Photos".
-
-
Label Position:
-
Determines where the label is displayed relative to the upload area (e.g., Top, Left, Right, Bottom).
-
Default: Top.
-
-
Description:
-
Provides additional explanatory text for the component, typically displayed below the label.
-
Example: "Please upload all relevant permits and licenses."
-
-
Tooltip:
-
Text that appears when the user hovers their mouse over the component. 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 for uploaded files).
-
2. Data Tab
The Data tab manages how uploaded files are handled.
-
Multiple Values:
-
If checked, allows the user to upload more than one file to this component. This is useful for attaching multiple photos or documents.
-
3. Validation Tab
The Validation tab defines rules for the document upload field.
-
Required:
-
If checked, the user must upload at least one document before submitting the form.
-
4. Conditional Tab
The Conditional tab allows you to set up rules for when this Documents 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 "Upload Incident Photos" component only displays when an "Is there an incident?" checkbox is checked.
-
Preview Panel
The Preview panel on the right side of the dialog box shows you how the "Upload" field will visually appear on your form. It displays the drag-and-drop area and the "Browse" link, giving you a real-time sense of the user's interaction.
Actions at the bottom of the dialog:
-
Save: Saves all changes made to the Documents Component's settings.
-
Cancel: Discards any unsaved changes and closes the dialog.
-
Remove: Deletes the Documents Component from the form.
Best Practices for Documents Component:
-
Clear Label & Description: Use a straightforward label (e.g., "Upload Attachments") and a description to specify what documents are needed and why.
-
Allow Multiple Files if Applicable: If users might need to upload more than one file, always check "Multiple Values" to avoid forcing them to use multiple upload fields.
-
Make it Required When Necessary: If supporting documents are absolutely crucial for a record, set the component as "Required."
-
Use Conditional Display: Only show the document upload field when it's logically required based on other inputs in the form (e.g., show "Upload Permit" only if a specific type of work is selected).