Utilisation de l'interface de configuration XML pour administrer les étiquettes et évaluations

Vous pouvez utiliser l'interface de configuration XML pour gérer l'étiquetage et l'évaluation dans le portail. Par exemple, vous pouvez déplacer des espaces d'étiquette et des évaluations entre les versions du portail ou à des fins de transfert.

Les ressources XML liées à l'étiquetage et à l'évaluation sont tag, rating et custom-resource. Les ressources de portail et les ressources personnalisées sont étiquetées et évaluées de différentes façons :

Pour étiqueter ou évaluer les ressources de portail, vous devez utiliser leur ID objet.
Pour représenter des ressources personnalisées, telles que des livres, par exemple, utilisez la ressource XML custom-resource. L'ID objet de la ressource custom-resource est utilisé comme atribut resourceref dans les étiquettes tag et rating.

Les étiquettes de ressource XML et leurs attributs sont répertoriés dans les rubriques suivantes.

Notes :

Lorsque vous créez des étiquettes, des évaluations ou des ressources personnalisées, vous devez spécifier tous les attributs, sauf ceux marqués comme étant facultatifs.
Lorsque vous déplacez des espaces d'étiquettes entre les portails, les deux utilisateurs ayant appliqué les étiquettes et les ressources auxquelles les étiquettes ont été appliquées doivent exister dans le portail cible.
Vous pouvez mettre à jour des évaluations existantes mais pas des étiquettes existantes à l'aide de l'interface de configuration XML. L'interface de configuration XML action="update" fonctionne uniquement pour la création implicite d'une balise.

étiquette

Utilisez les attributs suivants avec l'étiquette de ressource XML tag :

resourceref = "object_ID"

Cet attribut spécifie la référence à la ressource étiquetée.

domain = "comm | cust"

Cet attribut spécifie le domaine de base de données pour la ressource étiquetée. Les valeurs possibles sont les suivantes :

cust: Indiquez cette valeur pour les étiquettes privées.
comm: Indiquez cette valeur pour les étiquettes publiques.

locale

Cet attribut spécifie l'environnement local de l'étiquette. Cet attribut est facultatif. La valeur par défaut est null.

owner = "user"

Cet attribut spécifie le propriétaire de l'étiquette.

rating

Utilisez les attributs suivants avec l'étiquette de ressource XML rating :

resourceref = "object_ID"

Cet attribut spécifie la référence à la ressource évaluée.

domain = "comm | cust"

Cet attribut indique le domaine de base de données de la ressource évaluée. Les valeurs possibles sont les suivantes :

cust: Indiquez cette valeur pour les évaluations privées.
comm: Indiquez cette valeur pour les évaluations publiques.

value = "integer"

Cet attribut indique la valeur de l'évaluation.

owner = "user"

Cet attribut spécifie le propriétaire de l'évaluation.

custom-resource

Cette étiquette permet de représenter les ressources personnalisées, les livres par exemple. Utilisez l'attribut suivant avec l'étiquette de ressource XML custom-resource :

uri = "string": Cet attribut spécifie un identificateur URI qui identifie la ressource personnalisée.

Utilisez la sous-étiquette suivante avec l'étiquette de ressource XML custom-resource :

category-instance

Utilisez la sous-étiquette category-instance pour attribuer une catégorie sous la forme d'une chaîne à une ressource personnalisée. Vous pouvez attribuer plusieurs catégories à une ressource personnalisée. Utilisez l'attribut suivant avec la sous-étiquette category-instance :

name = "category_instance_name": Utilisez cet attribut pour spécifier un nom pour une instance de catégorie.

Reportez-vous aux exemples de code suivants.

Exemple : Exportation d'étiquettes et d'évaluations

<?xml version="1.0" encoding="UTF-8" ?> 
<request
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="PortalConfig_8.5.0.xsd"
    type="export">

    <!-- This sample exports all custom resources, ratings, and tags.        
         Related sample files:
             CreateTagsAndRatings.xml 
             DeleteTagsAndRatings.xml
     -->
    <portal action="locate">
    
        <custom-resource action="export" objectid="*"/>
        <rating action="export" objectid="*"/>
        <tag action="export" objectid="*"/>

        <!-- Export all tags with a specific locale in the system -->
        <!-- <tag action="export" objectid="*" locale="SPECIFIC_LOCALE"/> -->

    </portal>
</request>

Exemple : Création d'étiquettes et d'évaluations

<?xml version="1.0" encoding="UTF-8"?>
<request
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="PortalConfig_8.5.0.xsd"
    type="update">

    <!-- This sample creates ratings and tags.
    
         Related sample files:
             ExportTagsAndRatings.xml 
             DeleteTagsAndRatings.xml
             
    
         NOTE: This sample file needs to be modified before execution.
               Update the value of the 'owner' attributes of the 'access-control',
               'rating', and 'tag' tags, and specify an existing user. 
    -->
     
    <portal action="locate">

        <!-- Parent element under which a new page for this sample is inserted -->
        <content-node action="locate" objectid="parentPage" uniquename="ibm.portal.Home"/>

        <!-- A new empty page to which a tag and rating are assigned.-->
        <content-node action="update" objectid="samplePageOID" 
                      uniquename="ibm.portal.SamplePage.TagsAndRatings" 
                      ordinal="last" content-parentref="parentPage" 
                      active="true" create-type="explicit" type="page">
            <supported-markup markup="html" update="set"/>
            <localedata locale="en">
                <title>Sample page for tag and rating creation</title>
            </localedata>
        </content-node>


        <!-- A custom resource can be used to assign tags and ratings to resources 
             that are not managed by XMLAccess, but can be identified by an URI -->
        <custom-resource action="update" objectid="CH_B1L68B1A00DO80IG7PCV0I1000" 
                         uri="book:mySampleBookURI">
            <category-instance action="update" name="cookbook"/>
            <category-instance action="update" name="hardcover"/>
        </custom-resource>

        <!-- Assignment of a rating value of 5 by user wpsadmin to the sample page -->
        <rating action="update" objectid="CJ_B1L68B1A00DO80IG7PCV0I2000" 
                resourceref="samplePageOID" domain="comm" value="5" 
                owner="uid=wpsadmin,o=defaultwimfilebasedrealm" />
        <!-- Assignment of a rating value of 5 to the custom resource -->
        <rating action="update" objectid="CJ_B1L68B1A00DO80IG7PCV0I3000" 
                resourceref="CH_B1L68B1A00DO80IG7PCV0I1000" domain="comm" value="5" 
                owner="uid=wpsadmin,o=defaultwimfilebasedrealm"/>

        <!-- Assignment of the tag 'sample' to the sample page -->
        <tag action="update" objectid="CI_B1L68B1A00DO80IG7PCV0I4000" 
             resourceref="samplePageOID" domain="comm" 
             owner="uid=wpsadmin,o=defaultwimfilebasedrealm" locale="en">sample</tag>
        <!-- Assignment of the tag 'sample' to the custom resource -->
        <tag action="update" objectid="CI_B1L68B1A00DO80IG7PCV0I5000" 
             resourceref="CH_B1L68B1A00DO80IG7PCV0I1000" domain="comm" 
             owner="uid=wpsadmin,o=defaultwimfilebasedrealm" locale="en">sample</tag>

    </portal>
</request>

Exemple : Suppression d'étiquettes et d'évaluations

<?xml version="1.0" encoding="UTF-8"?>
<request
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="PortalConfig_8.5.0.xsd"
    type="update">

    <!-- This sample deletes ratings and tags.
        
         Related sample files:
             CreateTagsAndRatings.xml 
             ExportTagsAndRatings.xml
         
         NOTE: This sample assumes that the CreateTagsAndRatings.xml sample was 
         executed before.  
     -->
    <portal action="locate">

        <!-- Delete the custom resource created by sample CreateTagsAndRatings.xml -->
        <custom-resource action="delete" objectid="CH_B1L68B1A00DO80IG7PCV0I1000"/>

        <!-- Delete all custom resources in the system -->
        <!-- <custom-resource action="delete" objectid="*"/> -->

        <!-- Delete the ratings created by sample CreateTagsAndRatings.xml -->
        <rating action="delete" objectid="CJ_B1L68B1A00DO80IG7PCV0I2000"/>
        <rating action="delete" objectid="CJ_B1L68B1A00DO80IG7PCV0I3000"/>

        <!-- Delete all ratings in the system -->
        <!--  <rating action="delete" objectid="*"/> -->

        <!-- Delete the tags created by sample CreateTagsAndRatings.xml -->
        <tag action="delete" objectid="CI_B1L68B1A00DO80IG7PCV0I4000"/>
        <tag action="delete" objectid="CI_B1L68B1A00DO80IG7PCV0I5000"/>

        <!-- Delete all tags in the system -->
        <!-- <tag action="delete" objectid="*"/> -->

        <!-- Delete all tags with a specific locale in the system -->
        <!-- <tag action="delete" objectid="*" locale="SPECIFIC_LOCALE"/> -->

    </portal>
</request>

Transfert d'étiquettes et d'évaluations entre les portails à l'aide de l'interface de configuration XML

Pour déplacer les étiquettes et les évaluations entre les portails, par exemple à des fins de transfert, procédez comme suit :

Assurez-vous que tous les utilisateurs ayant appliqué des étiquettes et des évaluations sur le portail source existent également sur le portail cible.
Assurez-vous que toutes les ressources étiquetées et évaluées sur le portail source existent également sur le portail cible.
Utilisez le modèle de script XML fourni pour exporter toutes les étiquettes et évaluations depuis le portail source.
Importez le fichier de résultats généré à l'étape d'exportation précédente dans le portail cible.