Project

General

Profile

Exporting Raisers Edge for CiviCRM » History » Version 25

Jon Goldberg, 11/12/2018 09:34 PM

1 5 Jon Goldberg
{{last_updated_at}} by {{last_updated_by}}
2 1 Jon Goldberg
3
{{>toc}}
4
5
# Exporting Raiser's Edge for CiviCRM
6
7
8
There are two basic approaches to exporting RE data.  There's the built-in export tool, and there's direct SQL interaction.  This document will try to cover both approaches where possible.  The Export tool has a lower barrier to entry, but a) there's some data you can't export with the tool, and b) the data will be denormalized, requiring additional transformation compared to extracting normalized SQL data.
9
10
Note that there's a good video on this topic by Young-Jin from Emphanos, LLC, here: http://sf2013.civicrm.org/migrating-raisers-edge-civicrm
11
12
##  Do you use Pentaho Kettle?
13
14
If so, you can use my Raiser's Edge to CiviCRM transforms, available here: https://github.com/PalanteJon/civicrm_kettle_transforms
15
16
## Export tool - general guide.
17
18
The Raiser's Edge Export tool is on the left toolbar when you first enter Raiser's Edge.
19
20
From the tool, you will create a number of exports.  When you first create an export, you'll be asked a number of questions, including Export Type (Constituent, Gift, etc.), a checkbox to include inactive records (check this), and an export file type (select CSV).
21
22
For most export, select Constituent as the Export type.  This is the "base table" - all records will be joined relative to it.
23
24
## Constituent Based Exports
25
26
### Contact Information
27
28
RE differentiates between constituents and non-constituents in their system.  If you create a new contact, they're a constituent - but then you might decide to add a spouse or employer record, which is NOT considered a constituent, and doesn't show up in most queries.  Notably, non-constituents aren't exported when using the Export tool and your base table is "Constituent".
29
30
### SQL
31
32
If extracting directly from SQL, `SELECT * FROM RECORDS`.
33
34
Note that you can extract only constituents by adding `WHERE IS_CONSTITUENT = -1`.  For a Civi migration, I recommend importing all contacts.
35
36
### Export tool (NOTE: This ONLY gets constituents).
37
38
Tab 1. General:
39
- Include all records.
40
- Head of Household processing: Export both constituents separately.
41
- Check all of the "Include these Constitutents": Inactive, deceased, no valid address
42
43
Tab 2: Output.
44
First, expand the "Constituent Information" in the left pane, and add every field to the export.  Do the export (as a CSV).
45
46
### Constituent Codes
47
48
In RE: Found at the bottom of the "Bio 2" tab.
49
In SQL: CONSTITUENT_CODES maps to "GroupContact".  TABLEENTRIES stores the codes ("groups").  In my case, `SELECT *  FROM [CCR_July_snapshot].[dbo].[TABLEENTRIES] WHERE [CODETABLESID] = 43` did the trick.  YMMV - see "deciphering stored procedures" below.
50
51
Export as _one to many_, below.
52
These map to "groups" in Civi - can also be mapped to "tags" if you don't need to track the begin/end date on them.
53
54
No need to export these fields:
55
System Record ID
56
Import ID
57
As of Civi 4.4.6, there's no way to import Group Begin/End dates via API, you need to do it via direct SQL.
58
59
### Solicit Codes
60
61
These can map to groups - but also may map to privacy preferences or custom fields (e.g. Email Only, Do Not Solicit)
62
63
SQL to extract solicit codes:
64 7 Jon Goldberg
```sql
65
SELECT RECORDSID AS external_identifier, LONGDESCRIPTION as solicit_code 
66
FROM CONSTITUENT_SOLICITCODES JOIN TABLEENTRIES ON SOLICIT_CODE = TABLEENTRIES.TABLEENTRIESID 
67
WHERE TABLEENTRIES.ACTIVE = -1
68 1 Jon Goldberg
```
69
70
In my copy of RE, the CODETABLESID is 5044, so to get a list of all solicit codes, use:
71 7 Jon Goldberg
```sql
72
SELECT LONGDESCRIPTION, ACTIVE 
73
FROM TABLEENTRIES 
74
WHERE CODETABLESID = 5044 
75
ORDER BY SEQUENCE;
76 1 Jon Goldberg
```
77
78
### Addresses
79
80
SQL tables: ADDRESS, CONSTIT_ADDRESS
81
82 2 Jon Goldberg
Addresses are a many-to-many relationship in RE.
83
Not all addresses in the database are visible in RE.  Addresses where the `INDICATOR` field is 1 or 7, for instance.  Make sure to look your data over and filter those out accordingly.  Alternatively, you may want to handle them by creating address sharing in Civi.
84
85
Source: http://www.kb.blackbaud.co.uk/articles/Article/41141
86
The address Indicator field is located on the CONSTIT_ADDRESS table and can have the following values: 
87
~~~
88
0 = Alternate
89
1 = Contact
90
2 = Preferred (Primary Address entered on the Bio 1 tab of the constituent record)
91
3 = Business
92
4 = Spouse Business
93
5 = Spouse Preferred
94
6 = Spouse Alternate
95
7 = Relationship
96
~~~
97 3 Jon Goldberg
98
`CONSTIT_ADDRESS.TYPE` and `CONSTIT_ADDRESS.INDICATOR` both have a bearing on location type.  `TYPE` is what appears in the RE UI; however it's calculated based on the indicator.  An indicator of `3` is always a shared address from the relationship to "primary business information".  Adding a work address manually will always give an indicator of `2` if preferred or `0` otherwise.
99 4 Jon Goldberg
100
When you create an address on a related non-constituent, the address's `CONSTIT_ID` is actually the constituent's!  E.g. if John Doe works for Acme Corp, an address added to Acme Corp will have John Doe's `CONSTIT_ID`.  Even more confusing, a blank address with the Acme Corp `CONSTIT_ID` will be created.  To decipher this, you need to look at the `CONSTIT_RELATIONSHIPS.CONSTIT_ADDRESS_ID` field.
101
102
Here's the SQL I use for getting address data in Kettle:
103
104
~~~sql
105
SELECT
106
  ADDRESS_BLOCK
107
, CITY
108
, POST_CODE
109
, "STATE"
110
, CTY.LONGDESCRIPTION as country
111
, ADDRESS_ID
112
, ca.CONSTIT_ID
113
, PREFERRED
114
, LOC_TYPE.LONGDESCRIPTION
115
, ca.DATE_FROM
116
, ca.DATE_TO
117
, SENDMAIL
118
, ca.ID AS CAID
119
, cr.IS_EMPLOYEE
120
, cr.IS_PRIMARY AS IS_RELATIONSHIP_PRIMARY
121
, cr.RELATION_ID
122
, ca.INDICATOR
123
FROM ADDRESS a
124
LEFT JOIN TABLEENTRIES AS CTY ON CTY.TABLEENTRIESID = COUNTRY
125
JOIN CONSTIT_ADDRESS ca ON a.ID = ca.ADDRESS_ID
126
LEFT JOIN TABLEENTRIES AS LOC_TYPE ON ca."TYPE" = LOC_TYPE.TABLEENTRIESID
127
LEFT JOIN RECORDS r ON ca.CONSTIT_ID = r.ID
128
-- This next join is needed to handle address sharing with the business
129
LEFT JOIN CONSTIT_RELATIONSHIPS cr ON ca.ID = cr.CONSTIT_ADDRESS_ID AND ca.CONSTIT_ID = cr.CONSTIT_ID
130
WHERE INDICATOR <> 7 AND ADDRESS_BLOCK IS NOT NULL
131
~~~
132 2 Jon Goldberg
133
### Primary Business Information 
134 1 Jon Goldberg
From "Bio 1", if you press the "Business" button, you can add a related business and its address - but if you check the "Primary Business Information" box, the address will actually have a `CONSTIT_ID` tied to the original contact.  Very confusing!  To properly migrate this address, you'll need to link the address using the `CONSTIT_RELATIONSHIP` table.
135
136
### Phones/E-mail/websites
137 6 Jon Goldberg
138 1 Jon Goldberg
Email and websites are stored in the `PHONES` table along with phone numbers.
139 6 Jon Goldberg
140
In older versions of RE (possibly up to 7.93), phones were tied to addresses, not contacts.  In current versions this is no longer true, but the fields are still present, which is a red herring.
141 1 Jon Goldberg
142
Notes:
143
* You can NOT have duplicate phone types in RE, so no need to try and catch multiple "Home" numbers!
144
* Oh - except that one contact can have two home phone numbers on two different addresses.
145
* Don't forget to filter out duplicate numbers/e-mails/etc. when someone puts the same phone number on two different addresses.
146 6 Jon Goldberg
147
This SQL gets me a useful list of phones and e-mail for further processing in Kettle (for RE 7.96):
148
149 1 Jon Goldberg
```sql
150 6 Jon Goldberg
SELECT DISTINCT
151 1 Jon Goldberg
PHONES.CONSTIT_ID
152
, NUM
153 6 Jon Goldberg
, DO_NOT_CALL
154
, LONGDESCRIPTION AS location_type
155
, PHONES."SEQUENCE"
156
, PHONES.PHONESID
157
FROM PHONES
158
LEFT JOIN TABLEENTRIES ON PHONETYPEID = TABLEENTRIESID
159
LEFT JOIN RECORDS r ON r.ID = PHONES.CONSTIT_ID
160
WHERE PHONES.INACTIVE = 0
161
AND CONSTIT_RELATIONSHIPS_ID IS NULL
162
--Sequence so we get primary number correct
163 1 Jon Goldberg
ORDER BY PHONES.PHONESID, PHONES."SEQUENCE"
164
```
165
166
### Relationships
167
168
Relevant SQL table: CONSTIT_RELATIONSHIPS
169
170
Relationships are different in Civi and RE in the following significant ways:
171
* Relationships don't have to have a relationship type.
172
* The A-B relationship doesn't have to have the same relationship type as B-A (e.g. if my relationship is "parent", the reciprocal relationship could be "son" or "daughter".
173
* Related contacts need not have their own constituent record (though they can).  If they don't have their own constituent record, they nevertheless have a record in RECORDS, they're just not a constituent.
174
* There need not be a relationship type at all.  This doesn't make sense, except that:
175
* There are hardcoded fields for IS_SPOUSE, HON_MEM_ACKNOWLEDGE, IS_HEADOFHOUSEHOLD, and SOFTCREDIT_GIFTS.
176
177
Because relationships aren't necessarily reciprocal, I find it helpful to take my list of invalid relationships and do BOTH of the following:
178
* Look up the RELATIONSHIP_TYPE against the `name_b_a` field in `civicrm_relationship_type`.
179
* Look up the RECIP_RELATIONSHIP_TYPE against both `name_a_b` and `name_b_a` in `civicrm_relationship_type`.
180
181
### Solicitor Relationships
182
183
Solicitor relationships are stored in a different table.  I used this SQL to extract them:
184 8 Jon Goldberg
```sql
185 1 Jon Goldberg
SELECT
186
CONSTIT_ID
187
, SOLICITOR_ID
188
, TABLEENTRIES.LONGDESCRIPTION as solicitor_type
189
, AMOUNT
190
, NOTES
191
, cs."SEQUENCE" as weight
192
FROM CONSTIT_SOLICITORS cs
193
LEFT JOIN TABLEENTRIES ON cs.SOLICITOR_TYPE = TABLEENTRIES.TABLEENTRIESID
194
ORDER BY weight
195
```
196
197
### Attributes
198
199
Attributes are the RE equivalent of custom fields.  However, unlike custom fields, they can also have a "date" value and a "comments" value.  While this can be replicated in Civi via multi-record custom field groups, ideally the data is evaluated attribute by attribute.
200
201
Valuable information about the setup of the attributes is available in RE from *Config > Attributes*.
202
203
* The analogous field to `civicrm_custom_field` is `AttributeTypes`.
204
* `AttributeTypes.CODETABLESID` gives a lookup for the RE "option group" that contains valid options for that attribute.
205 25 Jon Goldberg
* All constituent attribute data is stored in the table `ConstituentAttributes` for constituents and `RELATIONSHIPATTRIBUTES` for non-constituents.  Note that it's stored in a Key-Value Pair-style table - you'll need to do a bunch of SQL queries, or run a Kettle "Row Denormaliser" step to get this data in order.
206 1 Jon Goldberg
 
207
Here's my preliminary SQL to export attributes from RE:
208 9 Jon Goldberg
```sql
209 1 Jon Goldberg
SELECT
210 25 Jon Goldberg
at.DESCRIPTION as Category
211 1 Jon Goldberg
, TABLEENTRIES.LONGDESCRIPTION as Description
212
, TEXT
213
, "BOOLEAN"
214
, COMMENTS
215
, ca.ATTRIBUTEDATE
216 25 Jon Goldberg
, ca.PARENTID
217 1 Jon Goldberg
FROM ConstituentAttributes ca
218
JOIN AttributeTypes at ON ca.ATTRIBUTETYPESID = at.ATTRIBUTETYPESID
219
LEFT JOIN TABLEENTRIES ON ca.TABLEENTRIESID = TABLEENTRIES.TABLEENTRIESID
220 25 Jon Goldberg
-- This UNION adds non-constituent attributes
221
UNION 
222
SELECT
223
at.DESCRIPTION as Category
224
, TABLEENTRIES.LONGDESCRIPTION as Description
225
, TEXT
226
, "BOOLEAN"
227
, COMMENTS
228
, ra.ATTRIBUTEDATE
229
, cr.RELATION_ID AS PARENTID
230
FROM RELATIONSHIPATTRIBUTES ra
231
JOIN AttributeTypes at ON ra.ATTRIBUTETYPESID = at.ATTRIBUTETYPESID
232
LEFT JOIN TABLEENTRIES ON ra.TABLEENTRIESID = TABLEENTRIES.TABLEENTRIESID
233
JOIN CONSTIT_RELATIONSHIPS cr ON ra.PARENTID = cr.ID
234 1 Jon Goldberg
```
235
236
*note:*  In the SQL above, "PARENTID" and not "ConstitID" is the correct foreign key to link this to the contact.
237
238
To get a list of option values out of RE for the attributes, use this SQL:
239 9 Jon Goldberg
```sql
240 1 Jon Goldberg
SELECT
241
DESCRIPTION
242
, at.CODETABLESID
243
, LONGDESCRIPTION
244
FROM TABLEENTRIES te 
245
LEFT JOIN AttributeTypes at ON te.CODETABLESID = at.CODETABLESID
246
ORDER BY DESCRIPTION
247
```
248
249
Attributes can be multi-record custom fields by their nature, so you have to account for that.  Here's some alpha-grade SQL for sussing out which fields have multi-record custom fields:
250 9 Jon Goldberg
```sql
251 1 Jon Goldberg
SELECT ATTRIBUTETYPESID, PARENTID, COUNT(LONGDESCRIPTION)
252
FROM ConstituentAttributes ca
253
JOIN TABLEENTRIES te ON ca.TABLEENTRIESID = te.TABLEENTRIESID
254
GROUP BY PARENTID, ATTRIBUTETYPESID
255
HAVING COUNT(LONGDESCRIPTION) > 1
256
ORDER BY ATTRIBUTETYPESID
257
```
258
259
*note:*  In Civi 4.5+, you could conceivable use "EntityRef" functionality to facilitate chained selects of OptionValue lists.  That would let you create a multi-record custom field group that would very closely map how Attributes work in RE - but you'd have all the disadvantages of multi-record custom fields.
260
261
### Salutations/addressee info
262
263
RE stores contact salutations and addressee info in two places.
264
265
Primary salutations/addressess are stored on the `RECORDS` table.  `PRIMARY_ADDRESSEE_ID`, `PRIMARY_ADDRESSEE`, and `PRIMARY_ADDRESSEE_EDIT`, `PRIMARY_SALUTATION_ID`,  `PRIMARY_SALUTATION`,  `PRIMARY_SALUTATION_EDIT`.
266
267
An unlimited number of non-primary salutations can be stored in the `CONSTITUENT_SALUTATION` table.
268
269
Salutation options values are stored in the SALUTATION table, in the format "CODE1, CODE2, CODE3, etc.".  Each code refers to an id in the SALUTATION_FIELDS table, which contains tokens (e.g. "First Name", "Spouse Last Name") as well as common words like "And".
270
271
Note that  `PRIMARY_ADDRESSEE` is more akin to `addressee_display` in Civi, in that it stores the calculated display ID.  Also note that when `PRIMARY_ADDRESSEE_EDIT` is -1 (true), that's the equivalent of a custom addressee in Civi, and the value stored in  `PRIMARY_ADDRESSEE_ID` must be ignored.
272
273
### Other constituent tables:
274
275
Skip these tables:
276
* Spouse
277
* Gifts
278
* First Gift, Last gift, Largest Gift
279
* Actions
280
* First Action, Last Action
281
* Summary Information
282
283
## Contribution-related exports
284
285
### Contributions/Gifts
286
287
Contributions (in RE parlance: Gifts) are complicated beasts!
288
289
Here are some relevant database tables and their equivalent in Civi:
290
GIFT	civicrm_contribution
291
GiftSplit	civicrm_line_item
292
CAMPAIGN	Roughly maps to Campaign.  Your mapping may vary and/or include custom fields.
293
APPEAL	Also roughly maps to Campaign (or Source).  Your mapping may vary and/or include custom fields.
294
FUND	Roughly maps to Financial Type, but you might choose to import as a custom field instead.
295
296
See "Campaigns, Appeals, Packages" below for more.
297
298
Finally, note that RE has a concept of an "Adjustment".  If a gift has already been posted to the accounting software, you can't simply change the amount.  You create an adjustment, which has the updated data, and the two gift records are linked via the AdjustmentId.  This is also how pledge installments are written off (see "Pledges" below).
299
300
Note that gift type is hardcoded into a function called "TranslateGiftType) - so you may want to include that function in your SQL, e.g.:
301 10 Jon Goldberg
```sql
302 1 Jon Goldberg
SELECT
303
gs.GiftId
304
, g.CONSTIT_ID
305
, gs.Amount
306
, g.DTE as gift_date
307
, FUND.DESCRIPTION as fund
308
, CAMPAIGN.DESCRIPTION as campaign
309
, APPEAL.DESCRIPTION as appeal
310
, g.PAYMENT_TYPE
311
, g.ACKNOWLEDGE_FLAG
312
, g.CHECK_NUMBER
313
, g.CHECK_DATE
314
, g.BATCH_NUMBER
315
, g.ANONYMOUS
316
, gst.LONGDESCRIPTION as giftsubtype
317
, g.TYPE
318
, DBO.TranslateGiftType(g.TYPE) as type2
319
FROM GiftSplit gs
320
LEFT JOIN FUND on gs.FundId = FUND.id
321
LEFT JOIN APPEAL on gs.AppealId = APPEAL.id
322
LEFT JOIN CAMPAIGN on gs.CampaignId = CAMPAIGN.id 
323
LEFT JOIN GIFT g on gs.GiftId = g.ID
324
LEFT JOIN TABLEENTRIES gst on g.GIFTSUBTYPE = gst.TABLEENTRIESID
325
```
326
327
(See here: http://www.re-decoded.com/2013/07/payment-type-or-payment-method-id-reference/#more-714)
328
329
Payment Type is also hard-coded, it seems:
330
1	Cash
331
2	Personal Check
332
3	Business Check
333
4	Credit Card
334
5 	Standing Order
335
6	Direct Debit
336
7	Voucher
337
8	Other
338
339
### Soft Credits
340
341
Stored in GIFTSOFTCREDIT.  RE does NOT have the concept of a soft credit type - which is fine.
342 11 Jon Goldberg
```sql
343 1 Jon Goldberg
SELECT
344
, GiftId
345
, ConstitId
346
, Amount
347
, 'Soft Credit' as soft_credit_type
348
FROM GiftSoftCredit
349
```
350
351
### Solicitor, Gift
352
353
(Important!  Gift solicitors are different from Contact Solicitors)
354
355
I imported these as soft credits, but a different TYPE of soft credit.  Here's the SQL I used to get the data out of RE:
356 12 Jon Goldberg
```sql
357 1 Jon Goldberg
SELECT
358
ParentId as gift_id
359
, SolicitorId as soft_creditee_external_identifier
360
, Amount
361
, 'Solicitor' as soft_credit_type
362
FROM GiftSolicitor
363
```
364
365
### In Honor/Memorial Of (aka Tributes)
366
367
As of CiviCRM 4.5, In Honor/Memorial of is considered a form of soft credit.  In RE, they're still separate, and are called Tributes.  The structure is a little more complex - the table structure is Constituent <-> Tribute <-> Gift_Tribute <-> Gift.  Civi is Contact <-> Soft Credit <-> Contribution.  
368
369
Here is some preliminary SQL that pulls tribute data suitable for transformation and import to Civi as ContributionSoft entities.  Note that CiviCRM doesn't have a concept of a "Description" but does have the concept of a PCP Note, so I'm importing the description there - in the future, I could see the argument for Civi exposing the PCP Note as a description.
370
371
SELECT
372 13 Jon Goldberg
```sql
373 1 Jon Goldberg
gt.GIFT_ID
374
, gt.TRIBUTE_TYPE
375
, t.DESCRIPTION
376
, t.RECORDS_ID as tributee_extenal_identifier
377
, te.LONGDESCRIPTION as tribute_type
378
FROM GIFT_TRIBUTE gt
379
JOIN TRIBUTE t ON gt.TRIBUTE_ID = t.ID
380
LEFT JOIN TABLEENTRIES te on gt.TRIBUTE_TYPE = te.TABLEENTRIESID
381
```
382
383
### Pledges
384
385
Here are the relevant tables and their equivalents in Civi:
386 23 Jon Goldberg
```
387 1 Jon Goldberg
GIFT
388
Installment
389
InstallmentPayment
390 23 Jon Goldberg
```
391 1 Jon Goldberg
392 23 Jon Goldberg
`GIFT` is equivalent to `civicrm_contribution` AND to `civicrm_pledge`.  Pledges and contributions are stored in the same table - so a pledge paid in six installments will have SEVEN records in the `GIFT` field.  One will be of Gift Type `Pledge` or `MG Pledge` ("Matching Gift Pledge").  MG Pledges will be on the original donor, with the payment on the matching donor.  You can also tell pledges by the presence of the `INSTALLMENT_FREQUENCY`, `NUMBER_OF_INSTALLMENTS`, `FrequencyDescription`, `REMIND_FLAG`, `NextTransactionDate` and the `Schedule*` fields.  Note that some of these might also be used for recurring contributions.  
393 1 Jon Goldberg
394
`Installment` and `InstallmentPayment` are, when combined, the equivalent of the `civicrm_pledge_payment` table.  `civicrm_pledge_payment` has a field `scheduled_amount` and `actual_amount`.  RE's model is somewhat superior in that it allows partial payments on a pledge installment.
395
396
*Notes:* When creating pledges in CiviCRM via API, the open pledge payments are simultaneously created.  To import pledge payments from RE, you first want to delete the auto-generated pledge payments, then import your own pledge payments.  Finally, when importing pledge payments, the status of the parent pledge isn't updated.  So you'll probably want some SQL to indicate whether the pledges are pending, complete or canceled, depending on the status of the pledge payments.  Finally, watch out for adjustments, which is how some or all pledge installments might be marked as "Written Off" in RE.
397
398
The INSTALLMENT_FREQUENCY list is hard-coded:
399 14 Jon Goldberg
```
400
1 Annually
401
2 Every 6 Months
402
3 Every 3 Months
403
4 Every 2 Months
404
5 Every Month
405
6 Due Twice/Month
406
9 Irregular
407
10 Single Installment
408
```
409 1 Jon Goldberg
410
Some SQL:
411 14 Jon Goldberg
```sql
412 1 Jon Goldberg
/* Find all GIFT records with one or more associated Installment records.  These are pledges OR recurring gifts. */
413
SELECT DISTINCT
414
g.CONSTIT_ID
415
, g.ID as GiftId
416
, g.Amount
417
, g.DTE as receive_date
418
, FUND.DESCRIPTION as fund
419
, FUND.FUND_ID
420
, CAMPAIGN.DESCRIPTION as campaign
421
, APPEAL.DESCRIPTION as appeal
422
, g.PAYMENT_TYPE
423
, g.ACKNOWLEDGEDATE
424
, DBO.TranslateGiftType(g.TYPE) as type
425
, g.REF as note
426
,DATE_1ST_PAY
427
,g.DATEADDED
428
,g.DATECHANGED
429
,INSTALLMENT_FREQUENCY
430
,NUMBER_OF_INSTALLMENTS
431
,POST_DATE
432
,POST_STATUS
433
,REMIND_FLAG
434
,Schedule_Month
435
,Schedule_DayOfMonth
436
,Schedule_MonthlyDayOfWeek
437
,Schedule_Spacing
438
,Schedule_MonthlyType
439
,Schedule_MonthlyOrdinal
440
,Schedule_WeeklyDayOfWeek
441
,Schedule_DayOfMonth2
442
,Schedule_SMDayType1
443
,Schedule_SMDayType2
444
,NextTransactionDate
445
,Schedule_EndDate
446
,FrequencyDescription
447
, r.CONSTITUENT_ID
448
FROM Gift g
449
LEFT JOIN GiftSplit gs on g.ID = gs.GiftId
450
LEFT JOIN FUND on gs.FundId = FUND.id
451
LEFT JOIN APPEAL on gs.AppealId = APPEAL.id
452
LEFT JOIN CAMPAIGN on gs.CampaignId = CAMPAIGN.id 
453
LEFT JOIN RECORDS r ON g.CONSTIT_ID = r.ID
454
JOIN Installment i ON g.ID = i.PledgeId
455
```
456
457
Find pledge payments:
458 14 Jon Goldberg
```sql
459 1 Jon Goldberg
/* Find all pledge installments, and their related payments if they exist. */
460
SELECT
461
i.InstallmentId
462
, i.PledgeId
463
, i.AdjustmentId
464
, i.Amount as scheduled_amount
465
, i.Dte
466
, ip.Amount as actual_amount
467
, ip.PaymentId
468
, g.CONSTIT_ID
469
, g.RECEIPT_AMOUNT
470
, g.DTE as receive_date
471
, g.TYPE
472
, DBO.TranslateGiftType(g.TYPE) as type
473
FROM Installment i
474
LEFT JOIN InstallmentPayment ip ON i.InstallmentId = ip.InstallmentId
475
LEFT JOIN GIFT g ON ip.PaymentId = g.ID
476
/* Adjustments are stored in here too - when an adjustment happens, the pledge ID of the original value is blanked */
477
WHERE i.PledgeId IS NOT NULL 
478
ORDER BY i.AdjustmentId
479
/* Write-off Types: Covenant WriteOff, MG Write Off, Write Off */
480
```
481 23 Jon Goldberg
482 24 Jon Goldberg
#### Matching gifts
483
Gifts are connected to their matching gift via the `GiftMatchingGift` table, and appear in both the matched person's and matcher's "gifts" tab.
484
485 23 Jon Goldberg
#### Pledges as contributions
486
If you're working with an organization that wants to use CiviAccounts, you'll want to track pledges as pending contributions.
487 1 Jon Goldberg
488
## Campaigns, Appeals, Packages
489
490
RE's model for campaigns is hierarchical and more sophisticated than CiviCRM's.  A campaign (e.g. "Capital fundraising FY2017") can consist of several appeals (e.g. "Capital fundraising FY 2017 Spring Mailing").  Appeals will generally correspond to a particular action, especially a postal mailing.  Campaigns and Appeals _can_ be linked in a many-to-many relationship, but this is rare.  The 1-to-many is by far the most common approach.  Finally, an appeal can consist of "packages", which is a segment of your appeal.  For instance, a single mailing ("appeal") could go out to major donors, regular donors and non-donors.  You might also A/B test envelopes vs. postcards in the same mailing.  This would result in a total of six "packages" for a single appeal.  RE can track goals for each separately, and easily report on "number solicited" by package vs. number of gifts received.
491
492
## Actions
493
494
Actions fill the same purpose as Activities in CiviCRM, but are architected quite differently - in some ways better, some ways worse.  I don't have as much concrete info here, but here's a decent start at extracting Actions data via SQL:
495 15 Jon Goldberg
```sql
496 1 Jon Goldberg
SELECT
497
  a.ADDED_BY
498
, a.AUTO_REMIND
499
, a.RECORDS_ID as external_identifier
500
, cr.RELATION_ID as action_contact_id
501
, a.DTE as activity_date_time
502
, LETTER.LONGDESCRIPTION as letter
503
, a.PRIORITY as priority_id
504
, a.REMIND_VALUE
505
, a.CATEGORY
506
, a.Completed
507
, a.COMPLETED_DATE
508
, a.FUND_ID
509
, a.FOLLOWUPTO_ID
510
, a.TRACKACTION_ID
511
, a.PhoneNumber as phone_number
512
, a.Remind_Frequency
513
, a.WORDDOCNAME
514
, a.APPEAL_ID
515
, a.APPEAL_LETTER_CODE
516
, a.OUTLOOK_EMAIL_SUBJECT
517
, STATUS.LONGDESCRIPTION as status
518
, TYPE.LONGDESCRIPTION as type
519
, LOCATION.LONGDESCRIPTION as location
520
, ActionNotepad.ActualNotes
521
, CAMPAIGN.DESCRIPTION as campaign
522
FROM ACTIONS a
523
LEFT JOIN TABLEENTRIES as STATUS ON a.STATUS = STATUS.TABLEENTRIESID
524
LEFT JOIN TABLEENTRIES as TYPE ON a.[TYPE] = [TYPE].TABLEENTRIESID
525
LEFT JOIN TABLEENTRIES as LOCATION ON a.[Location] = LOCATION.TABLEENTRIESID 
526
LEFT JOIN TABLEENTRIES as LETTER on a.[LETTER_CODE] = LETTER.TABLEENTRIESID
527
LEFT JOIN ActionNotepad ON a.ID = ActionNotepad.ParentId
528
LEFT JOIN CAMPAIGN on a.CAMPAIGN_ID = CAMPAIGN.id
529
LEFT JOIN CONSTIT_RELATIONSHIPS cr on a.CONTACT_ID = cr.ID
530
```
531
532
"Category" and "Action type" both roughly map to "Activity Type".  Same for "status" and "COMPLETED" and "COMPLETED_DATE" mapping to "activity_status".  RE lets you designate a related Campaign, Fund and Proposal; out of the box, Civi only supports Campaign.  The auto-reminder is more flexible than you can get with scheduled reminders in Civi without getting very complicated.  "Solicitors" can't be mapped to a contact reference lookup, because more than one can be stored.
533
534
*Note:* The SQL above presumes only one note per action.  If you have multiple notes per action, the action will be represented with multiple records, one per associated note.  I'll try to provide SQL for extracting the notes separately at a later date.
535
536
## Action Notes
537
538
Action Notes are stored in their own table.  This maps to "Details" on a Civi activity, but you can log multiple notes per action in RE.  Here's the SQL I used to extract them in preparation:
539 16 Jon Goldberg
```sql
540 1 Jon Goldberg
SELECT
541
  NotesID
542
, Title
543
, Description
544
, Author
545
, ActualNotes
546
, ParentId
547
, NotepadDate
548
, TABLEENTRIES.LONGDESCRIPTION as Type
549
  FROM ActionNotepad
550
  LEFT JOIN TABLEENTRIES ON ActionNotepad.NoteTypeId = TABLEENTRIES.TABLEENTRIESID
551
ORDER BY ParentId, ActionNotepad."SEQUENCE"
552
```
553
554
## Events
555
556
Events are stored fairly similarly to CiviCRM, except:
557
* locations are stored on the event record itself (which I'm not dealing with).
558
* There's fields for storing data about classes.  I haven't delved into this - I suspect that this may tie into recurring events.
559
* "Event Category" and "Event Type" might both map to Civi's "Event Type".  This isn't the case for me.
560
* Events need not have begin/end dates.  While this is technically true for Civi, you're buying yourself a whole lot of trouble.  I'm pulling in "DATE_ADDED" to substitute in for START_DATE where none exists.
561
562
Here's some SQL to pull in the most relevant data:
563 17 Jon Goldberg
```sql
564 1 Jon Goldberg
SELECT
565
  se.CAPACITY
566
, se.END_DATE
567
, se.ID
568
, se.NAME
569
, se.START_DATE
570
, se.DATE_ADDED
571
, te.LONGDESCRIPTION as activity_type
572
, se.INACTIVE
573
, se.DISPLAYONCALENDAR
574
, CAMPAIGN.DESCRIPTION as campaign
575
, se.DESCRIPTION
576
FROM SPECIAL_EVENT se
577
LEFT JOIN CAMPAIGN on se.CAMPAIGN_ID = CAMPAIGN.id 
578
LEFT JOIN TABLEENTRIES te ON se.TYPEID = te.TABLEENTRIESID
579
```
580
581
## Notes
582
583
RE notes (stored in the "ConstituentNotepad" table) can store quite a bit of data that Civi notes can not.  They can store formatting (but with proprietary format tags, not HTML), inline photos, etc, and contain fields for date of note (separate from "Date Added" and "Date Changed"), the type of note, etc.  Fortunately, they store plain-text versions of formatted notes in their own field.  "Notes" is formatted; "ActualNotes" is plain text (except, well, where it isn't). 
584
585
I've resolved this by removing notes over a certain length (above 15K and I assume you're a photo) and concatenating the fields I want to keep (e.g. Note Type and Description) with the ActualNotes field.
586
587
It may be possible to export the photos in the Notes using the techniques described below under "Media".
588
589
Here's the SQL I'm currently using to extract notes before doing transforms in Kettle:
590 18 Jon Goldberg
```sql
591 1 Jon Goldberg
SELECT
592
Title as subject
593
, Description
594
, Author
595
, ActualNotes
596
, ParentId
597
, cn.DateChanged
598
, LONGDESCRIPTION as NoteType
599
FROM ConstituentNotepad cn
600
LEFT JOIN TABLEENTRIES ON NoteTypeId = TABLEENTRIESID
601
```
602 22 Jon Goldberg
603
## Localization formats
604
Raiser's Edge stores most of this info in the `COUNTRY_CODES` table, though the actual country name is stored in `TABLEENTRIES`.  This SQL will get you both:
605
```sql
606
SELECT LONGDESCRIPTION, COUNTRY_CODES.*
607
  FROM COUNTRY_CODES
608
  JOIN TABLEENTRIES ON COUNTRY_CODES.COUNTRYCODESID = TABLEENTRIES.TABLEENTRIESID
609
```
610
611
Address formats (stored in Civi in `civicrm_address_format`) are stored in `COUNTRY_LABELS`.  You can add ass many tokens (`FIELD_NUM`) to a line (`LINE_NUM`) and they'll appear in order of `SEQUENCE`).  I couldn't find a lookup table in the database that translated the tokens, but here it is:
612
```
613
1 = Address lines
614
2 = City
615
3 = State/Province
616
4 = Postcode
617
5 = Country
618
6 = Country abbreviation
619
9 = County
620
101 = :
621
102 = ,
622
103 = -
623
104 = .
624
105 = /
625
106 = <space>
626
```
627
628 21 Jon Goldberg
## Financial accounts
629
I believe that their presence in RE is set by a flag `GENERAL_INFORMATION.GL_PRESENT`, with `GENERAL_INFORMATION.GL_ENG_TYPE` playing a role (I believe dealing with Financial Edge integration).
630
The relevant fields are:
631
* `FUND` (relates to `GIFT.FundId`).
632
* `FUNDDISTRIBUTION` (connector table, also connects to Gift Type and Subtype, which are also set on the Gift.  You can have different Financial Accounts based on a combination of FundId, TypeId, and SubTypeId).
633
* `GLDISTRIBUTIONDETAIL` (Contains GL Account codes, etc. Looks like it contains some Quickbooks integration fields. Most similar to `civicrm_financial_account`.)
634
* `GLDISTRIBUTION` (This also links to `FUNDDISTRIBUTION` but AFAICT has no data that needs migrating to CiviCRM).
635
636
## Misc
637
638
Some RE tables and what they're for (and their equivalents in Civi if applicable):
639
`GENERAL_INFORMATION`: Similar to both `civicrm_domain` and `civicrm_settings`.  Version number, Organization name, license number, general settings, etc.
640 1 Jon Goldberg
641
## Media
642
643
### Exporting from RE
644
645
The files stored on the "Media" tab are held in the [dbo].[MEDIA] table in MS SQL.  Assuming embedded and not linked data, the files are stored in the MS Access OLE format.  It's relatively difficult to extract data from the OLE wrapper, though searching for `extract access ole` on any search engine will give you lots of options in a variety of languages.  Blackbaud even has code to do it "here":https://kb.blackbaud.com/articles/Article/58559, if you feel like using VBA.
646
647 19 Jon Goldberg
I opted to use a commercial software package from Yohz Software called "SQL Image Viewer":http://www.yohz.com/siv_details.htm.  If you use this tool, enter the command: 
648
```sql
649 1 Jon Goldberg
SELECT OBJECT FROM [dbo].[MEDIA]
650
```
651
652
Then press "Execute Query", then press "Export" when it's done.  This exports about 200 items/minute on a computer with a very slow hard drive.
653
654
If you want to decode the OLE containers on your own, there's the "bcp":https://msdn.microsoft.com/en-us/library/ms162802.aspx CLI tool that installs with MS SQL, and you can run a SQL query from SQL Server Management Studio that extracts your OLE containers; see "here":http://dba.stackexchange.com/questions/80817/how-to-export-an-image-column-to-files-in-sql-server.  I experimented with this strategy, and this CLI command extracted an Access OLE container:
655
```
656
bcp "SELECT OBJECT FROM [July_Snapshot].[dbo].[media] WHERE ID = 1210 " queryout "C:\Users\Jon\Desktop\temp\test.ole" -T -N -S HOSTNAME\RE_EXPRESS
657
```
658
659
### Importing into CiviCRM
660
661
The approach I took was to copy all the files into the "custom files" directory as specified in *Administer > System Settings > Directories*.  Then I used the Attachment entity of the API to import the file to an activity.  For the Media tab, I created activities especially to import the media onto.
662
663
Here's an example of the correct usage of the API to add in image "drill.jpg" to an activity with an ID of 628:
664 19 Jon Goldberg
```php
665 1 Jon Goldberg
$result = civicrm_api3('Attachment', 'create', array(
666
  'sequential' => 1,
667
  'name' => "drill.jpg",
668
  'mime_type' => "image/jpeg",
669
  'entity_id' => 628,
670
  'entity_table' => "civicrm_activity",
671
  'options' => array('move-file' => "/home/jon/local/civicrm-buildkit/build/d46/sites/default/files/civicrm/custom/drill.jpg"),
672
));
673
```
674
675
Note that Civi will rename your files with random characters at the end, so this action is not idempotent.  Keep a reserve copy of your exported RE media to roll back to!
676
677
If you use the API CSV import tool, your CSVs should look like this:
678
```
679
"name",entity_id,"entity_table","mime_type","options.move-file"
680
"100.png",87511,"civicrm_activity","image/png","/home/jon/local/lccr/wp-content/plugins/files/civicrm/custom/100.png"
681
"1000.pdf",88411,"civicrm_activity","application/pdf","/home/jon/local/lccr/wp-content/plugins/files/civicrm/custom/1000.pdf"
682
```
683
684
## And More
685
686
### Tables that Civi doesn't have a direct counterpart for
687
688
* Aliases (stores Maiden Name and d/b/a - unsure how to import into Civi just yet)
689
* Solicitor Goals - Can be found on an RE contact record on "Bio 1" tab by clicking "Details" next to "Is a Solicitor" checkbox.  Don't know how to use them.
690
691
692
Open each CSV file in Excel or similar.  Sort each field by ascending AND descending to see if any data is stored in that field.  If every record has no data or the same data, delete it - it's not being tracked in the current system.  If you see only one or two records with a particular field, they're also probably fine to go, but check with the client first.
693
694
695
Next, strip out all of the constituent information except for primary/foreign keys.  I like to keep in First/Middle/Last name just for human readability though.  So leave in those three fields, plus any field with the word "ID" in it.  This is your base constituent info, and will be in every other export you do.
696
697
Now comes the fun part!  Export each table, one at a time, by adding those fields to an export that already includes the base constituent info.
698
699
For one-to-many relationships, the system will ask you how many instances of the information to export.  I default to 12, then look over the data to see how many are actually used, then re-export with a higher or lower number.
700
701
I also remove records that don't contain the relevant data.  For instance, when exporting Solicit Codes, I sort by the first Solicit Code.  Then I scroll down past the folks that have Solicit Codes to those who have none, and delete the rows for folks who have none.
702
703
Note that for simplicity's sake, RE contains many views of the tables that, if you export them all, you'll have redundant data.  There's no need to export "First Gift", "Last Gift", or "Largest Gift" - simply export all gifts.  Likewise for "Preferred Address".
704
705
When exporting one-to-many tables that themselves contain one-to-many tables (e.g. Addresses contains Phones), do NOT select 12 of each!  That means you're exporting 144 phone numbers per record.  First determine the maximum number of addresses being tracked, re-export with that number, THEN export with phone numbers.  Also, it's reasonable to export with 5 phone numbers per address.
706
707
NOTE: Letters sent is incomplete, there's more than 12 letters to some folks!
708
709
GIFTS is related to constituent on the last column (Constituent System Record ID)
710
711
### Code Tables/Option Groups/Option Values
712
713
If you're extracting data from the SQL back-end, you'll see that the RE equivalent to Civi option groups is "code tables".  There's two functions that handle lookups: dbo.GetTableEntryDescription and dbo.GetTableEntryDescSlim.  To determine where the data is being accessed by the function, see "Deciphering MS SQL", below.  Use the "lTableNumber" passed to those functions and you'll find your data in dbo.CODETABLES (comparable to civicrm_option_group), dbo.CODETABLEMAP and dbo.TABLEENTRIES (comparable to civicrm_option_value).
714
715
## Deciphering MS SQL
716
717
SQL Server Profiler is a tool that lets you spy on SQL statements passed to MS SQL, which is good for determining where certain data lives.  However, RE depends on functions and stored procedures, so sometimes the SQL won't tell you exactly where to look.
718
719
### Looking Up Functions
720
721
These are embedded in SQL and have a nomenclature like: dbo.GetTableEntryDescSlim. Find them in SQL Server Management Studio: database > Programmability > Functions > Scalar-valued Functions.
722
723
### Looking Up Stored Procedures
724
725
If, in the profiler, taking a certain action shows a command like this:
726
These have a syntax like:
727 19 Jon Goldberg
```sql
728 1 Jon Goldberg
exec sp_execute 48,43,'Acknowledgee'
729
```
730
731
You're dealing with a stored procedure.  You need to find the corresponding `exec sp_prepexec` command (in this case, the one with a 48).  In this case, it looks like:
732 19 Jon Goldberg
```sql
733 1 Jon Goldberg
declare `p1 int
734
set `p1=48
735
exec sp_prepexec `p1 output,N'`P1 int,`P2 varchar(255)',N'SELECT  Top 1 TABLEENTRIESID  FROM DBO.TABLEENTRIES WHERE CODETABLESID = `P1 AND LONGDESCRIPTION = `P2  ',43,'Acknowledgee'
736
select `p1
737
```
738
739
Note that there's a tool called "SQL Hunting Dog", a free plug-in for SQL Server Management Studio, which makes locating stored procedures, etc. easier.
740
741
### Addressee/Postal Greeting/E-mail greeting
742
743
RE has a much wider variety of greeting formats out-of-the-box.  The "spouse ID" is stored on the record to enable quick lookups of addressee greetings that include the spouse.
744
745
It's likely that you'll want to map existing RE greetings to Civi greetings.  Here is some SQL that will show you how the current greetings in RE are constructed:
746 19 Jon Goldberg
```sql
747 1 Jon Goldberg
/****** Script for SelectTopNRows command from SSMS  ******/
748
SELECT s.ID
749
, sf1.FIELDNAME as FIELD1
750
, sf2.FIELDNAME as FIELD2
751
, sf3.FIELDNAME as FIELD3
752
, sf4.FIELDNAME as FIELD4
753
, sf5.FIELDNAME as FIELD5
754
, sf6.FIELDNAME as FIELD6
755
, sf7.FIELDNAME as FIELD7
756
, sf8.FIELDNAME as FIELD8
757
, sf9.FIELDNAME as FIELD9
758
, sf10.FIELDNAME as FIELD10     
759
, sf11.FIELDNAME as FIELD11
760
, sf12.FIELDNAME as FIELD12
761
, sf13.FIELDNAME as FIELD13
762
, sf14.FIELDNAME as FIELD14
763
, sf15.FIELDNAME as FIELD15
764
, sf16.FIELDNAME as FIELD16
765
, sf17.FIELDNAME as FIELD17
766
, sf18.FIELDNAME as FIELD18
767
, sf19.FIELDNAME as FIELD19
768
, sf20.FIELDNAME as FIELD20
769
  FROM SALUTATIONS s
770
  LEFT JOIN SALUTATION_FIELDS sf1 on CODE1 = sf1.ID
771
  LEFT JOIN SALUTATION_FIELDS sf2 on CODE2 = sf2.ID
772
  LEFT JOIN SALUTATION_FIELDS sf3 on CODE3 = sf3.ID
773
  LEFT JOIN SALUTATION_FIELDS sf4 on CODE4 = sf4.ID
774
  LEFT JOIN SALUTATION_FIELDS sf5 on CODE5 = sf5.ID
775
  LEFT JOIN SALUTATION_FIELDS sf6 on CODE6 = sf6.ID
776
  LEFT JOIN SALUTATION_FIELDS sf7 on CODE7 = sf7.ID
777
  LEFT JOIN SALUTATION_FIELDS sf8 on CODE8 = sf8.ID
778
  LEFT JOIN SALUTATION_FIELDS sf9 on CODE9 = sf9.ID
779
  LEFT JOIN SALUTATION_FIELDS sf10 on CODE10 = sf10.ID
780
  LEFT JOIN SALUTATION_FIELDS sf11 on CODE11 = sf11.ID
781
  LEFT JOIN SALUTATION_FIELDS sf12 on CODE12 = sf12.ID
782
  LEFT JOIN SALUTATION_FIELDS sf13 on CODE13 = sf13.ID
783
  LEFT JOIN SALUTATION_FIELDS sf14 on CODE14 = sf14.ID
784
  LEFT JOIN SALUTATION_FIELDS sf15 on CODE15 = sf15.ID
785
  LEFT JOIN SALUTATION_FIELDS sf16 on CODE16 = sf16.ID
786
  LEFT JOIN SALUTATION_FIELDS sf17 on CODE17 = sf17.ID
787
  LEFT JOIN SALUTATION_FIELDS sf18 on CODE18 = sf18.ID
788
  LEFT JOIN SALUTATION_FIELDS sf19 on CODE19 = sf19.ID
789
  LEFT JOIN SALUTATION_FIELDS sf20 on CODE20 = sf20.ID
790 20 Jon Goldberg
```
791 1 Jon Goldberg
792
793
### Things I see that RE does better than Civi:
794
795
* Better greetings/salutations UI out of the box.  In Civi, you must in-line edit the greetings, then press "Edit" next to the greetings, and even then you only see the tokens you'll use.  RE lets you edit with no clicks, and parses the tokens for you.
796
* The equivalent of option values are stored with their id, not their value.  This isn't a big deal, but it DOES make data transformation easier in RE, and I suspect it makes their equivalent of pseudoconstant code easier to read.
797
* There's a lot more data stored in many-to-many tables.  For instance, job titles are stored in the relationship tab, reflecting the fact that someone can have more than one job.