Złącze OpenBOM

Konektor OpenBOM

Integracja Tulip z OpenBOM przy użyciu Tulip HTTP Connector

Wprowadzenie

OpenBOM to oparta na chmurze technologia współpracy i zarządzania danymi w czasie rzeczywistym, która umożliwia zarządzanie częściami, katalogami, zestawieniami materiałów, zapasami i zamówieniami zakupu w sieciach inżynierów, menedżerów łańcucha dostaw i producentów kontraktowych. Celem tego konektora jest integracja OpenBOM z Tulip przy użyciu konektorów HTTP Tulip i dostarczenie gotowego konektora OpenBOM, który można zaimportować do instancji.

Cel

1. Podkreślimy różne funkcje konektorów HTTP, które można zbudować, wykonując wywołania HTTP do punktów końcowych OpenBOM w celu uzyskania informacji o skonfigurowanych zestawieniach materiałów (BOM), utrzymywanych katalogach i pobieraniu informacji o zestawieniach BOM zleceń produkcyjnych wydanych w OpenBOM.
2. Aplikacje Tulip można tworzyć w celu dostosowywania instrukcji pracy dla operatorów na hali produkcyjnej, które pobierają informacje o zleceniach produkcyjnych, podkreślając części potrzebne operatorom do montażu produktów i realizacji zlecenia produkcyjnego na hali produkcyjnej. Wykorzystując katalogi w OpenBOMs, pokażemy, w jaki sposób kierownicy hali produkcyjnej mogą utrzymywać w czasie rzeczywistym zapasy różnych części wymaganych do montażu produktu na hali produkcyjnej.

API Doc

Następujące funkcje łączników wyróżnione w tym dokumencie wykorzystują dokumenty API OpenBOM

Wymagania wstępne

1. Utwórz konto w OpenBOM i skonfiguruj OpenBOM Catalogs & BOM dla produktu, który ma zostać zmontowany na hali produkcyjnej.
2. Konieczne będzie wygenerowanie klucza API, który jest używany w konektorach Tulip do nawiązywania połączeń z OpenBOM.
3. Korzystając z podstawowego uwierzytelniania (nazwa użytkownika i hasło), uzyskaj token dostępu (wyjaśniony poniżej), który zostanie przekazany jako nagłówek żądania we wszystkich funkcjach konektora.

Szczegóły połączenia Tulip

W konektorze HTTP Tulip należy skonfigurować następujące informacje.

1. Uruchomione na: Cloud Connector Host
2. Host: developer-api.openbom.com
3. Port:443
4. TLS: Tak
5. Uwierzytelnianie: No Auth
6. Nagłówki: x-openbom-appkey

Funkcje konektora

Pobieranie tokena dostępu

Cel

1. Uzyskanie tokenu dostępu, który będzie używany jako nagłówek żądania we wszystkich kolejnych funkcjach konektora.
2. Access Token wygasa co 24 godziny. Po uruchomieniu tej funkcji konektora OpenBOM zwraca token dostępu, który może być przechowywany w zmiennej Tulip, która może być dynamicznie używana przez wszystkie kolejne funkcje konektora jako nagłówek żądania.

Punkt końcowy i nagłówki

1. Wywołanie POST do punktu końcowego: https://developer-api.openbom.com:443/login
2. Nagłówek żądania: x-openbom-appkey
3. Treść żądania: ContentType: JSON nazwa użytkownika i hasło jako klucze

Wymagany ekstraktor danych wyjściowych

1. Token dostępu - zwrócony token dostępu będzie używany we wszystkich funkcjach łącznika podrzędnego.

Pobieranie listy katalogów

Cel

1. Ten punkt końcowy dostarcza listę katalogów dostępnych w profilu OpenBOM użytkownika.
2. Lista może być wykorzystana do wyodrębnienia identyfikatorów katalogów, które mogą być wykorzystane do wykorzystania określonych katalogów do pobierania bieżących zapasów dla różnych materiałów i aktualizowania różnych właściwości w katalogu w czasie rzeczywistym.

Punkt końcowy i nagłówki

1. Wywołanie GET do punktu końcowego: https://developer-api.openbom.com:443/catalogs
2. Nagłówki żądania: x-openbom-appkey, x-openbom-accesstoken

Wymagane dane wejściowe

1. Token dostępu przekazywany przez zmienną, która jest wymagana jako nagłówek żądania dla wywołania HTTP do powyższego punktu końcowego.

Wymagane ekstraktory danych wyjściowych

1. CatalogId - może być używany do wywoływania określonych katalogów będących przedmiotem zainteresowania.

Pobieranie listy BOM-ów

Cel

1. Ten punkt końcowy dostarcza listę BOM-ów dostępnych w profilu OpenBOM użytkownika.
2. Listę można wykorzystać do wyodrębnienia identyfikatorów BOM lub nazw BOM, które można wykorzystać do wykorzystania określonych BOM w celu uzyskania informacji o różnych częściach potrzebnych do ukończenia montażu jednostki na hali produkcyjnej.

Punkt końcowy i nagłówki

1. Wywołanie GET do punktu końcowego: https://developer-api.openbom.com:443/boms
2. Nagłówki żądania x-openbom-appkey, x-openbom-accesstoken

Wymagane dane wejściowe

1. Token dostępu przekazywany przez zmienną, która jest wymagana jako nagłówek żądania dla wywołania HTTP do powyższego punktu końcowego.

Wymagane ekstraktory danych wyjściowych

1. BOMId - może być używany do wywoływania określonych BOM-ów będących przedmiotem zainteresowania
2. Name - może być użyty do wykonania POST w celu wywołania określonego BOM poprzez przekazanie właściwości Name.

Pobieranie BOM zlecenia produkcyjnego

Cel

1. Ta funkcja pobiera BOM zlecenia produkcyjnego, gdy określony BOM do montażu jednostki zostanie zwolniony do produkcji w OpenBOM.
2. Ta funkcja łącznika wyodrębnia ważne szczegóły (nazwa, BOMID, liczba jednostek) dotyczące zlecenia produkcyjnego, które będą dynamicznie przekazywane w celu wywołania określonego identyfikatora BOM, który będzie zawierał wszystkie informacje o całkowitej liczbie części potrzebnych operatorowi do wykonania całego zlecenia produkcyjnego.

Punkt końcowy i nagłówki

1. Wywołanie GET do punktu końcowego: https://developer-api.openbom.com:443/orderboms
2. Nagłówki żądania: x-openbom-appkey, x-openbom-accesstoken

Wymagane dane wejściowe

1. Token dostępu przekazywany przez zmienną, która jest wymagana jako nagłówek żądania dla wywołania HTTP do powyższego punktu końcowego.

Wymagane ekstraktory danych wyjściowych

1. Name - może być użyty do uzyskania szczegółów dla określonego BOMu produkcyjnego poprzez przekazanie nazwy do punktu końcowego specyficznego dla BOMu.
2. BOMID - ta właściwość może być użyta do uzyskania wszystkich szczegółów dla konkretnego BOMu produkcyjnego poprzez przekazanie ID do punktu końcowego specyficznego dla BOMu.
3. numUnits - ta właściwość może być użyta do wskazania liczby jednostek, które mają być wyprodukowane na hali produkcyjnej dla pojedynczego zlecenia produkcyjnego.

Pobieranie określonego BOM

Cel

1. Ta funkcja pobiera właściwości dla wszystkich różnych materiałów zawartych w określonej BOM w celu złożenia jednostki.
2. Wiersze zwrócone przez OpenBOM mogą być analizowane w Tulip, który jest używany do wyświetlania ilości różnych surowców potrzebnych do ukończenia zlecenia produkcyjnego, oprócz wszystkich innych właściwości BOM zwróconych przez OpenBOM w zależności od tego, jak BOM jest skonfigurowany.

Punkt końcowy i nagłówki

1. Wywołanie GET do punktu końcowego: https: //developer-api.openbom.com:443/bom/{bomid}
2. Nagłówek żądania: x-openbom-appkey, x-openbom-accesstoken
3. Parametr URL: {bomid} - zostanie przekazany jako dane wejściowe.

Wymagane dane wejściowe

1. Token dostępu przekazywany przez zmienną, która jest wymagana jako nagłówek żądania dla wywołania HTTP do powyższego punktu końcowego.
2. BOMID - Aby uzyskać informacje na temat konkretnego BOM będącego przedmiotem zainteresowania.

Wymagane dane wyjściowe

1. Wiersze zwrócone przez OpenBOM dla określonego BOM, które zawierają właściwości różnych materiałów, które są częścią BOM.
2. Użytkownicy mogą analizować określone szczegóły zwrócone przez OpenBOM w oparciu o przypadek użycia.

Pobieranie określonego BOM według nazwy

Cel

1. Ta funkcja pobiera właściwości dla wszystkich różnych materiałów zawartych w określonym BOM w celu złożenia jednostki, przekazując nazwę BOM zamiast identyfikatora.
2. Wiersze zwrócone przez OpenBOM mogą być analizowane w Tulip, które są używane do wyświetlania ilości różnych surowców potrzebnych do ukończenia zlecenia produkcyjnego, oprócz wszystkich innych właściwości BOM zwróconych przez OpenBOM w zależności od tego, jak BOM jest skonfigurowany.

Punkt końcowy i nagłówki

1. Wywołanie POST do punktu końcowego: https://developer-api.openbom.com:443/boms/byparams
2. Nagłówek żądania x-openbom-appkey, x-openbom-accesstoken
3. Treść żądania Content-Type:JSON , nazwa jako klucz przekazany w JSON

Wymagane dane wejściowe

1. Token dostępu
2. BOM NAME - przekazywane jako wartość klucza "name" w treści żądania.

Wymagane dane wyjściowe

1. Wiersze zwrócone przez OpenBOM dla określonego BOM, który zawiera właściwości różnych materiałów, które są częścią BOM.
2. Użytkownicy mogą analizować określone szczegóły zwracane przez OpenBOM w oparciu o przypadek użycia.

Pobieranie określonego katalogu

Cel

1. Oprócz różnych innych wstępnie zdefiniowanych lub niestandardowych właściwości, katalogi w OpenBOM utrzymują inwentaryzację części w ręku, które mogą być używane do wyświetlania/aktualizowania inwentaryzacji w czasie rzeczywistym w Tulip
2. Ta funkcja służy do uzyskiwania informacji o wszystkich właściwościach dostępnych w katalogach OpenBOM.

Punkt końcowy i nagłówki

1. Wywołanie GET do punktu końcowego: https://developer-api.openbom.com:443/bom/{bomid}
2. Nagłówek żądania x-openbom-appkey, x-openbom-accesstoken
3. Parametr URL: {catid} - zostanie przekazany jako dane wejściowe.

Wymagane dane wejściowe

1. Token dostępu
2. CATID: Aby uzyskać informacje na temat konkretnego BOM będącego przedmiotem zainteresowania.

Wymagane dane wyjściowe

1. W zależności od przypadku użycia użytkownicy mogą wyodrębnić różne właściwości katalogu zwrócone przez OpenBOM, przy czym ilość na stanie jest jedną z właściwości, która może być używana do zarządzania zapasami w Tulip i aktualizacji w czasie rzeczywistym.

Aktualizacja właściwości katalogu

Cel

1. Katalog w OpenBOM przechowuje zapasy części, które mogą być używane do wyświetlania/aktualizowania zapasów tych części w czasie rzeczywistym w aplikacjach Tulip działających na hali produkcyjnej.
2. Funkcja ta jest używana do aktualizowania właściwości w Catalog w czasie rzeczywistym, przy czym Quantity On Hand jest jednym z przykładów, który podkreśla stan zapasów materiałów używanych do montażu produktu na hali produkcyjnej. Ponieważ materiały są zużywane w czasie rzeczywistym, możemy wykorzystać tę funkcję do aktualizacji ilości w czasie rzeczywistym, gdy operator kontynuuje montaż jednostki za pomocą aplikacji instrukcji pracy w Tulip.

Punkt końcowy i nagłówki

1. Wywołanie POST do punktu końcowego: https: //developer-api.openbom.com:443/catalog/{catid}/propertyvalue
2. Nagłówek żądania x-openbom-appkey, x-openbom-accesstoken
3. Typ treści żądania : JSON
4. Wymagane jest przekazanie 4 kluczy w formacie JSON -partNumberPropertyName, partNumber, propertyName, propertyValue.

Wymagane dane wejściowe

1. Token dostępu
2. CATID: Parametr URL
3. PartNumberPropertyName: Wartość dla klucza przekazanego w treści żądania
4. PartNumber: Wartość dla klucza przekazanego w treści żądania
5. PropertyName: Wartość dla klucza przekazanego w treści żądania
6. PropertyValue: Wartość dla klucza przekazanego w treści żądania

OpenBOM zwraca status 200 z pomyślną odpowiedzią "Property Updated".

Wideo

Mały film wyjaśniający, w jaki sposób można używać OpenBOM z aplikacją Tulip.