Field and button actions
Field actions are triggered when the IBM TRIRIGA Application Platform detects that a user has finished changing the value in a field. Button actions are triggered when a user clicks a button. To create a new field action, select a field in the Navigation panel. Scroll to the bottom of the field's properties, and click Add in the Actions section. To create a new button action, add a new Form Action field, as described in "Buttons" and save the button. Now scroll to the bottom of the properties, and click Add in the Actions section. The way to set up field and button actions is very similar.
For both a field action and a button action, the value of the Label property is read-only. For a field action the value of the Label property is always onChange. For a button action the value of the Label property is always onClick. That is the only difference in the setup for the two kinds of actions.
Here are the things that you can arrange for in a response to a field or button action:
- You can arrange for a window to pop up with the results of a query. This will allow the user to select records that correspond to query results.
- You can arrange for a workflow to run. If you also had the query pop up in a window, the workflow can be aware of which records were selected in the query.
- You can arrange for a record to be created and a form to pop up so the person using the form can edit the new record.
- Popup Module
The value of this property is the name of the module that contains the query to be run. The drop-down list for this property contains the names of all modules in the IBM TRIRIGA Application Platform environment.
If no value is specified for this property, no query will be run.
- Popup Query
The value of this property is the name of the query to be run. If no value is specified for this property, no query will be run.
The drop-down list in this property contains the names of queries and reports in the module specified by the value of the Popup Module property.
The name of this property is a hyperlink. Click the name of this property to view or edit the definition of the selected query or report.
- Single Record Select
If the check box in this property is checked, the person using the form will only be able to pick one of the query results.
If the check box in this property is not checked, the person using the form will be able to pick any number of query results.
- Workflow
The value of this property is the name of a synchronous workflow that will run after the person using the form is finished selecting query results. If no query is run, the workflow is run immediately.
The workflow is able to navigate from the record being edited by this form to the records that correspond to selected query results by using the association specified by the Association property.
If this property does not have a value, no workflow will run after the newly created record has been edited.
The drop-down list for this property contains the names of synchronous workflows associated with the business object associated with this form. The workflow you select from this list is the workflow that will run when this action is triggered.
The name of this property is a hyperlink. Clicking the name of this property opens the definition of the selected workflow.
- Association
The value of this property is the name of an association that may be created by this action. If a query is specified and a user selects some of the query results, an association with the specified name is created from the record being edited by this form to the records that correspond to the selected query results. The workflow that runs after the query results are selected can use the association to retrieve the selected records.
If it is specified that this action will create a record, an association with the specified name is created from the record being edited by this form to the newly created record. The workflows specified by the Pre Form Workflow property or the Post Form Workflow property can use this association to navigate from the record being edited by this form to the newly created record.
The names in this property's drop-down list are the names in the List Manager's Association Types list.
- Permanent Association
If the check box for this property is not checked, the associations created by this action are considered temporary. If the associations are temporary, they are automatically deleted after the workflows have finished.
If the check box for this property is checked, the associations created by this action are considered permanent and are not automatically deleted.
- Save On Form Popup
If the check box for this property is not checked, the underlying parent record is not saved after the popup renders.
If the check box for this property is checked, the system saves the underlying parent record data as soon as the popup is rendered.
- Popup Form Module
- The value of this property is the name of the module that contains the form to use for editing records that will be created by this action. The drop-down list for this property contains the names of all the modules in the IBM TRIRIGA Application Platform environment.
- Popup Form
The value of this property is the name of the form to use for editing records that will be created by this action. This also determines the type of record created by this action. The business object used by this action to create records will be the business object associated with the form named by this property.
The drop-down list in this property contains the names of forms in the module specified by the value of the Popup Module property.
- Pre Form Workflow
The value of this property is the name of a synchronous workflow that will be run before the window pops up that allows the user to edit the record created by this action. The Pre Form workflow runs after the record is physically created.
The workflow is able to navigate from the record being edited by this form to the newly created record by using the association specified by the Association property.
If this property does not have a value, no workflow will be run before the window pops up.
The drop-down list for this property contains the names of synchronous workflows associated with the business object associated with the form selected in the Popup Form property. The workflow you select from this list is the workflow that will run when this action is triggered. The selected workflow will run instead of the workflow defined for the business object as the Pre-Create Workflow property in Data Modeler. Pre-Create workflows are discussed in "Viewing business object properties".
The name of this property is a hyperlink. Click the name of this property to view or edit the definition of the selected workflow.
- Post Form Workflow
The value of this property is the name of a synchronous workflow that will run after the person using the form is finished editing the record this action created. More precisely, this workflow is run after the person editing the newly created record initiates an action that changes the state of the newly created record to a state other than null and the user closes the window he was using to edit the record.
The workflow is able to navigate from the record being edited by this form to the newly created record by using the association specified by the Association property.
If this property does not have a value, no workflow will run after the newly created record has been edited. If no value is specified for the Popup Form property, no record will be created and the workflow specified by this property will not run.
The drop-down list for this property contains the names of synchronous workflows associated with the business object associated with this form. The workflow you select from this list is the workflow that will run when this action is triggered.
The name of this property is a hyperlink. Click the name of this property to view or edit the definition of the selected workflow.