Plugin: Social tags
| Other versions of this plugin may exist. Please ensure you are viewing the documentation for the version that you are currently using. If you are not running the latest version of your plugin we recommend upgrading. See: list of all available versions of this plugin. |
Purpose
This plugin adds support to search user mentions (@username) and hash-tags (#hash-tag) to Funnelback.
It enables:
-
Detection of user mentions and hash-tags in content: When enabled on a data source it extracts user mentions and hash-tags from document content using a filter.
-
Query language support to search for user mentions and hash-tags: When enabled on a results page, it extends the query language to support search for hash-tags and user mentions.
Usage
Extracting user mentions and hash-tags
| This plugin can be used to detect hash-tags and user mentions in any data source. |
-
Enable the social-tags plugin on your data source from the Extensions screen in the administration dashboard or add the following data source configuration to enable the plugin.
plugin.social-tags.enabled=true plugin.social-tags.version=1.0.0 -
Add the social-tags filter to the filter chain
filter.classes=<OTHER-FILTERS>:com.funnelback.plugin.socialtags.SocialTagsStringFilter:<OTHER-FILTERS>The social-tags filter should be placed at an appropriate position in the filter chain (which applies the filters from left to right). In most circumstances, this should be located towards the end of the filter chain. -
Configure the plugin by setting the following optional settings in the data source configuration:
-
plugin.social-tags.config.hash-tags.disable: If set totrue, hash-tags will be ignored. By default, extracting of hash-tags is enabled. -
plugin.social-tags.config.user-tags.disable: If set totrue, user mentions will be ignored. By default, extracting of user mentions is enabled.
-
-
Run a full update of the data source must be run for any changes to apply. Note: a full update is required as all of your documents must be re-gathered and filtered for any changes to take effect. If you are using this with a push data source then you will need to resubmit anything where you want the new filter to be applied.
Extending query to search for user mentions and hash-tags
| The social tag query language extension will only detect hash-tags and user mentions that are detected with the accompanying data source filter (see above). |
Enable the social-tags plugin on your results page from the Extensions screen in the administration dashboard or add the following results page configuration to enable the plugin.
plugin.social-tags.enabled=true
plugin.social-tags.version=1.0.0| The plugin will take effect as soon as it is enabled. |
Details
When enabled on a data source, the plugin filter will analyse document content and search for any hash-tags and/or user mentions. Detected hash-tags/user mentions and counts of occurrences will be written to the following internal metadata fields:
-
Plugin-Social-Tags-Hash-Tags: contains the unique set of hash-tags found in the content -
Plugin-Social-Tags-Hash-Tags-Count: contains the total number of hash-tags in the content (including duplicates) -
Plugin-Social-Tags-User-Tags: contains the unique set of user mentions found in the content -
Plugin-Social-Tags-User-Tags-Count: contains the total number of user mentions in the content (including duplicates)
Plugin-Social-Tags-Hash-Tags and Plugin-Social-Tags-User-Tags fields will be automatically mapped to metadata classes hashTag and userTag.
Detection of hash-tags and user mentions is handled by Twitter’s official twitter-text library and applies the same rules as Twitter when identifying these in Tweets.
The count metadata fields are useful if you wish to report on hash-tags and user mention usage in the content auditor.
| The count metadata fields are not automatically mapped into a metadata class and to use it needs to be added manually on your data source via the metadata mapping configuration on a data source. |
When enabled on a results page, the plugin will analyse search query to look for any hash-tags (strings started with # character) and/or user mentions (strings started with @ character). Detected hash-tags/user mentions in the query are converted to appropriate metadata classes hashTag and userTag.
Example
Consider the tweet below:
Funnelback Plugins
New #extension was added to list of @funnelbackPlugins. #extension can be enabled via admin UI.
1:35PM Sep 13, 2021When the plugin is enabled on the data source that fetches this tweet the following metadata will be added:
The following metadata will be stored with document:
-
Plugin-Social-Tags-Hash-Tags:extension -
Plugin-Social-Tags-Hash-Tags-Count:2 -
Plugin-Social-Tags-User-Tags:funnelbackPlugins -
Plugin-Social-Tags-User-Tags-Count:1
If a results page includes results from this data source and has the social-tags plugin enabled, a user searching for funnelback #extensions will have search converted to search for funnelback hashTag:extensions.
In this case extensions will only match #extensions hash-tags that have been extracted. Without the plugin enabled the query would be run as funnelback extensions and would match any page that had the words funnelback or extensions (with or without the preceding ).