Conector OpenBOM

Conector OpenBOM

Integrar Tulip con OpenBOM usando el conector HTTP de Tulip

Introducción

OpenBOM es una colaboración en tiempo real basada en la nube y la tecnología de gestión de datos que permite la gestión de piezas, catálogos, lista de materiales, inventarios y órdenes de compra a través de redes de ingenieros, gestores de la cadena de suministro, y los fabricantes contratados. El objetivo de este conector es integrar OpenBOM con Tulip utilizando los conectores HTTP de Tulip y proporcionarle un conector OpenBOM listo para usar que puede ser importado a su instancia.

Propósito

1. Vamos a destacar diferentes funciones de conectores HTTP que se pueden construir haciendo llamadas HTTP a los puntos finales de OpenBOM para extraer información sobre listas de materiales (BOMs) configuradas, catálogos mantenidos y extraer información sobre listas de materiales de órdenes de producción liberadas en OpenBOM.
2. Se pueden crear aplicaciones Tulip para personalizar las instrucciones de trabajo para los operarios en el taller que extraen información sobre las órdenes de producción destacando las piezas necesarias para que los operarios ensamblen los productos y completen la orden de producción en el taller. Aprovechando los catálogos en OpenBOMs, vamos a mostrar cómo los gerentes de taller pueden mantener un inventario en tiempo real de las diferentes partes necesarias para ensamblar el producto en el taller.

Documento API

Las siguientes funciones del conector destacadas en este documento han aprovechado la API Docs de OpenBOM

Requisitos previos

1. Cree una cuenta en OpenBOM y configure los catálogos y las listas de materiales de OpenBOM para el producto que va a ensamblar en su taller.
2. Necesitarás generar una clave API que se utiliza en los conectores Tulip para realizar conexiones con OpenBOM.
3. Utilizando la autenticación básica (nombre de usuario y contraseña), obtener el token de acceso (se explica más adelante) que se pasaría como un encabezado de solicitud en todas las funciones del conector.

Detalles de la conexión Tulip

La siguiente información necesitaría ser configurada en el conector HTTP de Tulip.

1. Running On: Cloud Connector Host
2. Host: developer-api.openbom.com
3. Puerto:443
4. TLS: Sí
5. Autenticación: No Auth
6. Cabeceras: x-openbom-appkey

Funciones del conector

Obtener token de acceso

Propósito

1. Obtener el token de acceso que se utilizará como cabecera de petición en todas las funciones posteriores del conector.
2. El token de acceso caduca cada 24 horas. Tras ejecutar esta función de conector, OpenBOM devuelve el token de acceso que puede almacenarse en una variable Tulip que puede ser utilizada dinámicamente por todas las funciones de conector posteriores como cabecera de petición.

Endpoint y cabeceras

1. Una llamada POST al Endpoint: https://developer-api.openbom.com:443/login
2. Encabezado de la solicitud: x-openbom-appkey
3. Cuerpo de la petición: ContentType: JSON nombre de usuario y contraseña como claves

Extractor de salida requerido

1. Access Token - El Access Token devuelto se utilizaría en todas las funciones del conector secundario.

Obtención de una lista de catálogos

Propósito

1. Este endpoint proporciona una lista de catálogos disponibles en el perfil OpenBOM del usuario.
2. La lista se puede utilizar para extraer los ID de catálogo que se pueden utilizar para aprovechar catálogos específicos para extraer el inventario actual de diferentes materiales y actualizar diferentes propiedades dentro del catálogo en tiempo real.

Punto final y cabeceras

1. Una llamada GET al Endpoint: https://developer-api.openbom.com:443/catalogs
2. Encabezados de solicitud: x-openbom-appkey, x-openbom-accesstoken

Entrada obligatoria

1. Identificador de acceso que debe pasarse por una variable que se requiere como cabecera de solicitud para la llamada HTTP al punto final anterior.

Extractores de salida requeridos

1. CatalogId - Puede utilizarse para llamar a catálogos específicos de interés

Obtención de una lista de listas de materiales

Propósito

1. Este punto final proporciona una lista de las listas de materiales disponibles en el perfil OpenBOM del usuario.
2. La lista puede utilizarse para extraer los ID o nombres de las listas de materiales que pueden utilizarse para aprovechar listas de materiales específicas para obtener información sobre las distintas piezas necesarias para completar el ensamblaje de una unidad en el taller.

Punto final y cabeceras

1. Una llamada GET al Endpoint: https://developer-api.openbom.com:443/boms
2. Encabezados de solicitud x-openbom-appkey, x-openbom-accesstoken

Entrada obligatoria

1. Identificador de acceso que debe pasarse por una variable que se requiere como cabecera de solicitud para la llamada HTTP al punto final anterior.

Extractores de salida necesarios

1. BOMId: puede utilizarse para llamar a listas de materiales específicas de interés.
2. Name - Puede utilizarse para hacer un POST para llamar a una lista de materiales específica pasando la propiedad Name.

Obtención de la lista de materiales de la orden de fabricación

Propósito

1. Esta función extrae la lista de materiales de la orden de fabricación cuando la lista de materiales específica para ensamblar una unidad se lanza a producción en OpenBOM.
2. Esta función de conector extrae detalles importantes (Nombre, BOMID, Número de unidades) sobre la orden de fabricación que se pasarán dinámicamente para llamar a un ID de lista de materiales específico que contendrá toda la información sobre el número total de piezas necesarias para que el operario complete toda la Orden de fabricación.

Punto final y cabeceras

1. Una llamada GET al punto final: https://developer-api.openbom.com:443/orderboms
2. Encabezados de solicitud: x-openbom-appkey, x-openbom-accesstoken

Entrada obligatoria

1. Identificador de acceso que debe pasarse mediante una variable que se requiere como cabecera de solicitud para la llamada HTTP al punto final anterior.

Extractores de salida requeridos

1. Nombre: se puede utilizar para obtener los detalles de una lista de materiales de producción específica pasando el nombre al punto final específico de la lista de materiales.
2. BOMID: puede utilizarse para obtener todos los detalles de una lista de materiales de producción específica pasando el ID al punto final específico de la lista de materiales.
3. numUnits - Esta propiedad se puede utilizar para indicar el número de unidades que se producirán en el taller para una sola orden de producción.

Obtener una lista de materiales específica

Propósito

1. Esta función obtiene las propiedades de todos los diferentes materiales incluidos en una lista de materiales específica para ensamblar una unidad.
2. Las filas devueltas por OpenBOM pueden analizarse en Tulip que se utiliza para mostrar la cantidad de materia prima necesaria para completar la orden de producción además de todas las demás propiedades de la lista de materiales devueltas por OpenBOM dependiendo de cómo esté configurada la lista de materiales.

Endpoint y cabeceras

1. Una llamada GET al endpoint : https://developer-api.openbom.com:443/bom/{bomid}
2. Encabezado de la solicitud: x-openbom-appkey, x-openbom-accesstoken
3. Parámetro URL : {bomid} - Se pasará como entrada.

Entradas requeridas

1. Token de acceso que se pasará por una variable que se requiere como cabecera de petición para la llamada HTTP al endpoint anterior.
2. BOMID - Para obtener la información sobre la lista de materiales específica de interés.

Salidas requeridas

1. Filas devueltas por OpenBOM para una lista de materiales específica que incluye las propiedades de los distintos materiales que forman parte de la lista.
2. Los usuarios pueden analizar detalles específicos devueltos por OpenBOM en función del caso de uso.

Obtención de una lista de materiales específica por nombre

Propósito

1. Esta función obtiene las propiedades de todos los materiales incluidos en una lista de materiales específica para ensamblar una unidad pasando el nombre de la lista de materiales en lugar del identificador.
2. Las filas devueltas por OpenBOM se pueden analizar en Tulip que se utilizan para mostrar la cantidad de materia prima necesaria para completar la orden de producción, además de todas las demás propiedades de la lista de materiales devueltas por OpenBOM dependiendo de cómo esté configurada la lista de materiales.

Endpoint y cabeceras

1. Una llamada POST al Endpoint: https://developer-api.openbom.com:443/boms/byparams
2. Encabezado de la solicitud x-openbom-appkey, x-openbom-accesstoken
3. Cuerpo de la solicitud Content-Type:JSON , nombre como la clave pasada en el JSON

Entradas requeridas

1. Token de acceso
2. BOM NAME - Pasado como valor a la clave 'name' en el cuerpo de la petición.

Salidas obligatorias

1. Filas devueltas por OpenBOM para una lista de materiales específica que incluye las propiedades de los distintos materiales que forman parte de la lista.
2. Los usuarios pueden analizar detalles específicos devueltos por OpenBOM en función del caso de uso.

Obtención de un catálogo específico

Propósito

1. Además de otras propiedades predefinidas o personalizadas, los Catálogos en OpenBOM mantienen el inventario de las piezas en mano que podrían utilizarse para mostrar/actualizar el inventario en tiempo real dentro de Tulip.
2. Esta función se utiliza para obtener información sobre todas las propiedades disponibles en los Catálogos de OpenBOMs.

Punto final y cabeceras

1. Una llamada GET al endpoint: https://developer-api.openbom.com:443/bom/{bomid}
2. Encabezado de solicitud x-openbom-appkey, x-openbom-accesstoken
3. Parámetro URL : {catid} - Se pasará como entrada.

Entrada obligatoria

1. Identificador de acceso
2. CATID: Para obtener la información sobre la lista de materiales específica de interés.

Salida obligatoria

1. Dependiendo del caso de uso, los usuarios pueden extraer diferentes propiedades del catálogo devueltas por OpenBOM, siendo la cantidad disponible una propiedad que podría utilizarse para gestionar el inventario en Tulip y actualizarlo en tiempo real.

Actualización de Propiedades de Catálogo

Propósito

1. El catálogo en OpenBOM mantiene el inventario de las piezas en mano que podrían ser utilizadas para mostrar/actualizar el inventario en tiempo real de estas piezas dentro de las aplicaciones Tulip que se ejecutan en el taller.
2. Esta función se utiliza para actualizar las propiedades en el Catálogo en tiempo real con la Cantidad en Mano siendo un ejemplo que destaca el inventario de los materiales que se utilizan para ensamblar el producto en el taller. Como los materiales se consumen en tiempo real, podemos aprovechar esta función para actualizar la cantidad en tiempo real a medida que el operador procede con el montaje de una unidad utilizando la aplicación de instrucciones de trabajo en Tulip.

Endpoint & Cabeceras

1. Una llamada POST al endpoint : https://developer-api.openbom.com:443/catalog/{catid}/propertyvalue
2. Encabezado de la solicitud x-openbom-appkey, x-openbom-accesstoken
3. Tipo de contenido del cuerpo de la solicitud : JSON
4. Se necesitan pasar 4 claves en un JSON -partNumberPropertyName, partNumber, propertyName, propertyValue

Entrada requerida

1. Token de acceso
2. CATID: Parámetro URL
3. PartNumberPropertyName: Valor de la clave pasada en el cuerpo de la solicitud
4. NúmeroPieza: Valor de la clave introducida en el cuerpo de la solicitud
5. PropertyName: Valor de la clave introducida en el cuerpo de la petición
6. PropertyValue: Valor de la clave pasada en el cuerpo de la petición

OpenBOM devuelve un estado 200 con una respuesta "Property Updated" correcta.

Vídeo

Un pequeño vídeo que explica cómo utilizar OpenBOM con una aplicación Tulip.