Especiales
¡Su guía para la integración de V5!
La integración de fórmulas entre V5 Traceability y el sistema ERP del cliente permite importar fórmulas, recetas y listas de materiales, que luego pueden programarse mediante órdenes de trabajo para producir lotes o productos utilizando el terminal V5.
Para obtener más información sobre cómo funciona el módulo de formulación en V5 Traceability, consulte nuestra guía de módulos aquí.
Índice
1. Disposición del centro de control
En términos de cómo podemos relacionar los detalles de la fórmula con lo que vemos en el Centro de control, usaremos la API V5 y la puerta de enlace para completar tanto la parte superior como la API. ‘Formula’ panel para ingresar datos del encabezado de la fórmula, así como la parte inferior ‘Formula Step’ panel para completar los detalles del paso de la fórmula.
Dependiendo de nuestro método de integración, haremos uso de la ‘Formula’ y ‘FormulaStep’ puntos finales para completar ambos paneles y completar nuestra configuración de fórmula.
2. Enlaces API
Para obtener más información sobre las definiciones de estas clases de bases de datos, consulte los siguientes enlaces:
3. Plantilla de integración
La plantilla de integración para fórmulas se puede descargar aquí.
4. Guía de campo de fórmulas
4.1. Claves primarias
Las claves primarias son el identificador único para cada tabla dentro de la API V5. Para Formula, esto es:
commodity.code – El código de producto subyacente de la fórmula. El número de fórmula/receta.
Para FormulaStep, las claves primarias son:
formula.commodity.code – El mismo código de producto para la fórmula en sí como se describe anteriormente.
sequence – Se utiliza para determinar el orden de los pasos de fórmula individuales dentro de una configuración de fórmula, es decir, 1, 2, 3, etc.
4.2. Campos requeridos
Otros campos que SG requiere para completar una línea de fórmula válida en el Centro de control son:
Para Formula:
type – El tipo de fórmula. Debe ser 0 (para una fórmula de lote) o 1 (para una fórmula de producto).
defaultSize - los 'Tamaño base' de la fórmula en cuestión.
commodity.units.code – La unidad de peso en la que se producirá la fórmula. Si no se indica, se creará la fórmula en la unidad de medida predeterminada de la base de datos.
Para FormulaStep:
type - la formula paso tipo.
Los tipos de pasos son los siguientes:
0 – Pesar
1 – Entrada clave
2 – Pregunta
3 - Mensaje
4 – Cambio de contenedor
5 – Componente del producto
6 – Embalaje del producto
7 – Submezcla
8 – Cotejo
9 - Dispensador a granel
10 - Opcional
11 – Escanear
12 - Revisar
13 – Suspender
4.3. Campos preferidos
Los campos preferidos sirven para agregar más información a la fórmula en cuestión y, aunque no son obligatorios, son útiles cuando se trata de funciones adicionales dentro de Trazabilidad V5.
Para Formula estos campos son:
commodity.units.code – La unidad de peso en la que se producirá la fórmula. Si no se indica, se creará la fórmula en la unidad de medida predeterminada de la base de datos.
minimumProducts – El tamaño mínimo del lote que se puede producir.
maximumProducts – El tamaño máximo del lote que se puede producir.
Para FormulaStep estos campos son:
sequence – la secuencia del paso de la fórmula, es decir, en qué orden debe procesarse durante la producción.
commodity.code – el producto/ingrediente que se utilizará para el paso en particular
targetQty – el peso objetivo para el paso en particular
unit.code – la UM de ese paso en particular
question.question– Si este paso va a ser una pregunta o mensaje, entonces puede ingresarlo usando este campo.
Podemos, como hemos visto en las secciones de claves principales y campos obligatorios, recorrer entre estos 2 'formula'Y'formulaStep' clases, por lo que podemos incluir los puntos de datos anteriores para usar con cualquiera de las clases, siempre que podamos atravesar esa clase con éxito.
4.4. Campos Adicionales
También se pueden incluir campos adicionales, como por ejemplo FormulaStep:
upperTol – La tolerancia superior para ese paso en particular, es decir, lo máximo que el peso puede estar por encima de la cantidad objetivo, es aceptable cuando se produce la fórmula.
lowerTol – La tolerancia más baja para ese paso en particular, es decir, lo máximo que el peso puede estar por debajo de la cantidad objetivo para que sea aceptable cuando se produce la fórmula.
schedule – Si el paso debe programarse cuando se produce la fórmula. Útil para pasos que son submezclas y deben producirse al mismo tiempo que una fórmula maestra.
Como se discutió anteriormente, aún podríamos hacer uso de estos puntos de datos cuando usemos el ‘formula’ punto final, simplemente atravesando hasta el ‘formulaStep’ clase agregando ‘formulaStep’ a cada uno de los anteriores.
5. Metodología
Dependiendo de nuestra metodología de integración de fórmulas, generalmente usaríamos diferentes puntos finales; Para la integración de API generalmente usaríamos ‘Formula’y para CSV ‘FormulaStep’. Podemos echar un vistazo a ambos ahora y ver por qué es así.
5.1. JSON – Importar
Fórmula:
Podemos hacer uso de la ‘Formula’ endpoint para crear nuevas fórmulas para producción en Trazabilidad V5. Como veremos, el uso de este punto final nos permite capturar fácilmente tanto el encabezado de la fórmula como la información del paso en 1 archivo.
‘Formula’ importar punto final/URI –
http://host:port/V5-API/api/integrate/import/formula
Para esta importación de muestra usando el ‘Formula’ punto final, podemos estructurar un archivo de importación básico para una sola fórmula con 2 pasos de fórmula como se muestra a continuación:
Este archivo JSON de ejemplo se puede descargar aquí.
Usando el manual de API, podemos trazar las rutas que estamos usando para recorrer las diversas clases que necesitamos usar para esta importación. En el ‘Formula’ clase podemos ver que todo lo que estamos usando aquí es el ‘type’ y ‘productionLocation’. Desde aquí necesitamos definir nuestra fórmula de información sobre productos básicos, lo cual podemos hacer atravesando desde ‘Formula’ a ‘Commodity’. Aquí podemos ingresar la información del producto para la fórmula en sí (su código, descripción, etc.).
Para luego definir los pasos de la fórmula, primero debemos recorrer hasta el ‘FormulaStep’ clase, donde podemos definir el tipo de paso, la cantidad objetivo, las tolerancias, etc. Desde aquí, volveríamos a atravesar la ‘Commodity’ clase, excepto que aquí, debido a la ruta que hemos tomado hacia la clase, definiremos la información del producto para el ingrediente que se usará para un paso de fórmula específico, en lugar de la información del encabezado que ya definimos anteriormente.
Desde aquí atravesaríamos desde ambos ‘Commodity’ clases para llegar al ‘WeightUnit’ clase, donde podemos definir la UM tanto para la fórmula en sí como para cada paso individual. Entonces, aunque estamos usando la misma clase para esto, lo hemos llegado de 2 maneras diferentes, lo cual se refleja en las definiciones que podemos ver (commodity.units.code vs formulaStep.commodity.units.code), permitiéndonos utilizar diferentes UMs si así lo deseamos.
Podemos ver un resumen de la búsqueda de ruta necesaria para producir el archivo JSON anterior aquí:
Podemos construir el resto de nuestros puntos de datos requeridos utilizando un método de búsqueda de ruta similar.
Si ejecutamos el archivo JSON anterior, veremos que esta nueva fórmula, junto con sus pasos, ahora está visible en la pestaña 'Fórmulas' en el Centro de control.
Paso de fórmula:
‘FormulaStep’ importar punto final/URI –
http://host:port/V5-API/api/integrate/import/formula_step
Para esta importación de muestra usando el ‘FormulaStep’ punto final, consideraremos importar la misma fórmula que hicimos anteriormente, pero simplemente cambiaremos su nombre. Usando este punto final podemos estructurar este archivo de la siguiente manera:
También podemos hacer uso de la ‘FormulaStep’ endpoint para crear nuevas fórmulas para producción en Trazabilidad V5. Esto funcionaría en gran medida de la misma manera que usar ‘Formula’ arriba, pero efectivamente tendríamos que recorrer las clases de la base de datos a la inversa, por lo que en lugar de ir desde ‘Formula’ a ‘FormulaStep’, pasaríamos de ‘FormulaStep’ a ‘Formula’. Podemos ver cómo funcionaría esto a continuación:
Este archivo JSON de ejemplo se puede descargar aquí.
Como podemos ver aquí, estamos ingresando la misma información en términos de los pasos y simplemente cambiando el nombre de la fórmula. Nótese aquí el recorrido desde el ‘formulaStep’ clase a la ‘formula’ clase, y el hecho de que es necesario anidar esta información para cada paso de la fórmula.
Si ahora ejecutamos este archivo JSON de ejemplo, nuestra fórmula duplicada ahora se creará con la misma configuración que vimos cuando usamos el ‘Formula’ punto final
5.2. JSON – Exportar
En términos de recibir archivos relacionados con fórmulas/recetas desde la API V5, realmente no estamos rastreando ningún dato de consumo aquí, por lo que simplemente exportaremos la configuración/instalación de una fórmula. Todavía quedan algunas opciones para esto si comprobamos las disponibles. ‘IntegrationExport’ servicios:
Fórmula:
Exportar punto final/URI –
http://host:port/V5-API/api/integrate/export/formula/{code}
Este punto final exportará un archivo JSON con toda la información relacionada para una fórmula específica. Si ejecutamos esta solicitud GET para la fórmula que creamos a través del ‘Formula’ punto final, obtendremos un archivo de retorno similar a este:
Aquí puede descargar un archivo JSON de ejemplo.
All Formulas:
Exportar punto final/URI –
http://host:port/V5-API/api/integrate/export/formulas
Este punto final exportará un archivo JSON que incluye una lista de todas las fórmulas contenidas en el sistema. Tenga en cuenta que esto solo devolverá los datos del encabezado de cada fórmula. Para recuperar los pasos de la fórmula, consulte a continuación.
Aquí puede descargar ejemplos de archivos JSON de este tipo.
Paso de fórmula:
Exportar punto final/URI –
http://host:port/V5-API/api/integrate/export/formula_step/{code}/{sequence}
Este punto final se puede configurar para devolver datos para un paso específico de una fórmula específica. Especificaríamos qué paso queremos recuperar utilizando su número de secuencia. Si llegamos a este punto final para recuperar el paso 1 de la primera fórmula de ejemplo que creamos anteriormente, obtendremos un resultado similar a este:
Este archivo JSON de ejemplo se puede descargar aquí.
Pasos de la fórmula:
Exportar punto final/URI –
http://host:port/V5-API/api/integrate/export/formula_steps/{all}
Este punto final proporciona una lista de todos los pasos de la fórmula dentro del sistema. Podemos cambiar la devolución usando cualquiera de los dos ‘/true’ or ‘/false’ en lugar de ‘/{all}’ en el URI de arriba. ‘True’ exportará una lista de todos los pasos del sistema, mientras que ‘false’ devolverá una lista de pasos no marcados como ya exportados.
El diseño sería muy similar al ejemplo anterior, solo que con más pasos presentes. Un ejemplo de un ‘true’ La exportación de este tipo se puede descargar. aquí.
5.3. CSV – Importar
Nota: Una vez importadas, las fórmulas pueden protegerse de cualquier modificación marcando la casilla "Excluir importación" en el encabezado de la fórmula en el Centro de control . Esto solo se aplica a la metodología CSV.
Hemos visto en los ejemplos JSON anteriores que podemos usar tanto el ‘formula’ y ‘formulaStep’ puntos finales para esa metodología en particular. Sin embargo, para las importaciones CSV solo usaremos el ‘formulaStep’ punto final
Nombre de archivo de definición de encabezado/columna: “formulaStep.csvh”
Los archivos de encabezado completos deben colocarse en: “<installdir>\SG Control Center\gateway\import\column_defs”
Importar nombre de archivo CSV: “formulaStep-datetime.csv”
Los CSV para la importación deben colocarse en: “<installdir>\SG Control Center\gateway\import”
Archivo de cabecera:
Los archivos de encabezado generalmente serán compilados por SG Systems antes de que se realicen las integraciones CSV, pero podemos ver un ejemplo básico de uno que podemos usar para trabajos a continuación:
Para obtener más información sobre cómo estructuramos estos archivos, consulte la página principal de integración . Este archivo de encabezado de ejemplo se puede descargar aquí.
Archivo de importación CSV:
Luego podemos usar el orden definido de puntos de datos en el encabezado para estructurar nuestro archivo de importación. SG Systems puede proporcionar un archivo de plantilla para esto, enumerando el punto de datos para cada columna para aclarar las cosas al completar la lista. Tenga en cuenta que el Centro de control puede ignorar esta primera fila y, por lo tanto, puede conservarse en el archivo cuando se envía para importar.
Nuevamente crearemos una fórmula duplicada de las 2 que creamos mediante el método JSON anterior. Un archivo de importación CSV de ejemplo para una fórmula podría verse así:
Este archivo de importación de ejemplo se puede descargar aquí.
Una vez completada la importación, podemos ver que esta fórmula adicional se agregó al Centro de control con los mismos pasos que las fórmulas que creamos usando las importaciones JSON anteriores.
5.4. CSV – Exportar
Para nuestras exportaciones CSV, simplemente usaremos el mismo ‘formulaStep’ archivo de encabezado/punto final como se indicó anteriormente para las importaciones. Esto se puede descargar aquí.
Nombre de archivo de definición de encabezado/columna: “formulaStep.csvh”
Los archivos de encabezado completos deben colocarse en: “<installdir>\SG Control Center\gateway\export\order”
Exportar nombre de archivo CSV: “FormulaStep-datetime.csv”
Los CSV para las exportaciones se generarán en: “<installdir>\SG Control Center\gateway\export”
Esta es la única manera de recuperar los datos de la fórmula de V5 Traceability en forma de CSV.
Esta exportación también debería estar habilitada en la sección Puerta de enlace del Centro de control. Podemos elegir aquí para exportar ‘Formulas’.
Archivo de cabecera:
Para este ejemplo, podemos utilizar el encabezado utilizado anteriormente para la importación para la exportación. Se pueden agregar puntos de datos adicionales a esto si se desea.
Archivo de exportación CSV:
Habilitar esta exportación usando el encabezado usado anteriormente generaría un archivo de exportación para nuestras 3 nuevas fórmulas que se vería así:
5.5. Proteger fórmulas
Exclusivo del mecanismo de importación CSV, hay una casilla de verificación "Protegido" disponible junto al encabezado de la fórmula en el Centro de control:
Si esta opción está marcada, la fórmula estará protegida contra cualquier cambio realizado por las importaciones CSV de formulaStep posteriores.
Como se indicó anteriormente, esto es exclusivo de la metodología de importación CSV; marcar esta casilla no protegerá una fórmula de las actualizaciones a través de JSON/API.
