How to handle different implementations in SysML/UML?

Viewed 108

Imagine that we are building a Library system. Our use cases might be

  • Borrow book
  • Look up book
  • Manage membership

Imagine that we can fulfill these use cases by a librarian person or a machine. We need to realize these use cases.

  1. Should we draw different use case realizations for different flows? If not, it is very different to borrow a book from a machine and a person. How can we handle it?
  2. Moreover, what if we have updated version of library machines some day? (e.g. one with keyboard and the other is with touch screen) What should we do then? The flow stays the same, however the hardware and the software eventually be different.
  3. What would you use to realize use cases and why?

It might be a basic question, but I failed to find concrete examples on the subject to understand what is right. Thank you all in advance.

3 Answers

There is no single truth or one way you "should" do it. I will give you my approach, based on the Unified Process.

The use case technique is primarily used to describe a dialog between a human user (actor) and an application. It is modeled as an ellipse and further specified as an activity diagram or just a list of steps: 1 The actor does A, 2 The system does B, 3 The actor does C etc. In this approach, the application is regarded as a black box.

A "use case realization" describes how the system performs its steps (white box), e.g. in terms of collaborating components, transparent to the user.

It is possible, but much less common, to have so-called business use cases. In that case, the "system" represents an enterprise or a business unit. In your case, it would be the library. The "actor" represents an external person or organization, e.g. a client or a supplier. In your case, it would be a client. With business use cases, the library is regarded as a black box. The steps are still in format "actor does A; system does B", but here, it is not specified which of the library's actions are performed by humans and which by applications. The system is the organization, interfacing with external actors, regardless of whether this is implemented by employees or by applications.

A "business use case realization" specifies how the system performs its steps (white box) and specifies which parts are done by employees and which parts by machines.

Now, let me answer you questions one by one.

Question 1.

If you have described your use case as a business use case, and it is at such a high level of abstraction that the steps for client-librarian interaction are the same as for client-machine interaction, then you will have one business use case "Borrow book" and two business use case realizations for this business use case.

However, it is more common practice to have only use cases for user-application interaction. If the client interacts with the system in the same way as a librarian would do on behalf of the client, then you will have only one use case "Borrow book", with actor "Person". This actor has two specializations: "Client" and "Librarian". There will be only one use case realization per use case.

Otherwise, you would have one use case "Borrow book online" describing the flow of events when a client interacts directly with the application, connected to actor "Client" and another use case "Borrow book for client" describing the flow of events when a librarian interacts with the application while talking to the client. The latter use case has "Librarian" as its actor. Again, there will be only one use case realization per use case.

You may choose to model the Client-Librarian interaction separately, or not at all, depending on the purpose of your model.

Question 2.

Let's take use case "Borrow book online". You may have two use case realizations for this use case: one for the keyboard machine and one for the touch screen machine. If these use case realizations are very similar, then I would just make only one use case realization and describe the fact that there are two possible input devices inside that single realization.

Question 3.

For a business use case realization, I would use BPMN 2.0 or a UML activity diagram. These are well suited for business workflow specification.

For a normal use case realization, I usually make a sequence diagram, where the lifelines in those diagrams refer to components defined in a common component diagram. In the left margin of the sequence diagrams, I usually write the steps of the use case in UML note symbols. The sequence diagram focuses on the interaction between components, using their interfaces. This gives a nice overview of the collaboration between components in the context of a particular use case.

For more information, please refer to my white paper Which UML models should we make?. The use case realization is described on page 19.

UML is method-agnostic. Even when there are no choices to make, there are different approaches to modeling, fo example:

  • Have one model and refine it succesfully getting it through the stages requirements, analysis (domain model of the problem), design (abstraction to be implemented), implementation (classes that are really in the code).
  • Have different models for different stage and keep them all up to date
  • Have successive models, without updating the previous stages.
  • keep only a high level design model to get the big picture, but without implementation details that could be found in the code.

Likewise, for your question, you could consider having different alternative models, or one model with different alternatives grouped in different packages (to avoid naming conflicts). Personally, I’d go for the latter, because the different alternatives should NOT be detailed too much. But ultimately, it’s a question of cost and benefits in your context.

By the way, Ivar Jacobson’s book, the Object advantage applies OO modeling techniques to business process design. So UML is perfectly suitable for a human solution. It’s just that the system under consideration is no longer an IT system, but a broader organisational system, in which IT represents some components among others.

UML has collaboration elements to show different implementations. The use cases are anchors since the added value for the actors does not change. However, you can realize these use cases in different ways. And that is where the collaborations come into play. A collaboration looks like a use case but has a dashed border. And you draw a realize relation from one or many collaborations towards a use case. Inside the collaborations you show how the different implementation's classes collaborate (hence the name).

P.213 of UML 2.5 in paragraph 11.7 Collaborations:

The primary purpose of Collaborations is to explain how a system of communicating elements collectively accomplish a specific task or set of tasks without necessarily having to incorporate detail that is irrelevant to the explanation. Collaborations are one way that UML may be used to capture design patterns.

A CollaborationUse represents the application of the pattern described by a Collaboration to a specific situation involving specific elements playing its collaborationRoles.

Related