Submit Form Editor
The submit form editor is used to design custom dialogs that are presented to users when they submit a definition, such as a process or chain. They were originally designed for user message.
User Message Integration
The dialogs are separate user interface elements that can be accessed via the ${UserMessage_Link} link in user message notification emails.
The user message uses the System_UserMessage_Notification definition in the partition of the user message as the email source. If this definition does not exist, it uses the GLOBAL.System_UserMessage_Notification definition. Note that the source of GLOBAL.System_UserMessage_Notification cannot be edited and contains no link to the form, so you duplicate it and place it in the same partition as your user message.
tip
When you duplicate GLOBAL.System_UserMessage_Notification, the system automatically removes the System_ prefix from the name; you have to revert this. The user message will only use System_UserMessage_Notification, not UserMessage_Notification.
Designing Forms
Prerequisites
To create a submit form for a definition, the definition must have a default queue set.
Controls
The following components are available:
| Control | Description |
|---|---|
| Button | Buttons are mapped to responses. Once a button is pressed, the definition is persisted and no further action on the definition is allowed. |
| Calendar | A calendar control allows the user to select a date. |
| DateTime & TimeZone Edit | The date time with time zone edit control allows the user to specify a date time with time zone; this can be mapped to a parameter on the definition. The value selected will be set on the parameter. |
| DateTime Edit | The date time zone edit control allows the user to specify a date time with time zone; this can be mapped to a parameter on the definition. The value selected will be set on the parameter. |
| Grid | Allows you to align child controls horizontally and vertically in a grid. |
| Image | Allows you to upload an image that will be displayed on the form. |
| Number Edit | The number edit control allows you the user to specify a number; this can be mapped to a parameter on the definition. |
| Panel | Allows you to align child controls either horizontally (Row) or vertically (Column) |
| Spacer | Allows you to insert a space between controls. |
| Text | Allows you to label adjacent controls. Non-editable, non-expandable text box. |
| Text Area | Allows the user to enter text. Expandable text box; can be mapped to a parameter. |
| Text Edit | Allows the user to enter text. Non-expandable text box; can be mapped to a parameter. |
| Time Edit | Allows the user to specify a time. |
Button
| Property | Description |
|---|---|
| Response | The response to map to the button. By default, a definition has two responses, Accept and Reject. |
| Text | The text to be displayed on the button. Defaults to Button. |
| Style | The style of the button. Normal - styling used for non-toolbar buttons in the user interface.Toolbar Normal - styling used for successful toolbar buttons in the user interface.Toolbar Cancel - styling used for abortive toolbar buttons in the user interface. |
| Tooltip | Text to be displayed when a pointing device hovers over the button. |
Calendar
| Property | Description |
|---|---|
| Parameter | Parameter to be mapped to this control; only parameters of type Date, Date Time, and Date Time Zone can be mapped to calendar controls. |
| Clock | Time notation; allows you to choose between 24 and 12 hour times, the latter with AM/PM. |
| TimeZone | Olson time zone. |
| Tooltip | Text to be displayed when a pointing device hovers over the calendar. |
DateTime & TimeZone Edit
| Property | Description |
|---|---|
| Parameter | Parameter to be mapped to this control; only parameters of type Date, Date Time, and Date Time Zone can be mapped to this control. |
| Format | The Java Date Format to use to display the date, time, and time zone. Note that if you do not specify a format, no date, time, timezone elements are displayed. |
| Tooltip | Text to be displayed when a pointing device hovers over the control. |
DateTime Edit
| Property | Description |
|---|---|
| Parameter | Parameter to be mapped to this control; only parameters of type Date and Date Time can be mapped to this control. |
| Format | The Java Date Format to use to display the date and time. Note that if you do not specify a format, no date, time, timezone elements are displayed. |
| Tooltip | Text to be displayed when a pointing device hovers over the control. |
Grid
| Property | Description |
|---|---|
| Stretch | Stretch the grid to occupy all free space. |
| Tooltip | Text to be displayed when a pointing device hovers over the control. |
Image
| Property | Description |
|---|---|
| Image | Use the Browse button to select an image to upload to the form. The image will be displayed inline. |
| Tooltip | Text to be displayed when a pointing device hovers over the control. |
Number Edit
| Property | Description |
|---|---|
| Parameter | Parameter to be mapped to this control; only parameters of type Number can be mapped to this control. |
| Tooltip | Text to be displayed when a pointing device hovers over the control. |
Panel
| Property | Description |
|---|---|
| Direction | Orientation of the panel, horizontal (Row) or vertical (Column). |
| Align | Horizontal (Column Direction)/Vertical (Row Direction) alignment of child controls. The alignment is dependent on the Direction property (Column / Row).Start - align child controls to the left/top.Center - center child controls.End - align child controls to the right/bottom.Stretch - stretch child controls to occupy all space. |
| Justify | Vertical (Column Direction)/Horizontal (Row Direction) alignment of child controls. The alignment is dependent on the Direction property (Column / Row). Start - align child controls to the top/left.Center - center child controls. End - align child controls to the bottom/right. Space Between - add spacing between child controls Space Around - add spacing before the first and after the last child control. |
| Stretch | Stretch the panel to occupy all free space. |
| Scrollable | Allow the control to have scroll controls, if required. |
| Style | Style of the control.Transparent - no styling.Panel - use the default panel styling of the current theme.Background - use the background color of the current theme.Title bar - use title bar styling of the current theme.Button bar - use the button bar styling of the current theme. |
| Tooltip | Text to be displayed when a pointing device hovers over the control. |
Spacer
| Property | Description |
|---|---|
| Width | Width in points of the spacing. |
| Height | Height in points of the spacing. |
| Tooltip | Text to be displayed when a pointing device hovers over the control. |
Text
| Property | Description |
|---|---|
| Text | Read-only text to display. |
| Font size (pt) | Font size to use for the text; in points. |
| Bold | Use a bold font. |
| Italic | Use an italic font. |
| Tooltip | Text to be displayed when a pointing device hovers over the control. |
Text Area
| Property | Description |
|---|---|
| Parameter | Parameter to be mapped to this control; only parameters of type String can be mapped to this control. |
| Columns | Width in characters of the text area. |
| Rows | Number of lines of text. |
| Tooltip | Text to be displayed when a pointing device hovers over the control. |
note
A text area can be resized by the user.
Text Edit
| Property | Description |
|---|---|
| Parameter | Parameter to be mapped to this control; only parameters of type String can be mapped to this control. |
| Tooltip | Text to be displayed when a pointing device hovers over the control. |
Time Edit
| Property | Description |
|---|---|
| Parameter | Parameter to be mapped to this control; only parameters of type Time can be mapped to this control. |
| Tooltip | Text to be displayed when a pointing device hovers over the control. |
Form Layout
By default, the form contains a title bar, a vertical panel, and a button bar.
The default form will have the following controls:
Titleset to the Description of the process definition.- Additional controls and labels for each parameter that does not have the
UserMessage_prefix. The control type depends on the parameter type; the label will either be the Description of the parameter if set, or its Name. - Additional toolbar buttons will be created for each Response.
You drag and drop controls from the left panel onto the form. Available target positions on the form are highlighted in green. In a Grid control, child controls can be aligned vertically and horizontally, there is always a target position before, after, above, and below a control in a Grid. In a panel, target positions are located either above and below ( Column ) or before and after ( Row ).
Controls that are mapped to In parameters are read-only, controls that are mapped to In/Out or Out parameters can be filled.