UMIG – HTML Documentation: model relationships & manual


This brief introduction has the purpose to explain all relevant inter-element relations of the published models and thus to improve the navigation experience.

Each of the green boundaries represents one of the following parts of the model:


The different elements are represented with their real appearance icon in the model

The links are subdivided in 3 types:

  • Physical Link (black): the elements are really linked together (subordination link) and you will find them in the same package
  • Logical Link (blue): the elements are often placed in an other package but they are used within a diagram or to define an other element (relational link)
  • Hyperlink (red): to facilitate the navigation between some diagrams, we added hyperlinks that permit to go from one to another one (one way hyperlink)



Most of elements (actions, classes, attributes,…) on the different diagrams are clickable. With a left-mouse-click you will have the possibility to see the specifications of the desired element (such as definition, owned attributes/rules,…) and, for the elements where a hyperlink has been set, to follow the hyperlink and open the target diagram.




Summary

As an amendment to the existing documentation we introduce an interactive website that is comprised of all core elements relevant for understanding technical and business process of UMIG 6 – http://model.atrias.be/

Purpose and target group

The purpose of this new website is to present a dynamic view of the UMIG 6 model. The chosen form of representation enables a more holistic and integrated perspective on all modeling content. Hereby, the primary target group are technical profiles within the supplier organizations. However, business profiles can also benefit from information contained in e.g. business process views.

Scope and prioritization

The website covers the UMIG 6 - bill, measure, operate, settle and structure domains, each composed of information, choreography and requirements views. Furthermore, ABIEs (Aggregated Business Information Entities), BDTs (Business Data Types), ebIX entities, harmonized roles and message codes are included.
The website and its content are intended to be an interactive aid and will be refreshed more frequently than the official UMIG 6 publication cycle, however in case of doubt, the UMIG 6 documents always have priority.

High level manual and feedback process

The page is divided in two main sections: the containment tree on the left and the content segment on the right. Within the containment tree users can navigate (expand the view by clicking “+”) between three main directories, which in return containing sub-directories:

  1. atrias:be
    1. ABIE (Aggregated Business Information Entities)
    2. BDT (Business Data Types)
  2. ebIX Entities
  3. ebix:org (Codes)
  4. Harmonized Role Model
  5. Belgian Energy Distribution Market
    1. BE-Bill
    2. BE-Measure
    3. BE-Role Model
    4. BE-Settle
    5. BE-Structure

Based on the ebIX® open standard model for the European Energy Market, each domain is composed of three interlinked segments: Requirements, Choreography and Information. Hereby, requirements is targeted at a business audience and includes business process use cases, business processes and business data views.

The choreography views are aimed at IT people responsible for the implementation of ebIX® recommendations and are used to define and document the global choreography between collaborating business partners in an inter‐organizational business process. Still targeting IT people, the information view contains class diagrams with standardized ABIE and OCLs (Object Constraint Language) elements.

Other than choosing elements for review within the containment tree, additional navigation options allow to go back and forward to previously viewed elements (arrow buttons in the top left corner of the content view) and a button to view a given element within the containment tree (positioned next to the navigation buttons).

Models or diagram views can be bookmarked by saving a link available within the “Specifications tab”, present in each diagram.

Finally, a mailto link for feedback is positioned in the top right corner of each content view. The link is dynamically generated and will attempt to include a reference to the latest viewed diagram. When sending feedback, we kindly ask you to refer to a specific model, diagram or process in question (a specific link can be copied from the “Specifications tab”) so that we can accurately review and address your feedback.

Return to ATRIAS website || Return to HTML model