FORM Butler CHECKBOX form-field

FORM Butler can convert a merge field into an editable checkbox. Use a CHECKBOX form field for values that have two states, such as True/False or Yes/No. 

In this example, the checkbox is used within an Opportunity Products related list. Each product appears as its own record, and the Has Discount checkbox indicates whether that specific product receives a discount.

Note: To learn more about configuring and updating related-list data in FORM Butler, see the Related Lists guide.

Step 01: Prepare the Word Document #

1. Open the Word document you want to use with FORM Butler.
2. Add the merge field that will become an editable checkbox if it is not already present in the document. The same merge-field syntax used with PDF Butler can be used when creating the FORM Butler document.

In this example, the Has Discount field is used from the Opportunity Products data source.

Note: If your FORM Butler Doc Config, document upload, and required DataSources are not already set up, complete the FORM Butler Document and DataSource Setup guide before continuing. 

If the configuration already exists, review the current DataSources and add any additional DataSource required for the field you are configuring. After adding a new DataSource, click Save to Server before continuing.

Step 02: Configure the CHECKBOX Form Field #

1. On the left-hand side, click Add Config Type.

1. Enter a name for the field you want to configure. Use the same name as the corresponding merge field in the Word document. Then change the configuration type from Single to Single for Form Fields.

1. In Datasource, select the data source that contains the field you want to use.
2. In DataSourceField, select the specific Salesforce field that should supply the value.
3. In MergeField, enter the merge field from your Word document that should be linked to that Salesforce field.

Note: A related list is not required to use a CHECKBOX form field. In this example, the checkbox field is added under the Opportunity Products child DataSource because the Has Discount value belongs to each individual product record. See the Related Lists guide for more information.

Step 03: Configure the CHECKBOX Form Field Settings #

You can now use the Form Field Data options to configure the field as a checkbox.

1. Leave Lock when data unchecked if users should be able to edit the value after the document is generated.
2. Set the Control type to Checkbox.

1. Set the Checked Value and Unchecked Value to match the values used by the Salesforce field. In this example, Checked Value is set to True and Unchecked Value is set to False.
2. Click OK to save the form field configuration.

Step 04: Save and Test the CHECKBOX Form Field #

1. Click Save to Server. Confirm that the configuration validates successfully.
2. Generate a preview document to verify that the checkboxes appear correctly. If needed, adjust the table formatting in the Word document so the checkboxes are aligned and sized appropriately.