Árvore de páginas

Index


Speaking of Forms...

This feature allows creating Forms that can be published both for internal access, by registered users, and external platform users, by simply marking the form as public.

The form development center (Forms) offers features that facilitate the process by allowing editing and deleting forms during development. For published forms, records created can be viewed and new records can be added, in addition to sharing the form URL both publicly or among internal users, editing and deleting.

The Solutions feature covers all forms created and consolidated within the Form development center (Forms), making it much easier to manage the forms and their respective records.

Only forms created as of the Liquid 1.6.5 release will be featured in the Form development center (Forms). Forms created in the Waterdrop 1.6.4 release will be kept in the platform’s document browsing.


Attention

Forms created in Forms beta cannot be imported/exported or used in processes, and they do not have any link to communities.

The widget columns in the See records feature within the Forms center (Forms) are dynamic, which means that they change depending on the form chosen due to the fact that they have different fields.


Create forms


Follow the steps below to create a form.

01. Access Solutions on the main menu and select Forms.

02. A new guide will open listing all published forms. (Forms) 

03. Select New Form to open the form editor window.

04. Enter a form title in the Form title area (in green) above the component board.

The title must not exceed 70 characters.

The board with field and layout components available to create the form is located on the left-hand side, below the title.


05. Drag and drop components into the desired area, and a dotted area will appear to define the location and space of the field added. Users can set the field’s location as needed or align all fields to the top, using the icon  on the footer (in green). Select this item to align all components to the top of the form. 


Fields can be edited or deleted by placing the mouse cursor over the component and selecting among the following actions.


  • To open field editing, click the  icon on the right-hand corner of the field.

  • To delete fields, click the icon on the right-hand corner of the field.


Field componentes


Field components available to create forms:

Text field: used to add text fields to the form;

    • Field title: title of the added field;

    • Field style: style of the added field;

      • No style: default field;

      • CPF: used to add Individual Taxpayer Registry (CPF) number;

      • CEP: used to add Postal Code (CEP) number;

      • CNPJ: used to add Corporate Taxpayer Registry (CNPJ) number;

      • Date and Time: used to inform dates and times;

      • Percentage: used to add values with percentages;

      • Landline: used to add landline numbers;

      • Cell phone: used to add cell phone numbers;

      • License plate: used to add car license plate information;

      • Currency: used to add currency values;

      • IP: used to add IPs;

    • Tip: instructions to complete the field.

    • Initial value: initial value to complete the field (e.g. Enter your CPF here);

    • Help text: used to assist field completion (e.g. street name);

    • Mandatory?: used to define whether the field is mandatory. Mandatory fields are identified with an asterisk (*).

    • Advanced options: unique field name to check data.


Numeric: used to collect numerical data needed.

    • Field title: title of the added field

    • Tip: instructions to complete the field

    • Initial value: initial value to complete the field (e.g. Enter your CPF here);

    • Help text: used to assist field completion (e.g. Enter your RG)

    • Mandatory?: used to define whether the field is mandatory. Mandatory fields are identified with an asterisk (*).

    • Advanced options: unique field name to check data.


Single choice: used to add a field with multiple options but only allowing one option to be selected.

    • Field title: title of the added field;

    • Options: number of options to add to the field;

    • Help text: used to assist field completion (e.g. choose an option);

    • Mandatory: used to define whether the field is mandatory. Mandatory fields are identified with an asterisk (*).

    • Advanced options: unique field name to check data;


Multiple choice: used to add a multiple-choice field, which allows selecting one or more options.

    • Field title: title of the added field

    • Options: number of options to add to the field

    • Help text: used to assist field completion (e.g. choose one or more options)

    • Mandatory?: used to define whether the field is mandatory. Mandatory fields are identified with an asterisk (*).

    • Advanced options: unique field name to check data.

The Multiple-choice fields of Forms BETA are saved in the table in a different way than the previous form creation technique. By adding selected values in these fields, records are saved in the same column and line of the dataset. Each value is identified by a delimiter pipe (|). This ensures the character is reserved exclusively for this function.


List: used to add lists to the form.

    • Field title: Title of the added field

    • Options: number of options to add to the field

    • Help text: used to assist in field completion (e.g. choose a state)

    • Mandatory?: used to define whether the field is mandatory. Mandatory fields are identified with an asterisk (*).

    • Advanced options: unique field name to check data.

The Multiple-choice fields of Forms BETA are saved in the table in a different way than the previous form creation technique. By adding selected values in these fields, records are saved in the same column and line of the dataset. Each value is identified by a delimiter pipe (|). This ensures the character is reserved exclusively for this function.


Drop-down list: used to add drop-down lists.

    • Field title: title of the added field

    • Options: number of options to add to the field

    • Help text: used to assist field completion (e.g. choose an option)

    • Mandatory?: used to define whether the field is mandatory. Mandatory fields are identified with an asterisk (*).

    • Advanced options: unique field name to check data.


Paragraph: used to insert paragraphs in the form to view extensive information.

    • Field title: title of the added field;

    • Tip: instructions to complete the field.

    • Help text: used to assist field completion (e.g. describe your experience);

    • Mandatory?: used to define whether the field is mandatory. Mandatory fields are identified with an asterisk (*).

    • Advanced options: unique field name to check data;


Rich Text: used to add text that must be highlighted. In this field, it is possible to set the font, color, size, bold, italic, underline, strikeout, and enable spell check.

    • Title: title of the added text field

    • Mandatory: used to define whether the field is mandatory. Mandatory fields are identified with an asterisk (*).

    • Tip: instructions to complete the field

    • Help text: used to assist field completion (e.g. Write about you)


Rating: used to create forms with rating features in order to collect satisfaction survey information (star ranking).

    • Field title: title of the added rating field

    • Rating value: define the maximum rating value between: 1 and 5 stars

    • Help text: used to assist field completion (e.g. Rate from 1 to 5 stars)

    • Mandatory?: used to define whether the field is mandatory. Mandatory fields are identified with an asterisk (*).

    • Advanced options: unique field name to check data.


Date: used to define a date in the calendar.

    • Field title: title of the added field

    • Help text: used to assist field completion (e.g. Choose a date)

    • Mandatory?: used to define whether the field is mandatory. Mandatory fields are identified with an asterisk (*).

    • Advanced options: unique field name to check data.


Search: used to search information outside the form. This requires setting up a service and configuring the dataset with the operation available.

Refer to the document Dataset Development for more details on how to develop and setup datasets.

  • Title: title of the added search field.

  • Dataset: select the dataset configured for the field.

  • Column: select the dataset column to show desired values.

  • Preview: preview dataset values.

  • Mandatory: used to define whether the field is mandatory. Mandatory fields are identified with an asterisk (*).

  • Tip: instructions to complete the field

  • Help text: used to assist field completion (e.g. Select the desired value)

Advanced options:

      • Autofill: allows automatically filling out a field based on the dataset chosen for the search field.

      • Filter results?: this requires selecting a text field to use as a filter for the search field. Therefore, when selecting the dataset value, it is shown in the chosen field as a filter.


Search user: used whenever users must be searched within the form.

    • Title: title of the added search field

    • Filter: filters if the search is made by role, group or no filter

    • Save: saves the email address of the user searched

    • Mandatory?: used to define whether the field is mandatory. Mandatory fields are identified with an asterisk (*).

    • Tip: instructions to complete the field

    • Help text: used to assist field completion (e.g. Enter a user name)

    • Advanced options: unique field name to check data.


Layout components


Layout components available to create forms:

Button: used whenever there must be form actions other than the platform’s default actions (Save and Close).

    • Title: title of the added button

    • Button type: three button types available:

      • Save and continue;

      • Save and close;

      • Cancel;

    • Label color: color of the button label

    • Background color: button background color


Image: Used to add desktop or network images in forms.

    • Load image: load images directly from the user’s desktop

    • Apply: load external images by copying the link, pasting it on the URL chart and clicking Apply

    • Image alignment: set the image alignment:

      • Left

      • Center

      • Right

The icon  is shown whenever the component has pending settings. The form cannot be saved or published before these settings are addressed.



Multiple records: used whenever components must be grouped by subject in order to be presented together.

    • Title: title of the added field

    • Title color: color of the field title

    • Title background color: color of the title background

    • Add? button: (Document)

    • Delete? button: (Document)

    • Top alignment:component alignment to the top of the form

The icon  is shown whenever the component has pending settings. The form cannot be saved or published before these settings are addressed.


Delimiter: used to create delimitations between form fields.

    • Spacing: set the delimiter spacing between:

      • negative values reduce the delimiter spacing from the content above.

      • positive values reduce the delimiter spacing from the content below.

    • Style: delimiter style:

      • Solid

      • Dashed

      • Dotted

    • Color: delimiter color


Section: used to group related components within the form. To add components to the section, simply drag the desired component into the section.

    • Section title: title of the added section

    • Title background color: background color of the section title’s text.

    • Edge color: section edge color.


Tabs: used to add tabs to the form. One or more tabs can be used. To include tab components, simply select the desired tab and drag the component into the tab.

    • Tabs: field used to define the tab title.

To add a new tab, simply select Add tab, located below this field.

    • Tab color: used to define a color for the tab title.

    • Edge color: used to define a color for the tab edge.


Header: used to edit a form header.

    • Title: form header title

    • Title size: three title size options:

      • Large

      • Medium

      • Small

    • Title position: three title position options:

      • Left

      • Center

      • Right

    • Title color: header title color


Text: Used to add text to the form

    • Text description: field used to add a description of the added field

    • Text size: size of the text font. Options:

      • Extra small

      • Small

      • Medium

      • Large

      • Extra large

    • Text position: used to define the text position:

      • Left

      • Center

      • Right


External content: used to add external URLs to the form.

    • URL: add the access URL on the field and click Apply

    • Load: Add an image directly from the user’s desktop

The icon  is shown whenever the component has pending settings. The form cannot be saved or published before these settings are addressed.


Incorporate: used to incorporate information (form registry) within the form being created.

This field is mandatory. Only forms selected from the list can be incorporated to other forms.

    • Select a form to incorporate: list of platform forms to incorporate to the form being created.

The icon  is shown whenever the component has pending settings. The form cannot be saved or published before these settings are addressed.



Integrate forms


Integration is a feature that allows users to carry out predefined platform actions in the form. Each new form created can be integrated by selecting the parameters of the selected operation, in order to ensure it runs correctly. Step-by-step:

Integration must be set up before the form is saved or published. Otherwise the integration will not work as expected.

01. Create the form and click Configure.

02. Click External Integrations and then Add.

03. The integration screen will open. In this screen, operations predefined by the user are shown as a list.

Click here for more details on how to register operations in TOTVS Fluig Platform.

04. Select the desired operation and click Next.

05. The selected operation’s parameters are shown. Set the parameters to run the operation. Click Next.

06. Define the messages, if necessary. One as a warning, in case of integration issues, and another for follow-up, since the process time may vary depending on the integration.

Define messages on: Warning message definition and Follow-up message definition.

07. After the operation and messages are configured, a summary of the integration is shown.

08. Click Confirm.


Preview forms


Click item to preview what the form will look like during completion (form registration). However, it is not possible to edit or interact with the form in preview mode, since it still has to be saved and published before it can be completed.



Save forms


Follow the instructions below to save a form:


01. Click Save on the right-hand side of the editor screen. 

02. When saving a form, a message is shown confirming that the form has been saved and the editor screen remains open.

The saved form can be accessed via Solutions, on the platform’s main menu, and is also featured in the Last edited and Under editing lists.

03. Forms can be edited and later published or can be directly published. Solutions can be removed by clicking the button represented by the icon .


Publish forms


Follow the steps below to publish a form.

01. Open the folder where the form was created. The form will be highlighted by an orange icon, indicating that it is still being edited.

02. Click More options to the right of the form name. Then, click Edit form.

Click Yes, I do on the confirmation message to open the form available for publication.

03. The saved form is opened on the editor screen. Click Publish and a confirmation message will appear. Click Confirm to publish the form. The editing screen will close and the form will be identified by a gray icon, indicating that it has been published.

Form records may be added after the form is published. Refer to the document Form Records for more details.


Attention

The new APIs can only be used in forms created from Forms Beta, launched under the 1.6.4 Waterdrop release.

Attention!

It is not possible to fill out data in mobile devices for forms created in Forms Beta.

The Fluig app only allows filling out information for forms linked to a process. However, Forms Beta does not have this link yet, which prevents the user from editing records in the mobile app. 


Rule validations


This table details validations by field type (text, numeric and date) in Forms, as well as setting up each rule.

Text fieldsValidationsDescription

Text

Search

Search user

Paragraph


01. Validate email

02. Validate email with content

03. Validate CPF

04. Validate CNPJ

05. Validate contents of text field

06. Validate blank text field

07. Validate identical text fields

08. Validate identical text fields (ignoring upper and lower case)

01. Check if the email entered is a valid text.

02. Check if the email entered is a valid text and has a certain content, in order to ensure a standard is met. Example: [email protected], to ensure whether the text is an email and whether it contains the “company.comdomain.

03. Check if the CPF entered is valid.

04. Check if the CNPJ entered is valid.

05. Check if a text field has a certain text.

06. Check if a text field has a certain text.

07. Check if two text fields are identical.

08. Check if two text fields are identical, ignoring differences regarding upper and lower case letters.


Numeric fieldsValidationsDescription

Numeric

01. Validate identical numeric values.

02. Validate numeric value higher than another value.

03. Validate numeric value equal to or higher than another value.

04. Validate numeric value lower than another value.

05. Validate numeric value equal to or lower than another value.

01. Check if two numeric values are identical.

02. Check if one numeric value is higher than another value.

03. Check if one numeric value is equal to or higher than another value.

04. Check if one numeric value is lower than another value.

05. Check if one numeric value is equal to or lower than another value.

Date fieldsValidationsDescription
Date

01. Validate current date.

02. Validate identical dates.

03. Validate a date higher than another date.

04. Validate a date equal to or higher than another date.

05. Validate a date lower than another date.

06. Validate a date equal to or lower than another date.

01. Check if the value is informed with the current date (today)

02. Check if two date values are identical.

03. Check if one date value is higher than another value.

04. Check if one date value is equal to or higher than another value.

05. Check if one date value is lower than another value.

06. Check if one date value is equal to or lower than another value.

Attention!

To complete the form, all highlighted fields must be checked and filled out according to the required rules.


Forms buttons guide


The buttons guide shows users the purpose of each new button when editing forms.

ButtonDescription

Shown whenever an item is set as mandatory.

Shown whenever a component has pending configurations. The form cannot be saved or published in this case.

The form can be previewed. The form is shown in its editing format, but it cannot be filled out or saved.

Allows directly redirecting to the documentation page, with more details on how to configure the form correctly.

Allows the user to align components to the top. When selected, it is highlighted in green and aligns all components.
Simply select it again to turn it back to gray highlight, allowing the user to reassign components as needed. 

Enables the Do and Undo action. This can be useful in several different situations, such as when a user adds a component and later has to remove it.
In this case, the user simply clicks Undo. 

Saves the form as a draft.

Publishes the form.


Attention!

This documentation is valid as of the 1.6.5 - Liquid update. Previous updates may contain different information than what you see on your platform.