Define Advanced Properties for a Business Object
Advanced users can use the Advanced page in the Business Object Properties window to define advanced properties for a Business Object.
Define the following Business Object properties:
- Advanced Options: Whether the Business Object is read-only or cacheable, enable View Counter functionality, or to associate a color with the Business Object.
- Attributes: Additional pieces of information (or meta-data) that can be associated with the Business Object. Some attributes are automatically set, but others must be provided manually.
- Only advanced users should define attributes. For more information about attributes, please contact Cherwell Support.
To define advanced properties for a Business Object:
- Open the Business Object Properties window.
- Select the Advanced page and define the following options:
- Read-only: Select this check box to protect the data in the Business Object from being edited. In CSM, users will only be able to view the data but will not be allowed to make changes to it.
- View Counter: Select this check box to enable View Counter functionality for a Major Business Object. The View Counter functionality applies to only the Business Object View selected in the Object Manager (for more information, see Business Object Views). The View Counter adds two read-only fields to the Object (Portal View Count and Technician View Count), which can be added to features such as dashboard Widgets, reports, and forms. The Portal View Count field incrementally tracks the number of times a record is viewed in the Customer Portal. The Technician View Count field incrementally tracks the number of times the record is viewed in the CSM Desktop Client or CSM Browser Client. The View Counter must be enabled for each Business Object View that you want counted. The count only increments when a user or customer opens a record by:
- Selecting a Quick Search result.
- Selecting a Saved Search result.
- Selecting a result from the Knowledge Pane.
- Selecting the GoTo button in the form arrangement.
- Selecting the Quick View button in the form arrangement.
- Using a deep link.
- Using the Command Line.
The count does not increment when a record is viewed in the form arrangement, refreshed from the toolbar, updated with a status change, or accessed using the Cherwell REST API.
View Counter data is automatically captured and stored until the record or Major Business Object is deleted. When a record is deleted, View Counter data for the specific record is deleted, and when a Major Business Object is deleted, all View Counter data related to the Business Object is deleted. If you clear the View Counter option for a Business Object, the fields are removed from the object, but the View Counter data is saved.
- Cacheable: Select this check box to have the Business Object cached for use as a validation table. This allows the values from the Business Object to be cached instead of retrieved from the database each time they are needed, which can improve system performance.
This is the default setting for Lookup Business Objects. You may not want to cache a Lookup Object if you expect it to change frequently or if it is very large (3MB or more). Even if a Business Object is marked for caching, the system might not cache it if it contains too much data.
- Include Large Text Fields in Cache: Select this check box to also cache large text fields (Max Allowed and Max Searchable are checked in field properties) and rich text fields.
Large text fields and rich text fields are rarely used for validation/auto-fill. To reserve memory space, selecting this check box is not recommended. Select this check box only if there is a need to cache these fields.
- Associated Color: Select the Color Selector button to select a color to associate with the Business Object (example: For use in Visualizations). For more information, see About Visualizations.
- Define attributes for the Business Object:
- General Attributes: Select the down arrow to expand the General Attributes section. Then, select an empty row and provide the attribute name and associated value (if applicable).
- Database Attributes: Select the down arrow to expand the Database Attributes section. Then, select an empty row and provide the attribute name and associated value (if applicable).
Database attributes are used to indicate special attributes used for a Business Object’s database table. Most of these are set by the system.
- View additional advanced information for the Business Object:
- Business Object ID: Select this button to open a window that displays the internal ID that is used for the Business Object. This ID can be used instead of the Business Object’s name in many places in the system (this is particularly useful when accessing the system via the Cherwell REST API). The ID is used internally so that Business Objects can be renamed without breaking any relationships.
- Find Dependencies: Select this button to scan the Business Object for a list of other definitions in the system that use this Business Object. When the scan is finished, the Definition Dependencies window opens, listing the dependent definitions.
- Select OK.
- Publish the Blueprint to commit the changes, or save the Blueprint to continue making other changes. For more information, see Publish a Blueprint or Save a Blueprint.
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. For more information, see Create/Edit a Form and Create/Edit a Business Object Grid.