A.4 Dynamic Forms

This topic provide details about how you can specify the dynamic parameters for the existing fields.

Textbox

The textbox offers a simple user input that accepts any characters as follows:
  • The name of the user input can be defined using ${name}.
  • A customized label can be set using ${name(Label)}.
  • A default value can be assigned using the equals operator ${name(label)=Default Value}or ${name=Default Value}.

    For example, ${name(Label)=Default Value}.

Select

A select field allows you to choose from a given selection as follows:
  • The name, label, and default value can be set like the Textbox.
  • Options follow the ",(comma)" after the default assignment name=default,default|other1|other2 etc.
  • The label of an option can be added in the brackets following the option other1 (Other Option 1).

    For example: ${name(Label)=default,default(Default Option)|other1(Other Option 1)|other2}.

Slider

A slider allows you to choose from a given range as follows:
  • The first part of the slider dynamic form is the keyword slider, followed by brackets containing the values for minimum, maximum, and step size: slider(<min>,<max>,<step size>).
  • Then, after a: (colon), the name, label, and default value can be set similar to the Textbox.

    For example: ${slider(0,30,1.5):name(Label)=3}.

Checkbox

A checkbox allows you to choose from a given selection as follows:
  • The first part of the checkbox dynamic form is the keyword checkbox, followed by brackets containing the values join parameter of the options: slider(<join parameter>).
  • The join parameter is used between all selections and only shows up if at least two elements are selected.
  • Then, after a : (colon), the name, label, default value, and options can be set similar to the Dynamic Forms.

    For example: ${checkbox(or):name(Label)=default,default(Default Option)|other1(Other Option 1)|other2}.

Date Picker

A date-picker allows you to choose from a given date as follows:
  • The first part of the checkbox dynamic form is the keyword date, followed by brackets containing the output format: date (day) or date(yyyy-MM-dd.
  • The name, label, and default value can be set similar to the Textbox.

    For example:${date(yyyy-MM-dd):name(Label)=2019-02-27}.

Time Picker

A time picker allows you to choose from a given time as follows:
  • The first part of the checkbox dynamic form is the keyword time, followed by brackets containing the output format: time(HH:mm) or time(HH).
  • The name, label, and default value can be set similar to the Textbox.

    For example: ${time(HH:mm):name(Label)=T13:30}.

DateTime Picker

A datetime picker allows you to choose from a given date and time as follows:
  • The first part of the checkbox dynamic form is the keyword dateTime, followed by brackets containing the output format, that is, dateTime (YYYY-MM-dd hh:mm).
  • The name, label, and default value can be set similar to the Textbox.

    For example: ${dateTime(yyyy-MM-dd hh:mm):name(Label)=2019-02-28 11:30}.

Setting Values through a Notebook URL

In the web interface, dynamic form values can also be set by passing a name-value pair as the parameter of a notebook URL.

For example, to set the value of the dynamic form named myDynamicForm to FCCStudio , the parameter &form_myDynamicForm=FCCStudio must be added to the URL. If there are multiple dynamic forms with the same name in the same notebook, all of them will be set.

Note:

It is recommended not to pass sensitive information via the URL. If you have sensitive information, you can use the REST API to change the values of a dynamic form.