Apply a pattern
A pattern is a piece of model your team reuses: an edge with its gateway and firewall, a resilient database pair, an event pipeline. Save it once, insert copies anywhere, and when you publish a new version, update the copies without losing the edits made on them.
On this page
Before you start
- A diagram you can edit, with the elements you want to reuse already drawn: for the Claims Platform, the API gateway, the WAF and the Claims API in their zones.
- To publish to your organisation's curated library, the right to publish there. Otherwise the pattern stays in this workspace.
Save a pattern
- Select what to reuse
Select the elements on the canvas or in the Model tree. Their children, the relationships between them and the trust zones they use go with them.
- Save the selection
Choose Save selection as pattern… in the Governance menu, or in the canvas menu of the selection. Give it a name, such as Secured public edge, a description and tags. Choose where it goes: Organisation library (curated) or This workspace. Select Save pattern.
The pattern is listed in the Standards register as a pattern with its version, and in Insert pattern….
Published versions never change. To change a pattern, save it again as a new version with Publish new version; a new version stays in the library of the first one.
Insert a pattern
- Open the patterns
In the diagram that needs it, choose Insert pattern… in the Insert menu. To insert it inside a container, select the container first and choose Insert pattern inside…
- Find and insert it
Search by name, description or tag; the organisation library comes first. Select the pattern to insert a copy.
The elements arrive with their relationships, and the Inspector says Follows a pattern (1.0.0) on each of them.
A copy is yours to edit: rename, add an element, connect it to the rest of the diagram.
Update the copies
When a newer version is published, the copies show it: the Inspector line offers the update, and the status bar counts the pattern copies of the diagram. Choose Update pattern copies in the Governance menu.
The update merges the new version into each copy. Your own edits on the copy win; where both changed the same thing, the update reports it as a conflict for you to settle. When nothing is left to do, the menu says Every pattern copy is up to date.
The integration platform
One pattern plays a special role: the platform your applications should integrate through (an API gateway, a broker, an integration service). Mark it with Mark as integration platform in the Governance menu. From then on, wherever the pattern is inserted, a direct link between two applications that bypasses it is flagged by PERF-07.
If it doesn't work
“Select the elements to reuse first, in the Model tree or on the canvas.”
Nothing is selected. Select the elements, then save the selection as a pattern.
“The pattern does not fit here.”
The element you selected cannot hold what the pattern contains. Select another element to insert into, or clear the selection and use Insert pattern…
“Follows a pattern that is not in your libraries”
The copy comes from a pattern that is not in a library you can read. The copy works as it is; it cannot be updated from here.
More: Standards.
Was this page helpful?Your answer is anonymous and counts only if you accepted measurement.
What went wrong?
Don't write personal data.