Ajout d'un schéma de source de données REST avec l'assistant de reconnaissance de schéma

Un schéma de source de données peut être créé pour une source de données REST. La création de schémas simplifie la création des canevas de document pour les modules dont la structure est la même et dont la liste d'attributs est identique ou similaire.

Pourquoi et quand exécuter cette tâche

Si vous utilisez l'assistant Reconnaissance de schéma pour créer des schémas de source de données, vous pouvez choisir l'une des deux options REST rapportables que votre application peut prendre en charge ; REST API 1.0 ou REST API 2.0. Si vous ne savez pas quelle version d'API REST votre application prend en charge, adressez-vous à votre administrateur système.

Reconnaissance de schéma (REST API 1.0)

Procédure

  1. Dans Document Studio, cliquez sur Données > Reconnaissance de schéma > Reconnaissance de schéma REST.
  2. Spécifiez les détails de connexion :
    1. Entrez un Nom pour la source de données.
    2. Entrez une Description pour la source de données.
    3. Spécifiez l'URL de base pour la ressource.
    4. Sélectionnez le Type d'authentification dans la liste. Si aucun type n'est sélectionné, chaque type est testé jusqu'à ce que le type correct soit trouvé. Si un type est indiqué, ce processus est éliminé.
    5. Si la ressource se trouve sur un serveur sécurisé, indiquez le nom de l'Utilisateur.
    6. Si la ressource se trouve sur un serveur sécurisé, indiquez le Mot de passe.
  3. Cliquez sur Suivant .
  4. Selon que votre source de données utilise ou non Data services, l'une des fenêtres suivantes s'affiche :

    Si la source de données n'utilise pas Data services, la fenêtre Créer une ressource s'affiche.

    1. Entrez un Nom pour la nouvelle ressource.
    2. Entrez une Description pour la nouvelle ressource.
    3. Entrez un Chemin relatif pour la nouvelle ressource.
    Si la source de données REST est accessible via l'adaptateur Reporting Data Services, la fenêtre de recherche à l'aide de Data services s'affiche.
    1. Sélectionnez un élément dans l'arborescence du schéma XML.
    2. Sélectionnez la valeur href dans la liste des attributs.
    3. Cliquez sur Suivant. L'URL de la ressource sélectionnée s'affiche.
  5. Sélectionnez l'adresse URL, puis cliquez sur Terminer ou utilisez l'URL permettant de rechercher la ressource enfant. Pour rechercher la ressource enfant :
    1. Sélectionnez l'URL de la ressource et cliquez sur Suivant.
    2. Sélectionnez un élément dans le volet du schéma XML.
    3. Sélectionnez href dans la liste des attributs.
  6. Si vous avez trouvé une ressource enfant, cliquez sur Terminer. L'exécution de l'assistant est terminée et l'URL s'affiche dans la fenêtre Configuration. Entrez un nom d'utilisateur et un mot de passe dans la fenêtre de configuration si la ressource se trouve sur un serveur sécurisé.

Reconnaissance de schéma (REST API 2.0)

Pourquoi et quand exécuter cette tâche

Remarque : Rational Publishing Engine ne prend en charge que le RDF abrégé. Les fournisseurs doivent accepter et honorer les demandes application/xml. Voir Open Services for Lifecycle Collaboration Core Specification Version 2.0.
Rational Publishing Engine ne prend en charge que les fournisseurs OSLC v2 qui respectent la spécification REST v2 rapportable.
  • Les fonctions de requête d'un service OSLC doivent être définies dans la ressource de service de toutes les ressources destinées à la génération de rapports.
  • Chaque fonction de requête pour la génération de rapports :
    • Doit avoir oslc:queryBase qui pointe vers la ressource qui contient une liste des ressources destinées à la génération de rapports. Les ressources de la liste doivent être identifiées sous le nom oslc:isMemberProperty dans la ressource de forme des ressources de la ressource de liste.
    • Doit avoir oslc:resourceShape pour décrire la ressource de liste.

Procédure

  1. Cliquez sur Données > Reconnaissance de schéma > Reconnaissance de schéma REST v2.
  2. Spécifiez les détails de connexion :
    1. Spécifiez l'URL de base pour la ressource.
      Vous devez connaître l'adresse URL du fournisseur de services que vous souhaitez accepter. Cette adresse URL est l'équivalent de l'URL de l'application Reporting data services de la source de données REST rapportable. Rational Publishing Engine extrait les données de la source de données sous forme de liste de requêtes. Ces ressources sont stockées par le service à partir duquel les données peuvent être interrogées et interprétées. Le service fournit également un service de requête qui permet de filtrer les données en fonction d'une condition définie ou d'affiner les sous-ensembles de données. Ces requêtes correspondent à un type de ressource et vous permettent d'accéder à la ressource d'un type spécifique. Un service ID2 rapportable peut exposer de nombreux types de ressource, tels qu'une demande de modification de produit ou d'utilisateur. Le service de requête aide l'utilisateur à extraire les données de manière efficace ou un sous-ensemble des données, mais il n'est pas obligatoire. Le service de requête existe pour toutes les ressources. Chaque produit peut définir ses ressources et les requêtes qui y accèdent.
    2. Sélectionnez un Type d'authentification dans la liste.
    3. Si la ressource se trouve sur un serveur sécurisé, indiquez le nom de l'Utilisateur.
    4. Si la ressource se trouve sur un serveur sécurisé, indiquez le Mot de passe.
  3. Cliquez sur Suivant .
  4. Sélectionnez un service REST v2 et sa requête correspondante, puis cliquez sur Suivant. Les propriétés des services sélectionnés s'affichent.
  5. Sélectionnez les propriétés requises dans la liste et cliquez sur Test oslc.select. Une fenêtre Confirmation des résultats affiche les services sélectionnés. Vérifiez que les services sont corrects. Si vous cliquez sur Correct, le statut de la zone Test oslc.select devient true. Cliquez sur Suivant.

    La zone Test oslc.properties n'est pas souvent utilisée.

  6. Vous ne devez entrer que la clause de filtre ou de tri de la requête, telle que cq:Product{cq:Product="Rational Publishing Engine"} dans La requête inclut la clause oslc.where et La requête inclut la clause oslc.orderBy.
  7. Cliquez sur Test oslc.where et Test oslc.orderBy pour vérifier la connexion. Rational Publishing Engine crée la demande complète à l'aide des options définies.
  8. Cliquez sur Suivant. Le récapitulatif de votre requête s'affiche. Cliquez sur Terminer. L'exécution de l'assistant est terminée et l'URL s'affiche dans la fenêtre Configuration. Si la ressource se trouve sur un serveur sécurisé, vous pouvez fournir un nom d'utilisateur et un mot de passe dans la fenêtre Configuration.

Retour d'informations