| Table of Contents |
|---|
What is a Property Tag?
A Property Tag can be used to attach keywords or metadata to properties so it is easier to group a set of Properties in the Property Store and build relations between them.
Each Property can be assigned to one or more Property Tags:
...
A Tag has a name unique within the namespace. Additionally, an optional value can be set which can contain additional metadata about the relationand search for properties with these tags later. Furthermore, a Property Tag can also be used as label to categorize and classify properties.
| Info |
|---|
Sometimes a Tag is also referred to as a Label even if both approaches are slightly different. But both concepts can be implemented in PIPEFORCE using the Property Tag feature. Therefore, to simplify, we will use the name Tag for both approaches. |
...
A Tag has a name and an optional value. This tag can then be assigned to one or more properties. Later you can filter for all properties having this certain tag or list all tags of a given property.
Example: Lets assume you store job applications (CVs, candidate information, …) in the property store and you would like to mark all job applications those candidates are selected to be invited for an interview, you could set the tag invite on each of these properties with an optional value of true or false. Later, you can easily find all properties which are selected for an interview and those, a rejection letter must be send for.
Create a Tag
In order to create a Tag and add it to a Property, you can use the command property.tag.put.
...
| Code Block | ||
|---|---|---|
| ||
pipeline:
- property.tag.put:
path: global/app/jobs/applicant/1
name: invite
value: true |
For more information see: https://pipeforce.github.io/docs/api/commands#propertytagput-v1
List Tags
To list all tags on a given property, you can use the command property.tag.list.
...