Previous Topic

Next Topic

Book Contents

Book Index

Define General Properties for a Business Object

Use the General page in the Business Object Properties window to define the following:

To define general 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, displaying the Object Manager in its Main Pane. The Object Manager lists the existing Business Objects.

    2. In the Object Manager, click (New Object) in the Object tree, and then click the New Business Object task from the Structure area.

      Note: If working on an existing Business Object, open the Business Object Editor for that Business Object, and then click the Bus Ob Properties button.

      The Business Object Properties window opens.

  2. Click the General page.

    General Business Object Properties

  3. Define general information for the Business Object:
    1. Name: Provide a display name to use within CSM.
      • Plural Name: When you provide a display name, the plural name is automatically populated (an s is added to the end of the display name; this might need to be edited). The plural name is used whenever the Business Object is displayed in text that needs a plural form.
      • Internal Name: When you provide a display name, the internal name is automatically populated with the Business Object display name, but with spaces and punctuation removed. In most places in the interface, the display name is used; however, the internal name is used when accessing the Business Object using APIs. By default, the internal name is also used as the custom storage name on the Database page (except for Group Objects, which use the Group Leader's storage name).

        Note: The storage name can be overridden in the database properties for a Business Object. However, it must adhere to SQL Table naming conventions (ex: Automatically be derived from the display name, not use invalid values such as spaces, etc.).

    2. (Optional) Description: Provide a description to use within CSM.
  4. Define a Public ID for the Business Object. CSM uses a unique identifier (usually RecID) for each Business Object instance, but this is not User-friendly. A Public ID allows you to define your own ID that is displayed to Users. This is a single Field that best represents the Business Object (ex: Incident ID for the Incident object, Customer's full name for the Customer object, etc.).

    Important: A Public ID is required for Major Business Objects.

    1. Use Public ID: Select this check box to use a Public ID for the Business Object.
    2. Define a Public ID:
      • Use Existing Field: In the drop-down, select a Field containing the value that best describes the Business Object (ex: IncidentID for Incident or Full Name for Customer).
      • Create New Field: Click New to create a new Public ID field.
      • Prefix with Business Object Name: Select this check box to display the Business Object name along with the Public ID. This is useful if the Public ID is numeric (ex: An Incident ID of 12345 is displayed as Incident 12345 rather than just 12345).

        Note: When you define a Public ID, a window opens asking if you want to create an index. We recommend clicking Yes so that Public ID can be used in CSM Searches.

  5. Select an Object type: Select a radio button to designate the type of Business Object (Major, Supporting, or Lookup).
  6. Define tracking options (creates Fields to track information in the Business Object):

    Note: Clearing a check box deletes the selected tracking Field from the Business Object.

  7. Define other options:
  8. (Major Objects only) Define menus and shortcut keys:
  9. Click OK.
  10. 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.

See Also

Define Basic Business Object Properties

Define Process and Procedure Help Properties for a Business Object

Define Group Properties for a Business Object