Overview

Tag your components to find them more easily.

tags are metadata defined on a component to characterize it and make it easier to find.

This metadata can be of different types to ensure consistency of the data stored in FlowerDocs.


A tag class defines the typology and characteristics of a tag within a scope. This tag class applies to all tags associated with components, and is made up of the following elements:

  • id: technical tag identifier
  • displayNames: tag display name (ex : Agency name, building no., etc.) internationalized
  • searchable: Boolean to make the tag searchable or not
  • Type: tag id
Type Description
STRING String (e.g. reference, customer name …)
TEXT Text field (ex: comment …)
CHOICELIST Choice list (e.g. type of document …)
ICON Icon list (e.g. input channel …)
FREELIST Choice list (e.g.: reference linked to an external IS …)
CONDITIONAL Conditional value list (e.g.: list of departments according to direction …)
FLOAT Decimal number (e.g.: rate, proportion …)
INT Integer (e.g.: number of supporting documents …)
CURRENCY Decimal number limited to 2 decimal places (e.g.: amount …)
DATE Date (e.g. due date …)
BOOLEAN Check box (e.g.: medical confidentiality …)
USER Linked to a directory user (e.g. manager)


Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:TagClass xmlns="http://flower.com/docs/domain/common" xmlns:ns2="http://flower.com/docs/domain/tagclass"
	xmlns:ns3="http://flower.com/docs/domain/i18n">
	<id>Identifier</id>
	<ns2:displayNames language="EN">
		<ns3:value>Display name</ns3:value>
	</ns2:displayNames>
	<ns2:displayNames language="FR">
		<ns3:value>Display name</ns3:value>
	</ns2:displayNames>
	<ns2:data>
        <owner>owner</owner>
        <creationDate>2017-10-03 2332.169 +0200</creationDate>
        <lastUpdateDate>2017-04-02 1140.909 +0200</lastUpdateDate>
    </ns2:data>
	<ns2:type>TYPE</ns2:type>
    <ns2:searchable>true</ns2:searchable>
</ns2:TagClass>


Add tags to your components by referencing a tag class at component class level.