Building and Editing OneTrust Embedded Web Form Collection Points

Once you have created a OneTrust Embedded Web Form, you can begin building out the content that you want to include in it. You can configure which purposes and data elements to include on your web form, edit the labels and response types as well as indicate whether the field is required, and edit the OneTrust Embedded Web Form details, as needed.

To access the OneTrust Embedded Web Form Builder

  1. On the Universal Consent & Preference Management menu, select Interfaces > Collection Points.

    The Collection Points screen appears.

  2. Click the link in the Name column for the OneTrust Embedded Web Form that you want to build.

    The Builder tab on the Collection Point Details screen appears.


    Builder tab of the Collection Point Details screen for a OneTrust Embedded Web Form.
  3. Complete the following procedures, as needed, to build your OneTrust Embedded Web Form.

To add purposes to your OneTrust Embedded Web Form

Note:

If a Purpose has Purpose Preferences assigned to it, then these will be included as separate form fields that can be edited independently. The Purpose associated with Purpose Preferences will need to be selected for the form to be submitted properly.

  1. Access the Builder tab for the OneTrust Embedded Web Form Collection Point that you want to build.
  2. In the Content Fields section, click the Add button.

    The Add Form Field modal appears.


    Example of purposes added to the OneTrust Embedded Web Form
  3. Create as many Purposes as needed clicking the Create New button.
    Note:

    Once the OneTrust Embedded Web Form is published, Purposes created from the Add Form Field modal will be published as well. For more information, see Publishing OneTrust Embedded Web Form Collection Points.

  4. Complete the fields, as necessary.
    Field
    Description
    Field Type

    Select Purposes.

    Select Purpose

    Select the purpose that you want to include in the OneTrust Embedded Web Form.

  5. Click the Add button.

    The purpose appears in the Content Fields section.

    Click the link in the Name field to navigate to the Purpose Details screen.

  6. In the Content Fields section, click the Edit icon Edit icon in the Content Fields section.

    The Edit Field section appears.


    Edit Field configuration example
  7. Verify the field configuration and make any changes, as necessary.
    Field
    Description
    Form Field Label

    Enter a label to be used for the purpose within the OneTrust Embedded Web Form.

    Response Type

    • Single Checkbox - The web form includes a blank check box that a data subject can select to indicate consent for those selections before submitting the form.

    • Form Submission Only - The web form includes a standard HTML Submit button that a data subject can click to give consent.

    Required (Optional)

    Select this check box to require that the data subject consent to the purpose when interacting with the OneTrust Embedded Web Form.

    Lock field if pre-filled

    Select this checkbox to make the field read-only if the field is pre-filled with a value.

    For more information, see Pre-filling and Hiding Fields in OneTrust Hosted and Embedded Web Form Collection Points.

    Show description

    Enable this setting to inform about how data will be processed if consent is given to the Purpose.

    Hide Form Field

    Enable this setting to hide the purpose on the OneTrust Hosted Web Form. When a data subject submits the form, they will automatically consent to the purpose.

    If this setting is enabled, a default value must be selected for the purpose. The following default values are available:

    • Checked

    • Unchecked

    In addition, any Purpose Preferences that are attached to the Purpose can be hidden as well.

    For more information, see Pre-filling and Hiding Fields in OneTrust Hosted and Embedded Web Form Collection Points.

    Enable Geolocation

    Enable this setting to capture a data subject's geolocation if they provide consent to this specific Purpose.

  8. Click Save and Close.
    Note:

    You can identify when a Purpose is capturing geolocation. The Geolocation icon Geolocation icon indicating geolocation capture will appear on the Builder tab if the geolocation setting is enabled for that Purpose.

    For more information, see Configuring Geolocation Capture.


    Builder tab showing geolocation configuration

To add cookie categories to your OneTrust Embedded Web Form

  1. Access the Builder tab for the OneTrust Embedded Web Form Collection Point that you want to build.
  2. In the Content Fields section, click the Add New button.

    The Add Form Field modal appears.


    Add Form Field modal
  3. Complete the fields, as necessary.
    Field
    Description
    Field Type

    Select Cookie Categories.

    Select Cookie Category

    Select the cookie category that you want to include in the OneTrust Embedded Web Form. These categories are populated from the Categories tab on the Categorizations screen in the Cookie Consent module.

  4. Click the Save button.

    The cookie category appears in the Content Fields section.

  5. In the Content Fields section, click the Edit icon Edit icon.
    Note:

    Click the link in the Name field to navigate to the Purpose Details screen.

    The Edit Field section appears.


    Edit Field section
  6. Verify the field configuration and make any changes, as necessary.
    Field
    Description
    Form Field Label

    Enter a label to be used for the cookie category within the OneTrust Embedded Web Form.

    Response Type

    Single Checkbox is automatically selected by default and cannot be changed.

    Required (Optional)

    Select this check box to require that the data subject consent to the cookie category when interacting with the OneTrust Embedded Web Form.

    Show description (optional)

    Enable this setting to display a description of the cookie category.

    Hide Form Field (Optional)

    Enable this setting to hide the cookie category on the OneTrust Hosted Web Form. When a data subject submits the form, they will automatically consent to the cookie category.

    If this setting is enabled, a default value must be selected for the cookie category. The following default values are available:

    • Checked

    • Unchecked

  7. Click Save and Close.

To add data elements to your OneTrust Embedded Web Form

Note:

Each OneTrust Embedded Web Form must have one data element marked as an identifier.

You can configure your OneTrust Embedded Web Form to allow multiple identifiers. For more information, see Allowing Multiple Data Subject Identifiers on Collection Points.

  1. Access the Builder tab for the OneTrust Embedded Web Form Collection Point that you want to build.
  2. In the Content Fields section, click the Add New button.

    The Add Form Field modal appears.


    Example of the Add Form Field modal
  3. Complete the fields, as necessary. Create as many Data Elements as needed clicking the Create New button.
    Field
    Description
    Field Type

    Select Data Elements.

    Select Data Element

    Select the data element that you want to collect from the data subject interacting with the OneTrust Embedded Web Form.

    Note:

    If a data element has been designated as an identifier, the data element will appear as an option in this field. For more information, see Managing Data Elements.

    Select if used as identifierorSelect if used as parental additional identifier

    Select the if used as identifier check box if the data element you selected will be used to uniquely identify data subjects that interact with the OneTrust Embedded Web Form. Otherwise, leave the check box blank.

    Select whether the data element can be used for parent identifiers.

    Note:

    These options appear only if two or more data elements are added to the Collection Point. The Select if used as identifier check box will be unavailable if the data element cannot be used as a data subject identifier. You can configure what data element types can be used as identifiers on the web form using the Data Elements screen.

  4. Click the Add button.
    Note:

    Hover over the icon next to a data element to know the type of identifier that is being used.

    The data element appears in the Content Fields section.

  5. In the Content Fields section, click the Edit icon Edit icon.
    Note:

    Click the link in the Name field to navigate to the Data Element Details screen.

    The Edit Field section appears.


    Example of the Edit Field section
  6. Verify the field configuration and make any changes, as necessary.
    Field
    Description
    Form Field Label

    Enter a label to be used for the data element within the OneTrust Embedded Web Form.

    Response Type

    Select the format in which responses will be provided.

    The following response types are available:

    • Text - This type allows users to enter text as the attribute value.

    • Date - This type allows users to select a date as the attribute value.

    Required (Optional)

    Select this check box to require that the data subject enter a value for the data element when interacting with the OneTrust Embedded Web Form.

    Contains Personally Identifiable Information (PII) (Optional)

    Select this check box if the data element contains PII.

    Hide Form Field (Optional)

    Select this setting to hide:

    • Single-select type data elements and Purpose Preferences

    • Non-required user-input type data elements, including phone numbers

      For non-required user-input type data elements

      : The data element can be hidden by including a query parameter in the URL. For example, a query parameter of ?city=Atlanta will hide the data element city on the web form but capture the city as Atlanta in the receipts.

      For mobile number type form fields

      : These form fields can be hidden by passing the UTF-8 encoded value for “+”, which is “%2B”, in the query parameter. For example, if the phone number is +1 123 456 7890, then the query parameter passed should be ?Mobile=%2B11234567890.

    Note:

    This functionality depends on the admin to provide an accurate query parameter on the OneTrust Embedded Web Form link to ensure that unexpected values are not recorded in the receipts, as incorrect query parameters can result in incorrect values being recorded for the data subject’s profile.

    Placeholder Text (Optional)

    Enter the text that you want to appear before an end user types in an answer.

    Custom Validation

    Enter the regular expression to use for validating the data subject's input.

    Validation Error Message

    Enter the message to display if the input is invalid.

  7. Click Save and Close.

To add a content block to the OneTrust Embedded Web Form

You can add a Content Block to your OneTrust Embedded Web Form in order to add additional text that is not in an input field.

  1. Access the Builder tab for the OneTrust Embedded Web Form Collection Point that you want to add a content block to.
  2. In the Content Fields section, click the Add New button.

    The Add Form Field modal appears.


    Add Form Field modal showing configuration options for a Content Block in the OneTrust Embedded Web Form
  3. Complete the required fields, as necessary, and add any relevant information into the Rich Text Editor text input.
    Field
    Description
    Field Type

    Select Content Block.

    Content Block Title

    Enter a title that will appear on the content block that is visible in the application only.

    Rich Text Editor

    Enter any customized content that cannot be displayed in a text input. Use the editing tools at the top of the editor to modify the content as needed. For more information, see Rich Text Editor Reference.

  4. Click the Save button.
    Note:

    Content Blocks can be drag and dropped in the Content Fields section to appear above or below specific purposes or data elements.

    The Content Block appears in the Content Fields section of the Builder.

Rich Text Editor Reference

The rich text editor offers a variety of formatting options to help you personalize and organize your OneTrust Hosted Web Form.



Text Formatting Options

Available Icons

Description

The following icons are available to format your text.

Click the More Text icon to show additional text formatting options.

The following options are available:

  • Bold - Makes the selected text bold.

  • Italic - Makes the selected text italic.

  • Underline - Makes the selected text underlined.

  • Subscript - Makes the selected text a smaller typeface at a level below the main text.

  • Superscript - Makes the selected text a smaller typeface at a level above the main text.

  • Font Size - Applies the selected font size to the text.

  • Text Color - Applies the selected color to the selected text.

  • Background Color - Applies the selected color as the background of the selected text.

Paragraph Formatting Options

Available Icons

Description

The following icons are available to format your paragraphs.

Click the More Paragraph icon to show additional paragraph formatting options.

The following options are available:

Note:

Icons with an arrow include additional formatting options from which you can select.

  • Align Left - Left-aligns the selected text.

  • Align Centre - Centers the selected text.

  • Align Right - Right-aligns the selected text.

  • Align Justify - Justifies the selected text.

  • Ordered List - Inserts a numbered (ordered) list.

  • Unordered List - Inserts a bulleted (unordered) list

  • Decrease Indent - Reduces the indentation level of the selected text by one level.

  • Increase Indent - Increases the indentation level of the selected text by one level.

  • Paragraph Format - Expands a list of heading and text styles.

Additional Options

Available Icons

Description

Click the Insert Link icon to insert a link that redirects to another URL when it is clicked. Once clicked, the Insert Link popover appears where you can define the URL and text and decide whether the new destination opens in a new tab.



The following icons are available once a link is added.

The following options are available:

Note:

Icons with an arrow include additional options from which you can select.

  • Choose Link - Select a URL from the predefined list.

  • Open Link - Opens the inserted URL. If the Open in new tab checkbox is selected, a new tab appears. If the checkbox is not selected, the URL opens in the existing page.

  • Style - Expands a list of link styles.

  • Edit Link - Opens the Insert Link popover to edit the link.

  • Unlink - Removes the link from the selected text.

Click the More Rich icon to show additional formatting options.

The following icons are available to insert additional objects within your content block.

The following options are available:

  • Insert Horizontal Line - Inserts a horizontal line.

  • Insert Table - Inserts a table with the selected columns and rows. Additional table formatting options are available once a table is added. For more information, see the row below.

  • Insert Image - Inserts an image you select to include.

Click the Insert Table icon to insert a table with the selected columns and rows.

The following icons become available to format your table when clicking any of the existing cells.

The following options are available:

Note:

Icons with an arrow include additional options from which you can select.

  • Table Header - Applies a header row to the table.

  • Table Footer - Applies a footer row to the table.

  • Remove Table - Deletes the entire table.

  • Row - Inserts or deletes a row in the table.

  • Column - Inserts or deletes a column in the table.

  • Table Style - Expands a list of table styles.

  • Cell - Expands a list of formatting options for the selected cell.

  • Cell Background - Applies the selected color as the background for the selected cell.

  • Vertical Align - Expands a list of vertical alignment options for the selected cell.

  • Horizontal Align - Expands a list of horizontal alignment options for the selected cell.

  • Cell Style - Expands a list of cell styles.

Action and View Options

Available Icons

Description

The following icons are available to perform actions and adjust your view.

Click the More Misc icon to show additional actions and view options.

The following actions are available:

  • Undo - Reverses the last action you performed.

  • Redo - Repeats the last Undo action you performed. The Redo icon only becomes available after you select Undo.

  • Code View - Adjusts the editor to let you view and edit your content in code view.

  • Fullscreen - Adjusts the editor to take up the entire browser window.

To edit the OneTrust Embedded Web Form details

Note:

For OneTrust Embedded Web Forms in Active status, you will need to create a new version of the OneTrust Embedded Web Form before you can make changes. For more information, see Creating OneTrust Hosted Web Form Collection Points.

  1. Access the Builder tab for the OneTrust Embedded Web Form Collection Point for which you want to edit the details.
  2. Make any necessary changes.
    Note:

    You can use the Purpose consent on form submission field to add a purpose to which the data subject will be opted in when submitting the OneTrust Embedded Web Form. Only one purpose can be included at purpose submission and this purpose will not be visible on the actual OneTrust Embedded Web Form. For more information, see To edit OneTrust Embedded Web Form purposes.

  3. Click the Save button.

To edit OneTrust Embedded Web Form purposes

  1. Access the Builder tab for the OneTrust Embedded Web Form Collection Point that you want to edit a purpose for.
  2. In the Content Fields section, click the Edit icon next to the purpose. The Edit Field section appears.

  3. Make any necessary changes.
  4. Click the Save and Close button.

To edit a content block on the OneTrust Embedded Web Form

  1. Access the Builder tab for the OneTrust Embedded Web Form Collection Point that you want to edit.
  2. In the Content Fields section, click the Edit icon next to the content block you want to update. The Edit Field section appears.

  3. Make any necessary changes.
  4. Click the Save and Close button.

Additional Resources

To continue setting up your OneTrust Embedded Web Form Collection Point, see the following articles:

For more information on advanced configurations for OneTrust Embedded Web Form Collection Points, see the following articles: