FOR THE RAISER’S EDGE
INSTALLATION GUIDE For product version 3.3 Updated June, 2017
Please carefully read the following installation documentation before installing Springbaud. If you require further information or have any questions about licensing Springbaud, please contact us by email at email@example.com or fill in the support request form available on our website support page.
1. System Requirements Below are details of the system specifications Springbaud requires to be installed, configured and used.
1.1 Workstation requirements Springbaud is designed to run alongside The Raiser’s Edge, so any workstation suitable for The Raiser’s Edge will likely meet Springbaud’s requirements as well, the only caveat being that there is adequate disk-space and memory and that the user installing Springbaud has sufficient rights to do so.
1.2 Supported Raiser’s Edge versions Springbaud has been tested with The Raiser’s Edge 7 versions 7.85 to 7.96 (all patch levels). It will be tested with the latest versions and patches of The Raiser’s Edge as Blackbaud releases them. You will be notified of any required updates to Springbaud provided we have your current contact details. However, it would be prudent to check with us before upgrading or patching The Raiser’s Edge if Springbaud is installed on any client workstations.
1.3 Raiser’s Edge security privileges Springbaud requires different Raiser’s Edge security privileges for installation and configuration than for normal use. For normal use – uploading lists and retrieving results – the standard privileges of the General User security group in The Raiser’s Edge sample database are sufficient. Please ensure that Raiser’s Edge users who will be using Springbaud have at least the same privileges as this security group. When Springbaud is being installed or configured, higher-level Raiser’s Edge security privileges are required because changes to The Raiser’s Edge code tables and attributes are often necessary. As such, Springbaud can only be configured by a user with Raiser’s Edge supervisor privileges; ie, the Supervisor account as well as any other user accounts with the Supervisor Rights option selected. NOTE: A dedicated Springbaud user account on The Raiser’s Edge is not required for the plug-in version as the Raiser’s Edge connection to the server is used when The Raiser’s Edge is running. (The standalone/Windows Service version of Springbaud does, however, require a dedicated user account as well as either the optional API Module or an API Bypass Code. Contact us for more information.) Please refer to section 3.7 Security and permissions, below, for more information about security and permissions.
Page 1 of 5
2. Installing and Uninstalling Springbaud Springbaud installs in a similar fashion to most other Windows software; an installer is run on a compliant workstation and thereafter is available in the Plug-Ins pane of The Raiser’s Edge. Please refer above for system requirements before attempting to install Springbaud.
2.1 Installing Springbaud To install Springbaud, first ensure that the workstation and the version of The Raiser’s Edge both conform to the system requirements mentioned above and that the user performing the installation has sufficient workstation rights. Windows Administrator-level permissions are required as well as Raiser’s Edge supervisor privileges. Re-booting the workstation prior to installation is recommended as is closing any running applications, especially anti-virus software. To begin installation, simply run setup.exe, ensuring that the file Springbaud.msi is present in the same folder. You will be guided through the installation procedure and, thereafter, the configuration procedure. NOTE: Springbaud must be installed in the Plugins folder under the Raiser’s Edge system directory otherwise it will not appear in the Raiser’s Edge Plug-Ins pane. During installation, Springbaud attempts to determine the Raiser’s Edge system directory automatically. If The Raiser’s Edge is either not installed or Springbaud cannot determine its system directory, installation will abort. In the unlikely event of this occurring, please contact us. After the installation has finished, Springbaud Campaign Management will be displayed in the Plug-Ins pane of The Raiser’s Edge. Before you can use Springbaud, it must be configured. You will be guided through this process when Springbaud is first started. Refer below to ‘Initial Configuration’ for more information about how Springbaud can be configured for multiple users. NOTE: If you would like to add a Springbaud shortcut to the Raiser’s Edge Bar and have the optional Raiser’s Edge VBA Module installed, this can be achieved by modifying the RE_System_Object_Code code module of the System VBA Project. Please refer to Appendix 9.1 of the product documentation for instructions. IMPORTANT! Modifications to The Raiser Edge user interface code should only be attempted by someone with Raiser’s Edge VBA programming experience. Modifications should be fully tested before being deployed to a live/production server.
2.2 Uninstalling Springbaud To uninstall Springbaud open Programs & Features (Windows 7-10, Vista, Windows Server 2008, etc) or Add or Remove Programs (Windows XP) from Windows Control Panel. Right click on the Springbaud entry then click Uninstall. Allow the uninstallation process to complete. NOTE: When Springbaud is uninstalled, the application data file is not deleted. This is because this file is often shared between several installations and because it contains important information such as settings and results retrieval history which may be useful for a subsequent re-installation. If it is necessary to delete, move or archive the Springbaud application data file, you can find it in the Program Data folder on most Windows workstations. If in doubt, the date file path is available from Admin/Misc & Info/Information.
Page 2 of 5
3. Initial Configuration Because multiple installations of Springbaud may in a work environment, when Springbaud is installed, two options are available for managing settings: Shared (recommended for multiple installations) or Local. This option determines whether a single application data file is shared between Springbaud installations or whether each installation maintains its own. The Springbaud application data file contains settings, results retrieval history, logs and the like.
3.1 Shared application data Where multiple installations of Springbaud will be using the same Raiser’s Edge database and email service provider account, shared application data management is recommended. Sharing application data means that all installations of Springbaud are linked to the same application data file and therefore use the same settings, work with the same results retrieval intervals, and contribute to the same log files. This means that a user – or users – will experience the same Springbaud environment from whichever workstation they are using. Administration is also simpler because any workstation can be used to upload lists, retrieve results, change settings, etc. For shared application data management to function, the application data file must reside in a location accessible to each Springbaud installation, for example a network folder or mapped drive.
3.2 Local application data In contrast to the shared application data scenario described above, local application data management means that each installation of Springbaud functions independently, without any interaction with other installations; settings, results retrieval intervals and logs will apply only to that installation. This configuration method can have undesirable repercussions if changes are made, for example, to one Springbaud installation or to The Raiser’s Edge; the changes would have to be replicated manually for other Springbaud installations in order to avoid any errors or inconsistencies between installations.
3.3 The configuration process During installation, the user has the option to either connect to an existing application data file or to create a new one. Linking to an existing data file is simply a matter of browsing to the file from the configuration wizard, then clicking Test Connection to ensure that the file is accessible and of the correct version. Creating a new, local application data file requires that you enter your email service provider – Campaign Monitor, MailChimp, etc – credentials as well as list upload and Raiser’s Edge preferences. Refer to the next section for complete instructions.
3.4 A single installation or the first of several shared installations The very first installation of Springbaud is unique because there is no existing application data file to link to, meaning that the first installation must always create a new application data file. (It would be possible to utilize a data file from a previous installation but for the purposes of this document, we shall assume that no such file exists.) To proceed with local/new application data file installation:
Click Next from the initial configuration pane to enter the Email Service Provider (ESP) pane. Enter your Account API key and test the connection to the provider.
Page 3 of 5
After a successful connection, the Default account name selector field will be populated with one or more account names retrieved from your provider account. Then:
Select your preferred account name (if multiple accounts are supported and retrieved) and enter your default list upload preferences such as Unsubscribe URL, List Visibility, etc. (Settings vary by email service provider.) Click Next to move to the Raiser’s Edge Query Filter pane. Select a Query type filter and enter at least two characters (alphanumeric characters, underscore, hyphen and period/full-stop only) in the Query prefix field. Click Next to move to the Configuration Confirmation pane. Click OK or Back to review or change configuration settings.
Configuration of Springbaud will be completed, an application data file will be created on the workstation and Springbaud will start. NOTE: By default, new application data files are installed in a sub-folder of the workstation’s Program Data folder (Protege Solutions/Springbaud) but this can be changed, if desired, by clicking Change to the right of the file path. If the application data file is to be shared with other Springbaud installations, it must be accessible to those installations. It is likely, then, that the data file will need to be saved to – or moved to – a more central location, rather than a folder on the local workstation, for example, to a network folder or mapped drive. Its actual location is unimportant provided that it is reliably accessible to all Springbaud installations with which it is to be shared. NOTE: File and folder permissions are especially important when using a shared application data file; check these if you are experiencing connection difficulties or consult your IT staff.
3.5 Subsequent shared installations Where subsequent installations of Springbaud are to share the application data file, they can be pointed to the existing application data file during initial configuration as described in ‘The configuration process’, above.
3.6 Changing installation type Installations of Springbaud can be changed between Shared and Local quite easily. Converting from Shared to Local Data To change from a shared application data file to local data file, copy the existing shared application data file to separate folders accessible by each installation, generally in the Program Data folder on the workstation. Then move, rename or delete the original shared application data file. This last step will trigger Springbaud to enter the configuration process when it is next started. (If fresh configurations will be made for each installation, the original application data file may simply be archived or deleted, though the latter is not recommended due to the historical information contained in the file.) When each installation of Springbaud is next started and you enter the configuration procedure (due to the now-missing application data file), browse to the new local file, test the connection and click OK. Springbaud will then be working with its own local application data while retaining all the settings and history from the previously-shared file. Please note that from then on, each installation will be completely independent of any others and that no common settings or logs will exist. This is not recommended where the same ESP account is being used by multiple Springbaud installations.
Page 4 of 5
Converting from Local to Shared Data To change from local application data files to a shared data file, you must either nominate one of the existing local application data files to be the shared data file or else create a new data file (as described above under ‘A single installation or the first of several shared installations’) which will then be shared. Importantly, you must move, rename or delete the existing local data files. This step will trigger each Springbaud installation to enter configuration when it is next started. Place the nominated shared data file in a location accessible to all Springbaud installations, generally on a network or mapped drive. When each installation of Springbaud is next started and you are prompted to configure Springbaud, browse to the new shared file, test the connection and click OK . Springbaud will then be working with a single, shared application data file with common settings, retrieval schedule, log files, etc.
3.7 Security and permissions The following references are provided to assist with any security and permissions installation troubleshooting. Raiser’s Edge Folder Permissions Blackbaud Knowledge Base article 45968: Which NTFS rights are required to run the software on workstations, Citrix or Terminal Servers? Windows Registry Permissions Full Control permission to the following Windows Registry keys is required for all Springbaud users: Windows 32-bit systems: HKEY_LOCAL_MACHINE\SOFTWARE\ Protege Solutions. Windows 64-bit systems: HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Protege Solutions.
If you require further information or have any questions about licensing Springbaud, please contact us by email at firstname.lastname@example.org or fill in the support request form available from our website support page.
Protégé Solutions is a Blackbaud Technology Partner
Springbaud is a trademark of Protégé Solutions Pty Ltd. Disclaimer: The Raiser’s Edge is a trademark of Blackbaud, Inc. Protégé Solutions is not associated with Blackbaud, nor are its products supported or endorsed by Blackbaud. Copyright © 2017 Protégé Solutions. All rights reserved. No part of this publication may be reproduced except in its original form.
Page 5 of 5
Installation Guide for Springbaud For The Raiser's Edge 7. Author Steven J Cinquegrana Copyright Protege Solutions
Published on Jul 1, 2014
Installation Guide for Springbaud For The Raiser's Edge 7. Author Steven J Cinquegrana Copyright Protege Solutions