Model: data/HcsNbnAttributesDAT

Attributes

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

You can use attribute selectors to define the attributes to be received in a notification for a particular event. Notifications contain only the specified fields and are not sent if none of the fields are chosen.

Note

You cannot delete an attribute selector until it is removed or disassociated from all events.

Important

It is possible to create an attribute selector through the API with 'invalid' attributes as there is no API validation on the list of attributes. We recommend using the Admin Portal or API to retrieve the list of attributes prior to creating an attribute list through the API. Refer to the API Reference Guide. If an invalid attribute is added to an attribute filter, the transaction will succeed but notifications will not contain the chosen field.

Perform these steps:

Log in as provider administrator.
Choose Administration Tools > Northbound Notifications > Attributes.
Click Add.
Enter a unique name.
Choose a model type: either data/NormalizedUser or relation/Subscriber.
Highlight one or more attributes and perform the following:
- Click Select to add an attribute to the list of chosen attributes. You can also select multiple attributes at a time by highlighting them and clicking Select. The attributes move from the Available box to the Selected box.
- Click Remove to remove an attribute from the list of chosen attributes. You can also remove multiple attributes at a time by highlighting them and clicking Remove. The attributes move from the Selected box to the Available box.
Example: For the data/User model, you could select Username, First Name, Last Name, Phone Number, and Mail. Notifications are then sent when an event occurs that includes one or more of these attributes.
Click Save.

Apply the event attributes to an event by adding or updating the event and choosing the desired attribute selector.

HcsNbnAttributesDAT

Model Details: data/HcsNbnAttributesDAT

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		Details
Name *		Field Name: name Type: String MaxLength: 1024
Model Type *		Field Name: model_type Type: String MaxLength: 1024
	Attributes	Field Name: attributes.[n] Type: Array