Configuration des services OData sur K2 Five

K2 expose ses listes de données nativement en OData, vous permettant d’aisément requêter vos sources d’informations K2 depuis tout outil de reporting. Je ne vais pas tous les citer mais voici ce qu’on retrouve plus ou moins régulièrement chez nos clients : PowerBI, Tableau, Qlick View, Crystal Reports, Oracle BI, Cognos, SAP BI (a.k.a BO)… et oserai-je citer également Excel qui permet d’utiliser des sources OData.

Bref, au sein de tous ces outils, une fois les services OData K2 référencés, vous allez pouvoir mettre en place de très chouettes tableaux de bord qui exposeront vos données métier et de traçabilité K2.

Si pour K2 Cloud, l’exposition des données OData se fait en un clic (étape 2 ci-dessous au niveau du site K2 Management), pour K2 Five, il faudra quelques petites étapes supplémentaires afin de rendre les webservices accessibles. Suivons le guide.

Au niveau d’IIS

Activez l’authentification Basic sur l’application odata qui est dans le dossier virtuel Api à la racine du site K2. Il vous faudra aussi activer l’authentification Anonyme. Sans cette dernière l’interface d’administration Management remontera des erreurs.

Config côté IIS
Config côté IIS

 Le compte utilisé passera sur le réseau les informations de connexion sous forme de chaîne de caractères. Il faut donc s’assurer que la connexion utilisée est bien de l’HTTPS.

Au niveau K2 Management

Si vous utilisez un compte autre que le compte de service, sur le site Management, allez sur la partie Integration > APIs. Puis ajoutez, dans la partie API Administrator, le compte qui sera utilisé pour configurer OData.

Configuration du compte de "service" utilisé
Configuration du compte de “service” utilisé

 La partie suivante est la seule à prendre en considération avec K2 Cloud.

Ensuite, allez dans la partie Integration > APIs > SmartObject OData et activez la fonction SmartObject OData API.
Enfin, choisissez les SmOs à publier. Seuls les SmOs disposant d’une méthode liste seront publiés.

Activation des OData et restriction des méthodes
Activation des OData et restriction des méthodes

 Cas particulier des SmO disposant de plusieurs méthodes de type List : vous pourrez alors configurer la méthode à utiliser par défaut pour ces SmO, il suffit d’aller sur la page d’administration du SmO.

Choix de la méthode list par défaut lorsque nécessaire
Choix de la méthode list par défaut lorsque nécessaire

Tests de fonctionnement

Vous pourrez tester immédiatement votre endpoint OData en utilisant, depuis votre navigateur, l’URL qui est présente sur la page d’administration SmartObject OData. Un compte et mot de passe vous seront demandé à l’ouverture de session. Dans mon cas : https://k2.denallix.com/api/odata/v3/.

Et pour afficher les métadonnées de votre service, vous pouvez ajouter $metadata à l’URL. Dans mon cas https://k2.denallix.com/api/odata/v3/$metadata.

Il ne vous reste plus qu’à faire de beaux dashboards. 

N’hésitez pas à utiliser les commentaires si vous avez des questions.

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *

Ce site utilise Akismet pour réduire les indésirables. En savoir plus sur comment les données de vos commentaires sont utilisées.