System implementers need a broader overview of the schema used to represent the published data. For instance, this can be helpful when evaluating potential improvements to work processes that involve sharing this data with other applications. It is for this purpose that these UML diagrams are provided.
These diagrams may include references to schema property definitions and relationship definitions that are not seen in the tool schemas because some SmartPlant application adapters do not utilize the tool schema when creating data. These diagrams include the property definitions and relationship definitions created by the adapter even when not included in the tool schema.
The diagrams were generated using the Construct schema views for data objects command that reads a published data file and determines the portion of the SmartPlant schema used to represent it. This command can be used by administrators to automatically generate similar diagrams for their own custom implementations of SmartPlant Enterprise. For more information, see Auto-Generate UML Diagrams Based on Published Data in the Schema Editor User's Guide.
Each UML displays the following:
-
Class definitions (ClassDefs) and classes (instances of ClassDefs) are represented by rectangles. An instance of a class is an object that is published by an integrated application.
-
Interface definitions (InterfaceDefs) are represented as rectangles. Interface definitions are connected to a class definition (through Realizes relationships).
-
Relationship definitions (RelDefs) and relationships (instances of RelDefs) between two interface definitions are represented as lines. The interface definitions at both ends of each relationship definition are displayed.
If there are other relationships in the data file that apply to either of these interface
definitions, they are also added to the UML diagram regardless of whether they apply
to the class definition for the UML diagram.
-
Implies and Realizes relationships are identified by solid or broken lines. Required Implies and Realizes relationships are identified by bold text on the relationship.
-
The Primary Interface of a class is a separate relationship between the ClassDef and the primary InterfaceDef.
-
Relationship definitions (RelDefs) have a name, two roles, two cardinalities, plus an optional stereotype.
-
Relationship definitions may be abstract or concrete. Abstract relationship definitions are used to group similar relationship definitions (at a higher-level). There are no instances of an abstract relationship definition, which means relationships that have a definition type of abstract are not published.
-
Boxes numbered 1 and 2 at the ends of the associations identify the direction of the association; for example, interface 1 (the source) implies interface 2 (the destination).
-
A stereotype represents a subclass of an existing modeling element with the same form, but with a different intent. Generally, a stereotype represents a usage distinction (possibly additional constraints from the base class). For example, the model may express a general (abstract) relationship definition between two roles, but a specific instance of the relationship definition would have its own set of overriding cardinalities and semantics. An example is the <<Implies>> relationship between two interfaces. Stereotypes are surrounded with guillemots (<< and >>).
-
For each interface definition added as a result of displaying relationship definitions that are not realized by the class definition, one or more class definitions that do realize that interface definition are added to the diagram.
-
If more than two class definitions are found that realize the interface definition, the text Realized by multiple class definitions is added to the diagram.
-
The following section contains UML diagrams for the delivered published map schema file.