Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
Parámetros de automatización
Los parámetros de automatización son una potente función de App Studio que se puede usar para crear automatizaciones flexibles y reutilizables mediante la transferencia de valores dinámicos de varias fuentes, como la interfaz de usuario, otras automatizaciones o acciones de datos. Actúan como marcadores de posición que se sustituyen por valores reales cuando se ejecuta la automatización, lo que te permite usar la misma automatización con entradas diferentes cada vez.
En una automatización, los parámetros tienen nombres únicos y puedes hacer referencia al valor de un parámetro mediante la variable params seguida del nombre del parámetro, por ejemplo. {{params.customerId}}
Este artículo proporciona una comprensión profunda de los parámetros de automatización, incluidos sus conceptos fundamentales, su uso y sus mejores prácticas.
Ventajas de los parámetros de automatización
Los parámetros de automatización ofrecen varias ventajas, entre las que se incluyen las siguientes:
Reutilización: mediante el uso de parámetros, puede crear automatizaciones reutilizables que se pueden personalizar con diferentes valores de entrada, lo que le permite reutilizar la misma lógica de automatización con diferentes entradas.
Flexibilidad: en lugar de codificar los valores de forma rígida en una automatización, puedes definir los parámetros y proporcionar diferentes valores cuando sea necesario, lo que hace que tus automatizaciones sean más dinámicas y adaptables.
Separación de preocupaciones: los parámetros ayudan a separar la lógica de automatización de los valores específicos utilizados, lo que promueve la organización y la capacidad de mantenimiento del código.
Validación: cada parámetro tiene un tipo de datos, como cadena, número o booleano, que se valida en tiempo de ejecución. Esto garantiza que las solicitudes con tipos de datos incorrectos se rechacen sin necesidad de un código de validación personalizado.
Parámetros opcionales y obligatorios: puede designar los parámetros de automatización como opcionales u obligatorios. Los parámetros obligatorios se deben proporcionar al ejecutar la automatización, mientras que los parámetros opcionales pueden tener valores predeterminados o omitirse. Esta flexibilidad le permite crear automatizaciones más versátiles que pueden gestionar diferentes escenarios en función de los parámetros proporcionados.
Escenarios y casos de uso
Escenario: recuperación de los detalles del producto
Imagine que tiene una automatización que recupera los detalles del producto de una base de datos en función de un identificador de producto. Esta automatización podría tener un parámetro llamadoproductId.
El productId parámetro actúa como un marcador de posición que puedes rellenar con el valor real del identificador del producto al ejecutar la automatización. En lugar de codificar de forma rígida un identificador de producto específico en la automatización, puedes definir el productId parámetro e introducir distintos valores de identificador de producto cada vez que ejecutes la automatización.
Puedes llamar a esta automatización desde la fuente de datos de un componente, pasando el ID del producto seleccionado como productId parámetro usando la sintaxis de dos corchetes:. {{ui.productsTable.selectedRow.id}} De esta forma, cuando un usuario selecciona un producto de una tabla (ui.productsTable), la automatización recuperará los detalles del producto seleccionado pasando el identificador de la fila seleccionada como productId parámetro.
Como alternativa, puedes invocar esta automatización desde otra automatización que recorra una lista de productos y recupera los detalles de cada producto pasando la identificación del producto como parámetro. productId En este escenario, el valor del productId parámetro se proporcionaría de forma dinámica a partir de la {{product.id}} expresión en cada iteración del ciclo.
Al usar el productId parámetro y la sintaxis de dos corchetes, puede hacer que esta automatización sea más flexible y reutilizable. En lugar de crear automatizaciones independientes para cada producto, puedes tener una sola automatización que pueda recuperar los detalles de cualquier producto simplemente proporcionando el identificador de producto correspondiente como valor de parámetro de diferentes fuentes, como los componentes de la interfaz de usuario u otras automatizaciones.
Escenario: gestionar los parámetros opcionales con valores alternativos
Pensemos en un escenario en el que tienes una entidad denominada «Tarea» con la columna «Propietario» obligatoria, pero quieres que este campo sea opcional en la automatización y que proporcione un valor alternativo si el propietario no está seleccionado.
Crea una automatización con un parámetro llamado
Ownerque se asigne alOwnercampo de laTaskentidad.Como el
Ownercampo es obligatorio en la entidad, elOwnerparámetro se sincronizará con la configuración requerida.Para que el
Ownerparámetro sea opcional en la automatización, desactive larequiredconfiguración de este parámetro.En tu lógica de automatización, puedes usar una expresión como
{{params.Owner || currentUser.userId}}. Esta expresión comprueba si se proporciona elOwnerparámetro. Si no se proporciona, recurrirá al ID del usuario actual como propietario.De esta forma, si el usuario no selecciona un propietario en un formulario o componente, la automatización asignará automáticamente al usuario actual como propietario de la tarea.
Al cambiar la required configuración del Owner parámetro y usar una expresión alternativa, puedes desvincularlo del requisito del campo de la entidad, convertirlo en opcional en la automatización y proporcionar un valor predeterminado cuando no se proporcione el parámetro.
Definir los tipos de parámetros de automatización
Al usar los tipos de parámetros para especificar los tipos de datos y establecer los requisitos, puede controlar las entradas de sus automatizaciones. Esto ayuda a garantizar que las automatizaciones se ejecuten de forma fiable con las entradas esperadas.
Sincronizar los tipos de una entidad
La sincronización dinámica de los tipos de parámetros y los requisitos de las definiciones de los campos de las entidades agiliza la creación de automatizaciones que interactúan con los datos de las entidades, lo que garantiza que el parámetro siempre refleje los requisitos y tipos de campo de la entidad más recientes.
El siguiente procedimiento detalla los pasos generales para sincronizar los tipos de parámetros de una entidad:
Cree una entidad con campos escritos (por ejemplo, booleanos, numéricos, etc.) y márquelos según sea necesario.
Crea una nueva automatización.
Agregue parámetros a la automatización y, al elegir el tipo, elija el campo de entidad con el que desea sincronizarse. El tipo de datos y la configuración requerida se sincronizarán automáticamente desde el campo de la entidad mapeada
Si es necesario, puede anular la configuración «obligatoria» cambiándola para cada parámetro. on/off Esto significa que el estado obligatorio no se mantendrá sincronizado con el campo de la entidad, sino que, de lo contrario, permanecerá sincronizado.
Definir los tipos manualmente
También puede definir los tipos de parámetros manualmente sin sincronizarlos desde una entidad
Al definir tipos de parámetros personalizados, puede crear automatizaciones que acepten tipos de entrada específicos y gestionen los parámetros opcionales o obligatorios según sea necesario, sin depender de las asignaciones de campos de entidades.
Crea una entidad con campos escritos (por ejemplo, booleanos, numéricos, etc.) y marca los campos según sea necesario.
Crea una nueva automatización.
Agregue parámetros a la automatización y, al elegir el tipo, elija el tipo deseado.
Configurar los valores dinámicos para pasarlos a los parámetros de automatización
Una vez que hayas definido los parámetros para una automatización, puedes pasarles valores al invocar la automatización. Puedes pasar los valores de los parámetros de dos maneras:
Activadores de componentes: si invocas la automatización desde un activador de un componente (por ejemplo, al hacer clic en un botón), puedes usar JavaScript expresiones para transferir valores desde el contexto del componente. Por ejemplo, si tiene un campo de entrada de texto llamado
emailInput, puede pasar su valor al parámetro de correo electrónico con la siguiente expresión:ui.emailInput.value.Otras automatizaciones: si invocas la automatización desde otra automatización, puedes usar JavaScript expresiones para pasar valores desde el contexto de automatización. Por ejemplo, puedes pasar el valor de otro parámetro o el resultado de un paso de acción anterior.
Escriba seguridad
Al definir los parámetros con tipos de datos específicos, como cadena, número o booleano, puedes asegurarte de que los valores que se transfieren a la automatización son del tipo esperado.
nota
En App Studio, las fechas son fechas de cadenas ISO y también se validarán.
Esta seguridad de tipos ayuda a evitar discrepancias entre tipos, lo que puede provocar errores o comportamientos inesperados en la lógica de automatización. Por ejemplo, si defines un parámetro como aNumber, puedes estar seguro de que cualquier valor que se le pase a ese parámetro será un número y no tendrás que realizar más comprobaciones de tipo o conversiones dentro de la automatización.
Validación
Puedes agregar reglas de validación a tus parámetros para asegurarte de que los valores transferidos a tu automatización cumplan ciertos criterios.
Si bien App Studio no proporciona una configuración de validación integrada para los parámetros, puedes implementar validaciones personalizadas añadiendo una JavaScript acción a tu automatización que genere un error si se infringen restricciones específicas.
En el caso de los campos de entidad, se admite un subconjunto de reglas de validación, como minimum/maximum los valores. Sin embargo, no se validan en el nivel de automatización, solo en la capa de datos, cuando se ejecutan acciones de Create/Update/Delete registro.
Mejores prácticas para los parámetros de automatización
Para garantizar que los parámetros de automatización estén bien diseñados, se puedan mantener y sean fáciles de usar, siga estas prácticas recomendadas:
Utilice nombres de parámetros descriptivos: elija nombres de parámetros que describan claramente el propósito o el contexto del parámetro.
Proporcione descripciones de los parámetros: aproveche el campo Descripción al definir los parámetros para explicar su propósito, sus restricciones y sus expectativas. Estas descripciones aparecerán en los comentarios de JSDoc al hacer referencia al parámetro, así como en cualquier interfaz de usuario en la que los usuarios necesiten proporcionar valores para los parámetros al invocar la automatización.
Utilice los tipos de datos adecuados: considere detenidamente el tipo de datos de cada parámetro en función de los valores de entrada esperados, por ejemplo: cadena, número, booleano, objeto.
Valide los valores de los parámetros: implemente las comprobaciones de validación adecuadas en su automatización para asegurarse de que los valores de los parámetros cumplen con los requisitos específicos antes de continuar con las acciones.
Usa valores alternativos o predeterminados: aunque App Studio no admite actualmente la configuración de valores predeterminados para los parámetros, puedes implementar valores alternativos o predeterminados cuando utilices los parámetros de tu lógica de automatización. Por ejemplo, puedes usar una expresión similar
{{ params.param1 || "default value" }}a la de proporcionar un valor predeterminado si elparam1parámetro no se proporciona o tiene un valor falso.Mantenga la coherencia de los parámetros: si tiene varias automatizaciones que requieren parámetros similares, intente mantener la coherencia en los nombres de los parámetros y los tipos de datos en todas esas automatizaciones.
Documente el uso de los parámetros: mantenga una documentación clara para sus automatizaciones, que incluya descripciones de cada parámetro, su propósito, los valores esperados y cualquier ejemplo o caso límite relevante.
Revisa y refactoriza con frecuencia: revisa periódicamente tus automatizaciones y sus parámetros, y refactoriza o consolida los parámetros según sea necesario para mejorar la claridad, la capacidad de mantenimiento y la reutilización.
Limite la cantidad de parámetros: si bien los parámetros proporcionan flexibilidad, demasiados parámetros pueden hacer que una automatización sea compleja y difícil de usar. Intente lograr un equilibrio entre flexibilidad y simplicidad limitando la cantidad de parámetros solo a lo que sea necesario.
Considere la posibilidad de agrupar parámetros: si se encuentra definiendo varios parámetros relacionados, considere la posibilidad de agruparlos en un solo
Objectparámetro.Preocupaciones distintas: evita usar un único parámetro para varios propósitos o combinar valores no relacionados en un solo parámetro. Cada parámetro debe representar una preocupación o un dato distinto.
Utilice alias de parámetros: si tiene parámetros con nombres largos o complejos, considere la posibilidad de utilizar alias o versiones abreviadas dentro de la lógica de automatización para mejorar la legibilidad y el mantenimiento.
Si sigues estas prácticas recomendadas, puedes asegurarte de que tus parámetros de automatización estén bien diseñados, se puedan mantener y sean fáciles de usar, lo que, en última instancia, mejorará la calidad y la eficiencia generales de tus automatizaciones.
