General business objects

Parameters for the general business objects

Each of the general business objects that is included with application toolkit contains a specific set of parameters.

The following list describes each of these parameters:

DBTYPE

Used with Master Data Policy Monitoring. Specifies the type of database that is used by the InfoSphere MDM server that is managing policy monitoring. Possible values are DB2®, Microsoft SQL Server, Oracle.

MDM_Connection

A complex data type that specifies the information to connect to your MDM operational server.

Table 1. MDM_Connection parameters.

Parameter Name	Type	Description	Physical MDM	Virtual MDM
hostname	String	The hostname for the MDM operational server.	✓	✓
port	Integer	The port number for the IBM® WebSphere® Application Server for the MDM operational server. For example, 9080 or 9081.	✓	✓
username	String	The userID that has the authorization to access the MDM operational server.	✓	✓
password	String	The password for the username.	✓	✓
serverType	String	Ignore. This parameter is not used currently.
locale	String	The locale of the requester, which is used as the <requesterLocale> value in the DWLControl object.	✓
requestUser	String	The transaction request user name.	✓
userRole	String	The name of a user role, sometimes referred to as a user group, that is authorized to run the transactions that manage product type hierarchies.	✓
usessl	Boolean	To enable encryption between the operational server and IBM BPM. The default value is false. If you set this parameter to true, you must specify a secure port number in the port parameter.	✓
requestTimeZone	String	Optional. Only applicable for MDM operational servers that are enabled for multiple time zones. The timezone of the requester, which is used as the requesterTimeZone value in the DWLControl object. The value must be a valid timezone that is defined in the operational server, such as GMT, UTC, US/Pacific.	✓

MDM_Change_History

Used to track the changes that are made to the MDM Hierarchy and MDM Tree coach views. This business object is not intended to be used independently from these coach views.

Table 2. MDM_Change_History parameters.

Parameter Name	Type	Description	Physical MDM	Virtual MDM
child	MDM_Entity	The entity that has been modified in the hierarchy. This is an entity that has been added, deleted, or moved to a different parent. Additionally, the MDM Hierarchy coach view will output an MDM_Change_History business object when an entity's details have been updated.
parent	MDM_Entity	The original parent of the entity that has been modified in the hierarchy. This will be populated when an entity has been deleted or moved.
newParent	MDM_Entity	The new parent of the entity that has been modified in the hierarchy. This will be populated when an entity has been moved or added.
action	String	The action for the captured change. When using the MDM Tree coach view, the options are: remove paste When using the MDM Hierarchy coach view, the options are: deleteNode paste addLink addNode updateNode
link	MDM_Relationship	Captures the details of the relationship between the entity and the original parent. This parameter is populated when an entity is moved to a different parent with the MDM Hierarchy coach view. This parameter is used to enable the ending of a relationship on the operational server when the change is saved.

MDM_Entity

A complex data type modelling the JSON structure of an entity in the MDM Tree and MDM Hierarchy coach views.

Table 3. MDM_Entity parameters.

Parameter Name	Type	Description	Physical MDM	Virtual MDM
id	String	The ID of the entity, in the format required by the MDM Tree or MDM Hierarchy coach views. For example, Party/234561 or 70001/70000.	✓	✓
type	String	The type of the entity as configured in the MDMCFG_Entity business object passed to the MDMCFG_Adaptor, or the XSL transform in the MDM Get Hierarachy Ajax service. For example, Party.	✓	✓
label	String	The label that is displayed for the entity in the MDM Tree or MDM Hierarchy coach views.	✓	✓
children	MDM_Entity ( ) - List	A list of the entity's child entities.	✓	✓
hasChildren	Boolean	Specifies whether the entity has child entities. For example, the value will be true if the entity has children that are populated or if the entity is a reference node that has children when expanded. This value is false if the node does not have children.	✓	✓
contains	String	List that specifies the type of entities that can be contained as child entities when using the drag and drop capabilities of the MDM Tree coach view.	✓	✓
customProperties	NameValuePair ( )	This parameter contains additional attributes from the operational server for the entity. These attributes will be used later in a process flow. For example, the lastUpdateDate attributes will be needed to persist any changes to an InfoSphere MDM Advanced Edition operational server.	✓	✓
details	NameValuePair ( )	A list of properties that will be displayed for the entity in an MDM Hierarchy Dialog Details coach view if the view is attached to an MDM Hierarchy coach view using the event framework.	✓	✓
ref	String	This parameter is used by the MDM Tree and MDM Hierarchy coach views to signify that the entity has not been fully loaded from the server. The value contains the ID of the entity.	✓	✓
subtype	String	The subtype of the entity, as configured in the MDMCFG_Entity business object passed to the MDMCFG_Adaptor, or the XSL transform in the MDM Get Hierarchy Ajax service. This parameter is used to provide finer control for CSS styling of the MDM Tree and MDM Hierarchy coach views.	✓

MDM_Hierarchy_Event

The event object used with the MDM_Event_Framework to enable communication between the MDM Hierarchy and other coach views. This business object is not intended to be used independently from the MDM Hierarchy coach view.

Table 4. MDM_Hierarchy_Event parameters.

Parameter Name	Type	Description	Physical MDM	Virtual MDM
visibility	String	Controls the visibility of the coach view that is bound to this event object. Uses the following BPM visibility strings: REQUIRED, NONE, HIDDEN.
data	String	JSON String used to pass data to coach views subscribed to the event.
result	String	JSON String used to pass a result from a coach view that handled the event.
metadata	String	JSON String used to pass event metadata, such as x & y coordinates for a dialog to be shown.

MDM_Hierarchy_Event_Framework

The MDM_Hierarchy_Event_Framework is an extensible mechanism for pluggable dialogs for the MDM Hierarchy coach view. The MDM_Hierarchy_Event_Framework provides the support for passing data between the MDM Hierarchy coach view and the dialog coach views (MDM Hierarchy Dialog Add, MDM Hierarchy Dialog Error, MDM Hierarchy Dialog Details, and MDM Hierarchy Dialog MultiParent).

Each MDM_Hierarchy_Event in the MDM_Hierarchy_Event_Framework has a visibility, data, result, and parameter. The MDM Hierarchy launches the dialogs by setting the visibility and data parameters. When the dialog is ready to pass data back to the tree, it sets the result parameter and hides itself.

Table 5. MDM_Hierarchy_Event_Framework parameters.

Parameter Name	Type	Description	Physical MDM	Virtual MDM
addNode	MDM_Hierarchy_Event	Event triggered by the MDM Hierarchy Dialog Details coach view to display an MDM_Hierarchy_Dialog_Add coach view. The MDM_Hierarchy_Dialog_Add coach view then uses this event to pass a list of nodes to the MDM Hierarchy coach view to be added to the hierarchy.
multiParent	MDM_Hierarchy_Event	Event used by the MDM Hierarchy coach view to trigger the display of an MDM Hierarchy Dialog MultiParent coach view that displays the parents of a node in the hierarchy.
nodeDetails	MDM_Hierarchy_Event	Event used by the MDM Hierarchy coach view to trigger the display of an MDM Hierarchy Dialog Details coach view that displays the details of a node in the hierarchy. nodeDetails is used by the MDM Hierarchy Dialog Details coach view to pass an update or delete node action to the MDM Hierarchy coach view.
error	MDM_Hierarchy_Event	Event used by the MDM Hierarchy coach view to trigger the display of an MDM Hierarchy Dialog Error coach view that displays an error message.

MDM_Relationship

A complex data type that represents a relationship that has been edited in the MDM Hierarchy coach view.

Table 6. MDM_Relationship parameters.

Parameter Name	Type	Description	Physical MDM	Virtual MDM
id	String	The ID of the relationship
parentId	String	The ID of the parent node.
childId	String	The ID of the child node.
customProperties	NameValuePair ( )	List of properties, for more data, that is associated with the entity.
details	NameValuePair ( )	Not currently used.

MDM_SDV_Change_History

Supports the Virtual MDM data stewardship capabilities in IBM Stewardship Center.

This business object is not intended to be used independently to develop your own process applications.

MDM_Tree

A complex data type for the hierarchical tree.

Table 7. MDM_Tree parameters.

Parameter Name	Type	Description	Physical MDM	Virtual MDM
selectedNode	MDM_Entity	The node that is selected in the tree.	✓	✓
MDM_Change_History	MDM_Change_History ( )	Holds a list of the changes that are made when you use the MDM Tree coach view. This list is in preparation for the changes to be saved to the MDM operational server.	✓	✓

MDM_Txn_Control

Mimics the functionality that is provided by the DWLControl object, however provides a subset of the variables that are found in the DWLControl object. You can:

• Modify the MDM_Txn_Control business object to include more attributes
• Use a MDM_Txn_Control business object that is created when you import the MDM data model
• Use a business object that you create which matches the attribute name and order that are specified in the DWLControl object

Table 8. MDM_Txn_Control parameters.

Parameter Name	Type	Description	Physical MDM	Virtual MDM
inquireAsOfDate	Date	Specifies a point in time date. Used to determine from that point in time to now.	✓
inquireFromDate	Date	Specifies the date at the start of a date range.	✓
inquireToDate	Date	Specifies the date at the end of a date range.	✓