Activity Fields
Last updated
Was this helpful?
XMPro WorkFlow
Last updated
Was this helpful?
Object Groups
An Object Group displays line items. A number of Objects (or fields) will form a line within the Object Group. The user is allowed to add as many lines as needed to the object group. The line items can be populated from a database, or individual line items can be added as more fields are completed.
Tabs
Allows for the name of the tab to be defined. At the Activity Object level, add an option to associate a tab with an Activity Object. If an Activity Object belongs to an Object Group then all the Activity Objects in the same Object Group needs to be part of the same tab group.
Fields refer to the different fields that you see on the activity screen of the XMPro WorkFlow. They are the lowest level elements of a process. These controls are available from the following Activity Designer.
The following list explains the use of the fields available. Each field type also has several options available to configure the field to function the way you want it to. The available options depend on the field type.
Note: When naming the field using the wizard make sure to exclude the use of the XML reserved words & < > % in the caption.
Browse Page
Displays more than one field from a database in a separate browser window.
Chart
Displays as a chart in the WorkFlow. Charts can be changed based on a chart type, chart colors, the chart’s axis, and other chart elements.
Check Box
Displays a standard Windows check box on the activity screen. Used to select (checked) or clear (unchecked) an option.
Command Option
Displays a command button responsible for calling the next activity. All activities should have at least one command option.
Date Picker
Displays a standard Windows calendar on the activity screen. Select a date from the Calendar drop-down.
Drop-Down
Displays as a combo-box with a predefined list of selectable values. The values for a drop-down are static in the WorkFlow Designer and are a good control to use to display “stagnant” information that is not sensitive. If the options are going to change frequently or if you are, working with sensitive information, this is not a good control to use.
File Attachment
Displays as a text box with a Browse button next to it. Allows to attach documents to the process. When the Browse button is selected, it allows the navigation of a hard drive.
HTML Editor
Displays as an HTML Editor control. Allows for text to be copied and pasted as well as manipulated within the control.
Hyperlink
Displays an HTML link to an address, which opens in the default browser. Allows a hyperlink on the activity screen. It is typically used as links to open reports, or links to related documents such as policy and procedure documents.
Large Text Box
Displays as a comments box or multi-line text box on the activity screen. It serves as a placeholder to fill out and provide information.
Lookup
Displays as a combo-box. Allows the choice of a value from a list. The values for a lookup are dynamically retrieved from a database.
Pivot Grid
Displays as a Pivot Grid control. Allows present complex data sets and to allows to be grouped, ordered and filtered data presented.
Radio Button
Displays as a standard Windows radio or option button. It allows the choice one of more than one option.
Reference Label
Displays as a dynamic value on the activity screen. This value cannot be changed.
Signature
Displays as a standard signature box. Allows for the capture of the end user’s signature.
Simple Text Box
Displays as a standard Windows text box. It serves as a placeholder to fill out and provide information.
Team Select
Displays as a combo-box. Allows the selection of the business group to which a later activity must be routed. For the object to work, the items in the team select must be the same as existing business groups. Then, this field can be used as the Creation Value when choosing Dynamic Group as the Creation Type.
A field has the following properties:
Attributes
Options:
Use this property to configure the options for the field.
Behavior
Column:
This property allows you to specify that a field should be placed next to another field. The result will be two fields on the same line next to one another in the WorkFlow.
The property can have one of the following values:
0 – The field should be in the left column. This is the default value for this property.
1 - The field should be in the right column
Note: This property only applies to ungrouped fields that are not of type command option.
Type:
This property specifies the field's type. For more information for each type see the section below.
Content Definition
Dynamic Value/ Managed Object:
This property allows you to write a script or code for the field to run and interpret. It can be used to populate the value of the field dynamically.
This property is not available for Command Option field types.
Trigger:
This property allows you to write a trigger script for the command option field. The trigger script is the script that calls the next activity, and in doing so, determines the routing or flow of the process.
This property is only available for Command Option field types.
Control
Data Type:
This property specifies the required data type for the value entered into the field on the activity or web form. XMPro allows three data types: numeric, date, and text.
If the user enters an invalid data type into the control, XMPro will inform the user of this, and prevent the process from carrying on until the user enters the correct data type.
Display Mask:
A Boolean value indicating whether the input mask should be displayed in the WorkFlow.
If the value is True, the input mask will be displayed next to the Caption.
Input Mask:
This property allows you to specify the required format of the data entered by the user into this field.
See Specifying Input Masks for more information on this topic.
Required Field:
A Boolean value that specifies whether a value for this field is required in the WorkFlow.
ID
ID:
A numerical value which uniquely identifies this activity field. This property is automatically assigned, and used internally by XMPro.
Identifier
Caption:
This property specifies a caption that will appear to the left of the field in the WorkFlow.
Index:
This is a unique number you assign to the field. This number will determine the sequence of fields on the activity or web form in the WorkFlow. The fields will be arranged top to bottom, smallest to biggest index number.
This is also the number that you will use as a unique identifier in the field's name.
Name:
This property specifies the name of this field. This name should be unique in the site.
A naming convention is used to name fields. In the field name, you should show four things:
The process the field forms part of.
The activity the field forms part of.
A logical description for the field.
If you have a Leave Requisition process, and the first activity in the process is a leave form the user has to complete, and the first field on this activity is a text box where the user must enter his/her name, you will typically name the field LR10Name.
Object Group:
This property allows you to choose the object group that you want this field to be part of. A field doesn't have to be part of an object group.
Object groups are configured in the Object Groups property of an activity.
Parent:
This property specifies the ID of the activity to which this field belongs.
Tooltip Text:
This property specifies the tooltip text for the field. This tooltip text will appear as an icon to the right of the field in the WorkFlow.
Risk Management
Risk Category:
The Risk Management properties are used in compliance processes (Sarbanes-Oxley).
Risk Control Type:
The Risk Management properties are used in compliance processes (Sarbanes-Oxley).
Risk Description:
The Risk Management properties are used in compliance processes (Sarbanes-Oxley).
The browse page field type allows you to display more than one field from a database in a separate browser window. It is used instead of a lookup when you want to return records that are too many or too large for a lookup.
The browse page has the following options:
AllButton
A Boolean value that specifies whether the browse page displays the display all icon.
AutoPostBack
A Boolean value that specifies whether the page must automatically refresh when this field loses focus.
Edit Page
This property allows you to configure the browse page.
When you click in this property, a button ( ) will appear. This button will open the configuration window
FirstPage
A Boolean value that specifies whether the browse page displays the first page icon.
LastPage
A Boolean value that specifies whether the browse page displays the last page icon.
Popup
A Boolean value indicating whether the browse page must open up in a different browser window, or on the same page.
Resizable
A Boolean value that specifies whether the user can resize the browse page window.
Scrollbars
A Boolean value that specifies whether you want to display scrollbars in the browse page window.
Visible
A Boolean value that specifies whether the browse page object is visible or not.
Width
The width, in pixels, of the browse page field.
WindowHeight
The height, in pixels, of the browse page window.
WindowWidth
The width, in pixels, of the browse page window.
The date picker field type allows the user to choose a date from a Calendar drop down.
It is displayed as a drop down that displays a calendar if the user clicks on it.
The date picker has the following options:
AutoPostBack
A Boolean value that specifies whether the page must automatically refresh when this field loses focus.
Enabled
A Boolean value that specifies whether this field is enabled or disabled.
Style
This option allows you to use any CSS instruction/s to determine what the field looks like and how it acts.
For example: "text-align: center;"
Visible
A Boolean value that specifies whether this field is visible or not.
Width
Specify the width, in pixels.
The Chart field displays as a chart in the WorkFlow. You have a lot of field over the chart type, chart colors, the chart's axis, and other chart elements.
Chart display in WorkFlow
The chart has the following options:
Chart Definition
This option opens the Chart Wizard which will take you through the steps of creating a chart.
Height
Specify the height, in pixels, of the chart.
Visible
A Boolean value indication whether the chart must be visible or not.
Width
Specify the width, in pixels, of the chart.
The checkbox control type displays a standard Windows check box on the activity screen.
The checkbox has the following options:
AutoPostBack
A Boolean value that specifies whether the page must automatically refresh when this field loses focus.
Enabled
A Boolean value that specifies whether this field is enabled or disabled.
Style
This option allows you to use any CSS instruction/s to determine what the field looks like and how it acts.
For example: "text-align: center;"
Visible
A Boolean value that specifies whether this field is visible or not.
The radio button field type is displayed as a standard Windows radio or option button. It allows the user to choose one of more than one option.
The radio button has the following options:
AutoPostBack
A Boolean value that specifies whether the page must automatically refresh when this field loses focus.
Enabled
A Boolean value that specifies whether this field is enabled or disabled.
GroupName
The name of the group of radio buttons. In order to obtain the functionality of the radio button, you need to make it part of a group.
Style
This option allows you to use any CSS instruction/s to determine what the field looks like and how it acts.
For example: "text-align: center;"
Text
The text that should appear to the right of the radio button.
Visible
A Boolean value that specifies whether this field is visible or not.
The dropdown field type allows the user to choose a value from a predefined list.
It is displayed as a combo-box. The values for a drop down are hard-coded in the WorkFlow Designer.
The dropdown has the following options:
AutoPostBack
A Boolean value that specifies whether the page must automatically refresh when this field loses focus.
Enabled
A Boolean value that specifies whether this field is enabled or disabled.
Items
Use this property to add items to the drop down.
Clicking on the options button ( ) in this property will open the Specify Items window. In this window, you can add, remove, or change the entries in the drop down's list.
Style
This option allows you to use any CSS instruction/s to determine what the object looks like and how it acts.
For example: "text-align: center;"
Visible
A Boolean value that specifies whether this field is visible or not.
Width
Specify the width, in pixels, of this object.
The lookup field type allows the user to choose a value from a list.
It is displayed as a combo-box. The values for a lookup are dynamically retrieved from a database.
The lookup has the following options:
AutoPostBack
A Boolean value that specifies whether the page must automatically refresh when this field loses focus.
Enabled
A Boolean value that specifies whether this field is enabled or disabled.
Style
This option allows you to use any CSS instruction/s to determine what the field looks like and how it acts.
For example: "text-align: center;"
Visible
A Boolean value that specifies whether this field is visible or not.
Width
Specify the width, in pixels, of this object.
The reference label field is displayed as a dynamic value on the activity screen. The user can't change this value.
It is typically used to display the date, the user's name, and other dynamic values that you don't want the user to change.
The reference label has the following options:
Style
This option allows you to use any CSS instruction/s to determine what the object looks like and how it acts.
For example: "text-align: center;"
Visible
A Boolean value that specifies whether this field is visible or not.
Width
Specify the width, in pixels, of this field. This is used when you want to align the text in the label using the Style option.
The simple text box field is displayed as a standard Windows textbox.
The textbox has the following options:
AutoPostBack
A Boolean value that specifies whether the page must automatically refresh when this field loses focus.
MaxLength
Specify the maximum number of characters that the user can input in this field.
ReadOnly
A Boolean value that specifies whether the field is read-only.
Style
This option allows you to use any CSS instruction/s to determine what the field looks like and how it acts.
For example: "text-align: center;"
Visible
A Boolean value that specifies whether this field is visible or not.
Width
Specify the width, in pixels, of this field.
The large textbox field is displayed as a comments box or multi-line text box on the activity screen.
The large textbox has the following options:
AutoPostBack
A Boolean value that specifies whether the page must automatically refresh when this field loses focus.
Height
Specify the height, in pixels, of this field.
ReadOnly
A Boolean value that specifies whether the field is read-only.
Style
This option allows you to use any CSS instruction/s to determine what the field looks like and how it acts.
For example: "text-align: center;"
Visible
A Boolean value that specifies whether this field is visible or not.
Width
Specify the width, in pixels, of this field.
The hyperlink field provides a hyperlink on the activity screen.
It is typically used as links to open reports, or links to related documents such as policy and procedure documents.
The hyperlink has the following options:
Enabled
A Boolean value that specifies whether this field is enabled or disabled.
ImageUrl
The image to use as the link.
If ImageURL and NavigateURL are set, ImageURL will override NavigateURL
NavigateUrl
The URL that the link must open.
If ImageURL and NavigateURL are set, ImageURL will override NavigateURL.
Style
This option allows you to use any CSS instruction/s to determine what the field looks like and how it acts.
For example: "text-align: center;"
Target
The target window in which the link must open.
Options are:
blank - opens the link in the new browser window. This is the default value for this property.
_parent- opens the link in the same browser window.
Text
The text to use as the link.
Visible
A Boolean value that specifies whether this field is visible or not.
The file attachment field allows the user to attach documents to the process. It is displayed as a text box with a Browse button next to it. If the user clicks on Browse, it allows the user to navigate their hard drive.
The hyperlink has the following options:
Location
The location of where the file will be stored.
Style
This option allows you to use any CSS instruction/s to determine what the field looks like and how it acts.
For example: "text-align: center;"
Upload File To
Type of file field you want to upload. SharePoint or XMPro
Text
The text to use as the link.
Visible
A Boolean value that specifies whether this field is visible or not.
The team select field allows the user to choose the role group to which a later activity must be routed. It is displayed as a combo box.
For the field to work, you need to make sure that the items in the team select are exactly the same as existing role groups. Then you can use this field as the Creation Value when choosing Dynamic Group as the Creation Type.
The hyperlink has the following options:
AutoPostBack
A Boolean value that specifies whether the page must automatically refresh when this field loses focus
Enabled
A Boolean value that specifies whether this field is enabled or disabled.
Items
Clicking on the options button ( ) in this property will open the Specify Items window. In this window, you can add, remove, or change the entries in the team select's list.
Style
This option allows you to use any CSS instruction/s to determine what the field looks like and how it acts.
For example: "text-align: center;"
Visible
A Boolean value that specifies whether this field is visible or not.
Width
Specify the width, in pixels, of this field.
The command option field is responsible for calling the next activity. All activities must have at least one command option.
If an activity only has one command option, it is displayed as a checkbox with a Submit and a Reset button. If an activity has more than one command option, they are displayed as radio buttons with a Submit and a Reset button.
The command option does not have any options.
The available options depend on the field's type. See below for details for each control.
Dropdown list item displayed:
Lookup items displayed:
