Versions Compared

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.

...

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 can then be added via tag type settings (manage tags):

Image AddedImage Added

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-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 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.

JSON Field Map

The following example tags a

Required configuration for the import

...

  • "entityType": "person", “group” or “both”

  • "preprocessor": "phoenixGenericTags"

  • "skipRemoveTagsFromEntity": false

  • "removeExistingEntityTags": truefalse

  • "forceUpdateSameTag": true

  • "importShadowTag":false

...

Code Block
languagejson
{
  "entityType": "person",
  "preprocessor": "phoenixGenericTags",
  "skipRemoveTagsFromEntity": false,
  "removeExistingEntityTags": truefalse,
  "forceUpdateSameTag": true,
  "importShadowTag": false,
  
  "headerRowIdentifier": "Person ID",
  "idType": "internalId",
  "idColumnName": "Person ID",
  
  "tagTypes": [
    {
      "tagValueColumnNames": [
        "Tags"
      ],
      "separator": "_"
      "tagType": "FUNDING_SOURCE",
      "entityTagAttributes": [
        {
          "attrValueColumnName": "FTE",
          "label": "FTE"
        }
      ],
    }
  ]
}

...