1. Configuring Siebel Open UI Guide
  2. Summary of Notifications That Siebel Open UI Supports

Summary of Notifications That Siebel Open UI Supports

The following table describes the notification types that Siebel Open UI supports. For more information, see New Notification User Interfaces.

Notification Type Description

NotifyBeginNotifys

SWE_PROP_BC_NOTI_BEGIN

Notifies the client business component that the request that Siebel Open UI sent to the Siebel Server resulted in at least one notification from a business component.

NotifyStateChanged

SWE_PROP_BC_NOTI

_STATE_CHANGED

Specifies a top-level notification for more than one state change that occurs in the business component level. Siebel Open UI uses the following properties to identify the change and to get the data associated with the change:

  • state

  • value

Siebel Open UI can provide summary or detailed state information. For more information, see NotifyStateChanged Notification Type.

NotifyGeneric

SWE_PROP_BC_NOTI_GENERIC

Identifies the predefined and custom notifications that the Siebel application must send. Siebel Open UI addresses most predefined generic notifications to a particular applet.

You can use NotifyGeneric to get the exact type for a generic notification. Siebel Open UI provides actual information of the changes as an encoded argument set.

NotifyNewSelection

SWE_PROP_NOTI_SELECTED

Notifies the client business component that a change occurred in the selection status. Siebel Open UI calls NotifyNewSelection two times for each selection status change:

  • One time a value of false for the last row selected

  • One time with a value of true for the new row that Siebel Open UI is selecting

You cannot use NotifyNewSelection with a multi-select.

You can use the following syntax in the property set that Siebel Open UI sends: 

SWE_PROP_BC_NOTI_ACTIVE_ROW = index 
SWE_PROP_NOTI_SELECTED = Boolean

where:

  • index identifies the index of the row that Siebel Open UI is activating or deactivating.

  • Boolean is true or false.

NotifyNewActiveRow

SWE_PROP_BC_NOTI_

NEW_ACTIVE_ROW

Notifies the client business component that a change occurred on an active row of the corresponding business component on the Siebel Server. Siebel Open UI usually uses NotifyNewSelection with NotifyNewActiveRow.

You can use the following syntax: 

SWE_PROP_BC_NOTI_ACTIVE_ROW = row

where:

  • row identifies the row that Siebel Open UI is activating or deactivating.

NotifyDeleteRecord

SWE_PROP_BC_NOTI

_DELETE_RECORD

Notifies the business component in the client that Siebel Open UI deleted a record from the current set of records on the Siebel Server. Siebel Open UI might use this notification two times for a single record deletion.

You can use the following syntax in the property set that Siebel Open UI sends: 

SWE_PROP_BC_NOTI_ACTIVE_ROW = index 
bUp = Boolean

where:

  • index identifies the index of a record that resides in the current set of records that Siebel Open UI is deleting.

  • Boolean is one of the following values:

  • true. Shift records up after the delete.

  • false. Shift records down after the delete.

For an example usage of this notification, see Customizing the Presentation Model to Handle Notifications.

NotifyDeleteRecordSet

SWE_PROP_BC_NOTI

_DELETE_WORKSET

Notifies the business component in the client that Siebel Open UI is deleting a record from the current set of records in the client. Does not correspond to a method invoke. Siebel Open UI sends a separate notification for each record that it deletes.

You can use the following syntax in the property set that Siebel Open UI sends:

index:index 
NumRows/nr:number

where:

  • index identifies the start index of the record that Siebel Open UI is deleting.

  • number identifies the number of rows that Siebel Open UI must delete.

For more information, see Using Notifications with Operations That Call Methods.

NotifyInsertWorkSet

SWE_PROP_BC_NOT

I_INSERT_WORKSET

Notifies the business component in the client that Siebel Open UI is inserting a new record in the current set of records in the client.

You can use the following syntax in the property set that Siebel Open UI sends: 

index:index_value  
SWE_FIELD_VALUE_STR:child  
SWE_PROP_VALUE_ARRAY:array

where:

  • index identifies the index of the record that Siebel Open UI is inserting.

  • child identifies the child property set that contains the record data.

  • array is an array that contains the field values of the record that Siebel Open UI is inserting. This array must use the same sequence that the business component uses when it lists these field values.

For more information, see Using Notifications with Operations That Call Methods.

NotifyNewData

SWE_PROP_BC

_NOTI_NEW_DATA

Notifies the business component in the client that Siebel Open UI is modifying the current set of records. Siebel Open UI sends this notification only if it modifies a record. It does not send this notification if it only modifies a field value.

NotifyNewPrimary

SWE_PROP_BC_

NOTI_NEW_PRIMARY

Sets the primary record in a multi-value group. The RepopulateField notification calls NotifyNewPrimary.

NotifyNewRecord

SWE_PROP_BC_

NOTI_NEW_RECORD

Notifies the client business component that Siebel Open UI is creating a new record in the current set of records on the Siebel Server. You can use the following syntax in the property set that Siebel Open UI sends: 

SWE_PROP_BC_NOTI_ACTIVE_ROW = index 
bInsertBefore = Boolean

where:

  • row identifies the index of the record that Siebel Open UI is creating.

  • Boolean is one of the following values:

  • true. Place the new record before the previous active row.

  • false. Place the new record after the previous active row.

For a similar usage of this notification, see Customizing the Presentation Model to Handle Notifications.

NotifyNewRecordData

SWE_PROP_BC_NOTI_

NEW_RECORD_DATA

Sets the do populate flag.

NotifyNewDataWorkSet

SWE_PROP_BC

_NOTI_NEW

_RECORD_DATA_WS

Updates a record in the current set of records.

NotifyNewFieldData

SWE_PROP_BC_NOTI_

NEW_FIELD_DATA

Notifies the client business component that Siebel Open UI modified a field value on the Siebel Server, and that Siebel Open UI communicated this modification to the client through the NotifyNewDataWorkset notification.

You can use the following syntax in the property set that Siebel Open UI sends: 

SWE_PROP_NOTI_FIELD = field

where:

  • field identifies the name of the field that Siebel Open UI is modifying.

NotifyNewDataWorkset

SWE_PROP_BC_NOTI_

NEW_DATA_WS

Notifies the client business component of a field value that Siebel Open UI modified for a field that resides on the Siebel Server.

You can use the following syntax in the property set that Siebel Open UI sends: 

SWE_PROP_NOTI_FIELD = field    
SWE_PROP_FIELD_VALUES = child

where:

  • field identifies the name of the field that Siebel Open UI is modifying.

  • child identifies the name of the child property set that contains the modification details.

You can use the following syntax in the child property set: 

SWE_PROP_FIELD_ARRAY:string1
SWE_PROP_VALUE_ARRAY:string2

where:

  • string1 is an encoded string that identifies the field index.

  • string2 is an encoded string that identifies the field value.

NotifyNewFieldList

SWE_PROP_BC_

NOTI_NEW_FIELD_LIST

Refreshes the entire view internally.

NotifyNewRecordDataWS

SWE_PROP_BC_NOTI_

NEW_RECORD_DATA_WS

Updates the values in the record set. Siebel Open UI updates the dirty flag during previous notifications.

NotifyChangeSelection

SWE_PROP_BC_

NOTI_CHANGE_SELECTION

Sets the update conditionals flag and the row counter.

NotifyEndNotifys

SWE_PROP

_BC_NOTI_END

Notifies the client business component that Siebel Open UI is ending the notification, and that no more server notifications exist for the current transaction.

NotifyBeginQuery

SWE_PROP_BC

_NOTI_BEGIN_QUERY

Notifies the client business component that Siebel Open UI started a query on the business component on the Siebel Server.

NotifyNewQuerySpec

SWE_PROP_BC_

NOTI_NEW_QUERYSPEC

Siebel Open UI uses the NotifyNewQuerySpec notification if the user refines a query. If the business component search specification is empty, then NotifyNewQuerySpec clears all field search specifications.

NotifyNewFieldQuerySpec

SWE_PROP_BC_NOTI_

NEW_FIELD_QUERYSPEC

Notifies the client business component that Siebel Open UI is doing one of the following to query the fields of the current business component on the Siebel Server:

  • Using a default query specification

  • Starting or running a query

This situation can occur through a predefined or custom configuration, or in reply to a query that the user performs.

You can use the following syntax in the property set that Siebel Open UI sends: 

SWE_PROP_NOTI_FIELD = 
fieldSWE_PROP_VALUE = search 
specification"

where:

  • field identifies the name of the field that Siebel Open UI is querying.

  • search specification identifies a query specification that is defined on this field.

NotifyEndQuery

SWE_PROP_BC_

NOTI_END_QUERY

Notifies the client business component that Siebel Open UI is ending a query on the business component on the Siebel Server. This situation can occur if the ExecuteQuery method or the UndoQuery method runs.

NotifyExecute

SWE_PROP_BC

_NOTI_EXECUTE

Notifies the client business component that Siebel Open UI is running a business component on the Siebel Server.

You can use the following syntax in the property set that Siebel Open UI sends: 

srt = sort specifications

where:

  • sort specification identifies the sort specification that Siebel Open UI runs.

  • search specification identifies the search specification that Siebel Open UI runs.

NotifyScrollAmount

SWE_PROP_BC_

NOTI_SCROLL_AMOUNT

Sets the scroll folder and the amount for a mobile swipe operation.

NotifyPageRefresh

SWE_NOTIFY_PAGE_REFRESH

Updates the urltogo with the URL that Siebel Open UI uses to refresh a view. Siebel Open UI gets this URL from a subsequent executeurltoGo notification.