Versions Compared

Old Version 5

changes.mady.by.user Space Sync for Confluence

Saved on

compared with

New Version 6

changes.mady.by.user Space Sync for Confluence

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

As outlined in What are tags?, Tags can contain additional data (attributes), which can be uniquely set for each entity-tag (i.e. Tag applied to a person or a team). This is useful if you seek to have common Tag names, but “data” (i.e. attributes) that is unique to the person/team to which a tag is applied.

This pages defines how to load unique entity-tag attributes.

Info

Note: this is a special case of Tags With Attributes use. For more about importing Tags with Attributes, see: Bulk import Tags with attributes (common attributes)

...

.

About unique attributes for tags

Enabling attributes for tags

Note

Tags attributes need to be

...

enabled by a TeamForm consultant via admin devtools, using the workspace feature flags

...

“enableEntityTagAttributes.”

...

Image Added

Tags with Unique Attributes to an Entity an can then be added via tag type settings (manage tags):

Image Added

...

Tag config view (Setting → Manage Tags)

...

An example edit view when editing a tag applied to a person or team (select Person/ Team, Edit Tag)

...

Configuring tags attributes

Tags attributes can be configured from Settings > Manage tags.

Image Added

Users can then associate values to the attributes when editing tags applied to a group or person. Navigate to a group or person page then select Edit tag.

Image Added

Interaction Options for Unique Attributes

image-20240228-035611.pngImage Added

  • Optional - The attribute is not required, its value can be edited from the directory

  • Editable - not currently in use

  • Mandatory - The attribute must be provided when tagging a group or person, can be edited from the directory

  • Readonly - The attribute value cannot be edited from the directory

Importing tags and their unique attributes

Importing unique attributes along with a tag import can be done using specific pre-processing instruction using the normal integration for tag import.
An example of CSV file and JSON field map is provided below.

Expand
titleSample CSV and JSON Fields Map

Sample CSV file

Code Block
Sample JSON Field Map
 Code Block
languagejson
{
  "entityType": "group",
  "skipRemoveTagsFromEntity": true,
  "preprocessor": "phoenixGenericTags",
  "headerRowIdentifier": "Organization Ref ID",
  "idType": "externalId",
  "idColumnName": "Organization Ref ID",
  "tagTypes": [
    {
      "tagValueColumnNames": ["Employee ID"],
      "separator": "_",
      "tagTypeColumnName": "Role Name",
      "tagTypeNamesMap": {
        "Project Hierarchy Manager": "Group Owner",
        "Project Manager": "Product Owner",
        "Project Hierarchy Performance Lead": "GPL"
      },
      "attributes": {
        "entityTag": [
          {
            "action": "optional",
            "associatedValue": "",
            "defaultValue": "",
            "label": "Country",
            "attrValueColumnName": "Country",
            "type": "text"
          },
          {
            "id": "bcd123",
            "action": "optional",
            "associatedValue": "",
            "defaultValue": "",
            "label": "Group Manager",
            "attrValueColumnName": "Group Manager",
            "type": "person"
          }
        ],
        "others": [
          {
            "action": "optional",
            "associatedValue": ["Agile Group"],
            "label": "Group name",
            "type": "groupType"
          }
        ],
        "values": [
          {
            "action": "optional",
            "associatedValue": "",
            "defaultValue": "",
            "label": "Supervisory Manager",
            "attrValueColumnName": "Manager ID",
            "type": "person"
          },
          {
            "id": "abc123",
            "action": "optional",
            "associatedValue": "",
            "defaultValue": "",
            "label": "Manager group lead",
            "attrValueColumnName": "Manager Group Lead",
            "type": "person"
          }
        ]
      }
    }
  ],
  "importShadowTag": false
}

Downloadable file: 
 View file
nameimportTagsWithAttributesFieldsMap.json
 Interaction Options for Unique Attributes:
...
  • Optional - is not required, can be edited 
  • Editable - not currently in use 
  • Mandatory - must be provided when creating, can be edited
...