Create or Delete a User-Defined Object

A user-defined object is a set of data returned by a specially configured advanced control. You can use the data set as a business object, with each result column serving as an attribute of the object.

To create a user-defined object, simply deploy the control that supplies data to the user-defined object. Doing so automatically creates the object itself:

  • Either an access control or a transaction control can provide data to a user-defined object.

  • A control can generate incidents, or it can provide data to a user-defined object, but it can't do both. You determine which purpose a control serves by selecting an appropriate value in a Result Type field as you create the control. Data set is the value to select for a control that supplies data to a user-defined object.

  • A user-defined object has the same name as the control it's based on. You can't change this name. As you create a data-set control, ensure that its name is meaningful as the name of an object a user would select while creating a model.

Once user-defined objects are created:

  • They're listed in a User-Defined Objects page. You can open the page from the Actions menu of either the Models or the Controls page.

  • If you deploy the control that creates a user-defined object, you automatically have access to that object. However, you can access other user-defined objects only if they're assigned to you. An administrator must use a Business Object Security feature, available in the Risk Management Data Security work area, to assign objects you can use.

  • Only a transaction model (or a control developed from it) can contain filters that cite user-defined objects.

  • Before you use one of these objects in a transaction model or control, you must run its data-set control. Otherwise, no results are generated. Each time the source control is run, the data available in the user-defined object is refreshed.

  • User-defined objects have no join relationship to other objects. You must expressly define a relationship between a user-defined object and another object it may work with in a model or control. When you cite a user-defined object in a model filter, you use a Related to condition in a subsequent filter to create this join relationship.

You may delete a user-defined object, but only if it isn't used in any control or model. In the row for the user-defined object, an Actively Used field indicates whether this is the case. If not, select the Delete icon in the row.