Skip to main content

Return to TX Community

Liaison

Refreshing and Resetting Your TargetX Sandbox

Before upgrading with TargetX packages, you should refresh and reset your sandbox and then install and test the upgrade packages in the sandbox. This should always be done before upgrading your production org. During a sandbox refresh, the data in your sandbox environment will be overwritten by data from your production org. Hence, it is important to move any work in the sandbox to the production org before refreshing.

Refresh the sandbox

  1. Log in to your production environment.
  2. Navigate to Setup and search for Sandboxes.
  3. Select the sandbox you plan to refresh.
  4. You will be prompted to select whether this is a Partial or Full.
    • If you plan to refresh a Partial sandbox→, Select the Template you plan to use or use the template containing ALL objects.
  5. Ensure the Auto Activate checkbox is checked.
  6. Indicate sandbox Access.
    1. Unless you have a reason to grant all of your users access to the refreshed Sandbox, it is advisable to create a Public Group (under Setup) for those who will be testing. 
      1. Title your Public Group (for example, ‘Admins’ or ‘sandbox Testers’) and add the users who need access to the refreshed sandbox.
      2. The instructions below provide the steps for granting access to users (not part of the used Public Group) after a sandbox has been refreshed.
  7. Click Create.

Once the refresh is complete, log in to the sandbox using your production password and sandbox username (the username from production appended with the sandbox name, e.g., address@domainname.com.sandboxname).

Update Users in Sandbox Org

If you did not grant users access during the refresh, these instructions provide the steps to grant them access after the refresh has occurred.

  1. Navigate to the User record and click Unfreeze at the top of the page. 
  2. Update the email address on the user record for any user requiring sandbox access. To do this, remove the .invalid that is appended on the end of the address.
  3. Once you have removed the .invalid from applicable user records, notify each user that they should have received a verification email from Salesforce and will need to verify this update. They have 24 hours to do so.
  4. Once the user verifies the update, they can log in to the refreshed sandbox with their sandbox username (the username from production appended with the sandbox name, e.g., address@domainname.com.sandboxname)and their production password.

Reset the Sandbox

The following items detail the sandbox items to update (for either Full or Partial) after the refresh.  These updates may vary depending on which TargetX tools you use.

Community Theme Related Site URL

Community Themes need to be updated to reflect the sandbox URL:

  1. In the App Launcher, navigate to Community Themes.
  2. Open each theme, select the Related tab, and change the production URL to the new sandbox URL.
    • You can find the new URL by going to Setup, searching for Sites, and using the URL from the appropriate community site.

Recommendation Email Links

Recommendation Email links need to be changed from production URL to new sandbox URL:

  1. Navigate to Setup and search for Sites. Locate and make note of the Online Application Site URL.
  2. Navigate to Email Builder and update any TX Email templates for Recommendations.
  3. If needed, navigate to Setup and search for Classic Email Templates
    • Update the folder to Recommendation Emails.
  4. If recommendation emails are used, update the site portion of the link to the recommendation form to point to the new sandbox Online App URL.

Group Assignment Remote Site URL

  1. Navigate to Setup and search for Remote Sites.
  2. Add or adjust the existing remote site URL to match the sandbox site.
    1. You can find the sandbox Group Assignment URL by navigating to the Group Assignment Builder and refreshing the rules. An error message will appear with the URL to use to update the Remote Site URL.

Retention Remote Site URL

  1. Navigate to Setup and search for Remote Sites.
  2. Add or adjust the existing remote site URL to match the sandbox site. The Remote Site Name is usually MDAPI or Retention.
    1. You can find the sandbox Retention URL by navigating to the Student Success Center tab > Settings > Picklists tab > Clicking Refresh Picklist Definitions. An error message will appear with the URL to use to update the Remote Site URL.

Events Setting Page

The SingleEventRegistrationURL Field needs to be changed from the production URL to the new sandbox URL on the Event Settings Tab.

  1. If you do not have an Event(s) Settings tab, append the following to any URLfrom the Sandbox org to access Event Settings:

  • You can find the new Sandbox Event URL by navigating to Setup and searching for Sites. Use the URL from the event site, being sure to build this as outlined in the Testing an Upgrade article.
  • Ensure the following code is not removed from the URL:

Session Settings

  • The sandbox URL needs to be added as a Trusted Domain. To do this, navigate to Session Settings in Setup. From there, add the sandbox URL (without http:// or anything after .com) as a Trusted Domain.(Ex. premiereducation.lightning.force.com)
  • If you are using FormAssembly, your Test Form needs to be updated to reference the new sandbox. This must be done in your production org. If you are not sure which form to use, search all forms for “sandbox” or “Events” and you will usually find one that has only a handful of responses. If none exist, clone the production version of the form you wish to test.
    • Update the Connector (access) to connect to the newly refreshed sandbox
      • Click Change Access and sandbox, or select a current access username and enter credentials for a new sandbox to establish the connection.
        • If you do not have a Salesforce Login page appear (to add your credentials), you may have to clone the form.
      • WAIT until the page has loaded and ensure Enabled is checked and that you click Save.
      • Update the Notification URL to reference the updated nodes from the new sandbox.  If this is a newly cloned form, you will also need to update the URL to point to the sandbox.
    • Update the Notification URL
      • If Enhanced Domains is enabled, you will need to update the full URL. Otherwise, you will only need to change the Node in the URL.
      • If this is a newly cloned form, copy and paste the URL in and adjust the node for your new sandbox.
    • Once your form is set up in production, copy the Form ID and navigate back to the sandbox. Update/paste the Form Assembly ID field on your test Event.

ReCAPTCHA for Online Application and TX Forms

  • The registered URLs for your school need to be updated to account for the new sandbox URL. 
    • You can find the new URL by going to Setup and then searching for Sites. Use the URL from the Online App community site and/or the TX Form Site (Inquiry).
  • Log into your Google Captcha account and add this new sandbox URL to the list.
  • You should not need to re-enter the site key and secret key.  However, if ReCAPTCHA does not pick up the new site, you can troubleshoot by beginning with this step.  If creating new, pick v2 and “I’m not a robot” for the type.
    • Append this code to the end of one of your open tabs in the Sandbox org: /apex/TargetX_Base__CaptchaSetup
    • Copy the Secret Key and Site Key into the sandbox after you have updated your Google Captcha account with the updated URL.

Additional Partial Sandbox Items to Update

The Unknown School Account may need to be created.

  1. Check to see if Unknown School exists. If it does not, create it a new account record for Unknown School.
    • Log into production and check the following areas to see if you have Unknown School listed as a Default Account ID. Wherever you see it listed, update that same area in the sandbox so that it points to your sandbox Unknown School. If nothing exists in your production environment, you DO NOT NEED TO UPDATE THE SANDBOX.
      • RM Preferences Default Account ID → input newly created Unknown School ID
      • Custom Settings → TargetX Base Custom Setting → Default → Default Account ID → input newly created Unknown School ID
      • All Sites → ANY Community the client is using → Administrator → Login and Registration → Bottom of page - Default Account (select the newly created Unknown School record from the search)
      • Online Application Forms that include High School and/or College Enrollment History - Once you determine the Application Forms, open the Form Builder and review conditioning on all fields in the card, especially School Name fields.  Any that include the Unknown Default Account ID from production should be updated with the new Default Account ID for the sandbox.
        • If no high school records exist, create at least one.
        • If no college records exist, create at least one.

Test the Reset

As you familiarize yourself with upgrades, you may wish to test the reset prior to installing new packages in your Sandbox. This helps with troubleshooting issues by allowing you to rule out/resolve any issues with the reset. If you wish to test the reset,complete the following steps if applicable for tools that you currently use: 

  • Create a community account
  • Submit an application
  • Submit a recommendation form
  •  Create a test event
  • Register/cancel registration for the test event
  • Test any portal configurations as part of the reset testing

 

 

  • Was this article helpful?