Installation and Configuration Guide for

Transcription

1 Installation and for Brickwork Version: Last Updated: March 17 th, 2017

2 Table of Contents 1 Document Version Contact Information Overview of Brickwork Install Process and Features Installation Process Workflow: Custom Objects and Features of Brickwork Installation Pre-Requisites Part 1 - Brickwork Installation Part 2 - Configure Page Layouts and iats Settings Configure Contact Page Layout Configure Opportunities (Donation) Page Layout Configure Recurring Donations Page Layout (Only if being integrated with Brickwork) Configure Payments Page Layout (Only if being integrated with Brickwork) Configure iats Customer Codes Page Layout Configure iats Transaction Page Layout if using NPSP Payments Create iats Merchant Account(s) Modify iats Settings Opportunity (Donation) Settings Non-Profit Success Pack Settings Contact Match Settings Aura Field Mapping Virtual Terminal Settings Additional Settings Schedule the Nightly Download Journal Import Edit the Nightly Download Journal Batch Size (Optional) Transaction Workflow Logic: NA ACH/EFT Returns Workflow Logic UK Direct Debit BACS Returns Workflow Logic Download Journal Notification Templates: Page 2 of 67

3 9.5.1 Logic of functionality: Integrate an Online Donation Form (Aura or Form Assembly) Create a Salesforce Site URL: Connect an Aura or AuraLink form to Brickwork Connect a Form Assembly donation page to Brickwork: Aura to Salesforce Post Error Notification Modify NPSP Trigger s to accommodate for Brickwork 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 (Recommended) 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 Installation checklist How To: Import iats Customer Codes into Salesforce Create necessary Salesforce records Prepare Import Spreadsheet Import Existing iats Customer Codes (Optional) Page 3 of 67

4 1 Document Version Document Change Date of Change: Added references to new Form Assembly integration Updated iats Settings images and added details for new Pending March 17 th, 2017 ACH opty stage. Added instructions for modifying the Download Journal APEX Class batch size. Replaced references to Nonprofit Starter Pack with Success Amended NPSP Trigger changes to include new value of User Alias as per changes to NPSP Replaced images of Virtual Terminal to include new Edit expiry date feature. April 15 th, 2016 Added Best Practices details throughout guide. Updated Import Customer Codes section to use the Data Import Wizard tool from Salesforce. 4.5 Addition of iats Returns object to track ACH/EFT Return notices and UK Direct Debit BACS reports (section ). Sep 8 th, 2015 Page 4 of 67

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 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 version of this Brickwork Installation &, the Brickwork User Guide, and our Aura Guides please visit 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 67

6 3 Overview of Brickwork Install Process and Features 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 in person, via the phone or through your website, Brickwork enables your organization to process credit card and ACH/EFT payments and maximize your revenue. With the ability to process both 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 Nonprofit Success Pack, including the Recurring Donations and Payments objects, and all three Account date models (Household, One-to-One, and Individual/Bucket). For more information on Brickwork processing best practices and how Brickwork functions please refer to the Brickwork User Guide which can be downloaded by clicking here. Please also take a look at our Brickwork Video Series, found here. 3.1 Installation Process Workflow: Read Installation and Customization Guide & Download Brickwork Complete Page Layout changes to display Brickwork fields, buttons, and related lists Create iats Merchant Accounts & Customize iats Settings tab Schedule Nightly Download Journal APEX Class and Salesforce Site URL for Aura Online donation form or Universal Postback Read and follow Brickwork User Guide to complete testing and Staff Training New: See our handy checklist, Section 12! Page 6 of 67

7 3.2 Custom Objects and Features of Brickwork iats Merchant Accounts iats Client Codes and passwords are stored as iats Merchant Accounts, which replaces the need for traditional Merchant numbers. Brickwork supports an unlimited number of iats merchant accounts (4 digit Client Code), and up to 99 unique iats SubCodes (for example TEST88), 10 of which can be Active for manual use within in the Brickwork Virtual Terminal. For more information on iats Client Codes, please contact us at iats Customer Codes iats Customer Codes are unique tokens that represent the donors payment information and recurring schedule details which have been securely stored within the iats servers. The last four digits of the Credit Card and/or bank account and related recurring details are displayed. The Brickwork Virtual Terminal can be used to create these tokens, and make any necessary edits in the future. Page 7 of 67

8 iats Transactions iats Transactions are individual Credit Card or ACH/EFT transactions which have been processed via your 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 67

9 Brickwork Virtual Terminal Also known as the iats Button, the Brickwork Virtual Terminal is used to charge Single Credit Card or ACH/EFT transactions, to schedule Recurring Credit Card or ACH/EFT/Direct Debit transactions, and to amend all saved payment details and schedule details within an iats Customer Code. Additional Virtual Terminal features: Manual or non-encrypted USB 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. (Contact iats at to purchase a non-encrypted MagTek Dynamag USB swiper for use with Brickwork) Create iats Customer Codes and Opportunity (Donation) records directly within the terminal. Can be added to the Contact, Opportunity, Recurring Donation record, and/or Account objects. Page 9 of 67

10 iats Settings The iats Settings tab is where all customizations are set to tell your unique Salesforce environment how Virtual Terminal and Aura transactions should be handled by Brickwork (Stage, Contact Role, etc) and if the Nonprofit Start Pack applications are being used. For more information about the Nonprofit Success Pack, including information on the Recurring Donations App and the Payments Object (within the Contacts & Organizations App) please visit the following links: General NPSP: NPSP Doc s: Page 10 of 67

11 Online Donation Web Form Integrations (Aura or Form Assembly) Included with Brickwork is the ability to received online donations automatically within Salesforce. You have the choice of using our Aura tools, or as of Fall 2016 our integration with Form Assembly and the Universal Postback feature. Aura and AuraLink refer to the secure online donation web form which integrates seamlessly into an existing website, and connects to Salesforce using Sites. Aura and AuraLink have built-in integration with Brickwork to ensure that all online transactions are imported into Salesforce automatically. For more information about how to build an Aura online donation form, please refer to the Aura Installation Guide, which can be downloaded at, or the AuraLink documentation which is available by contacting iats Customer Care With FormAssembly's iats Connector, you can easily process one-time credit card payments, set up recurring credit card payments through subscriptions, process ACH or Direct Deposit payments, and create new records in Salesforce iats Brickwork. For more information on how to use the FA iats Connector with Brickwork, please refer to our instructions in this document and at Form Assembly. Page 11 of 67

12 Download Journal Import The Manual or Automated Download Journal retrieves an iats Journal report containing all transaction data processed the prior day, or for a span of dates. This ensures all recurring iats Transactions are imported within your Salesforce environment as iats Transactions. For more information on how the Download Journal process works, please refer to the visual workflow diagram within the Brickwork User Guide. Multi-Currency Integration Brickwork is fully compatible with the Multi-Currency features within Salesforce. For more information on how choose a Multi-Currency option, please visit: Campaign and Record Type Integration Online Aura form processing (Opportunity/Donations & Contacts) can be customized to use specific Record types or be related to specific Campaigns within Salesforce if required. Campaign ID s and Contact and Opportunity Record Type ID integration can be added to your Aura donation form in three different ways to provide maximum flexibility. For complete instructions on how to associate Aura online processing to Campaigns and assign Record Types, please see the Integrate Aura online processing with Campaign ID s and/or Record Types section of this guide. Cumulative Roll-up Fields on the Opportunity The Opportunity can be customized to include Brickworks roll-up fields Total Number of Approved Transactions, Total Number of Rejected Transactions, and Total Amount of Approved Transactions. Note: The trigger that updates these fields in real-time can be disabled via the Custom Settings page for Brickwork within the Setup menu of Salesforce to allow only the nightly update to occur. Instructions on this can be found within the Brickwork User Guide, Section 9.5. Page 12 of 67

13 Recurring Payment Tracking Options As of Version 4, Brickwork is fully integrated with the Payments and Recurring Donations objects within the Nonprofit Success Pack to record and organization recurring payments! We now offer four unique methods of recording recurring transaction and Opportunity data. Before configuring Brickwork, please review the below options: 1. Standard iats option - One Opportunity with multiple iats Transactions: When Brickwork is installed this is the default method to record all online Aura recurring transaction and Opportunity data. In this method, iats Customer Codes are created to store the payment and schedule details so that iats can automatically process future iats Transactions. Each Customer Code is then related to one new Opportunity Record. All future transactions (approved or rejected) for that donor s recurring schedule will be processed by iats and imported into Salesforce and related to that single Opportunity. 2. NPSP Payments Integration - Multiple Payment Records are created and related to one Opportunity: When the NPSP Payments option is enabled and selected within iats Settings, an iats Customer Code (to store the payment details and recurring schedule) and Payment records are created automatically and related to one new Opportunity Record. All future transactions (approved or rejected) for that donor s recurring schedule will be processed by iats and imported into Salesforce as individual iats Transactions and then related to the correct Payment record based on Date and Amount. Each Payment record will be marked as Paid based on the approval status of the iats Transaction. You can also enable rejected transactions to be marked as Withdrawn via iats Settings. Note: All single/one-time online transactions will have one Opportunity and one Payment record created for reporting purposes. 3. NPSP Recurring Donation Integration - Multiple Donations (Opportunities) related to one Recurring Donation record: When the NPSP Recurring Donations option is enabled and selected within iats Settings, an iats Customer Code (to store the payment details and recurring schedule) and Recurring Donation record is created automatically by Brickwork for all Aura online donations. As per the Recurring Donation settings, multiple child Donation (Opportunity) records will be created with the stage of Pledged and related to the parent Recurring Donation. All future transactions (approved or rejected) for that donor s recurring schedule will be processed by iats and imported into Salesforce as individual iats Transactions and related to the correct child Donation record based on Date and Amount. Each Donation record will be marked as Posted based on the approval status of the iats Transaction. Note: All single/one-time online transactions will have one Opportunity record created as NPSP Recurring Donation s are used to record recurring transactions only. 4. No Opportunity Records option: With this option, you re asking Brickwork to not utilize either the NPSP or Opportunity records at any time. For this method, iats Customer Codes are created and related to the Contact Record. All future transactions (approved or rejected) for that donor s recurring schedule will be processed by iats and imported into Salesforce as individual iats Transactions and related to that iats Customer Code and Contact Record only. Opportunities will not be created by Brickwork at any time. To watch our video for an overview of the Brickwork Recurring Payment options here! Page 13 of 67

14 Do you plan to accept recurring payments in addition to one-time transactions? Yes No Do you use the Nonprofit Success Pack? Download Brickwork Application only and use the None recurring payments option Yes No Do you use the Recurring Donation object to record all recurring details? No Yes No Do you utilize the Payments object to record all recurring details? Yes Download Brickwork & our NPSP Recurring Donation add on Extension. Select the Recurring Donation option within iats Settings. Download Brickwork & our NPSP Payments add on Extension. Select the Payments option within iats Settings. Page 14 of 67

15 iats Returns Launched in September 2015, Brickwork now includes a new custom record called iats Returns. These records are automatically imported from to Salesforce via the Brickwork Nightly Download Journal process, providing added visibility into returned NA ACH/EFT and UK Direct Debit iats Transactions. Where you previously needed to review the iats Portal or the Smart Debit UK website, now your data is where you need it within Salesforce! For more information on iats Returns, please see Section 10 of the Brickwork User Guide. (NEW) iats Universal Postback The new iats Universal Postback feature allows our Partner s online donation processing to flow seamlessly to your Salesforce environment via Brickwork! This means that now you can connect your third party app like a Form Assembly Donation form to iats for processing, but also take advantage of Brickwork s connection to the Nonprofit Success Pack for Recurring Donations! ** Each Partner has a unique way of connecting to iats for processing. Please refer to their product manuals for further information on how to setup their tools to connect with iats. For more information on how to use a Partner donation form with Brickwork, please review the Online Form Integration, section 10. Page 15 of 67

16 4 Installation Pre-Requisites The following account credentials are recommended in addition to installing Brickwork to ensure complete set- up and testing. For a video walkthrough of most Installation steps, check out our video! 1. If using the NPSP Recurring Donation Object with Brickwork To utilize the Recurring Donations object with Brickwork and Aura, you must have the Recurring Donations option enabled within your NPSP Settings, and have our NPSP Recurring Donation add-on extension downloaded. Please click here to download the Nonprofit Success Pack 'Recurring Donation' extension package from our website. 2. If using the NPSP Payments Object with Brickwork To utilize the Payments object with Brickwork and Aura, you must have the Payments option enabled within your NPSP Settings, and have our NPSP Payments add-on extension downloaded. Please click here to download the Nonprofit Success Pack 'Payments' extension package from our website. 3. Obtain an Merchant Account An iats Offline Client Code (ends in 01) is required to fully configure and test iats Transactions within the Brickwork Virtual Terminal. 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: For more information regarding setting up an iats Merchant Account or obtaining temporary test credentials, please contact iats Sales. Page 16 of 67

17 5 Part 1 - Brickwork Installation 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 to an administrator account or one with administrator permissions. You can choose to download Brickwork within your Sandbox, or a Production environment/developer Edition. 4. Once logged in, confirm the installation details and Terms and Conditions. 5. Click Continue on the Package Installation Details screen. You may 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. ** If you have chosen to utilize the standard Brickwork recurring tracking options, or the no Opportunity option, you can continue to the next page for Part 2 Configure Page Layouts and iats Settings. ** If you have chosen to use Brickwork with the Nonprofit Success pack s Recurring Donation or Payment object, please continue onto step 11: 11. If will be using the NPSP Recurring Donation or Payments objects with Brickwork, proceed with downloading our Brickwork add on extensions here. If already logged into Salesforce, you may find it easier to right click on the extension links from our website, and copy/paste them into a new browser URL bar. Congratulations! You have successfully installed the Brickwork App! ** 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 67

18 6 Part 2 - Configure Page Layouts and iats Settings In order to follow iats processing recommendations, 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 Standard to Salesforce Opportunities (Donation) Standard to Salesforce iats Customer Code Brickwork Custom Object iats Transactions Brickwork Custom Object iats Merchant Accounts Brickwork Custom Object iats Settings Brickwork Custom Object NPSP Recurring Donations Part of the Nonprofit Success Pack (Optional) NPSP Payments Part of the Nonprofit Success Pack (Optional) iats Aura Setup (Optional) Brickwork Custom Object Please note: 1. 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 layout. 2. The field Comment on the Aura donation form will automatically map to the description field when Brickwork creates a Contact or Opportunity record. Page 18 of 67

19 6.1 Configure Contact Page Layout 1. In the Setup menu (click on your username and choose Setup, or click the Setup button if using the Enhanced Setup Menu option) search for Contacts in the search bar in the top left. 2. Click on Page Layouts. 3. 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. 4. Click Buttons. Drag the iats button to the Custom Buttons area of the page layout. 5. 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 67

20 6. On the iats Customer Codes related list, click the wrench icon (Related List Properties) to customize the visible fields. We recommend adding the following fields to the current list: 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 Additional fields such as iats Merchant Account, Created Date, or Credit Card Number (will show only last 4 digits) will offer additional information if needed. ** To prevent users from creating new iats Customer Code records outside of the Virtual Terminal or Aura processes, we highly recommend removing the New iats Customer Code button from the related list if visible. 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 Amount ($) Status iats Merchant Account Opportunity Currency (for multi-currency option) 8. Once the related lists have been edited, click Save. Page 20 of 67

21 6.2 Configure Opportunities (Donation) Page Layout 1. In the Setup menu (click on your username and choose Setup, or click the Setup button if using the Enhanced Setup Menu option) search for Opportunities in the search bar in the top left. 2. Click Page Layouts. 3. 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. 4. Click Buttons. Drag the iats button to the Custom Buttons area of the page layout. 5. 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 iats Item 1 iats Item 4 iats Item 2 iats Item 5 iats Item 3 iats Item 6 Description Page 21 of 67

22 6. 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 22 of 67

23 7. 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 Note: Additional fields such as iats Merchant Account, Created Date, or Credit Card Number (will show only last 4 digits) will offer additional information if needed. ** To prevent users from creating new iats Customer Code records outside of the Virtual Terminal or Aura processes, we highly recommend removing the New iats Customer Code button from the related list if visible. 8. 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 Merchant Account Currency (for multi-currency option) 9. OPTIONAL - If using the iats Brickwork/Payment Record integration to record recurring and single transactions, please complete the following instructions: 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 Page 23 of 67

24 Payment Date Written Off Scheduled Date Related iats Transaction Related iats Transaction Status 10. Once the related lists have been edited, click Save. Page 24 of 67

25 6.3 Configure Recurring Donations Page Layout (Only if being integrated with Brickwork) 1. In the Setup menu (click on your username and choose Setup, or click the Setup button if using the Enhanced Setup Menu option) search for Objects in the search bar in the top left. 2. Locate the Recurring Donations object, and click its Label. 3. Next, scroll down to locate the Page Layout section and click Edit beside Recurring Donation Layout. 4. Click Buttons, and drag the iats button into the Custom Buttons section. 5. If desired, a blank Section can be created to house the iats data. Click Fields and drag the following fields onto the page layout: iats - First Name iats - Last Name iats Address iats City iats iats - Home Phone iats - Mobile Phone iats Fax iats State iats Item 4 iats - Zip Code iats Item 5 iats Country iats Item 6 iats Item 1 iats Item 2 iats Item 3 Page 25 of 67

26 6. Click Related Lists and drag the iats Customer Code related list onto the page layout. 7. 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 Merchant Account Contact Opportunity ** To prevent users from creating new iats Customer Code records outside of the Virtual Terminal or Aura processes, we highly recommend removing the New iats Customer Code button from the related list if visible. 8. Click Save. Page 26 of 67

27 6.4 Configure Payments Page Layout (Only if being integrated with Brickwork) 1. In the Setup menu (click on your username and choose Setup, or click the Setup button if using the Enhanced Setup Menu option) search for Objects in the search bar in the top left. 2. Locate the Payment object, and click on its Label. 3. Next, scroll down to locate the Page Layout section and click Edit beside the Payment Layout. 4. Click Fields and add the Related iats Transaction, and Related iats Transaction Status related list onto the page layout. 5. Click Save. Page 27 of 67

28 6.5 Configure iats Customer Codes Page Layout 1. In the Setup menu (click on your username and choose Setup, or click the Setup button if using the Enhanced Setup Menu option) search for Objects in the search bar in the top left. 2. Locate the iats Customer Codes object, and click its Label. 3. Next, scroll down to the Page Layouts list, and click Edit beside iats Customer Code Layout. 4. Click Fields and drag the following fields onto the page layout: Recurring Donation (if being integrated with Brickwork) Direct Debit Reference Number (UK Users Only) Direct Debit Registration Status (UK Users Only) Direct Debit Registration Error (UK Users Only) 5. Click Save. Page 28 of 67

29 6.6 Configure iats Transaction Page Layout if using NPSP Payments 1. In the Setup menu (click on your username and choose Setup, or click the Setup button if using the Enhanced Setup Menu option) search for Objects in the search bar in the top left. 2. Locate the iats Transactions object, and click its Label. 3. Next, scroll down to the Page Layouts list, and click Edit beside Transaction Layout. 4. Click Related List and drag the Payments Related List onto the page layout if using Brickwork with the NPSP Payments object. 5. Click Save. Page 29 of 67

30 7 Create iats Merchant Account(s) iats merchant account credentials are stored as Sub-codes and Passwords within iats Merchant Accounts. Ten iats Merchant Accounts can be checked as Active and will be available for use in the Brickwork Virtual Terminal. All other iats Merchant Accounts can be left unchecked and are still available for use with Aura Online Donation pages and the Download Journal import process. An unlimited number of iats Merchant Accounts (first for characters of Sub-code, ex: TEST) can be used within Brickwork. 1. Click on the iats Merchant Account tab, and click New to create a new iats Merchant Account. 2. Add a description to the Account Name field. This field name will be visible within Salesforce and 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 Merchant Accounts, but only those you want visible within the Virtual Terminal need to be Active. There can be up to 10 Active iats Merchant 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 Merchant Account to be displayed as the default Account within the Brickwork Virtual Terminal. 6. Add a description of the iats Merchant 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 Merchant Account and move on to the next iats Client Code. 9. Optional Step: iats Merchant Accounts cannot be deleted once used to create iats Customer Codes or iats Transactions. To remove an iats Merchant Account from the Manual and Scheduled Nightly Download Journal import processes, check the Do Not Include in Journal Download checkbox. This should generally only be used for an iats Merchant Account that is no longer in use, such as a Test account. Page 30 of 67

31 8 Modify iats Settings iats Settings options customize how Brickwork, Aura, and the Virtual Terminal iats button communicate with your unique Salesforce environment and the Nonprofit Success Pack application if installed. 8.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 either approved, declined, or pending; 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 from an online Aura form and relates either an Approved or Rejected iats Transaction. If you will be accepting ACHEFT type transactions, you have the option of stating that all ACH transactions are marked as Pending until Brickwork obtains the final results from iats via the nightly download journal import. By default, ACH Single Transactions are posted to Salesforce immediately with a transaction status of OK:55555 and a related Opportunity Stage of your closed won option determined in iats Settings. Set the Stage if iats Transaction is Pending to a custom Opportunity Stage you ve created, such as Pending ACH Transaction. The stage will be set to the approved or rejected status once the final results are known. Recurring ACH transactions are not affected and are only imported once the final status is known. Page 31 of 67

32 These options draw from the existing Opportunity Stage pick list within Salesforce and can be customized by your SF Administrator. 2. Select a default Opportunity Contact Role. This option will be utilized for all Opportunity/Donation records that are created by Brickwork for online Aura form or offline Virtual Terminal processing. 3. The Do Not Automatically Populate Amount Field controls the amount field on the iats Virtual Terminal. If left unchecked (recommended), 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 record. 4. If desired, Brickwork can be configured to not automatically create Opportunity records, as per the No Opportunity recurring tracking option. When the Do Not Automatically Create Opportunity (Donation) Records option is checked, opty records will not be created for Aura Online payments (Recurring or One-Time), or via the Download Journal import. Do not check this if using the Nonprofit Success Pack. ** Important **: If utilized, we STRONGLY recommend using Aura Field Mapping to ensure donor s data is recorded in Salesforce. 5. If utilizing the iats standard recurring tracking method of creating one Opportunity/Donation Record and relating all subsequent iats Transaction records to it, 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. This is the recommended option; however both options should be reviewed to confirm which is most appropriate for your organization. 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 32 of 67

33 8.2 Non-Profit Success Pack Settings The Nonprofit Success Pack Settings section enables the configuration between Brickwork and the NPSP. 1. Select One-to-One, Individual (Bucket Model), or Households depending on the Account Model of the NPSP your organization utilizes. You can determine which model you are using from the NPSP Settings tab. 2. Select the appropriate Recurring Payments Model, depending on if your organization utilizes (or will be utilizing) the Recurring Donation or Payments Object of the NPSP to track your recurring iats Transactions. If you use neither, select None to utilize the iats Brickwork Standard model. Note: If you haven t decided which option you will be using, we recommend reviewing the NPSP Documentation to see which option works best for your organization. 3. If you have chosen Opportunity (Donation) and Payments, additional customization options will become visible: 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 future Payment Records created for iats Transactions if changes to the recurring schedule on the iats Customer Code are made. We recommend using Payment Creation and Delete. c) Check Update Rejected Transaction Payment to Written Off if you would like Brickwork to check that option if the iats Transaction is Rejected. If left unchecked, we will not mark Paid or Written Off. d) 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. We recommend a number between 1-12, however this is completely up to your organization. e) Check the Do Not Create Past Recurring Payments if you are migrating existing iats donors from another system into your Salesforce environment and don t want new Payments to be created back to the original begin date (say back to 2014). We recommend checking this option, and testing to see if it is appropriate for your organization. Page 33 of 67

34 4. If you have chosen Recurring Donations and Opportunities (Donations), additional customization options will become visible: **Important if using the Recurring Donation NPSP integration: By default the stage for all new open child Donation records created by the Recurring Donations NPSP app or via Aura will be 'Pledged' as this is the default of the NPSP. When they are closed automatically by the nightly download journal import or closed because of changes made via the Virtual Terminal, Brickwork will change the stage to the Closed value chosen within the 'Stage if iats Transaction is Approved/Rejected' fields on the iats settings page. New to version , you are now able to optionally select a stage to indicate that an ACH transaction is Pending, which will be automatically updated once the final results (approved or rejected) are imported. To view your current Stage Types, please click on Setup -> App Setup -> Opportunity -> Fields -> and click on Stage within the Opportunity Standard Fields section. Types can be 3 values: Open, Closed/Won, and Closed/Lost, however Brickwork doesn't update opportunity records that are closed (Closed/Won and Closed/Lost) because it is assumed that a payment (via IATS transaction or any other payment method) has already been received for the opportunity or that the opportunity is lost. a) 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. b) 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. c) 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. o Note that the Open type is considered to be never ending by the NPSP. Because of this, the number of child Donation records that are created within the Recurring Donation (that Brickwork creates via Aura) will be the number of Future Forecast Months you have set with the Recurring Donation NPSP settings. Brickwork will post the Begin and End dates the donor selected on Aura within the Recurring Donation itself, however the NPSP ignores these fields for the Open type. The result of this is that if the Future Forecast Months number is 12, but Page 34 of 67

35 the donor selects to give for only 5 months, you will still see 12 future Donation records within the Recurring Donation. If would prefer to limit the number of future Donations to the exact end date the donor selects, use the None option instead (do not select the None option). d) Click the Recurring Donations Settings link to open a new window for the NPSP Settings tab. Brickwork will react to these settings, which prevents you from needing to repeat these options within iats Settings. Page 35 of 67

36 8.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, and when a new Contact record will be created instead. 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 the Aura field to any field OR the Aura Phone field to any Phone field on the Salesforce Contact Record. Example: First Name, Last Name must match, but either the or phone must match or a new Contact record is created. Advanced Option (Recommended): Matches any Donor information 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. 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: Page 36 of 67

37 Ø 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. Aura Donor detail fields: Page 37 of 67

38 8.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 (or Recurring Donation record in the case of our Recurring Donation NPSP app integration). The Aura Field Mapping options can be enabled and customized to map any Aura field data to any other Salesforce field on the Contact, Opportunity, iats Transactions, iats Customer Code, and Recurring Donation Records. If using Recurring Donations, any data from the Parent record can be mapped to the child Donation record using the Recurring Donation map settings. 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. 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 designated Salesforce Record) Page 38 of 67

39 1. Select the iats Merchant 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. 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: Page 39 of 67

40 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 The optimal result of this example would be an incomplete address, so that the donor can be followed up with to correct the address. 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. 8.5 Virtual Terminal Settings The Virtual Terminal Settings determine default options within the Brickwork Virtual Terminal. 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. Page 40 of 67

41 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. 8.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 41 of 67

42 9 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 for Credit Card UK Direct Debit and for the prior four consecutive days for North American ACH. North American ACH/EFT Return data and UK Direct Debit BACS reports are also imported to create iats Return records. This tool ensures that all recurring transactions are recorded in Brickwork the day after they have been processed, and any missing Single iats Transactions are imported into Salesforce. Also, the iats Transaction status of single ACH charges is updated as the final results take up to two business days to be received from the bank. The Download Journal tool utilizes the Client Codes that are saved as iats Merchant Accounts to access iats servers to obtain processing data. For more information on how the Download Journal Import tool works, please see the workflow included on the next page. Important Details: Only System Administrators are permitted to schedule the Download Journal. 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. The download journal imports in batches of 200 iats Transactions at a time, up to 10,000 maximum. The import batch size can be amended if needed to accommodate for the NPSP. See below for instructions on how to do that if necessary. If an error message is received during the import process the current batch and all future batches are aborted, however prior successful batches are not. Credit Card transactions are imported daily at each scheduled import time, and include yesterday s transactions. ACH North American transactions are imported daily at each scheduled import time, and include all transactions from the prior four days. 1. In Setup (click on your username and choose Setup if using the standard menu, or click the Setup link if using the Enhanced menu). 2. Under the App Setup or Build (for enhanced) section select Develop then Apex Classes, and click the Schedule Apex button. 3. Name the job iats Nightly Download Journal. 4. Click the Apex Class look up button and select IATSPayments_journal_log. Page 42 of 67

43 5. Set the Frequency as Weekly. 6. Check off each day of the week. 7. The Start Date will default to today, but be sure to select an End Date in the future. We recommend at least 5 years. There is no restriction on future End Date. 8. Set the Preferred Start Time. Please select a time between 7am and 7pm (Your own time zone) Note: Internal iats updates and maintenance may occur between 11:00pm and 4: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 11-12pm GMT to ensure the prior day s report has been created in both the UK and North American time zones. 9. Click Save to register the new Apex Schedule. 10. If desired, you can receive daily notifications regarding the import by checking the Download Journal Notification option within the iats Settings tab. 9.1 Edit the Nightly Download Journal Batch Size (Optional) It is not recommended to edit the batch size from the standard of 200 unless you are receiving errors from the NPSP. These errors are rare. 1. Access the iats Brickwork Custom Settings Setup > Develop > Custom Settings > IATS Brickwork Settings 2. Click Manage 3. Click Edit 4. Scroll down to the Journal Download Batch Size field and enter a number greater than 1, but less than 200. Please note that the maximum size is 200 and minimum is 1. Any values over or under will be discarded and the default 200 batch size will be set. 5. Click Save. Be sure not to edit any other fields on this page. If see a value that you d like to change, use the iats Settings tab directly. Page 43 of 67

44 9.2 Transaction Workflow Logic: Page 44 of 67

45 9.3 NA ACH/EFT Returns Workflow Logic For more information on the new iats Returns object, check out Section 9 of the Brickwork User Guide. Page 45 of 67

46 9.4 UK Direct Debit BACS Returns Workflow Logic For more information on the new iats Returns object, check out Section 9 of the Brickwork User Guide. Page 46 of 67

47 9.5 Download Journal Notification Templates: 1. Successful Manual or Auto Download Journal: Subject line: Brickwork Download Journal Import - Successful Body of Dear **Name of client**, The iats Transaction and iats Return batch download to Salesforce is now complete for iats Account(s): **client sub-code(s) **. Please note the following details: The Download Journal import process was successful for date period 01/03/ /03/2013. Number of new iats Transaction Records created (Approval and Rejected): 80 Number of new iats Customer Code Records created: 78 Number of new Contact Records created: 18 Number of new Opportunity (Donation) Records created: 78 Number of new iats Return Records created: 0 Please note that if the above details indicate 0 records were inserted, it means there was no new iats Transaction or Return data to import into Salesforce. If you receive an iats Returns error after this message, please address the details and try the import again. To ensure all ACH iats Transactions are imported after weekends and Holidays, the scheduled Nightly Download Journal will import the prior four days of North American ACH processing. If you have any questions, please contact iats Customer Care for additional assistance at iatscs@iatspayments.com or , option 1. Thank you, 2. Failed Manual or Auto Download Journal for iats Transactions ONLY: Subject line: Brickwork Download Journal Import Error Received for Transactions Body of Dear **Name of client**, The iats Transactions batch download to Salesforce for date period 10/22/ /22/2014 was unable to complete for iats Account(s): **client sub-code(s) **, as the following error message has been received: **Error message varies per scenario** Please address the error details, and manually reattempt the batch download via the iats Settings tab in Salesforce. If your Organization processes ACH or Direct Debit transactions with Brickwork, iats Returns are imported only after a successful import of iats Transactions has been completed. Once the iats Transactions are imported successfully, iats Returns will be attempted and if unsuccessful an error message will be sent. Page 47 of 67

48 If you have any questions about the error or require further assistance, please contact iats Customer Care at or , option 1. Thank you, 3. Failed Manual or Auto Download Journal for iats Returns ONLY: Subject line: Brickwork Download Journal Import Error Received for Returns Body of Dear **Name of client**, The iats Returns batch download to Salesforce for date period 10/22/ /22/2014 was unable to complete for iats Account(s): **client sub-code(s) **, as the following error message has been received: **Error message varies per scenario** Please address the error details, and manually reattempt the batch download via the iats Settings tab in Salesforce. If you have any questions about the error or require further assistance, please contact iats Customer Care at or , option 1. Thank you, Logic of functionality: If the Transaction and Return imports are successful, you will get a Success template indicating the numbers of transactions, otpy's, contacts, and returns that were imported. If the Transaction import is successful but the Return isn't, you should get one success template (# of Returns imported would equal 0), and one Returns Error template explaining why the Returns import failed. You can then re-run the download journal and import the Returns. At that point you would receive the success import template indicating 0 transactions and the # of returns imported. If the Transaction import fails, the Return import isn't attempted. You should get the Transaction Error message (no mention of returns) so you can fix the errors. Then when you run the manual import you will get the success template showing them the number of transactions and returns that were imported. Should the Returns import actually fail, you should get the returns error message (no mention of transactions) allowing you to fix the reason for the returns fail. When you run the manual import you should get the success template indicating the number of returns imported. To ensure your organization is receiving these notifications, please add your address to the Notification field and check the Nightly Batch Download Notification checkbox within Additional Settings on the iats Settings tab. Page 48 of 67

49 10 Integrate an Online Donation Form (Aura or Form Assembly) Until 2016, Brickwork clients had the option of Aura or AuraLink for online donation form processing. Thanks to the release of our new iats Universal Postback feature, you now have other online options to choose from, such as Form Assembly. The new iats Universal Postback feature allows any transaction processed via your iats Merchant Account to post directly to your Salesforce environment via Brickwork! This means that now you can connect your third party app like a Form Assembly Donation form to iats for processing, but also take advantage of Brickwork s connection to the Nonprofit Success Pack for Recurring Donations. ** Each Partner has a unique way of connecting to iats for processing. Please refer to their product manuals for further information on how to setup their tools to connect with iats. Create a Salesforce Site URL: In order to connect any online form to Brickwork, you first need to create a Salesforce Site. The Site is the connector between the iats processing system and your unique Salesforce environment. Please follow the below instructions to create a site that can be used specifically for Brickwork. 1. Within Setup (click on your username and choose Setup, or just the setup button if using the Enhanced menu option) locate the App Setup or Build 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. 9. Check the Active checkbox. 10. Click Save. This displays a summary of the new Site ( Site Detail ) noting the user name, site URL and label, and other details. 11. Return to the site list by clicking on the Site link from the left side Setup menu under Develop. 12. Locate your newly created site, and right click on the Site URL field, and select Copy Link Address. Page 49 of 67

50 10.1 Connect an Aura or AuraLink form to Brickwork 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 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. ** Aura can post to either http or https type URL s. If the website which hosts the Aura page is https it s recommended to check the Require Secure Connection checkbox within the Site Label settings, and add the s onto the Site URL when adding to Aura. 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. Page 50 of 67

51 10.2 Connect a Form Assembly donation page to Brickwork: With Form Assembly's iats Connector, you can easily process one-time credit card payments, set up recurring credit card payments through subscriptions, process ACH or Direct Deposit payments, and create new customers in iats. If you have an iats account, you can follow the recommended installation steps to configure the connector and pass single and recurring donations to Salesforce via Brickwork. For more information on the Form Assembly iats Connector, visit their website. ** Please note that this feature is still in BETA. Please refer to the below points to be sure this product to product integration is right for your needs: At this time Brickwork will always create a Salesforce Opportunity for all processed transactions or recurring schedules, or a Recurring Donation if using the NPSP. This cannot be disabled in Brickwork if a connection to the NPSP is desired. Because Form Assembly has the ability to create Salesforce Opportunities as well, this could result in an extra undesired Opty record. There are a few options to overcome this issue such as: a. Disable Opty s from being created by Form Assembly, allowing Brickwork and the UPB to create all records. The pro of this option is that there will be no extra opty records. The con is that you may not be able to map custom Form Assembly data to the Opty record. A workaround to this is to map the custom data to Salesforce and have an administrator create a custom solution to move the data wherever you need it in Salesforce. (Recommended) b. Separate how Recurring vs. Single transactions are handled by Brickwork and iats. The Universal Postback can be enabled for both Single and Recurring posts, or one or the other. For example, Brickwork and the UPB can be configured to receive only Recurring donations, but allow Form Assembly to create all Single donation records. You cannot do this in reverse as Form Assembly cannot create NPSP records. c. Have a developer write a custom solution that creates the required Brickwork and NPSP records based on the authorization responses that Form Assembly receives from the iats Connector. This option is not recommended unless you have a very unique requirement that cannot be met by option A or B above. Duplicate Contact and Account records may be created by Form Assembly and Brickwork in certain set-up situations. If you require that Form Assembly create Salesforce Contact and Account records while the transactions are being processed by the iats Connector, there could be duplicate records. This is because although Brickwork has extensive Contact Match options to prevent duplicates, the Form Assembly records and the Brickwork records may be created at the exact same time. In these cases Page 51 of 67

52 the Brickwork Contact Match tool won t locate a duplicate, and will create a new Contact and Account. This can be avoided by allowing Brickwork to create or find all Contact records. If this solution isn t possible, you may have to write custom code to locate, merge, and delete any duplicate contacts. Only the standard payment fields from the predefined Form Assembly content should be used with the iats Connector. Renaming or creating custom payment fields will not map to iats properly and will cause errors. *Important Considerations when connecting Form Assembly Processing to Brickwork: When setting the Start Date field, There are three options to choose from in the dropdown, Immediately, Use a Formula, and Defined in Form. Please DO NOT USE Immediately as this will cause an immediate transaction to be processed, which will not relate to the NPSP Recurring Donation properly. Use either Use in a Formula, or Defined in the form to set the Start Date. Page 52 of 67

53 Aura to Salesforce Post Error Notification During the post from iats to Salesforce, rare connection issues (for example if Salesforce is down for maintenance or a custom validation rule is activated) could cause the Aura post to fail resulting in the Aura transaction data to not appear in Salesforce. In these cases, you will receive an containing the cause of the error, the details the donor entered on the Aura form, and a hyperlink which can be used to manually repost the data from iats to Salesforce. Subject line: Error received during import from iats Aura online form Body of There was an error importing new donation details from your Aura online donation page to Salesforce. Please review the error message detail posted below and address accordingly. Once the reason for the error message has been corrected, the donation details can be imported via the manual import tool on the iats Settings tab in Salesforce if needed. If you have any questions about the error or require further assistance, please contact iats Customer Care at iatscs@iatspayments.com or , option 1. Organization Name: **Name of client** Organization ID: **Salesforce Org ID of client** Error Type: Aura online donation import error Error Message: **Error message varies per scenario** Error Line Number: **Error number varies per scenario** **All details the donor entered into Aura donation form** Brickwork Version: **varies per client** Full URL: **URL hyperlink will be displayed** Page 53 of 67

54 10.3 Modify NPSP Trigger s to accommodate for Brickwork If your organization has chosen to use the Nonprofit Success Pack, there are some built in Validation Triggers that can produce errors when new donors are created via online posts like Aura or the Universal Postback, such as the Preferred and Preferred Phone rules. To prevent errors, you can choose to modify the NPSP Triggers to ignore records created via Brickwork. To prevent the Preferred Phone or Preferred Aura Post error, you can modify the trigger that is created by the NPSP when it s installed. 1. Within Setup, go to Sites (within Develop), and click on the site label that is being used with the Brickwork Site 2. Next, click on the Public Access settings button 3. Click on View Users 4. Click on the Full Name of the User 5. Copy the value in the Alias field, which will normally be guest 6. Access the Validation Trigger code by going to Setup, Build, Customize, Contacts, Validation Rules, and either Contact Preferred or Contact Preferred Phone (both can be amended). 7. Click Edit. Page 54 of 67

55 8. Before pasting the below code, please be sure to review the code you already have listed. If there have been any prior modifications to the code, do not paste the below. In this case, please see step 11 below for the values you need to add to the code instead. 9. If the code has not been modified, it should like this: Default Preferred Phone Code: AND( ISPICKVAL(npe01 PreferredPhone c,""), OR( LEN(MobilePhone)>0, LEN( npe01 WorkPhone c)>0, LEN( OtherPhone )>0 ) ) Default Preferred Code: AND( ISPICKVAL( npe01 Preferred_ c,""), OR( LEN(npe01 Alternate c )>0, LEN(npe01 Work c )>0, LEN(npe01 Home c )>0 ) ) 10. If this matches your code, there have been no modifications on the default NPSP trigger code. In this case, replace it with the below code which includes the addition of the CreatedBy.Profile.Name exclusion: Updated Preferred Phone Code: AND( ISPICKVAL(npe01 PreferredPhone c,""), OR( LEN(MobilePhone)>0, LEN( npe01 WorkPhone c)>0, LEN( OtherPhone )>0 ), $User.Alias!= ' PASTE ALIAS VALUE HERE ' ) Updated Preferred Code: AND( ISPICKVAL( npe01 Preferred_ c,""), OR( LEN(npe01 Alternate c )>0, LEN(npe01 Work c )>0, LEN(npe01 Home c )>0 ), $User.Alias!= ' PASTE ALIAS VALUE HERE ' ) 11. **Important! Paste the previously copied Alias value to replace the PASTE ALIAS VALUE HERE value above, and click Save. 12. If your code didn t look like the above, you can amend it to include the exclusion at the end. In this case, simply add the $User.Alias!= ' PASTE ALIAS VALUE HERE ' code to the rule, and paste the previously copied alias value to replace the PASTE ALIAS VALUE HERE value. Page 55 of 67

56 11 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 Contact, Opportunity, and Recurring Donation (NPSP) Record types within Salesforce. 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 record to be linked to a specific Campaign, and for any new Contacts, Opportunities, or Recurring Donations to be assigned a specific Record Type when they are created by Brickwork. This can be done via three different methods: Method 1. Add the variable(s) and your Campaign ID and/or Record Type ID s onto the URL of the Donate button or link which hosts the embedded Aura form. This method will ensure all iats Transaction data processed via this Aura webpage will be assigned the specified values. Method 2. Add the variable(s) and your 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 the variable(s) and your Campaign ID and/or Record Type ID s onto the end of a URL, such as included within an blast, or online 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 Recurring Donation (NPSP) Record Type ID Variable: rertid Page 56 of 67

57 11.1 Method 1 - Add Campaign ID and/or Record Type ID s onto the web page Button/link URL (Recommended) 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 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. 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, oprtid, or rertid described above. When adding a second variable ID into the URL link, they must be separated by an ampersand. Example: 0zJ6O&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 default Record type instead. Page 57 of 67

58 11.2 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: 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, oprtid, or rertid described above. When adding a second variable ID into the Salesforce Site URL, they must be separated by an ampersand. Page 58 of 67

59 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 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. Page 59 of 67

60 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: 6. If desired, a Contact and/or Opportunity Record Type can also be added by using the Record Type ID variables cortid, oprtid, or rertid described above. 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 60 of 67

61 12 Installation checklist Did you complete all installation and configuration steps? Not sure? Check off each item you ve completed below: Review Steps: Watch the Brickwork Install and Customize Video Watch the Brickwork Recurring Options Video Watch the Aura Brickwork Integration Video Download Steps: Review the Pre-requisites for downloading Brickwork from the App Exchange Install Brickwork from the Salesforce App Exchange Configure: Modify Contact and Opportunity (Donation) page layouts Modify Recurring Donation or Payment page layouts depending on chosen recurring option Modify the iats Customer Code custom object if using UK Direct Debit Customize the iats Settings tab Schedule the APEX Class " Journal Log" Nightly Download Journal Integrate Aura Online Forms: Decide if you will use Aura or Form Assembly. If Aura, review the Aura guide and create an iats Aura online donation page(s) If Form Assembly, review the Form Assembly Brickwork Guide and the Form Assembly iats Connector Instructions to create an FA online donation page(s) Create a Salesforce site URL to add to the iats Aura online donation page(s) or the Universal Postback for Form Assembly Is desired, add Record Type ID's or Campaign's to control the records created from either donation processing forms Learn: Review Brickwork User Guide to learn how to use Brickwork for transaction processing Train your staff how to use Brickwork Page 61 of 67

62 13 How To: Import iats Customer Codes into Salesforce Some client s may choose to import existing iats Customer Codes from iats directly into Salesforce. This is only applicable for clients who already use iats, but where there are existing recurring donors from another software system. If you are a new iats client you do not need to import Customer Codes. The following instructions detail how to create the template for the iats Customer Code object. You can use any import tool you are comfortable with such as the Import Wizard, Salesforce Data Loader or third party solutions such as Apsona. Also, please note that if you are using the NPSP (Nonprofit Success Pack) with Brickwork you need to create the accompanying Recurring Donation and Donation records in advance so they can be related to the new iats Customer Code during the import. For more information on creating NPSP records, please see their instructions 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 Merchant Account (Brickwork record of iats Merchant Account details) Required Contacts Opportunity/Donations or NPSP Recurring Donations Account/Households 1. Log into Salesforce. 2. Create or obtain the iats Merchant Account Name field (Example NA test ) applicable for your merchant account which connected to the pre-existing Customer Codes on the iats server. This is important so if you are not sure which iats Merchant Account was used, please reach out to iatscs@iatspayments.com for assistance. Page 62 of 67

63 3. Create/Import Contact Records and export their ID s. 4. Create/Import Opportunity Records and export their ID s. If the above records have already been created, simply obtain the Salesforce Record ID 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 Virtual Terminal Tab, then Customer Database 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 Merchant 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 Merchant 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. Page 63 of 67

64 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) ScheduleType ScheduleDateNumber(Weekly/Monthly Only) N/A N/A N/A N/A N/A 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 Recurring Payment Schedule Type Recurring Payment Schedule Date iats Merchant Account Name Contact ID Opportunity ID Account ID Recurring Donation 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. Page 64 of 67

65 13.3 Import Existing iats Customer Codes (Optional) We recommend you use the import tools you are most comfortable with. The below represents using the Salesforce Import Wizard. 1. In Setup, under the Administer section select Data Management then Data Import Wizard. 2. Click the Launch Wizard! button: 3. Click on the Custom Objects option within the What kind of data are you importing? choice, then select iats Customer Codes: Page 65 of 67

66 4. Next, click on the action Add new records option in the What do you want to do? question, and select appropriate match options: Page 66 of 67

67 5. Drag your file onto the CSV area of the wizard: 6. Edit the mapping of the file so that each field matches to the fields on the iats Customer Code object. This should have automatically been mapped properly if you used the correct header names in your spreadsheet: 7. Once you are happy with the mapping, click the Next button, review, and click the Start Import button. Page 67 of 67