1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
3 <base>CRM/Activity
</base>
4 <class>Activity
</class>
5 <name>civicrm_activity
</name>
6 <description>Past or future actions concerning one or more contacts.
</description>
7 <comment>Other Activity details stored here include contact, location, details.
</comment>
11 <labelField>subject
</labelField>
13 <add>civicrm/activity?reset=
1&action=add
&context=standalone
</add>
14 <view>civicrm/activity?reset=
1&action=view
&id=[id]
</view>
15 <update>civicrm/activity/add?reset=
1&action=update
&id=[id]
</update>
16 <delete>civicrm/activity?reset=
1&action=delete
&id=[id]
</delete>
20 <uniqueName>activity_id
</uniqueName>
21 <title>Activity ID
</title>
23 <type>int unsigned
</type>
24 <required>true
</required>
25 <comment>Unique Other Activity ID
</comment>
33 <autoincrement>true
</autoincrement>
36 <name>source_record_id
</name>
37 <type>int unsigned
</type>
38 <title>Source Record
</title>
39 <comment>Artificial FK to original transaction (e.g. contribution) IF it is not an Activity. Table can be figured out through activity_type_id, and further through component registry.
</comment>
40 <readonly>true
</readonly>
44 <name>UI_source_record_id
</name>
45 <fieldName>source_record_id
</fieldName>
49 <name>activity_type_id
</name>
50 <title>Activity Type ID
</title>
52 <type>int unsigned
</type>
53 <required>true
</required>
56 <headerPattern>/(activity.)?type(.id$)/i
</headerPattern>
57 <comment>FK to civicrm_option_value.id, that has to be valid, registered activity type.
</comment>
60 <optionGroupName>activity_type
</optionGroupName>
64 <label>Activity Type
</label>
68 <name>UI_activity_type_id
</name>
69 <fieldName>activity_type_id
</fieldName>
74 <uniqueName>activity_subject
</uniqueName>
76 <title>Subject
</title>
78 <comment>The subject/purpose/short description of the activity.
</comment>
80 <headerPattern>/(activity.)?subject/i
</headerPattern>
88 <name>activity_date_time
</name>
90 <required>false
</required>
92 <default>CURRENT_TIMESTAMP
</default>
93 <title>Activity Date
</title>
95 <headerPattern>/(activity.)?date(.time$)?/i
</headerPattern>
96 <comment>Date and time this activity is scheduled to occur. Formerly named scheduled_date_time.
</comment>
98 <type>Select Date
</type>
99 <formatType>activityDateTime
</formatType>
104 <name>index_activity_date_time
</name>
105 <fieldName>activity_date_time
</fieldName>
109 <name>duration
</name>
110 <uniqueName>activity_duration
</uniqueName>
111 <title>Duration
</title>
112 <import>true
</import>
113 <type>int unsigned
</type>
114 <headerPattern>/(activity.)?duration(s)?$/i
</headerPattern>
115 <comment>Planned or actual duration of activity expressed in minutes. Conglomerate of former duration_hours and duration_minutes.
</comment>
122 <name>location
</name>
123 <uniqueName>activity_location
</uniqueName>
124 <title>Location
</title>
125 <import>true
</import>
128 <headerPattern>/(activity.)?location$/i
</headerPattern>
129 <comment>Location of the activity (optional, open text).
</comment>
136 <name>phone_id
</name>
137 <type>int unsigned
</type>
138 <title>Phone ID (called)
</title>
139 <comment>Phone ID of the number called (optional - used if an existing phone number is selected).
</comment>
142 <type>EntityRef
</type>
143 <label>Phone (called)
</label>
147 <name>phone_id
</name>
148 <table>civicrm_phone
</table>
151 <onDelete>SET NULL
</onDelete>
154 <name>phone_number
</name>
155 <title>Phone (called) Number
</title>
158 <comment>Phone number in case the number does not exist in the civicrm_phone table.
</comment>
166 <uniqueName>activity_details
</uniqueName>
167 <title>Details
</title>
168 <import>true
</import>
169 <type>longtext
</type>
170 <headerPattern>/(activity.)?detail(s)?$/i
</headerPattern>
171 <comment>Details about the activity (agenda, notes, etc).
</comment>
173 <type>RichTextEditor
</type>
180 <name>status_id
</name>
181 <uniqueName>activity_status_id
</uniqueName>
182 <title>Activity Status
</title>
183 <import>true
</import>
184 <export>true
</export>
185 <headerPattern>/(activity.)?status(.label$)?/i
</headerPattern>
186 <type>int unsigned
</type>
187 <comment>ID of the status this activity is currently in. Foreign key to civicrm_option_value.
</comment>
190 <optionGroupName>activity_status
</optionGroupName>
197 <name>index_status_id
</name>
198 <fieldName>status_id
</fieldName>
202 <name>priority_id
</name>
203 <type>int unsigned
</type>
204 <title>Priority
</title>
205 <export>true
</export>
206 <import>true
</import>
207 <comment>ID of the priority given to this activity. Foreign key to civicrm_option_value.
</comment>
210 <optionGroupName>priority
</optionGroupName>
217 <name>parent_id
</name>
218 <title>Parent Activity ID
</title>
219 <type>int unsigned
</type>
220 <comment>Parent meeting ID (if this is a follow-up item). This is not currently implemented
</comment>
221 <readonly>true
</readonly>
223 <label>Parent Activity
</label>
228 <name>parent_id
</name>
229 <table>civicrm_activity
</table>
232 <onDelete>CASCADE
</onDelete>
237 <uniqueName>activity_is_test
</uniqueName>
240 <import>true
</import>
241 <headerPattern>/(is.)?test(.activity)?/i
</headerPattern>
244 <type>CheckBox
</type>
248 <name>medium_id
</name>
249 <uniqueName>activity_medium_id
</uniqueName>
250 <title>Activity Medium
</title>
251 <type>int unsigned
</type>
252 <default>NULL
</default>
253 <comment>Activity Medium, Implicit FK to civicrm_option_value where option_group = encounter_medium.
</comment>
255 <optionGroupName>encounter_medium
</optionGroupName>
263 <name>index_medium_id
</name>
264 <fieldName>medium_id
</fieldName>
276 <name>relationship_id
</name>
277 <title>Relationship ID
</title>
278 <type>int unsigned
</type>
279 <default>NULL
</default>
280 <comment>FK to Relationship ID
</comment>
282 <label>Relationship
</label>
287 <name>relationship_id
</name>
288 <table>civicrm_relationship
</table>
290 <onDelete>SET NULL
</onDelete>
293 <name>is_current_revision
</name>
294 <title>Is this activity a current revision in versioning chain?
</title>
297 <import>true
</import>
298 <headerPattern>/(is.)?(current.)?(revision|version(ing)?)/i
</headerPattern>
302 <name>index_is_current_revision
</name>
303 <fieldName>is_current_revision
</fieldName>
307 <name>original_id
</name>
308 <type>int unsigned
</type>
309 <title>Original Activity ID
</title>
310 <comment>Activity ID of the first activity record in versioning chain.
</comment>
311 <readonly>true
</readonly>
313 <label>Original Activity
</label>
318 <name>original_id
</name>
319 <table>civicrm_activity
</table>
322 <onDelete>CASCADE
</onDelete>
326 <uniqueName>activity_result
</uniqueName>
328 <title>Result
</title>
330 <comment>Currently being used to store result id for survey activity, FK to option value.
</comment>
334 <name>is_deleted
</name>
335 <uniqueName>activity_is_deleted
</uniqueName>
336 <title>Activity is in the Trash
</title>
339 <import>true
</import>
340 <headerPattern>/(activity.)?(trash|deleted)/i
</headerPattern>
343 <type>CheckBox
</type>
347 <name>index_is_deleted
</name>
348 <fieldName>is_deleted
</fieldName>
352 <name>campaign_id
</name>
353 <component>CiviCampaign
</component>
354 <uniqueName>activity_campaign_id
</uniqueName>
355 <type>int unsigned
</type>
356 <title>Campaign ID
</title>
357 <import>true
</import>
358 <comment>The campaign for which this activity has been triggered.
</comment>
361 <type>EntityRef
</type>
362 <label>Campaign
</label>
365 <table>civicrm_campaign
</table>
366 <keyColumn>id
</keyColumn>
367 <labelColumn>title
</labelColumn>
368 <prefetch>FALSE
</prefetch>
372 <name>campaign_id
</name>
373 <table>civicrm_campaign
</table>
375 <onDelete>SET NULL
</onDelete>
378 <name>engagement_level
</name>
379 <uniqueName>activity_engagement_level
</uniqueName>
380 <type>int unsigned
</type>
381 <title>Engagement Index
</title>
382 <import>true
</import>
383 <comment>Assign a specific level of engagement to this activity. Used for tracking constituents in ladder of engagement.
</comment>
385 <optionGroupName>engagement_index
</optionGroupName>
400 <title>Is Starred
</title>
403 <import>true
</import>
404 <comment>Activity marked as favorite.
</comment>
405 <headerPattern>/(activity.)?(star|favorite)/i
</headerPattern>
408 <type>Checkbox
</type>
412 <name>created_date
</name>
413 <uniqueName>activity_created_date
</uniqueName>
414 <type>timestamp
</type>
415 <comment>When was the activity was created.
</comment>
416 <required>false
</required>
417 <export>true
</export>
418 <default>CURRENT_TIMESTAMP
</default>
420 <label>Created Date
</label>
425 <name>modified_date
</name>
426 <uniqueName>activity_modified_date
</uniqueName>
427 <type>timestamp
</type>
428 <comment>When was the activity (or closely related entity) was created or modified or deleted.
</comment>
429 <required>false
</required>
430 <export>true
</export>
431 <default>CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
</default>
433 <label>Modified Date
</label>
435 <readonly>true
</readonly>