QAS Small Business for Salesforce CRM

Transcription

1 INTRODUCTION This document provides an overview of integrating and configuring QAS for Salesforce CRM. It will take you through the standard integration and configuration process and also provides an appendix that explains how you can customize QAS beyond the standard integration. If you encounter problems using QAS for Salesforce CRM which are not answered in the product documentation, please visit QAS Small Business for Salesforce CRM Support Center: BEFORE STARTING THIS DOCUMENT YOU SHOULD HAVE COMPLETED THE FOLLOWING: 1) Purchased QAS Small Business for Salesforce CRM online 2) Created a QAS On Demand account. You will need this username and password to configure QAS. TABLE OF CONTENTS CONFIGURING QAS FOR SALESFORCE Add QAS Remote Site Add QAS On Demand Account Details Integrating QAS into Salesforce Objects and Pages Overriding the New Object Process Adding Custom Links or Buttons Finalizing Your Integration...6 APPENDIX A: Custom QAS Integrations...7 Overview Configure a Custom Touchpoints Integrate QAS into Your Custom Touchpoint Create a New Custom Override Create a New Custom Link or Button ) Downloaded and installed the QAS Address Verification app from the AppExchange IF YOU HAVE NOT COMPLETED ALL THREE PLEASE VISIT THE SITE BELOW TO FIND OUT HOW TO COMPLETE THESE ITEMS BEFORE CONTINUING WITH THIS DOCUMENT. SUPPORT: Page 1

2 CONFIGURING QAS FOR SALESFORCE UNDERSTANDING THE INTEGRATION PROCESS: At this point you should have installed QAS for Salesforce from the AppExchange and should now have a custom QAS for Salesforce.com tab available. This tab allows you to add your QAS On Demand account and edit address search settings. If it is not currently available, it can be added by going to the All Tabs page and clicking the add a tab link (the QAS tab can be ignored). Overall configuration is a 3 step process: 1) Edit remote site settings to allow access to the QAS On Demand server 2) Create overrides to call QAS when adding or changing addresses 3) Add custom links or buttons to pages where you want to invoke QAS via link or button QAS is pre-configured to interface with: Accounts Object and Pages Contacts Object and Pages Leads Object and Pages Contracts Object and Pages If you want to use QAS in any other objects that edit addresses you will need to follow the instructions in Appendix A: Custom QAS Integrations. If you plan to do custom integrations, we suggest you integrate QAS into the pre-configured objects and pages first to gain an understanding of the process before doing custom work. Depending on the security settings you configured when installing QAS from the AppExchange, you may need to make changes to the users that have access to QAS. In order for users to utilize QAS, they need to have access to the following VisualForce pages: QASPopup, QASUpdateDB, and any QAS_Override_New_XXX[_Lightbox] that you have used to override the New button on Salesforce objects. Additionally, if you do any custom QAS integrations in objects other than the pre-configured ones you will need to give users access to the QASOverrideController Apex Class in order for your custom integration to work. To change the user profile access permissions, click Setup, then under the App Setup menu expand Develop, click on Pages (or Apex Classes) and click the Security link next to the page (or class) you want to change. You should now be ready to configure QAS for Salesforce! Page 2

3 1. Add QAS Remote Site You must now change the Salesforce remote site settings to allow access to the QAS On Demand service. You will need to be an administrator to change these settings. Click Setup, then under the Administration Setup menu, expand Security Controls and click on Remote Site Settings. URLs are added by clicking the New Remote Site button. Add each address below as a new remote site: QAS_USA_1: QAS_USA_2: 2. Add QAS On Demand Account Details QAS for Salesforce relies upon the QAS On Demand platform to access address data. You should have received account activation instructions via after making your purchase. If you have not received this or need to activate your account please visit for instructions or to request another activation . Once your QAS On Demand account is activated, follow the steps below. You will need your QAS On Demand username and password. 1. Open the QAS for salesforce.com tab. The Main sub-tab will be active. 2. Add your QAS On Demand account details in the QAS On Demand Web Service Username and Password boxes. This is the username and password you setup for QAS On Demand, not your salesforce.com login. 3. Set United States as your QAS On Demand Data Center. 4. Click Save to store these details. Page 3

4 3. Integrating QAS into Salesforce Objects and Pages The final stage is to integrate QAS address searching into your Salesforce objects pages. QAS can be integrated into objects by overriding the new object process and individual pages by creating a custom link or button. This can be done easily for the standard Leads, Account, Contacts and Contracts using the supplied Visualforce Pages. To integrate into other objects see Appendix A: Custom QAS Integrations however we recommend integrating into the standard objects first to gain an understanding of the process before doing custom work. You must choose at least one of the methods below to integrate QAS into Salesforce. We recommend using both methods together, but if you only want to use one method we recommend overriding the new object process. Method 1: Overriding The New Object Process Every time a new contact, account lead, contact, etc. is created the QAS will automatically be called to check the address. Using this method, QAS will appear in line with the normal process users experience when adding a new address. Method 2: Adding Custom Links or Buttons A link or button can be added to each Salesforce page that will call QAS to find an address when clicked. Using this method, users will need to be instructed to use the custom button or link when they want to verify an address using QAS. 3.1 Overriding the New Object Process 1. Click Setup, then from the App Setup menu, select Customize, pick the object you want to change (for example Leads), then Buttons and Links. 2. In the Standard Buttons and Links section, click Edit next to the New label. 3. In the Override Properties, select the Visualforce Page option. From the Content Name drop-down list choose the Visualforce page you require: RECOMMENDED: QAS_Override_New_[object]_Lightbox Launches the recommended Lightbox address searching popup. QAS_Override_New_[object] Launches an alternative address searching popup window which can be used if you experience problems using the Lightbox version. 4. Click Save. The New button will now be listed as Overridden. 5. Repeat steps 1-4 for each object (Accounts, Contacts, Leads, Contracts) where you want to use QAS to verify addresses. Page 4

5 3.2 Adding Custom Links or Buttons QAS Small Business for Salesforce CRM 1. Click Setup, then from the App Setup menu, select Customize, pick the object you want to change (for example Leads), then Page Layouts. 2. Click Edit next to the page layout to which you want to add the link or button, e.g. Lead Layout. 3. You will now need to decide if you want to add a Button or a Custom Link. You can add both, but you will need to create one and then the other. To add an address search button, click Buttons in the enhanced page layout editor. To add an address search link, click Custom Links in the enhanced page layout editor. 4. Drag-and-drop the button or link you require onto the Custom Buttons or Custom Links area of your page layout. The screen shot on this page shows a button being added. A link is done the same way except you need to drag the link to the custom link area of your page layout. For the standard Leads, Accounts, Contacts and Contracts objects there are two versions of each button or link provided: Find Address (RECOMMENDED) will launch the Lightbox address searching popup Lookup Address will launch the alternative address searching popup window which can be used if you experience problems using the Lightbox version. Note that for objects with more than one address there will be more than one set of buttons and links available. For example, there are Billing Address and Shipping Address buttons and links provided for the Accounts object. 5. Click Save to make the changes to the page layout. 6. Repeat steps 1 through 5 for each object and page layout (Accounts, Contacts, Leads, Contracts) where you want to add a custom link or button to use QAS. Page 5

6 4. Finalizing Your Integration QAS for Salesforce should now be configured per standard settings and integrated into your Salesforce CRM. You will need to ensure that all users who are licensed for QAS for Salesforce have access to the QASPopup, QASUpdateDB, and any QAS_Override_New_XXX[_Lightbox] Visualforce pages. IF YOU WOULD LIKE TO CONFIGURE QAS FOR ANY OBJECTS OTHER THAN ACCOUNTS, CONTACTS, LEADS OR CONTRACTS PLEASE USE APPENDIX A: CUSTOM QAS INTEGRATIONS TO DO SO. Page 6

7 APPENDIX A: Custom QAS Integrations Overview QAS Small Business for Salesforce CRM Creating a custom QAS integration is the same process as setting up a standard QAS integration except that you create a custom touchpoint for QAS and then create custom overrides, links or buttons to call QAS. A custom touchpoint is required for any object you want to use QAS in other than Accounts, Contacts, Leads or Contracts. If you only want to customize the overrides, links, or buttons you are using to call QAS in the standard objects or pages you do not need to create a custom touchpoint and can skip to overrides, buttons or links sections of this appendix. If at any time you are in the QAS for Salesforce.com tab and want more information you can always click the Help for this page link in the upper right. This will pull up a full description of all the fields on the page you are on. 1. Configure a Custom Touchpoints Touchpoints Touchpoints map the contact data fields on your Salesforce object to the address search input and output fields used by QAS for Salesforce. You will need a touchpoint for every address in Salesforce into which you want to integrate QAS for Salesforce. QAS for Salesforce comes preconfigured for the Leads, Accounts, Contacts and Contracts objects so you will only need to configure custom touchpoints for other objects. To set up a new touchpoint for any other Salesforce object, do the following: 1. In the Touchpoints sub-tab click the Add new Touchpoint button. The Touchpoint Edit screen will open. 2. In the Core Details area, name your touchpoint in the Touchpoint Name box. You will need the touchpoint name when you configure the custom links, buttons or overrides so make a note of the touchpoint name. 3. Select the Salesforce object you are creating this touchpoint for from the Object Name drop-down list. 4. Set up the Input Mapping for this touchpoint by selecting Input Search Fields from your Salesforce object and linking them to the QAS for salesforce.com input fields using the arrow buttons. The example on the right shows a recommended input mapping for mailing address. Page 7

8 5. You can set up a general Output Mapping as well as a custom output mapping for each country dataset you have using the process below. The screenshot on this page shows a recommended output mapping for mailing address. a. From the output mapping drop-down list choose the data mapping for which you want to set up the output mapping, or Default for a general output mapping. b. Choose the QAS On Demand Output Layout to base your output mapping on. The Salesforce layout will usually provide the best results. c. Select an output field from the Formatted Address Output Fields list. d. Select a Salesforce field from one of the drop-down lists on the right (initially these will all be <NotAssigned>). e. Click the arrow button next to the Salesforce field to map it to the output field. f. Repeat steps c to e for every output field you want to map. 6. Click the Save button. The new touchpoint can now be used by a custom link, button or override on your Salesforce object (see step 4 on page 8). For more details about input and output mappings click the Help for this page link on the Touchpoints sub-tab. Page 8

9 2. Integrate QAS into Your Custom Touchpoint QAS Small Business for Salesforce CRM Now that you have setup custom touchpoint you must decide how you will call QAS at the touchpoint. QAS can be called by overriding the new object process and/or by creating a custom link or button and then adding it to the page. You must choose at least one of the methods below to integrate QAS in each object. We recommend using both methods together, but if you only want to use one method we recommend overriding the new object process. Method 1: Create a New Override Every time a new contact, account lead, contact, etc. is created the QAS will automatically be called to check the address. Using this method, QAS will appear in line with the normal process users experience when adding a new address. Method 2: Adding Custom Links or Buttons A link or button can be added to each Salesforce page that will call QAS to find an address when clicked. Using this method, users will need to be instructed to use the custom button or link when they want to verify an address using QAS. 2.1 Create a New Custom Override To override the new object process at a custom touchpoint you must create a custom Visualforce page for the object. The screenshot on this page shows the Visualforce Page Edit screen for creating a custom override for the Leads object. Note: you must be logged in as a System Administrator to create new Visualforce pages. 1. Click Setup, then from the App Setup menu, select Develop, then Pages to list the Visualforce pages available. 2. Click the New button to display the Page Edit screen. 3. If you are integrating the Lightbox address search popup, type QAS_Override_New_[object]_Lightbox in the Name and Label boxes, where [object] is the name of the Salesforce object you want to customize. If you are integrating the alternative address search popup window, type QAS_Override_New_[object] in the Name and Label boxes, where [object] is the name of the Salesforce object you want to customize. 4. In the Visualforce Markup area paste the following code, replacing Object with the name of the object you want to customize: For Lightbox integrations: <apex:page standardcontroller="object" extensions="qas.qasoverridecontroller" action="{!autorun}"> <qas:qasredirectlightboxcomponent ErrorCondition="{!ErrorCondition}" NoSuccess="{!NoSuccess}" SomeSuccess="{!SomeSuccess}" FormData="{!FormData}" RNextUrl="{!RNextUrl}" /> </apex:page> Page 9

10 For popup window integrations: <apex:page standardcontroller="object" extensions="qas.qasoverridecontroller" action="{!autorun}"> <qas:qasredirectcomponent ErrorCondition="{!ErrorCondition}" NoSuccess="{!NoSuccess}" SomeSuccess="{!SomeSuccess}" FormData="{!FormData}" RNextUrl="{!RNextUrl}" /> </apex:page> 5. Click Save. The new Visualforce page will be listed. 6. Follow the instructions for overriding the new object process in section 3.1 of the Configuring QAS for Salesforce part of this document (page 4) to override the New button on the Salesforce object using the Visualforce page you just created. Remember you need give users access to the Visualforce page you just created. Page 10

11 2.2. Create a New Custom Link or Button If you would like to use a custom button or link to call QAS address searching you will need to follow the instructions below. The screen shot on the right shows the Custom Button or Link Edit page ready to create a Find Address link for the Lead object which will launch the Lightbox version of the QAS for salesforce.com address search popup. NOTE: that you must be logged in as a System Administrator to create custom links or buttons. QAS Small Business for Salesforce CRM 1. For standard Salesforce objects, click Setup, then from the App Setup menu, select Customize, the object you want to change (for example Leads), then Buttons and Links. For custom Salesforce objects, click Setup, then from the App Setup menu, select Create, then Objects, and select the custom object from the list. 2. In the Custom Buttons and Links section, click the New button. The New Button or Link page will be displayed. 3. Type a Label (the text on the link or button) and Name for your link or button that will help you identify it. There are no special requirements for the label or name. 4. Choose the Detail Page Link option if you are creating a custom link, or the Detail Page Button option if you are creating a custom button. 5. Change the Behavior to Execute JavaScript. The Content Source will automatically change to OnClick JavaScript. 6. Paste one of the following code sections into the code area, replacing Object with the name of the object you are customizing and ObjectTouchpoint with the name of the touchpoint you created earlier: For Lightbox integrations: {!REQUIRESCRIPT("/resource/ /qas jquery132min")} {!REQUIRESCRIPT("/resource/ /qas thickbox31js")} {!REQUIRESCRIPT("/resource/ /qas PopupHelperJS")} QASDisplayLightbox({ id : "{!Object.Id}", touchpoint : "ObjectTouchpoint"}); For popup window integrations: {!REQUIRESCRIPT("/resource/ /qas PopupHelperJS")} QASDisplayPopup ({ id: "{!Object.Id}", touchpoint: "ObjectTouchpoint"}); The example on the following page shows the Custom Button or Link Edit page ready to create a Find Address link for the Lead object which will launch the Lightbox version of the QAS for salesforce.com address search popup. 7. Click Save. 8. The custom link or button you created will now be available to be added to pages in the respective Salesforce object by following the instructions in section 3.2 in the Configuring QAS for Salesforce section of this document (page 5). Remember you need give users to the new links/buttons you have just created. Page 11