PeopleImport can be used with either a production instance or a sandbox instance. By default, PeopleImport accesses the Salesforce production login server. An unlimited number of sandbox accounts are allowed for each production org.
Starting in PeopleImport Version 2.2 the process for accessing a sandbox will depend on whether the user is logging in via the Salesforce API Login tab or the Salesforce OAuth Login tab. Information on the API login option can be found HERE and information on the OAuth login option can be found HERE.
Salesforce OAuth Login (available in version 2.2 and up)
To access a sandbox using the OAuth login option, either enter the Custom Domain for the sandbox (if custom domains are used in the org) and/or check the Sandbox Login checkbox.
1. Sandbox Login/Custom Domain
- Using a custom domain: Enter the custom domain, click Set
- DO NOT check Sandbox Login
- Include the sandbox name and cs server (company--sbname.csX)
- If SSO is active for the sandbox, a custom endpoint will be required to login via SSO
- Depending on how SSO is configured in the org, users may be brought directly to the SSO login provider screen, or will have an additional option to login via SSO vs the Salesforce login page
- NOT using a custom domain: Check Sandbox Login
- Leave Custom Domain blank
2. Enter Salesforce Username and Password for the Sandbox (no custom domain) or the SSO provider login credentials (with custom domain and SSO).
- No Security Token Required
3. Click Log in to Sandbox
Salesforce API Login
Adding a Custom Endpoint
To access a sandbox when using the API login page, a custom endpoint must be specified AND the Use Custom Endpoint box must be checked. To add a custom endpoint click on Proxy / Endpoint Setup in the upper right hand corner of the API login window. The custom endpoint is the Salesforce API URL (https address) for the sandbox.
- Login to the sandbox instance of Salesforce
- Click on:
- Setup -> Develop -> API
- Generate the Partner WSDL
- At the end of the WSDL locate a "soap:address location" URL that is similar to: https://test.salesforce.com/services/Soap/u/39.0
- Copy the URL (it is case sensitive)
- Launch PeopleImport (login screen)
- Click Proxy/Endpoint Setup in the upper right
- Paste the URL in the Custom Endpoint box, check Use Custom Endpoint, and click OK
- Restart PeopleImport
- Login using the sandbox instance credentials
NOTE: A warning will be generated notifying the user if the API version specified in the endpoint does NOT match the current API on which PeopleImport was built. Earlier or later API's can typically be used but, occasionally problems may arise, therefore it is best to have the API in the custom endpoint match the API version on which PeopleImport was built.
THIS IS JUST A WARNING. Users should attempt to login and access the modules with the API version in the endpoint and ONLY need to change to the API version noted in the warning if errors occur (e.g. "error accessing data").
When logging into production, PeopleImport will always use the API that it was compiled with. Therefore, this is only an issue when overriding the standard API with a custom endpoint to access the Sandbox.
Switching Between Sandbox and Production
To set PeopleImport back to production with Salesforce OAuth login, simply set the custom domain to the production domain and/or uncheck Sandbox Login.
When using the Salesforce API login:
- UNCHECK the Use Custom Endpoint checkbox
- Close the login window and relaunch a fresh login screen
- Enter the login credentials for production
The endpoint DOES not need to be blanked out, nor should a different endpoint be entered. By default, when the Use Custom Endpoint box is unchecked the login is directed to the production servers.
The status bar on the bottom of the screen (when logged into PeopleImport) will show the URL in which PeopleImport is pointed.
Linking Production and Sandbox Instances
Sandbox org ID's can be linked to Production such that scenarios created on one or the other can be run on either org
- To link 2 Salesforce org's together, a request must be made via Validity technical support by emailing firstname.lastname@example.org
- Keep in mind that whenever an existing sandbox is refreshed the old Salesforce org ID is deleted and a new org is created, so a request to re-link the new sandbox will required