[civicrm-core.git] / xml / schema / Campaign / Survey.xml

<?xml version="1.0" encoding="iso-8859-1" ?>
<table>
  <base>CRM/Campaign</base>
  <class>Survey</class>
  <name>civicrm_survey</name>
  <comment>Campaign Survey Details.</comment>
  <add>3.2</add>
  <icon>fa-clipboard</icon>
  <labelField>title</labelField>
  <component>CiviCampaign</component>
  <field>
    <name>id</name>
    <title>Survey ID</title>
    <type>int unsigned</type>
    <required>true</required>
    <comment>Survey id.</comment>
    <html>
      <type>Number</type>
    </html>
    <add>3.3</add>
  </field>
  <primaryKey>
    <name>id</name>
    <autoincrement>true</autoincrement>
  </primaryKey>

  <field>
      <name>title</name>
      <title>Survey Title</title>
      <type>varchar</type>
      <length>255</length>
      <required>true</required>
      <localizable>true</localizable>
      <comment>Title of the Survey.</comment>
      <import>true</import>
      <add>3.3</add>
  </field>

  <field>
    <name>campaign_id</name>
    <title>Campaign ID</title>
    <type>int unsigned</type>
    <default>NULL</default>
    <comment>Foreign key to the Campaign.</comment>
    <html>
      <type>EntityRef</type>
      <label>Campaign</label>
    </html>
    <add>3.3</add>
    <pseudoconstant>
      <table>civicrm_campaign</table>
      <keyColumn>id</keyColumn>
      <labelColumn>title</labelColumn>
      <prefetch>FALSE</prefetch>
    </pseudoconstant>
  </field>
  <foreignKey>
    <name>campaign_id</name>
    <table>civicrm_campaign</table>
    <key>id</key>
    <add>3.3</add>
    <onDelete>SET NULL</onDelete>
  </foreignKey>

  <field>
    <name>activity_type_id</name>
    <title>Activity Type</title>
    <type>int unsigned</type>
    <default>NULL</default>
    <comment>Implicit FK to civicrm_option_value where option_group = activity_type</comment>
    <import>true</import>
    <add>3.3</add>
    <pseudoconstant>
      <optionGroupName>activity_type</optionGroupName>
    </pseudoconstant>
    <html>
      <type>Select</type>
    </html>
  </field>
  <index>
    <name>UI_activity_type_id</name>
    <fieldName>activity_type_id</fieldName>
    <add>3.3</add>
  </index>

  <field>
    <name>recontact_interval</name>
    <title>Follow up Interval</title>
    <type>text</type>
    <comment>Recontact intervals for each status.</comment>
    <html>
      <type>TextArea</type>
      <rows>20</rows>
      <cols>80</cols>
    </html>
    <add>3.3</add>
  </field>

  <field>
    <name>instructions</name>
    <title>Instructions</title>
    <type>text</type>
    <localizable>true</localizable>
    <comment>Script instructions for volunteers to use for the survey.</comment>
    <html>
      <type>TextArea</type>
      <rows>20</rows>
      <cols>80</cols>
    </html>
    <add>3.3</add>
  </field>

  <field>
    <name>release_frequency</name>
    <title>Survey Hold Duration</title>
    <type>int unsigned</type>
    <default>NULL</default>
    <comment>Number of days for recurrence of release.</comment>
    <add>3.3</add>
  </field>

  <field>
    <name>max_number_of_contacts</name>
    <title>Maximum number of contacts</title>
    <type>int unsigned</type>
    <default>NULL</default>
    <comment>Maximum number of contacts to allow for survey.</comment>
    <add>3.3</add>
  </field>

  <field>
    <name>default_number_of_contacts</name>
    <title>Default number of contacts</title>
    <type>int unsigned</type>
    <default>NULL</default>
    <comment>Default number of contacts to allow for survey.</comment>
    <add>3.3</add>
  </field>

  <field>
    <name>is_active</name>
    <title>Survey Is Active</title>
    <type>boolean</type>
    <default>1</default>
    <comment>Is this survey enabled or disabled/cancelled?</comment>
    <add>3.3</add>
  </field>

  <field>
    <name>is_default</name>
    <title>Is Default Survey</title>
    <type>boolean</type>
    <default>0</default>
    <comment>Is this default survey?</comment>
    <add>3.3</add>
  </field>

  <field>
    <name>created_id</name>
    <title>Created By Contact ID</title>
    <type>int unsigned</type>
    <comment>FK to civicrm_contact, who created this Survey.</comment>
    <html>
      <label>Created By</label>
    </html>
    <add>3.3</add>
  </field>
  <foreignKey>
    <name>created_id</name>
    <table>civicrm_contact</table>
    <key>id</key>
    <add>3.3</add>
    <onDelete>SET NULL</onDelete>
  </foreignKey>

  <field>
    <name>created_date</name>
    <type>datetime</type>
    <title>Campaign Created Date</title>
    <comment>Date and time that Survey was created.</comment>
    <add>3.3</add>
  </field>

  <field>
    <name>last_modified_id</name>
    <title>Modified By Contact ID</title>
    <type>int unsigned</type>
    <comment>FK to civicrm_contact, who recently edited this Survey.</comment>
    <html>
      <label>Modified By</label>
    </html>
    <add>3.3</add>
  </field>
  <foreignKey>
    <name>last_modified_id</name>
    <table>civicrm_contact</table>
    <key>id</key>
    <add>3.3</add>
    <onDelete>SET NULL</onDelete>
  </foreignKey>

  <field>
    <name>last_modified_date</name>
    <title>Survey Modified On</title>
    <type>datetime</type>
    <comment>Date and time that Survey was edited last time.</comment>
    <add>3.3</add>
  </field>

  <field>
    <name>result_id</name>
    <title>Survey Result</title>
    <type>int unsigned</type>
    <default>NULL</default>
    <comment>Used to store option group id.</comment>
    <add>3.3</add>
    <pseudoconstant>
      <table>civicrm_option_group</table>
      <keyColumn>id</keyColumn>
      <labelColumn>title</labelColumn>
      <nameColumn>name</nameColumn>
      <condition>name LIKE "civicrm_survey_%"</condition>
    </pseudoconstant>
  </field>
  <field>
    <name>bypass_confirm</name>
    <title>No Email Verification</title>
    <type>boolean</type>
    <default>0</default>
    <comment>Bypass the email verification.</comment>
    <add>4.2</add>
  </field>
  <field>
    <name>thankyou_title</name>
    <title>Thank-you Title</title>
    <type>varchar</type>
    <length>255</length>
    <localizable>true</localizable>
    <comment>Title for Thank-you page (header title tag, and display at the top of the page).</comment>
    <add>4.2</add>
  </field>
  <field>
    <name>thankyou_text</name>
    <title>Thank-you Text</title>
    <type>text</type>
    <html>
      <type>TextArea</type>
      <rows>8</rows>
      <cols>60</cols>
    </html>
    <localizable>true</localizable>
    <comment>text and html allowed. displayed above result on success page</comment>
    <add>4.2</add>
  </field>
  <field>
    <name>is_share</name>
    <title>Is shared through social media</title>
    <type>boolean</type>
    <default>1</default>
    <comment>Can people share the petition through social media?</comment>
    <add>4.4</add>
  </field>
</table>
Commit	Line	Data
6a488035 TO	1	<?xml version="1.0" encoding="iso-8859-1" ?>
	2	<table>
	3	<base>CRM/Campaign</base>
	4	<class>Survey</class>
	5	<name>civicrm_survey</name>
	6	<comment>Campaign Survey Details.</comment>
	7	<add>3.2</add>
449c4e6b	8	<icon>fa-clipboard</icon>
8ab43c93	9	<labelField>title</labelField>
d31fb4e3	10	<component>CiviCampaign</component>
6a488035 TO	11	<field>
6a488035 TO	12	<name>id</name>
bf76be71	13	<title>Survey ID</title>
6a488035 TO	14	<type>int unsigned</type>
	15	<required>true</required>
	16	<comment>Survey id.</comment>
0481e12c A	17	<html>
	18	<type>Number</type>
	19	</html>
6a488035 TO	20	<add>3.3</add>
	21	</field>
	22	<primaryKey>
	23	<name>id</name>
	24	<autoincrement>true</autoincrement>
	25	</primaryKey>
	26
	27	<field>
	28	<name>title</name>
f813f78e	29	<title>Survey Title</title>
6a488035 TO	30	<type>varchar</type>
	31	<length>255</length>
	32	<required>true</required>
434cdb95	33	<localizable>true</localizable>
6a488035 TO	34	<comment>Title of the Survey.</comment>
	35	<import>true</import>
	36	<add>3.3</add>
	37	</field>
	38
	39	<field>
	40	<name>campaign_id</name>
047c5009	41	<title>Campaign ID</title>
6a488035	42	<type>int unsigned</type>
f813f78e	43	<default>NULL</default>
6a488035	44	<comment>Foreign key to the Campaign.</comment>
57e94608	45	<html>
8813f972	46	<type>EntityRef</type>
047c5009	47	<label>Campaign</label>
57e94608	48	</html>
6a488035	49	<add>3.3</add>
25ad69f2 CW	50	<pseudoconstant>
	51	<table>civicrm_campaign</table>
	52	<keyColumn>id</keyColumn>
	53	<labelColumn>title</labelColumn>
	54	<prefetch>FALSE</prefetch>
	55	</pseudoconstant>
6a488035 TO	56	</field>
	57	<foreignKey>
	58	<name>campaign_id</name>
	59	<table>civicrm_campaign</table>
	60	<key>id</key>
	61	<add>3.3</add>
	62	<onDelete>SET NULL</onDelete>
	63	</foreignKey>
f813f78e	64
6a488035 TO	65	<field>
6a488035 TO	66	<name>activity_type_id</name>
a42c9322	67	<title>Activity Type</title>
f813f78e	68	<type>int unsigned</type>
f813f78e	69	<default>NULL</default>
3c7d2158	70	<comment>Implicit FK to civicrm_option_value where option_group = activity_type</comment>
6a488035	71	<import>true</import>
f813f78e	72	<add>3.3</add>
4080e473 AS	73	<pseudoconstant>
	74	<optionGroupName>activity_type</optionGroupName>
	75	</pseudoconstant>
614d72ec	76	<html>
e0991796	77	<type>Select</type>
614d72ec	78	</html>
6a488035 TO	79	</field>
	80	<index>
	81	<name>UI_activity_type_id</name>
	82	<fieldName>activity_type_id</fieldName>
	83	<add>3.3</add>
	84	</index>
	85
	86	<field>
	87	<name>recontact_interval</name>
bf76be71	88	<title>Follow up Interval</title>
6a488035 TO	89	<type>text</type>
6a488035 TO	90	<comment>Recontact intervals for each status.</comment>
7deea513	91	<html>
7deea513	92	<type>TextArea</type>
817807ab	93	<rows>20</rows>
817807ab	94	<cols>80</cols>
7deea513	95	</html>
6a488035 TO	96	<add>3.3</add>
6a488035 TO	97	</field>
f813f78e	98
6a488035 TO	99	<field>
6a488035 TO	100	<name>instructions</name>
bf76be71	101	<title>Instructions</title>
6a488035	102	<type>text</type>
434cdb95	103	<localizable>true</localizable>
6a488035	104	<comment>Script instructions for volunteers to use for the survey.</comment>
7deea513	105	<html>
7deea513	106	<type>TextArea</type>
817807ab	107	<rows>20</rows>
817807ab	108	<cols>80</cols>
7deea513	109	</html>
6a488035 TO	110	<add>3.3</add>
	111	</field>
	112
	113	<field>
	114	<name>release_frequency</name>
bf76be71	115	<title>Survey Hold Duration</title>
6a488035 TO	116	<type>int unsigned</type>
	117	<default>NULL</default>
	118	<comment>Number of days for recurrence of release.</comment>
	119	<add>3.3</add>
	120	</field>
f813f78e	121
f813f78e	122	<field>
6a488035 TO	123	<name>max_number_of_contacts</name>
6a488035 TO	124	<title>Maximum number of contacts</title>
f813f78e	125	<type>int unsigned</type>
6a488035	126	<default>NULL</default>
f813f78e	127	<comment>Maximum number of contacts to allow for survey.</comment>
6a488035 TO	128	<add>3.3</add>
6a488035 TO	129	</field>
f813f78e	130
f813f78e	131	<field>
6a488035 TO	132	<name>default_number_of_contacts</name>
6a488035 TO	133	<title>Default number of contacts</title>
f813f78e	134	<type>int unsigned</type>
6a488035	135	<default>NULL</default>
f813f78e	136	<comment>Default number of contacts to allow for survey.</comment>
6a488035 TO	137	<add>3.3</add>
6a488035 TO	138	</field>
f813f78e	139
	140	<field>
	141	<name>is_active</name>
bf76be71	142	<title>Survey Is Active</title>
6a488035	143	<type>boolean</type>
f813f78e	144	<default>1</default>
	145	<comment>Is this survey enabled or disabled/cancelled?</comment>
	146	<add>3.3</add>
6a488035	147	</field>
f813f78e	148
	149	<field>
	150	<name>is_default</name>
bf76be71	151	<title>Is Default Survey</title>
6a488035	152	<type>boolean</type>
f813f78e	153	<default>0</default>
	154	<comment>Is this default survey?</comment>
	155	<add>3.3</add>
	156	</field>
	157
6a488035 TO	158	<field>
6a488035 TO	159	<name>created_id</name>
047c5009	160	<title>Created By Contact ID</title>
6a488035 TO	161	<type>int unsigned</type>
6a488035 TO	162	<comment>FK to civicrm_contact, who created this Survey.</comment>
57e94608	163	<html>
047c5009	164	<label>Created By</label>
57e94608	165	</html>
6a488035 TO	166	<add>3.3</add>
	167	</field>
	168	<foreignKey>
bf76be71 EM	169	<name>created_id</name>
	170	<table>civicrm_contact</table>
	171	<key>id</key>
	172	<add>3.3</add>
	173	<onDelete>SET NULL</onDelete>
6a488035	174	</foreignKey>
f813f78e	175
6a488035 TO	176	<field>
	177	<name>created_date</name>
	178	<type>datetime</type>
	179	<title>Campaign Created Date</title>
	180	<comment>Date and time that Survey was created.</comment>
	181	<add>3.3</add>
	182	</field>
f813f78e	183
6a488035 TO	184	<field>
6a488035 TO	185	<name>last_modified_id</name>
047c5009	186	<title>Modified By Contact ID</title>
6a488035 TO	187	<type>int unsigned</type>
6a488035 TO	188	<comment>FK to civicrm_contact, who recently edited this Survey.</comment>
57e94608	189	<html>
047c5009	190	<label>Modified By</label>
57e94608	191	</html>
6a488035 TO	192	<add>3.3</add>
	193	</field>
	194	<foreignKey>
	195	<name>last_modified_id</name>
	196	<table>civicrm_contact</table>
	197	<key>id</key>
	198	<add>3.3</add>
	199	<onDelete>SET NULL</onDelete>
	200	</foreignKey>
f813f78e	201
6a488035 TO	202	<field>
6a488035 TO	203	<name>last_modified_date</name>
bf76be71	204	<title>Survey Modified On</title>
6a488035 TO	205	<type>datetime</type>
	206	<comment>Date and time that Survey was edited last time.</comment>
	207	<add>3.3</add>
	208	</field>
	209
	210	<field>
	211	<name>result_id</name>
bf76be71	212	<title>Survey Result</title>
6a488035 TO	213	<type>int unsigned</type>
	214	<default>NULL</default>
	215	<comment>Used to store option group id.</comment>
	216	<add>3.3</add>
223671d0 EM	217	<pseudoconstant>
	218	<table>civicrm_option_group</table>
	219	<keyColumn>id</keyColumn>
	220	<labelColumn>title</labelColumn>
	221	<nameColumn>name</nameColumn>
	222	<condition>name LIKE "civicrm_survey_%"</condition>
	223	</pseudoconstant>
6a488035 TO	224	</field>
	225	<field>
	226	<name>bypass_confirm</name>
bf76be71	227	<title>No Email Verification</title>
6a488035 TO	228	<type>boolean</type>
	229	<default>0</default>
	230	<comment>Bypass the email verification.</comment>
	231	<add>4.2</add>
	232	</field>
	233	<field>
	234	<name>thankyou_title</name>
	235	<title>Thank-you Title</title>
	236	<type>varchar</type>
	237	<length>255</length>
	238	<localizable>true</localizable>
	239	<comment>Title for Thank-you page (header title tag, and display at the top of the page).</comment>
	240	<add>4.2</add>
	241	</field>
	242	<field>
	243	<name>thankyou_text</name>
	244	<title>Thank-you Text</title>
	245	<type>text</type>
7deea513	246	<html>
7deea513	247	<type>TextArea</type>
817807ab	248	<rows>8</rows>
817807ab	249	<cols>60</cols>
7deea513	250	</html>
6a488035 TO	251	<localizable>true</localizable>
	252	<comment>text and html allowed. displayed above result on success page</comment>
	253	<add>4.2</add>
	254	</field>
424392c5	255	<field>
	256	<name>is_share</name>
	257	<title>Is shared through social media</title>
	258	<type>boolean</type>
	259	<default>1</default>
	260	<comment>Can people share the petition through social media?</comment>
	261	<add>4.4</add>
	262	</field>
6a488035	263	</table>