Define History Properties for a Business Object

Use the History page in the Business Object Properties window to define options for tracking historical information for the Business Object, including:

• History Relationship: The Business Object's Relationship to the history Object. History is tracked using a related Group Object whose members track different types of information.
• Group Members: Which of the Group Object's members to use to track each type of history.
• How to track Field changes: Whether to track each Field change in a separate history record or combine all changes into one, and whether to track changes for all Fields in the Business Object or just certain ones.
  Note: The Business Object Properties window is available in the Business Object Editor (accessed from within the Object Manager in a Blueprint).

Good to know:

• In the OOTB system, the Journal Object is used to track Business Object history.

To define history properties for a Business Object:

1. Open the Business Object Properties window:
   1. In the CSM Administrator main window, click the Blueprints category, and then click the Create a New Blueprint task.

      Note: If working on a saved Blueprint, open the existing Blueprint.

      The Blueprint Editor opens, showing the Object Manager in its Main Pane. The Object Manager lists the existing Business Objects.

   2. In the Object Manager, click a Business Object in the Object tree, and then click the Edit Business Object task in the Structure area.

      The Business Object Editor opens.

      Tip: You can also click the Edit Business Object button on the Blueprint Editor Toolbar to open the Business Object Editor.

   3. Click the Bus Ob Properties button.
2. Click the History page.
3. Select the Business Object's Relationship to the history Object:
   • History Relationship: In the drop-down, select the Relationship of the primary Business Object to the history Object (ex: Incident Owns Journals).

     Note: If a Relationship does not already exist, you must create one.

4. Select which of the history Object's Group Members to use for each type of history:
   • Manual History: Select the Business Object to use for tracking history records that are manually added by Users.
   • Lifecycle History: Select the Business Object to use for tracking changes to the primary Object's lifecycle.

     Note: This is only applicable if the primary object has a lifecycle. For more information, see Define Lifecycle Properties for a Business Object.

   • Customer Request: Select the Business Object to use for tracking Customer requests. This is used in the Browser Client and Portal to track requests against a record (ex: Withdraw a record, close it, etc.).
   • Mail History: Select the Business Object to use for tracking e-mail correspondence.
   • Queue History: Select the Business Object to use for tracking when records are added to or removed from a Queue (Uses Queues must be selected on the General page).
   • Knowledge History: Select the Business Object to use for associated Knowledge. If a Knowledge source is configured to transfer its contents into a Journal - History object when the Knowledge item is used, then a Journal - Knowledge History record is created.
   • Change/Audit History: Select the Business Object to use for tracking change/audit logs.
   • Chat History: Select the Business Object to use for tracking remote support session details.
5. Define options for tracking changes to Fields in the Business Object. Select one of the following options from the Track Field Changes menu:
   • No Tracking: Select this option to not track Field changes.
   • Record per Change: Select this option to have one history record created for each Field that is changed.
   • Combine Changes: Select this option to have one history record created for all changes made to a Business Object before it is saved.
   • All Fields: Select this check box to track changes for all Fields in the Business Object. Otherwise, tracking is done on a Field-by-Field basis (on the General page in the Field Properties window, check Track Changes to Field for each Field you want to track).

6. Click OK.

7. Publish the Blueprint (File>Publish Blueprint) to commit the changes, or save the Blueprint (File>Save Blueprint) to continue making other changes.
   Note: Before publishing a Blueprint that contains Business Objects, ensure that each Business Object has at least one Form and one Grid defined and that all of the appropriate Fields have been created.