Swap Active Template

Swap Active Template: How It Works

Check the Source and Destination for Dictionary Updates

When initiating a template swap, the system first checks both the source and destination templates for dictionary updates. If either template lacks the latest dictionary updates, a request is automatically sent to update the template and all associated resources to ensure that data IDs align with the latest IDs in the underlying dictionary. For details on what is included in a template dictionary update, refer to the "Switch Active Template User Guide" under "What is included in a template dictionary update?"

Disclaimer: If both templates require dictionary updates, the load time will be significantly longer compared to scenarios where only one or neither template needs an update.

‍

Switch the Customer to the New Template

Once both templates are confirmed to be updated, the switch process is initiated. This process updates the customer's template information, determining which form and PDF the customer is associated with. After the template switch, live customer data is fetched to ensure all information is current with the new template, including share URLs, categories, and integration configurations.

Helpful Information

How can I determine if a field is an under dictionary field?To identify dictionary fields in a template, look for green indicators on the left-hand sidebar of the template editor. A gray indicator means the dictionary field is not present on the form and data transfer between templates is not expected. Replacing custom fields with dictionary fields is crucial for maximizing data transferability.

What happens to non-dictionary fields when I swap/switch?Non-dictionary fields, or custom fields, remain unaffected during the swap or dictionary update processes. Although they might not display on the destination template, the data will reappear if the original template is restored.

I have swapped my customer but data is missingIf data is missing after a swap, validate that the dictionary field is present on both templates before reporting the issue. Click here for guidance on this validation process. If both fields are under dictionary fields and data is still missing, report the issue using the "reported issues" table.

What happens to supporting documents when I swap/switch?Supporting documents are retained in the system even after switching to a new template. These documents will not display unless you navigate back to the original template or use the "download all" feature.

What happens if my fields have mismatching options?If a value does not match the current field options:

• The EU form will show a blank value until a new value is selected.
• The customer data tab will show a blank value until a new value is selected.
• PDF authoring will display the previous value as text.
• Switching back to any template with a matching option will display the value normally.

What is included in a template dictionary update?

• Form Structure:
  • Field ID
  • Data ID
  • Calculation IDs
  • Conditional IDs
  • Merge IDs
  • Address IDs
  • Repeater IDs
  • Adds to Total IDs
  • Choice IDs and Options
  • Connected Plaid Bank IDs
  • Signer IDs
• Integration Config:
  • Field Data IDs
  • Connected Field Choices
• Customers:
  • Data IDs compared to template data ID changes
  • Updated Signer IDs
  • Updated Selected Choice Values
  • Updated Adds to Values
  • Updated Repeater Values
• PDF:
  • PDF Values
  • PDF Choices
  • PDF Fields