[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>
  </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>
  </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 TO	49	<add>3.3</add>
	50	</field>
	51	<foreignKey>
	52	<name>campaign_id</name>
	53	<table>civicrm_campaign</table>
	54	<key>id</key>
	55	<add>3.3</add>
	56	<onDelete>SET NULL</onDelete>
	57	</foreignKey>
f813f78e	58
6a488035 TO	59	<field>
6a488035 TO	60	<name>activity_type_id</name>
a42c9322	61	<title>Activity Type</title>
f813f78e	62	<type>int unsigned</type>
f813f78e	63	<default>NULL</default>
3c7d2158	64	<comment>Implicit FK to civicrm_option_value where option_group = activity_type</comment>
6a488035	65	<import>true</import>
f813f78e	66	<add>3.3</add>
4080e473 AS	67	<pseudoconstant>
	68	<optionGroupName>activity_type</optionGroupName>
	69	</pseudoconstant>
614d72ec	70	<html>
e0991796	71	<type>Select</type>
614d72ec	72	</html>
6a488035 TO	73	</field>
	74	<index>
	75	<name>UI_activity_type_id</name>
	76	<fieldName>activity_type_id</fieldName>
	77	<add>3.3</add>
	78	</index>
	79
	80	<field>
	81	<name>recontact_interval</name>
bf76be71	82	<title>Follow up Interval</title>
6a488035 TO	83	<type>text</type>
6a488035 TO	84	<comment>Recontact intervals for each status.</comment>
7deea513	85	<html>
7deea513	86	<type>TextArea</type>
817807ab	87	<rows>20</rows>
817807ab	88	<cols>80</cols>
7deea513	89	</html>
6a488035 TO	90	<add>3.3</add>
6a488035 TO	91	</field>
f813f78e	92
6a488035 TO	93	<field>
6a488035 TO	94	<name>instructions</name>
bf76be71	95	<title>Instructions</title>
6a488035	96	<type>text</type>
434cdb95	97	<localizable>true</localizable>
6a488035	98	<comment>Script instructions for volunteers to use for the survey.</comment>
7deea513	99	<html>
7deea513	100	<type>TextArea</type>
817807ab	101	<rows>20</rows>
817807ab	102	<cols>80</cols>
7deea513	103	</html>
6a488035 TO	104	<add>3.3</add>
	105	</field>
	106
	107	<field>
	108	<name>release_frequency</name>
bf76be71	109	<title>Survey Hold Duration</title>
6a488035 TO	110	<type>int unsigned</type>
	111	<default>NULL</default>
	112	<comment>Number of days for recurrence of release.</comment>
	113	<add>3.3</add>
	114	</field>
f813f78e	115
f813f78e	116	<field>
6a488035 TO	117	<name>max_number_of_contacts</name>
6a488035 TO	118	<title>Maximum number of contacts</title>
f813f78e	119	<type>int unsigned</type>
6a488035	120	<default>NULL</default>
f813f78e	121	<comment>Maximum number of contacts to allow for survey.</comment>
6a488035 TO	122	<add>3.3</add>
6a488035 TO	123	</field>
f813f78e	124
f813f78e	125	<field>
6a488035 TO	126	<name>default_number_of_contacts</name>
6a488035 TO	127	<title>Default number of contacts</title>
f813f78e	128	<type>int unsigned</type>
6a488035	129	<default>NULL</default>
f813f78e	130	<comment>Default number of contacts to allow for survey.</comment>
6a488035 TO	131	<add>3.3</add>
6a488035 TO	132	</field>
f813f78e	133
	134	<field>
	135	<name>is_active</name>
bf76be71	136	<title>Survey Is Active</title>
6a488035	137	<type>boolean</type>
f813f78e	138	<default>1</default>
	139	<comment>Is this survey enabled or disabled/cancelled?</comment>
	140	<add>3.3</add>
6a488035	141	</field>
f813f78e	142
	143	<field>
	144	<name>is_default</name>
bf76be71	145	<title>Is Default Survey</title>
6a488035	146	<type>boolean</type>
f813f78e	147	<default>0</default>
	148	<comment>Is this default survey?</comment>
	149	<add>3.3</add>
	150	</field>
	151
6a488035 TO	152	<field>
6a488035 TO	153	<name>created_id</name>
047c5009	154	<title>Created By Contact ID</title>
6a488035 TO	155	<type>int unsigned</type>
6a488035 TO	156	<comment>FK to civicrm_contact, who created this Survey.</comment>
57e94608	157	<html>
047c5009	158	<label>Created By</label>
57e94608	159	</html>
6a488035 TO	160	<add>3.3</add>
	161	</field>
	162	<foreignKey>
bf76be71 EM	163	<name>created_id</name>
	164	<table>civicrm_contact</table>
	165	<key>id</key>
	166	<add>3.3</add>
	167	<onDelete>SET NULL</onDelete>
6a488035	168	</foreignKey>
f813f78e	169
6a488035 TO	170	<field>
	171	<name>created_date</name>
	172	<type>datetime</type>
	173	<title>Campaign Created Date</title>
	174	<comment>Date and time that Survey was created.</comment>
	175	<add>3.3</add>
	176	</field>
f813f78e	177
6a488035 TO	178	<field>
6a488035 TO	179	<name>last_modified_id</name>
047c5009	180	<title>Modified By Contact ID</title>
6a488035 TO	181	<type>int unsigned</type>
6a488035 TO	182	<comment>FK to civicrm_contact, who recently edited this Survey.</comment>
57e94608	183	<html>
047c5009	184	<label>Modified By</label>
57e94608	185	</html>
6a488035 TO	186	<add>3.3</add>
	187	</field>
	188	<foreignKey>
	189	<name>last_modified_id</name>
	190	<table>civicrm_contact</table>
	191	<key>id</key>
	192	<add>3.3</add>
	193	<onDelete>SET NULL</onDelete>
	194	</foreignKey>
f813f78e	195
6a488035 TO	196	<field>
6a488035 TO	197	<name>last_modified_date</name>
bf76be71	198	<title>Survey Modified On</title>
6a488035 TO	199	<type>datetime</type>
	200	<comment>Date and time that Survey was edited last time.</comment>
	201	<add>3.3</add>
	202	</field>
	203
	204	<field>
	205	<name>result_id</name>
bf76be71	206	<title>Survey Result</title>
6a488035 TO	207	<type>int unsigned</type>
	208	<default>NULL</default>
	209	<comment>Used to store option group id.</comment>
	210	<add>3.3</add>
	211	</field>
	212	<field>
	213	<name>bypass_confirm</name>
bf76be71	214	<title>No Email Verification</title>
6a488035 TO	215	<type>boolean</type>
	216	<default>0</default>
	217	<comment>Bypass the email verification.</comment>
	218	<add>4.2</add>
	219	</field>
	220	<field>
	221	<name>thankyou_title</name>
	222	<title>Thank-you Title</title>
	223	<type>varchar</type>
	224	<length>255</length>
	225	<localizable>true</localizable>
	226	<comment>Title for Thank-you page (header title tag, and display at the top of the page).</comment>
	227	<add>4.2</add>
	228	</field>
	229	<field>
	230	<name>thankyou_text</name>
	231	<title>Thank-you Text</title>
	232	<type>text</type>
7deea513	233	<html>
7deea513	234	<type>TextArea</type>
817807ab	235	<rows>8</rows>
817807ab	236	<cols>60</cols>
7deea513	237	</html>
6a488035 TO	238	<localizable>true</localizable>
	239	<comment>text and html allowed. displayed above result on success page</comment>
	240	<add>4.2</add>
	241	</field>
424392c5	242	<field>
	243	<name>is_share</name>
	244	<title>Is shared through social media</title>
	245	<type>boolean</type>
	246	<default>1</default>
	247	<comment>Can people share the petition through social media?</comment>
	248	<add>4.4</add>
	249	</field>
6a488035	250	</table>