Business Events

The display name of the action to be used for the corresponding command on the More menu of the generic inquiry form (in the Actions category).

The box appears on the form only if the Trigger by Action option is selected in the Type box.

A check box that you select to indicate that the system should display two commands on the More menu of the generic inquiry form (in the Actions category): <Action Name> and <Action Name> (All).

If you clear this check box, only the <Action Name> command that corresponds to the action will be displayed.

The check box appears on the form only if the Trigger by Action option is selected in the Type box and a generic inquiry is selected in the Screen Name box.

• For Each Record: For each record that satisfies the condition, the system raises a business event and executes the subscribers of the business event.
• Once for All Records: The system raises one business event for all records that satisfy the conditions and executes each subscriber once for all records of the business event.
• For Group of Records: For each generic inquiry field that is selected for the grouping in the Group Records By box, the system raises an event for each group of records. If this option is selected, a separate event will be raised for each group of records with the same value of the specified field.

  If this option is selected, the Group Records By box and Use Previous Value check box become available.

The field by which records are grouped. This box contains a list of all internal fields of the generic inquiry in the <Table Name>.<Field Name> format, including formula fields.

The box becomes available if the For Group of Records option is selected in the Raise Event box.

Required. The name of the inquiry form or data entry form that defines the data the system should monitor to detect whether this business event has occurred. The inquiry form can be any generic inquiry that does not have grouping specified on the Grouping tab of the Generic Inquiry (SM208000) form.

For business events of the Triggered by Record Change type, the system displays a warning for this box if any of the following is true:

• The generic inquiry contains grouping fields.
• Some of the key fields of the DACs used in the generic inquiry are not added to the Results Grid tab of the Generic Inquiry (SM208000) form.
• The unbound fields of the generic inquiry (that is, fields that are not kept in the database) are used in trigger conditions.

A read-only box that displays the identifier of the inquiry form or data entry form that defines the data the system should monitor to detect whether this business event has occurred.

The system fills in this box automatically when you select a value in the Screen Name box.

The shared filter that the system should apply to the records retrieved by the generic inquiry selected in the Screen Name box. The shared filter can be any of the filters that are listed for the generic inquiry on the Filters (CS209010) form.

By default, All Records is selected, which means that no shared filter is applied to the records.

This box appears on the form only if Trigger by Record Change is selected in the Type box.

For details on shared filters, see Advanced Filters: General Information.

A button that you can click to open the Inquiry Parameters dialog box, where you can specify the values of the parameters to be used for the inquiry selected in the Screen Name box.

By default, the system runs the inquiry with the default values of the parameters.

The button appears on the form only if Trigger by Record Change is selected in the Type box and is available only if the inquiry selected in the Screen Name box has parameters.

The parameter value that should be used by the system for retrieving data for this business event.

The box initially contains the default value (if any) of the parameter, but you can override this value.

If you change the value in a row of this column, the system clears the Use Default Value check box in this row. You can select the check box to discard the new value and cause the default value to be inserted in this column again.

A check box that indicates (if selected) that the default value of the parameter is used by the system for retrieving data for this business event.

By default, this check box is selected; the system clears this check box if you change the value in the Value column.

The check box is available only if it is cleared. If you select this check box, the value specified in the Value column is discarded and the default value is used instead.

The operation that defines how the data should have been changed for the condition to be met. The operation can be applied to any of the following:

• The results of the generic inquiry or a record on a data entry form before the data change (the old field values)
• The results of the generic inquiry or a record on a data entry form after the data has been changed (the new field values)
• The change of the data (this applies when a field value is changed or when a record is added, removed, or updated)

The operation can be one of the following:

• Field Changed: The value of the field in the results of the generic inquiry or the record on the data entry form has been changed in any way. If you select this operation, you specify the table to which the field belongs and the field in the Table Name and Field Name columns, respectively.
• Field Value Increased: The value of the field in the results of the generic inquiry or the record on the data entry form has been increased. If you select this operation, you specify the table to which the field belongs and the field in the Table Name and Field Name columns, respectively. This operation can be used only for fields with numeric types.
• Field Value Decreased: The value of the field in the results of the generic inquiry or the record on the data entry form has been decreased. If you select this operation, you specify the table to which the field belongs and the field in the Table Name and Field Name columns, respectively. This operation can be used only for fields with numeric types.
• New Field Value: The value of the field is checked in the results of the generic inquiry or the record on the data entry form after the data has been changed. If you select this operation, you specify the table to which the field belongs and the field in the Table Name and Field Name columns, respectively. You also specify a condition on the new field value by using the Condition and Value 1 (and Value 2 if Condition is Is Between) columns.
• Old Field Value: The value of the field is checked in the results of the generic inquiry or the record on the data entry form before the data change. If you select this operation, you specify the table to which the field belongs and the field in the Table Name and Field Name columns, respectively. You also specify a condition on the new field value by using the Condition and Value 1 (and Value 2 if Condition is Is Between) columns.
• Record Inserted: A new record has appeared in the inquiry results.
  Attention:

  If the Record Inserted or Record Deleted operation is used in a trigger condition of a business event, you need to add to the list on the Fields to Track tab all fields whose change can lead to the appearance or disappearance of rows in the inquiry results. That is, you need to add the following fields:

  • If the generic inquiry has conditions, every field mentioned in the conditions
  • If the generic inquiry has joins, the fields of the joins
  • The key fields of the DACs
• Record Deleted: A record has been removed in the inquiry results.
  Attention:

  For information on which fields to add to the list on the Fields to Track tab, see the note for the Record Inserted operation.
• Record Changed (Tracked Fields): A record has been changed in the inquiry results.
  Note:

  If the Record Changed (Tracked Fields) operation is used in a trigger condition, a business event occurs only if any field listed on the Fields to Track tab changes.

This column appears only if the selected option in the Type box of the Summary area is Trigger by Record Change.

The table that contains the record whose changes the system should monitor. The table can be any of the tables included in the generic inquiry or the primary view of the data entry form that is specified in the Screen Name box in the Summary area.

If the selected option in the Type box of the Summary area is Trigger by Record Change, you select a table name in this column only if the selected Operation is any of the following: Field Changed, Field Value Increased, Field Value Decreased, New Field Value, or Old Field Value.

The field (in the table specified in Table Name) whose changes the system should monitor.

If the selected option in the Type box of the Summary area is Trigger by Schedule or if the selected Operation is Field Changed, New Field Value, or Old Field Value, the field can be any of the fields included in the results table of the inquiry that is defined in the Screen Name box in the Summary area. If the selected Operation is Field Value Increased or Field Value Decreased, only the fields of the results table with numeric types are available.

If the selected option in the Type box of the Summary area is Trigger by Record Change, you select a field in this column only if the specified Operation is any of the following: Field Changed, Field Value Increased, Field Value Decreased, New Field Value, or Old Field Value.

You can also use the Formula Editor and specify formulas if you need the system to compare the values of different boxes and determine whether a business event should be triggered.

The logical operation that applies to the value of the selected field.

The following options are available:

• Equals: Returns TRUE if the value of the specified field is equal to the value specified in the Value 1 column.
• Does Not Equal: Returns TRUE if the value of the specified field is not equal to the value specified in the Value 1 column.
• Is Greater Than: Returns TRUE if the value of the specified field is greater than the value specified in the Value 1 column.
• Is Greater Than or Equal To: Returns TRUE if the value of the specified field is greater than or equal to the value specified in the Value 1 column.
• Is Less Than: Returns TRUE if the value of the specified field is less than the value specified in the Value 1 column.
• Is Less Than or Equal To: Returns TRUE if the value of the specified field is less than or equal to the value specified in the Value 1 column.
• Contains (for fields of the string type): Returns TRUE if the value of the specified field (a string) contains the value specified in the Value 1 column.
• Starts With (for a field of the string type): Returns TRUE if the value of the specified field (a string) contains at the beginning the value specified in the Value 1 column.
• Ends With (for a field of the string type): Returns TRUE if the value of the specified field (a string) ends with the same character or string as the value specified in the Value 1 column contains.
• Does Not Contain (for a field of the string type): Returns TRUE if the value of the specified field (a string) does not contain the value specified in the Value 1 column.
• Is Between: Returns TRUE if the value of the specified field is greater than the value specified in the Value 1 column and less than the value specified in the Value 2 column.
• Is Empty: Returns TRUE if the value of the specified field is empty (null).
• Is Not Empty: Returns TRUE if the value of the specified field is not empty (not null).
• Is In (for a field of the user type): Returns TRUE if the value of the specified field (a user) is included in the workgroup specified in the Value 1 column. You can select this option for the @MyGroups and @MyWorktree parameters specified in Value 1.
• Is Not In (for the fields of the user type): Returns TRUE if the value of the specified field (a user) is not included in the workgroup specified in the Value 1 column. You can select this option for the @MyGroups and @MyWorktree parameters specified in Value 1.

You select a condition in this column if the value of the Operation column is New Field Value or Old Field Value or if the selected option in the Type box of the Summary area is Trigger by Schedule. In other cases, the column is empty and unavailable.

A check box that indicates (if selected) that the value can be selected from the predefined values of the field selected in the Field Name column. If a field is selected in the Field Name column and you select the From Schema check box, then in the Value 1 and Value 2 columns, a lookup box, drop-down list, or check box (depending on the control type of the selected schema field) is displayed.

The value for the logical condition used to filter the data. For date-relative and user-relative values, you can use the parameters (such as @today or @MyGroup) that are described in Advanced Filters: General Information.

You can also use the Formula Editor and specify formulas if you need the system to compare the values of different boxes and determine whether a business event should be triggered. The Formula Editor is available if the From Schema check box is cleared.

The second value for the logical condition used to filter the data.

You specify a value in this column only if the value of the Condition column is Is Between.

You can also use the Formula Editor and specify formulas if you need the system to compare the values of different boxes and determine whether a business event should be triggered. The Formula Editor is available if the From Schema check box is cleared.

Provides the following menu commands, which you can click to create a subscriber of a specific type.

You click one of the following menu commands to create the subscriber of the corresponding type:

• Import Scenario: When you click this menu command, the system opens the Create Import Scenario dialog box, where you specify the name of a new import scenario and click OK. The system then creates a data provider of the Business Process Provider type (if the provider has not been created earlier for the generic inquiry of the business event), links this provider to the generic inquiry of the business event, and opens the Import Scenarios (SM206025) form with the import scenario name and provider specified. On this form, you complete the creation of the import scenario. Once you have specified the settings of the import scenario, saved your changes, and closed the form, the system adds a row for the subscriber to this tab.
  Tip:

  You can add to a business event only an import scenario with a data provider that has the Business Process Provider type and that uses the same generic inquiry as the business event uses.
• Task: When you click this menu command, the system opens the Task Templates (SM204005) form, where you can create a template for tasks. Once you have specified the settings of the task template, saved your changes, and closed the form, the system adds a row for the subscriber to this tab.
• Email Notification: When you click this menu command, the system opens the Email Templates (SM204003) form, where you can create a template for email notifications. Once you have specified the settings of the notification template, saved your changes, and closed the form, the system adds a row for the subscriber to this tab.
• Mobile Push Notification: When you click this menu command, the system opens the Mobile Notifications (SM204004) form with the Push option selected in the Delivery Method box. On this form, you can create a template for mobile push notifications. Once you have specified the settings of the notification template, saved your changes, and closed the form, the system adds a row for the subscriber to this tab.
• Mobile SMS Notification: When you click this menu command, the system opens the Mobile Notifications (SM204004) form with the SMS option selected in the Delivery Method box. On this form, you can create a template for mobile text notification. Once you have specified the settings of the notification template, saved your changes, and closed the form, the system adds a row for the subscriber to this tab.

The type of the subscriber.

The following types are available:

• Email Notification: A notification template that the system uses to send emails if the business event has occurred
• Mobile Push Notification: A notification template that the system uses to send push notifications if the business event occurred
• Mobile SMS Notification: A notification template that the system uses to send mobile text messages if the business event occurred
• Import Scenario: An import scenario that uses a data provider of the Business Process Provider type and that defines the sequence of instructions for the system to perform if the business event has occurred

If you create a subscriber from this tab, when you save your changes on the applicable form and close the form, the system adds a row for the subscriber and fills in the type. If you add a subscriber that has already been created, you select the type manually.

The identifier of the subscriber. For details about what is used as the identifier for a particular subscriber, see Actions to Perform on Event Occurrence (Event Subscribers).

If you create a subscriber from this tab, when you save your changes on the applicable form and close the form, the system fills in the ID. If you are adding a subscriber that has already been defined in the system, you select the subscriber in this column.

For details about subscribers of business events, see Business Events: Subscribers.

A check box that indicates (if selected) that the system should not process subsequent subscribers if an error has occurred for this subscriber. If the check box is cleared (the default setting), the system processes subsequent subscribers of this event regardless of any error for the current subscriber. The subscribers are processed in the order in which they are defined on this tab.

If the check box is selected, the system considers the subscriber to be mandatory. That is, if the subscriber has not been processed successfully, on the Business Event History (SM502030) form, the system displays an error for the subscriber and for the business event.

If the check box is cleared, the system considers the subscriber to be optional. That is, if the subscriber has not been processed successfully, on the Business Event History (SM502030) form, the system displays a warning for the subscriber and for the business event.

The name of the field from the selected table.

If a generic inquiry is specified in the Screen Name box of the form, the system offers for selection only the data fields that were added to the Results Grid tab of the on the Generic Inquiry (SM208000) form.