The user may have to select an Organizational Unit, Repository and Project from the drop-down boxes.

The default configuration hides Package details from view.

In order to reveal packages click on the icon as indicated in the following screen-shot.

After a suitable combination of Organizational Unit, Repository, Project and Package have been selected the Project Explorer will show the contents. The exact combination of selections depends wholly on the structures defined within the Workbench installation and projects. Each section contains groups of related files.

The Data Modeller panel is divided into the following sections:

This will pop up the new object screen:

Some initial information needs to be provided before creating the new object:

Once the user has provided at least the mandatory information, by pushing the "Ok" button at the bottom of the screen the new data entity will be created. It will be added to the model browser's entity listing.

It will also appear automatically selected, to make it easy for the user to complete the definition of the newly created entity, by completing the entity's properties in the Data Object Properties browser, or by adding new fields.

In the Data Modeller's object browsing section, an entity can be deleted by clicking upon the 'x' icon to the right of each entity. If an entity is being referenced from within another entity (as a field type), then the modeller tool will not allow it to be deleted, and an error message will appear on the screen.

The new field will also automatically be selected in the entity's field list, and its properties will be shown in the Field tab of the Property editor. The latter facilitates completion of some additional properties of the new field by the user (see below).

At any time, any field (without restrictions) can be deleted from an entity definition by clicking on the corresponding 'x' icon in the entity's fields table.

At this time each entity that has been defined in the model will be translated into a Java class, according to the following transformation rules:

A standard Java default (or no parameter) constructor is generated, as well as a full parameter constructor, i.e. a constructor that accepts as parameters a value for each of the entity's user-defined fields.

The entity's user-defined fields are translated into Java class fields, each one of them with its own getter and setter method, according to the following transformation rules:

As an example, the generated Java class code for the Purchase Order entity, corresponding to its definition as shown in the following figure purchase_example.jpg is visualized in the figure at the bottom of this chapter. Note that the two of the entity's fields, namely 'header' and 'lines' were marked with Equals, and have been assigned with the positions 2 and 1, respectively).

    package org.jbpm.examples.purchases;


    /**

    * This class was automatically generated by the data modeler tool.

    */

    @org.kie.api.definition.type.Role(value =

    org.kie.api.definition.type.Role.Type.EVENT)

    @org.kie.workbench.common.services.datamodeller.annotations.Label(value =

    "Purchase Order")

    @org.kie.workbench.common.services.datamodeller.annotations.Description(value =

    "This entity models the client purchase orders.")

    public class PurchaseOrder extends org.jbpm.examples.purchases.parent

    implements java.io.Serializable {


    static final long serialVersionUID = 1L;


    @org.kie.workbench.common.services.datamodeller.annotations.Label(value =

    "Description")

    @org.kie.api.definition.type.Position(value = 0)

    @org.kie.workbench.common.services.datamodeller.annotations.Description(value =

    "A description for this purchase order.")

    private java.lang.String description;


    @org.kie.workbench.common.services.datamodeller.annotations.Label(value =

    "Lines")

    @org.kie.api.definition.type.Position(value = 1)

    @org.kie.workbench.common.services.datamodeller.annotations.Description(value =

    "The purchase order items (collection of Purchase Order Line sub-entities).")

    @org.kie.api.definition.type.Key

    private java.util.List<org.jbpm.examples.purchases.PurchaseOrderLine> lines;


    @org.kie.workbench.common.services.datamodeller.annotations.Label(value =

    "Header")

    @org.kie.api.definition.type.Position(value = 2)

    @org.kie.workbench.common.services.datamodeller.annotations.Description(value =

    "The purchase order header (Purchase Order Header sub-entity).")

    @org.kie.api.definition.type.Key

    private org.jbpm.examples.purchases.PurchaseOrderHeader header;


    public PurchaseOrder() {}


    public PurchaseOrder(

    java.lang.String description,

    java.util.List<org.jbpm.examples.purchases.PurchaseOrderLine> lines,

    org.jbpm.examples.purchases.PurchaseOrderHeader header )

    {

    this.description = description;

    this.lines = lines;

    this.header = header;

    }


    public PurchaseOrder(

    java.util.List<org.jbpm.examples.purchases.PurchaseOrderLine> lines,

    org.jbpm.examples.purchases.PurchaseOrderHeader header )

    {

    this.lines = lines;

    this.header = header;

    }


    public java.lang.String getDescription() {

    return this.description;

    }


    public void setDescription( java.lang.String description ) {

    this.description = description;

    }


    public java.util.List<org.jbpm.examples.purchases.PurchaseOrderLine>

    getLines()

    {

    return this.lines;

    }


    public void setLines(

    java.util.List<org.jbpm.examples.purchases.PurchaseOrderLine> lines )

    {

    this.lines = lines;

    }


    public org.jbpm.examples.purchases.PurchaseOrderHeader getHeader() {

    return this.header;

    }


    public void setHeader( org.jbpm.examples.purchases.PurchaseOrderHeader

    header )

    {

    this.header = header;

    }


    @Override

    public boolean equals(Object o) {

    if (this == o) return true;

    if (o == null || getClass() != o.getClass()) return false;

    org.jbpm.examples.purchases.PurchaseOrder that =

    (org.jbpm.examples.purchases.PurchaseOrder)o;

    if (lines != null ? !lines.equals(that.lines) : that.lines != null)

    return false;

    if (header != null ? !header.equals(that.header) : that.header != null)

    return false;

    return true;

    }


    @Override

    public int hashCode() {

    int result = 17;

    result = 13 * result + (lines != null ? lines.hashCode() : 0);

    result = 13 * result + (header != null ? header.hashCode() : 0);

    return result;

    }

    }

  

Generally categories are created with meaningful name that match the area of the business the rule applies to (if the rule applies to multiple areas, multiple categories can be attached).