Project

General

Profile

Exporting Salsa for CiviCRM » History » Version 36

Jon Goldberg, 01/22/2015 05:28 PM

1 24 Jon Goldberg
{{lastupdated_at}} by {{lastupdated_by}}
2
3 1 Jon Goldberg
h1. Exporting Salsa for CiviCRM
4
5 2 Jon Goldberg
When logged in as a Manager, "Query/Export" will give you a full export of contact data.  There's a "Select My Entire List" button.  There's also an "include my deleted supporters" checkbox, which you may want to check (but probably not).  This will NOT get you groups/tags.
6 1 Jon Goldberg
7 14 Jon Goldberg
h2. Exporting Data not on the Contact Entity
8 2 Jon Goldberg
9 25 Jon Goldberg
You need to get to custom reports.  If you have the Reports tab, great; if not, you can get there by clicking "Supporter Management" tab, then "Built-in Reports", then "Clone and Edit" a report, then select "List Your Custom Reports".  Or go straight here: https://hq-org.salsalabs.com/dia/hq/reports/list.jsp?table=report
10 1 Jon Goldberg
11 8 Jon Goldberg
*Important*: When selecting foreign keys (e.g. "Supporter KEY") from the Columns tab, be sure to give a custom label.  This will cause the key to display correctly, instead of giving a link to the supporter's record.
12
13 11 Jon Goldberg
h3. Groups
14 12 Jon Goldberg
15 3 Jon Goldberg
* Create a new report.
16
* Select the type of report you would like to create: Standard report
17
* Use "Advanced Object Chooser".
18 9 Jon Goldberg
* Report "Supporter Groups", then "Groups".  Press "Save".
19 1 Jon Goldberg
* Select the "Columns" tab and select your columns.  I like just "Supporter Key" and "Group Name".
20 7 Jon Goldberg
* In Conditions, "Group Name" should be "Not Empty".
21 4 Jon Goldberg
* Save, Run the report.
22
* Click the "Export" link.
23 1 Jon Goldberg
24 11 Jon Goldberg
h3. Tags
25 12 Jon Goldberg
26 5 Jon Goldberg
* Create a new report.
27
* Select the type of report you would like to create: Standard report
28
* Use "Advanced Object Chooser".
29
* Report on "Tags", then "Tags Data", then "Database Table".  Press "Save".
30
* Select the "Columns" tab and select your columns.  I like just "Tag" and "Table Key".
31 1 Jon Goldberg
** "Table Key" is the Supporter Key.  It's similar to "entity_id" in CiviCRM.
32 7 Jon Goldberg
* In "Conditions", "Table Name" should equal "supporter".
33 10 Jon Goldberg
* Add another condition: "Tag.Tag" is "Not Empty".
34 1 Jon Goldberg
* Save, Run the report.
35
* Click the "Export" link.
36
37 11 Jon Goldberg
h3. Events
38 1 Jon Goldberg
39 15 Jon Goldberg
As above, but no conditions, and report on the "Event" table.  If you're only importing legacy events, this is a good list of easy fields to import:
40
Event KEY
41
Reference Name
42
Event Name
43
Description
44
Start
45
End
46
Deadline
47
Maximum Attendees
48
49 1 Jon Goldberg
h3. Participants
50 16 Jon Goldberg
51
As above.  Report on tables "Supporter Event", then "Event".  Note that there are a lot of tables that _look_ like "Supporter Event", like "Supporterevent" and "Supporter Events"!
52
53
Note that if you're matching on a unique field from "Events", you can just export "Supporter Event" and not the "Event" table.
54
Here are the fields I exported and what I matched them to:
55
Supporter KEY	external_identifier
56
Event KEY	event_key
57
Status	status
58
Type	role
59
Date Created	register_date
60
61 28 Jon Goldberg
h3. Recurring Donations
62
63
Export on table "Recurring Donation".  Here's the field mapping:
64
65
Recurring Donation Key -> trxn_id
66
Supporter Key -> external_identifier
67
Transaction date -> create_date
68
Start Date -> start_date
69
RPREF -> invoice_id
70
RESULT (exclude 37, they're tests)
71
Amount -> amount
72
Pay Period -> use to remap to frequency_unit and frequency_interval
73
TERM -> installments
74
Status(?)
75
76
Note that in Salsa, there's no clear-cut way to tell whether a contact's recurring donation is still working or not - "Status" isn't a complete indicator, and thus doesn't cleanly map into Civi.
77
78 27 Jon Goldberg
h3. Donations
79
80
It's important to link the recurring donations to the donations when exporting if you need to identify the first recurring donation (e.g. to generate thank-you letters if it's a first donation and recurring).
81
82 30 Jon Goldberg
Under "Conditions", filter by "Supporter KEY is not empty" - when Salsa imports legacy data into their system, sometimes they don't do such a hot job.
83
84 29 Jon Goldberg
Export on table "Donation" linked to table "Donate Page".  You'll want these fields (more or less):
85 27 Jon Goldberg
86
Donation.donation KEY(donation)	
87 1 Jon Goldberg
Donation.supporter KEY(donation)
88 29 Jon Goldberg
donate_page.Reference_Name
89
Donation.Date_Entered
90 27 Jon Goldberg
Donation.Transaction Date(donation)
91 1 Jon Goldberg
Donation.amount(donation)
92 27 Jon Goldberg
Donation.Transaction Type(donation)
93
Donation.RESULT(donation)
94
Donation.Tracking Code(donation)
95 29 Jon Goldberg
Donation.Designation Code(donation)
96 1 Jon Goldberg
Donation.In Honor Name(donation)
97 27 Jon Goldberg
Donation.In Honor Email(donation)
98
Donation.In Honor Address(donation)
99 1 Jon Goldberg
Recurring donation.Transaction Date(recurring_donation)
100 29 Jon Goldberg
Donation.Order_Info
101 27 Jon Goldberg
102 19 Jon Goldberg
h3. Actions
103 17 Jon Goldberg
104 19 Jon Goldberg
Salsa has a separate table for actions, making them structurally comparable to Civi Events.  A good match in Civi is the Survey entity, which is used for petitions.
105 1 Jon Goldberg
106 19 Jon Goldberg
Export as above. Report on table "Action".
107
Condition: "Reference Name" is not empty.
108
109
*Note*: "Description" is likely to contain HTML that breaks the export.  I find it helpful to export it as the last column.
110
111
h3. Supporter_Actions
112 11 Jon Goldberg
113 22 Jon Goldberg
Export "action" and "supporter_action" and "supporter_action_comment" in that order.
114 23 Jon Goldberg
Condition: supporter_key IS NOT NULL
115 20 Jon Goldberg
116
Here's the fields I grabbed with their mapping:
117 22 Jon Goldberg
supporter_action.supporter_key	
118 21 Jon Goldberg
action.Reference Name
119 22 Jon Goldberg
supporter_action.Date_Created
120
supporter_action_comment.Comment	details
121 20 Jon Goldberg
122 31 Jon Goldberg
h3. Letter to the Editor
123
124
This isn't a feature CiviCRM has, but it maps reasonably well to an activity when migrating.
125
* Create a new report.
126
* Select the type of report you would like to create: Standard report
127
* Use "Advanced Object Chooser".
128
* Report "Letter Supporter", then "Letter".  Press "Save".
129
* Select the "Columns" tab and select your columns:
130
> Date_Created -> activity_date_time
131
> supporter_KEY -> external_identifier
132
> person_media_ID? -> seems important - but I can't find a matching table, and this data doesn't seem to be accessible from Salsa.
133
> Letter_Subject -> details (concatenated)
134
> Letter_Content -> details
135
> Reference_Name -> subject
136
* Save, Run the report.
137
* Click the "Export" link.
138
139 11 Jon Goldberg
h3. Chapters
140 12 Jon Goldberg
141 7 Jon Goldberg
* Create a new report.
142 1 Jon Goldberg
* Select the type of report you would like to create: Standard report
143 7 Jon Goldberg
* Use "Advanced Object Chooser".
144 8 Jon Goldberg
* Report "Supporter Chapter", then "Chapter".  Press "Save".
145
* Select the "Columns" tab and select your columns.  I like just "Supporter KEY" and "Chapter.Name".
146
* In Conditions, "Chapter.Name" should be "Not Empty".
147 5 Jon Goldberg
* Save, Run the report.
148 1 Jon Goldberg
* Click the "Export" link.
149
150 32 Jon Goldberg
h2. Programmatically creating custom fields in CiviCRM
151
152
To do this, you'll need to create a custom group, custom fields, option groups, and option values.
153
154
h3. Custom Field Group
155
156
Don't export anything from Salsa - just create this manually, or using my Kettle transform.
157
158
h3. Custom Fields, Option Groups, Option Values
159
160 33 Jon Goldberg
_Custom Columns_
161
* Create a new report.
162
* Select the type of report you would like to create: Standard report
163
* Use "Advanced Object Chooser".
164
* Report "Custom Columns".  Press "Save".
165
* Select the "Columns" tab and select your columns:
166 36 Jon Goldberg
> custom_column_key -> needed to relate to custom_column_options.  Store in filter temporarily.
167 34 Jon Goldberg
> data_table (should = supporter_custom.  In theory, we can probably export non-contact custom fields in this same process)
168 33 Jon Goldberg
> Date_Created -> created_date
169
> name -> name
170
> label -> label
171
> type -> data_type, html_type (can be bool, enum, text, varchar)
172
> Description -> help_pre
173
> Order -> weight
174
* Save, Run the report.
175
* Click the "Export" link.
176 1 Jon Goldberg
177 35 Jon Goldberg
_Option Groups_
178 36 Jon Goldberg
These will be created automatically when you create custom fields.
179 35 Jon Goldberg
180 1 Jon Goldberg
_Custom Column Options_
181 33 Jon Goldberg
* Create a new report.
182
* Select the type of report you would like to create: Standard report
183
* Use "Advanced Object Chooser".
184
* Report "Custom Column Options".  Press "Save".
185
* Select the "Columns" tab and select your columns:
186 36 Jon Goldberg
> custom_column_KEY -> a lookup field (against civicrm_custom_field.filter to get option_group_id)
187 35 Jon Goldberg
> value -> value, name
188 33 Jon Goldberg
> label -> label
189
> isDefault -> is_default
190
> isDisplayed -> is_active
191
> _Order -> weight
192
* Save, Run the report.
193
* Click the "Export" link.
194 7 Jon Goldberg
195 1 Jon Goldberg
h3. Receive_Email field
196
197 26 Jon Goldberg
Here's a TSV of how to interpret the "Receive_Email" field.
198
|*code*|*meaning*|
199
|-24|INACTIVE: (5.1.1 User Unknown)|
200
|-26|INACTIVE: Address contains RFC spec. invalid characters / is improperly formatted|
201
|-3|INACTIVE: UNSUBSCRIBED (actively unsubscribed by user)|
202
|-30|INACTIVE (Reported as Spam): Other Blacklist (BLACKLIST)|
203
|-32|(Unknown Status)|
204
|-35|INACTIVE (Reported as Spam): Outblaze|
205
|-4|(Unknown Status)|
206
|-42|INACTIVE (Recipient Initiated Spam Report): MSN/Hotmail/WebTV|
207
|-44|INACTIVE (Recipient Initiated Spam Report): UNTI (Juno/NetZero/FreeServers)|
208
|-45|INACTIVE (Recipient Initiated Spam Report): Yahoo|
209
|-46|INACTIVE (Recipient Initiated Spam Report): Comcast.net|
210
|-47|INACTIVE (Recipient Initiated Spam Report): AOL|
211
|-48|INACTIVE (Recipient Initiated Spam Report): RoadRunner|
212
|-50|ISP Specific Bounces: AIM.com Unactivated account|
213
|-51|INACTIVE (Recipient Initiated Spam Report): Excite|
214
|-52|INACTIVE (Reported as Spam): Earthlink|
215
|-53|(Unknown Status)|
216
|-54|(Unknown Status)|
217
|-60|Bad Address/Expired address, etc (n.b.: These addresses are all @democracyinaction.org)|
218
|-9|INACTIVE: DEATH (supporter has died)|
219
|0|0 - Inactive or Unknown(not subscribed)|
220
|1|1 - Imported or unknown (subscribed)|
221
|10|ACTIVE: CONFIRMED (Double opt-in)|
222 1 Jon Goldberg
|3|ACTIVE: CLIENT (Client has directly signed up)|
Go to top