1 Summary | 2 Field types | 3 Field type qualifiers | 3.1 Field type validations

Summary

The Replace field list (replace) parameter is a comma separated list of field descriptions. A field description is a colon separated list of entries that configure the field for display and replacement. Each field has a type and each type has a colon separated list of configuration entries.

If you prefer to see an example before looking at the reference information, go to this article.

The base field configuration that is common to all field types. Position refers to the position within the colon separated list (position1:postion2:position3:position4: etc...). Blanks are valid. Optional fields do not need to be specified. The following table lists the sequence to be used for the Replace field list:

Position	Entry	Default	Description

Position	Entry	Default	Description
1	key	required	Enter the field name. It must not be blank or contain blanks. Avoid special characters. This is the name used for replacement in the body. Key is case sensitive.
2	value	blank	Enter the initial field value. Always use the internal value and not the text representation of the value where that is supported.
3	description	key	Enter the prompt text for the field that will appear in the field table. Line breaks with leading space ( <br>) and required spaces ( ) are supported.
4	field type	text	Specify the field type from the list. See the field types table in the next section for valid values. Invalid types are ignored.

Field types

Field type

Description

Addition positions

Text

Password

Text entry box

Text entry box with masked value

Position	Entry	Default	Description
5	input size	inputSize parameter	Allows override of global parameter value.

Textarea

Multi-line text area

Position	Entry	Default	Description
5	number of rows	5 rows	Number of rows to be displayed.
6	number of columns	as large as containing area allows	Number of columns to be displayed.

Radio

Checkbox

Radio buttons

Checkboxes

Position	Entry	Default	Description
5	number of rows	1	Layout of the entries.
6	value		Value of entry for replacement.
7	text	value	Text for entry for display to user.
repeat			Repeated text:value pairs for each entry.

Entries per line

An alternative is to use a negative number for position 5 to indicate the number of entries per line.

Select

Multi select

Select list

Multiple select list

Position	Entry	Default	Description
5	number of rows	1	Selections to display.
6	value		Value of list entry for replacement
7	text	value	Text for list entry for display to user
repeat			Repeated text:value pairs for each list entry

Dynamic Select

Dynamic Multi Select

Dynamic select list

Multiple dynamic select list

Populates select list with the values retrieved after specifying an SQL query.

Important information:

Requires the SQL for Confluence app to use these field types. If the app is not installed or is disabled, the macro displays an error message.

Points to remember:

If multiple columns are specified in the SQL query, only the first and second columns are considered as key-value pairs for the select list.
If only one column is specified in the SQL query, that column is considered as a key-value pair for the select list.
A custom default value can be specified when either of these field types are used. Use the following SQL query format to provide the default value:
SELECT 'defaultValue' UNION ALL SELECT...
Specify the SQL query to fetch data from after the UNION ALL operator.
For example, if the following query is used:
SELECT 'NA' UNION ALL SELECT second_address FROM Master_Address
Once Run is clicked on the form, NA is displayed as the default value in the select list.

Position

Parameter

Description

6

Data source profile

Specify the profile to be used to access data. This is a mandatory field.

Lists all the data source profiles configured by your Confluence administrator.

7

SQL query

Enter query to fetch data to be used as the select options. This is a mandatory field.

If the SQL query specifies multiple columns, the values from the first column are considered.

8

Number of options to display

Enter the number of list options to be displayed. If left blank, all fetched values are displayed in the list.

Float

Integer

Integer Select

Text entry box with validation

Select list

Position	Entry	Default	Description
5	lower bound	no validation	Automatic range validation. Must be valid integer or float value.
6	upper bound	no upper validation

Inclusive

Bounds are inclusive - greater than or equal and less than or equal.

integer-select

Both bounds must be specified and the difference must be less than 10000.

Date

Text entry box with validation

Position

Entry

Default

Description

5

lower bound

no validation

Automatic range validation

6

upper bound

no validation

7

date format

dateFormat parameter

Allows override of global parameter value.

See Date Format for how to specify this value.

Inclusive

Bounds are inclusive - greater than or equal and less than or equal.

Output

Output text only

Hidden

Hidden field - does not show in table

Group

Pseudo field used for grouping of fields

Position	Entry	Default	Description
5	width	as much as needed	Width of the group area in percent (%) or pixels.

Field type qualifiers

The field type (position 4) entry can be qualified by one or more of the following by appending the qualifier to the field type name.

Field type validations

An individual field type can be validated against a regular expression (regex), display an error message if the field value does not match the given regex, and if required, a short description about the field. To enable the validation for a specific field, toggle Validate on to enable the Regular expression, Error message, and Help text fields. This position entry is appended to the the field type qualifier. Available since version 6.2.

The entry is supported for the following field types:

Text
Password
Textarea
Date
Integer
Float

Once Validate is enabled, the three fields, Regular expression, Error message and Help text, then become mandatory, that is, values for all three fields must be provided.
A configuration error is displayed in the editor if values are not given for all of the validation fields before the settings are saved.
Disable the Validate field if validations are not required for the specific field to proceed further.
Refer to this article to know more about regular expressions.

Field types - 6.x

Summary

Field types

Field type qualifiers

Field type validations