Closed at055612 closed 5 years ago
Suggested documentation:
Information stored in repositories can be categorised (or tagged) with keywords or phrases that allow users to group or filter information labelled the same tags. Examples of this concept can be found in
Finance
, Purchases
, Human-resources
, Payroll
, Sales
, Domestic-sales
, International-sales
, Research
, ICT
, ICT-Sustainment
, etc.xslt
, lucene
, big-data
, pipeline-processor
, data-analytics
, enrichment
, visualisation
and dashboards
.I have backported what we have in the on-site schema. I have enforced UPPER_SNAKE_CASE for the tags. Possibly a mistake as lower-hyphen-case seems more common for this sort of thing but a precedent has already been set on site. Also created a TagSimpleType so it can be reused in multiple places.
We cannot enforce any enumeration on the tags as we are just copying data from an event source. The event source dictates the content such as this, not the event storage capability. If we force an enumeration, we are changing audit data which is not appropriate. The only enforcement we can make is that it is a string and not null, but one assumes .+ is pointless.
This is a similar situation to the EmailAddressSimpleType ... a user can type in any address and our event just records what is given.
Fair point @burnalting about taking tags from the event source. I had in my head that they would be tags added either post receipt with decoration, during translation or when an xml event is crafted by the client system. In your case a restriction would be unhelpful. I will change to just a string and leave the content down to local convention.
Thanks.
Address #31 and #37
Still requires some example values in the annotations.