Model: relation/HcsNbnEventREL

Events

You must set the Northbound Notification Destination before you can configure events.

Use this procedure to specify an event to trigger Northbound Notifications.

Log in as provider administrator.
Choose Administration Tools > Northbound Notifications > Events.
Click Add.
Provide the following information for the triggering event:

Field	Description
Name	Event name. Must be unique. This field is mandatory.
Description	A description of the event
Active	Select to turn on notification.
Model Type	Choose either data/User or relation/Subscriber as the model type of the data that triggers the event. This field is mandatory.
Operation	Choose from the operations applicable to the selected model type. This field is mandatory.
Attribute Selector	Set an attribute selector to restrict (filter) the list of attributes sent in notifications for this event. This field is optional. To remove an existing attribute selector, backspace and delete it from the Attribute Selector field. If you do not specify an attribute selector, all possible attributes are sent in notifications for this event.
Destination	The provider's NBN destination. This field is read-only.

Click Save.

Model Details: relation/HcsNbnEventREL

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title															Description																				Details
Name *																																			Field Name: name Type: String MaxLength: 1024
Destination *															The HTTP server destination for the notifications.																				Field Name: destination Type: String Target: data/HcsNbnDestinationDAT MaxLength: 1024 Format: uri
Attribute Selector															The attribute selector defining the list of attributes to receive in the notification.																				Field Name: attribute_selector Type: String Target: data/HcsNbnAttributesDAT Target attr: name MaxLength: 1024 Format: uri
Base																																			Field Name: base Type: Object
	Name *														Name of event																				Field Name: base.name Type: String
	Description														Description																				Field Name: base.description Type: String
	Workflow *														The workflow instance that will be executed.																				Field Name: base.workflow Type: String Target: data/ProvisioningWorkflow Target attr: name Format: uri
	Active *														Active Default: false																				Field Name: base.active Type: Boolean Default: false
	Model Type *														The model type acted on by the transaction for which to trigger the event. This field supports the use of the * wildcard.																				Field Name: base.model_type Type: String Format: uri
	Operation *														The transaction operation for which to trigger the event. This field supports the use of the * wildcard.																				Field Name: base.operation Type: String Choices: []
	Phase *														The phase of transaction execution at which the event should be triggered eg. Pre-Execution (before the transaction is performed) or Post-Execution (after the transaction is performed). This field supports the use of the * wildcard.																				Field Name: base.phase Type: String Choices: ["Pre Execution", "Post Execution"]
	Synchronous														If selected the event will be executed synchronously, otherwise asynchronously (default).																				Field Name: base.synchronous Type: Boolean
	Rollback														If selected the event will only be executed for rollback operations, otherwise it will only be executed for normal non rollback operations (default).																				Field Name: base.rollback Type: Boolean
	API Version														A version field applicable to North Bound Notifications specifying the version the data must be transformed to.																				Field Name: base.api_version Type: String