DataSplice Releases Mobile Integration Suite 3.0
Event Chain Settings
In direct response to certain events that users can initiate on the Remote Client, DataSplice can be configured to respond by initiating a series of pre-defined actions. Within each of the event chains, any number of actions can be added to create the desired string of actions. This type of functionality is configured by selecting Event Chain Settings from the Configuration Section drop-down list on the View Configuration screen.
There is no limit to the number of actions that can be defined. Actions can be generated based on the following user events.
Server-side Events
- Query - Executes when a user retrieves a record from the data source (this is a server-side event if the user is connected to the DataSplice Server at the time the query is performed).
- Insert - Executes when a user saves a newly-created record.
- Update - Executes when a user saves a record update.
- Delete - Executes when a user deletes a record from the system.
Client-side Events
- Query - Executes when a user retrieves a record from the data source (this is a client-side event if the user is working offline at the time the query is performed).
- Create Record - Executes as soon as a user starts a new record (before it is even saved).
- Verify Record - Executes when a user moves off of a record.
- Mark Record for Delete - Executes when a record is marked for deletion (before it is even saved).
- Navigate Query - Executes when a user selects an entry from the navigation menu, or if a lookup list for a field is clicked and that lookup uses a query to populate its dataset.
Basic Actions
Basic actions are used to define the desired behavior in the specified event chain.
Supported Basic Actions
For the most part, each of the event chains supports the same basic actions. However, there are a few exceptions. The following matrix displays the basic actions that are supported for each event chain.
X = Supported Basic Action
| Basic Actions | Query | Insert | Update | Delete | Create Record | Verify Record | Mark Record for Delete | Navigate Query |
|---|---|---|---|---|---|---|---|---|
| Abort Event Chain | X | X | X | X | X | X | X | X |
| Call Plug-in Function | X | X | X | X | ||||
| Check Filter | X | |||||||
| Create Error | X | X | X | X | X | X | X | X |
| Default Action | X | X | X | X | X | X | X | X |
| Modify Attributes | X | X | X | X | X | X | X | X |
| Modify Filter | X |
Error Actions
Each of the event chains has its own set of error actions that can be defined. The error actions of an event chain are executed if any of the basic actions fail.
Supported Error Actions
The available error actions are the same for each type of event chain, as shown in the following matrix.
X = Supported Error Action
| Error Actions | Query | Insert | Update | Delete | Create Record | Verify Record | Mark Record for Delete | Navigate Query |
|---|---|---|---|---|---|---|---|---|
| Abort Event Chain | X | X | X | X | X | X | X | X |
| Call Plug-in Function | X | X | X | X | ||||
| Modify Attributes | X | X | X | X | X | X | X | X |
Abort Event Chain
This action causes the current event chain processing to stop if the specified action condition is met. The Event Details section for this action provides the following configuration areas:
| Option Name | Description |
|---|---|
| Action Condition | A Boolean expression that, when evaluated to true or blank, will perform said action. |
| Continue on Failure | Checkbox to specify if the action should continue processing if an error occurs during its execution. |
| Action Description | Free-form field that allows administrators to keep notes describing this action. |
Call Plug-in Function
This action invokes an available plug-in. This may be used for initiating such tasks as automatic email generation or server-initiated barcode printing. The Event Details section for this action provides the following configuration areas:
| Option Name | Description |
|---|---|
| Provider | The function provider used for the current event action. |
| Function Group | Specifies which group of functions to access. |
| Function Name | The name of the function to bind to the current event action. |
| Action Condition | A Boolean expression that, when evaluated to true or blank, will perform said action. |
| Continue on Failure | Checkbox to specify if the action should continue processing if an error occurs during its execution. |
| Action Description | Free-form field that allows administrators to keep notes describing this action. |
The Parameter Bindings section contains the parameters that will be passed to this plug-in function. This section contains the following fields:
| Column Name | Description |
|---|---|
| Parameter Name | Name of the particular parameter. |
| Parameter Value | Corresponding value of the parameter. |
| Parameter Type | Associated type of the parameter. |
| Parameter Description | Brief description of the parameter. |
Check Filter
This action provides the ability to force a user to enter values in all filter fields, or just at least one of the fields. The Event Details section for this action provides the following configuration areas:
| Option Name | Description |
|---|---|
| Require All Fields | When checked, all listed field names require a supplied value; otherwise the user must supply a value for at least one of the listed fields. |
| Action Condition | A Boolean expression that, when evaluated to true or blank, will perform said action. |
| Continue on Failure | Checkbox to specify if the action should continue processing if an error occurs during its execution. |
| Action Description | Free-form field that allows administrators to keep notes describing this action. |
The Field Names section allows for a list of fields to be entered that are required when the Require all Fields box is checked.
Create Error
This action provides the ability to enforce client-side field validation. The conditions defined are verified before the processing can continue to the server-side processing. If the conditions are not met successfully, the user is presented with the specified error message, providing useful information to resolve the problem and attempt the action again. The Event Details section for this action provides the following configuration areas:
| Option Name | Description |
|---|---|
| Error Message | Specifies the error message that will be displayed to the user if this action is triggered. |
| Error Field | If set, the client will indicate to the user that this field caused the error. |
| Skip Error Chain | Checkbox that causes the event handler to not process the error chain if this action is triggered. |
| Action Condition | A Boolean expression that, when evaluated to true or blank, will perform said action. |
| Continue on Failure | Checkbox to specify if the action should continue processing if an error occurs during its execution. |
| Action Description | Free-form field that allows administrators to keep notes describing this action. |
Default Action
This action will take place by default for each of the event chains. Server-side default actions are performed by the data source that created the view (i.e., the ADO.NET Data Source Plug-in performs the action for standard views, while the Default Plug-in performs the action for virtual views). The Event Details section for this action provides the following configuration areas:
| Option Name | Description |
|---|---|
| Action Condition | A Boolean expression that, when evaluated to true or blank, will perform said action. |
| Continue on Failure | Checkbox to specify if the action should continue processing if an error occurs during its execution. |
| Action Description | Free-form field that allows administrators to keep notes describing this action. |
The effects of the default action vary across each of the different event chains:
- Query - For database plug-in views, this action executes a SQL
SELECTstatement. For virtual views, this only performs an action if the view also has the Display Virtual Record option checked. The default action is required for the query event chain. If it is removed, an error will be received when a query is performed. If a modify filter action is being used, it should be placed ahead of the default action. - Insert - For database plug-in views, this action executes a SQL
INSERTstatement if the view is of a single table. It will generate an error if the DataSplice view is a join of multiple database tables. For virtual views, this action will generate an error. The default action for this event chain is optional. Oftentimes, inserts are performed by calling stored procedures or Java/.NET functions through another plug-in. - Update - For database plug-in views, this action executes a SQL
UPDATEstatement if the view is of a single table. It will generate an error if the DataSplice view is a join of multiple database tables. For virtual views, this action will generate an error. The default action for this event chain is optional. Oftentimes, updates are performed by calling stored procedures or Java/.NET functions through another plug-in. - Delete - For database plug-in views, this action executes a SQL
DELETEstatement if the view is of a single table. It will generate an error if the DataSplice view is a join of multiple database tables. For virtual views, this action will generate an error. The default action for this event chain is optional. Oftentimes, deletes are performed by calling stored procedures or Java/.NET functions through another plug-in. - Create Record - The default action for this event chain creates a new record.
- Verify Record - The default action for this event chain checks the AllowNull field settings and reports errors for fields that cannot be null but are.
- Mark Record for Delete - The default action for this event chain marks the current record for deletion (the delete process is not complete until the Save Changes button is pressed).
- Navigate Query - The default action for this event chain performs the selected query.
Modify Attributes
This action allows for DataSplice attribute values to be manipulated as desired during the event chain processing. The Event Details section for this action provides the following configuration areas:
| Option Name | Description |
|---|---|
| Modify Session Attributes | Checkbox that causes the attribute modifications to be stored with the current session and persist until the session is closed. |
| Action Condition | A Boolean expression that, when evaluated to true or blank, will perform said action. |
| Continue on Failure | Checkbox to specify if the action should continue processing if an error occurs during its execution. |
| Action Description | Free-form field that allows administrators to keep notes describing this action. |
The Attribute Collection section allows for session attribute values to be altered from their existing values.
Modify Filter
This action allows for filter fields to be manipulated as desired during the event chain processing. The Event Details section for this action provides the following configuration areas:
| Option Name | Description |
|---|---|
| Replace User Filter | Checkbox that causes the user's filter to be replaced with the one specified in the Filter section below. |
| Action Condition | A Boolean expression that, when evaluated to true or blank, will perform said action. |
| Continue on Failure | Checkbox to specify if the action should continue processing if an error occurs during its execution. |
| Action Description | Free-form field that allows administrators to keep notes describing this action. |
The Filters section for this action allows for a new filter to be created that will replace the existing user filter. For a detailed explanation of creating filters, see the filters section of this document.
Last modified 2007-02-07 12:11 PM
