Export and Import Forms
How to export and import General Forms between Pro Self-Service (ESS2) environments, and what field configuration is carried over.
Export and Import Forms
How to export and import General Forms between Pro Self-Service (ESS2) environments, and what field configuration is carried over.
Overview
Form export and import lets administrators:
- move a General Form and its field configuration between Pro Self-Service (formerly known as ESS2) environments, for example to promote a form built and tested on a lower environment to production without manually recreating it.
- export services or problem domains from the Classic Self-service and import them as General Forms to ESS2
- create new set of general forms with help of AI and import them in self-service
Exporting a form produces an XML file describing the form and its fields; importing that file creates a new form on the target environment. Import never updates an existing form.
Export and import is generally available from version 26.2 onward. Only admins can export or import forms.
Exporting a Form
- Open the General Forms list.
- Select the form(s) you want to export.
- Click Export. The form definitions download as an XML file.
Importing a Form
Import always creates new forms. It cannot update or overwrite an existing form, even if it has the same name or was originally exported from the same environment. Importing the same file several times creates a separate copy each time, so you can end up with several forms with the same name. To replace a form, import the new version and then delete the old one. Imported forms are created unpublished.
Shared Form Links
If you use the export and import functionality to replace an existing form in a production environment with one exported from a test environment, the original form's published link will be lost when the form is deleted.
Please make sure to publish a new form link and update all locations that use the old direct link, such as email templates, intranet pages, and other documentation.
Before You Import
The export file refers to other configuration by code or name, not by copying it. Make sure the target environment has:
- The form's target template, with the same code.
- The template attributes the form's fields use as targets and sources, with the same codes.
- For each List View and List View (Read-Only) field, exactly one self-service view with the same name.
If something is missing, the import reports it. See Validation and troubleshooting.
Import Steps
- Open the General Forms list on the target environment.
- Click Import.
- Select a previously exported XML file. The import creates new forms from that file.
What's Included
Exporting a form carries over both the form itself and its field configuration.
Form
- The Form Name and icon.
- The target template.
- The Reporter field target.
- The File attachments field, if configured.
- The Submission method setting, including a form left at its default (no override).
Fields
Fields are exported in the order they appear on the form.
- Short text, including RegEx data validation and its Validation Fail Message.
- Text area, Date, and Date & Time fields.
-
Drop-down, Multi-select Drop-down, and Checkbox fields with either:
- a reference value source, or
- a static (custom) value source, whether that source template is the form's own target template or a different one.
- List View (the targeted field that lets end users select from a self-service view) and List View (Read-Only) (the display-only variant). Only the name of the self-service view is exported, not the view itself.
- Text block and Section title elements, including their content.
Each field also keeps its settings: name, target, whether it is required, the tooltip setting on Drop-down, Multi-select Drop-down and Checkbox fields, and the Minimum and Maximum selections on Multi-select Drop-down, Checkbox and List View fields.
What's Not Covered in 26.2
The following are not part of the export file. After importing, set them up manually on the imported form.
- Translations: only default-language values are exported and imported, including Validation Fail Messages and referenced view names. Translations into other languages are not included.
- Field conditions: conditions that control when a field is shown or applied.
- Keywords.
- Comments field.
- Override Defaults: the default values set for target attributes.
- Published state: imported forms are created unpublished.
Validation and Troubleshooting
A form is validated at both export and import time, and it must be completely valid for either to succeed. Validation checks the entire file and reports all problems at once, so you can fix everything before trying again. If a form is not valid, nothing is imported. The most common problems are listed below.
| Problem | Cause | Resolution |
|---|---|---|
| Import fails because the target template cannot be found or is not suitable for forms. | The export file references the form's target template by code, and the target environment has no matching template. | Make sure the template exists on the target environment with the same code, then import again. |
| Import fails with an error such as "group attribute with code ... not found on target template" for a field target or source. | Field targets and sources are referenced by attribute code. The target environment's template is missing an attribute that the form uses, or the attribute has a different code. | Add or align the attribute on the target environment's template so the codes match, then import again. |
| Import fails with an error naming a missing view. | A List View or List View (Read-Only) field references a self-service view by name, and no view with that name exists on the target environment. The view definition (filters, columns, data) is not part of the export. | Create a self-service view with the same name on the target environment, then import again. |
| Import fails with an ambiguity error. | More than one self-service view on the target environment has the name the field references. | Make sure exactly one self-service view has that name, then import again. |
| Export or import fails on a RegEx validation rule. | RegEx data validation is checked with the same engine applied when end users submit the form (RE2J). Syntax accepted by other regex engines, such as lookahead, lookbehind, or backreferences, is not supported. | Rewrite the regex without unsupported syntax. Text area fields don't support RegEx validation and are unaffected. |
Tips & Tricks
Using AI to Generate Forms
By providing the schema of the import/export file and the target environment configuration export file, you can create AI-powered skills that automatically build forms.
This can be especially useful when designing new process forms and defining their content. When using a skill, you can describe the information you want to collect, the purpose of the form, and the business processes in which it will be used. The AI model can then generate a form structure based on those requirements.
Table of Contents