Form summary

The Form summary function allows you to create an overview of the most important properties of a form. Xima® Formcycle creates this summary as a PDF document.

The form summary gives you a quick overview of the form, such as its form elements and workflow configuration. You may also use a template to customize the layout.

Creating a form summary

You can create a summary of a form in the export option. The export option is available in the My forms menu (button to the right of the form card) or in the Xima® Formcycle Designer (more button at the top). This brings up a dialog with the following options:

Select the language for the summary. For example, the summary contains a table with all form elements. The text in the header of this table depends on the chosen language.
Export template
Template to be used for generating the summary. When no template is selected, the default template included in Xima® Formcycle is used.

Using templates

A .doc or .docx file can be used as a template. It must be uploaded either as a client or form file. First select whether you would like to use a client file or a form file, then select the file to be used.

Creating templates

Form summary templates are Word documents that may contain certain form control elements. These control elements are replaced by Xima® Formcycle with the corresponding content – similarly to the workflow action Word Fill. Otherwise, you are free to customize the content and layout document as required.

Please note that you need to enable the developer tools in Word to insert or edit form fields. See Preparing a Word document for more details.

Content placeholders (form control elements)

The following placeholders are available and can be used to insert various form details into the generated form summary. The placeholder must be inserted as the name of a form control element.

ContentPlaceholder codeDescription and notes
Form titleform_titleInserts the title (name) of the form.
Preview image of the formform_preview_image.b64img(450)Inserts a preview image of the form. Optionally, you may pass the desired width and height in pixels, e.g. form_preview_image.b64img(579~|410) (width 579, height 410). When only a width (form_preview_image.b64img(579)) or height (form_preview_image.b64img(~|410)) is given, the image will be scaled and retain its original aspect ratio.
Form descriptionform_description
Number of elementselements_countThe number of form elements in the form.
Last updateform_updateDate of the last update.
Link to formform_link.url()Link to open the form on the master server.

Content placeholders (MergeField)

MergeFields can be added in Word via Insert..Quick Parts..Fields.

To insert the following content, the corresponding placeholder must be entered in the Word document as merge field. After inserting a placeholder in a MergeField, it will appear as «PLACEHOLDER». The following placeholders may be used and are replaced when the form summary is created:

ContentPlaceholderDescription and notes
Workflowform_workflow_htmlAn overview of all states and actions present in the current workflow configuration.
Used data sourcesform_datasource_htmlAn overview of all data sources used by the form and its (select) elements.
List of used elementsform_elements_htmlAn overview of all form elements, including their name, label, alias, (data) type, attributes, and whether they are required fields. This width of the generated table is rather large – we recommend you use this placeholder on a page in landscape format.

To insert the following content, the corresponding placeholder must be entered directly in the Word document as plain text (without form control element). The following placeholders may be used and are replaced when the form summary is created:

Default templates

If no custom template is selected, Xima® Formcycle uses a default Word template to create the form summary. You can download the default template below - it can serve as a starting point for your own templates:

English Word template
German Word template
Dutch Word template