1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
3 <base>CRM/Activity
</base>
4 <class>Activity
</class>
5 <name>civicrm_activity
</name>
6 <comment>Other Activity details stored here include contact, location, details.
</comment>
11 <uniqueName>activity_id
</uniqueName>
12 <title>Activity ID
</title>
14 <type>int unsigned
</type>
15 <required>true
</required>
16 <comment>Unique Other Activity ID
</comment>
22 <autoincrement>true
</autoincrement>
25 <name>source_contact_id
</name>
26 <type>int unsigned
</type>
27 <title>Source Contact
</title>
29 <headerPattern>/(activity.)?source(.contact(.id)?)?/i
</headerPattern>
30 <comment>Contact ID of the person scheduling or logging this Activity. Usually the authenticated user.
</comment>
35 <name>source_contact_id
</name>
36 <table>civicrm_contact
</table>
40 <onDelete>SET NULL
</onDelete>
43 <name>UI_source_contact_id
</name>
44 <fieldName>source_contact_id
</fieldName>
50 <name>source_record_id
</name>
51 <type>int unsigned
</type>
52 <title>Source Record
</title>
53 <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>
57 <name>UI_source_record_id
</name>
58 <fieldName>source_record_id
</fieldName>
62 <name>activity_type_id
</name>
63 <title>Activity Type ID
</title>
65 <type>int unsigned
</type>
66 <required>true
</required>
69 <headerPattern>/(activity.)?type(.id$)/i
</headerPattern>
70 <comment>FK to civicrm_option_value.id, that has to be valid, registered activity type.
</comment>
73 <optionGroupName>activity_type
</optionGroupName>
80 <name>UI_activity_type_id
</name>
81 <fieldName>activity_type_id
</fieldName>
86 <name>target_entity_table
</name>
89 <required>true
</required>
90 <comment>Name of table where item being referenced is stored.
</comment>
96 <name>target_entity_id
</name>
97 <type>int unsigned
</type>
98 <required>true
</required>
99 <comment>Foreign key to the referenced item.
</comment>
106 <uniqueName>activity_subject
</uniqueName>
108 <title>Subject
</title>
110 <comment>The subject/purpose/short description of the activity.
</comment>
111 <import>true
</import>
112 <headerPattern>/(activity.)?subject/i
</headerPattern>
121 <name>scheduled_date
</name>
122 <type>datetime
</type>
123 <comment>Date and time meeting is scheduled to occur.
</comment>
129 <name>activity_date_time
</name>
130 <import>true
</import>
131 <title>Activity Date
</title>
132 <type>datetime
</type>
133 <headerPattern>/(activity.)?date(.time$)?/i
</headerPattern>
134 <comment>Date and time this activity is scheduled to occur. Formerly named scheduled_date_time.
</comment>
136 <type>Select Date
</type>
141 <name>due_date_time
</name>
142 <type>datetime
</type>
143 <comment>Date and time this activity is due.
</comment>
148 <name>duration_hours
</name>
149 <type>int unsigned
</type>
150 <comment>Planned or actual duration of meeting - hours.
</comment>
156 <name>duration_minutes
</name>
157 <type>int unsigned
</type>
158 <comment>Planned or actual duration of meeting - minutes.
</comment>
164 <name>duration
</name>
165 <uniqueName>activity_duration
</uniqueName>
166 <title>Duration
</title>
167 <import>true
</import>
168 <type>int unsigned
</type>
169 <headerPattern>/(activity.)?duration(s)?$/i
</headerPattern>
170 <comment>Planned or actual duration of activity expressed in minutes. Conglomerate of former duration_hours and duration_minutes.
</comment>
178 <name>location
</name>
179 <uniqueName>activity_location
</uniqueName>
180 <title>Location
</title>
181 <import>true
</import>
184 <headerPattern>/(activity.)?location$/i
</headerPattern>
185 <comment>Location of the activity (optional, open text).
</comment>
193 <name>phone_id
</name>
194 <type>int unsigned
</type>
195 <title>Phone (called) ID
</title>
196 <comment>Phone ID of the number called (optional - used if an existing phone number is selected).
</comment>
199 <type>EntityRef
</type>
203 <name>phone_id
</name>
204 <table>civicrm_phone
</table>
207 <onDelete>SET NULL
</onDelete>
211 <name>phone_number
</name>
212 <title>Phone (called) Number
</title>
215 <comment>Phone number in case the number does not exist in the civicrm_phone table.
</comment>
224 <uniqueName>activity_details
</uniqueName>
225 <title>Details
</title>
226 <import>true
</import>
227 <type>longtext
</type>
228 <headerPattern>/(activity.)?detail(s)?$/i
</headerPattern>
229 <comment>Details about the activity (agenda, notes, etc).
</comment>
231 <type>RichTextEditor
</type>
241 <title>Status
</title>
242 <values>Scheduled, Completed
</values>
243 <comment>What is the status of this meeting? Completed meeting status results in activity history entry.
</comment>
249 <name>status_id
</name>
250 <uniqueName>activity_status_id
</uniqueName>
251 <title>Activity Status
</title>
252 <import>true
</import>
253 <export>false
</export>
254 <headerPattern>/(activity.)?status(.label$)?/i
</headerPattern>
255 <type>int unsigned
</type>
256 <comment>ID of the status this activity is currently in. Foreign key to civicrm_option_value.
</comment>
259 <optionGroupName>activity_status
</optionGroupName>
266 <name>priority_id
</name>
267 <type>int unsigned
</type>
268 <title>Priority
</title>
269 <comment>ID of the priority given to this activity. Foreign key to civicrm_option_value.
</comment>
272 <optionGroupName>priority
</optionGroupName>
279 <name>parent_id
</name>
280 <title>Parent Activity Id
</title>
281 <type>int unsigned
</type>
282 <comment>Parent meeting ID (if this is a follow-up item). This is not currently implemented
</comment>
286 <name>parent_id
</name>
287 <table>civicrm_activity
</table>
290 <onDelete>CASCADE
</onDelete>
296 <uniqueName>activity_is_test
</uniqueName>
299 <import>true
</import>
300 <headerPattern>/(is.)?test(.activity)?/i
</headerPattern>
307 <name>medium_id
</name>
308 <uniqueName>activity_medium_id
</uniqueName>
309 <title>Activity Medium
</title>
310 <type>int unsigned
</type>
311 <default>NULL
</default>
312 <comment>Activity Medium, Implicit FK to civicrm_option_value where option_group = encounter_medium.
</comment>
314 <optionGroupName>encounter_medium
</optionGroupName>
322 <name>index_medium_id
</name>
323 <fieldName>medium_id
</fieldName>
334 <name>relationship_id
</name>
335 <title>Relationship Id
</title>
336 <type>int unsigned
</type>
337 <default>NULL
</default>
338 <comment>FK to Relationship ID
</comment>
342 <name>relationship_id
</name>
343 <table>civicrm_relationship
</table>
345 <onDelete>SET NULL
</onDelete>
348 <name>is_current_revision
</name>
349 <title>Is this activity a current revision in versioning chain?
</title>
352 <import>true
</import>
353 <headerPattern>/(is.)?(current.)?(revision|version(ing)?)/i
</headerPattern>
356 <type>CheckBox
</type>
360 <name>index_is_current_revision
</name>
361 <fieldName>is_current_revision
</fieldName>
365 <name>original_id
</name>
366 <type>int unsigned
</type>
367 <title>Original Activity ID
</title>
368 <comment>Activity ID of the first activity record in versioning chain.
</comment>
372 <name>original_id
</name>
373 <table>civicrm_activity
</table>
376 <onDelete>CASCADE
</onDelete>
379 <name>UI_original_id
</name>
380 <fieldName>original_id
</fieldName>
386 <uniqueName>activity_result
</uniqueName>
388 <title>Result
</title>
390 <comment>Currently being used to store result id for survey activity, FK to option value.
</comment>
397 <name>is_deleted
</name>
398 <uniqueName>activity_is_deleted
</uniqueName>
399 <title>Activity is in the Trash
</title>
402 <import>true
</import>
403 <headerPattern>/(activity.)?(trash|deleted)/i
</headerPattern>
410 <name>index_is_deleted
</name>
411 <fieldName>is_deleted
</fieldName>
415 <name>campaign_id
</name>
416 <uniqueName>activity_campaign_id
</uniqueName>
417 <type>int unsigned
</type>
418 <title>Campaign
</title>
419 <import>true
</import>
420 <comment>The campaign for which this activity has been triggered.
</comment>
422 <table>civicrm_campaign
</table>
423 <keyColumn>id
</keyColumn>
424 <labelColumn>title
</labelColumn>
428 <type>CheckBox
</type>
432 <name>campaign_id
</name>
433 <table>civicrm_campaign
</table>
435 <onDelete>SET NULL
</onDelete>
438 <name>engagement_level
</name>
439 <uniqueName>activity_engagement_level
</uniqueName>
440 <type>int unsigned
</type>
441 <title>Engagement Index
</title>
442 <import>true
</import>
443 <comment>Assign a specific level of engagement to this activity. Used for tracking constituents in ladder of engagement.
</comment>
445 <optionGroupName>engagement_index
</optionGroupName>