Installation and Configuration Guide for

Transcription

1 Installation and for Brickwork Version: Last Updated: February 13 th, 2014

2 Table of Contents 1 Document Version Contact Information Overview Brickwork Overview Custom Objects and Features of Brickwork New Recurring Payment Options Installation Pre-Requisites Recurring Donations Object Payments Object Obtain Merchant Account Have a Salesforce Administrator Account Part 1 - Brickwork Installation Part 2 - Configure Page Layouts and iats Settings Configure Contact Object Page Layout Configure Opportunities (Donation) Object Page Layout Configure Recurring Donations Object Page Layout (Only if used with Brickwork) Configure Payments Object Page Layout (Only if used with Brickwork) Configure iats Customer Codes Object Page Layout Create iats Account(s) Modify iats Settings Opportunity (Donation) Settings Nonprofit Starter Pack Settings Contact Match Settings Aura Field Mapping Virtual Terminal Settings Additional Settings Schedule the Nightly Download Journal Import Aura and Aura/Link Online Integration (Optional) Page 2 of 60

3 11.1 Create a Salesforce Site: Integrate Aura online processing with Campaign ID s and/or Record Types Method 1 - Add Campaign ID and/or Record Type ID s onto the web page Button/link URL Method 2 - Add Campaign ID and/or Record Type ID s onto the Salesforce Site Method 3 - Add Campaign ID and/or Record Type ID s on URL hyperlink How To: Import iats Customer Codes into Salesforce Create necessary Salesforce records Prepare Import Spreadsheet Perform a Salesforce Custom Object Import: Step 1 - Choose Record: Step 2 Prevent Duplicates: Step 3 Specify Relationships: Step 4 Define Lookup Matching: Step 5 File Upload: Step 6 Field Mapping: Step 7 Verify Import Settings: Page 3 of 60

4 1 Document Version Document Change Date of Change: Various Bug Fixes Feb 11 th, Various Bug Fixes Jan 16 th, ** Important: Existing Brickwork clients should download the Brickwork 4 - Existing Client Update Instructions document instead of utilizing these Install Instructions. All Brickwork.15 additions added: Descriptions of new Recurring Payment Options (Pages 10 & 14) Page Layout modifications added to accommodate new Recurring Donations and Payments Object integration (Section 7) New Recurring Payment options added to iats Settings configuration (Section 9.1 & 9.2) Dec 10 th, 2013 Page 4 of 60

5 2 Contact Information North America: UK/Europe: Customer Care: Phone: North America: UK/Europe: Hours: 7:30am 5:00pm Pacific Standard Time, Monday to Friday 8:00am 4:00pm Pacific Standard Time, Saturday Sales and Marketing: Phone: North America: UK/Europe: Hours: 6:00am 4:30pm Pacific Standard Time, Monday to Friday For the most up to date versions of our documentation, this Brickwork Installation &, the Brickwork User Guide, and Aura Guides can be downloaded by visiting our website As a Level 1 Payment Card Industry (PCI) certified company, ensures all transactions are handled with the highest industry standards in security and confidentiality. Page 5 of 60

6 3 Overview 3.1 Brickwork Overview Brickwork is a native Salesforce ( Application that brings the power of iats Payment Processing directly into your Salesforce environment. Whether donations are received via the phone or through your website, Brickwork enables your organization to process credit card payments and maximize your revenue. With the ability to process one-time transactions and schedule recurring payments, Brickwork eliminates the hassle of manual data entry into your Salesforce CRM. Real-time processing allows for greater workload efficiency and rapid results. With the ability to create donation pages directly using Brickwork s Aura custom tab, taking your fundraising efforts online is a snap. Brickwork is fully integrated with the Non Profit Starter Pack, including the Recurring Donations object and the standard Payments object. For more information on iats recommended Brickwork workflows and how Brickwork functions please refer to the Brickwork User Guide which can be downloaded by clicking here. Page 6 of 60

7 3.2 Custom Objects and Features of Brickwork iats Account iats sub-codes and passwords are stored as iats Accounts. Brickwork currently supports up to 10 Active iats Accounts (available for use in the Brickwork Virtual Terminal), and 99 Inactive iats Accounts (available for use with Aura Online Donation pages and for reporting purposes). iats Customer Codes iats Customer Codes are unique tokens that represent the donor s payment information which has been securely stored in the iats servers. The last four digits of the Credit Card and/or ACH account and related recurring details are displayed. Page 7 of 60

8 iats Transactions iats Transactions are individual Credit Card or ACH charges which have been processed via your iats Payments merchant account. Each iats Transaction is represented by a unique Transaction ID and contains details pertinent to the charge such as Approval or Rejection status and the Date & Time. Refund Transactions In addition, full Credit Card Refunds can be processed within Brickwork via the iats Transaction. Page 8 of 60

9 Brickwork Virtual Terminal Also known as the iats Button, the Brickwork Virtual Terminal is used to charge Single Credit Card or ACH transactions, to schedule Recurring Credit Card or ACH transactions, and to amend all saved payment details and schedule details within an iats Customer Code. Additional Virtual Terminal features: Manual or Credit Card Swipe payment details entry. The Card Swipe option can be set as the default entry method if selected on the iats Settings tab. Create iats Customer Codes and Opportunity (Donation) records directly within the terminal. Can be added to the Contact, Opportunity and/or Account objects. Page 9 of 60

10 iats Settings iats Settings options customize how Brickwork and Aura communicate with your unique Salesforce environment and the Non Profit Start Pack if being used. For more information about the Nonprofit Starter Pack, including information on the Recurring Donations object and the Payments Object (within the Contacts & Organizations app) please visit the following helpful links: General NPSP: NPSP and Money: Payments: Page 10 of 60

11 Aura and AuraLink Secure Online Donation Web Form Aura and AuraLink refer to the secure online donation web form which integrates seamlessly into an existing website. Aura and AuraLink have built-in integration with Brickwork. For more information please refer to the Aura Installation Guide, which can be downloaded at, or the AuraLink documentation which is available by contacting iats Customer Care. Page 11 of 60

12 Download Journal Import The Manual or Automated Download Journal retrieves an iats Journal report containing all transaction data processed the prior day. This ensures all recurring iats Transactions are recorded in Brickwork. Multi-Currency Integration Brickwork is fully compatible with the Multi-Currency feature within Salesforce. For more information on how choose a Multi-Currency option, please visit: Campaign and Record Type Integration As of Version Brickwork processing can be integrated with Salesforce Campaigns, and the Contact and Opportunity Record types for Online Aura processing. Campaign ID s and Contact and Opportunity Record Type ID s can be added to the URL which hosts the Aura donation webpage to enable relating records to a Campaign. For complete instructions on how to associate Aura online processing to Campaigns and assign Record Types, please see the Aura and Aura/Link Integration URL (Optional) section of this guide. Page 12 of 60

13 4 New Recurring Payment Options As of.15, Brickwork is fully integrated with the standard Payments object, and the NPSP Recurring Donations object to record recurring payments! Before installing Brickwork, please review the below options. Brickwork recurring functionality offers four options for handle recurring/pledged donation schedules: 1. Payments Integration - Multiple Payment Records related to one Opportunity: iats Customer Code related to Opportunity and all iats Transactions related to each Payment Record. 2. Recurring Donation Integration - Multiple Opportunities related to one Recurring Donation: iats Customer Code related to Recurring Donation and all iats Transactions related to individual Recurring Donation Record. 3. No Opportunity Records option: iats Customer Code and all iats Transactions related to Contact Record. 4. Standard iats option - One Nested Opportunity: iats Customer Code related to Opportunity Record and all iats Transactions nested within the Opportunity. This is the existing recurring method. Do you plan to accept recurring payments in addition to one-time transactions? Yes No Do you utilize the Recurring Donations object? Do you utilize the Payments object? Download Brickwork Application Yes No Yes No Download Brickwork Application & Recurring Donation add Download Brickwork Application Download Brickwork Application & Payments add on Extension Download Brickwork Application on Extension Page 13 of 60

14 In order to utilize either the Payments or Recurring Donations, you will need to meet the below pre-requisites depending on which option you choose, and install the applicable add on extension from the Salesforce Brickwork App Exchange listing after installing the Brickwork application. If you would prefer to use the Standard iats option, or no Opportunity records, you only need to install Brickwork. For more information about the Nonprofit Starter Pack, including information on the Recurring Donations object and the Payments Object (within the Contacts & Organizations app) please visit the following helpful links: General NPSP: NPSP and Money: Payments: Page 14 of 60

15 5 Installation Pre-Requisites The following account credentials are recommended before installing Brickwork to ensure complete set- up and testing. ** Important: Existing Brickwork clients should download the Brickwork 4 - Existing Client Update Instructions document instead of utilizing these Install Instructions. 5.1 Recurring Donations Object To utilize the Recurring Donations Object, you must have the Recurring Donations for the Non-profit Starter Pack installed. Please click here to download from the Salesforce App Exchange. 5.2 Payments Object To utilize the Payments object for recurring payments, you must have the latest version of the Contacts and Organizations for the Non-profit Starter Pack installed. Please click here to download from the Salesforce App Exchange. 5.3 Obtain Merchant Account An iats Offline Client Code (ends in 01) is required to fully configure and test iats Transactions within Brickwork. If being utilized, an iats on-line account (ends in 80) is required to fully configure and test iats Transactions processed via Aura or AuraLink. These codes will have been provided to you on the confirmation that is sent once the Merchant Account has been approved: Page 15 of 60

16 For more information regarding setting up an iats Merchant Account, adding a 01 or 80 sub-code onto an existing Merchant Account or obtaining temporary test credentials, please contact iats Sales and Marketing at: iats@iatspayments.com Phone: North America: UK/Europe: Have a Salesforce Administrator Account An account with administrator access is needed in order to modify the standard Salesforce Objects (specifically Contact and Opportunity) during the setup and configuration of Brickwork. It is recommended to use this account for the whole installation process described in this document. Page 16 of 60

17 6 Part 1 - Brickwork Installation Please review the Brickwork Installation Pre-Requisites section of this Installation Guide before following the previous steps to ensure you have all required information. ** Important: Existing Brickwork clients should download the Brickwork 4 - Existing Client Update Instructions document instead of utilizing these Install Instructions. 1. Click here to find Brickwork on the Salesforce App Exchange. 2. Click Get It Now to begin the installation process. 3. When prompted, please login with elevated access (use an administrator account or one with administrator permissions). 4. Once logged in, confirm the installation details and Terms and Conditions. 5. Click Continue on the Package Installation Details screen. You will be asked to verify your password at this point as a security check. 6. On the next pop-up window, click Yes, Grant Access to these Third-Party web sites, then click Continue. This will allow Brickwork to communicate with the iats servers. 7. Approve Package API Access. Click Next. 8. Choose Security level. Select the Security level that is appropriate to your organization, then click Next. 9. Install Package. Click Install. You will receive an from Salesforce when installation is completed. 10. The Package Details page will confirm the installed Brickwork application and changes that were made. New.15 additions: 11. If using the NPSP Recurring Donation Object or NPSP Payments Object with Brickwork, proceed with downloading (or updating) the Recurring Donations package or the Contacts & Organization s package from the Salesforce App Exchange (if not already done) in order to integrate Brickwork with these objects. 12. If using our Payments integration, please click here to install our Brickwork add on extension for Payments from our website. 13. If using our Recurring Donations integration, please click here to install our Brickwork add on extension for Recurring Donations from our website. Congratulations! You have successfully installed Brickwork! ** Important! These installation steps completed Part 1 of the setup process. Please proceed to the Part 2 - Configuring Brickwork section of this Installation Guide. Page 17 of 60

18 7 Part 2 - Configure Page Layouts and iats Settings In order to follow iats recommended workflows, ensure visibility of all iats Transaction information, and have access to the iats Virtual Terminal, it is important to complete each Part 2 - Configuring Brickwork step. The following objects and records will be configured and/or modified during the following steps: Contact Object Standard to Salesforce Opportunities (Donation) Object Standard to Salesforce iats Accounts Brickwork Custom Object iats Settings Brickwork Custom Object Recurring Donations Object Salesforce Download (Optional) Payments Object Part of Salesforce Contacts & Organization s (Optional) iats Aura Setup (Optional) Brickwork Custom Object Please note that the iats Button and iats Transactions & iats Customer Codes related lists can also be added to the Account (Household/Organization) Object if desired. Please follow the same instructions as the Contact Record Object layout. Page 18 of 60

19 7.1 Configure Contact Object Page Layout 1. In Setup (click on your username and choose Setup), under the App Setup section select Customize then Contacts and then Page Layouts, OR Click on Edit Layout in the Force.com quick access menu when in a Contact record, which is the blue arrow at the far right of the page if enabled. OR 2. If accessed via the Setup menu, click Edit for the active or current page to be customized. If there is more than one active page layout, you may need to repeat the following steps for each layout. 3. Click Buttons. Drag the iats button to the Custom Buttons area of the page layout. 4. Click Related Lists and drag the iats Transactions and iats Customer Code related lists onto the page layout. If using the Recurring Donations object, add the Recurring Donations related list. Page 19 of 60

20 5. On the iats Customer Codes related list, click the wrench icon (Related List Properties) to customize the visible fields. We recommend including at least the following fields: Customer Code Direct Debit Reference Number (UK Direct Debit users only) Method of Payment Recurring Payment Status Recurring Payment Schedule Type Recurring Payment Amount Recurring Schedule Date Recurring Payment Begin Date Opportunity Page 20 of 60

21 Additional fields such as iats Account, Created Date, or Credit Card Number (will show only last 4 digits) will offer additional information if needed. 6. On the iats Transactions related list, click the wrench icon (Related List Properties) to customize the visible fields. We recommend including at least the following fields: Transaction ID Date Amount ($) Status iats Account Opportunity Currency (for multi-currency option) 7. Once the related lists have been edited, click Save. Page 21 of 60

22 7.2 Configure Opportunities (Donation) Object Page Layout 1. In Setup (click on your username and choose Setup), under the App Setup section select Customize then Opportunities and then Page Layouts, OR Click on Edit Layout in the Force.com quick access menu when in an Opportunity record, which is the blue arrow at the far right of the page if enabled. OR 2. If accessed via the Setup menu, click Edit for the active or current page to be customized. If there is more than one active page layout, you may need to repeat the following steps for each layout. 3. Click Buttons. Drag the iats button to the Custom Buttons area of the page layout. Page 22 of 60

23 4. If desired, a blank Section can be created to house the iats data. Click Fields and drag the following fields onto the page layout: Total Amount of Approved Transactions Total Number of Approved Transactions Total Number of Rejected Transactions iats - First Name iats - Last Name iats Address iats City iats State iats - Zip Code iats Country iats iats - Home Phone iats - Mobile Phone iats Fax If Aura is being utilized for online payments, please add the Aura Survey question answer boxes labeled iats - Item 1 to iats - Item 6 as indicated above. 5. Click Related Lists and drag the iats Transactions, iats Customer Code, and Payments (if being used with Brickwork), related lists onto the page layout. Page 23 of 60

24 6. On the iats Customer Codes related list, click the wrench icon (Related List Properties) to customize the visible fields. We recommend including at least the following fields: Customer Code Direct Debit Reference Number (UK Direct Debit users only) Method of Payment Recurring Payment Status Recurring Payment Schedule Type Recurring Payment Amount Recurring Schedule Date Recurring Payment Begin Date Opportunity Page 24 of 60

25 Note: Additional fields such as iats Account, Created Date, or Credit Card Number (will show only last 4 digits) will offer additional information if needed. 7. On the iats Transactions related list, click the wrench icon (Related List Properties) to customize the visible fields. We recommend including at least the following fields: Transaction ID Date Method of Payment Amount ($) Status iats Account Currency (for multi-currency option) 8. On the Payments related list, click the wrench icon (Related List Properties) to customize the visible fields. We recommend adding the following fields to the standard fields: Payment Amount Paid Payment Date Written Off Scheduled Date Related iats Transaction Related iats Transaction Status 9. Once the related lists have been edited, click Save. Page 25 of 60

26 7.3 Configure Recurring Donations Object Page Layout (Only if used with Brickwork) 1. In Setup (click on your username and choose Setup), under the App Setup section select Create then Objects. Locate the Recurring Donations package, and click its Label. Next, scroll down to locate the Page Layout section and click Edit beside Recurring Donation Layout. OR: 2. Click on Edit Layout in the Force.com quick access menu when in a Recurring Donation record, which is the blue arrow at the far right of the page if enabled. Page 26 of 60

27 3. Click Buttons, and drag the iats button into the Custom Buttons section. 4. Click Related Lists and drag the iats Customer Code related list onto the page layout. Page 27 of 60

28 5. On the iats Customer Codes related list, click the wrench icon (Related List Properties) to customize the visible fields. We recommend including at least the following fields: Customer Code Recurring Payment Status Recurring Payment Amount Method of Payment iats Account Contact Opportunity 6. Click Save. Page 28 of 60

29 7.4 Configure Payments Object Page Layout (Only if used with Brickwork) 1. In Setup (click on your username and choose Setup), under the App Setup section select Create then Objects. Locate the Contact & Organizations package, and click the Payment Label. Next, scroll down to locate the Page Layout section and click Edit beside the Payment Layout. OR: 2. Click on Edit Layout in the Force.com quick access menu when in a Payment record, which is the blue arrow at the far right of the page if enabled. Page 29 of 60

30 3. Click Fields and add the Related iats Transaction, and Related iats Transaction Status related list onto the page layout. 4. Click Save. Page 30 of 60

31 7.5 Configure iats Customer Codes Object Page Layout 1. In Setup (click on your username and choose Setup), under the App Setup section select Create then Objects and then iats Customer Code. Next, scroll down to the Page Layouts list, and click Edit beside iats Customer Code Layout. OR: 5. Click on Edit Layout in the Force.com quick access menu when in an iats Customer Code record, which is the blue arrow at the far right of the page if enabled. Page 31 of 60

32 6. Click Fields and drag the following fields onto the page layout: Recurring Donation Direct Debit Reference Number (UK Users Only) Direct Debit Registration Status (UK Users Only) Direct Debit Registration Error (UK Users Only) 7. Click Save. Page 32 of 60

33 8 Create iats Account(s) iats client Sub-codes and Passwords are stored as iats Accounts. Brickwork currently supports up to 10 Active iats Accounts (available for use in the Brickwork Virtual Terminal), and up to 99 Inactive iats Accounts (available for use with Aura Online Donation pages and the Download Journal import. Up to three unique iats Merchant Account (first for characters of Sub-code, ex: TEST) can be used within Brickwork. 1. Click on the iats Account tab, and click New to create a new iats Account. 2. Add a description to the Account Name field. This field name will be visible within Salesforce and Page 33 of 60 should describe the type of transactions. For example, TEST80 Aura Website. 3. Click the Active checkmark box if this code will be used within the Brickwork Virtual Terminal. All iats Client Codes that are being used within Brickwork or Aura should be added as iats Accounts, but only those you want visible within the Virtual Terminal need to be Active. There can be up to 10 Active iats Accounts. 4. Enter the Client Code and Password that was issued by iats Customer Care upon setup of your iats Merchant Account. Please note that if the password is changed in the future, it will need to be updated here to avoid iats connections problems. 5. The Primary checkbox enables one iats Account to be displayed as the default Account within the Brickwork Virtual Terminal. 6. Add a description of the iats Account for future reference. For example, Aura Online. 7. Select the appropriate iats System and Currency for the iats Merchant Account. Choose NA (North America) if the Account has been setup to accept Canadian Dollars or US Dollars. Choose UK (United Kingdom) if the Account has been setup to accept any other currency. 8. Click Save & New to create the new iats Account and move on to the next iats Client Code. 9. Optional Step: iats Accounts cannot be deleted once used to create iats Customer Codes or iats Transactions. To remove an iats Account from the Manual and Scheduled Nightly Download Journal reports, check the Do Not Include in Journal Download checkbox. This should generally only be used for an iats Account that is no longer in use.

34 9 Modify iats Settings iats Settings options customize how Brickwork and Aura communicate with your unique Salesforce environment. As of.15, Brickwork has four different settings options to determine how Brickwork handles your Recurring and/or Pledge donations. 1. Payments Integration - Multiple Payment Records related to one Opportunity: iats Customer Code related to Opportunity and all iats Transactions related to each Payment Record. ** Option of Opportunity (Donation) and Payments selected via the Recurring Donation Model field within the Non-profit Starter Pack Settings section within the iats Settings tab. 2. Recurring Donation Integration - Multiple Opportunities related to one Recurring Donation: iats Customer Code related to Recurring Donation and all iats Transactions related to individual Recurring Donation Record. ** Option of Recurring Donations and Opportunities (Donations) selected via the Recurring Donation Model field within the Non-profit Starter Pack Settings section within the iats Settings tab. 3. No Opportunity Records option: iats Customer Code and all iats Transactions related to Contact Record. ** Option selected via the Opportunity (Donation) Settings section within the iats Settings tab. 4. Standard iats option - One Nested Opportunity: iats Customer Code related to Opportunity Record and all iats Transactions nested within the Opportunity. ** Option of None selected via the Recurring Donation Model field within the Non-profit Starter Pack Settings section within the iats Settings tab. If you do not already have a pre-set method for recording Recurring and/or Pledge donations, we recommend reviewing the workflow diagram on Page 10 of this guide. Once you have chosen a recurring method, please follow the below iats Settings configuration instructions within the Opportunity (Donation) Settings and Nonprofit Starter Pack Settings sections below. Page 34 of 60

35 9.1 Opportunity (Donation) Settings The Opportunity (Donation) Settings section allows for customization of the Stage field on a new Opportunity when a related iats Transaction is approved or declined, the default Contact Role on a new Opportunity, and an option to include the value of the Amount field of an Opportunity within the Brickwork Virtual Terminal. 1. Select the appropriate Payment Accepted Stage and Payment Rejected Stage options to determine the stage settings when Brickwork creates a new Opportunity and relates either an Approved or Rejected iats Transaction. These options draw from the existing Opportunity Stage pick list within Salesforce. 2. Select a default Opportunity Role. This option will be utilized for all Opportunity/Donation records that are created by Brickwork. 3. The Do Not Automatically Populate Amount Field controls the amount field on the iats Virtual Terminal. If selected, the amount field will automatically populate with the amount of the Opportunity (Donation) record. This only applies to the Virtual Terminal located in the Opportunity object. 4. If desired, Brickwork can be configured to not automatically create Opportunity records. When the Do Not Automatically Create Opportunity (Donation) Records option is checked, records will not be created for Aura Online payments (Recurring or One-Time), or via the Download Journal import. ** Important **: If utilized, we STRONGLY recommend using Aura Field Mapping to ensure donor s data is recorded to Salesforce. 5. If utilizing the standard Recurring Payments method of creating one Opportunity/Donation Record and nesting all subsequent iats Transactions, you can now customize how the value within the Amount field is added when a new Opportunity/Donation Record is created when a new schedule is received via Aura. Selecting the Recurring Installment Amount option will use the amount the donor is being charged for each payment. Selecting the Total Recurring Value Amount option (default if None is selected), will post the total value of the entire recurring payment schedule. The amount is the result of the following calculation: ($ per installment) X (Schedule chosen) X (# of years until End Date) = Total Amount Value Page 35 of 60

36 9.2 Nonprofit Starter Pack Settings The Nonprofit Starter Pack (NPSP) Settings section enables the configuration between Brickwork and your installation of the Non Profit Starter Pack. 1. Select One-to-One (1 X 1 Model) or Individual (Bucket Model) depending on the Account Model of the Contacts and Organizations package your organization utilizes. For more information regarding Salesforce Account Models, please visit: 2. Select the appropriate Recurring Payments Model, depending on if your organization utilizes (or will be utilizing) the Recurring Donation Object, or the Payments Object of the NPSP. If you use neither, select None to utilize the iats Brickwork Standard model. 3. If you have chosen Opportunity (Donation) and Payments, additional customization options will become visible: For more information on how to enable Payments within NPSP s Contacts & Organizations, please click here. a) Check Create Scheduled Payment Records to activate the Payments Object integration. b) Select an iats Recurring Payments Date Change Action. This selection will determine what happens to Payment Records created for iats Transactions if changes to the recurring schedule on the iats Customer Code are made. c) Select a record limitation in the Scheduled Payment Records Limit pick list and add the limit itself in the Limit field. This sets the limit on how many future Payment Records are created for iats Transactions. d) To compensate for a bug within the Contact s and Organizations NPSP package, click on the Contact Settings tab (from the all tabs menu), at least once so that the related 'custom settings' records are created properly. 4. If you have chosen Recurring Donations and Opportunities (Donations), additional customization options will become visible: Page 36 of 60

37 For more information on how to enable Recurring Donations within the NPSP, please click here. **Important: The default stage for new donations (opportunity) records is based on the NPSP settings (custom labels). By default it is 'Pledged'. Brickwork references the custom label to determine what stage to set when creating new opportunities when using our Recurring Donations integration. To ensure future iats Transaction records are linked properly to new donations, please ensure the Stage type is an Open value, not a closed value such as Closed/Won or Closed/Lost. To view your current Stage Types, please click on Setup -> App Setup -> Opportunity -> Fields -> and click on Stage within the Opportunity Standard Fields section. a) Select the appropriate Recurring Donations Open Ended Status option, depending on how you would like the Recurring Donations to calculate and handle your recurring payments. For more information on each option, please click on the following Salesforce NPSP help text: b) Select an iats Recurring Payments Date Change Action. This selection will determine what happens to the Recurring Donation s Opportunity (Donation) Records that were created for iats Transactions if changes to the recurring schedule on the iats Customer Code are made. c) Checking the Pre-populated Virtual Terminal Recurring Fields box will enable the iats Virtual Terminal to be pre-populated with the Amount and Schedule details from the Recurring Donations Record. d) Click the Recurring Donations Settings link to open a new window containing the standard Salesforce settings page for the Recurring Donations Object. Brickwork will react to these settings, which prevents you from needing to repeat these options within iats Settings. Page 37 of 60

38 For more information about the Recurring Donation Settings, please click on the following NPSP help text: e) To compensate for a bug within the Recurring Donation NPSP package, click on the 'recurring donations settings' tab (from the all tabs menu), at least once so that the related 'custom settings' records are created properly. 9.3 Contact Match Settings The Contact Match Settings determine which details are used to match online Aura website donors to their existing Salesforce Contact Record. Basic Option Matches the Address field from Aura to any type field on the Salesforce Contact Record. Standard Option: Matches the First Name AND Last Name from Aura to the standard First Name and Last Name field, AND any field OR any Phone field on the Salesforce Contact Record. Example A: First Name, Last Name and match, but phone can be incorrect. Example B: First Name, Last Name and Phone match, but can be incorrect. Advanced Option: Matches Aura fields to the Salesforce Contact Record based on the logic selected within the Advanced Logic section. Advanced Match includes all Standard and Custom fields on the Salesforce Contact Record. Page 38 of 60

39 1. Select the preferred Contact Match Type. 2. If utilizing the Basic or Standard options, no additional setup is required. 3. If utilizing the Advanced option, the Brickwork Field equals Contact Field options will be displayed. Additional Row s can be added or removed via the Add Row and Remove Row options. If desired, custom Filter Logic can be utilized for added flexibility. For more information regarding working with Salesforce Filter Logic, please visit: The example below details an example of logic manipulation and how the donor s address can be used to match against multiple fields on the existing Contact record: Values used within the Contact Match process must match exactly, or no match will be found. For example, if a donor has the last name O Brien, the Last Name OBrien will not match and a new Contact Record will be created. Phone and field types are specially formatted Salesforce fields. These field types validate the data that it contains. For example, you cannot save coritest.com as it is missing symbol. Page 39 of 60

40 9.4 Aura Field Mapping By default, all donor data that is included on an online Aura donation form is posted to the iats/brickwork custom fields located on the Opportunity record, unless the new Do Not Automatically Create Opportunity (Donation) Records option is selected. The Aura Field Mapping option can be enabled and customized to map any Aura field data to any other Salesforce field on the Contact, Opportunity, iats Transactions, and iats Customer Code Records. If not utilized, all Aura fields will be added to the standard Brickwork fields on the Opportunity (unless the new Do Not Automatically Create Opportunity (Donation) Records option is selected). The following Salesforce field types can be utilized for Aura Field Mapping: All Text type fields All type fields All Phone type fields Pick list & Pick list multiple type fields (Please note the Aura field value will replace all existing Pick list multiple values that may currently be set on the destination Salesforce Record) Select the iats Account that has been stored within the Aura form on the Aura Setup. 2. Select the specific Aura Event form that requires custom field mapping. 3. The Brickwork Field, Object, Map Field and Do Not Update if Blank options will appear. a) Only those fields that are currently set as Visible on the Aura Form will be available within the Brickwork Field pick list. To modify which fields are visible on the Aura Form, please refer to the Aura Setup tab or log into and select the specific Aura Event by name. Page 40 of 60

41 b) Select the Salesforce Record (Object) that contains the field that Aura should map to. c) Select the desired field. 4. If desired, check the Do Not Update if Blank checkmark box. Unchecked: If this option is not checked, any empty (blank) mapped Aura fields will overwrite existing fields that may have previously contained data within Salesforce with a blank value. For example, this action would be desired for address fields because it will prevent the mixing of two different addresses: For example the donor s address is listed on their current Salesforce Contact record as: 123 Madison Ave., New York, NY If the donor enters their new address on the Aura form, but does not include his new Zip Code and State in error, the address would be transferred to Salesforce as: 555 Pine Street, San Francisco, BLANK BLANK If the Do Not Update if Blank checkmark was added to the Field Mapping Settings, the address for the donor would incorrectly read: 555 Pine Street, San Francisco, NY Page 41 of 60

42 The optimal result of this example would be an incomplete address, so that the donor can be followed up with to correct the address. Note: Checked: If this option is checked, the donor s Salesforce Record will not be overwritten with blank data from Aura fields when the Custom Map options are being utilized. This may be desired for certain fields such as Name, Phone and etc. For example, if the Aura form contains both the Phone and Fax fields and the donor leaves the fax number field blank, any existing Fax data contained for the donor on their Salesforce Contact record will not be removed and replaced with the blank Aura data. It is recommended to turn on History Track for mapped fields. This will provide a record of all fields that have been overwritten during the mapping process for reference purposes. If two different Aura fields are mapped to the same field within Salesforce, the second row value will be added as it takes precedence. For example: If the First Name is mapped first, and the Last Name is mapped second to the same field, only the Last Name will map to the desired field. Only custom Aura Field Mapping values are mapped to the Contact Record when a duplicate contact is found (via the Contact Match settings). Standard mapping (the mapping function for all non custom mapped fields) to the Contact Record will only occur when a new Contact Record is created. 9.5 Virtual Terminal Settings The Virtual Terminal Settings determine default options within the Brickwork Virtual Terminal. Page 42 of 60

43 1. The Terminal is configured to receive Credit Card data both manually and electronically via a USB swiper, but the preferred option can be saved for convince. Select either Manual or Swipe in the Default Credit Card Entry Mode. 2. The Select Create New Donation by Default checkmark option will default a checkmark in the Create new Donation option of the Virtual Terminal. This is useful for One-Time transactions when an Opportunity/Donation record should be created for every approved transaction. 9.6 Additional Settings The Additional Settings allow control of other functions such as the Brickwork/Aura error notifications and if the scheduled Nightly Download Journal sends a notification after being run each day. Both options are recommended. Page 43 of 60

44 10 Schedule the Nightly Download Journal Import The Download Journal enables Brickwork to retrieve an iats Journal report containing all transaction data processed the prior day. This feature ensures that all recurring transactions are recorded in Brickwork the day after they have been processed. Only System Administrator s are permitted to schedule the Download Journal. Please note that if the Salesforce User who creates the Apex Class is set to Inactive or deleted from Salesforce, the nightly Download Journal will no longer run, and will need to be rebuilt by the new Admin. 1. In Setup (click on your username and choose Setup), under the App 2 5 Setup section select Develop 3 then Apex Classes, and click the Schedule Apex button. Name the 4 job iats Nightly Download Journal. 2. Click the Apex Class look up button and select IATSPayments_journal_log. 3. Set the Frequency as Weekly. 4. Check off each day of the week. 5. The Start Date will default to today, 6 but be sure to select an End Date in the future. We recommend at least 7 5 years. There is no restriction on future End Date. 6. Set the Preferred Start Time. Please select a time between 6am 8 and 7pm. Note: Internal iats updates and maintenance may occur between 11:00pm and 3:00am nightly. Setting the Preferred Start Time during this window is not recommended. Salesforce/Brickwork Multicurrency users are recommended to schedule the start time between 10-11am GMT to ensure the prior day s report has been created in both the UK and North American time zones. 7. Click Save to register the new Apex Schedule. 8. If desired, you can receive daily notifications regarding the import by checking the Download Journal Notification option within the iats Settings tab. Note: the will be sent for each 1000 imported records (as of version ). Page 44 of 60

45 11 Aura and Aura/Link Online Integration (Optional) Aura and AuraLink refer to the secure online donation web form which integrates seamlessly into an existing website. Aura and AuraLink have built-in integration with Brickwork, and are connected via a Salesforce Site URL. A secure Salesforce Site is created by following the below steps, and should be added as the Post Back URL within the Aura or AuraLink donation page. As of Version Brickwork Online Aura processing can be integrated with Salesforce Campaigns, and the Contact and Opportunity Record types. For more information on how to create an Aura or AuraLink donation page, please refer to the Aura Installation Guide or AuraLink documentation information which can be obtain from our website Create a Salesforce Site: 1. Within Setup (click on your username and choose Setup) locate the App Setup section. 2. Within Develop, select Sites. 3. If you haven t already done so, type a unique sub-domain, accept terms and conditions, and click Register My Force.com Domain. If you already have at least one site already created, skip to step Click New in the Site section of the page to create a new Site. 5. Enter a Site Label, Site Name, Side Description and Site Contact. 6. Enter a URL suffix in the Default Web Address text box. 7. Click the look up icon beside Active Site Home page. 8. In the pop-up window, scroll down and select Aura. Page 45 of 60

46 9. Click Save. This displays a summary of the new Site ( Site Detail ) noting the user name, site URL and label, and other details. 10. Select the Active checkbox. 11. Right click on the Site URL field, and Copy Link Address. 12. Paste the Site URL into the Post Back URL field on the Event Info tab within your Aura page (via Aura Set-up on the iats website ). Page 46 of 60

47 12 Integrate Aura online processing with Campaign ID s and/or Record Types Online Aura processing can be integrated with Salesforce Campaigns, and configured to utilize certain Contact and Opportunity Record types within Salesforce (available in Brickwork Version and higher only). When a Transaction is processed via an Aura webpage that is connected to Salesforce, iats will pass certain variables and ID s to Salesforce that allow the Opportunity/Donation to be linked to a specific Campaign, and for new Contacts and Opportunities to be assigned a specific Record Type. This can be done via three different methods: Method 1. Add Campaign ID and/or Record Type ID s onto the URL of the Donate button or link which hosts the embedded Aura box. This method will ensure all iats Transaction data processed via this Aura webpage will be assigned the specified values. Method 2. Add Campaign ID and/or Record Type ID s onto the end of the Salesforce Site within Aura Setup while creating the Aura event on the iats website. If using Aura Connect for Facebook, this is the option which should be used. This method will ensure all iats Transaction data processed via this specific Aura webpage will be assigned the specified values. Note: Adding the ID s via this method will not transmit ID information to the iats Download Journal Report, which is necessary for iats to relate records via the Download Journal in the future if needed. Method 3. Add Campaign ID and/or Record Type ID s onto the end of a URL, such as included within an blast, or Facebook Ad. This method allows for the flexibility of receiving different ID information from donors via one Aura webpage. For this method to function properly, please ensure there are no other ID s added as per method 1 and 2 above. The Variables that will be used in the following instructions: Opportunity Primary Campaign ID variable: caid Contact Record Type ID variable: cortid Opportunity Record Type ID variable: oprtid Page 47 of 60

48 12.1 Method 1 - Add Campaign ID and/or Record Type ID s onto the web page Button/link URL 1. Create an Aura donation page by following the instructions within the Aura User Guide. If an Aura donation page is already hosted on your website, skip this step. 2. Obtain the Salesforce Campaign Record ID by going to the Campaign within Salesforce and copying the ID number listed after the Salesforce web address from the URL. 3. Example: 4. Add the Campaign ID and variable onto the end of the URL for the Donate button or link to the website that hosts the Aura payment box by modifying the coding of the button or link. This step may need to be completed by a Web Developer. 5. As per the example below, the first character after the URL link should be a question mark, followed by the Campaign ID variable caid, then an equals sign and the ID itself. 6. Example: 7. If desired, a Contact and/or Opportunity Record Type can also be added by using the Record Type ID variables cortid and oprtid described below. When adding a second variable ID into the URL link, they must be separated by an ampersand. Example: 0zJ6O&oprtid=012A zJ6Y 8. Processing a test transaction through the Aura page is recommended to ensure the correct Campaign and/or Record types are functioning as expected. Note: If an incorrect ID (does not exist for example) is used, the Opportunity and Contact records will not be related to any Campaign and will display the Salesforce defaulted Record type instead Method 2 - Add Campaign ID and/or Record Type ID s onto the Salesforce Site 1. Create an Aura donation page by following the instructions within the Aura User Guide. If an Aura donation page is already hosted on your website, skip this step. 2. Obtain the Salesforce Campaign Record ID by going to the Campaign within Salesforce and copying the ID number listed after the Salesforce web address from the URL. Example: 3. Add the Campaign ID and variable onto the end of the Salesforce Site URL, in the Post Back URL Field of Aura Setup. Example: Page 48 of 60

49 4. As per the example below, the first character after the URL link should be a question mark, followed by the Campaign ID variable caid, then an equal s sign and the ID itself. Example: 5. If desired, a Contact and/or Opportunity Record Type can also be added by using the Record Type ID variables cortid and oprtid described below. When adding a second variable ID into the Salesforce Site URL, they must be separated by an ampersand. Example:?caid=701A dzhU&cortid=012A zJ6O&oprtid=012A zJ6Y 6. Processing a test transaction through the Aura page is recommended to ensure the correct Campaign and/or Record types are functioning as expected. Note: If an incorrect ID (does not exist for example) is used, the Opportunity and Contact records will not be related to any Campaign and will display the Salesforce defaulted Record type instead. Page 49 of 60

50 12.3 Method 3 - Add Campaign ID and/or Record Type ID s on URL hyperlink 1. Create an Aura donation page by following the instructions within the Aura User Guide. If an Aura donation page is already hosted on your website, skip this step. 2. Obtain the Salesforce Campaign Record ID by going to the Campaign within Salesforce and copying the ID number listed after the Salesforce web address from the URL. Example: 3. Copy and paste the donation page URL into the body of an (for example). 4. Add the Campaign ID and variable onto the end of the pasted URL hyperlink. 5. As per the example below, the first character after the URL link should be a question mark, followed by the Campaign ID variable caid, then an equal s sign and the ID itself. Example: Page 50 of 60

51 6. If desired, a Contact and/or Opportunity Record Type can also be added by using the Record Type ID variables cortid and oprtid described below. When adding a second variable ID into the URL hyperlink, they must be separated by an ampersand. Example: 0zJ6O&oprtid=012A zJ6Y 7. When the URL is clicked, the donor will be directed to the Aura hosted webpage, and the ID s entered will be displayed in the URL of the site, and pushed to iats/salesforce with the transaction details. 8. Processing a test transaction through the URL hyperlink is recommended to ensure the correct Campaign and/or Record types are functioning as expected. Note: If an incorrect ID (does not exist for example) is used, the Opportunity and Contact records will not be related to any Campaign and will display the Salesforce defaulted Record type instead. Page 51 of 60

52 13 How To: Import iats Customer Codes into Salesforce Some client s may choose to import existing IATS Customer Codes from the iats servers directly into Salesforce. The following instructions detail how this process is done Create necessary Salesforce records Certain Salesforce records needs to be created so that they can be related to the new iats Customer Code record during the import. If not already done, the following list of Records should be created: iats Account (Brickwork record of iats Merchant Account details) Required Contacts Optional but recommended Opportunity/Donations Optional but recommended Account/Households Optional 1. Log into Salesforce as an administrator. 2. Create or obtain the iats Account Name field (Example NA test ). 3. Create/Import Contact Records and export their ID s. 4. Create/Import Opp Records and export their ID s. If the above records have already been created, simply obtain the Salesforce Record ID. Page 52 of 60

53 13.2 Prepare Import Spreadsheet 1. Export Customer Code data from the Client Database found within the iats website: a) Log into the iats website. b) Click on the button Client DB to access the Customer Details. c) Click the Export button to export all data saved within the iats Customer Codes. d) Delete unnecessary columns so that only the below fields are included: Customer Code Required Credit Card Type Required if CC Credit Card Number and/or ACH Account Number Required Credit Card Expiry Date Required if CC ACH Account Type Required if ACH Recurring Dollar Amount Optional Recurring Status Optional Recurring Begin Date Optional Recurring End Date Optional Recurring Schedule Type Optional Recurring Schedule Date Optional 2. Add three new columns to house the Salesforce Contact Record ID s, the Salesforce Opportunity/Donation ID s and the Salesforce iats Account Name field (The field from Brickwork that relates to the applicable iats Client Sub-Code that has been used to create/store the Customer Code details within the iats servers. If you are unsure which iats Account to use, please contact iats Customer Care for assistance ). 3. Replace the iats column headers with the details from the table below. This ensures that the iats fields will map to the Salesforce iats Customer Code fields correctly during the import process. iats Client Database Field Name CustomerCode Method of Payment Add manually (CC or ACH) CardType Account or Card Number ExpiryDate(MM/YY) AccountType Account or Card Number Amount Reoccuring BeginDate(mm/dd/yyyy) EndDate(mm/dd/yyyy) Salesforce iats Customer Code Field Name Customer Code Method of Payment Credit Card Type Credit Card Number Credit Card Expiry Date ACH Account Type ACH Account Number Recurring Payment Amount Recurring Payment Status Recurring Payment Begin Date Recurring Payment End Date Page 53 of 60

54 ScheduleType ScheduleDateNumber(Weekly/Monthly Only) N/A N/A N/A N/A Recurring Payment Schedule Type Recurring Payment Schedule Date iats Account Name Contact ID Opportunity ID Account ID 4. Your spreadsheet should now approximately reflect the below screenshot. The columns highlighted in Red are fields obtained from Salesforce. Please note that certain fields may not be needed for your import, such as recurring schedule data if you are not utilizing these fields currently Perform a Salesforce Custom Object Import: 1. In Setup (click on your username and choose Setup), under the Administration Setup section select Data Management then Import Custom Objects. 2. The following screen (next page) details FAQ s regarding the Salesforce Import Wizard, and information on what to do before attempting an import. Please review these details carefully as importing Custom Objects cannot be undone or mass deleted. 3. When ready, click the Start the Import Wizard! button. As indicated, it is recommended to perform a small test batch to ensure the.csv file has been created properly and that there are no missing fields. Page 54 of 60