Business object properties

To begin the creation of a business object by specifying its basic information, click the New Business Object menu item in the New menu of the Data Modeler.

You can enter several pieces of information in the Properties panel. Some information does not have to be specified when you create a business object. It can be specified later or not at all.

When you create a business object, you must specify four pieces of information. The first three pieces of information are the business object's name, display name, and description. While it is not mandatory, ensure that all business objects have a description.

The other piece of information that you must specify is whether the records that are created from the business object are stand-alone, embedded, or link records.

Stand Alone
Stand-alone records contain their own data. Stand-alone records can appear at the top-level organization of reports and queries (described in the IBM TRIRIGA Application Platform: Reporting User Guide). Stand-alone records are the only form of record that can be managed directly from the results of a query. This value is the default.
Embedded

Embedded records cannot be at the top-level organization of a query or report. Embedded records cannot be accessed from the results of a query. An embedded record can be accessed only through other records. Embedded records can exist only in a smart section or query section of another record. Smart sections are described in "Record organization".

Embedded records cannot be shared between two different smart sections. Trying to put the same embedded record in two different smart sections creates a copy of the embedded record in the second smart section.

Stand-alone records can be referenced by any number of smart sections; embedded records cannot be embedded in more than one.

Tip: Use a stand-alone business object with a dependent association instead of an embedded business object. IBM® TRIRIGA® uses stand-alone business objects with a dependent association in standard IBM TRIRIGA applications.
Link

Link records were used to blur differences between the types of records referenced by a smart section. When a link record was created, it was linked to another record. A link record can be linked to any record created from a business object in the same module as the one the link was created from.

In the past, one of the uses of link business objects was to report on multiple business objects. Now, Report Builder queries can report on multiple business objects without using link business objects. Use Report Builder queries to report on multiple business objects.

In the past, one of the uses of link business objects was to allow different business objects to appear in multi-record smart sections. Now, query sections provide this functionality without using link business objects or multi-record smart sections. Use Query sections to display information from different business objects.

Externally Managed
This option is not normally selected. Select only for Fact Table business objects. Externally managed business objects are described in Application Building for the IBM TRIRIGA Application Platform: Performance Framework.

After you have specified one of the previous four options, you can create the business object by clicking the Save BO action. You can then specify other properties for the business object:

Staging Table

Identifies business objects for which the IBM TRIRIGA system maintains staging tables. If the property is set to DataConnect or Generic and the business object is published, a staging table is either created or updated. If the property is set to None and the business object is published, the publish process deletes the staging table if it exists. By default, the Staging Table property is set to None.

If this property is set to Generic, fields whose staging-table key property was set at the initial BO publish become the keys for the database table.

A staging table is created for a business object with the Staging Table property set to DataConnect or Generic when the business object is brought in through object migration and object migration publishes the business object.

IBM TRIRIGA DataConnect for Fact Tables uses staging tables as a mechanism for moving external data into the IBM TRIRIGA database. Read more about DataConnect for Fact Tables in Application Building for the IBM TRIRIGA Application Platform: Data Management.

Has Calendar

This option is not normally selected. When selected, records that are created from this business object are associated with a calendar.

Calendars and calendar-based events are described in "Calendar and time-based events".

Audit Actions

This option is not normally selected. When selected, a record is kept of every action as defined in the state transitions that is done on records that are created from this business object. The record of actions is incorporated into an audit trail.

If you are using the Request for Information (RFI) metrics and reports in IBM TRIRIGA Workplace Performance Management products, Audit Actions must be checked.

Audit trails and other security-related issues are discussed in "Security".

Audit Access

This option is not normally selected. When selected, a record is kept of every time someone views a record that is created from this business object.

The next three options define the auditing of data changes to records that are created from this business object. Audit trails and other security-related issues are discussed in "Security".

No Audit
No audit is the most common choice. When selected, a record is not kept when a value change is made to a record created from this business object.
Audit Interactive Data
When selected, a record is kept of every value change made by a user to a record created from this business object. The record of changes is incorporated into an audit trail.
Audit All Data
When selected, a record is kept of every value change made to a record created from this business object, regardless of how the data is modified. This includes value changes that are made by a user, due to a formula calculation or rollup calculation, or by a workflow. However, this option does not include value changes made if the record is modified by an editable query. Selecting this option might adversely affect the performance of the process.
Note: IBM TRIRIGA CAD Integrator/Publisher changes are only covered by the Audit All Data option.
Require Explanation
This option is not normally selected. If it is selected and Audit Interactive Data is selected, when a user changes a record, a pop-up window displays and requires them to enter information about why they made the change.
Show Single Tab
When selected, records that are created from this business object can be used with forms that have single tab operation. If this checkbox is not selected, you cannot use forms that show only a single tab with records that are created from this business object.
Approval History
When selected, forms that work with records that are created from this business object can have a tab that shows the approval history of the record. Approvals of records are under the control of Approval workflow tasks, which are discussed in "Approval task".

When you are finished setting the properties of a new business object, click the Save BO action to create the business object. Creating the business object does not make the business object available for use. The business object is not available for use until you publish it. This cycle is described in "Create-Publish-Revise cycle".

You cannot publish the new business object until you complete two more steps:

  • Specify the fields to be in records that are created from the business object. This step is described in "Business object fields".
  • Specify how a unique name is determined for records that are created from the business object by using its field values. The details of this step are specified in "Naming records".

You are now ready to publish the business object. The details of publishing a business object are discussed in "Publishing business objects".

When you first save the properties of a business object, the module name is included in the Object Browser panel, and some additional properties appear in the Property panel.

The next step is editing the properties of the new business object, such as adding fields.

Copying business objects

If you create a new business object from the New Business Object menu item, it is based on the module's base business object. It has copies of the base business object's sections, fields, associations, and state transitions. Sometimes, it is more convenient to copy the new business object from an existing business object.

You can also create a business object by copying any non-base business object in a module. When you view the properties of an existing business object, a Copy BO action also displays in the Data Modeler. Click Copy BO and a Name property displays in the Data Modeler Property panel. Name the new business object and finish by clicking Ok in the Property panel.