This topic will provide information about sandbox sites and how to migrate templates across sites in your account.
Ironclad Clickwrap accounts comprise separate environments, called sites. Every account is auto-provisioned with a primary production site. Depending on your plan, you may have access to create additional sites within your account.
Additional sites are most commonly created to serve as sandbox environments, in which you build and test your Clickwrap implementations prior to deploying them to your production instance.
To learn more about creating and managing sites, refer to Add a New Site and Update Your Site's Properties.
Sandbox Site Considerations
Review the following sandbox site considerations:
- All activity in a sandbox site will have the test_mode variable set to true. This is not modifiable. To learn more about test_mode, refer to the Use test_mode Without a Sandbox Site section below.
- Acceptance Record PDFs in a sandbox site have the watermark “Not Legally Binding!”
- Each site has a unique Access ID. This means the Access IDs of your sandbox site and your production site will be different.
- All templates, Clickwrap Groups, Snapshot Locations, Legal Centers, activity, and users do not carry over across your sites by default. Refer to the Migrate Clickwraps Across Sites section below to learn more.
Migrate Clickwraps Across Sites
As stated above, components of your Clickwrap implementations do not carry over across your sites in your account. After you complete Clickwrap testing in your sandbox site, use the following tips to migrate your templates from your sandbox site to your production site.
Note: You must have user access to both sites to complete the steps below.
Copy and Paste Template HTML
- In your sandbox site, click Templates. Then, select the template you want to migrate.
- Click Edit. This will open the editor.
- Click the code view icon to view the HTML of the template.
- Select all of the code, then copy it to your clipboard.
- Hover over the three dots next to Publish, and click Delete to delete the draft template version you created.
- Click your sandbox site name at the top of the page, then select your production site to switch to your production site.
- Click Templates.
- Click Create New. This will open the editor.
- Name the template, then click Start Editing.
- Click the code view icon to view the HTML of the template.
- Delete any code on the screen. Then, paste the code from your clipboard.
- Click the code view icon to return to the regular template view to verify formatting.
- Save and Publish the template.
Repeat the steps above for each template you need to migrate across your sites.
Recreate Additional Clickwrap Building Blocks
You must recreate and publish your Clickwrap Groups, Snapshot Locations, and Legal Centers in your production site. Consider opening your sandbox site in an incognito window as a visual reference while you recreate these building blocks in your production site.
Note: Activity cannot carry over across your sites. You can add users to one or multiple sites in your account. To do so, refer to Manage Clickwrap Users.
Use test_mode Without a Sandbox Site
test_mode Overview
If you do not have a sandbox site and want to conduct testing in your primary production site, you can use the test_mode variable in the site object of your Clickwrap implementation.
test_mode is a boolean variable, which means it can have the value true or false. If test_mode is set to true, all activity related to that implementation is designated as Test Data with a checkmark in the Activity tab of the Clickwrap Group.
Additionally, any Acceptance Records associated with test data have the watermark "Not Legally Binding!" on their downloadable PDFs.
Note: As stated above, all activity in a sandbox site is test data, and it is not modifiable.
Use test_mode
While testing your Clickwrap implementation, add the test_mode variable to the site object of your implementation, and set its value to true.
_ps('create', your-site-access-id, {
test_mode: true
});
Once you complete testing, change the test_mode value to false in your deployed production code. Then, remove test_data from the activity of the associated Clickwrap Group:
- In Ironclad Clickwrap, click Clickwraps.
- Select the Clickwrap Group.
- Click the Activity tab.
- Click Delete Test Data.