Database Reference

Key Table Diagrams

These entity-relationship diagrams (click each one to enlarge) show the relationships between the key tables for tracking users, subscription status, actions, donations, and mailings.

Common User Tables Common Action Tables Common Mailing Tables
Common User Tables Common Action Tables Common Mailing Tables

Action Tables

The action tables relate to user actions. Users take action anytime they submit on a page.

The following action tables are described below:

core_action

Every action submitted with associated user_id, page_id, and source.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for each action taken NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
user_id int(11) Joins to core_user on (core_action.user_id= core_user.id) NO MUL NULL  
mailing_id int(11) If user followed an email link to the action, the mailing id shows here. Joins to core_mailing. YES MUL NULL  
page_id int(11) Joins to core page on (core_page.id= core_action.page_id) NO MUL NULL  
link int(11) Not in use. YES   NULL  
source varchar(255) Whether the user came to this action from a website, mailing, TAF email, etc. NO   NULL  
opq_id varchar(255) Not in use. NO   NULL  
created_user tinyint(1) 1 if this is the first action ever taken by this user NO   NULL  
subscribed_user tinyint(1) 1 is this user was added to any of your mailings lists as a result of this action NO   NULL  
referring_user_id int(11) User_id of referrer, if the source of this action was TAF or a forwarded email. YES MUL NULL  
referring_mailing_id int(11) ID for the forwarded email if that was the action source. YES MUL NULL  
status varchar(255) Complete or incomplete. Incomplete only applies to certain page types. NO   NULL  
taf_emails_sent int(11) Number of friends' emails the action taker entered in the TAF widget. YES   NULL  
is_forwarded int(1) 0: action was not from a forwarded mailing. 1: action was from a forwarded mailing. NO   0  
ip_address varchar(15) IP address of the action taker. YES   NULL  

core_actionfield

Custom action fields; answers to survey questions (from any page type).

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
parent_id int(11) Joins to the action where you find the user_id and other info. Joins on (core_actionfield.parent_id= core_action.id) NO MUL NULL  
name varchar(255) Name of the survey question. Defined on the page using "name= action_[desiredname]" NO MUL NULL  
value longtext User's answer. NO   NULL  

core_actionnotification

Notification email to be sent to someone aside from the actiontaker after an action.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
hidden tinyint(1) 1=hidden NO   NULL  
name varchar(255) The name of the email notification. NO   NULL  
to varchar(255) Email recipient(s) YES   NULL  
from_line_id int(11) From line id for standard from line from mailer. YES MUL NULL  
custom_from varchar(255) Custom from line NO   NULL  
subject varchar(255) Email subject. NO   NULL  
wrapper_id int(11) Email wrapper. YES MUL NULL  
body longtext Notification email body. NO   NULL  

core_actionnotification_to_staff

Joins notification email from above with one or more staff user_ids to receive it.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
actionnotification_id int(11) Joins to action notification. NO MUL NULL  
user_id int(11) Joins to auth_user. NO MUL NULL  

core_callaction

Records every call action submitted and joins to core_action.

Field Type Description Null Key Default Extra
action_ptr_id int(11) id for an action submittal; Joins to core_actions NO PRI NULL  

Other Tables Following The Same Formula

Records every action of the given type submitted and joins to core_action.

Table Description
core_donationaction Records every donation action submitted and joins to core_action.
core_donationupdateaction Records every donationupdate action submitted and joins to core_action.
core_donationcancellationaction Records every donationcancellation action submitted and joins to core_action.
core_importaction Records every import action submitted and joins to core_action.
core_letteraction Records every letter action submitted and joins to core_action.
core_petitionaction Records every petition action submitted and joins to core_action.
core_recurringdonationcancelaction Records every recurringdonationcancel action submitted and joins to core_action.
core_recurringdonationupdateaction Records every recurringdonationupdate action submitted and joins to core_action.
core_redirectaction Records every redirect action submitted and joins to core_action.
core_signupaction Records every signup action submitted and joins to core_action.
core_surveyaction Records every survey action submitted and joins to core_action.
core_unsubscribeaction Records every unsubscribe action submitted and joins to core_action.
core_userupdateaction Records every userupdate action submitted and joins to core_action.
core_whipcountaction Records every whipcount action submitted and joins to core_action.

core_callaction_local_office_checked

Identifies which office the user indicated they called (if local offices were shown on the call page).

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
callaction_id int(11) Joins to core_action on (core_callaction_targeted.callaction_id= core_action.id) NO MUL NULL  
targetoffice_id int(11) Shows target offices listed for the action. Joins to targetoffice table on (core_callaction_local_office_checked.targetoffice_id= core_targetoffice.targetoffice_id) NO MUL NULL  

core_callaction_checked

Identifies which of the targets displayed on a call page the user indicated they called.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
callaction_id int(11) Joins to core_action. NO MUL NULL  
target_id int(11) Joins to core_target. NO MUL NULL  

core_callaction_targeted

Identifies who showed as targets for a specific user on a specific call page.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
callaction_id int(11) Joins to core_action on (core_callaction_targeted.callaction_id= core_action.id) NO MUL NULL  
target_id int(11) Shows targets listed for the action. Joins to target table on (core_callaction_targeted.target_id= core_target.target_id) NO MUL NULL  

Other tables following the same formula

Identifies targets for a specific user on the relevant page type.

Table Description
core_letteraction_targeted Identifies targets for a specific user taking action on a letter page.
core_petitionaction_targeted Identifies targets for a specific user taking action on a petition page.

core_campaignvolunteeraction

Records every volunteer moderator signup submitted and joins to core_action as well as the event campaign.

Field Type Description Null Key Default Extra
action_ptr_id int(11) id for an action submittal; Joins to core_actions NO PRI NULL  
campaign_id int(11) Event Campaign ID. Joins to event_campaign. NO PRI NULL  
volunteer_id int(11) ID for a specific volunteer moderator/event campaign combination. Joins to events_campaign_volunteer. NO PRI NULL  

core_eventcreateaction

Joins each event creation action in core_action to the event. Also links to the events table.

Field Type Description Null Key Default Extra
action_ptr_id int(11) id for an action submittal; Joins to core_action NO PRI NULL  
event_id int(11) Joins to events_event. NO MUL NULL  

core_eventmoderateaction

Joins each event moderation action in core_action to the event.

Field Type Description Null Key Default Extra
action_ptr_id int(11) id for an action submittal; Joins to core_action NO PRI NULL  
event_id int(11) Joins to events_event. NO MUL NULL  
approved_event tinyint(1) 1=yes. NO   NULL  
deleted_event tinyint(1) 1=yes. NO   NULL  

core_eventsignupaction

Joins attendee sign up in core_action to sign up record.

Field Type Description Null Key Default Extra
action_ptr_id int(11) id for an action submittal; Joins to core_action NO PRI NULL  
signup_id int(11) Joins to events_eventsignup, which includes event_id. NO MUL NULL  

core_eventvolunteeraction

Joins each event moderation volunteer signup in core_action to the event campaign.

Field Type Description Null Key Default Extra
action_ptr_id int(11) id for an action submittal; Joins to core_action NO PRI NULL  
campaign_id int(11) Joins to events_campaign. NO MUL NULL  
volunteer_id int(11) Joins to events_campaignvolunteer. NO MUL NULL  

core_lteaction

Joins each LTE action in core_action to the newspaper and includes the letter text. Also includes the users letter.

Field Type Description Null Key Default Extra
action_ptr_id int(11) id for an action submittal; Joins to core_action NO PRI NULL  
subject varchar(80) LTE subject submitted by user. NO   NULL  
letter_text longtext Body of the LTE submitted by user. NO   NULL  
target_id int(11) Joins to core_mediatarget. YES MUL NULL  

core_whipcountactioncalled

Records who was called for each whipcount action and the response recorded by the user.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
target_id int(11) joins core_target NO MUL NULL  
whipcountaction_id int(11) joins whipcountaction NO MUL NULL  
response varchar(255) Target position submitted by user. NO   NULL  

spam_spamchecklog

A history of actions that looked like spambots, malicious users, or that matched blacklists or whitelists.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI   auto_increment
created_at datetime   NO MUL    
updated_at datetime   NO      
check varchar(255) Check that matched this action. NO      
why text Details of the filter match. NO      
whitelisted tinyint(1) 1=Any spam check unsubscribing or suppressing was prevented because the IP address is whitelisted. NO      
action_id int(11) Unique identifier for user action. NO MUL    
action_status varchar(255) The action status before any filtering was applied. NO      
action_updated_at datetime   NO      
reversed tinyint(1) 1=Filtering applied to this action has been reversed. NO      
reversed_at datetime If the filtering has been reversed, the timestamp of the reversal. YES      

Page Tables

The Page tables define key elements of pages, like goals, advocacy targets, and what the user sees after they submit an action.

The following core page tables are described below:

core_allowedpagefield

Custom field created by your group to display text or activate custom code on a particular page.

Field Type Description Null Key Default Extra
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
hidden tinyint(1) 1=hidden NO MUL NULL  
order_index int(1) Sets the display order for page fields shown on the Basics screen and in the pull down display. NO   NULL  
display_name varchar(255) The display name is shown when selecting a custom field and may be changed in the future. Spaces, punctuation, etc are permitted. NO UNI NULL  
name varchar(255) Name of the custom page field. NO PRI NULL  
always_show tinyint(1) 1=show when creating pages. NO   0  
required tinyint(1) Value must be entered for this field before the page can be saved. NO   NULL  
description longtext Description of custom page field. YES   NULL  
field_type varchar(32) Choose how data should be entered in this field. NO   NULL  
field_default longtext Provide a default value that will be pre-filled wherever this field is displayed in the admin. NO   NULL  
field_choices longtext Values available if the list type is Select From List or Select From List with Other. NO   NULL  
field_regex longtext You can provide a regular expression to validate campaigners' input here. NO   NULL  
field_length int(11) Maximum number of characters; leave blank for unlimited. YES   NULL  

core_builtintranslation

ActionKit provided language translations for error messages, form fields, etc.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
hidden tinyint(1) 1=hidden NO   NULL  
name varchar(255) The name for this translation. NO UNI NULL  
iso_code varchar(10) Alphanumeric iso code for the language. NO   NULL  
translations long text All provided translations for this language. NO   NULL  

core_callpage

Page id for all pages of type call and page specific attributes (like whether only constituents can take this action).

Field Type Description Null Key Default Extra
page_ptr_id int(11) Joins to core_page on (core_callpage.page_ptr_id= core_page.id) NO PRI NULL  
constituents_only_url varchar(200) Fallback page URL - page displayed to non-constituents in lieu of message that the action isn't available where they live. NO   NULL  
allow_local_targetoffices tinyint(1) =1 displays local office phone numbers for federal legislators. NO   NULL  

core_callpage_target_groups

Joins call page to targets.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
callpage_id int(11) Joins to core_page and core_callpage. NO MUL NULL  
targetgroup_id int(11) Joins to core_targetgroup. NO MUL NULL  

Other tables following the same formula

Linking page to targets.

Table Description
core_letterpage_target_groups Joins letter page to targets.
core_petitionpage_target_groups Joins petition page to targets.
core_whipcountpage_target_groups Joins whipcount page to targets.

core_campaignvolunteerpage

Page ID for all volunteer event moderator signup pages and campaign the page is associated with.

Field Type Description Null Key Default Extra
page_ptr_id int(11) Joins to core_page on core_campaignvolunteerpage.page_ptr_id= core_page.id NO PRI NULL  
campaign_id int(11) Campaign of event the volunteer moderator signup page is associated with. Joins to events_campaign. NO   NULL  

core_donationpage

Page id for all pages of type donation and page specific attributes.

Field Type Description Null Key Default Extra
page_ptr_id int(11) Unique identifier to core_page. NO PRI NULL  
minimum_amount decimal(10,2) Minimum donation amount. NO NULL    
payment_account varchar(255) Merchant vendor account used for this page. NO NULL    
hpc_rule_id int(11) Joins to core_donation_hpc_rule. YES MUL NULL  
allow_international tinyint(1) 1=Accept international donations. NO NULL    
filtering_for_web_id int(11) Values for fraud filter are "Default for users from mailings", "Default for users from web", and "None". YES MUL NULL  
filtering_for_mailings_id int(11) Values for fraud filter are "Default for users from mailings", "Default for users from web", and "None". YES MUL NULL  
use_account_switcher tinyint(1) 1=Currency switcher is added to donation page display. YES      
paypal_account varchar(255) Paypal account used for this page. YES      
paypal_user_requirements varchar(255) 'none'=no user data required. email=email required, all=name, email, and address required. NO   'none'  
accept_ach tinyint(1) 1=ACH Direct Debit is added to donation page display NO   NULL  

core_donationcancellationpage

Page id for all pages of type Cancel Recurring Donation and page specific attributes.

Field Type Description Null Key Default Extra
page_ptr_id int(11) Joins to core_page on (core_donationcancellationpage.page_ptr_id= core_page.id) NO PRI NULL  

core_donationupdatepage

Page id for all pages of type Update Rcurring Donation and page specific attributes.

Field Type Description Null Key Default Extra
page_ptr_id int(11) Joins to core_page on (core_donationupdatepage.page_ptr_id= core_page.id) NO PRI NULL  

core_eventcreatepage

Joins event campaign to the event creation page.

Field Type Description Null Key Default Extra
page_ptr_id int(11) Joins to core_page on (core_eventcreatepage.page_ptr_id = core_page.id). NO PRI NULL  
campaign_id int(11) Joins to events_campaign. NO MUL NULL  
campaign_title varchar(255) Title of campaign. YES      

core_eventsignuppage

Joins event signup to the event campaign.

Field Type Description Null Key Default Extra
page_ptr_id int(11) Joins on core_eventsignuppage.page_ptr_id= core_page.id). NO PRI NULL  
campaign_id int(11) Joins to events_campaign. NO MUL NULL  

core_eventmoderatepage

Joins event moderation page to the event campaign.

Field Type Description Null Key Default Extra
page_ptr_id int(11) Joins on core_eventmoderatepage.page_ptr_id= core_page.id). NO PRI NULL  
campaign_id int(11) Joins to events_campaign. NO MUL NULL  

core_formfield

Default fields available for inclusion in forms (name, state, etc.)

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
name varchar(255) Name of field. NO UNI NULL  

core_immediatedeliverylog

Logs every immediate delivery sent. Joins to core_action.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI   auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
email varchar(255) Email or link to webform if no email YES MUL NULL  
action_id int(11) Unique identifier for user action. YES MUL NULL  

core_immediatedeliverywarning

Used to generate message to switch to bulk delivery to admin if immediate delivery limit is exceeded.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
email varchar(255) Email or link to webform if no email YES MUL NULL  

core_importpage

Page id for all pages of type import and page specific attributes.

Field Type Description Null Key Default Extra
page_ptr_id int(11) Joins to core_page on (core_importpage.page_ptr_id = core_page.id) NO PRI NULL  
subscribe tinyint(1) 1=subscribe users to list selected. YES   1  
default_source varchar(255) The default value for the user source if a value is not specified for the row in the import file. YES   NULL  
unsubscribe_all tinyint(1) 1=unsubscribe users from all lists. YES   0  
unsubscribe tinyint(1) 1=unsubscribe user from list selected. YES   0  
privacy_notes_id int(11)   YES MUL NULL  
custom_privacy_notes longtext   NO   NULL  

core_language

Name of language and error translations you've entered for any additional languages (aside from English).

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
name varchar(255) Name of language (ex. "Spanish") NO UNI NULL  
translations longtext Translations of error and other messages as a single text blob. NO   NULL  
hidden tinyint(1) 1=hidden NO MUL NULL  
iso_code varchar(10) iso code for the language. YES      
inherit_from_id tinyint(4) Built in phrases are available for English, French, and Portuguese YES   NULL  
ordering int(11) Order for the Language picker, 0=English. YES   0  
is_default tinyint(1) 1=default NO   0  

core_letterpage

Page id for all pages of type letter and page specific attributes.

Field Type Description Null Key Default Extra
page_ptr_id int(11) Joins to core_page on (core_letterpage.page_ptr_id= core_page.id) NO PRI NULL  
send_immediate_fax tinyint(4) Binary for enabled immediate fax. YES   0  
send_immediate_email tinyint(4) 1=send letter immediately as email (if available). YES   0  
send_immediate_email_override_limit tinyint(1) 1=you requestsed and received an override of the daily email delivery limit for this page. NO   NULL  
immediate_email_subject text Subject text. YES   NULL  
delivery_template text Email/fax text YES   NULL  
email_mode int(11)   YES   NULL  
remind_me_set_up_batch_delivery tinyint(1)   NO   NULL  
immediate_email_subject text   YES   NULL  
delivery_template text   YES   NULL  
batch_delivery_from_id int(11)   YES MUL NULL  
batch_delivery_subject varchar(255)   YES   NULL  
batch_delivery_template longtext   YES   NULL  
batch_petitiondeliveryjob_id int(11)   YES   NULL  
send_immediate_email_delivery_blocked_at datetime   YES   NULL  
batch_delivery_threshold int(11)   YES   NULL  
batch_delivery_minimum int(11)   NO      
send_via_cwc tinyint(1)   YES   NULL  
cwc_topic varchar(255)   YES   NULL  
cwc_statement text   YES   NULL  
cwc_subject varchar(255)   YES   NULL  

core_ltepage

Page id for all pages of type letter to the editor and page specific attributes such as selections made during set up for types of papers and whether to show phone number.

Field Type Description Null Key Default Extra
page_ptr_id int(11) Joins to core_page on (core_callpage.page_ptr_id= core_page.id). NO PRI NULL  
national_newspapers tinyint(1) 1=show national newspapers NO   NULL  
regional_newspapers tinyint(1) 1=show regional newspapers NO   NULL  
local_newspapers tinyint(1) 1=show local newspapers NO   NULL  
show_phones tinyint(1) 1=show newspaper phone number NO   NULL  
signature_template_id int(11) Template used for users LTE signature. Join to core_signaturetemplate. NO MUL 1  

core_multilingualcampaign

Join translations of a page together for reporting and for your end users.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
hidden tinyint(1) 1=hidden NO   NULL  
name varchar(255) Campaign name. NO UNI NULL  

core_page

Unique id for each page and basic info including name, goal, page type.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
title varchar(255) Shows to the end user as the header for the page NO MUL NULL  
name varchar(255) Generally part of the URL for the page NO UNI NULL  
notes varchar(255) Notes field for internal use. YES      
hosted_with_id int(11) AK or outside webserver NO MUL NULL  
url varchar(255) Not currently in use. NO   NULL  
type varchar(255) page type (petition, call, etc.) NO MUL NULL  
lang_id int(11) Specifies language when not English. Joins to core_language. YES MUL NULL  
multilingual_campaign_id int(11) Points to a row in core_multilingualcampaign if used. Used for grouping pages that hold different translations of the same basic campaign. YES MUL NULL  
goal int(11) optional numeric goal displays progress meter to end user YES   NULL  
goal_type varchar(255) actions taken or dollars raised NO   NULL  
status varchar(255) identifies model pages NO MUL NULL  
list_id int(11) shows list a user will be subscribed to after taking action on this page NO MUL NULL  
hidden tinyint(1) 1=yes, page is hidden NO MUL NULL  
allow_multiple_responses tinyint(1) 1=yes NO   1  
real_actions tinyint(1) 1=include in reports of member actions. NO   0  
recognize varchar(255) Set this page to recognize users based on AKID: always, never or once. NO   once  
never_spam_check tinyint(1) 1=do not treat actions on this page as potential spam. NO   0  

core_page_required_fields

Fields required for the user to submit the given page, selected from the formfields above.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for page/ required fields combo. NO PRI NULL auto_increment
page_id int(11) Identifies the page. Joins on (core_page_required_fields.page_id = core_page.id) NO MUL NULL  
formfield_id int(11) Identifies the required field. Joins on (core_page_required_fields. formfield_id= core_formfield.id) NO MUL NULL  

core_page_tags

Associates a page with a tag or tags.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
page_id int(11) Joins to core_page. NO MUL NULL  
tag_id int(11) Identifies the tag. Joins to core_tag. NO MUL NULL  

core_page_visible_fields

Shows the fields you selected as required on the Action Basics screen when creating the page.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for page/ visible fields combo. NO PRI NULL auto_increment
page_id int(11) Identifies the page. Joins on (core_page_visible_fields.page_id = core_page.id) NO MUL NULL  
formfield_id int(11) Identifies the visible field. Joins on (core_page_visible_fields.formfield_id = core_formfield.id) NO MUL NULL  

core_pagefield

Page and page field value.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for this content on this page. NO PRI NULL auto_increment
parent_id int(11) ID for the page. Joins to core_page. NO MUL NULL
name varchar(255) Name of field. Same name as in core_allowedpagefield. NO MUL NULL  
value longtext Text to be displayed or code to be activated by this field. NO   NULL  

core_pagefollowup

Landing page, confirmation email, TAF and sharing for all pages.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
page_id int(11) Joins to core_page. NO UNI NULL  
send_email tinyint(1) Determines whether a confirmation email is sent. Yes=1. NO   NULL  
url varchar(255) After-action landing page. NO   NULL  
email_wrapper_id int(11) Used in confirmation email. Joins to core_emailwrapper. YES MUL NULL  
email_from_line_id int(11) Used in confirmation email. Joins to core_fromline. YES MUL NULL  
email_custom_from varchar(255) "From" line for this confirmation email only. NO   NULL  
email_subject varchar(255) After-action confirmation email subject. NO   NULL  
email_body longtext After-action confirmation email content. NO   NULL  
send_taf tinyint(1) Determines whether the email TAF widget displays on the thank you page. Yes=1. NO   NULL  
taf_subject varchar(255) Default TAF email subject line (user can edit) NO   NULL  
taf_body longtext Default TAF email content (user cannot edit) NO   NULL  
share_title varchar(255) Customized title for sharing YES   NULL  
share_description varchar(1024) Customized description for sharing YES   NULL  
share_image varchar(1024) Customized image URL for sharing YES   NULL  
twitter_message longtext Customized Twitter message for sharing YES   NULL  
send_notifications tinyint(1) Yes=1. NO   NULL  
send_pushes tinyint(1) Not in use. NO   NULL  

core_pagefollowup_notifications

Joins the page followup to the notification.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
pagefollowup_id int(11) Joins to page follow up. NO MUL NULL  
actionnotification_id int(11) Joins to notifications. NO MUL NULL  

core_petitiondeliveryjob

Defines the content, delivery options, and appearance for each delivery job.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
single_file tinyint(1) Not currently in use. NO   NULL  
cover_html longtext Cover page text and html. NO   NULL  
print_template_id int(11) Joins to core_printtemplate. Template for cover page and petitions NO MUL NULL  
header_content longtext Header NO   NULL  
footer_content longtext Footer NO   NULL  
backgroundtask_id int(11) Joins to core_backgroundtask. YES UNI NULL  
allow_pdf_download tinyint(1) 1=yes YES   0  
allow_csv_download tinyint(1) 1=yes YES   0  
template_set_id int(11) Joins to cms_templateset. Defines the appearance of the pick up website. YES MUL NULL  
limit_delivery tinyint(1) Limit to only certain targets. NO   0  
all_to_all tinyint(1) Deliver all signatures to all targets. YES   0  
include_email_in_csv tinyint(1) Display email addresses for users who signed in CSV or PDF. NO   NULL  
date_from date Only include signatures after this date. YES   NULL  
ldate_to date Only include signatures before this date. YES   NULL  

core_petitiondeliveryjob_petitions

Joins the job to the page(s) to be delivered.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
petitiondeliveryjob_id int(11) Joins to core_petitiondeliveryjob. NO MUL NULL  
page_id int(11) Joins to core_page. NO MUL NULL  

core_petitiondeliveryjob_target_groups

Used to limit delivery to a subset of page targets.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for each job and target group combo. NO PRI NULL auto_increment
petitiondeliveryjob_id int(11) Joins to core_petitiondeliveryjob. NO MUL NULL  
targetgroup_id int(11) Joins to core_targetgroup. NO   NULL  

core_petitionpage

Page ID for all pages of type Petition and page specific attributes.

Field Type Description Null Key Default Extra
page_ptr_id int(11) Joins to core_page on (core_petitionpage.page_ptr_id= core_page.id) NO PRI NULL  
send_immediate_fax tinyint(4) 1=send fax immediately upon user signature (when available) YES      
send_immediate_email tinyint(4) 1=send email to target immediately upon user signature (when available) YES      
send_immediate_email_override_limit tinyint(1) 1=you requested and received an override on the daily email delivery limit for this page NO   NULL  
email_mode int(11) Description needed. YES   NULL  
remind_me_set_up_batch_delivery tinyint(1) 1=YES NO   NULL  
immediate_email_subject text Subject text for immediate email delivery. YES   NULL  
delivery_template text Text for email or fax YES   NULL  
one_click tinyint(1) 1=Enable one click signing NO   NULL  
batch_delivery_from_id int(11)   YES MUL NULL  
batch_delivery_subject varchar(255) Subject line for batch delivery. YES   NULL  
batch_delivery_template longtext   YES   NULL  
batch_petitiondeliveryjob_id int(11)   YES   NULL  
send_immediate_email_delivery_blocked_at datetime   YES   NULL  
batch_delivery_threshold int(11)   YES   NULL  
batch_delivery_minimum int(11)   NO      
send_via_cwc tinyint(1) 1=Delivery via CWC. YES   NULL  
cwc_topic varchar(255) Topic selected for CWC delivery for this page. YES   NULL  
cwc_statement text   YES   NULL  
cwc_subject varchar(255)   YES   NULL  

core_printtemplate

Defines the appearance of the cover letter and signature pages for delivery jobs.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
name varchar(255) Template name. NO UNI NULL  
header_html longtext Template header appearance. NO   NULL  
template longtext Body html. NO   NULL  
footer_html longtext Footer appearance. NO   NULL  
font_family varchar(255) Text font. NO   NULL  
font_size double Font size. NO   NULL  
logo_URL varchar(200) Logo to include in the header. NO   NULL  
page_size varchar(255) Letter or A4 NO   NULL  
margin_units varchar(255) Inches or millimeters NO   NULL  
margin_top double Margin for body text. NO   NULL  
margin_bottom double Margin for body text. NO   NULL  
margin_left double Margin for body text. NO   NULL  
margin_right double Margin for body text. NO   NULL  
readonly tinyint(1) 1 = makes template readonly. NO   NULL  
hidden tinyint(1) 1 = makes template hidden. NO   NULL  

core_recurringdonationcancelpage

Pointer to page id for all pages of type cancel recurring donation.

Field Type Description Null Key Default Extra
page_ptr_id int(11) Joins to core_page on (core_recurringdonationcancelpage.page_ptr_id= core_page.id) NO PRI NULL  

core_recurringdonationupdatepage

Pointer to page id for all pages of type update recurring donation.

Field Type Description Null Key Default Extra
page_ptr_id int(11) Joins to core_page on (core_recurringdonationupdatepage.page_ptr_id= core_page.id) NO PRI NULL  
minimum_amount decimal(10,2) Minimum accepted donation amount. NO   NULL  

core_signaturetemplate

Template for user signature for LTEs.

Field Type Description Null Key Default Extra
id int(11) unique identifier NO PRI NULL auto_increment
name varchar(255) Name of signature template. NO UNI NULL  
is_default tinyint(4) =1 if this templateset is to be selected by default during page creation YES   0  
template longtext format for displaying user info to newspapers. NO   NULL  

core_signuppage

Pointer to page id for all pages of type Signup.

Field Type Description Null Key Default Extra
page_ptr_id int(11) Joins to core_page on (core_signuppage.page_ptr_id=core_page.id) NO PRI NULL  

core_surveypage

Pointer to page id for all pages of type Survey.

Field Type Description Null Key Default Extra
page_ptr_id int(11) Joins to core_page on (core_surveypage.page_ptr_id=core_page.id) NO PRI NULL  

core_tag

Word or phrase which can be used to associate pages or emails with a campaign or issue.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
name varchar(255) Tag name. NO UNI NULL  
hidden tinyint(1) 1=hidden NO MUL NULL  
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
times_used int(11) Used to display most used on top. YES   NULL  
order_index int(11) Used to retain tag order if you change the default order on the tags screen. NO   NULL  

core_tellafriendpage

Pointer to page id for all tell-a-friend pages.

Field Type Description Null Key Default Extra
page_ptr_id int(11) Joins to core_page on (core_tellafriendpage.page_ptr_id= core_page.id). NO PRI NULL  

core_unsubscribepage

Pointer to page id for all unsubscribe pages and user in mail wrapper flag.

Field Type Description Null Key Default Extra
page_ptr_id int(11) Joins to core_page on (core_unsubscribepage.page_ptr_id = core_page.id) NO PRI NULL  
use_in_mail_wrapper tinyint(1) 1=default unsubscribe page; always used in email wrappers unless you overwrite manually in the wrapper. NO   NULL  

core_userupdatepage

Pointer to page id for all user update pages.

Field Type Description Null Key Default Extra
page_ptr_id int(11) Joins to core_page on (core_userupdatepage.page_ptr_id= core_page.id) NO PRI NULL  

core_whipcountpage

Pointer to page id for all whipcount pages

Field Type Description Null Key Default Extra
page_ptr_id int(11)   NO PRI NULL  

core_whipcountpagefollowup

Pointer to page id for all whipcount followup pages.

Field Type Description Null Key Default Extra
pagefollowup_ptr_id int(11)   NO PRI NULL  

Target tables

The Target tables relate to advocacy targets for call, whipcount, letter and petition page types and to media targets for Letters-to-the-Editor.

The following core target tables are described below:

core_boundary

Unique geographic area defined by a spatial file or a handdrawn boundary. Can be associated with a custom target.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
group_id int(11) Unique identifier. NO MUL NULL auto_increment
name varchar(255) Name of the specific boundary (e.g. school district 6). NO   NULL  
geometry multipolygon Description needed. NO MUL NULL  
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  

core_boundarygroup

A group of boundaries of the same type (e.g. School District #23 boundary might belong to the Madison School District group).

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
hidden tinyint(1) 1=yes NO   NULL auto_increment
name varchar(255) Name of the boundary group. NO UNI NULL  
description longtext Optional description for the group. YES   NULL  

core_congresstargetgroup

Indicates whether the congressional group includes Republicans, Democrats, and/or Independents.

Field Type Description Null Key Default Extra
targetgroup_ptr_id int(11) Joins to core_targetgroup, which defines the legislative body, on (core_targetgroup.id=core_congresstargetgroup.targetgroup_ptr_id) NO PRI NULL  
include_republicans tinyint(1) 1=yes NO   NULL  
include_democrats tinyint(1) 1=yes NO   NULL  
include_independents tinyint(1) 1=yes NO   NULL  
states longtext contains list of states included in group. default is all states. NO   NULL  

core_congresstargetgroup_excludes

Individuals excluded from the congress target group above.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
congresstargetgroup_id int(11)   NO MUL NULL  
target_id int(11)   NO MUL NULL  

core_congresstargetgroup_targets

Individual legislators targeted (used when you pick specific individuals versus targeting by body and party).

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
congresstargetgroup_id int(11)   NO MUL NULL  
target_id int(11)   NO MUL NULL  

core_cwcdeliverylog

Log of all successful constituent deliveries via the Communicating With Congress integration.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
target_id int(11) Joins to core_target. NO MUL NULL  
action_id int(11) Joins to core_action. NO MUL NULL  
cwc_delivery_id varchar(255)   YES   NULL  

core_mediatarget

Contact and circulation data for newspapers for LTEs.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
hidden tinyint(1) 1=hidden NO   NULL  
address1 varchar(255) Newspaper address. NO   NULL  
address2 varchar(255) Newspaper address. NO   NULL  
city varchar(255) Newspaper address. NO   NULL  
state varchar(255) Newspaper address. NO   NULL  
region varchar(255) Newspaper address. NO   NULL  
postal varchar(255) Newspaper address. NO   NULL  
zip varchar(5) Newspaper address. NO   NULL  
plus4 varchar(4) Newspaper address. NO   NULL  
country varchar(255) Newspaper address. NO   NULL  
longitude double Newspaper longitude. YES   NULL  
latitude double Newspaper latitude. YES   NULL  
orgid int(11) Paper identifier. YES   NULL  
name varchar(255) Reporter name. NO   NULL  
phone varchar(255) Reporter phone. YES   NULL  
fax varchar(255) Reporter fax. YES   NULL  
email_address varchar(255) Reporter email. YES   NULL  
website_url varchar(255) Newspaper website. YES   NULL  
circulation int(11) Circulation size. YES   NULL  
frequency varchar(36) Daily, weekly, etc. YES   NULL  
language varchar(64) Newspaper language. YES   NULL  
levelcode varchar(64) Local, regional, national. YES   NULL  
dmacode varchar(10) Designated Market Area code. YES   NULL  
fipscode int(11) Standardized geographic area codes (state, county, etc.) YES   NULL  
msacode int(11) Metropolitan Statistical Area identifier. YES   NULL  

core_pagetargetchange

Used to redistribute signatures after a targeting change.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
page_id int(11) Joins to advocacy page with changed targeting. NO UNI NULL  
targets_representation longtext Need description. NO   NULL  

core_specialtarget

Custom targets.

Field Type Description Null Key Default Extra
target_ptr_id int(11) Joins to core_target on (core_target.id= core_specialtarget.target_ptr_id) NO PRI    
body_id int(11) Defines the group to which the custom target belongs. Joins to core_targetgroup. NO MUL    
boundary_id int(11) Joins to core_boundary.id. YES   NULL  

core_specialtargetgroup

A group of custom targets.

Field Type Description Null Key Default Extra
targetgroup_ptr_id int(11) Identifies group. Joins to core_targetgroup. NO PRI NULL auto_increment
jurisdiction varchar(50) All, state or country. NO   all  
custom_boundaries_id int(11)   YES MUL NULL  

core_target

Contact information for the president, House and Senate members, and delegates, plus any custom targets you have added.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
type varchar(255) house or senate NO MUL NULL  
seat varchar(255) Only available for Senate seat. NO MUL NULL  
country varchar(255) Designated target's country. NO MUL NULL  
state varchar(255) Designated target's state. NO MUL NULL  
city varchar(255) Designated target's city. NO MUL NULL  
region varchar(255) Designated target's region. NO MUL NULL  
county varchar(255) Designated target's county. NO MUL NULL  
us_district varchar(255) Only pertains to House member target's districts. NO MUL NULL  
title varchar(255) Target's title NO   NULL  
long_title varchar(255) Target's title NO   NULL  
first varchar(255) Target's given first name. NO   NULL  
last varchar(255) Target's last name. NO   NULL  
official_full varchar(255) Full name of target using nickname if available otherwise given name. Only available for some target types. NO   NULL  
nickname varchar(255) Nickname if different than given name (e.g. Bernie instead of Bernard). Only available for some target types. NO   NULL  
phone varchar(255) Target's phone number. NO   NULL  
fax varchar(255) Target's fax number. NO   NULL  
email varchar(255) Email or link to webform if no email NO   NULL  
gender varchar(1) Target's preferred gender pronouns. Value is null for They/Them/Theirs; M for He/Him/His; or F for She/Her/Hers. NO   NULL  
party varchar(255) Target's party affiliation. NO   NULL  
hidden tinyint(1) =1 is hidden NO   0  
district_name varchar(255)   NO MUL NULL  
twitter varchar(255)   YES   NULL  
twitter_id varchar(255)   YES   NULL  
facebook varchar(255)   YES   NULL  
facebook_id varchar(255)   YES   NULL  
youtube varchar(255)   YES   NULL  
youtube_id varchar(255)   YES   NULL  
instagram varchar(255)   YES   NULL  
instagram_id varchar(255)   YES   NULL  

Note: we cannot expose the email details of representatives, so the email field is sometimes listed as actionkit-contact@example.com. Behind the scenes, there is a lookup for the real email address of the representative when a query that includes it is used in targeting.

core_targetgroup

Groups of targets.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for this group of targets NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
name varchar(255) Name of group. For example, U.S. House is all house members. NO UNI NULL  
type varchar(255) House, senate or other. NO MUL NULL  
readonly tinyint(1) 1=true NO   0  
hidden tinyint(1) 1=hidden NO MUL NULL  

core_targetoffice

District offices for congressional targets.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI NULL auto_increment
created_at datetime   NO MUL    
updated_at datetime   NO   NULL  
target_id int(11) Joins to core_target on (core_target.id= core_targetoffice.target_id) NO MUL NULL  
type varchar(255) house or senate NO MUL NULL  
address1 varchar(255) Address of office. NO   NULL  
address2 varchar(255) Address of office. NO   NULL  
name varchar(255) Office name NO   NULL  
city varchar(255) Office location city NO   NULL  
state varchar(255) Office location state NO   NULL  
zip varchar(255) Office location zip NO   NULL  
phone varchar(255) Office phone number. NO   NULL  
fax varchar(255) Office fax number. NO   NULL  
is_current tinyint(1) 1=true. 0=old office info. NO   NULL  

core_letterpage_target_groups

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
letterpage_id int(11)   NO MUL NULL  
targetgroup_id int(11)   NO MUL NULL  

core_petitionpage_target_groups

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
petitionpage_id int(11)   NO MUL NULL  
targetgroup_id int(11)   NO MUL NULL  

Event tables

The Event tables relate to event pages and actions.

The following core event tables are described below:

events_campaign

Settings for a particular events campaign.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
title varchar(255) Campaign title--used on event creation pages. NO MUL NULL  
name varchar(255) Campaign name -- used in the URL. NO UNI NULL  
public_create_page tinyint(1) 0=only staff can create events; 1=public can create events NO   NULL  
use_title tinyint(1) 0=use the title in this table; 1=allow hosts to set a title for their own event NO   NULL  
starts_at datetime Default event date and time. YES   NULL  
use_start_date tinyint(1) 0=use default date; 1=allow hosts to pick date NO   NULL  
use_start_time tinyint(1) 0=use default time; 1=allow hosts to pick time NO   NULL  
require_staff_approval tinyint(1) 0=no; 1=yes NO   NULL  
require_email_confirmation tinyint(1) not in use NO   NULL  
allow_private tinyint(1) 0=no; 1=yes NO   NULL  
max_event_size int(11) Max event size a host can enter for their event. YES   NULL  
default_event_size int(11) Default size pre-filled on event creation page. YES   NULL  
public_search_page tinyint(1) Not in use. NO   NULL  
show_title tinyint(1) 0=display default title on search page; 1=display host provided title on search page NO   NULL  
show_venue tinyint(1) 0=no; 1=yes NO   NULL  
show_address1 tinyint(1) 0=no; 1=yes NO   NULL  
show_city tinyint(1) 0=no; 1=yes NO   NULL  
show_state tinyint(1) 0=no; 1=yes NO   NULL  
show_zip tinyint(1) 0=no; 1=yes NO   NULL  
show_public_description tinyint(1) 0=no; 1=show host provided description if available NO   NULL  
show_directions tinyint(1) 0=no; 1=show host provided directions if available NO   NULL  
show_attendee_count tinyint(1) 0=no; 1=yes NO   NULL  
default_title varchar(255) Not in use. No      
hidden tinyint(1) 1=yes, campaign is hidden     0  
show_completed_events tinyint(1) 0=no; 1=yes No   0  
show_full_events tinyint(1) 0=no; 1=yes No   0  
mode_onsite tinyint(1) 0=no; 1=yes No   1  
mode_local tinyint(1) 0=no; 1=yes No   0  
mode_global tinyint(1) 0=no; 1=yes No   0  

events_campaignvolunteer

Record of each volunteer moderator signup and their status.

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
user_id int(11) Joins to core_user. NO MUL NULL  
campaign_id int(11) Joins to events_campaign. NO MUL NULL  
is_approved tinyint(1) Staff approval status. 1=approved. NO   NULL  
status varchar(32) Description needed NO   NULL  

events_emailbodylog

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
body longtext Copy of the email body text sent. NO   NULL  

events_emaillog

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
from_type varchar(32) ADD NO   NULL  
to_type varchar(32) ADD NO   NULL  
event_id int(11) Joins to events_event. NO MUL NULL  
from_user_id int(11) Description needed YES MUL NULL  
from_admin_id int(11) Description needed YES MUL NULL  
user_written_subject longtext Description needed YES   NULL  
body_id int(11) Joins to events_emailbodylog. NO MUL NULL  

events_emaillog_to_users

Joins the email from the log to the recipient.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
emaillog_id int(11) Joins to events_emaillog. NO MUL NULL  
user_id int(11) Joins to core_user. NO MUL NULL  

events_event

Selections made by host for their event.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
address1 varchar(255) Event address. NO   NULL  
address2 varchar(255) Event address. NO   NULL  
city varchar(255) Event address. NO   NULL  
state varchar(255) Event address. NO MUL NULL  
us_district varchar(5) Event address. NO MUL NULL  
us_county varchar(24) Event address.   MUL NULL  
region varchar(255) International events only. NO   NULL  
postal varchar(255) International events only. NO   NULL  
zip varchar(5) Event address. NO MUL NULL  
plus4 varchar(4) Event address. NO   NULL  
country varchar(255) MUL NO   NULL  
longitude double Event address. YES   NULL  
latitude double Event address. YES   NULL  
campaign_id int(11) Joins to events_campaign. NO MUL NULL  
title varchar(255) Host-provided event title. NO MUL NULL  
creator_id int(11) User_id of person who created the event. NO MUL NULL  
starts_at datetime Host-provided start time in the event's local time. YES   NULL  
ends_at datetime Not in use. YES   NULL  
status varchar(32) active, cancelled, deleted NO   NULL  
host_is_confirmed tinyint(1) 0=no; 1=yes NO   NULL  
is_private tinyint(1) 0=no; 1=yes NO   NULL  
is_approved tinyint(1) 0=no; 1=yes NO   NULL  
attendee_count int(11) Current count. NO   NULL  
max_attendees int(11) Host-provided event max. YES   NULL  
venue varchar(255) Host-provided venue. NO   NULL  
phone varchar(255) Host phone. NO   NULL  
public_description longtext Description host provides of the event. NO   NULL  
directions longtext Directions if provided by host. NO   NULL  
note_to_attendees longtext Note from host to display on attendee tools page if provided. NO   NULL  
notes longtext Any notes entered by staff through the event admin. NO   NULL  
mode varchar(32) Event type: onsite, local, or global. NO   onsite  
starts_at_utc datetime Host-provided start time in UTC. YES   NULL  
ends_at_utc datetime Not in use. YES   NULL  
confirmed_at datetime Date/time of event confirmation. YES   NULL  
approved_at datetime Date/time of event approval. YES   NULL  
merged_to_id int(11) ID of event merged to. YES   NULL  

events_eventfield

Custom event field -- host page.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
parent_id int(11) Joins to events_event. NO MUL NULL  
name varchar(255) Name of custom event field. NO MUL NULL  
value longtext Value entered by host. NO   NULL  

events_eventsignup

Record of each sign up, including role.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
user_id int(11) Joins to core_user. NO MUL NULL  
event_id int(11) Joins to events_event. NO MUL NULL  
role varchar(32) Attendee or host. NO   NULL  
status varchar(32) Active, deleted or cancelled. NO   NULL  
page_id int(11) Joins to core_page. NO   0  
attended tinyint(1) Binary, 1=YES. YES   0  

events_eventsignupfield

Custom event field -- attendee page.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
parent_id int(11) Joins to events_eventsignup. NO MUL NULL  
name varchar(255) Name of custom event field. NO MUL NULL  
value longtext Value entered by attendee. NO   NULL  

events_historicalevent

This stores previous versions of an event. Joins to events_event.

Field Type Description Null Key Default Extra
history_id int(11) Unique identifier of the event's history record. Not to be confused with id, the unique identifier of the event. NO PRI NULL auto_increment
history_date datetime Date/time this event was updated, and this history record was saved as a result NO   NULL  
history_change_reason varchar(100) For internal use only. NO   NULL  

Donation tables

The Donation table relate to donations and products to be used in donation page types.

The following core donation tables are described below:

core_authnettransactionlog

Additional data from auth.net (empty unless they are your vendor).

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
source varchar(255) Description needed. NO   NULL  
raw longtext Description needed. NO   NULL  
processed tinyint(1) Description needed. NO MUL NULL  

core_candidate

Candidates for use in bundling on donation pages.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for candidate. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
hidden tinyint(1) 1=hidden. NO MUL NULL  
name varchar(255) Candidate name for display, includes titles. NO UNI NULL  
fec_id varchar(16) Candidate's FEC ID. YES UNI NULL  
portrait_url varchar(255) URL of candidate photo for inclusion on page. NO   NULL  
description longtext Text about candidate. NO   NULL  
status varchar(255) values are active candidate or inactive candidate. NO   NULL  

core_candidate_tags

Tags associated with a candidate.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for candidate, tag combo. NO PRI NULL auto_increment
candidate_id int(11) Joins to core_candidate. NO MUL NULL  
tag_id int(11) Joins to core_tag. NO MUL NULL  

core_donationchangelog

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime(6)   NO MUL NULL  
updated_at datetime(6)   NO   NULL  
change_type varchar(255)   NO   NULL  
action_id int(11)   NO MUL NULL  
order_id int(11)   NO MUL NULL  
recurring_id int(11)   YES MUL NULL  
transaction_id int(11)   YES MUL NULL  
new_amount decimal(10   NO   NULL  
user_id int(11)   YES MUL NULL  
staff_id int(11)   YES MUL NULL  

core_donation_hpc_rule

Name and timestamps for each set of rules for suggested ask amounts based on HPC (Highest Previous Contribution), 2nd highest contribution, and average.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
name varchar(255) Name of this Suggested Ask Formula. NO UNI NULL  
hidden tinyint(1) 1=hidden NO MUL NULL  
which_amount varchar(255) values are "Highest Donation", "Second Highest Donation", "Average Donation", and "Most Recent". NO   highest  
timespan varchar(255) values are "to the begining (default)", "6 months", "12 months", and "24 months". NO   all  
currency varchar(3) Currency used for this Suggested Ask Formula. No   USD  

core_donation_hpc_rule_condition

Thresholds and ask amounts for each set of Suggestion Ask Rules.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
rule_id int(11) Identifies which rule set this threshold and ask belong to. Joins to core_donation_hpc_rule. NO MUL NULL  
threshold varchar(10) Amount, above the previous threshold, up to which the ask applies. NO   NULL  
ask varchar(10) Ask amount to be displayed for up to this threshold. NO   NULL  

core_donation_hpc_rule_exclude_tags

Joins tags you've selected for exclusion from suggested ask rules with the rule.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
donationhpcrule_id int(11) Unique identifier for hpc rule. NO MUL NULL  
tag_id int(11) Unique identifier for tag. NO MUL NULL  

core_donationfraudfilter

MaxMind anti-fraud settings which apply if you enable this.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
hidden tinyint(1) =1 means this filter is hidden. NO MUL NULL  
name varchar(255) The name of the fraud filter NO UNI NULL  
check_maxmind tinyint(1) =1 enables maxmind. NO   NULL  
maxmind_threshold int(11) Integer representing percentage of allowable chance of donation fraud. NO   NULL  
whitelist_where longtext Description needed. NO   NULL  
blacklist_where longtext Description needed. NO   NULL  
is_default_for_mailings tinyint(1) =1 is default for mailings NO NULL  
is_default_for_web tinyint(1) =1 is default for web NO NULL  
message longtext Message displayed to user if fraud is detected. NO NULL  

core_donationpage_products

Joins donation page to product.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for this combination of page and product(s). NO PRI NULL auto_increment
donationpage_id int(11) Joins to core_page. NO MUL NULL  
product_id int(11) Joins to core_product. NO MUL NULL  

Tables following the same formula

Table Description
core_donationpage_candidates Joins donation page to candidate.

core_order

Information about donations and/or product orders made by a user.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
action_id int(11) Shows the action associated with this order. Joins to core_action. NO MUL NULL  
user_id int(11) Shows the user who made this order. Joins to core_user. NO MUL NULL  
user_detail_id int(11) Joins to core_order_user_detail. NO MUL NULL  
shipping_address_id int(11) Where a shipping address was given, joins to core_order_shipping_address. YES MUL NULL auto_increment
total decimal(10,2) Total of donations and products. NO   NULL  
currency varchar(3) Currency code. NO   USD  
status varchar(255) Shows if the order was completed or if it failed. NO   NULL  
card_num_last_four varchar(4) Last four digits of credit card NO   NULL  
import_id varchar(32) identifier you specify in your CSV for imported donations YES   NULL  
account varchar(255) name of the merchant vendor account for this order YES   NULL  
payment_method varchar(255) "cc" for creditcard, or "paypal" No   cc  

core_order_detail

Quantity and amount of products ordered by a user.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
order_id int(11) Joins to core_order. NO MUL NULL  
product_id int(11) Joins to core_product. YES MUL NULL  
quantity int(11) Number of the product ordered by the user. NO   NULL  
amount decimal(10,2) Total for products only (not including any additional donation). NO   NULL  
amount_converted decimal(10,2) Total for products only approximately converted into USD. NO   0.00  
candidate_id int(11) Joins to core_candidate. YES MUL NULL  
currency varchar(3) Currency used for this order. No   USD  

core_order_shipping_address

Shipping address for orders of shippable products.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
address1 varchar(255) Shipping address line 1. NO   NULL  
address2 varchar(255) Shipping address line 2. NO   NULL  
city varchar(255) Shipping city. NO   NULL  
state varchar(255) Shipping state. NO   NULL  
region varchar(255) International region. NO   NULL  
postal varchar(255) Postal code for international shipping. NO   NULL  
zip varchar(5) Shipping zip. NO MUL NULL  
plus4 varchar(4) Zip code plus 4. NO   NULL  
country varchar(255) Shipping country. NO   NULL  

core_order_user_detail

Billing information for user and source of action. Billing address is the last saved address for the order. Updates to the billing address for a recurring profile made by the user or an admin will overwrite the previously saved billing address in this table.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
email varchar(255) User email address for this donation. NO MUL NULL  
prefix varchar(255) User name prefix. NO   NULL  
first_name varchar(255) User first name. NO   NULL  
middle_name varchar(255) User middle name. NO   NULL  
last_name varchar(255) User last name. NO   NULL  
suffix varchar(255) User name suffix. NO   NULL  
address1 varchar(255) User address NO   NULL  
address2 varchar(255) User address NO   NULL  
city varchar(255) User city NO   NULL  
state varchar(255) User state NO   NULL  
region varchar(255) International user region. NO   NULL  
postal varchar(255) International user postal code. NO   NULL  
zip varchar(5) User zip code. NO MUL NULL  
plus4 varchar(4) User zip plus 4 digit code. NO   NULL  
country varchar(255) User country. NO   NULL  
source varchar(255) Source of the action. Matches the source shown for this action in core_action. NO MUL NULL  

core_orderrecurring

Information about recurring donation commitments made by a user.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
order_id int(11) Joins to core_order. NO MUL NULL  
action_id int(11) Joins to core_action with the most recent action ID that created or updated the order. NO MUL NULL  
exp_date varchar(6) Credit card expiration date. NO   NULL  
card_num varchar(4) Last 4 digits. NO   NULL  
recurring_id varchar(255) the profile or subscription ID with the payment gateway YES   NULL  
account varchar(255) Name of your vendor/account. See "Payment account" dropdown when you create a donation page. YES   NULL  
user_id int(11) Joins to core_user. NO MUL NULL  
start date Recurring billing start date. This is not the date of the first payment for this profile, it's the date of the first automatically processed payment. Query core_transaction to find the first payment date. NO   NULL  
period varchar(255) months, weeks, years, quarters NO   NULL  
amount decimal(10,2) Recurring payment amount. NO   NULL  
currency varchar(3) The original currency for the transaction. NO   USD  
amount_converted decimal(10,2) Recurring payment amount approximately converted into USD. NO   0.00  
status varchar(255) active, canceled_by_admin, canceled_by_user, failed, pending, canceled_by_processor, canceled_by_failure NO      

core_product

Name, price and other key information for products to be used on donation pages.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
name varchar(255) Product name. NO UNI NULL  
description longtext Description of product. NO   NULL  
price decimal(10,2) Price for product. Can be 0. NO   NULL  
currency varchar(3) The original currency for the transaction. NO   USD  
shippable tinyint(1) If the product is shippable (value=1), AK will ask for the user's shipping address. NO   NULL  
status varchar(255) Active or inactive. NO   NULL  
maximum_order int(11) The maximum number of this product an end user can order. NO   NULL  
hidden tinyint(1) 1=hidden NO MUL NULL  
admin_name varchar(255)   YES   NULL  

core_product_tags

Associates a product with a tag or tags.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
product_id int(11) Joins to core_product. NO MUL NULL  
tag_id int(11) Joins to core_tag. NO MUL NULL  

core_transaction

Transactions are created for every donation processed through ActionKit.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
type varchar(255) recurring_order_cancel, recurring_order_create,recurring_order_update, or sale NO MUL NULL  
order_id int(11) Joins to core_order. NO MUL NULL  
account varchar(255) Merchant account vendor. Payflow Pro, Braintree or Authorize.net. NO   NULL  
amount decimal(10,2) Payment total. NO   NULL  
amount_converted decimal(10,2) Payment total approximately converted to USD. NO   0.00  
test_mode tinyint(1) not in use NO   NULL  
success tinyint(1) 1=yes NO   NULL  
trans_id varchar(255) ID of transaction with the merchant account vendor. YES   NULL  
failure_description varchar(255) If the transaction failed, explains why. NO   NULL  
failure_code int(11) Vendor provided failure code. YES   NULL  
failure_message varchar(255) More detail about why the transaction failed. NO   NULL  
status varchar(255) Completed, failed or reversed. NO   NULL  
currency varchar(3) The original currency for the transaction. NO   USD  

Mailing Tables

Related to mailings created and sent from the mailings tab.

The following core mailing tables are described below:

core_allowedmailingfield

Field created by your group to capture user-specific data.

Field Type Description Null Key Default Extra
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
hidden tinyint(1) 1=hidden NO   NULL  
name varchar(255) Unique name NO PRI NULL  
always_show tinyint(1) 1 = shows this custom mailing field when creating mailings. NO 1=show NULL  
display_name varchar(255) The display name is shown when selecting a custom field and may be changed in the future. Spaces, punctuation, etc are permitted. NO UNI NULL  
order_index int(1) Sets the order of display on the Create screen for mailing fields that are not used in the wrapper and in the pull down display. NO   NULL  
description longtext Description of custom mailing field. YES      
field_default longtext Provide a default value that will be pre-filled wherever this field is displayed in the admin. NO   NULL  
field_choices longtext Values available if the list type is Select From List or Select From List with Other. NO   NULL  
field_regex longtext You can provide a regular expression to validate campaigners' input here. NO   NULL  
field_type varchar(32) Choose how data should be entered in this field. NO   NULL  
field_length int(11) Maximum number of characters; leave blank for unlimited. YES   NULL  
required tinyint(1) A value must be entered for this field before the mailing can be saved. NO   NULL  

core_blackholeddomain

List of email domains to suppress from bulk and transactional mailings.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
domain varchar(255) Domain to be suppressed. NO UNI NULL  

core_blackholedemail

List of email addresses to suppress from bulk and transactional mailings.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
email varchar(255) Email address to be suppressed. NO UNI NULL  

core_blackholedhistory

Log of all email addresses that were suppressed from bulk or transactional mailings, along with mailing_id or action_id if available.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
email varchar(255) Email address that was suppressed. NO MUL NULL  
mailing_id int(11) Joins to core_mailing. YES   NULL  
action_id int(11) Joins to core_action. YES   NULL  
matched_email tinyint(1) 1=matched an email address in core_blackholedemail. NO NULL  
matched_domain tinyint(1) 1=matched a domain in core_blackholeddomain. NO NULL  

core_bounce

User and mailing id for all hard bounces. Bounced users are unsubscribed.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI NULL auto_increment
user_id int(11) Joins to core_user. NO MUL NULL  
mailing_id int(11) Joins to core_mailing. YES MUL NULL  
timestamp timestamp Time of the bounce. NO   CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP
action_id int(11) Joins to core_action. YES MUL NULL  

core_click

Tracks clicks from an email to a page.

Field Type Description Null Key Default Extra
clickurl_id int(11) Pulls in the url. Joins to core_clickurl on (core_click.clickurl_id= coreclickurl.id) NO MUL NULL  
user_id int(11) User who clicked the link. YES MUL NULL  
mailing_id int(11) Email with the link the user clicked. Joins on (core_click.mailing_id= core_mailing.id) YES MUL NULL  
link_number int(11) Describes which link in the email the user clicked. YES   NULL  
source varchar(255) The source value from the mailing link YES MUL NULL  
referring_user_id int(11) User_id of referrer, if the source of this action was TAF YES   NULL  
created_at timestamp   NO   CURRENT_TIMESTAMP  
id bigint(20) Unique identifier. NO PRI NULL auto_increment
useragent_id int(11) ADD YES   NULL  

core_clickurl

Relates url for click tracking to the page.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
url varchar(255) Url for links in a mailing. NO UNI NULL  
page_id int(11) Page associated with that URL. Joins on (core_clickurl.page_id= core_page.id) YES MUL NULL  
created_at datetime   NO MUL NULL  

core_clientdomain

Other domains you control and for which links in emails should be tracked as ActionKit domains.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
domain varchar(255) The URL. NO UNI NULL  

core_emailwrapper

Sets the appearance of an email.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
name varchar(255) Wrapper name. NO UNI NULL  
template longtext Html defining the appearance and where the text is inserted. NO   NULL  
text_template longtext Text only version of template defining the appearance and where the email body is inserted. NO   NULL  
hidden tinyint(1) 1=hidden NO MUL NULL  
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
unsubscribe_text text Required link to an unsubscribe page and related description (text only version). YES   NULL  
unsubscribe_html text Required link to an unsubscribe page and related description (HTML version). YES   NULL  
is_default int(11) Used to set this as the default template. YES   0  
lang_id int(11) Optional language setting for this wrapper. Joins to core_language. YES MUL NULL  

core_failedusermailing

Record of mailings where a user was targeted but not sent an email because of a missing or bad snippet value.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for this failed mailing and user combo. NO PRI NULL auto_increment
mailing_id int(11) Identifies which mailing_id. Joins to core_mailing. NO MUL NULL  
user_id int(11) Identifies the user who didn't get the mailing. Joins to core_user. NO   NULL  
subject_id int(11) Identifies the subject of the mailing. Joins to core_mailingsubject. YES MUL NULL  
created_at datetime   NO NULL  
reasons longtext Failure reason. NO   NULL  

core_fromline

Names and email addresses from which emails can be sent.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
from_line text Ex.:Your Organization <info@example.com> NO UNI    
hidden tinyint(1) 1=hidden NO MUL NULL  
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  

core_mailing

Content and key information for all sent and draft emails.

Field Type Description Null Key Default Extra
id int(11) Mailing id. NO PRI NULL auto_increment
created_at datetime   NO MUL    
updated_at datetime   NO      
fromline_id int(11) Specifies who will show in the from line of the email (generally name and email address). Joins on (core_mailing.fromline_id= core_fromline.id) YES MUL NULL  
custom_fromline text Empty unless the sender created a from line for use in this mailing only, in which case this overrides fromline_id above. NO      
reply_to varchar(255) Email address that will receive responses if recipients hit reply. YES   NULL  
notes varchar(255) Notes field for internal use. YES   NULL  
html longtext Html and content of the email. YES   NULL  
lang_id int(11) Joins to core_language. YES MUL NULL  
text longtext Text version of the email. YES   NULL  
emailwrapper_id int(11) Defines the appearance of the email. Joins on (core_mailing.emailwrapper_id= core_emailwrapper.id) YES MUL NULL  
web_viewable tinyint(1) 1=Mailing can be viewed on the web.< YES   0  
landing_page_id int(11) For emails linking to call and petition pages, pulls the related targeting. Joins on (core_mailing.landing_page_id= core_page.id) YES MUL NULL  
winning_subject_id int(11) not in use) YES MUL NULL  
requested_proofs int(11) Number of proofs requested. YES   NULL  
submitter_id int(11) User_id of staff user who submitted the email. YES MUL NULL  
queue_task_id varchar(255) Internal identifier. YES   NULL  
queued_at datetime Date/time when the mailing was added to the send queue. YES   NULL  
queued_by_id int(11) ID of staff user who hit send. YES MUL NULL  
expected_send_count int(11) Estimated number of emails that will be sent. YES   NULL  
started_at datetime Time the mailing began sending to the targets. YES   NULL  
finished_at datetime Time the mailing finished sending. YES   NULL  
query_queued_at datetime Time the query was queued. YES   NULL  
query_started_at datetime Time the query started building. YES   NULL  
query_completed_at datetime Time the query finished building. YES   NULL  
query_previous_runtime int(11) Time the query took to run on previous submit. YES   NULL  
query_status varchar(255) Query build status. YES   NULL  
query_task_id varchar(255) Query task unique identifier. YES   NULL  
targeting_version int(11) Needs description YES   0  
targeting_version_saved int(11) Needs description YES   NULL  
status varchar(255) Draft, queued (in line to send), sending, completed, stopped, died, recurring, and model. YES   NULL  
includes_id int(11) Identifies group of criteria selected under include. Joins on (core_mailing.includes_id= core_mailingtargeting.id) YES MUL NULL  
excludes_id int(11) Identifies group of criteria selected under exclude. Joins on (core_mailing.excludes_id= core_mailingtargeting.id) YES MUL NULL  
limit int(11) Shows if the submitter set a limit on the number of emails to be sent. The limit applies if it's less than the total users who meet the targeting criteria. Generally used in testing. YES   NULL  
sort_by varchar(32) Random (generally used in testing) or zip (sends from the east to the west). YES   NULL  
rate double Send rate. YES   NULL  
progress int(11) Number sent so far YES   NULL  
pid int(11)   YES   NULL  
hidden tinyint(1) 1=hidden NO MUL NULL  
target_group_from_landing_page tinyint(1) Advocacy targets selected on landing page (petition, call, letter, whipcount only) NO   0  
scheduled_for datetime Time the mailing will send (scheduled mailings only). YES   NULL  
scheduled_by_id int(11) User that scheduled the mailing. YES MUL NULL  
sent_proofs int(11) Needs description NO   0  
rebuild_query_at_send tinyint(1) 1=YES NO   0  
limit_percent int(11) not in use. YES   NULL  
mergefile_id int(11) Merge file unique identifier. YES MUL NULL  
target_mergefile tinyint(1) 1 if AK should use the merge file identifier column to target recipients NO   0  
mergequery_report_id int(11) ID of the query report to be used as a merge query. Joins to reports_report_id. YES MUL NULL  
target_mergequery tinyint(1) 1 if AK should use the merge query identifier column to target recipients NO   0  
mails_per_second double count of mails sent per second YES   NULL  
recurring_schedule_id int(11) Join to recurringmailingschedule table. YES MUL NULL  
recurring_source_mailing_id int(11) Joins to master recurring mailing they were copied from. YES MUL NULL  
requested_proof_date datetime   YES   NULL  
send_date varchar(255) Date to be used for auto-exclusion. NO MUL    
exclude_ordering int(11) Ordering for auto-excludes send date. Yes    
test_group_id int(11) Mailing's test group. YES MUL    
test_remainder int(11) YES      
version smallint(6)   NO   NULL  
archive longtext Archived HTML from the sent mailing. The content will be generated for the same random user as the final proofs. YES      

core_mailing_proof_users

Shows user_ids entered under "see proofs for specific users" and the mailing_id.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
mailing_id int(11) Identifies the mailing. Joins to core_mailing. NO MUL NULL  
user_id int(11) Identifies the user. Joins to core_user NO MUL NULL  

core_mailing_reviewers

Shows which mailings were sent as proofs to which staff users.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
mailing_id int(11) Joins to core_mailing. NO MUL NULL  
user_id int(11) Joins to core_user. NO MUL NULL  

core_mailing_tags

Associates a mailing with a tag.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
mailing_id int(11) Mailing unique identifier, joins with core_mailing. NO MUL NULL  
tag_id int(11) Identifies the tag. Joins to core_tag. NO MUL NULL  

core_mailingerror

Information that may be helpful in identifying the cause of a mailing error.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
mailing_id int(11) Identifies which mailing had the error. Joins to core_mailing. NO MUL NULL  
queue_task_id varchar(255) Internal use only. NO   NULL  
traceback longtext Info about the error. NO   NULL  

core_mailingfield

Custom mailing field value. Joins to core_mailing.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI NULL auto_increment
parent_id int(11) Joins to core_mailing. NO MUL NULL  
name varchar(255) Field name NO MUL NULL  
value longtext Field value NO   NULL  

core_mailinghaiku

Mailer haikus.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for haiku. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
text longtext Haiku text. NO   NULL  

core_mailingsubject

Subject or subjects associated with an email

Field Type Description Null Key Default Extra
id int(11) Unique identifier for each subject. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
text longtext Subject text. NO   NULL  
preview_text longtext Preview text. YES   NULL  
mailing_id int(11) Specifies the mailing. Joins on (core_mailingsubject.mailing_id= core_mailing.id) NO MUL NULL  

core_mailingtargeting

Criteria for inclusion or exclusion from the select recipients screen. Joins to core_mailing on core_mailingtargeting.id=core_mailing.includes_id or core_mailing.excludes_id.

Field Type Description Null Key Default Extra
id int(11) Identifier for all criteria under "include" or all criteria under "exclude" for a given mailing. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
states longtext U.S. states. YES   NULL  
cds longtext Congressional Districts YES   NULL  
zips longtext U.S. zip codes, or city, state, or city, country or postcode country (for use with zip radius except for zip which can be a stand alone). YES   NULL  
zip_radius int(11) Radius for zip code or other geographic points YES   NULL  
has_donated tinyint(1) 1=yes; previous donations checkbox. YES   NULL  
is_monthly_donor tinyint(1) Not in use. YES   NULL  
raw_sql longtext Raw SQL. YES   NULL  
state_house_districts longtext U.S. state house districts. YES   NULL  
state_senate_districts longtext U.S. state senate districts. YES   NULL  
is_delivery tinyint(1) 1=Yes if mailing is a petition or letter signature delivery. YES   0  
delivery_job_id int(11) Joins to core_petitiondeliveryjob. YES MUL NULL  
counties longtext U.S. counties. YES   NULL  
activity_level_id int(11) Not in use. YES MUL NULL  
campaign_radius int(11) Radius around the zip of events within selected event campaign. YES   NULL  
countries text Countries. YES   NULL  
campaign_samestate_only tinyint(1) Only invite members to events in their own state. NO   0  
campaign_same_county_only tinyint(1) Only invite members to events in their own county. NO   0  
campaign_same_district_only tinyint(1) Only invite members to events in their own US House District. NO   0  
mirror_mailing_excludes tinyint(1) Excludes sent mailings that excluded this one. NO   1  
regions longtext Non-U.S. regions. YES   NULL  

core_mailingtargeting_actions

Targeting by whether user has taken action on a given page. Additional criteria (for inclusion or exclusion) added to set defined in core_mailingtargeting.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for each targeting and page combination. One target set will have multiple rows if multiple pages are targeted. NO PRI NULL auto_increment
mailingtargeting_id int(11) Identifies the set of criteria to which this one is added. Can be for either inclusion or exclusion. See table above. NO MUL NULL  
page_id int(11) Identifies the page. Joins on (core_mailing_targeting_actions.page_id= core_page.id) NO MUL NULL  

Other tables following the same formula

Adding targeting criteria (for inclusion or exclusion) to sets of criteria identified in the core_mailingtargeting table.

Table Description
core_mailingtargeting_lists Targeting by whether user is on a given list.
core_mailingtargeting_mailings Targeting by whether user is included in the targeting for another mailing.
core_mailingtargeting_users Targeting by user_id.
core_mailingtargeting_languages Targeting by whether user took action on a page associated with the given language.
core_mailingtargeting_was_monthly_donor Targeting by recurring donor status. Joins to core_recurringdonortargetingoption.
core_mailingtargeting_target_groups Targeting constituents of advocacy targets in specified target group (as defined from links on the pages tab).
core_mailingtargeting_campaigns Targeting users by proximity (specified in core_mailingtargeting) to event in the campaign in this table.
core_mailingtargeting_tags Targeting by whether the user took action on a page associated with the designated tag.
core_targetingqueryreport Targeting by results of a query report. Joins to reports_report using report_id.

core_mailingadditionaltargeting

Associates additional targeting sets with a mailing for OR targeting functionality.

Field Type Description Null Key Default Extra
mailingtargeting_ptr_id int(11) Joins to core_mailingtargeting.id NO PRI NULL  
mailing_id int(11) Joins to core_mailing.id NO MUL NULL  

core_mailingtestgroup

A group of mailings for launching and viewing test results together.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI   auto_increment
created_at datetime   NO MUL    
updated_at datetime   NO      
title longtext Mailing subject used for this test. YES      
number_of_mailings int(11) Count of mailings within this group. NO      
prime int(11) Prime number used for modulo. NO      
status varchar(255) Status of the mailing. YES      

core_mergefile

Merge files uploaded for use in mailings.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
name varchar(255) Merge file name. NO   NULL  
path varchar(255) merge file path. NO   NULL  
status varchar(20) Upload status YES   NULL  
lookup_table varchar(255) Table that will return user_ids for targeting based on the value in the lookup_column (e.g., core_user or core_location) YES   NULL  
lookup_column varchar(255) Name of the column to match on to identify users (e.g. id or zip or city,state) YES   NULL  
started_at datetime Start time for merge table upload. YES   NULL  
finished_at datetime End time for merge table upload. YES   NULL  
row_count int(11) Rows with valid match, available for use in mailing. YES   NULL  
line_count int(11) Number of lines in the merge file (including header row) YES   NULL  
error longtext Errors encountered while loading merge file. NO   NULL  

core_mergequeryparam

Parameters to use with the merge query for a specific mailing.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
mailing_id int(11) Joins to core_mailing.id NO MUL NULL  
name varchar(255) Parameter name. NO   NULL  
value varchar(255) Parameter value. NO   NULL  

core_open

Tracks all opens by mailing and user.

Field Type Description Null Key Default Extra
user_id int(11) User identifier, joins with core_user. YES MUL NULL  
mailing_id int(11) Mailing identifier, joins with core_mailing. YES MUL NULL  
created_at timestamp   NO   CURRENT_TIMESTAMP  
id bigint(20)   NO PRI NULL auto_increment
useragent_id int(11)   YES   NULL  

core_queuedemail

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
envelope_sender longtext   NO   NULL  
to longtext   NO   NULL  
message longtext   NO   NULL  
metadata longtext   NO   NULL  

core_recurringdonortargetingoption

Recurring donor statuses available in mailer targeting "Monthly Donors" box.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for status. 1-5. NO PRI NULL auto_increment
code varchar(255) Short status descriptions (i.e., expires_this_month) NO   NULL  
description varchar(255) Status description (i.e., Card will expire at the end of the month ) NO   NULL  

core_recurringmailingschedule

Table for storage of recurring series information.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
hidden tinyint(1) NO MUL NULL  
name varchar(255) NO   NULL  
tz_name varchar(64) NO   NULL  
schedule_type varchar(255) YES   NULL  
hours varchar(255) YES   NULL  
days_of_week varchar(255) YES   NULL  
days_of_month varchar(255) YES   NULL  
send_finished_notice tinyint(1)   NO   NULL  

core_redirect

See short links section of user guide.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
short_code varchar(255) Use links with a name and no number with this code. YES UNI NULL  
url varchar(4096) URL to be redirected. YES   NULL  
created_at datetime   NO MUL NULL  

core_targetingactionfield

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime(6)   NO MUL NULL  
updated_at datetime(6)   NO   NULL  
targeting_id int(11)   NO MUL NULL  
page_id int(11)   YES MUL NULL  
name varchar(255)   NO   NULL  
values longtext   YES   NULL  

core_targetingqueryreport

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
report_id int(11)   NO MUL NULL  
targeting_id int(11)   NO MUL NULL  

core_targetingqueryreportparam

Additional parameters provided by staffer when using a query report to target a mailing.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
query_id int(11) Query identifier. NO MUL NULL  
name varchar(255) Parameter name. NO   NULL  
value varchar(255) Value entered by staffer for the parameter. NO   NULL  

core_targetinguserfield

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime(6)   NO MUL NULL  
updated_at datetime(6)   NO   NULL  
targeting_id int(11)   NO MUL NULL  
field_id varchar(255)   NO MUL NULL  
values longtext   YES   NULL  

core_usermailing

Record of every mailing sent to every user.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for this mailing and user combo. NO PRI NULL auto_increment
mailing_id int(11) Identifies which mailing_id. Joins to core_mailing. NO MUL NULL  
user_id int(11) Identifies the user who got the mailing. Joins to core_user. NO MUL NULL  
subject_id int(11) Identifies the subject of the mailing. Joins to core_mailingsubject. YES MUL NULL  
created_at datetime   NO MUL NULL  

Transactional mailing Tables

Related to transactional mailings sent as a result of actions.

The following transactional mailing tables are described below:

core_transactionalmailing

Content and key information for all sent transactional emails.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for each transactional mailing. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
hidden tinyint(1) 1=hidden NO MUL NULL  
page_id int(11) Page associated with this transactional mailing. Joins to core_page. NO MUL NULL  
variation_id int(11) A/B testing variation associated with the page at the time of action, if any. Joins to lab_variation. YES MUL NULL  
wrapper_id int(11) Joins to core_emailwrapper. YES MUL NULL  
from_line_id int(11) Specifies who will show in the from line of the email (generally name and email address). Joins to core_fromline. YES MUL NULL  
custom_from varchar(255) Empty unless the sender created a from line for use in this mailing only, in which case this overrides fromline_id above. NO   NULL  
reply_to varchar(255) Email address that will receive responses if recipients hit reply. YES   NULL  
subject varchar(255) Mailing subject text. NO   NULL  
body longtext Mailing content. YES   NULL  
status varchar(20) Active, inactive, or test if page a/b test sets transactional email behavior. YES MUL NULL  
type varchar(20) confirmation, taf, notification NO MUL NULL  
signature varchar(255) Not used. YES   NULL  

core_notificationmailing

Records every action notification mailing and joins to core_transactionalmailing.

Field Type Description Null Key Default Extra
transactionalmailing_ptr_id int(11) Joins to core_transactionalmailing. NO PRI NULL  
notification_id int(11) Joins to core_actionnotification. NO MUL NULL  

core_tafmailing

Records every tell-a-friend mailing sent through ActionKit and joins to core_transactionalmailing.

Field Type Description Null Key Default Extra
transactionalmailing_ptr_id int(11) Joins to core_transactionalmailing. NO PRI NULL  

core_confirmationmailing

Records every confirmation mailing and joins to core_transactionalmailing.

Field Type Description Null Key Default Extra
transactionalmailing_ptr_id int(11) Joins to core_transactionalmailing. NO PRI NULL  

core_transactionalmailingsent

The core_transactionalmailingsent table stores a row each time a transactional mailing is sent.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for this transactional mailing and user/email combo. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
action_id int(11) Joins to core_action on the action that triggered the transactional mail to be sent. NO MUL NULL  
transactional_mailing_id int(11) Joins to core_transactionalmailing. NO MUL NULL  
user_id int(11) Joins to core_user. YES MUL NULL  
email varchar(255) Recipient email address. NO MUL NULL  

core_transactionalmailingopen

The core_transactionalmailingopen table stores a row each time a transactional mailing is opened.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for this open. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
transactional_mailing_sent_id int(11) Joins to core_transactionalmailingsent. NO MUL NULL  

core_transactionalmailingclick

The core_transactionalmailingclick table stores a row each time a transactional mailing is clicked.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for this click. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
transactional_mailing_sent_id int(11) Joins to core_transactionalmailingsent. NO MUL NULL  
clickurl_id int(11) Joins to core_clickurl. NO MUL NULL  
link_number int(11) Describes which link in the email the user clicked. YES   NULL  
source varchar(255) The source value from the mailing link which will provide the 'source' for any clicks or actions it generates. NO MUL NULL  

core_transactionalmailingaction

The core_transactionalmailingaction table stores a row each time a user takes action after clicking on a transactional mailing link.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for this combination of action and transactional mailing send. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
transactional_mailing_sent_id int(11) Joins to core_transactionalmailingsent. NO MUL NULL  
action_id int(11) Joins to core_action on the action taken from the transactional mailing. NO MUL NULL  

core_transactionalmailingunsub

The core_transactionalmailingaction table stores a row each time a user unsubscribes on a confirmation mailing.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for this click. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
action_id int(11) Joins to core_action on the action taken from the transactional mailing. NO MUL NULL  
transactional_mailing_sent_id int(11) Joins to core_transactionalmailingsent. NO MUL NULL  

core_useragent

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
useragent_string longtext   NO   NULL  
hash varchar(64)   NO UNI NULL  
browser varchar(255)   NO   NULL  
browser_version varchar(30)   NO   NULL  
os varchar(255)   NO   NULL  
os_version varchar(30)   NO   NULL  
device varchar(255)   NO   NULL  
is_mobile tinyint(1)   NO MUL NULL  
is_phone tinyint(1)   NO MUL NULL  
is_tablet tinyint(1)   NO MUL NULL  
is_desktop tinyint(1)   NO MUL NULL  

Import Tables

These tables information about import jobs (or uploads).

The following upload tables are described below:

core_backgroundtaskdetail

Use to identify failed rows in import.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
task_id int(11) Joins to core_backgroundtask. NO MUL NULL  
row int(11) Identifies the row in the file imported. NO   NULL  
details longtext Description of the error. NO   NULL  

core_upload

Record for each import.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime Creation date/time. NO MUL NULL  
updated_at datetime Update date/time. NO   NULL  
path varchar(255) File path, in hostname:filename format. NO   NULL  
submitter_id int(11) Admin ID submitting the upload. NO MUL NULL  
page_id int(11) Import Page ID. Joins to core_page. NO MUL NULL  
started_at datetime Upload start date/time. NO   NULL  
finished_at datetime Upload finish date/time. NO   NULL  
rate double Upload rate (rows/sec). NO   NULL  
progress int(11)   YES   NULL  
status varchar(20) Upload status - loading, completed, etc. NO   NULL  
format varchar(10) Upload format - csv, tsv. YES   NULL  
compression varchar(20) Needs description YES   NULL  
autocreate_user_fields tinyint(1) =1 creates custom user fields if they exist in the import file. NO   NULL  
original_header longtext Header row in JSON format. NO   NULL  
override_header longtext Edited header row in JSON format. NO   NULL  
line_count int(11) Approximate row count. YES   NULL  
job_id int(11) Joins to core_job.id YES MUL    

core_uploaderror

Errors encountered during imports.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime Creation date/time. NO MUL NULL  
update_at datetime Update date/time. NO   NULL  
upload_id int(11) Upload ID - joins to core_upload.id. NO MUL NULL  
worker_pid int(11) Process ID of worker task. YES   NULL  
row int(11) Row where the error occurred - header is row 1. YES   NULL  
col int(11) Column where the error occurred. YES   NULL  
message longtext Error message. NO   NULL  
exception longtext Python exception if the error was caused by one. YES   NULL  
value varchar(255) Value which caused the error. YES   NULL  
raw_row longtext Row data from the row with the error. YES   NULL  

core_uploadprogress

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
upload_id int(11) Upload identifier. NO MUL NULL  
worker_pid int(11) Needs description. NO   NULL  
ok int(11) Needs description. NO   NULL  
warnings int(11) Warning messages displayed on upload report screen. NO   NULL  
errors int(11) Error messages displayed on upload report screen. NO   NULL  
rate double Upload speed. YES   NULL  

core_uploadwarning

Warnings encountered during imports. Warnings indicate possible data problems but they don't cause your import to fail like errors.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime Creation date/time. NO MUL NULL  
updated_at datetime Update date/time. NO MUL NULL  
upload_id int(11) Upload ID - joins to core_upload.id. NO MUL NULL  
worker_pid int(11) Process ID of worker task. YES   NULL  
row int(11) Row where the warning occurred - header is row 1. YES   NULL  
col int(11) Column where the warning occurred. YES   NULL  
message longtext Warning message. NO   NULL  
exception longtext Python exception if the warning was caused by one. YES   NULL  
value varchar(255) Value which caused the warning. YES   NULL  
raw_row longtext Row data from the row with the warning. YES   NULL  

User Tables

The User tables contain information about individual users.

The following core user tables are described below:

core_alloweduserfield

Field created by your group to capture user-specific data.

Field Type Description Null Key Default Extra
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
hidden tinyint(1) 1=hidden NO   NULL  
order_index int(11) Sets the display order for user fields show on the user record and in the pull down display. NO   NULL  
display_name varchar(255)   NO UNI NULL  
name varchar(255) The name of the custom user field. NO PRI    
always_show tinyint(1) 1=always show on the individual user record (even if there is no value entered) NO   0  
required tinyint(1) A value must be entered for this field on the user record before saving. NO   NULL  
description longtext Description of custom user field. YES      
field_type varchar(32) Choose how data should be entered in this field. NO   NULL  
field_default longtext Provide a default value that will be pre-filled wherever this field is displayed in the admin. NO   NULL  
field_choices longtext Values available if the list type is Select From List or Select From List with Other. NO   NULL  
field_regex longtext You can provide a regular expression to validate campaigners' input here. NO   NULL  
field_length int(11) Maximum number of characters; leave blank for unlimited. YES   NULL  

core_location

Geography info for each user.

Field Type Description Null Key Default Extra
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
user_id int(11) joins on core_user.id. NO PRI NULL  
us_district varchar(5) User's Congressional District (based on zip and, if available, plus4). NO   NULL  
us_state_senate varchar(6) User's state senate district if known (based on zip plus4). NO   NULL  
us_state_district varchar(6) User's state house district if known (based on zip plus4). NO   NULL  
us_county varchar(255) User's county if known (based on zip). US only. NO   NULL  
loc_code varchar(30) ActionKit generated data used for radius targeting. YES MUL NULL  
longitude double ActionKit assigned longitude for user location. YES   NULL  
latitude double ActionKit assigned latitude for user location. YES   NULL  
country_code varchar(2) =01 for US users. YES MUL    
region_code varchar(20) For international users - region code for user location. YES      
lat_lon_precision varchar(32) Needs description YES      
timezone varchar(255) User's timezone if known NO   NULL  

core_phone

All phone numbers associated with a given user.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
user_id int(11) joins on core_user.id. NO MUL NULL  
type varchar(25) Types are home, mobile, work, emergency, home fax, work fax. NO   NULL  
phone varchar(25) Phone number. NO   NULL  
source varchar(25) Source of phone number. NO   NULL  
normalized_phone varchar(25) Digits with no spaces or punctuation. NO MUL NULL  

core_user

User contact info, user_id, and source of the first action the user took.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for each email address (user) and related data. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
email varchar(255) User email address. NO UNI NULL  
prefix varchar(255) User name prefix. NO      
first_name varchar(255) User first name. NO   NULL  
middle_name varchar(255) User middle name. NO   NULL  
last_name varchar(255) User last name. NO MUL NULL  
suffix varchar(255) User name suffix. NO   NULL  
password varchar(255) User password NO   NULL  
subscription_status varchar(255) Subscribed, unsubscribed, bounced, never. NO MUL NULL  
address1 varchar(255) User address. NO   NULL  
address2 varchar(255) User address. NO   NULL  
city varchar(255) User city. NO   NULL  
state varchar(255) User state. NO MUL NULL  
region varchar(255) International user region. NO   NULL  
postal varchar(255) International user postal code. NO   NULL  
zip varchar(5) User zip code. NO MUL NULL  
plus4 varchar(4) User zip plus 4 digit code. NO   NULL  
country varchar(255) User country. NO MUL NULL  
source varchar(255) Source of the first action the user took (see core_action.) NO MUL NULL  
lang_id int(11) If the user took action on a page associated with a language the id shows here. Joins to core_language. YES MUL NULL  
rand_id int(11) Not in use. NO MUL NULL  

core_userfield

User field values.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI NULL auto_increment
parent_id int(11) User id. Joins to core_user on (core_userfield.parent_id= core_user.id) NO MUL NULL  
name varchar(255) field name NO MUL NULL  
value longtext User's response. NO   NULL  
action_id int(11) The action that set this field to its current value. Joins to core_action. NULL for fields before this feature was added and for fields edited by staff.     NULL  
updated_at datetime(6) Date/time this record was last updated. NULL for fields before this feature was added.     NULL  

core_usermerge

Record of users merged.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
primary_id int(11) The ID of the primary user selected in a user merge. Joins to core_user. NO MUL NULL  
status varchar(255) Complete or pending. NO MUL NULL  

core_usermerge_users

Secondary user records merged into primary user. Primary shown in core_usermerge.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI NULL auto_increment
usermerge_id int(11) Joins to core_usermerge. NO MUL NULL  
user_id int(11) Each secondary user_id merged to primary in the core_usermerge record. NO MUL NULL  

core_userstaffnote

Staff notes on users.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
user_id int(11) User id. Joins to core_user on (core_userstaffnote.user_id = core_user.id) NO MUL NULL  
staff_id int(11) Staff User id. Joins to auth_user on (core_userstaffnote.staff_id = auth_user.id NO MUL NULL  
note longtext Staffer's note. NO   NULL  

core_user_page_tags

De-normalized record of user tags. Updated every 10 minutes.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI   auto_increment
user_id int(11) Joins to core_user.id NO MUL    
tag_id int(11) Joins to core_tag.id NO MUL    

core_reengagementlog

Daily counts for users engaged and unengaged per the most recently run count, added to the re-engagement list, removed from the re-engagement list, and unsubscribed through list migration.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI   auto_increment
created_at datetime Created date/time. NO MUL NULL  
updated_at datetime Updated date/time. NO   NULL  
dry_run tinyint(1) 1=Counted users but did not move. NO   NULL  
engaged int(11) Count of engaged users. NO   NULL  
unengaged int(11) Count of unengaged users. NO   NULL  
added int(11) Count of users added to re-engagement list. NO   NULL  
removed int(11) Count of users removed from re-engagement list. NO   NULL  
unsubscribed int(11) Count of users unsubscribed. NO   NULL  

Subscription Tables

The Subscription tables relate to users' list membership and subscription history.

The following core subscription tables are described below:

core_list

Name and id of mailing lists.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL Null  
updated_at datetime   NO   Null  
name varchar(255) Name of the list. NO UNI Null  
notes varchar(255) Notes field for internal use. YES      
hidden tinyint(1) 1=hidden NO MUL NULL  
is_default tinyint(1) 1=default mailing list YES   0  

core_subscription

List membership for each subscribed users.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for each user/list combination. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
user_id int(11) Joins on core_user.id. NO MUL NULL  
list_id int(11) Joins on core_list.id. NO MUL NULL  

core_subscriptionchangetype

Descriptions of each of the types of changes that are possible to a user's subscription to a particular list.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
name varchar(255) Name of change: subscribe, subscribe_api, subscribe_import, subscribe_merge, subscribe_notspamcheck, subscribe_uploader, unsubscribe, unsubscribe_admin, unsubscribe_bounce, unsubscribe_email, unsubscribe_import, unsubscribe_merge, unsubscribe_reengagement, unsubscribe_spamcheck NO UNI NULL  
description varchar(255) Definition (ex: Subscribe, Subscribe by import, Unsubscribe Bounce, etc.) NO   NULL  
subscribed tinyint(1) 0 = unsubscribed; 1 = subscribed NO   NULL  

core_subscriptioncounthistory

Daily subscription counts for each list, and overall.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
list_id int(11) Joins on core_list.id.
NULL = across all lists.
YES MUL NULL  
date date   NO   NULL  
subscribers int(11) Count of subscribers to the list. NO   NULL  

core_subscriptionhistory

Changes in subscription status for each user w/ id that ties to changetype table.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
user_id int(11) Joins on core_user.id. NO MUL NULL  
list_id int(11) The list this user was added or removed from. Joins to core_list. NO MUL NULL  
change_id int(11) Change type defined in core_subscriptionchangetype table above. NO MUL NULL  
action_id int(11) The action that led to the subscription status change. Joins on (core_action.id= core_subscriptionhistory.action_id) YES MUL NULL  

gm_subscriptioncounthistory

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
list_id int(11) Joins on core_list.id.
NULL = across all lists.
YES MUL NULL  
date date   NO   NULL  
subscribers int(11) Count of subscribers to the list. NO   NULL  

Job table

core_job

Table with information about back end processing jobs in ActionKit (like uploads or reports).

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
job_type varchar(255) Types include merge file, ping, report, upload. NO   NULL  
priority int(11)   YES   NULL  
parameters longtext   YES   NULL  
result_data longtext   YES   NULL  
submitter_id int(11) user_id of person submitting job YES MUL NULL  
started_at datetime job start YES   NULL  
finished_at datetime job end YES   NULL  
server varchar(255)   YES   NULL  
pid int(11)   YES   NULL  
rate double   YES   NULL  
progress int(11)   YES   NULL  
goal int(11)   YES   NULL  
estimated_finish_at datetime   YES   NULL  
status varchar(20) Job status (e.g. completed, died). YES   NULL  
django_version varchar(255)   YES   NULL  
polled_at datetime Last time this report's status was polled (by keeping its window open) while it was running. (If a report is running but has not been checked in ten minutes, it's considered abandoned and is killed). YES   NULL  

CMS tables

The CMS tables relate to the appearance and text of pages, like petitions, call actions, and unsubscribes.

The following cms tables are described below:

cms_allowedtemplatesetfield

Allowed templateset fields.

f
Field width=100pxType Description Null Key Default Extra
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
hidden tinyint(1)   NO MUL NULL  
order_index int(11) Sets display order for list of fields. NO   NULL  
display_name varchar(255) The display name is shown when selecting a custom field and may be changed in the future. Spaces, punctuation, etc are permitted. NO UNI NULL  
name varchar(255)   NO PRI NULL  
always_show tinyint(1) 1=always show NO   NULL  
description longtext Add a description to help your campaigners use this custom field. We will display your description just below the form input. YES   NULL  
field_default longtextProvide a default value that will be pre-filled wherever this field is displayed in the admin. NO   NULL  
field_choices longtext Choices displayed for this field. NO   NULL  
field_regex longtext You can provide a regular expression to validate campaigners' input here. NO   NULL  
field_type varchar(32) Choose how data should be entered in this field. NO   NULL  
field_length int(11) Maximum number of characters; leave blank for unlimited. YES   NULL  
required tinyint(4) 1 if the field is required. NO   NULL  

cms_call_form

Call page content.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
templateset_id int(11) Id of the templateset, which defines the page look and feel. Pulls from cms_templateset on (cms_template.id= cms_call_form.templateset_id) NO MUL NULL  
page_id int(11) ID of the page, which defines action basics and follow-up. Pulls from core_ page on (cms_call_form.page_id= core_page.id) NO UNI NULL  
thank_you_text longtext Text displayed on the thank you page (URL defined in core_page table) after end user takes action. NO   NULL  
script_text longtext Sample call script displayed to the user. NO   NULL  
introduction_text longtext Introductory text about call campaign, encouraging user to call. NO   NULL  
survey_question_text longtext Question for users about the call, such as "how did it go?". NO   NULL  
client_hosted int(11) 1 if the page is hosted outside of the ActionKit CMS YES   0  
client_url varchar(255) URL of a page hosted outside of the ActionKit CMS. Used for the "View" link in the admin interface. YES      

cms_cannedletter

Sample letters displayed on LTE forms.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for each canned letter. NO PRI NULL auto_increment
lte_form_id int(11) ID of the lte page content form. NO MUL NULL  
subject varchar(80) Canned letter subject line. NO   NULL  
letter_text longtext Sample letter text. NO   NULL  

cms_campaign_volunteer_form

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
thank_you_text longtext Text displayed on the thank you page (URL defined in core_page table) after end user takes action. NO   NULL  
templateset_id int(11) Id of the templateset, which defines the page look and feel. Pulls from cms_templateset on (cms_template.id= cms_campaign_volunteer_form.templateset_id) NO MUL NULL  
page_id int(11) ID of the page, which defines action basics and follow-up. Pulls from core_ page on (cms_campaign_volunteer_form.page_id= core_page.id) NO UNI NULL  
client_hosted tinyint(1) 1 if the page is hosted outside of the ActionKit CMS NO   NULL  
client_url varchar(255) URL of a page hosted outside of the ActionKit CMS. Used for the "View" link in the admin interface. NO   NULL  
ground_rules longtext Ground rules you require volunteer moderators to agree to before they can sign up. NO   NULL  
volunteer_text longtext Content that displays on the volunteer moderator sign up form. NO   NULL  

cms_donation_form

Donation page content.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
templateset_id int(11) Id of the templateset, which defines the page look and feel. Pulls from cms_templateset on (cms_template.id= cms_donation_form.templateset_id) NO MUL NULL  
page_id int(11) ID of the page, which defines action basics and follow-up. Pulls from core_ page on (cms_donation_form.page_id= core_page.id) NO UNI NULL  
thank_you_text longtext Text displayed on the thank you page (URL defined in core_page table) after end user takes action. NO   NULL  
ask_text longtext Donation request. NO   NULL  
is_recurring tinyint(1)   NO   NULL  
show_other_amount tinyint(1) 1=show other amount checkbox to user. NO   NULL  
amount_order varchar(255) Options are "High-to-Low", "Low-to-High". NO   NULL  
client_hosted int(11) 1 if the page is hosted outside of the ActionKit CMS YES   0  
client_url varchar(255) URL of a page hosted outside of the ActionKit CMS. Used for the "View" link in the admin interface. YES      

cms_donationamount

Donations also have a subsidiary table showing suggested donation amounts to be displayed on a donation page to the end user.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
amount varchar(10) Amount to be displayed. NO   NULL  
donation_form_id int(11) Joins to cms_donation_form. NO MUL NULL  
is_default tinyint(1) 1 if this amount is selected by default YES   0  

cms_event_create_form

Host event creation page content.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
templateset_id int(11) Id of the templateset, which defines the page look and feel. Pulls from cms_templateset on (cms_template.id= cms_event_create_form.templateset_id) NO MUL NULL  
page_id int(11) ID of the page, which defines action basics and follow-up. Pulls from core_ page on (cms_event_create_form.page_id= core_page.id) NO UNI NULL  
thank_you_text longtext Text displayed on the thank you page (URL defined in core_page table) after end user takes action. NO   NULL  
ground_rules longtext Text contains any event ground rules such as legal requirements. NO   NULL  
host_requirements longtext Text containing any requirements specific to the event host. NO   NULL  
host_text longtext Intro text on the host sign up page. NO   NULL  
custom_field_html longtext   NO   NULL  
tools_text longtext Text displayed on the event tools page, where the host can manage their own event. NO   NULL  
tools_sidebar longtext Sidebar on host event tools page - enter URLs for resources like event guide. NO   NULL  
client_hosted int(11) 1 if the page is hosted outside of the ActionKit CMS YES   0  
client_url varchar(255) URL of a page hosted outside of the ActionKit CMS. Used for the "View" link in the admin interface. YES      

cms_event_moderate_form

Volunteer moderator form for reviewing events, flagging issues, emailing hosts, etc.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
thank_you_text longtext Text displayed on the thank you page (URL defined in core_page table) after user submits an event moderation action. NO   NULL  
templateset_id int(11) ID of the templateset, which defines the page look and feel. Pulls from cms_templateset on (cms_template.id= cms_event_moderate_form.templateset_id) NO MUL NULL  
page_id int(11) ID of the page, which defines action basics and follow-up. Pulls from core_ page on (cms_event_moderate_form.page_id= core_page.id) NO UNI NULL  
client_hosted tinyint(1) 1 if the page is hosted outside of the ActionKit CMS NO   NULL  
client_url varchar(255) URL of a page hosted outside of the ActionKit CMS. Used for the "View" link in the admin interface. NO   NULL  
custom_field_html longtext Used to define criteria or questions for volunteers when reviewing events. Must start with 'action_'. NO   NULL  
tools_text longtext Text displayed in the moderation box for volunteer moderators. NO   NULL  
tools_sidebar longtext Sidebar for moderator view. NO   NULL  
host_tools_sidebar longtext Not in use. NO   NULL  

cms_event_signup_form

Attendee event sign up page content.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
templateset_id int(11) Id of the templateset, which defines the page look and feel. Pulls from cms_templateset on (cms_template.id= cms_event_signup_form.templateset_id) NO MUL NULL  
page_id int(11) ID of the page, which defines action basics and follow-up. Pulls from core_ page on (cms_event_signup_form.page_id= core_page.id) NO UNI NULL  
thank_you_text longtext Text displayed on the thank you page (URL defined in core_page table) after end user takes action. NO   NULL  
ground_rules longtext Text contains any event ground rules such as legal requirements. NO   NULL  
search_page_text longtext Intro text on the page where users can search for events by zip or city. NO   NULL  
signup_text longtext Text displayed on the screen where users sign up for a particular event. NO   NULL  
custom_field_html longtext   NO   NULL  
tools_text longtext Text containing information about the attendee event tool page. NO   NULL  
tools_sidebar longtext URLs for attendee materials. NO   NULL  
client_hosted int(11) 1 if the page is hosted outside of the ActionKit CMS YES   0  
client_url varchar(255) URL of a page hosted outside of the ActionKit CMS. Used for the "View" link in the admin interface. YES      

cms_event_volunteer_form

Event moderator sign up page content.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
thank_you_text longtext Text displayed on the thank you page (URL defined in core_page table) after user submits an event moderation action. NO   NULL  
templateset_id int(11) ID of the templateset, which defines the page look and feel. Pulls from cms_templateset on (cms_template.id= cms_event_moderate_form.templateset_id) NO MUL NULL  
page_id int(11) ID of the page, which defines action basics and follow-up. Pulls from core_ page on (cms_event_moderate_form.page_id= core_page.id) NO UNI NULL  
client_hosted tinyint(1) 1 if the page is hosted outside of the ActionKit CMS NO   NULL  
client_url varchar(255) URL of a page hosted outside of the ActionKit CMS. Used for the "View" link in the admin interface. NO   NULL  
ground_rules longtext Text contains any rules for moderators to agree to. NO   NULL  
volunteer_text longtext Text displayed on the signup page for volunteer moderators. NO   NULL  

cms_githubconnection

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
templateset_id int(11)   NO UNI NULL  
repository_id int(11)   NO MUL NULL  
path varchar(255)   NO   NULL  
live_branch varchar(255)   NO   NULL  
preview_branch varchar(255)   NO   NULL  

cms_githubevent

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
body longtext   NO   NULL  
repository_id int(11)   YES MUL NULL  
processed_by_id int(11)   YES MUL NULL  

cms_githubrepository

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime(6)   NO MUL NULL  
updated_at datetime(6)   NO   NULL  
owner varchar(255)   NO MUL NULL  
repos varchar(255)   NO   NULL  
private tinyint(1)   NO   NULL  
public_key longtext   YES   NULL  
private_key longtext   YES   NULL  
webhook varchar(255)   YES   NULL  
deploy_key varchar(255)   YES   NULL  

cms_githubwebhooksecret

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
secret varchar(255)   NO   NULL  

cms_letter_form

Letter page content.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
templateset_id int(11) Id of the templateset, which defines the letter look and feel. Pulls from cms_templateset on (cms_template.id= cms_letter_form.templateset_id) NO MUL NULL  
page_id int(11) ID of the page, which defines action basics and follow-up. Pulls from core_ page on (cms_letter_form.page_id= core_page.id) NO UNI NULL  
thank_you_text longtext Text displayed on the thank you page (URL defined in core_page table) after end user takes action. NO   NULL  
statement_leadin longtext Letter lead in text. NO   NULL  
letter_text longtext Default letter text that end users can edit. NO   NULL  
about_text longtext Letter page intro. NO   NULL  
client_hosted int(11) 1 if the page is hosted outside of the ActionKit CMS YES   0  
client_url varchar(255) URL of a page hosted outside of the ActionKit CMS. Used for the "View" link in the admin interface. YES      

cms_lte_form

LTE page content.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
templateset_id int(11) Id of the templateset, which defines the lte look and feel. Pulls from cms_templateset on (cms_template.id= cms_lte_form.templateset_id) NO MUL NULL  
page_id int(11) ID of the page, which defines action basics and follow-up. Pulls from core_ page on (cms_lte_form.page_id= core_page.id) NO UNI NULL  
thank_you_text longtext Text displayed on the thank you page (URL defined in core_page table) after end user takes action. NO   NULL  
introduction_text longtext LTE intro. NO   NULL  
talking_points longtext Main points for end user to include in lte. NO   NULL  
writing_tips longtext Tips to end user about writing letters to the editor. NO   NULL  
client_hosted int(11) 1 if the page is hosted outside of the ActionKit CMS YES   0  
client_url varchar(255) URL of a page hosted outside of the ActionKit CMS. Used for the "View" link in the admin interface. YES      

cms_petition_form

Petition content.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for each petition form. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
templateset_id int(11) Id of the templateset, which defines the petition look and feel. Pulls from cms_templateset on (cms_template.id= cms_petition_form.templateset_id) NO MUL NULL  
page_id int(11) ID of the page, which defines action basics and follow-up. Pulls from core_ page on (cms_petition_form.page_id= core_page.id) NO UNI NULL  
thank_you_text longtext Text displayed on the thank you page (URL defined in core_page table) after end user takes action. NO   NULL  
statement_leadin longtext Optional text displayed to end user saying who target is. NO   NULL  
statement_text longtext Petition statement text. Displayed to end user. NO   NULL  
about_text longtext Text about why the user should sign the petition. Displayed to end user. NO   NULL  
client_hosted int(11) 1 if the page is hosted outside of the ActionKit CMS YES   0  
client_url varchar(255) URL of a page hosted outside of the ActionKit CMS. Used for the "View" link in the admin interface. YES      

cms_recurringdonationcancel_form

Recurring donation cancellation page content.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
templateset_id int(11) Id of the templateset, which defines the recurring donation cancel page look and feel. Pulls from cms_templateset on (cms_template.id= cms_recurringdonationcancel_form.templateset_id) NO MUL NULL  
page_id int(11) ID of the page, which defines action basics and follow-up. Pulls from core_ page on (cms_recurringdonationcancel_form.page_id= core_page.id) NO UNI NULL  
thank_you_text longtext Text displayed on the thank you page (URL defined in core_page table) after end user takes action. NO   NULL  
please_stay_text longtext Optional text displayed to end user requesting that they not cancel their donation. NO   NULL  
client_hosted int(11) 1 if the page is hosted outside of the ActionKit CMS YES   0  
client_url varchar(255) URL of a page hosted outside of the ActionKit CMS. Used for the "View" link in the admin interface. YES      

cms_recurringdonationupdate_form

Recurring donation update page content.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
templateset_id int(11) Id of the templateset, which defines the recurring donation update page look and feel. Pulls from cms_templateset on (cms_template.id= cms_recurringdonationupdate_form.templateset_id) NO MUL NULL  
page_id int(11) ID of the page, which defines action basics and follow-up. Pulls from core_ page on (cms_recurringdonationupdate_form.page_id= core_page.id) NO UNI NULL  
thank_you_text longtext Text displayed on the thank you page (URL defined in core_page table) after end user takes action. NO   NULL  
update_card_text longtext Text to end user about options on this page. NO   NULL  
client_hosted int(11) 1 if the page is hosted outside of the ActionKit CMS YES   0  
client_url varchar(255) URL of a page hosted outside of the ActionKit CMS. Used for the "View" link in the admin interface. YES      

cms_signup_form

Sign up page content.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
templateset_id int(11) Id of the templateset, which defines the signup look and feel. Pulls from cms_templateset on (cms_template.id= cms_signup_form.templateset_id) NO MUL NULL  
page_id int(11) ID of the page, which defines action basics and follow-up. Pulls from core_ page on (cms_sign_form.page_id= core_page.id) NO UNI NULL  
thank_you_text longtext Text displayed on the thank you page (URL defined in core_page table) after end user takes action. NO   NULL  
introduction_text longtext Optional text displayed to end user asking them to signup. NO   NULL  
client_hosted int(11) 1 if the page is hosted outside of the ActionKit CMS YES   0  
client_url varchar(255) URL of a page hosted outside of the ActionKit CMS. Used for the "View" link in the admin interface. YES      

cms_survey_form

Survey page content.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
templateset_id int(11) Id of the templateset, which defines the survey look and feel. Pulls from cms_templateset on (cms_template.id= cms_survey_form.templateset_id) NO MUL NULL  
page_id int(11) ID of the page, which defines action basics and follow-up. Pulls from core_ page on (cms_survey_form.page_id= core_page.id) NO UNI NULL  
thank_you_text longtext Text displayed on the thank you page (URL defined in core_page table) after end user takes action. NO   NULL  
introduction_text longtext Optional text displayed to end user explaining the survey. NO   NULL  
client_hosted int(11) 1 if the page is hosted outside of the ActionKit CMS YES   0  
client_url varchar(255) URL of a page hosted outside of the ActionKit CMS. Used for the "View" link in the admin interface. YES      

cms_survey_question

Surveys also have a subsidiary table for the survey question html.

tr>
Field Type Description Null Key Default Extra
id int(11) Unique identifier for all survey questions on this survey form. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
question_label varchar(255) Survey question label. NO   NULL  
question_html longtext Html to display the question and answer choices (as checkboxes, or a textbox, etc.) for the end user. NO   NULL  
survey_form_id int(11) Joins to general survey content, as outlined in the table above, on (cms_survey_form.id= cms_survey_question.survey_form_id) NO MUL NULL  
ordering int(11) Sets the question order on the survey page. YES   0  
field_type varchar(16) Display format for field (e.g. 'text', 'checkbox', etc.) YES   NULL  
field_name varchar(255) The name of the action field that the user entry is saved under (e.g. select value from core_actionfield where name='[field_name entry]'). YES   NULL  
alternatives longtext Text of alternatives if the field type offers options to select from. YES   NULL  
options_json longtext Description needed. YES   NULL  
is_required tinyint(1) 1 if required. YES   0  

cms_template

HTML for each template. A template sets the appearance for a page type (like petition) and related items (like list of states).

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
filename varchar(255) Identifies page type or name of related item. NO MUL NULL  
code longtext Template HTML. NO   NULL  
templateset_id int(11) Joins to templateset on (cms_templateset.id= cms_template.templateset_id). NO MUL NULL  
code_hash varchar(64) Holds a hash of the template's code NO MUL NULL  

cms_templatecode

Stored text of old and current versions of templates for history.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
code_hash varchar(64) Holds a hash of the template's code NO MUL NULL  
code longtext html for displaying this type of page or item. NO   NULL  

cms_templatehistory

Stores old versions of templates.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
templateset_id int(11) Joins to templateset on (cms_templateset.id= cms_templatehistory.templateset_id). NO MUL NULL  
filename varchar(255) Identifies name of particular template. NO   NULL  
code_hash varchar(64) Holds a hash of the template's code NO   NULL  
user_name varchar(64) Identifies which admin user made this edit. YES   NULL  
edit_type varchar(64) Contains a designation like "edit", "copy", or "patch" YES   NULL  
github_sha varchar(64) Description needed. YES   NULL  
github_message longtext Description needed. YES   NULL  

cms_templateset

Name and description of a set of templates. Each set has the same templates.

Field Type Description Null Key Default Extra
id int(11) unique identifier NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
name varchar(255) Name of set NO UNI NULL  
description varchar(255) Description of set NO   NULL  
lang_id int(11) Joins to core_language on (cms_templateset.lang_id= core_language.id) YES MUL NULL  
editable tinyint(1) 0 prevents overwriting built-in Original templatesets NO   1  
hidden tinyint(1) 1=yes, templateset is hidden NO MUL NULL  
is_default tinyint(1) 1 if this templateset is to be selected by default during page creation YES   0  

cms_templatesetfield

Templateset field values.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI NULL auto_increment
parent_id int(11) User id. Joins to core_template on (core_templatesetfield.parent_id= core_template.id) NO MUL NULL  
name varchar(255) field name NO MUL NULL  
value longtext Value to be applied to the template. NO   NULL  

cms_unsubscribe_form

Unsubscribe page content.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
templateset_id int(11) Id of the templateset, which defines the unsubscribe look and feel. Pulls from cms_templateset on (cms_template.id= cms_unsubscribe_form.templateset_id) NO MUL NULL  
page_id int(11) ID of the page, which defines action basics and follow-up. Pulls from core_ page on (cms_unsubscribe_form.page_id= core_page.id) NO UNI NULL  
thank_you_text longtext Text displayed on the thank you page (URL defined in core_page table) after end user takes action. NO   NULL  
introduction_text longtext Optional text displayed to end user. NO   NULL  
suvery_question_text longtext Text asking user why they want to unsubscribe. NO   NULL  
client_hosted int(11) 1 if the page is hosted outside of the ActionKit CMS YES   0  
client_url varchar(255) URL of a page hosted outside of the ActionKit CMS. Used for the "View" link in the admin interface. YES      

cms_uploadedfile

Images, etc. for use in pages.

Field Type Description Null Key Default Extra
id int(11) unique identifier NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
bucket varchar(255) Needs description NO   NULL  
directory varchar(255) location of the file NO   NULL  
filename varchar(255) name of the file NO   NULL  
url varchar(255) address which you use to access the file NO UNI NULL  
etag varchar(255) Needs description NO   NULL  

cms_user_form_field

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI   auto_increment
created_at datetime   NO MUL    
updated_at datetime   NO      
form_type_id int(11) Joins to django_content_type.id NO MUL    
form_id int(10) unsigned Joins to the unique identifier of the CMS form table for the content type identified by form_type_id. NO      
type varchar(8) User, action, custom, or HTML. NO      
label longtext Field input label. NO      
field_name varchar(96) Name of the field NO      
input varchar(16) HTML input type. NO      
alternatives longtext The options provided for this input. NO      
html longtext Custom input HTML when type=HTML. NO      
status varchar(8) visible=the field will show on the user form, but a user can submit without entering a value. Required=the user cannot submit on this page without filling in this field. Hidden=the field will be included if required by an selected advocacy target. NO      
ordering int(11) Used to reorder form fields. NO      

cms_whipcount_form

Whipcount page content.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
templateset_id int(11) Id of the templateset, which defines the whipcount look and feel. Pulls from cms_templateset on (cms_template.id= cms_whipcount_form.templateset_id) NO MUL NULL  
page_id int(11) ID of the page, which defines action basics and follow-up. Pulls from core_ page on (cms_whipcount_form.page_id= core_page.id) NO UNI NULL  
thank_you_text longtext Text displayed on the thank you page (URL defined in core_page table) after end user takes action. NO   NULL  
introduction_text longtext Page intro. NO   NULL  
script_text longtext Call script. NO   NULL  
survey_question_text longtext Question for the user about the call (e.g. "Who did you speak to?"). NO   NULL  
results_source varchar(255) Source used to determine target's position. Possible values are User submitted, Admin configured, and User submitted with admin overrides. NO   users  
minimum_response_agreement decimal(3,2) Percentage value that must agree before the results are displayed on the page. NO   NULL  
minimum_calls int(11) The number of calls that must be made before the results are displayed on the page. NO   NULL  
client_hosted int(11) 1 if the page is hosted outside of the ActionKit CMS YES   0  
client_url varchar(255) URL of a page hosted outside of the ActionKit CMS. Used for the "View" link in the admin interface. YES      

cms_whipcountresponseoverride

Holds the admin configuration for overrides for target stances on a whipcount page.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
whipcount_form_id int(11) Joins to cms_whipcount_form NO MUL NULL  
target_id int(11) Joins to core_target NO MUL NULL  
stance varchar(255) Holds the target's position: either "supportive," "opposed," or "uncommitted" NO   NULL  

Page testing and statistics Tables

A/B page test tables record variations, trials, views and actions associated with page tests.

lab_test

An A/B test containing two or more variations, which override selected attributes of the page, like its title or sharing text.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
name varchar(255) Either the given or auto-generated name for the A/B test. YES   NULL  
notes varchar(255) Notes field for internal use. YES   NULL  
scope varchar(12) Not in use. NO   NULL  
allocation varchar(32) Method for assigning users to test variants: equal, custom, or optimize. NO   NULL  
optimize_for varchar(32) If allocation=optimize, the ratio that the test will try to optimize. YES   NULL  
change_page_title tinyint(1) 1=Test variants change page titles. NO   NULL  
change_intro_text tinyint(1) 1=Test variants change page intro text. NO   NULL  
change_thanks_text tinyint(1) 1=Test variants change page thank-you text. NO   NULL  
change_templateset tinyint(1) 1=Test variants may change page templatesets. NO   NULL  
change_custom_fields tinyint(1) Not used. NO   NULL  
change_followup_url tinyint(1) 1=Test variants change follow-up URLs. NO   NULL  
change_email_enabled tinyint(1) 1=Test variants may change whether thank-you emails are sent. NO   NULL  
change_email_subject tinyint(1) 1=Test variants change thank-you email subject. NO   NULL  
change_email_body tinyint(1) 1=Test variants change thank-you email body. NO   NULL  
change_taf_enabled tinyint(1) 1=Test variants may change whether tell-a-friend is enabled. NO   NULL  
change_taf_subject tinyint(1) 1=Test variants change tell-a-friend email subject. NO   NULL  
change_taf_body tinyint(1) 1=Test variants change tell-a-friend email body. NO   NULL  
change_share_title tinyint(1) 1=Test variants change share title. NO   NULL  
change_share_description tinyint(1) 1=Test variants change Facebook share description. NO   NULL  
change_share_image tinyint(1) 1=Test variants change Facebook share image. NO   NULL  
change_twitter_message tinyint(1) 1=Test variants change Twitter message. NO   NULL  

lab_variation

Variations override selected attributes of page in a test, like its title or sharing text.

Field Type Description Null Key Default Extra
id int(11) Unique identifier NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
test_id int(11) Joins to lab_test. NO MUL NULL  
letter varchar(2) Letter identifying this variant, e.g. A or B. NO   NULL  
weight double Allocation weight for this variant. Variants with a greater weight are shown more frequently. NO   NULL  
disabled tinyint(1) 1=Users will not see or be enrolled in a test using this variation. NO   NULL  
page_title varchar(255) Page title shown for this variation. If empty, page's original value will be used. NO   NULL  
intro_text longtext Intro text to display for users seeing this variation. If empty, page's original value will be used. NO   NULL  
thanks_text longtext Thank-you text to display for users seeing this variation. If empty, page's original value will be used. NO   NULL  
templateset_id int(11) Templateset to use for users seeing this variation. If empty, page's original value will be used. YES MUL NULL  
custom_fields longtext Not used. NO   NULL  
followup_url varchar(255) Follow-up URL to use for users taking action on this variation. If empty, page's original value will be used. NO   NULL  
email_enabled varchar(1) 0=Thank-you email disabled, 1=thank-you text enabled. If empty, page's original value will be used. NO   NULL  
email_subject varchar(255) Thank-you email subject to use for users seeing this variation. If empty, page's original value will be used. NO   NULL  
email_body longtext Thank-you email body to use for users seeing this variation. If empty, page's original value will be used. NO   NULL  
taf_enabled varchar(1) 0=Tell-a-friend disabled, 1=tell-a-friend enabled. If empty, page's original value will be used. NO   NULL  
taf_subject varchar(255) Tell-a-friend subject to use for users seeing this variation. If empty, page's original value will be used. NO   NULL  
taf_body longtext tell-a-friend email body use for users seeing this variation. If empty, page's original value will be used. NO   NULL  
share_title varchar(255) Facebook share title to display for users seeing this variation. If empty, page's original value will be used. NO   NULL  
share_description longtext Facebook share description to display for users seeing this variation. If empty, page's original value will be used. NO   NULL  
share_image varchar(255) Facebook share image to display for users seeing this variation. If empty, page's original value will be used. NO   NULL  
twitter_message varchar(255) Twitter message to display for users seeing this variation. If empty, page's original value will be used. NO   NULL  

lab_trial

A period during which a test was active.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
test_id int(11) Joins to lab_test. NO MUL NULL  
page_id int(11) Joins to core_page. YES MUL NULL  
started_at datetime Start date for this trial. NO   NULL  
ended_at datetime End date for this trial. YES   NULL  

lab_enrollment

When a test is active, users who visit a page are “enrolled” with one variation or another, and see that version of the page. Enrollments are sticky between requests, so if a user reloads a page, or clicks away and then returns, they’ll see the same variation again.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
test_id int(11) Joins to lab_test. NO MUL NULL  
variation_id int(11) Joins to lab_variation. NO MUL NULL  
trial_id int(11) Joins to lab_trial. YES MUL NULL  
user_id int(11) Joins to core_user. YES MUL NULL  
session_key varchar(255) Session identifier used to recognize a user across pageviews. YES   NULL  

lab_view

The lab_view table stores a row for each view of a page that is involved in a test.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
page_id int(11) Joins to core_page. NO MUL NULL  
filename varchar(255) Not used. NO   NULL  
user_id int(11) Joins to core_user. YES MUL NULL  
mailing_id int(11) Joins to core_mailing. YES MUL NULL  
share_id int(11) Joins to share_link. YES MUL NULL  

lab_enrolledview

Extending lab_view, the lab_enrolledview table records a row for each page view made by a user enrolled in a test.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
view_id int(11) Joins to lab_view. NO MUL NULL  
enrollment_id int(11) Joins to lab_enrollment. NO MUL NULL  

lab_enrolledaction

Records actions taken by users that have been enrolled in a test.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
action_id int(11) Joins to core_action. NO MUL NULL  
enrollment_id int(11) Joins to core_enrollment. NO MUL NULL  

lab_enrolledshare

Records a row each time a user enrolled in a test clicks a tracking-enable share button to post a link to a social network.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
share_id int(11) Joins to share_link. NO MUL NULL  
enrollment_id int(11) Joins to lab_enrollment. NO MUL NULL  

lab_test_pages

Pages that have been assigned to a test.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
test_id int(11) Joins to lab_test. NO MUL NULL  
page_id int(11) Joins to core_page. NO MUL NULL  

lab_tag

Categories that can be associated with a test.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
hidden tinyint(1) 1=yes, tag is hidden NO   NULL  
name varchar(255) Tag name. NO UNI NULL  

lab_test_tags

Categories that have been associated with a test.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
test_id int(11) Joins to lab_test. NO MUL NULL  
tag_id int(11) Joins to lab_tag. NO MUL NULL  

Privacy Tables

The Privacy tables provide an audit log of privacy records, used for GDPR and other compliance.

The following core privacy tables are described below:

core_privacynotes

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime(6)   NO   NULL  
updated_at datetime(6)   NO   NULL  
hidden tinyint(1)   NO   NULL  
text longtext   NO   NULL  

core_privacyrecord

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime(6)   NO   NULL  
updated_at datetime(6)   NO   NULL  
version_id int(11)   NO MUL NULL  
status varchar(32)   NO   NULL  
user_id int(11)   NO MUL NULL  
action_id int(11)   YES MUL NULL  

core_privacytext

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime(6)   NO   NULL  
updated_at datetime(6)   NO   NULL  
text longtext   NO   NULL  
type longtext   NO   NULL  
lang_id int(11)   YES MUL NULL  
hash varchar(64)   NO UNI NULL  
accepted tinyint(1)   NO   NULL  

eraser_eraserlog

Description needed

Field Type Description Null Key Default Extra
created_at datetime(6)   NO MUL NULL  
updated_at datetime(6)   NO   NULL  
user_id int(11)   NO PRI NULL  
hashed_email varchar(255)   NO   NULL  

Reports Tables

The Reports tables define queries and display for reports.

The following core reports tables are described below:

reports_dashboardreport

HTML for multi query (or dashboard) reports.

Field Type Description Null Key Default Extra
report_ptr_id int(11) Identifies the report. Joins to report_report. NO PRI Null  
template longtext HTML and display instructions for dashboard report. NO   Null  

reports_queryreport

SQL queries.

Field Type Description Null Key Default Extra
report_ptr_id int(11) Joins to reports_report above. NO PRI Null  
sql longtext The sql query. NO   Null  
display_as_id int(11) The template to be used to display the query. Joins to reports_querytemplate. NO MUL Null  
email_always_csv tinyint(1) Needs description YES   Null  
refresh varchar(255) For mailer library queries: every time, hourly or daily. YES   NULL  

reports_querytemplate

Layouts for the queries.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for each query layout. NO PRI NULL auto_increment
created_at datetime   NO MUL Null  
updated_at datetime   NO   Null  
name varchar(255) Template name. NO UNI Null  
template longtext Template HTML and display instructions. NO   Null  
hidden tinyint(1) 1=hidden NO MUL NULL  

reports_report

Name and basic info about all reports (query or dashboard).

Field Type Description Null Key Default Extra
id int(11) Unique identifier for each report. NO PRI NULL auto_increment
created_at datetime   NO MUL Null  
updated_at datetime   NO   Null  
name varchar(255) Report name. NO UNI Null  
short_name varchar(255) Reference name. YES UNI NULL  
description varchar(255) Description of report. NO   Null  
type varchar(255) Report type: query or dashboard. NO   Null  
run_every varchar(255) Hour, night or week. NO   NULL  
to_emails varchar(4000) Emails to receive the report. NO   NULL  
hidden tinyint(1) 1=hidden NO MUL NULL  
help_text longtext Additional text giving user direction for input. NO   NULL  
send_if_no_rows tinyint(1) 1=send the report, whether or not there are any matching rows NO   1  
run_day int(11) Day of month YES   1  
run_weekday int(11) Day of week YES   1
run_hour int(11) Time of day YES   8  
editable tinyint(1) 1=the report is editable. YES   1  

reports_report_categories

Links report to category.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
report_id int(11) Joins reports_report.id. NO MUL NULL  
reportcategory_id int(11) Joins reports_reportcategory.id NO MUL NULL  

reports_reportcategory

All available report categories.

Field Type Description Null Key Default Extra
id int(11) Unique identifier for each category. NO PRI NULL auto_increment
created_at datetime   NO MUL    
updated_at datetime   NO      
name varchar(255) Homepage and mailer, plus whatever categories you add. NO UNI NULL  
hidden tinyint(1) 1=hidden NO MUL 0  
is_internal tinyint(1) Needs description NO   0  

core_defaultexcludequery

Query report that will be excluded by default when a new mailing is created.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI   auto_increment
created_at datetime Creation date/time. NO MUL    
updated_at datetime Updated date/time. NO      
report_id int(11) Joins to reports_report.id NO MUL    

core_defaultexcludequeryparam

Additional parameters provided by staffer when using a query report as an auto excludes query.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime Creation date/time. NO MUL NULL  
updated_at datetime Updated date/time. NO   NULL  
query_id int(11) Query identifier. NO MUL NULL  
name varchar(255) Parameter name. NO   NULL  
value varchar(255) Value entered by staffer for the parameter. NO   NULL  

core_engagementqueryreport

Query report used to identify engaged users for re-engagement processing.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI   auto_increment
created_at datetime Creation date/time. NO MUL    
updated_at datetime Updated date/time. NO      
report_id int(11) Joins to reports_report.id NO MUL    

core_engagementqueryreportparam

Additional parameters provided by staffer when using a query report to identify engaged users.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime Creation date/time. NO MUL NULL  
updated_at datetime Updated date/time. NO   NULL  
query_id int(11) Query identifier. NO MUL NULL  
name varchar(255) Parameter name. NO   NULL  
value varchar(255) Value entered by staffer for the parameter. NO   NULL  

core_databaseaccount

Accounts that have been granted access to the MySQL client analytics database.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI   auto_increment
created_at datetime   NO      
updated_at datetime   NO      
username varchar(16) Database username. NO UNI    
email varchar(255) Database user's email address. YES      

zip_proximity

All zip code pairs within 50 miles of each other.

Field Type Description Null Key Default Extra
zip char(5) Zip code. NO      
nearby char(5) Another zip with 50 miles. NO      
same_state tinyint(1) 1=yes if the second zip is in the same state as the first. YES   NULL  
distance decimal (3,1) Distance to second zip. YES   NULL  

numeric_date

All dates from 1998-09-11 until 2026-01-26. Particularly useful for aggregating actions over a date ranges that may include days with 0 actions.

Field Type Description Null Key Default Extra
date varbinary(29)   YES   NULL  

numeric_9999

All integers from 0 to 9999.

Field Type Description Null Key Default Extra
number bigint(25)   NO   0  

numeric_digit

All integers from 0 to 10.

Field Type Description Null Key Default Extra
digit bigint(20)   NO   0  

Sharing Tables

The Sharing tables record share tracking links and any clicks and actions that are associated with them.

share_type

Records the names and two-letter type codes associated with various types of sharing, including Facebook, Twitter, and other.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
type varchar(2) Contains a share type code like "fb", "tw", or "ot" NO   NULL  
name varchar(255) Title of the sharing type, like "Facebook" or "Twitter" NO   NULL  

share_click

The share_click table stores a row each time a user clicks on a trackable share link.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
page_id int(11) ID of the page that was clicked to. NO MUL NULL  
share_id int(11) ID of the share link that was clicked. NO MUL NULL  

share_action

The share_action table stores a row each time a user takes action after clicking on a trackable share link.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
share_id int(11) ID of the share link that was clicked to take this action. NO MUL NULL  
action_id int(11) ID of the core_action row created for this action. NO MUL NULL  

Delivery Tables

core_batchdelivery

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
target_id int(11)   NO MUL NULL  
page_id int(11)   NO MUL NULL  
message longtext   YES   NULL  
subject varchar(255)   YES   NULL  
from_line longtext   YES   NULL  
recent_signatures int(11)   NO   NULL  
recent_since datetime   NO   NULL  
delivered tinyint(1)   NO   NULL  
traceback longtext   YES   NULL  

core_deliveryerror

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime(6)   NO MUL NULL  
updated_at datetime(6)   NO   NULL  
page_id int(11)   NO MUL NULL  
target_id int(11)   YES MUL NULL  
user_id int(11)   YES MUL NULL  
subject longtext   NO   NULL  
body longtext   NO   NULL  
reason varchar(255)   NO   NULL  
delivery_type varchar(255)   NO   NULL  

core_petitiondeliveryfile

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
job_id int(11)   NO MUL NULL  
target_count int(11)   NO   NULL  
signatures int(11)   YES   NULL  
format varchar(255)   NO   NULL  
hostname varchar(255)   NO   NULL  
filename varchar(255)   NO UNI NULL  
status varchar(255)   NO MUL NULL  

core_petitiondeliveryfile_targets

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
petitiondeliveryfile_id int(11)   NO MUL NULL  
target_id int(11)   NO MUL NULL  

core_petitiondeliveryfilecollector

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
task_id varchar(255)   YES MUL NULL  
queued int(11)   NO   NULL  
completed int(11)   NO   NULL  
status varchar(255)   NO   NULL  
started_at datetime   YES   NULL  
completed_at datetime   YES   NULL  
job_id int(11)   NO MUL NULL  
format varchar(255)   NO   NULL  
archive varchar(255)   YES   NULL  

core_petitiondeliveryfiledownload

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
file_id int(11)   NO MUL NULL  
downloaded_by_id int(11)   NO MUL NULL  

core_petitiondeliveryjob

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
single_file tinyint(1)   NO   NULL  
cover_html longtext   NO   NULL  
print_template_id int(11)   NO MUL NULL  
header_content longtext   NO   NULL  
footer_content longtext   NO   NULL  
backgroundtask_id int(11)   YES UNI NULL  
allow_pdf_download tinyint(1)   YES      
allow_csv_download tinyint(1)   YES      
template_set_id int(11)   YES MUL NULL  
limit_delivery tinyint(1)   NO      
all_to_all tinyint(1)   YES      
include_email_in_csv tinyint(1)   NO   NULL  
date_from date   YES   NULL  
date_to date   YES   NULL  

core_petitiondeliveryjobbuilder

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
single_file tinyint(1)   NO   NULL  
cover_html longtext   NO   NULL  
print_template_id int(11)   NO MUL NULL  
header_content longtext   NO   NULL  
footer_content longtext   NO   NULL  
backgroundtask_id int(11)   YES UNI NULL  
allow_pdf_download tinyint(1)   YES      
allow_csv_download tinyint(1)   YES      
template_set_id int(11)   YES MUL NULL  
limit_delivery tinyint(1)   NO      
all_to_all tinyint(1)   YES      
include_email_in_csv tinyint(1)   NO   NULL  
date_from date   YES   NULL  
date_to date   YES   NULL  

Salesforce Integration Tables

core_salesforcefieldmap

User field mappings for your Salesforce integration.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
ak_field varchar(255) Field in ActionKit mapping to Salesforce field. NO   NULL  
sf_field varchar(255) Field in Salesforce mapping to ActionKit field. NO   NULL  
readonly tinyint(1) 1 = mapping is not editable (for email and last_name). YES   NULL  
direction varchar(255) Shows how data will flow for this pair of fields: 'all' for bi-directional, ak_to_sf or sf_to_ak. NO   NULL  

core_salesforcelog

Summary of each time the sync runs.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
last_sf_datetime datetime YES Not in use. NULL  
last_ak_user_id int(11) YES Last ActionKit user ID synced. NULL  
last_ak_action_id int(11) YES Last ActionKit action ID synced. NULL  
created_ak_users int(11) NO Not in use. NULL  
created_ak_orders int(11) NO Not in use. NULL  
created_sf_users int(11) NO Number of Salesforce contacts created. NULL  
created_sf_opportunities int(11) NO Number of Salesforce opportunities created. NULL  
created_sf_recurring int(11) NO Number of Salesforce recurring donations created. NULL  
updated_ak_users int(11) NO Not in use. NULL  
updated_sf_users int(11) NO Not in use. NULL  
failed_ak_users int(11) NO Not in use. NULL  
failed_sf_users int(11) NO Not in use. NULL  
status varchar(20) NO failed or success NULL  
error longtext YES Detailed error message. NULL  

core_salesforceorderfieldmap

Order field mappings for your Salesforce integration.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime(6)   NO MUL NULL  
updated_at datetime(6)   NO   NULL  
ak_field varchar(255) Field in ActionKit mapping to Salesforce field. NO   NULL  
ak_literal varchar(255) Description needed NO   NULL  
sf_field varchar(255) Field in Salesforce mapping to ActionKit field. NO   NULL  
sf_literal varchar(255) Description needed NO   NULL  
readonly tinyint(1) 1 = mapping is not editable (currently no fields). YES   NULL  
builtin tinyint(1) Description needed YES   NULL  
direction varchar(255) Shows how data will flow for this pair of fields: 'all' for bi-directional, ak_to_sf or sf_to_ak. NO   NULL  

core_salesforceordermap

Record of synced donations.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime(6)   NO MUL NULL  
updated_at datetime(6)   NO   NULL  
order_id int(11) ActionKit order_id. Joins to core_order. NO MUL NULL  
salesforce_id varchar(18) Unique identifier in Salesforce, displayed in the opportunity record URL. NO   NULL  
origin varchar(2) System the donation is coming from: sf or ak. NO   NULL  

core_salesforcerecurringorderfieldmap

Recurring order field mappings for your Salesforce integration.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime(6)   NO MUL NULL  
updated_at datetime(6)   NO   NULL  
ak_field varchar(255) Field in ActionKit mapping to Salesforce field. NO   NULL  
ak_literal varchar(255) Description needed NO   NULL  
sf_field varchar(255) Field in Salesforce mapping to ActionKit field. NO   NULL  
sf_literal varchar(255) Description needed NO   NULL  
readonly tinyint(1) 1 = mapping is not editable (currently no fields). YES   NULL  
builtin tinyint(1) Description needed YES   NULL  
direction varchar(255) Shows how data will flow for this pair of fields: 'all' for bi-directional, ak_to_sf or sf_to_ak. NO   NULL  

core_salesforcesyncrule

Not in use.

core_salesforcetransactionmap

Maps individual payments on recurring orders from core_transaction to the corresponding Salesforce opportunity.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime(6)   NO MUL NULL  
updated_at datetime(6)   NO   NULL  
transaction_id int(11) ActionKit transaction_id. Joins to core_transaction. NO MUL NULL  
salesforce_id varchar(18) Unique identifier in Salesforce, displayed in the opportunity record URL. NO   NULL  

core_salesforceusermap

Record of user to contact mapping and whether the record was newly created in each system.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime(6)   NO MUL NULL  
updated_at datetime(6)   NO   NULL  
user_id int(11) ActionKit user_id. Joins to core_user. NO MUL NULL  
salesforce_id varchar(18) Unique identifier in Salesforce, displayed in the user record URL. NO   NULL  
match_type varchar(255) 'primary_email' if there's a match between systems. NO   NULL  
created_ak_user tinyint(1) 1 if the sync created a new user in ActionKit. NO   NULL  
created_sf_user tinyint(1) 1 if the sync created a new contact in Salesforce. NO   NULL  
last_sync_at datetime(6) Deprecated; use updated_at instead. Last time the user/contact were synced. YES   NULL  

core_salesforceuserfailedsync

Record of failed sync attempts for specific users.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime(6)   NO MUL NULL  
updated_at datetime(6)   NO   NULL  
user_id int(11) ActionKit user_id. Joins to core_user. NO MUL NULL  
reason longtext Reason the sync failed. NO   NULL  

Salesforce historical tables

Each historical table stores previous versions of an object. In addition to the object's regular fields, there are additional fields available on each historical table:

Field Type Description Null Key Default Extra
history_id int(11) Unique identifier of the mapping's history record. Not to be confused with id, the unique identifier of the mapping. NO PRI NULL auto_increment
history_date datetime Date/time this mapping was updated, and this history record was saved as a result NO   NULL  
history_user integer Which staff user made this change. NO   NULL  
history_change_reason varchar(100) For internal use only. NO   NULL  

core_historicalsalesforcefieldmap

This stored previous version of user field mappings. Joins to core_salesforcefieldmap.

core_historicalsalesforceorderfieldmap

This stored previous version of order field mappings. Joins to core_salesforceorderfieldmap.

core_historicalsalesforcerecurringorderfieldmap

This stored previous version of recurring order field mappings. Joins to core_salesforcerecurringorderfieldmap.

Config/Admin Tables

core_admineditors

Default settings for text editors in your instance.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
visual_default varchar(16) Mode the editor will start in for fields that support the WYSIWYG: 'on' for visual, 'off' for plain and 'code' for code. NO   NULL  
template_default varchar(16) Mode the editor will start in for fields that don't support the WYSIWYG: 'off' for plain and 'code' for code. NO   NULL  
turn_off_visual tinyint(1) 1 turns off the visual editor everywhere. NO   NULL  

core_clientsetting

CONFIG settings.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime(6)   NO MUL NULL  
updated_at datetime(6)   NO   NULL  
entity varchar(255) Category of client settings (e.g. 'Mailer Targeting Defaults'.) NO MUL NULL  
attribute varchar(255) Specific setting (e.g. 'Mailing List'). NO   NULL  
value longtext Value for the setting. Blank if not set. NO   NULL  

core_donationconfiguration

Donation processing settings for your instance. Set on CONFIG screen.

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
duplicate_window int(11) Duration in minutes in which to search for duplicate donations. Set on CONFIG screen. YES   NULL  
send_ip_address tinyint(1) Braintree only. 1=send IP address to 'customer_ip' custom field you have created in Braintree for this information. NO      

core_notice

Announcements created by Staff Users and displayed for all staff in the admin UI.

Field Type Description Null Key Default Extra
id int(11) unique identifier NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
title longtext Announcement title, displayed in bold. NO   NULL  
message longtext Additional content, displayed after title. NO   NULL  
type varchar(10) Type of announcement (danger, info, release, warning). NO   NULL  
url longtext URL if you include one in the announcement. NO   NULL  
tag varchar(255) Description needed NO   NULL  
expiration datetime Not in use. YES   NULL  
user_id int(11) Not in use. YES MUL NULL  
creator_id int(11) The user_id of the staff member who added or edited the announcement. Announcements from WAWD have no creator. NO PRI NULL auto_increment

core_noticeclosed

Shows announcements that have been closed manually by a staff user.

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO MUL NULL  
updated_at datetime   NO   NULL  
notice_id int(11) Joins to core_notice. NO MUL NULL  
user_id int(11) The ID of the staff user who closed the announcement. YES MUL NULL  

core_mailingsconfig

Settings for your instance for auto-excludes. Set on CONFIG screen.

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
use_auto_excludes tinyint(1) 1=enable auto-excludes for your instance. NO   NULL  
send_date_default varchar(255) Default auto-exclude date (none, today or tomorrow). NO   NULL  

core_supportcontact

Description needed

Field Type Description Null Key Default Extra
id int(11) Unique identifier. NO PRI NULL auto_increment
created_at datetime   NO   NULL  
updated_at datetime   NO   NULL  
hidden tinyint(1)   NO   NULL  
contact_id int(11)   NO MUL NULL  

Internal use only Tables

The following is the list of internal tables. These tables are not for use by client.

  • auth_* tables
  • axes_accessattempt
  • cache
  • celery_*
  • core_activityleveltargetingoption
  • core_adminprefs
  • core_adminlocation
  • core_adminnoticelog
  • core_blocked_email
  • core_bounce_state
  • core_donationattemptlog
  • core_facebookapp
  • core_faxaccount
  • core_googleanalytics
  • core_hostingplatform
  • core_jobcron
  • core_joberror
  • core_jobsignal
  • core_job_state
  • core_jobstatuslog
  • core_pagefollowup_pushes
  • core_previous_page_tags
  • core_redirectpage
  • core_s3connection
  • core_salesforcesyncrule
  • core_savedquerylog
  • core_session
  • core_subscriptionhistory_synced_to_sendgrid
  • core_targetcontact
  • core_tellafriendaction
  • core_todaytimezone
  • core_timezonepreference
  • core_transactionalmailing_tags
  • core_unsub_email
  • core_unsub_email_state
  • core_usergeofield
  • core_usermailing_archive_model
  • core_usermailing_archive_state
  • core_useroriginal
  • core_geocodequeue
  • django_* tables
  • lab_metric
  • lab_pagetype
  • lab_test_custom_fields
  • lab_test_page_types
  • mergefile_1
  • renamed_core_transactions_core_payment
  • reports_cachedqueryresult
  • spam_checkeractionstate
  • tastypie_* tables