/EIP-PlantUML

EIP-PlantUML adds Enterprise Integrations Patterns elements to PlantUML to provide easy support of designing EIP architectures for both, up-front design as well as development-time automated documentation generation.

Primary LanguageC#MIT LicenseMIT

EIP-PlantUML

EIP-PlantUML provides Enterprise Integrations Patterns elements to PlantUML to provide easy support of designing EIP architectures for both, up-front design as well as development-time automated documentation generation.

Important Information

Please bear in mind this repository is currently Work in Progress - therefore new features might be added regularly and breaking changes might be introduced more often than not.

Getting Started

You will need to download the EIP-PlantUML.puml file from the dist folder.
This files includes everything you need to use the EIP patterns in your PlantUML diagramms.

At the top of your PlantUML model you need to include the EIP-PlantUML.puml file.

!include ../EIP-PlantUML/EIP-PlantUML.puml

If you want to include the most recent version of the EIP-PlantUML.puml file, you can alternatively use

!includeurl https://raw.githubusercontent.com/plantuml-stdlib/EIP-PlantUML/main/dist/EIP-PlantUML.puml

to link to the latest version available in the master repository.

After including the EIP-PlantUML.puml file you can start using the EIP patterns as shown below.

MsgChannel(channel1, "Channel 1")
MsgChannel(channel2, "Channel 2")
Message(msg, "Message")

Send(channel1, msg)
Send(msg, channel2)

Message Example

Supported Pattern

The following pattern are currently supported:

Category Pattern Macro Image Image URL
Message Construction Message Message(alias [,label])
Message Construction Command Message CommandMessage(alias [,label])
Message Construction Document Message DocumentMessage(alias [,label])
Message Construction Event Message EventMessage(alias [,label])
Message Construction Request-Reply RequestReply(alias [,label])
Message Construction Return Address ReturnAddress(alias [,label])
Message Construction Correlation Identifer CorrelationIdentifier(alias [,label])
Message Construction Message Sequence MessageSequence(alias [,label])
Message Construction Message Expiration MessageExpiration(alias [,label])
Message Construction Format Indicator NA
Message Routing Pipes and Filters Pipe(from, to)
Message Routing Pipes and Filters Filter(alias [,label])
Message Routing Message Router MessageRouter(alias [,label])
Message Routing Message Filter MessageFilter(alias [,label])
Message Routing Dynamic Router DynamicRouter(alias [,label], dynamicrulebase)
Message Routing Recipient List RecipientList(alias [,label])
Message Routing Splitter Splitter(alias [,label])
Message Routing Aggregator Aggregator(alias [,label])
Message Routing Resequencer Resequencer(alias [,label])
Message Routing Composed Message Processor ComposedMessageProcessor(alias [,label])
Message Routing Scatter-Gather TBD
Message Routing Routing Slip RoutingSlip(alias [,label])
Message Routing Process Manager ProcessManager(alias [,label])
Message Routing Message Broker MessageBroker(alias [,label])

Message Transformation

  • Message Translator
    • MessageTranslator(alias [,label])
  • Envelope Wrapper
    • Wrapper(alias [,label])
    • Unwrapper(alias [,label])
  • Data Enricher (also Content Enricher)
    • DataEnricher(alias [,label], datasource)
  • Content Filter
    • ContentFilter(alias [,label])
  • Claim Check
    • Item(alias) <<$claim_check>>
    • Item(alias, "<$claim_check>")
    • Item(alias, "label <$claim_check>")
  • Normalizer
    • Normalizer(alias [,label])
  • Canonical Data Model
    • TBD

Messaging Endpoints

  • Message Endpoint
    • MessageEndpoint(alias [,label])
  • Messaging Gateway
    • MessagingGateway(alias [,label])
  • Messaging Mapper
    • MessagingMapper(alias [,label])
  • Transactional Client
    • TransactionalProducer(alias [,label])
    • TransactionalConsumer(alias [,label])
  • Polling Consumer
    • PollingConsumer(alias [,label])
  • Event-Driven Consumer
    • EventDrivenConsumer(alias [,label])
  • Competing Consumers
    • TBD
  • Message Dispatcher
    • MessageDispatcher(alias [,label])
  • Selective Consumer (Message Selector)
    • SelectiveConsumer(alias [,label])
  • Durable Subscription
    • DurableSubscriber(alias [,label])
    • NonDurableSubscriber(alias [,label])
  • Idempotent Receiver
    • TBD
  • Service Activator
    • ServiceActivator(alias [,label])

Messaging Channels

  • Messaging Channel
    • MsgChannel(alias [,label])
  • Point-to-Point Channel
    • P2PChannel(alias [,label] )
  • Publish-Subscribe Channel
    • PubSubChannel(alias [,label])
  • Datatype Channel
    • DatatypeChannel(alias [,label])
  • Invalid Message Channel
    • InvalidMsgChannel(alias [,label])
  • Dead Letter Channel
    • DeadLetterChannel(alias [,label])
  • Quaranteed Deliver
    • TBD
  • Channel Adapter
    • ChannelAdapterLeft(alias [,label])
    • ChannelAdapterRight(alias [,label])
  • Messaging Bridge
    • MsgBridge(alias [,label])
  • Message Bus
    • MsgBus(alias [,label])

System Managmenet

  • Control Bus
    • ControlBus(alias)
  • Detour
    • Detour(alias [,label])
  • Wire Tap
    • WireTap(alias [,label])
  • Message History
    • TBD
  • Message Store
    • MessageStore(alias [,label])
  • Smart Proxy
    • SmartProxy(alias [,label])
  • Test Message
    • TestMessage(alias [,label])
  • Channel Purger
    • ChannelPurger(alias [,label])

Examples

Dynamic Message Router

The dynamic message router is one of the more complex patterns. To apply this stencil, you must defne the dynamic rule base to be used for this router.

The following exmaple

rectangle "Dynamic Rulebase" as rulebase
DynamicRouter(dynamicrouter, "My Dynamic Router", rulebase)

Message(msg, "My Message")
Send(msg, dynamicrouter)

MsgChannel(queue1, "My Destination 1")
Send(dynamicrouter, queue1)

MsgChannel(queue2, "My Destination 2")
Send(dynamicrouter, queue2)

results in the graphic below:

Dynamic Message Router Example

Claim Check

The Claim Check pattern can be applied to other patterns. There are several ways, this can done using the EIP-PlantUML as shown by the following example. It can be either used as alternative sterotype, as iconic label or as a label combined with a label text.

ContentFilter(filter1) <<$claim_check>>

ContentFilter(filter2, "<$claim_check>")

ContentFilter(filter3, "secure filter <$claim_check>")

Claim Check Example

Messaging Mapper

The Messaging Mapper transofrms domain objects into messages required by the messaging mapper and vice versa.

Therefore, EAI-PLantUML introduces the following metapher for the Messaging Mapper.

Messaging Mapper Metapher

The original example introduced by G. Hoppe then can be written like

rectangle "Business Object" as obj
component [Messaging\nInfrastructure] as infra
MessagingMapper(mapper, "Messaging Mapper") 
obj -- mapper
Send(mapper, infra)

Messaging Mapper Example

Control Bus

A Control Bus is used to manage an enterprise integration system. It uses the same messaging mechanism used by the application data, but uses separate channels to transmit data that is relevant to the management of components involved in the message flow.

The following example shows how to create the original Control Bus example easily with PlantUML while connecting each system using the <--> command.

rectangle System1
rectangle System2
rectangle System3 

Message(source) 
Message(target) 

ControlBus("cb") 

Send(source, System1) 
Send(System1, System2) 
Send(System2, System3) 
Send(System3, target) 

System1 <--> cb 
System2 <--> cb 
System3 <--> cb

Contol Bus Example

Additional Features

Stereotypes

While stereotypes are great for new users and small examples, documentation frequently used often does not need this additional metadata. Therefore, stereotypes can be swithed off for the overall diagramm using HIDE_STEREOTYPES().

The following example shows an example with hidden sterotypes.

HIDE_STEREOTYPES()

Message(src, "source")
MsgChannel(queue, "queue")
Message(dest, "destination")
Send(src, queue)
Send(queue, dest)

Diagram without stereotypes

Horizontal Layout

In some cases it is required to use a horizontal layout. You can force this layout by calling

LAYOUT_LEFT_RIGHT()

Tests

Tests and scripts are located in the testfolder of this project.

Test Script: testlabel.sh

In issue #29 there was an issue reported where _labels have been not rendered. This ussue was reported on Windows 10 using PLantUML v1.2019.8. To avoid this, in the definition string, the label declaration has to be precendet by a space. This test script verifies this requirement. The script return 0if the test is passend, 1otherwise.

 FAILED: Issues detected
420:!define ChannelAdapterLeft(_alias, _label) rectangle "<$channel_adapter_left>\r_label" as _alias <<channel adapter left>> 
422:!define ChannelAdapterRight(_alias, _label) rectangle "<$channel_adapter_right>\r_label" as _alias <<channel adapter right>> 
AndreassMacBook:test andreas$ ./testlabel.sh 
 PASSED: No issues detected.

Background

Enterprise Intergartion Patterns are a set of 65 patterns, mainly based on messaging concepts introduced Gregor Hohpe and Bobby Woolf. The Website Enterprise Integration Patterns provides an extensive overview of these patterns.

These patterns come in handy when dealing with large scale enterprise architectures especially based on messaging systems.

While documenting large systems with manual tools like Microsoft Visio takes an enourmous amount of time, PlantUML provides an elegant way of coding such architecures top-down or creating documentation based on your source codes.

There fore the EIP patterns is designed to support this bottom up documentation. The EIP patterns also play well with the C4-PlantUML extension by Ricardo Niepel when it comes to Level 4 of the C4 model.

The C4 Model is a elegant way introduced by Simon Brow for describing and communicating software architectures up-front.

Feedback

@aheil
#eipplantuml

Contribution

If interested in contributing to this project, please make sure to read the Contribution Guidelines first.

Further References