Administration of tag federation

Administration of tag federation

When tags from remote systems, such as IBM Connections are integrated into the portal site, a task must be scheduled to retrieve tags and related data from the remote system.

Import federated tags and resources

When tags from remote systems, such as IBM Connections are integrated into WebSphere Portal, a task must be scheduled to retrieve the tags and related data from the remote system.
To retrieve tags and related resource for federation, a task named com.ibm.wps.cp.tagging.federation.taskhandler.FederationTaskHandler must be scheduled in WebSphere Portal using xmlAccess. Refer to the following example where the xmlAccess script task, triggerTask.xml, is scheduled to run once a day.
<?xml version="1.0" encoding="UTF-8"?>
    <request type="update" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:noNamespaceSchemaLocation="PortalConfig_8.0.0.xsd">      <portal action="locate">           <task action="create" name="com.ibm.wps.cp.tagging.federation.taskhandler.FederationTaskHandler">              <startTime>22:00</startTime>          </task>     </portal>
</request>
This tasks handles all IBM Connections features.
We can also specify which IBM Connections features a task should handle.
For example, data for IBM Connections wikis and blogs can be collected on a different schedule than IBM Connections files. Refer to the following example.
<request type="update" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"            xsi:noNamespaceSchemaLocation="PortalConfig_8.0.0.xsd">      <portal action="locate">
          <task action="create" name="com.ibm.wps.cp.tagging.federation.taskhandler.FederationTaskHandler">
              <startTime>12:00</startTime>                 <parameter>wikis</parameter>
              <parameter>blogs</parameter>
        </task>
        <task action="create" name="com.ibm.wps.cp.tagging.federation.taskhandler.FederationTaskHandler">
              <startTime>07:00</startTime>           <parameter>files</parameter>
        </task>
      </portal>
</request>
The parameter element contains the ID of the IBM Connections feature. These IDs are listed on the page Federating Tags
The FederationTaskHandler script must run to retrieve changes in the IBM Connections tag cloud.
Carefully consider which features to integrate into portal. As with each IBM Connections feature, there is potential for coupling large amounts of data.

Cleaning up federated tags and resources

When federated tags are no longer integrated in WebSphere Portal, the com.ibm.wps.cp.tagging.federation.taskhandler.FederationDeletionTaskHandler must be invoked to remove unnecessary data.
Refer to the following example where the xmlAccess script, triggerDeleteTask.xml, shows how to schedule the task to cleanup federated tags:
<?xml version="1.0" encoding="UTF-8"?>
    <request type="update" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"                   xsi:noNamespaceSchemaLocation="PortalConfig_8.0.0.xsd">
        <portal action="locate">         <task action="create"                name="com.ibm.wps.cp.tagging.federation.taskhandler.FederationDeletionTaskHandler"/> </portal></request>
Since no schedule is defined explicitly, the task is performed immediately. As for the import it is possible to specify the IBM Connections features for which the clean up should be run.

Redirect to IBM Connections site

When a IBM Connections resource is clicked in the result list portlet, this resource is rendered within a IBM Connections portlet, is that portlet exists and can handle this resource (See IBM Connections documentation for more information about deployment and configuration of the portlets and the IBM Connections POC Resolver).
If this behavior is not desired it can be chosen to redirect to a IBM Connections Server website.
This can be accomplished via the WP CPConfigurationService Resource Environment Provider. For each IBM Connections feature a custom property exists. The name of the property follows this pattern:
com.ibm.wps.cp.tagging.federation.uri.scheme.FederatorID To redirect to the IBM Connections Server use this value pattern: connections - FederatorID
This setting is used in the next run of the FederationTaskHandlethat retrieves IBM Connections tags and tagged resources. Aftethat a redirect to the external IBM Connections website is possible.
For details on how to set properties to the WebSphere Portal Configuration service, refer to the topic about the Setting service configuration properties.

Specify an icon for a federated resource

When federated resources are displayed in the Tag Results portlet they can be preceded by a icon.
To define an icon for a resource type it is required to specify a custom property with either a URI for the image or a relative path that is attached to the base URL of the IBM Connections service of the resource type.
The name of the custom property for the icon follows this pattern: com.ibm.wps.cp.tagging.federation.iconURL.FederatorID.
See topic "Federating tags" where the ID for a IBM Connections feature is documented
The custom properties belong to the WP CPConfigurationService Resource Environment Provider. For details how to set properties to the WebSphere Portal Configuration service refer to the topic about the Setting service configuration properties.
For theIBM Connections features the custom properties for the icons exist without a predefined path. Unless no icon URL is defined icons are loaded directly from portal, as they are part of the Portal Server installation.

Parent: Tagging and rating
Related:
Search for tagged content
Federating tags
Related reference:
How tagging and rating works in the portal
The tagging and rating user interface
Tagging and rating for static pages
Allow our own custom content to be tagged and rated
Configuration reference
Security for tagging and rating
Use xmlaccess.sh to administer tags and ratings
Tips for tagging and rating