Form Builder

Braincube forms builder is a web application that generates a form in .bform format. This form can be integrated into the Form Viewer.

Create

The form creation interface is accessible here or via the Admin interface

Manual data

Choose the name of the form.
Add the inputs by clicking on them. They are added one under the other.
Configure these components.
Reset the form if you want to start over.
Save the form.

After this step you have two scenarios :

If you use the builder in the admin interface: the form is automatically saved in the form directory.
Otherwise: copy the 'xxx.bform' file in the C:\Users\<user>\braincube-form\form directory.

Braincube data

We can use data from Braincube through our API.

To access data from API, you need to configure a Certificate.

To select data from API, you need to create a server on the Braincube forms administation.

Then select "from API" on the input parameters :

Choose the name for the server that you have created on the Braincube forms administration.
Choose the data id with the prefix d. In the example the Id of the data is 200002, so Data source will be “d200002”.

By default, None is selected in the comparator.

If you keep this choice you have two use cases :

For an input that can only recover a single value (TextInput, NumberInput, etc.) : you recover the last value of the selected variable.
For an input that can recover multiple values (Combobox, Table, etc.) : you recover a dico (list of modalities). Only possible with a discrete variable

Filter data

To filter the data from API, it's possible to make request with two comparison methods :

Constant
Input : value of an input in the form

For each comparison method we have two parameters :

Firstly a comparator (==, <=, <, >=, >, between)
Secondly a constant or an input (input name)
- constant : it must have the same type (number, date, etc.) as the data id.
- input : nested query with the selected input value on the braincube mb.

If the selected comparator is between, we have two inputs for the comparison.

Click on the add button to add a comparator and value in the filters list.

You can also delete an existing filter with the delete button (select a filter in the list before).

You can filter data with multiple filters.

Particular cases : Table and TextArea inputs

In the case of Table and TextArea inputs, we can request multiple API variables.

Server name that you have created on the Braincube forms administration.
Data id, with the prefix d, you want to add to the component. For example if the Id of the data is 2000020, so Data source will be “d2000020”.
cancel button to deselect the current filter.
Button to add a variable in the component, or update if a filter selected.
Button to delete the selected variable in the list of variables.
Button to move the filter.
List of variables in the component.
Different fields to query and filter the list of variables (see above).

Note1 : The table will be composed of one variable per column.

Note2 : The TextArea will be composed of the last value of each variable per line.

Help contents

You can add some help contents for each form input via the checkbox Help.

For each help section we have two options :

Type : how help contents will be displayed in the form
- Popin
- Arrowbox
Source : where does help data come from
- Text
- API

When the source Text is selected, we can write the help text into the associated text area.

When the source API is selected, we can choose two parameters :

Server : help server name in the brain-form application
Value : value used to recover help text in the braincube mb, can be the value taken by the own input or an other input.

If other input value is selected we can choose the input present in the form.

Note : The help server is a braincube mb composed of three variables, always in this order :

MX_ID
Help comment ID
Help comment text

Example 1 :

We write the text "Help Text Test" in the input combobox.

Form result :

Exemple 2

For the ComboBox 1, we select parameters :

type: Arrowbox
source: API
server: help
value: other input
- input: combo-box2

Form result :

Note: help mb contains the commentary "COMMENTAIRE NUM 800" for the value 800.

Document

You can add some files (.pdf, .txt,… instruction notices for example).

To select files, you need to create a repository in the tab repos of the Braincube forms administation

Then Add the files in the form :

Note : Don't forget to specify the name of the folder on the input's parameters

INPUTS Setup

Table input

TableInput defines a table values field.

File Header : The column name in the result file
Form Label : The label of the input in the form
Definition of each column of the table : name (should be unique), width and input type
Height : The height of the container, in pixels
Input width : The width of the input, in pixels
Label width : The width of the label, in pixels
Nb Rows : the number of rows in the table
Is visible : Input is visible or not in the form
Reset Input: Auto reset input when you submit the form
Help : Section to add help contents
From API : The field is filled up by Braincube values

Adding column in the TableInput component :

Text input

TextInput defines a single line text field.

File Header : The column name in the result file
Form Label : The label of the input in the form
Prefix : A short hint placed before the input
Suffix : A short hint placed after the input
Read Only : Specifies that the input field is read-only
Required : Specifies that the input is a mandatory field
Input width : The width of the input, in pixels
Label width : The width of the label, in pixels
Is visible : Input is visible or not in the form
Reset Input: Auto reset input when you submit the form
Help : Section to add help contents
From API : The field is filled up by Braincube values

Number input

NumberInput defines a numeric input field

The input number is not supported in Internet Explorer 9 and earlier versions.

File Header : The column name in the result file
Form Label : The label of the input in the form
Value : The initial value
Min :The minimum value
Max : The maximum value
Prefix : A short hint placed before the input
Suffix : A short hint placed after the input
Read Only : Specifies that the input field is read-only
Required : Specifies that the input is a mandatory field
Input width : The width of the input, in pixels
Label width : The width of the label, in pixels
Is visible : Input is visible or not in the form
Reset Input: Auto reset input when you submit the form
Help : Section to add help contents
From API : The field is filled up by Braincube values

Range Input

RangeInput defines a field to enter a value within a range.

The input range is not supported in Internet Explorer 9 and earlier versions

File Header : The column name in the result file
Form Label : The label of the input in the form
Value : The initial value
Min : The lower limit of the range
Max : The upper limit of the range
Read Only : Specifies that the input field is read-only
Step : Specifies the interval between valid values for the input (the first valid value is the lower limit of the range)
Input width : The width of the input, in pixels
Label width : The width of the label, in pixels
Is visible : Input is visible or not in the form
Reset Input: Auto reset input when you submit the form
Help : Section to add help contents
From API : The field is filled up by Braincube values