Author Topic: How let a report template change appearance in diagrams?  (Read 471 times)

Mikael S

  • EA Novice
  • *
  • Posts: 3
  • Karma: +0/-0
    • View Profile
How let a report template change appearance in diagrams?
« on: October 06, 2017, 02:08:55 am »
Use-case reports are intended to give the whole picture, but usually developers and testers feel confused when the report contains requirements and flows which will be implemented in a later release.

I'm trying to figure out a way to gather the requirements in one model, no matter the release, but let a release tag control which ones are included in the use case report. The real trouble are the diagrams. The excluded requirements need to remain as elements in the diagram elements but with a different appearance, for example a dotted contour, to set them apart.

Is the appearance of diagram elements something a report template can affect dynamically?

qwerty

  • EA Guru
  • *****
  • Posts: 8972
  • Karma: +136/-124
  • I'm no guru at all
    • View Profile
Re: How let a report template change appearance in diagrams?
« Reply #1 on: October 06, 2017, 07:24:39 am »
I have not much of an idea about EA's documentation features. But changing the appearance depending on tagged values is something you can achieve with shape scripts rather easily.

q.

Sunshine

  • EA User
  • **
  • Posts: 500
  • Karma: +33/-1
  • Amicorum omnia communia
    • View Profile
Re: How let a report template change appearance in diagrams?
« Reply #2 on: October 06, 2017, 12:39:22 pm »
I've used phase to indicate which phase the requirements should be implemented in. You can then add a filter in the doc gen template to only include requirements, usecases etc for a particular phase. Now the trick is to use the "one of..." option on the element filter so that for phase 2 you include phase 1 as well 2. For example  "1.0,2.0" - can't remember if that is the correction format comma separated values or whether its semi-colons or something else but I think you get the idea.

Paolo F Cantoni

  • EA Guru
  • *****
  • Posts: 5882
  • Karma: +71/-79
  • Inconsistently correct systems DON'T EXIST!
    • View Profile
Re: How let a report template change appearance in diagrams?
« Reply #3 on: October 06, 2017, 05:36:40 pm »
I've used phase to indicate which phase the requirements should be implemented in. You can then add a filter in the doc gen template to only include requirements, usecases etc for a particular phase. Now the trick is to use the "one of..." option on the element filter so that for phase 2 you include phase 1 as well 2. For example  "1.0,2.0" - can't remember if that is the correction format comma separated values or whether its semi-colons or something else but I think you get the idea.
As I discovered, you need to separate the values by the appropriate quote character for your DB, this for SQL Server it would be: '1.0','2.0'

Paolo
Inconsistently correct systems DON'T EXIST!
... Therefore, aim for consistency; in the expectation of achieving correctness....
-Semantica-
Helsinki Principle Rules!

Mikael S

  • EA Novice
  • *
  • Posts: 3
  • Karma: +0/-0
    • View Profile
Re: How let a report template change appearance in diagrams?
« Reply #4 on: October 10, 2017, 07:35:24 pm »
I've used phase to indicate which phase the requirements should be implemented in. You can then add a filter in the doc gen template to only include requirements, usecases etc for a particular phase. Now the trick is to use the "one of..." option on the element filter so that for phase 2 you include phase 1 as well 2. For example  "1.0,2.0" - can't remember if that is the correction format comma separated values or whether its semi-colons or something else but I think you get the idea.

That's not all there's to it. All steps in for exampel a sequence diagram need to be included, or the diagram will be messed up. But I only want the ones implemented up to the specified release to be displayed with a solid contour, the future ones should have a dotted contour.

Mikael
« Last Edit: October 10, 2017, 08:10:58 pm by Mikael S »

Mikael S

  • EA Novice
  • *
  • Posts: 3
  • Karma: +0/-0
    • View Profile
Re: How let a report template change appearance in diagrams?
« Reply #5 on: October 10, 2017, 07:37:16 pm »
I have not much of an idea about EA's documentation features. But changing the appearance depending on tagged values is something you can achieve with shape scripts rather easily.

q.

Thanks for the suggestion.

Marc Vanstraelen

  • EA User
  • **
  • Posts: 35
  • Karma: +5/-0
    • View Profile
Re: How let a report template change appearance in diagrams?
« Reply #6 on: October 10, 2017, 08:44:38 pm »
You could consider adding a Diagram Legend to your diagrams, with the option "apply auto colour". This allows to automatically change the appearance of elements based on a property, e.g. the Phase or Status. You can change the fill colour as well as the appearance of the borders.

This of course impacts your diagrams directly, not only the generated documentation.

There are also diagram filters that can gray out or hide elements based on selection criteria, but I have no idea if these can be made to be applied during document generation...

Sunshine

  • EA User
  • **
  • Posts: 500
  • Karma: +33/-1
  • Amicorum omnia communia
    • View Profile
Re: How let a report template change appearance in diagrams?
« Reply #7 on: October 11, 2017, 12:07:59 pm »
...
There are also diagram filters that can gray out or hide elements based on selection criteria, but I have no idea if these can be made to be applied during document generation...
Enable the filter then generate the doc

Marc Vanstraelen

  • EA User
  • **
  • Posts: 35
  • Karma: +5/-0
    • View Profile
Re: How let a report template change appearance in diagrams?
« Reply #8 on: October 12, 2017, 01:54:04 am »
Just tried this and it works... Almost too simple to be true  :)

cjcrystal

  • EA Novice
  • *
  • Posts: 15
  • Karma: +0/-0
    • View Profile
Re: How let a report template change appearance in diagrams?
« Reply #9 on: October 17, 2017, 04:32:29 pm »
Just tried this and it works... Almost too simple to be true  :)

 may i ask where you mapped your release tag  to the filter you wanted to set?

was it in the EXCLUDE Filter , ELEMENT, or OTHER


Sunshine

  • EA User
  • **
  • Posts: 500
  • Karma: +33/-1
  • Amicorum omnia communia
    • View Profile
Re: How let a report template change appearance in diagrams?
« Reply #10 on: October 18, 2017, 08:27:51 am »
I use the phase field and the filter to include one or more filters. So I might have a number of elements with phase 1.0, 2.0, 3.0 etc then create filters that include phase = '1.0', '2.0', '3.0' and enable one or more filters.
Now there are two patterns I've observed using this
a) Phased approach to implementing some system so that when the last phase is reached everything is included and all the filters enabled.
b) A phased approach to adding some components and retiring others. This requires a slightly different approach where in the phase I include the phases in which the component exists. For example if component A already exists and component B is being add lets say in phase 2 to replace it I might have 3 phases.
Phase 1.0 - component A only
Phase 2.0 - component A and B exist
Phase 3.0 - component B exists and component B has been retired.

Component A phase field = '1.0, 2.0'
Component B phase field = '2.0, 3.0'

I would use a filter that says contains rather than equals a phase value like '3.0'
Hope that helps.
 :)

cjcrystal

  • EA Novice
  • *
  • Posts: 15
  • Karma: +0/-0
    • View Profile
Re: How let a report template change appearance in diagrams?
« Reply #11 on: October 18, 2017, 06:56:00 pm »
 :) its helpful, thanks @ Sunshine

Sunshine

  • EA User
  • **
  • Posts: 500
  • Karma: +33/-1
  • Amicorum omnia communia
    • View Profile
Re: How let a report template change appearance in diagrams?
« Reply #12 on: October 18, 2017, 07:59:58 pm »
:) its helpful, thanks @ Sunshine
karma points welcome  ;)

Geert Bellekens

  • EA Guru
  • *****
  • Posts: 7752
  • Karma: +165/-21
  • Make EA work for YOU!
    • View Profile
    • Enterprise Architect Consultant and Value Added Reseller
Re: How let a report template change appearance in diagrams?
« Reply #13 on: October 18, 2017, 08:08:45 pm »
:) its helpful, thanks @ Sunshine
karma points welcome  ;)

You can only give/take karma from a certain number of posts.
I don't remember how much exactly; I think 20 or 25 or something like that.

Geert