Home > Articles > Software Development & Management > UML

Example Solutions to EAI Issues

Synergistic Solutions, Inc. (SSI) is a vendor of EAI software for telecommunications companies. Their products focus on customer provisioning of high-capacity services such as DS1 and DS3, developing systems that provide a unified, GUI interface to legacy applications (Operational Support Systems, mostly). Their systems pull together information from many legacy systems and present it to design engineers so those engineers don't have to deal with multiple systems, because there is a huge learning curve on those legacy systems.

SSI called upon System Innovations when their products had been accepted by a major telecommunications company, with the one provision that those products would be designed and documented in UML, with particular emphasis on the product architecture. The purchasing company told SSI they would require a stringent review of SSI's product architecture, as delivered in the Unified Modeling Language.

The examples that follow include some of the models that were developed for SSI's product suite. They were originally published with permission in Laura's book, Integration Models: Templates for Business Transformation.

Layers of code add to complexity

NetFlow is a product SSI makes that helps correct problems in the administration of hardwired elements in the Operational Support Systems (OSS) that are commonly used to administer them. These OSS systems are not designed to handle certain configurations of network elements that actually occur in the field, with the result that there are interruptions to the flow of the process of managing those disallowed configurations. The NetFlow product helps design engineers by identifying those configurations, "fixing" their entries in a special database, and informing the OSS of their existence.

The model shown in Figure 2 was developed to capture the use cases that describe the desired functionality of the NetFlow product. It uses the Tree structure to depict the possible branches in functionality, ending in more detailed possibilities on the right side of the diagram.

Figure 2

The NetFlow Use Case Tree defines the desired functionality for a middleware product.

The highest level of function for this product is the administration of hardwired elements. That function is composed of the following sub-functions:

  • Build and maintain the hardwired database
  • Poll and manage the work list that conveys the information from and to the legacy systems
  • Find hardwired elements

Under the "build and maintain the hardwired database" function, the "build database" function is composed of the following:

  • One-time automatic build
  • Manual build

The "maintain database" function includes the following:

  • Update based on Cable Pairs job
  • Update as found in the field

Finding hardwired elements consists of finding and posting the service order so that it flows properly through the process for the variety of possible configurations (F1 Cable Pairs hardwired to Object Repeater Bay to Multiplexer, Object Repeater Bay to Multiplexer, and so forth).

The Use Case Tree provides encapsulation of functionality at a high level. A similar Use Case Tree is developed to capture all requirements for error-handling and error message processing. Use Cases are subsequently resolved into collaboration diagrams, which depict one scenario for each significant use case. Scenarios model the objects that collaborate to deliver those use cases. To show how NetFlow works, the team develops a generic model of the core middleware that controls processing of NetFlow, which is a product called the Business Process Server (BPS).

Need for non-linear modeling techniques

The BPS is a generic support process, which accesses a common database, developed in Oracle, to configure its rules, queues, and external interfaces based on the start-up command line. When running, the BPS spawns the pre-determined number of remote system interface processes, which can interface with remote systems with a number of protocols including EHALAPI, sockets, and ODBC. The BPS loads and executes the pre-determined business rules for its start up defined role.

Class diagrams and collaboration diagrams are used to specify the components of the BPS and show how they collaborate. Then those components are reused in the collaboration diagrams that depict the scenarios for another SSI product, the NetLocate system, seen in Figure 3.

Figure 3

The NetLocate collaboration diagram shows how this EAI product accesses remote data sources through pre-defined BPS components.

The non-linear and self-referential nature of the BPS is modeled and captured in class diagrams so that components can be reused in collaboration diagrams.

Interfaces and metadata

As is the case for many EAI products, NetLocate and NetFlow provide interfaces to legacy systems that maintain intricate rules (or metadata) for accessing data and functions inherent to the legacy systems. EAI products providing access to legacy data can be modeled with the introduction of a UML metadata class type, which stores the rules for data access.

Other EAI features provide a unified front-end to the functionality of legacy systems. UML architecture models can utilize the Facade class to model these front ends, introduced by Gamma et al in the book, Design Patterns: Elements of Reusable Object-Oriented Software. Similar to the more familiar concept of database views, the Facade class can be used to depict a window upon functionality resident in legacy applications.

Customized reuse of product components

SSI uses a layered UML model to depict the system blueprint diagram for its NetLocate product. The model in Figure 4 helps the client purchasing this system to understand the intended architecture and what will be required to deploy the product in a particular environment. It also helps SSI reuse the components of existing products to formulate customized new products for clients.

Figure 4

Synergistic Solution's NetLocate product models the system's component architecture in UML.

The NetLocate system blueprint diagram organizes the components of the system into layers, including:

  • Application specific
  • Oracle-stored procedures that are used to access the Oracle database and the database belonging to certain remote systems from which NetLocate retrieves data.
  • Application general
  • Web browser and HTML coding used to provide user access to the retrieved data.
  • Middleware
  • Components specific to the NetLocate product, such as application and Web servers, and program DLLs and executables required to provide system functionality.
  • System software
  • Operating system and Oracle database management system.

The layered model shows the required components from the architecture viewpoint. Subsequent models, such as the component responsibility model, reorganize the components according to their interaction and the functionality they collaborate to deliver.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020