OpenBOMコネクタ

OpenBOMコネクタ

TulipのHTTPコネクタを使ってOpenBOMと統合する

はじめに

OpenBOMは、クラウドベースのリアルタイム・コラボレーション＆データ管理技術で、エンジニア、サプライチェーンマネージャー、製造委託先のネットワーク間で、部品、カタログ、部品表、在庫、発注書を管理できます。このコネクタの目的は、TulipのHTTPコネクタを使用してOpenBOMをTulipと統合し、インスタンスにインポート可能なOpenBOMコネクタを提供することです。

目的

1. OpenBOMのエンドポイントにHTTPコールを行い、設定された部品表（BOM）、維持されているカタログ、およびOpenBOMでリリースされた生産オーダーのBOMに関する情報を引き出すことによって構築できる、さまざまなHTTPコネクター機能を紹介します。
2. Tulipアプリは、現場のオペレーター向けに作業手順をカスタマイズするために構築することができ、現場のオペレーターが製品を組み立て、生産指示書を完成させるために必要な部品を強調した生産指示書の情報を引き出すことができます。OpenBOMsのカタログを活用することで、現場の管理者が現場で製品を組み立てるために必要な様々な部品の在庫をリアルタイムで管理する方法を紹介します。

APIドキュメント

このドキュメントで取り上げた以下のコネクタ機能は、OpenBOM の APIDocs を活用しています。

前提条件

1. OpenBOM でアカウントを作成し、OpenBOM カタログと BOM を現場で組み立てる製品用に設定します。
2. OpenBOM と接続するために Tulip コネクタで使用する API キーを生成する必要があります。
3. 基本認証（ユーザー名とパスワード）を使用して、すべてのコネクター機能でリクエストヘッダとして渡される Access Token（以下で説明）を取得します。

Tulip 接続の詳細

Tulip の HTTP コネクタでは、以下の情報を設定する必要があります。

1. 実行中: クラウド・コネクタ・ホスト
2. ホスト：developer-api.openbom.com
3. ポート:443
4. TLS: はい
5. 認証：認証なし
6. ヘッダ: x-openbom-appkey

コネクタ機能

アクセストークンの取得

目的

1. 以降のすべてのコネクタ機能でリクエストヘッダとして使用されるアクセストークンを取得します。
2. アクセストークンの有効期限は 24 時間です。このコネクタ関数を実行すると、OpenBOM はアクセストークンを返します。このアクセストークンは Tulip 変数に格納でき、後続のすべてのコネクタ関数でリクエストヘッダとして動的に使用できます。

エンドポイントとヘッダ

1. エンドポイントへの POST 呼び出し**: https://developer-api.openbom.com:443/login**
2. リクエストヘッダ：x-openbom-appkey
3. リクエスト・ボディ：ContentType：JSON ユーザー名とパスワードをキーとする

必要な出力エクストラクタ

1. Access Token - 返された Access Token は、すべてのサブコネクタ機能で使用されます。

カタログ一覧の取得

目的

1. このエンドポイントは、ユーザーの OpenBOM プロファイルで利用可能なカタログのリストを提供します。
2. このリストを使用してカタログ ID を抽出し、特定のカタログを活用して、さまざまな材料の現在の在庫を引き出したり、カタログ内のさまざまなプロパティをリアルタイムで更新したりすることができます。

エンドポイントとヘッダー

1. エンドポイントへのGETコール**： https://developer-api.openbom.com:443/catalogs**
2. リクエストヘッダ:x-openbom-appkey,x-openbom-accesstoken

必須入力

1. 上記のエンドポイントへの HTTP 呼び出しのリクエストヘッダとして必要な変数で渡されるアクセストークン。

必須出力エクストラクタ

1. CatalogId - 特定のカタログを呼び出すために使用できます。

BOMのリストの取得

目的

1. このエンドポイントは、ユーザーの OpenBOM プロファイルで利用可能な BOM のリストを提供します。
2. このリストを使用して、BOM ID または BOM の名前を抽出し、特定の BOM を活用して、現場でユニットの組み立てを完了するために必要なさまざまな部品の情報を引き出すことができます。

エンドポイントとヘッダー

1. エンドポイントへの GET 呼び出し**: https://developer-api.openbom.com:443/boms**
2. リクエストヘッダx-openbom-appkey,x-openbom-accesstoken

必須入力

1. 上記のエンドポイントへの HTTP 呼び出しのリクエストヘッダとして必要な変数で渡されるアクセストークン。

必須出力エクストラクタ

1. BOMId - 特定の BOM を呼び出すために使用できます。
2. Name - Name プロパティを渡すことで、特定の BOM を呼び出す POST を実行するために使用できます。

生産オーダー BOM の取得

目的

1. この関数は、ユニットを組み立てるための特定の BOM が OpenBOM 上で生産にリリースされたときに、生産オーダー BOM を取り出します。
2. このコネクタ関数は、製造オーダーの重要な詳細（名前、BOMID、ユニット数）を抽出し、オペレータが製造オーダー全体を完了するために必要な部品の総数に関するすべての情報を含む特定の BOM ID を呼び出すために動的に渡されます。

エンドポイントとヘッダー

1. エンドポイントへの GET 呼び出し**： https://developer-api.openbom.com:443/orderboms**
2. リクエストヘッダ:x-openbom-appkey,x-openbom-accesstoken

必須入力

1. 上記エンドポイントへの HTTP 呼び出しのリクエストヘッダとして必要な変数で渡されるアクセストークン。

必須出力エクストラクタ

1. Name - これは、BOM 固有のエンドポイントに Name を渡すことで、特定のプロダクション BOM の詳細を取得するために使用できます。
2. BOMID - これは、BOM 固有のエンドポイントに ID を渡すことで、特定の製造 BOM のすべての詳細を取得するために使用します。
3. numUnits - このプロパティを使用して、1 つの生産オーダーに対して現場で生産されるユニット数を示すことができます。

特定の BOM の取得

目的

1. この関数は、ユニットを組み立てるために特定の BOM に含まれるすべての異なる材料のプロパティを取得します。
2. OpenBOM によって返された行は Tulip にパースされ、BOM の構成に応じて、OpenBOM によって返された他のすべての BOM プロパティに加えて、生産オーダーの完了に必要なさまざまな原材料の数量を表示するために使用されます。

エンドポイントとヘッダー

1. エンドポイント**https://developer-api.openbom.com:443/bom/{bomid}**への GET コール。
2. リクエストヘッダ:x-openbom-appkey,x-openbom-accesstoken
3. URL パラメータ :{bomid}- これは入力として渡されます。

必須入力

1. 上記のエンドポイントへの HTTP 呼び出しのリクエストヘッダとして必要な変数で渡されるアクセストークン。
2. BOMID - 対象の特定の BOM に関する情報を取得します。

必要な出力

1. OpenBOM が特定の BOM に対して返した行。
2. ユーザは、ユースケースに基づいて、OpenBOM によって返される特定の詳細を解析することができます。

名前による特定の BOM の取得

目的

1. この関数は、id の代わりに BOM Name を渡すことで、ユニットを組み立てるための特定の BOM に含まれるすべての異なる材料のプロパティを取得します。
2. OpenBOM によって返された行は Tulip にパースされ、BOM の構成に応じて、OpenBOM によって返された他のすべての BOM プロパティに加えて、生産オーダーを完了するために必要なさまざまな原材料の数量を表示するために使用されます。

エンドポイントとヘッダー

1. エンドポイントへの POST コール**: https://developer-api.openbom.com:443/boms/byparams**
2. リクエストヘッダx-openbom-appkey,x-openbom-accesstoken
3. リクエストボディContent-Type:JSON ,nameは JSON で渡されたキー。

必須入力

1. アクセストークン
2. BOM NAME - リクエストボディの 'name' キーに値として渡される。

必要な出力

1. OpenBOM が特定の BOM に対して返す行。BOM の一部であるさまざまな材料のプロパティが含まれます。
2. ユーザは、ユースケースに応じて、OpenBOM が返す特定の詳細を解析することができます。

特定のカタログの取得

目的

1. OpenBOM のカタログは、事前に定義された、またはカスタマイズされた様々なプロパティに加えて、Tulip 内でリアルタイムの在庫を表示/更新するために使用できる、手元にある部品の在庫を保持します。
2. この関数は、OpenBOMs Catalogsで利用可能なすべてのプロパティに関する情報を取得するために使用されます。

エンドポイントとヘッダー

1. エンドポイントへの GET コール**: https://developer-api.openbom.com:443/bom/{bomid}**
2. リクエストヘッダx-openbom-appkey,x-openbom-accesstoken
3. URL パラメータ :{catid}- これは入力として渡されます。

必須入力

1. アクセストークン
2. CATID：特定の BOM に関する情報を取得する。

必須出力

1. ユースケースに応じて、ユーザーはOpenBOMによって返されるさまざまなカタログプロパティを抽出することができます。手持ち数量は、Tulipで在庫を管理し、リアルタイムで更新するために使用できるプロパティの1つです。

カタログプロパティの更新

目的

1. OpenBOMのカタログは、手元にある部品の在庫を管理し、現場で実行されているTulipアプリ内で、これらの部品のリアルタイムの在庫を表示/更新するために使用できます。
2. この機能はカタログのプロパティをリアルタイムに更新するために使用され、その一例として、現場で製品を組み立てるために使用されている材料の在庫をハイライトします。材料はリアルタイムで消費されるため、オペレーターがTulipの作業指示アプリを使用してユニットの組み立てを進める際に、この関数を活用して「数量」をリアルタイムで更新することができます。

エンドポイントとヘッダー

1. エンドポイントへのPOST呼び出し :https://developer-api.openbom.com:443/catalog/{catid}/propertyvalue
2. リクエストヘッダx-openbom-appkey,x-openbom-accesstoken
3. リクエストボディContent Type ：JSON
4. 4つのキーがJSONで渡される必要がある**-partNumberPropertyName**,partNumber,propertyName,propertyValue

必須入力

1. アクセストークン
2. CATID：URL パラメータ
3. PartNumberPropertyName：リクエストボディに渡されたキーの値
4. PartNumber：リクエストボディで渡されたキーの値
5. PropertyName：リクエストボディで渡されたキーの値
6. PropertyValue：リクエストボディで渡されたキーの値

OpenBOM は、"Property Updated" レスポンスの成功で、200 のステータスを返します。

ビデオ

TulipアプリでOpenBOMを使用する方法を説明する小さなビデオです。