Business Object Interfaces

A Business Object Interface defines the external data model (how other systems view a given Business Object) in terms of a single logical business data entity, such as "WELL." Business Object Interface definitions include but are not limited to "Well," "Valve," "Meter," "Pipe Segment," "Compressor," "Booster," "Tank," etc.

Example

A Business Object Interface named "WELL" would define an attribute called "Operator" as type "string" but not as "FacilityAttr1," even though the SCADA data model defines "FacilityAttr1" as the "Operator." The Business Object Interface remains abstract with regard to the SCADA data model, therefore allowing external users of "WELL" data to refer to the "Operator" attribute instead of "FacilityAttr1."

This concept allows external users of "WELL" to access required data completely independently of the underlying SCADA data model. If the SCADA data model changes, and attribute definitions are changed, the external user of "WELL" would be unaffected.

Business Object Interface Attributes

Business Object Interfaces consist of a list of enterprise attributes mapped to a list of native CygNet attributes. These Business Object attributes can include both string element attributes and point element attributes.

Simple Attributes

Some Attributes of a Business Object are relatively simple and can be represented as strings. These string elements are referred to as Simple Attributes.

Example

A simple attribute for a "Well" object might be "Field Office." A given well object might have a "Field Office" value of "Live Oak" or "Jalama" indicating its location.

Business Object Interfaces encapsulate string elements. See Mapping Simple Attributes for more information about data types which can be represented by string elements.

Unique Key

Each Business Object Interface supports a list of one or more Simple Attributes that compose the object's Unique Key. The value of the unique key for any given object instance must uniquely identify that object from all other objects in the system. The unique key can optionally be composed of multiple partial keys, each of which must be selected as Is Key in the Business Object Interface.

Point Definition Attributes

Many attributes of a Business Object are real-time data requiring a more complex construct than string elements. These complex real-time point elements are referred to as Point Definition Attributes.

Example

The volume for "Well" can be expressed as a string, but there is much more to a well's volume data point than its value; timestamp, units, alarm state, and description are all attributes of the 'volume' attribute as well. An attribute of this type is better expressed as a point element.

Optional Attributes

Business Object Interface Attributes are "read-only" by default. Optional attributes can also be configured as writable.

Writable Attributes

Optional Attributes are allowed to be configured as writable. Special writable attributes are configured by the administrator to be writable for specific purposes.

Creating, Editing, Copying, and Deleting Business Object Interfaces

To Create a Business Object Interface

1. In the Business Object Builder, click the Edit tab to open the Object Editor window.
2. The Navigation pane is on the left. If the Objects list is not already displayed, click on the down arrow to display the list of objects.
3. Click Add New Object and type in a name for the new Business Object. This opens the Object Editor for the newly named object.
4. At the bottom of the Interface for… field, click on Type new attribute here to add a new item to the list.
5. For each interface item, enter a name, and fields will be displayed allowing you to indicate whether it is a Simple Attribute or a Point Definition attribute.
6. If it is a Simple Attribute, an adjacent check box will be displayed, allowing you to select Is Key to mark the associated item as a key.
7. Select the Optional check box to mark the associated attribute as optional.
8. Select the Writable check box to mark the associated attribute as writable.
9. Click Save.

To Edit a Business Object Interface

1. In the Business Object Builder, click the Edit tab to open the Object Editor window.
2. The Navigation pane is on the left. If the Objects list is not already displayed, click on the down arrow to display the list of objects.
3. Click to select the name of the Object you want to edit from the list.
4. The Object Editor pane is on the right. Click to select the name of the Interface element you wish to edit.
5. To edit an interface item name, double-click in the text box and make the desired change.
6. To edit the attribute type, click the down arrow on the combo box and make the desired change.
7. For a Simple Attribute, click the check box adjacent to Is Key to select/clear the attribute's Key status.
8. Click the check box adjacent to Optional to select/clear the attribute's Optional status.
9. Click the check box adjacent to Writable to select/clear the attribute's Writable status.
10. Click the Delete icon to the right of the attribute's characteristics to delete the Interface item.
11. Click Save.

To Copy a Business Object Interface

Copying a Business Object Interface can be achieved by exporting the interface with a new file name, and then importing the new file back into CygBOB from the Package page. Mappings can then be created or edited on the Edit page.

See File Import and Export Options for more information.

To Delete a Business Object Interface

1. On the CygBOB menu, click the Edit tab to open the Object Editor window.
2. The Navigation pane is on the left. If the Objects list is not already displayed, click on the down arrow to display the list of Objects.
3. Click to select the name of the Object you want to delete from the list.
4. Click on the X to the right of the Object Name to delete it.
5. A message box will be displayed asking "Are you sure you want to remove this Object?" Select Yes to delete the Object or No to retain the Object.