Work with the Business Object Diagrammer

With the Diagrammer, you can create diagrams for your business objects to show their fields and relationships.

To create a Business Object Diagram:

  1. In the Business Objects pane, click the + sign and select Business Object Diagram.
  2. In the Create Business Object Diagram dialog box, enter a name in the Diagram name field and click Create.

    An empty page for the diagram opens, along with a Property Inspector.

  3. In the Property Inspector for the diagram, select the check boxes for the business objects you want to display, or click Select All to display all of them. If you have many business objects, you can create multiple diagrams to display them.

The Diagrammer shows the selected business objects and their fields. The name and type of each field are displayed. The Diagrammer also shows the relationships between the objects and the object accessor names through which you access referenced business objects:

Description of bo-diagram.png follows
Description of the illustration bo-diagram.png

You can use the Diagrammer to perform the following tasks:

  • Click the name of a business object to see the object's Property Inspector, where you can view or edit overview information. Double-click the business object name to go to the object's Overview tab.
  • Click a business object field to see the field's Property Inspector, where you can edit its properties.
  • Click the triangle next to a business object name to show or hide fields.
  • Right-click a business object to see a menu that lets you create a new field or a new relationship, edit or delete the business object, add related business objects, or remove the business object from the diagram:

  • Click a relationship line between two business objects to see the Property Inspector for the relationship, where you can edit or delete the relationship.
  • To specify how business object fields are displayed, right-click the Diagram page and select Fields to display the Fields menu:
    Description of bo-diagram-fields.png follows
    Description of the illustration bo-diagram-fields.png

    By default, any reference fields are displayed, along with their object accessor names, and the number of fields displayed is 10 (though you can scroll to view more).

    • Select Show Audit Fields to display the fields that are automatically created when you create a business object.
    • Select 20 to display up to 20 fields by default.
    • Select Show All to display all fields, or select Hide All to hide all fields.
  • To change the default display from horizontal to vertical, right-click the Diagram page, click Layout, then select Vertical.
  • To update the display, right-click the Diagram page and click Refresh.
  • If the diagram displays many business objects, right-click the Diagram page, then click Find to select one of them.
  • To export the diagram to your file system, right-click the Diagram page, click Save As, and select either PNG (Portable Network Graphics) or SVG (Scalable Vector Graphics) as the format.

To delete a diagram, right-click the diagram in the Diagrams tab and select Delete.

Create Business Objects with the Diagrammer

You can use the Diagrammer to create new business objects.

To create a new business object:
  1. Right-click in the Diagram page and select + New Business Object from the menu. Alternatively, select + New Business Object from the Options menu in the Diagram Property Inspector.
    Description of bo-diagram-new.png follows
    Description of the illustration bo-diagram-new.png
  2. In the New Business Object dialog box, enter the business object name in the Label field and click Create.
    The Name value is filled in automatically based on the Label value.
  3. To add a field to the new business object, right-click the object and select + New Field. In the dialog box, enter the field name in the Label field and select the type, then click Create.
  4. To delete a field, right-click the field and select Delete.

Double-click a field to open the Property Inspector for the field, where you can edit its name,data type, and other properties.

Create Relationships with the Diagrammer

You can use the diagrammer to create new relationships between business objects.

To create a new relationship:
  1. Right-click a business object name and select + New Relationship.
    A dotted red line appears in the business object.
  2. Drag the red line to the business object you want to connect to.
    The Create Relationship dialog box appears, with a new Reference field in the source business object that includes the name of the target business object.
  3. Select the cardinality for each object in the relationship (Many or One).
    In addition to many-to-one and one-to-many, you can specify cardinalities of one-to-one and many-to-many between business objects. If you specify Many-to-Many, an intersection business object with two reference fields is automatically created. Its default name is a concatenation of the two business objects; change this name as you want for better usability. For an intersection business object, you can't deselect the Required check box in either of the reference fields, and the default delete rule is Cascade.
  4. Edit the properties of the relationship field (the Id, the Display Label, the Default Display Field, the Required check box, the Delete Rule).
    For the Delete Rule, the available choices are Cascade, Restrict, and Set To Null. Whether you can edit a property and what values are available depends on the nature of the relationship and the objects.
  5. Click Create.

    A relationship line in "crow's feet" notation that matches the cardinality you selected appears between the object nodes. Mouse over the relationship line to see a description of the relationship.

Right-click a relationship line and select Edit to modify the relationship, or select Delete to remove the relationship.

The new relationship appears on the Overview page for each business object. You can edit and delete the relationship on that page as well as in the diagrammer.