Basic Tags import
Read What are tags? first. This describes how to load simple tags with values.
Summary
Entity tags import from excel or csv file.
Considerations
Import tags and add the tags to entity
How to create a Tags import
Go to Settings > Data Integrations and Hit the create button to create a new Integration.
Select the Tag import and Hit ‘Connect’:
Fields map
Normal CSV file like:
Entity ID,Tags,TagType
A00001,Project Manager,SPECIALIST
A00002,Engineering Lead,SPECIALIST
Importer json file looks like:
{
"entityType": "person",
"headerRowIdentifier": "Entity ID",
"skipRemoveTagsFromEntity": false,
"entityId": "Entity ID",
"tags": "Tags",
"tagType": "TagType"
}
entityType (optional)
Can be person
or group
. If you don't set it, the importer will apply to both regardless of the entity type.
headerRowIdentifier (only for xslx)
Only used for importing by excel file (vs csv importer which don’t need this field). Specify which row is the header row.
skipRemoveTagsFromEntity
If true, the import will not remove all existing tags of the specified tagType on the entity.
If false, the import will remove any existing tags of a specified tagType, if these tags not included in the upload file. Existing tags of other tagTypes will remain if tagType is not included in the upload file)
Example:
If you have a person (entity) 123 who currently has a tag type Skills ( two tags: Data Analysis, Communication) and another tag type Cost Centre 4567
You upload a file with
Entity Tag 123, Tag Type: Skills, Tags: JugglingIf "skipRemoveTagsFromEntity" : False
Person 123 will now have (just) Juggling for Skills tag type, will still have cost centre 4567 (Data Analysis, Communication tags removed, cost centre retained as tag type not in file uploaded)If "skipRemoveTagsFromEntity" : True
Person will have Skills: Juggling, Data analysis, communication and Cost Centre 4567 (Juggling added, Data Analysis and Communication retained, cost centre retained.)
entityId (optional)
The name of the entity ID column. Should be internal team id or person id.
If you leave this column empty, the tag type will be updated with the new values, without applying the tag to anything.
tags
Tag display value column. (tag value is lower cased of display value).
Can have multiple in one line, splitting by |
.
tagType
Tag type column, should be the tag type id (uppercase the tag name)
Where to find it: in Settings > Manage Workspace > Manage Tags
Pre-processors
Used to process complex tag type and tag values in csv or excel file.
Should provide:
{
processData,
importFromJsonFile,
importFromXlsxFile,
importFromCsvFile,
importFromURL,
importFromIntegrationTest
}
phoenixGenericTags
Import generic tags for entities.
FieldsMap
idColumnName
The column name of the entity id.
idType
Only used for importing tags to group. Can be externalId or internalId
.
tagTypes
Errors
Imported tags not displayed
Need to check the tag type configuration. Turn on the allow adding tag to groups or people
toggle.
If it’s for group, don’t turn on the group association
toggle.