Generic Ontology - Custom properties in ER entity model on entity and/or attribute level


#1

I am interested if there is way to extend the schema to support easily custom metadata on entities and/or attributes (columns), so they can be later exported into XML and processed and also will be included in published documentation.

Generic ontology tools give you much bigger range in form of what you can do, maybe you should try to adopt this for later times and new design of VP.

Example requirement:
I have in data source file information which can be split into 4 different areas from domain model perspective:

  • General Context - person, address, etc.
  • General Master Data Context - Country, Region mapping tables
  • Specific Domain Data - Account, Installation
  • Specific Master Data Context - Product, etc.

So I have something like 4 labels which I would like to bind on entities for later usage.

Or is there only way by writing my own VP plugin?

Thanks for any hints.


#2

You can use Tagged Value as custom properties.

Tagged Value can produce using three ways:

  • Ad-Hoc (create for specific model when need)
  • Default Tagged Value (base on model-type, default created for specific model-type)
  • Stereotype (available when specific model applied the stereotype)

For your case, I suggest using Stereotype.
You can see below page for more details.
https://www.visual-paradigm.com/tutorials/how-to-use-stereotypes-and-tagged-values.jsp

About “include in published documentation”
It depends which way you publish documentation,
but in most of cases, Tagged Value already included by default.


#3

Does tagged values supports ER diagrams?


#4

No, just classes are supported.


#5

Hi Ladislav,

Shapes in ER diagrams also support tagged values, if you cannot find tagged values tab in the specification window of a shape (e.g. Entity), try to look it up from the hidden tabs:

Hope this helps,

Antony.


#6

thank you @antony - I wasn’t aware of this combobox there :smiley:


#7

@roykeung - is tagged value supported on attribute level as well. See during our analysis, I would like to mark some field as SENSITIVE or other classification, I know I can use documentation, but some Key/Value store is better for such purpose.

Thank you.


#8

Hi Ladislav,

Most of the model elements in Visual Paradigm can be configured to use stereotypes together with tagged values, class members like attribute and operation support them too. The link Roy posted above shows you how to apply them to actor, but it is no different for attribute.

Here shows how I defined a custom stereotype for attribute called “MyStereotype” with one boolean tagged value “Sensitive” default to false. By selecting from the diagram’s popup menu item “Presentation Options” > “Show Tagged Values” > “Show All”, you see I could make the tagged values visible in the diagram as well.

Hope this helps,

Antony.


#9

You are right, thx for confirmation, I am just blind :-))

thanks again!

Ladislav


#10

@antony @roykeung - so yes, I can add both tagget values or stereotypes which can define tagged values. Thing is that when I publish the project I see:

On entity level
Only stereo type is visible as parameter in generate documentation

on attribute level
neither stereotype or tagged value is visible

Is it possible to customize Publisher ? I didn’t find much documentation on this.

I already esteablished automated publishing to web server with VP, so its really nice feature after every commit I have fresh view for public users.

Thanks for any hints and helpful thoughts.

Ladislav


#11

Sorry, on my testing,
the class’s Stereotype & Tagged Value, and attribute’s Tagged Value can be shown,
but the attribute’s Stereotype is missing.


We will fix to show the attribute’s stereotype.

PS: My testing result is different to your description. If I misunderstand your problem, may you describe more details? Thanks.


#12

@peter.wong - ok, so this is behavior on Class, but ER Entity has even different behavior from Class, I think only Stereotype on Entity is visible, the rest is not.

It will be valuable to display these as well on Entity layer.


#13

@peter.wong - I checked the ER diagram entity.

I have following defintion of both stereotype and tagged value on ATTRIBUTE level:

I am just trying to mark attribute as Sensitive, so it is visible in documentation as well.

But in documentation it shows only folloowing on attribute “First Name”:

So it is possibly bug?

Otherwise Stereotype and tagged values are shown on Entity level, but attribute is missing completely for both stereotype and tagged values.


#14

Thanks for your information. We will fix it soon.

FYI. the Attribute’s Stereotypes are fixed and ready in latest patch.


#15

The fix has been fixed and is ready in latest patch build.


#16

thx for info, will test.