Using the object modification log
The topics in this section provide information about using the object modification log. For additional information about objects, see:
- Labeling a collection of objects
- Adding version control labels to objects
- Finding objects with a specified version control label
- Exporting .def files for labeled objects
- Modifying version control labels
- Removing version control labels
The object modification log records object changes and, optionally, saves the definition file of each version of an object. This enables you to do the following:
- Track who changed an object, what change they made, and when they made it.
- Restore an earlier version of an object.
To enable the object modification log
- On the Version Control tab of the AR System Administration: Server Information form, set the following options:
- Set Object Modification Log to Enabled.
- (Optional) Set Save Definition Files to Yes. See Setting version control options.
To restore earlier versions of an object, you must configure the object modification log to save object definition files. For information about restoring earlier versions, see To restore an earlier version of an object.
- Click OK.
When the object modification log is enabled, the BMC Remedy AR System server adds an entry to the AR System Version Control: Object Modification Log form every time anyone creates, modifies, or deletes an object in BMC Remedy Developer Studio or by importing. The server adds the entry when it makes the change. The entry includes the following information:
Fields in object modification log entries
|Object Name||Name of the new, changed, or deleted object.|
|Obj Old Name||Previous name of the object if the change is renaming the object.|
|Object Type||Type of changed object: form, active link, escalation, filter, menu, image, or container (application, guide, or packing list).|
|Operation||Create, Delete, or Modify.|
|User||User who made the change.|
|Modified Date||Time stamp of the change.|
|Comments||Text from the New Description property of the object.|
Attachment field containing a .def file saved by the server after the change. The syntax of a .def file name is as follows:
If an object name contains any of the following characters, the characters are converted to the following strings in the .def file name:
This field does not contain a .def file in the following situations:
|Instance||An integer, starting at one, that specifies the version of the object.|
|API ID||An identifier that is the same for all log entries resulting from the same API call to the BMC Remedy AR System server.|
|API Target||A flag indicating whether the object was referenced by the API call (Yes) or is related to a referenced object (No).|
Reserved for future development.
This field is not associated with version control labels (see Labeling a collection of objects).
|Task ID||Reserved for future development.|
A single change in BMC Remedy Developer Studio can produce many changes on the BMC Remedy AR System server and many log entries. For example, when you modify a form, several entries are created in the AR System Version Control: Object Modification Log form:
- An entry for the form
- An entry for the form view
- An entry for any fields that were changed
To restore an earlier version of an object
If the object modification log is not configured to save definition files, you cannot perform this procedure. See To enable the object modification log.
- In a browser, log on to the BMC Remedy AR System server as an administrator.
- Open the AR System Version Control: Object Modification Log form in Search mode.
- Specify the appropriate search criteria.
- Perform the search.
- Find the log entry in the search results.
- Save the .def file from the entry to your computer and import it.