Connecteur OpenBOM

Connecteur OpenBOM

Intégrer Tulip avec OpenBOM en utilisant le connecteur HTTP de Tulip

Introduction

OpenBOM est une technologie de collaboration et de gestion de données en temps réel basée sur le cloud qui permet de gérer des pièces, des catalogues, des nomenclatures, des inventaires et des bons de commande à travers des réseaux d'ingénieurs, de gestionnaires de la chaîne d'approvisionnement et de fabricants contractuels. Le but de ce connecteur est d'intégrer OpenBOM avec Tulip en utilisant les connecteurs HTTP de Tulip et de vous fournir un connecteur OpenBOM prêt à l'emploi qui peut être importé dans votre instance.

Objectif

1. Nous allons mettre en évidence les différentes fonctions du connecteur HTTP qui peuvent être construites en faisant des appels HTTP aux points de terminaison d'OpenBOM pour obtenir des informations sur les nomenclatures configurées, les catalogues maintenus et pour obtenir des informations sur les nomenclatures des ordres de production lancés dans OpenBOM.
2. Les applications Tulip peuvent être construites pour personnaliser les instructions de travail pour les opérateurs de l'atelier qui tirent des informations sur les ordres de production mettant en évidence les pièces nécessaires aux opérateurs pour assembler les produits et compléter l'ordre de production dans l'atelier. En utilisant les catalogues dans OpenBOMs, nous montrerons comment les responsables d'atelier peuvent maintenir un inventaire en temps réel des différentes pièces nécessaires à l'assemblage du produit dans l'atelier.

Doc API

Les fonctions de connecteur suivantes, mises en évidence dans ce document, ont tiré parti des documents API d'OpenBOM.

Pré-requis

1. Créez un compte sur OpenBOM et configurez les catalogues et nomenclatures OpenBOM pour le produit à assembler dans votre atelier.
2. Vous devez générer une clé API qui est utilisée dans les connecteurs Tulip pour établir des connexions avec OpenBOM.
3. En utilisant l'authentification de base (nom d'utilisateur et mot de passe), obtenez le jeton d'accès (expliqué ci-dessous) qui sera transmis en tant qu'en-tête de requête dans toutes les fonctions du connecteur.

Détails de la connexion Tulip

Les informations suivantes doivent être configurées sur le connecteur HTTP de Tulip.

1. Exécuté sur : Cloud Connector Host
2. Hôte : developer-api.openbom.com
3. Port : 443
4. TLS : Oui
5. Authentification : No Auth
6. En-têtes : x-openbom-appkey

Fonctions du connecteur

Obtention d'un jeton d'accès

Objectif

1. Obtenir le jeton d'accès qui sera utilisé comme en-tête de requête dans toutes les fonctions ultérieures du connecteur.
2. Le jeton d'accès expire toutes les 24 heures. Après l'exécution de cette fonction de connecteur, OpenBOM renvoie le jeton d'accès qui peut être stocké dans une variable Tulip qui peut être utilisée dynamiquement par toutes les fonctions de connecteur suivantes en tant qu'en-tête de requête.

Point de terminaison et en-têtes

1. Un appel POST au point de terminaison : https://developer-api.openbom.com:443/login
2. En-tête de la requête : x-openbom-appkey
3. Request Body : ContentType : JSON nom d'utilisateur et mot de passe comme clés

Extracteur de sortie requis

1. Jeton d'accès - Le jeton d'accès renvoyé sera utilisé dans toutes les fonctions du sous-connecteur.

Obtenir une liste de catalogues

Objectif

1. Ce point d'accès fournit une liste des catalogues disponibles dans le profil OpenBOM de l'utilisateur.
2. La liste peut être utilisée pour extraire les identifiants de catalogue qui peuvent être utilisés pour exploiter des catalogues spécifiques afin d'extraire l'inventaire actuel pour différents matériaux et de mettre à jour différentes propriétés dans le catalogue en temps réel.

Point d'arrivée et en-têtes

1. Un appel GET au point de terminaison : https://developer-api.openbom.com:443/catalogs
2. En-têtes de la requête : x-openbom-appkey, x-openbom-accesstoken

Données requises

1. Jeton d'accès à transmettre par une variable requise comme en-tête de requête pour l'appel HTTP au point de terminaison ci-dessus.

Extracteurs de sortie requis

1. CatalogId - Peut être utilisé pour appeler des catalogues spécifiques d'intérêt.

Obtenir une liste de nomenclatures

Objectif

1. Ce point d'accès fournit une liste des nomenclatures disponibles dans le profil OpenBOM de l'utilisateur.
2. La liste peut être utilisée pour extraire les identifiants ou les noms des nomenclatures qui peuvent être utilisés pour exploiter des nomenclatures spécifiques afin d'obtenir des informations sur les différentes pièces nécessaires pour compléter l'assemblage d'une unité dans l'atelier.

Point final et en-têtes

1. Un appel GET au point de terminaison : https://developer-api.openbom.com:443/boms
2. En-têtes de requête x-openbom-appkey, x-openbom-accesstoken

Données requises

1. Jeton d'accès à transmettre par une variable requise en tant qu'en-tête de requête pour l'appel HTTP au point de terminaison susmentionné.

Extracteurs de sortie requis

1. BOMId - Peut être utilisé pour appeler des nomenclatures spécifiques d'intérêt.
2. Name - Peut être utilisé pour effectuer un POST afin d'appeler une nomenclature spécifique en passant la propriété Name.

Obtention de la nomenclature d'un ordre de fabrication

Objectif

1. Cette fonction extrait la nomenclature de l'ordre de fabrication lorsque la nomenclature spécifique pour l'assemblage d'une unité est mise en production sur OpenBOM.
2. Cette fonction de connecteur extrait des détails importants (Nom, BOMID, Nombre d'unités) sur l'ordre de fabrication qui seront transmis dynamiquement pour appeler une BOM ID spécifique qui contiendra toutes les informations sur le nombre total de pièces nécessaires à l'opérateur pour compléter l'ensemble de l'ordre de fabrication.

Point final et en-têtes

1. Un appel GET au point de terminaison : https://developer-api.openbom.com:443/orderboms
2. En-têtes de la requête : x-openbom-appkey, x-openbom-accesstoken

Données requises

1. Jeton d'accès à transmettre par une variable requise en tant qu'en-tête de requête pour l'appel HTTP au point de terminaison susmentionné.

Extracteurs de sortie requis

1. Name - Ceci peut être utilisé pour obtenir les détails d'une nomenclature de production spécifique en passant le nom au point de terminaison spécifique à la nomenclature.
2. BOMID - Cette propriété peut être utilisée pour obtenir tous les détails d'une nomenclature de production spécifique en passant l'ID au point de terminaison spécifique à la nomenclature.
3. numUnits - Cette propriété peut être utilisée pour indiquer le nombre d'unités à produire dans l'atelier pour un seul ordre de fabrication.

Obtention d'une nomenclature spécifique

Objectif

1. Cette fonction permet d'obtenir les propriétés de tous les différents matériaux inclus dans une nomenclature spécifique pour l'assemblage d'une unité.
2. Les lignes retournées par OpenBOM peuvent être analysées dans Tulip qui est utilisé pour afficher la quantité des différentes matières premières nécessaires pour compléter l'ordre de production en plus de toutes les autres propriétés de la nomenclature retournées par OpenBOM en fonction de la façon dont la nomenclature est configurée.

Point de terminaison et en-têtes

1. Un appel GET au point de terminaison : https://developer-api.openbom.com:443/bom/{bomid}
2. En-tête de la requête : x-openbom-appkey, x-openbom-accesstoken
3. Paramètre URL : {bomid} - Il sera transmis en tant qu'entrée.

Données requises

1. Jeton d'accès à transmettre par une variable requise en tant qu'en-tête de requête pour l'appel HTTP au point de terminaison ci-dessus.
2. BOMID - Pour obtenir des informations sur la nomenclature spécifique qui vous intéresse.

Résultats requis

1. Lignes renvoyées par OpenBOM pour une nomenclature spécifique qui comprend les propriétés des différents matériaux qui font partie de la nomenclature.
2. Les utilisateurs peuvent analyser les détails spécifiques renvoyés par OpenBOM en fonction du cas d'utilisation.

Obtenir une nomenclature spécifique par nom

Objectif

1. Cette fonction permet d'obtenir les propriétés de tous les différents matériaux inclus dans une nomenclature spécifique pour assembler une unité en passant le nom de la nomenclature à la place de l'identifiant.
2. Les lignes retournées par OpenBOM peuvent être analysées dans Tulip qui est utilisé pour afficher la quantité des différentes matières premières nécessaires pour compléter l'ordre de production en plus de toutes les autres propriétés de la nomenclature retournées par OpenBOM en fonction de la façon dont la nomenclature est configurée.

Point de terminaison et en-têtes

1. Un appel POST au point de terminaison : https://developer-api.openbom.com:443/boms/byparams
2. En-tête de la requête x-openbom-appkey, x-openbom-accesstoken
3. Corps de la requête Content-Type:JSON , nom comme la clé passée dans le JSON

Données requises

1. Jeton d'accès
2. BOM NAME - transmis comme valeur à la clé 'name' dans le corps de la demande.

Résultats requis

1. Lignes renvoyées par OpenBOM pour une nomenclature spécifique qui comprend les propriétés des différents matériaux qui font partie de la nomenclature.
2. Les utilisateurs peuvent analyser les détails spécifiques renvoyés par OpenBOM en fonction du cas d'utilisation.

Obtention d'un catalogue spécifique

Objectif

1. En plus de diverses autres propriétés prédéfinies ou personnalisées, les catalogues dans OpenBOM maintiennent l'inventaire des pièces en main qui pourrait être utilisé pour afficher/mettre à jour l'inventaire en temps réel dans Tulip.
2. Cette fonction est utilisée pour obtenir des informations sur toutes les propriétés disponibles dans les Catalogues d'OpenBOMs.

Point de terminaison et en-têtes

1. Un appel GET au point de terminaison : https://developer-api.openbom.com:443/bom/{bomid}
2. En-tête de la requête x-openbom-appkey, x-openbom-accesstoken
3. Paramètre URL : {catid} - Il sera transmis en tant qu'entrée.

Entrée requise

1. Jeton d'accès
2. CATID : Pour obtenir des informations sur la nomenclature spécifique qui vous intéresse.

Sortie requise

1. En fonction du cas d'utilisation, les utilisateurs peuvent extraire différentes propriétés du catalogue renvoyées par OpenBOM. La quantité disponible est une propriété qui peut être utilisée pour gérer l'inventaire dans Tulip et la mettre à jour en temps réel.

Mise à jour des propriétés du catalogue

Objectif

1. Le catalogue dans OpenBOM maintient l'inventaire des pièces en stock qui peut être utilisé pour afficher/mettre à jour l'inventaire en temps réel de ces pièces dans les applications Tulip fonctionnant dans l'atelier.
2. Cette fonction est utilisée pour mettre à jour les propriétés du catalogue en temps réel. La quantité disponible est un exemple qui met en évidence l'inventaire des matériaux utilisés pour assembler le produit dans l'atelier. Comme les matériaux sont consommés en temps réel, nous pouvons utiliser cette fonction pour mettre à jour la quantité en temps réel lorsque l'opérateur procède à l'assemblage d'une unité en utilisant l'application d'instructions de travail dans Tulip.

Point de terminaison et en-têtes

1. Un appel POST au point de terminaison : https://developer-api.openbom.com:443/catalog/{catid}/propertyvalue
2. En-tête de la requête : x-openbom-appkey, x-openbom-accesstoken
3. Type de contenu du corps de la requête : JSON
4. 4 clés sont nécessaires pour être transmises dans un JSON -partNumberPropertyName, partNumber, propertyName, propertyValue

Données requises

1. Jeton d'accès
2. CATID : Paramètre URL
3. PartNumberPropertyName : Valeur de la clé transmise dans le corps de la demande
4. PartNumber : Valeur de la clé transmise dans le corps de la demande
5. PropertyName : Valeur de la clé transmise dans le corps de la demande
6. PropertyValue : Valeur de la clé transmise dans le corps de la demande

OpenBOM renvoie un statut 200 lorsque la réponse "Property Updated" est réussie.

Vidéo

Une petite vidéo expliquant comment vous pouvez utiliser OpenBOM avec une application Tulip.