Skip to main content

Representing sub-system dependencies

When we start designing a big system we might also think on how to split our solution in sub-systems. We can end-up having a lot of sub-systems with different dependencies.  The same thing will happen if we start splitting a sub-system in components, we will have a lot of components with different dependencies.
How we can represent these dependencies in a simple and clean way?
I saw different solutions where you can end up with complicated schemas or with trees. Both solutions are complicated to read and people with spend some time understand these dependencies. X depends on Y and Z and so on.
This month I read “Software Architecture in Practice” written by L. Bass, P. Clements and R. Kazman.
I discovered a great and simple way to represent all these dependencies. Dependencies can be represented in a simple table where we will have on diagonal our sub-systems, or different components.
Each input resource that is needed by a sub-system will be on columns. Each resource will be placed in the cell of the row that offers these resources. In the same row, around our sub-system we will be able to see the output of our sub-system and what are sub-systems that depend on our sub-system.
In the following example we have 3 sub-systems. Aircraft System Group (ASG), Avionics Group (AG) and Environment Group (EG). We can observe very easily that the EG depends only on the AG and he need the Ownship and Emissions from it. Also the output of this sub-system is used only by the AG that use the Environment and Emitter Data input.
This example is taken from the book.
As we can observed it is very easily to understand how each sub-system and component interact. Based on this table we can see what sub-systems have a lot of dependencies. Also when we want to change a sub-system we can easily identify the sub-systems that may be affected of this change.
I encourage you to try this approach. If you have time, I really recommend to read the book.

Comments

  1. Do they explain in the book why a UML package/subsystem diagram is not appropriate in this case?

    ReplyDelete
  2. The link to the book is http://kind.regards :)

    ReplyDelete

Post a Comment

Popular posts from this blog

ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded

Today blog post will be started with the following error when running DB tests on the CI machine:
threw exception: System.InvalidOperationException: The Entity Framework provider type 'System.Data.Entity.SqlServer.SqlProviderServices, EntityFramework.SqlServer' registered in the application config file for the ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded. Make sure that the assembly-qualified name is used and that the assembly is available to the running application. See http://go.microsoft.com/fwlink/?LinkId=260882 for more information. at System.Data.Entity.Infrastructure.DependencyResolution.ProviderServicesFactory.GetInstance(String providerTypeName, String providerInvariantName) This error happened only on the Continuous Integration machine. On the devs machines, everything has fine. The classic problem – on my machine it’s working. The CI has the following configuration:

TeamCity.NET 4.51EF 6.0.2VS2013
It seems that there …

Entity Framework (EF) TransactionScope vs Database.BeginTransaction

In today blog post we will talk a little about a new feature that is available on EF6+ related to Transactions.
Until now, when we had to use transaction we used ‘TransactionScope’. It works great and I would say that is something that is now in our blood.
using (var scope = new TransactionScope(TransactionScopeOption.Required)) { using (SqlConnection conn = new SqlConnection("...")) { conn.Open(); SqlCommand sqlCommand = new SqlCommand(); sqlCommand.Connection = conn; sqlCommand.CommandText = ... sqlCommand.ExecuteNonQuery(); ... } scope.Complete(); } Starting with EF6.0 we have a new way to work with transactions. The new approach is based on Database.BeginTransaction(), Database.Rollback(), Database.Commit(). Yes, no more TransactionScope.
In the followi…

GET call of REST API that contains '/'-slash character in the value of a parameter

Let’s assume that we have the following scenario: I have a public HTTP endpoint and I need to post some content using GET command. One of the parameters contains special characters like “\” and “/”. If the endpoint is an ApiController than you may have problems if you encode the parameter using the http encoder.
using (var httpClient = new HttpClient()) { httpClient.BaseAddress = baseUrl; Task<HttpResponseMessage> response = httpClient.GetAsync(string.Format("api/foo/{0}", "qwert/qwerqwer"))); response.Wait(); response.Result.EnsureSuccessStatusCode(); } One possible solution would be to encode the query parameter using UrlTokenEncode method of HttpServerUtility class and GetBytes method ofUTF8. In this way you would get the array of bytes of the parameter and encode them as a url token.
The following code show to you how you could write the encode and decode methods.
publ…