Summary

• Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.awa
	1	+XWiki.gru

Default language

...	...	@@ -1,0 +1,1 @@
	1	+de

Content

...	...	@@ -1,52 +1,82 @@
1		-{{info}}
2		-This function is available starting with {{formcycle/}} version 6.2.0.
3		-{{/info}}
	1	+{{version major="6" minor="2" patch="0"/}} This license module is subject to costs and available from {{formcycle/}} version 6.2.0 onwards.
4	4
5		-This feature allows creation of form records and e.g. email invitation of persons to fill out this form. Data, including email adresses for the invitation, can be uploaded under data as a .csv file.
6		-The datasource with all information that should be used can be selected in the invitation dialog. The number of invitations which can simultaniously be created depends on the license.
	3	+{{content/}}
7	7
8		-== Process ==
9	9
10		-After starting the process of inviting persons, a form record is produced for every row in the datasource. The form is prefilled if wanted (see configuration) and a target status for the created form can be set (see configuration). Each Email adress receives a link to the for itself created form, if email sending is activated (see conifguration). Based on this link, the receiver can edit or send the form record.
	6	+{{figure image="Invite0.PNG" clear="h1"}}
	7	+Open the form menu and select //Publish// to open the dialog with the //Invite// option.
	8	+{{/figure}}
11	11
	10	+== Overview ==
	11	+
	12	+This feature lets you create multiple form records at once, with data taken from a [[CSV data source>>doc:Formcycle.UserInterface.Data.Sources]]. Optionally, you can also send send an invitation email for each form record with a link to the newly created form record. The CSV data source with all information that should be used can be selected in the invitation dialog. The number of invitations that can be created at once depends on the [[license>>doc:Formcycle.SystemSettings.UserInterface.License]].
	13	+
	14	+When you click the send button to start, a form record is created for each selected row in the data source. If configured, the form is prefilled with the data from the data source. Then, the form record is put into the chosen [[target state>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.States.WebHome]]. Once the form record was created successfully, an email is sent to the email in the current row of the data source. The email may contain a link to the created form record that lets the recipient open the form, edit it and submit it. As the link contain a generated UUID, nobody without the link can open or view the form record.
	15	+
12	12	== Configuration ==
13	13
14		-An uploaded datasource in .csv format is required to use the invitation feature. It is recommended to use headers. The invitation can be configured via multiple required and optional settings. The dialog is divided into four parts:
	18	+To start, you need at least one [[CSV data source>>doc:Formcycle.UserInterface.Data.Sources]] in the backend. We recommend you to use a header for each column, as that makes it easier to identify what each column represents. The invitation can be configured via various required and optional settings. The dialog is divided into four parts:
15	15
16		-=== Datasource ===
	20	+=== Data source ===
17	17
18		-; Datasource (.csv)
19		-: All datasources of this mandant are listed here. The datasource which should be used can be selected here.
	22	+{{figure image="Invite_1.PNG"}}
	23	+A new form records is created for each row of the selected data source. Optionally, you can prefill the form with the data from the data source or send emails.
	24	+{{/figure}}
	25	+
	26	+; Data source (.csv)
	27	+: All existing [[CSV data sources>>doc:Formcycle.UserInterface.Data.Sources]] are listed here. Select the data source which you would like to use.
	28	+{{info}}Please note that when the data source is changed, some settings (e.g. the //E-mail to// field) will be reset to a default value.{{/info}}
20	20	; From (row)
21		-: The invitation process will begin from this row in the datasource.
	30	+: By default, all rows from the data source are used. If you only want to use a subset of row, select the starting row here.
22	22	; Number of entries
23		-: This defines the number of entries which are used for the invitation process and consequently the number of form records that are created. The maximum number is dependent on the license.
	32	+: By default, all rows from the data source are used. If you only want to use a subset of row, select the numbers of rows here. The maximum number may be restricted by your license.
24	24
	34	+Once you have selected a data source, a preview of the selected range of rows is shown below. The preview only shows the first and last selected row.
	35	+
25	25	=== Email configuration ===
26	26
27		-; Activation
28		-: Activates the sending of emails to the content of the defined column of email adresses in the invitation process.
29		-; Column of e-mail adresses
30		-: All headers of each column in the datasource are displayed here. The column that contains email adresses should be selected here. The emails are sent to the content of this column.
	38	+{{figure image="Invite_2.PNG"}}
	39	+You can send an email for each newly created form record. Use the variable //[%$FORM_INVITE_LINK%]// to insert a link to the form.
	40	+{{/figure}}
	41	+
	42	+; Send an invitation email to each person in the above data source
	43	+: Activate this option to send an email for each created form record. The email address is taken from one of the columns of each row of the data source, see below.
	44	+; Email to (column in data source)
	45	+: Select the column of the data source that contains the email addresses.
31	31	; Email from
32		-: Specifies the sender address of the invitation email.
	47	+: Specify the sender address of the email.
33	33	; Sender name
34		-: Specifies the name of the sender of the double opt-in email.
	49	+: Specify the name of the sender of the email.
35	35	; Subject
36		-: Specifies the subject of the invitation email.
	51	+: Specify the subject of the invitation email.
37	37	; Message
38		-: The text of invitation email. This should contain the (prefilled) form link. The form link is available via the [[variables>>doc:Formcycle.UserInterface.Variables.WebHome]] //[%$FORM_INVITE_LINK%]//.
	53	+: The main message (body) of the email. This should contain a link to the form record. You can insert it the link with the following [[variable>>doc:Formcycle.UserInterface.Variables.WebHome]] //[%$FORM_INVITE_LINK%]//.
39	39
40	40	=== Prefill form ===
41	41
42		-; Activation
43		-: Activates prefilling of form elements during the invitation process.
44		-; Datamapping table
45		-: The form can optionally be prefilled with e.g. data from the datasource. If this option is active, a table with the mapping of form elements and columns of the datasource will appear. The first column of this table lists all form elements that can be filled. This column can be searched for specific form elements. In the second column, the content which will be prefilled can be specified. There are also placeholder which are dependent on the datasource which are replaced with the content of the specific column. These placeholders are available under über //[%$data.COLUMNNAME%]// for datasources with header or //[%$data.col1%]// for the first column of datasources without header. The third column of the datamapping table contains the button to edit that row and by clicking on the button of the last row, the mapping is deleted. If no value is specified in the second column, the form element will not be prefilled.
	57	+{{figure image="Invite_3.PNG"}}
	58	+The form may be prefilled with data from the data source. For example, you could enter the email address of the recipient into a form field.
	59	+{{/figure}}
46	46
47		-=== Target status ===
	61	+; Prefill form fields
	62	+: Activate this option to prefill the newly created form record with the data from the data source.
	63	+; Data mapping table
	64	+: Here you can choose a value for each form field. Select the form field to prefill in the first column. Enter the value for the form field in the second column. To insert a value from the data source, use a [[variable>>doc:Formcycle.UserInterface.Variables]] with the following format:
48	48
49		-; Activation
50		-: Activates to set a specific status to a generated form record.
51		-; Set target status
52		-: All status that are defined for this form are listed here and one of them must be selected.
	66	+* //[%$data.COLUMNNAME%]// (if the CSV data source has named headers), or
	67	+* //[%$data.col1%]// (if it does not have named header).
	68	+
	69	+: If you decide later you do not want to prefill a certain form field, click the {{icon name="trash"/}} recycle bin icon to delete the mapping.
	70	+
	71	+=== Target state ===
	72	+
	73	+{{figure image="Invite_4.PNG"}}
	74	+When no target state is set, the newly created form records are shown as //saved// in the inbox.
	75	+{{/figure}}
	76	+
	77	+If required, you can select an initial [[state>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.States.WebHome]] for the form record. In case you do not select a state here, the newly created form record will only marked as //saved// in the [[inbox>>doc:Formcycle.Inbox.WebHome]].
	78	+
	79	+; Assign a target state to all form records created without error.
	80	+: Activate this option and select a state for the form record that is used when the form record was created successfully.
	81	+; Assign a target state to all form records created unsuccessfully.
	82	+: Activate this option and select a state for the form record that is used when the an error occurred while the form record was created.