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