How to Reference Pipeline Fields in a Web Form
Learn how to create custom fields in a pipeline and use them to generate corresponding inputs in a web form in octapipe
Support Team
Last Update 4 months ago
Referencing custom pipeline fields in a web form allows you to collect specific information directly within the request workflow. See how to create and associate these fields with your form.
1st Step: Accessing the Pipeline and Opening Field Settings
1st Step: Accessing the Pipeline and Opening Field Settings
- In the left side menu, click “Pipelines” to open the list of pipelines.
- Select the pipeline where you want to add the custom field.
- Click “Module Settings” represented by the Gear Icon in the upper right corner of the screen.
- In the modal window, click the “Fields” tab.
2nd Step: Creating a Custom Field
• Type: select the data type (Text, Number, Date, Dropdown, etc.).
• Layout: choose “Single” or “Double” to define the width.
• Placeholder (optional): example text displayed inside the field.
• Mask (optional): format pattern for automatic input formatting.
• Is the Field Required? (optional): enable if the field must be filled in.
• Is the Field Read-Only? (optional): enable if it should be view-only.
- Click “Add Custom Field”.
- In the creation modal, fill in the following information:
• Type: select the data type (Text, Number, Date, Dropdown, etc.).
• Layout: choose “Single” or “Double” to define the width.
• Placeholder (optional): example text displayed inside the field.
• Mask (optional): format pattern for automatic input formatting.
• Is the Field Required? (optional): enable if the field must be filled in.
• Is the Field Read-Only? (optional): enable if it should be view-only.
3. (Optional) In the “Visibility” tab, configure rules to define when the field will be displayed.
4. Click “Create Field” to finish.
3rd Step: Associating the Custom Field with the Web Form
• Click “Associate Existing Field”.
4. Activate the fields you want to use in the form.
- In the side menu, go to Settings > Web Forms.
- Locate the desired form and click it.
- In the modal window:
• Click “Associate Existing Field”.
4. Activate the fields you want to use in the form.
5. Click Save Memberships, and when you open the form, the existing activated fields will be available to fill in.
4th Step: Publishing and Testing the Form
• Placeholder displayed
• Required validation applied
- In the Web Forms list, click the form and then click “Open” to preview it in a new tab.
- Copy the URL and open it in incognito mode for testing.
3. Verify that the custom field appears and works as configured:
• Placeholder displayed
• Required validation applied
4. Fill out and submit the form.
5. In octapipe, confirm that the card created in the pipeline contains the value entered in the custom field.
Best Practices:
• Standardize field names to simplify maintenance.
• Test in incognito mode to validate field visibility.
• Review visibility rules to ensure they reflect the correct scenario.
• Document each custom field with its purpose and rules.
• Avoid duplication by checking if the field already exists before creating a new one.
• Update related workflows when modifying or removing fields.
Conclusion:
You have learned how to create a custom field in a pipeline and reference it in a web form, ensuring that information is captured and integrated into the workflow. If you have any questions, contact our support team.
• Standardize field names to simplify maintenance.
• Test in incognito mode to validate field visibility.
• Review visibility rules to ensure they reflect the correct scenario.
• Document each custom field with its purpose and rules.
• Avoid duplication by checking if the field already exists before creating a new one.
• Update related workflows when modifying or removing fields.
Conclusion:
You have learned how to create a custom field in a pipeline and reference it in a web form, ensuring that information is captured and integrated into the workflow. If you have any questions, contact our support team.