Formcreator

Download

Sources

https://github.com/pluginsGLPI/formcreator/releases

https://github.com/pluginsGLPI/formcreator

Requirements (on-premise)

GLPI Version

Minimum PHP

Recommended

10.0.x

8.1

8.2

11.0.0

8.2

8.4

Version 3.0.0 of the plugin, called Formcreator Migration Tool, has been designed to prepare the migration of Formcreator forms to the Forms module (native forms introduced in GLPI 11).

With the many successive versions of Formcreator, the structure of the tables may have varied over time. Version 3.0.0 ensures a predictable and consistent state of the data before migration to GLPI 11, in order to simplify the migration script integrated into the GLPI core.

You can therefore upgrade your instance directly to GLPI 11.x from any previous version of GLPI and Formcreator.

Example: From GLPI 9.5.2 with Formcreator:

Install GLPI 11 and this plugin (v3.0.0) directly
Execute the table migration via the plugin
Run the GLPI core migration

A dedicated interface guides you through the different steps of the migration.

This plugin should be installed only for the duration of the migration, and then uninstalled once the operation is completed.

This plugin is available without a GLPI Network subscription. It is also available on GLPI Cloud.

FormCreator is a plugin which allow creation of custom forms of easy access.

Install the plugin

Go to the marketplace. Download and install the plugin Form Creator

Features

Direct access to forms self-service interface in main menu,
Highlighting forms in homepages,
Access to forms controlled: public access, identified user access, restricted access to some profiles,
Simple and customizable forms,
Forms organized by categories, entities and languages,
Questions of any type of presentation: Textareas, lists, LDAP, files, etc,
Questions organised in sections. Choice of the display order,
Possibility to display a question based on certain criteria (response to a further question),
A sharp control on responses from forms: text, numbers, size of fields, email, mandatory fields, regular expressions, etc,
Creation of one or more tickets from form answers,
Adding a description per fields, per sections, per forms, entities or languages,
Formatting the ticket set: answers to questions displayed, tickets templates,
Preview form created directly in the configuration,
Translation of forms to serve them in several languages.

You can take an look to the full changelog from plugin sources.

Install the Plugin

Uncompress the archive.
Move the formcreator directory to the <GLPI_ROOT>/plugins directory
Navigate to the Configuration > Plugins page,
Install and activate the plugin.

The plugin's directory must have the same name as the plugin:

Good: [glpi/plugins/formcreator]{.title-ref}
Bad: [glpi/plugins/formcreator-master]{.title-ref}
Bad: [glpi/plugins/formcreator-0.90-1.3.2]{.title-ref}

Only one directory must contains the plugin's files of a single plugin in the GLPI plugins directory. Don't rename the plugin's directory for backup, move it!

Service catalog

The service catalog is a replacement for the GLPI's simplified interface.

It is enabled on a per entity basis and exists in two flavors

simplified
extended

To enable it, edit an entity, open the [Forms]{.title-ref} tab and set the field [Helpdesk mode]{.title-ref} to [Service catalog simplified]{.title-ref} or [Service catalog extended]{.title-ref}. This setting handles inheritance from parent entity to children entities.

Users using the simplified interface will benefit a new interface allowing them to:

browse forms and FAQ with the unified interface
follow the process of their requests
book assets
view their feeds

Users using the extended interface have a more complete view on their requests.

Forms with [Direct access on homepage]{.title-ref} enabled will appear in the interface. Users may search by browsing the categories on the left of the screen, and may also search for forms with a natural language search engine.

By default FAQ items in the Knowledge Base also show with forms. The only prerequisite is to associate form categories to knowledge base categories (in [Setup > Dropdowns : Forms > Form categories]{.title-ref}).

It is possible th have a distinct display of FAQ in [Administration > Entities > Forms]{.title-ref}. When Distinct menu entry is selected the service catalog shows a new menu entry on the left. FAQ are browsable by category and key words.

All entity settings for Formcreator propagate to sub entities by default. The administrator may change the settings in a sub entities to break inheritance.

Overview

The service catalog shows several counters on the top left corner. Those counters show all requests involving the current user as a author, requester, observer, assigned or validator.

The requests displayed here are

tickets created without Formcreator
tickets generated by forms havung only one target tickets
form answers when the form has no target ticket
form answers when the form has several target tickets

The request are spread over 4 counters

processing
pending
to validate
closed

New requests are not included in the counters.

RSS feeds

When users are allowed to view RSS feds, the service catalog shows a menu entry on the left to access them. RSS feeds administration is done in GLPI as usual.

Reservations

Users may book an asset with GLPI's reservation system, avaialble in the left menu of the service catalog.

Forms configuration

Form creation

The right to create forms is enabled to the profiles having the right to update entities in GLPI. Refer to the documentation of GLPI to know how to setup this right.

Forms must be created in the entities where they are intended to be available. A form may be available in its entity and all sub entities if the field Child entities is set to Yes.

Navigate to Administration > Forms.

Click on the button to add a form +

Following fields must be populated:

Name: Name of the form.
Active: A form is inactive by default. You need to explicitly activate it when it is ready to use.

It is recommended to fill the Category field:

In the simplified interface, categories allow to tidy forms by Blocks.
If you want to use the service catalog you must use form categories.

Form categories are plugin's dropdowns. You can add form categories directly when editing a form using the + next to category field. You can do the same from Configuration > Dropdowns > Form category.

Direct access on homepage: Direct access to the form from the GLPI's simplified interface.
Description: displays in the list forms.
Language: by default a form is set to the language of its creator. The form will be available only to users using the same language as the form. Choose All languages to make the form available to users without language restriction.
Header: displays when the form is displayed.
Need to be validate: If Yes a list of validators is displayed. This is a list of GLPI users (with the right Validate an incident or Validate a request (in its profile) on a compatible entity with the form's entity. The list of validators is a multiple choice list. If no validator is selected all of them are submitted when the form is being used.
Default form in service catalog: if Yes the form will display in the service catalog without being filtered by the current category or keywords.

When all fields are filled, click on the add button at the bottom of the page.

Deleting a form is possible only if there are no associated answers. To delete a form, delete all its answers first from the Form answers tab.

Sections

After clicking on the tab Question the following page displays:

You must create a first section. Sections are intended to organize questions in the form.

It is possible to setup conditions to show the whole section, based on the answers provided to questions located in other sections of the form.

Questions

Click on the link Add a question in a section of your choice.

The following page displays:

A question is made of:

a title: this is the label of the question in the form.
a type: see list below.
a section: the section containing the question. You can move a question to an other section with this field.
a description: it is displayed under the question in the form. Use it as a hint for the requester, telling him which content is expected.
a dropdown list Show field to enable a condition

It submits the following choices:

Always visible: the field is always displays
Hidden unless: The question is hidden except if answers to other questions matches a condition.
Displayed unless: The question is displayed except if the answers to other questions matches a condition.

Conditions may be multiple. To add or remove a condition two buttons are available:

List of pictograms

The circle allows you to make a question mandatory

, or optional

Arrow up and arrow down allow you to reorder questions in a section.
Clicking on a question allow you to edit it.
Two stacked squares allows you to duplicate a question or a whole section.
The recycle bin allows you to delete a question or a whole section.

Questions are organized on a 4 columns array. You can resize width of questions, reorder them using drag and drop and put up to 4 questions on the same row.

Types of question

There are about twenty types of questions available. Depending on the chosen type, you need to provide additional information.

Required: Yes/No. When running the form a red star shows next to label of questions requiring an input.
Default values: its content depends on the type of the question.
Range Min/Max: Restricts the value to the given range when running the form.
Additional validation (Regular expression): You may set a custom regex with a regular expression. Use it when other restriction methods cannot satisfy your needs. Don't forget to specify the delimiters of the regex. You may add any modifier after the closing delimiter.

Actors

This field allows you to choose one or several users:

in GLPI, available in Administration > Users
not in GLPI, by typing an email address

Checkboxes (multiple choices)

Add a line per value in Values. Default values may be set in Default values, one per line. If this field is empty, no checkbox will be ticked.

Date / Datetime / Time

This field allows to select a date, a datetime or a time from a mini calendar.

Description

This field only displays information. Use it to give more details about a question.

This field allows the user to choose a value among those available in a dropdown from GLPI (in Configuration > Dropdowns).

Email

The answer to this type of field must be a syntactically valid email address.

File

This field allows the requester to upload a file.

Float

This field must be a float value. Note you may use a regular expression to tighter restrict the answer.

GLPI Object

This field allows you to build a dropdown from a GLPI object among those available in the menus:

Assets
Assistance
Management
Tools
Administration

Hidden field

This field is hidden and allows to retrieve an arbitrary value when generating the target (ticket or change).

This type of questions never shows on a form.

Hostname

This field is invisible. It allows to get the hostname of the computer used by the requester, assuming the DNS is able to properly resolve it from its IP address

Integer

This field must be an integer value. Note you may use a regular expression to tighter restrict the answer.

IP Address

This field is hidden and collects the IP address of the form requester. It does not show in the form.

LDAP select

This field allows you to create a dropdown list with objects from a LDAP directory:

This type of questions cannot be used to fill actors of a target.

Multiselect (multiple choice)

This field allows you to create a dropdown list with ability to select multiple items. Values are added one per line in the field Values. You may set default values, one per line in Default values*. If no default value is set then no item will be selected by default.

Request type

This field is a dropdown with "Incident" or "Request" choices. It can be used to set the request type of a ticket being generated by the form.

Radio buttons (one choice only)

Add a line per value in Values. A default value may be set in Default value. If this field is empty, no radio will be selected.

Select (one choice only)

This field allows you to create a dropdown list and set its items. Items are added one per line in Values. Default value may be set in Default value. If there is no default, no item is selected by default.

Text

This field allows you to input a single line of text.

Text area

This field allows you to input several lines of text.

Urgency

This field allows you to select an urgency defined in GLPI.

Conditions

Conditions are expressions involving questions and sections which are evaluated in order to determine

if a question is displayed
if a section is displayed
if the submit button of a form is displayed
if a target (see below) must be generated

Available operators in an assertion are:

equals
not equals
less than
greater than
less than or equal
greater than or equal
is visible
is not visible
matches a regular expression

The condition expression can be used with the following rules:

Hidden unless: the item is hidden or not generated except when the expression is true
Displayed unless: the item is displayed or generated except when the expression is true

Access types

Three values are available:

Public access: Anonymous users may access the form; you may use it in an intranet.
Private access: Users having a GLPI account may access the form.
Restricted access: Only users having the specified profiles may access the form.

When a form is set to Public access it is possible to enable a simple captcha. This captcha should prevent spamming if a form is accessible from internet.

Captchas are not enabled by default on anonymous forms. Administrators need to enabled them explicitly depending on how the form may be accessible from an hostile network such Internet.

Targets

There are three types of targets for a form:

tickets
changes
problems

It is possible to generate any number of targets from a single form. Mixing types of targets is also possible.

To create a target click on the link Add a target

The following window is then displayed:

Choose a target name and type, then validate. The new target is created and is available for tuning.

Preview

This tab allows you to view how the form will be rendered and test it without activating it.

Submitting answers from the preview will be actually saved, and will generate targets if the form is not configured with validation.