Using Business Objects
Everything within HEAT is driven by business objects.
1. | Within the Configuration Console Main Menu, choose Business Objects. The Common Business Objects page appears. |
2. | From the right panel in the Create an Object pane, click New Object. The Adding Business Object page appears. |
3. | Choose an option: |
Stand-alone Business Object | A simple business object where you can define object fields. Once created, you can extend it. See Creating a Stand-Alone Business Object. |
Extension to Existing Business Object |
A business object that extends the properties and behavior of another business object. You can add specific properties and business rules. See Creating an Extension to an Existing Business Object. |
Materialized View Business Object | A complex type of business object. Once created, you can set up to update data from different sources. See Creating a Materialized View Business Object. |
After choosing the Stand-alone Business Object option, the Object Details page appears.
1. | Under the Object Details tab, enter your information into the fields. |
Field | Description |
---|---|
Business Object |
Type a unique name for this object. The name will be stored in the database. |
Display Name |
Type a unique display name for this object. This name will appear to users in the Service Desk Console. |
Description |
Enter a brief description of the purpose of the business object. |
Composite Contract Memberships |
Click Add , then from not set, choose a customer type (Contact, Entity, or Identity). |
Default Form: |
Optional. Choose a form from the drop-down list. You can't choose a form until you have at least one form created. See Using Forms. |
Uniquely identifies the definition record.
RecID is set as the default Primary Key field. |
|
Clustered |
Check if the object is part of a clustered index at the database level. Clustered indexes can greatly increase overall speed of retrieval, but usually only where data is accessed sequentially in the same or reverse order of the clustered index, or when a range of items is selected. This is the same as a clustered index function for a SQL database. |
Display |
Choose a field to be shown with this business object. For example, you could select CreatedBy to be shown in conjunction with the incident business object. |
State |
Select the field to be used for driving the lifecycle of the processes in the business object. When the object is assigned a certain status, for example, certain business rules might be executed. |
Type Selector |
Choose a field from the drop-down list to facilitate the extension of the business object. A field must be selected to permit an object to be extended. |
Commonly Used |
Check to show this business object in the Common Objects area of the main Business Objects page. |
Under Change Control |
When working with a object derived from the Configuration Item (CI) and FRS_CIComponents objects, check to allow its Configuration Baseline attributes to be copied. |
Audit Creates/Update/Deletes | Check to add information from this object to the audit log each time an object record is created, modified, or deleted. |
2. | Click Save from the toolbar. The object is created, including the default fields, and the object tabs appear. |
Six default fields are automatically created:
- CreatedBy
- CreatedDateTime
- LastModBy
- LastModDateTime
- ReadOnly
- RecId
Advanced
3. | Optional. Click Advanced. In this area you can index fields associated with this business object. This option uses the Create Index function on a specific field within the Microsoft SQL database. Indexing a field can speed up search. The specified field is used to identify the type of member object in the group. |
4. | Click Add New Index. A list of indexed fields appears. See Indexing for an explanation on the pros and cons of indexing. |
5. | Select the field you want to index for this object. You can add more fields later. The System Properties page appears. |
6. | Enter information into the fields. |
Field | Description |
---|---|
Index Name |
Type a unique name for this index. |
Description |
Type a useful description for this index. |
Unique |
Check to designate this value as unique, preventing duplicate entries in the index and its backing table. You can create uniqueness by using multiple fields. This option automatically creates an unique index of this field.
|
The original field you chose appears. Click Add , then choose another field from the list to add more fields. Repeat as needed.
See Indexing on how this option can affect performance. |
|
Filter Expression |
Optional. You can apply a filter to the index that does not include NULLNo value. A field that is blank. values. Click Add , then choose a field from the list to create a filter. Repeat as needed.
|
7. | Click Add this Index. |
8. | Click Save from the toolbar. |
- To return to the previous page, click Go Back.
- To return to the previous page without saving your options, click Cancel.
Auto Generate UI
9. | To automatically create a workspace for this object, click Auto Generate UI. The Name window appears. |
10. | Enter a name for the layout (or use the system-generated name), then click OK. A new Form, Grid, and Layout is created, as indicated by the corresponding tab labels. |
To modify these, see Using Forms, Using Grids, and Using Layouts.
11. | Click Save from the toolbar. |
The following tabs are generated with this object:
- Object Details. The main page of the object. Includes Name, description, primary key identifier, and other basic information..
- Object Fields. Information about the types of fields stored in a business object. See Using Fields
- Relationships and Relationships v2. When an object must include information from another object, create a relationship between the objects. See Relationship Types. Each relationship contains a:
- Parent object. Functions as the center of a relationship.
- Child object. Assists a parent object by supplying it with additional data.
- Forms. A graphical display used to present and capture field information. One or many forms compose a record. See Using Forms.
- Grids. A tabular display for viewing multiple records at once. Columns represent the fields for each record.See Using Grids.
- Layouts. A collection of forms, tabs, grids, and controls that displays a parent record and its child records. The parent record displays as a form with its child records usually displayed as a series of tabs. See Using Layouts.
- Business Rules. Govern events based on user input forms. Business rules define triggering events, actions triggered by an event, and characteristics of user input forms pertaining to the business object. See Using Business Rules.
- Workflows. Workflows organize one or more business processes (sets of activities that perform a specific task) and are triggered by a user action, a time-based event, or additional business process. See Using Workflows.
- Audit. Store changes made to the records in this business object. The audit history for an individual record is then displayed as a tab. See Accessing the Audit History.
- Search. Set up how search results from a link field selector are displayed and set up Advanced Search fields for users to search. See Configure Search Settings.
- ERD. An entity relationship diagram. See Using Entity Relationship Diagram (ERD).
You can embed a single object into a parent object. For example, the group business object called Task contains a set of common fields (business properties), such as:
- EstimatedEffort
- ActualStartDate
- EmailAddress
However, you can create one or more extensions of Task, extended objects that are member business objects. The base object (Task) has its business properties extended into these objects without recreating the fields separately for each extended object. The extended objects can then gather more specific information, such as:
- Task.Assignment: Contains fields such as PlannedCost, AssignmentID, and AssignerEmail.
- Task.WorkOrder: Contains fields such as ActualCost, EstimatedCost, and WorkOrderID.
An extended object (such as Task.WorkOrder) can be a member of a business object group.
1. | After selecting the Extension to Existing Business Object option, the Create Extension page appears. |
2. | From the list, choose the object you want to extend. The business object Details page appears, showing the parent object link. Click the link to review the parent object properties. |
3. | Enter your information into the fields. |
Field | Description |
---|---|
Extension To | The parent object name is generated by the system. |
Suffix Name |
Enter a name for the member object, relative to the group object. |
Display Name |
The default display name (objectname.suffixname) is generated by the system. |
Description |
Describe the object. |
Default Form |
Optional. Select a form from the drop-down list. |
Primary Key Field |
Uniquely identifies the definition record. FrontRange Solutions recommends using this value. You can enter any other available field in the business object as an identifier as long as it is mandatory and unique. RecID is the default field. |
Clustered |
Select this option if the object is part of a clustered index at the database level. Clustered indexes can greatly increase overall speed of retrieval, but usually only where data is accessed sequentially in the same or reverse order of the clustered index, or when a range of items is selected. Consult your database administrator for guidance on using this feature. |
Special Purpose Field Display |
Select a field to be used as the display name with this business object. For example, you could select IncidentNumber to be displayed in conjunction with the incident business object. |
State |
Select the field to be used for driving the lifecycle of the processes in the business object. When the Object is assigned a certain status, for example, certain business rules might be executed. |
Type Selector |
Select a field from the drop-down list to facilitate the extension of the business object. A field must be selected to permit an object to be extended. |
Commonly Used |
Select this option to show this business object in the Common Objects area of the main Business Objects page. |
Under Change Control |
When working with a object derived from the Configuration Item (CI) and FRS_CIComponents objects, select the option to allow its Configuration Baseline attributes to be copied. |
4. | Click Save from the toolbar. The object is created, the fields generated, and the tabs appear. |
- Advanced. See Advanced.
- Auto Generate UI. See Auto Generate UI.
- Tabs. See Tabs.
This object type is used for establishing a universal worklistThe ability to view a list of items from multiple user workslists on one workspace.. See Universal Worklist for how to use this feature.
1. | After selecting the Materialized View Business Object option, the New Business Object page appears. |
2. | Enter information into the fields. |
Field | Description |
---|---|
Business Object |
A unique name for this object. The name is stored in the database. |
Display Name |
A unique display name for this object. This name appears to users in the Service Desk Console. |
Description |
A brief description of the purpose of the business object. |
3. | Click Save from the toolbar. The object is created and the tabs appear. |
This defines the structure into which you copy data. System fields are automatically generated for this object, but in reality you will probably not use them.
4. | From the View Fields tab, click Add Fields From. The Import Fields window appears. |
5. | Enter information into the fields. |
Field | Description |
---|---|
From Slave Tenant | Check to get data from the slave tenant. This enables the next field. If not checked, you can only get data from the master tenant. |
Tenant | Choose the slave tenant from the drop-down list. These are defined in the Slave Tenant workspace. See Slave Tenants |
Business Object | Enter the business object whose fields you want to import and map. |
The fields are listed, but only the physical fields are selected. Calculated or Boolean fields are grayed out.
To select all valid fields, check Select All Fields.
6. | Click Import. The fields are created for the new object and appear in the field list. |
7. | To add fields from another tenant, click Add Fields From and repeat the process. Only unique fields are created and duplicate fields are automatically ignored. |
8. | Click Save from the toolbar. The View Fields are created. This might take a couple of minutes, depending on how many fields are added. |
This tab lists any view parts for this object. You can create multiple parts from a single tenant.
1. | From the View Parts tab, click Add New.... The New Part page appears. |
2. | Enter information into the fields. |
Field | Description |
---|---|
View Part Name | A unique name for the view part. |
From Slave Tenant | Check to get data from the slave tenant. This enables the next field. If not checked, you can only get data from the master tenant. |
Tenant | The slave tenant. Select from the drop-down list. These are defined in the Slave Tenant workspace. See Slave Tenants |
Business Object | The related business object. Enter part of the name and a list of business objects appears in the list. The fields are mapped automatically if the part field name matches the tenant field name. |
3. | Map the fields if needed. |
4. | Click Save from the toolbar. |
5. | Return to the View Parts page. Your new part appears in the list. |
6. | Under the Actions column, click Build. The source data is compiled and ready to use. |
The following actions are now available:
Action | Description |
---|---|
Synchronize | Retrieves any updated data. |
Deactivate | Removes this object from the synchronization process. |
Destroy | Removes all traces of the part from user computers. |
Delete | Removes all field mapping. |
Use caution when modifying a business object. Changing business objects that have been linked to another business object or is required in a workflow can cause unexpected results and prevent your system from running correctly. We recommend that you only modify business objects that you have created.
You cannot delete default business objects; you can only delete business objects that you have created.
Use caution when deleting a business object, as you might inadvertently affect a workflow or relationship with another object.
1. | From the business object main page, click View All to see a list of objects. The objects you can delete appear without a lock in front of the name and with a Delete button enabled. |
2. | For the object to delete, click Delete. The Delete Confirmation window appears. |
3. | Click Yes. |
The object no longer appears on the list.
You can view the history of a specific business object from the Audit tab. This is in addition to the Transaction Audit Log.
Audit Tab of a Change Business Object
You can filter which items appear on the list:
Filter | Description |
---|---|
Author | The name of the author. Choose from the drop-down list. |
Min Date | To search a date range, enter the earliest date to search. |
Operation | The audit operation. Select from the drop-down list: All, Insert, Update, Delete. |
Mac Date | To search a date range, enter the latest date to search. |
Type | The type. Select from the drop-down list. |
- Click Search after setting your filter settings to see the audit items.
- Click Reset to clear all the filter fields and see all audit items.