Editor de reglas de formularios adaptables adaptive-forms-rule-editor
Información general overview
La característica del editor de reglas en Adobe Experience Manager Forms permite a los usuarios y desarrolladores de formularios empresariales escribir reglas sobre los objetos del formulario adaptable. Estas reglas definen las acciones que se deben activar en los objetos del formulario en función de los ajustes preestablecidos, las entradas del usuario y las acciones del usuario en el formulario. Esto ayuda a optimizar aún más la experiencia de cumplimentación de formularios, lo que garantiza precisión y velocidad.
El editor de reglas proporciona una interfaz de usuario intuitiva y simplificada para escribir reglas. El editor de reglas ofrece un editor visual para todos los usuarios. Además, solo para los usuarios avanzados de formularios, el editor de reglas proporciona un editor de código para escribir reglas y scripts. Algunas de las acciones clave que se pueden realizar en objetos de formulario adaptable mediante reglas son las siguientes:
- Mostrar u ocultar un objeto
- Habilitar o deshabilitar un objeto
- Establecer un valor para un objeto
- Validar el valor de un objeto
- Ejecutar funciones para calcular el valor de un objeto
- Invocar un servicio del modelo de datos de formulario y realizar una operación
- Establecer la propiedad de un objeto
El editor de reglas reemplaza las funciones de los scripts de AEM 6.1 Forms y versiones anteriores. Sin embargo, los scripts existentes se conservan en el nuevo editor de reglas. Para obtener más información sobre cómo trabajar con scripts existentes en el editor de reglas, consulte Impacto del editor de reglas en scripts existentes
Los usuarios que se agregan al grupo de usuarios avanzados de formularios pueden crear scripts nuevos y editar los existentes. Los usuarios del grupo forms-users pueden utilizar los scripts, pero no crearlos o editarlos.
Explicación de una regla understanding-a-rule
Una regla es una combinación de acciones y condiciones. En el editor de reglas, las acciones incluyen actividades como ocultar, mostrar, habilitar, deshabilitar o calcular el valor de un objeto en un formulario. Las condiciones son expresiones booleanas que se evalúan realizando comprobaciones y operaciones en el estado, el valor o la propiedad de un objeto de formulario. Las acciones se realizan según el valor devuelto (True o False) mediante la evaluación de una condición.
El editor de reglas proporciona un conjunto de tipos de reglas predefinidas, como When, Show, Hide, Enable, Disable, Set Value Of y Validate para ayudarle a escribir reglas. Cada tipo de regla permite definir condiciones y acciones en una regla. El documento explica cada tipo de regla en detalle.
Una regla suele seguir una de las siguientes construcciones:
Condición-acción. En esta construcción, una regla primero define una condición seguida de una acción que activar. La construcción es comparable a la instrucción if-then en lenguajes de programación.
En el editor de reglas, el tipo de regla When aplica la construcción de condición-acción.
Acción-condición. En esta construcción, una regla primero define una acción que activar seguida de condiciones para la evaluación. Otra variación de esta construcción es acción-condición-acción alternativa, que también define una acción alternativa que activar si la condición devuelve un valor False.
Los tipos de reglas Show, Hide, Enable, Disable, Set Value Of y Validate del editor de reglas aplican la construcción de reglas acción-condición. De forma predeterminada, la acción alternativa para Mostrar es Ocultar y para Habilitar es Deshabilitar y viceversa. No se puede cambiar la acción alternativa predeterminada.
Para obtener más información sobre los tipos de reglas disponibles en el editor de reglas, consulte Tipos de reglas disponibles en el editor de reglas.
Pautas para elegir una construcción de regla guidelines-for-choosing-a-rule-construct
Aunque puede lograr la mayoría de los casos de uso utilizando cualquier construcción de regla, estas son algunas pautas para elegir una construcción antes que otra. Para obtener más información sobre las reglas disponibles en el editor de reglas, consulte Tipos de reglas disponibles en el editor de reglas.
-
Una regla general típica al crear una regla es pensarla en el contexto del objeto en el que quiere escribirla. Tenga en cuenta que desea ocultar o mostrar el campo B en función del valor que un usuario especifique en el campo A. En este caso, quiere evaluar una condición en el campo A y, en función del valor que se devuelva, se debe activar una acción en el campo B.
Por lo tanto, si está escribiendo una regla en el campo B (el objeto sobre el que se evalúa una condición), utilice la construcción condición-acción o el tipo de regla When. Del mismo modo, utilice la construcción acción-condición o el tipo de regla Show o Hide en el campo A.
-
A veces, debe realizar varias acciones en función de una condición. En estos casos, se recomienda utilizar la construcción condición-acción. En esta construcción, puede evaluar una condición una vez y especificar varias instrucciones de acción.
Por ejemplo, para ocultar los campos B, C y D en función de la condición que comprueba el valor que un usuario especifica en el campo A, escriba una regla con la estructura condición-acción o el tipo de regla When en el campo A y especifique acciones para controlar la visibilidad de los campos B, C y D. De lo contrario, necesitará tres reglas independientes en los campos B, C y D, donde cada regla comprueba la condición y muestra u oculta el campo respectivo. En este ejemplo, es más eficaz escribir el tipo de regla When en un objeto, en lugar de Show o Hide en tres objetos.
-
Para activar una acción basada en varias condiciones, se recomienda utilizar la construcción acción-condición. Por ejemplo, para mostrar y ocultar el campo A mediante la evaluación de condiciones en los campos B, C y D, utilice los tipos de reglas Show o Hide en el campo A.
-
Utilice la construcción condición-acción o acción-condición si la regla contiene una acción para una condición.
-
Si una regla comprueba la existencia de una condición y realiza una acción inmediatamente al proporcionar un valor en un campo o al salir de un campo, se recomienda escribir una regla con la construcción condición-acción o el tipo de regla When en el campo en el que se evalúa la condición.
-
La condición de la regla When se evalúa cuando un usuario cambia el valor del objeto en el que se aplica dicha regla. Pero si desea que la acción se active cuando el valor cambia en el servidor, como para rellenar previamente el valor, se recomienda escribir una regla When que active la acción cuando el campo se inicialice.
-
Al escribir reglas para objetos de menús desplegables, botones de opción o casillas de verificación, las opciones o los valores de estos objetos de formulario en el mismo se rellenan previamente en el editor de reglas.
Tipos de operadores y eventos disponibles en el editor de reglas available-operator-types-and-events-in-rule-editor
El editor de reglas proporciona los siguientes operadores lógicos y eventos mediante los cuales puede crear reglas.
- Is Equal To
- Is Not Equal To
- Starts With
- Ends With
- Contains
- Is Empty
- Is Not Empty
- Has Selected: devuelve el valor True cuando el usuario selecciona una opción concreta para un botón de opción, un menú desplegable o una casilla de verificación.
- Is Initialized (event): devuelve el valor True cuando un objeto de formulario se procesa en el explorador.
- Is Changed (event): devuelve el valor True cuando el usuario cambia el valor indicado o la opción seleccionada para un objeto de formulario.
Tipos de reglas disponibles en el editor de reglas available-rule-types-in-rule-editor
El editor de reglas proporciona un conjunto de tipos de reglas predefinidas que puede utilizar para escribir reglas. Veamos en detalle cada tipo de regla. Para obtener más información sobre cómo escribir reglas en el editor de reglas, consulte Escribir reglas.
Cuando when
El tipo de regla When sigue a la construcción de regla condición-acción-acción alternativa o, a veces, solo a la construcción condición-acción. En este tipo de regla, primero debe especificar una condición para la evaluación seguida de una acción que se activará si se cumple la condición (True). Al usar el tipo de regla When, puede usar varios operadores AND y OR para crear expresiones anidadas.
Con el tipo de regla When, se puede evaluar una condición en un objeto de formulario y realizar acciones en uno o varios objetos.
En palabras simples, una regla When típica está estructurada de la siguiente manera:
When on Object A:
(Condition 1 AND Condition 2 OR Condition 3) is TRUE;
Then, do the following:
Action 2 on Object B;
AND
Action 3 on Object C;
Cuando tiene un componente de varios valores, como botones de opción o lista, mientras crea una regla para ese componente, las opciones se recuperan automáticamente y se ponen a disposición del creador de reglas. No es necesario volver a escribir los valores de las opciones.
Por ejemplo, una lista tiene cuatro opciones: rojo, azul, verde y amarillo. Al crear la regla, las opciones (botones de opción) se recuperan automáticamente y se ponen a disposición del creador de reglas de la siguiente manera:
Al escribir una regla When, puede activar la acción Clear Value Of. La acción Clear Value Of borra el valor del objeto especificado. Contar con Clear Value Of como opción en la instrucción When permite crear condiciones complejas con varios campos.
Hide. Oculta el objeto especificado.
Show. Muestra el objeto especificado.
Enable. Habilita el objeto especificado.
Disable. Deshabilita el objeto especificado.
Invoke service. Invoca un servicio configurado en un modelo de datos de formulario. Al elegir la operación Invoke Service, aparece un campo. Al pulsar el campo, se muestran todos los servicios configurados en todos los modelos de datos de formulario de la instancia de AEM. Al elegir un servicio del modelo de datos de formulario, aparecen campos adicionales en los que se pueden asignar objetos de formulario con parámetros de entrada y salida para el servicio especificado. Consulte la regla de ejemplo para invocar los servicios del modelo de datos de formulario.
Además del servicio de modelo de datos de formulario, puede especificar una URL de WSDL directa para invocar un servicio web. Pero un servicio del modelo de datos de formulario tiene muchas ventajas y es el método recomendado para invocar un servicio.
Para obtener más información sobre la configuración de servicios en el modelo de datos de formulario, consulte Integración de datos de AEM Forms.
Establecer valor de Calcula y establece el valor del objeto especificado. Puede establecer el valor del objeto en una cadena, el valor de otro objeto, el valor calculado mediante expresión o función matemática, el valor de una propiedad de un objeto o el valor de salida de un servicio configurado del modelo de datos de formulario. Al elegir la opción de servicio web, se muestran todos los servicios configurados en todos los modelos de datos de formulario de la instancia de AEM. Al elegir un servicio del modelo de datos de formulario, aparecen campos adicionales en los que se pueden asignar objetos de formulario con parámetros de entrada y salida para el servicio especificado.
Para obtener más información sobre la configuración de servicios en el modelo de datos de formulario, consulte Integración de datos de AEM Forms.
Establecer propiedad Define el valor de una propiedad del objeto especificado.
Clear Value Of. Borra el valor del objeto especificado.
Set Focus. Define el enfoque del objeto especificado.
Save Form. Guarda el formulario.
Submit Forms. Envía el formulario.
Reset Form. Restablece el formulario.
Validate Form. Valida el formulario.
Add Instance. Agrega una instancia del panel repetible o fila de tabla especificados.
Remove Instance. Quita una instancia del panel repetible o fila de tabla especificados.
Establecer valor de set-value-of
El tipo de regla Establecer valor de le permite definir el valor de un objeto de formulario en función de si la condición especificada se cumple o no. El valor puede establecerse en un valor de otro objeto, una cadena literal, un valor derivado de una expresión matemática o una función, un valor de una propiedad de otro objeto o el resultado de un servicio de modelo de datos de formulario. Del mismo modo, se puede comprobar la existencia de una condición en un componente, una cadena, una propiedad o valores derivados de una función o expresión matemática.
Nota: El tipo de regla Establecer valor de no está disponible para todos los objetos de formulario, como paneles y botones de la barra de herramientas. Una regla de valor definido estándar tiene la siguiente estructura:
Set value of Objeto A to:
(cadena ABC) OR
(propiedad de objeto X del objeto C) OR
(valor de una función) O
(valor de una expresión matemática) O
(valor de salida de un servicio de modelo de datos o servicio Web);
When (opcional):
(Condición 1 AND Condición 2 AND Condición 3) is TRUE;
El siguiente ejemplo toma el valor del campo dependentid como entrada y establece el valor del campo Relation como salida del argumento Relation del servicio getDependent del modelo de datos de formulario.
Ejemplo de la regla Establecer valor mediante un servicio del modelo de datos de formulario
Show show
Al usar el tipo de regla Show, puede escribir una regla para mostrar u ocultar un objeto de formulario en función de si una condición se cumple o no. El tipo de regla Show también activa la acción Hide (ocultar) en caso de que la condición no se cumpla o devuelva un valor False.
Una regla Show típica se estructura de la siguiente manera:
Show Object A;
When:
(Condition 1 OR Condition 2 OR Condition 3) is TRUE;
Else:
Hide Object A;
Hide hide
Al igual que el tipo de regla Show, puede usar el tipo de regla Hide para mostrar u ocultar un objeto de formulario en función de si se cumple o no una condición. El tipo de regla Hide también activa la acción Show (mostrar) en caso de que la condición no se cumpla o devuelva un valor False.
Una regla Hide típica se estructura de la siguiente manera:
Hide Object A;
When:
(Condition 1 AND Condition 2 AND Condition 3) is TRUE;
Else:
Show Object A;
Habilitar enable
El tipo de regla Enable permite activar o desactivar un objeto de formulario en función de si se cumple o no una condición. El tipo de regla Enable también activa la acción Disable en caso de que la condición no se cumpla o devuelva un valor False.
Una regla Enable típica se estructura de la siguiente manera:
Enable Object A;
When:
(Condition 1 AND Condition 2 AND Condition 3) is TRUE;
Else:
Disable Object A;
Disable disable
Similar al tipo de regla Enable, el tipo de regla Disable permite habilitar o deshabilitar un objeto de formulario en función de si se cumple o no una condición. El tipo de regla Disable también activa la acción Enable (habilitar) en caso de que la condición no se cumpla o devuelva un valor False.
Una regla Disable típica se estructura de la siguiente manera:
Disable Object A;
When:
(Condition 1 OR Condition 2 OR Condition 3) is TRUE;
Else:
Enable Object A;
Validate validate
El tipo de regla Validate valida el valor de un campo mediante una expresión. Por ejemplo, puede escribir una expresión para comprobar que el cuadro de texto para especificar el nombre no contenga caracteres especiales ni números.
Una regla Validate típica se estructura de la siguiente manera:
Validate Object A;
Using:
(Expression 1 AND Expression 2 AND Expression 3) is TRUE;
Explicación de la interfaz de usuario del editor de reglas understanding-the-rule-editor-user-interface
El editor de reglas proporciona una interfaz de usuario completa pero sencilla para escribir y administrar reglas. Puede iniciar la interfaz de usuario del editor de reglas desde un formulario adaptable en modo de creación.
Para iniciar la interfaz de usuario del editor de reglas, haga lo siguiente:
-
Abra un formulario adaptable en modo de creación.
-
Pulse el objeto de formulario para el que desea escribir una regla y, en la barra de herramientas de componentes, pulse
Cualquier regla existente en los objetos de formulario seleccionados se muestra en esta vista. Para obtener información sobre la administración de reglas existentes, consulte Administrar reglas.
-
Pulse Crear para escribir una regla nueva. El editor visual de la interfaz de usuario del editor de reglas se abre de forma predeterminada cuando se inicia el editor de reglas por primera vez.
Veamos en detalle cada componente de la interfaz de usuario del editor de reglas.
A. Visualización de la regla de componente a-component-rule-display
Muestra el título del objeto del formulario adaptable a través del cual se ha iniciado el editor de reglas y el tipo de regla seleccionado actualmente. En el ejemplo anterior, el editor de reglas se inicia desde un objeto de formulario adaptable llamado Salary y el tipo de regla seleccionado es When.
B. Desde objetos y funciones b-form-objects-and-functions-br
El panel de la izquierda de la interfaz de usuario del editor de reglas incluye dos pestañas: Objetos de formulario y Funciones.
La pestaña Objetos de formulario muestra una vista jerárquica de todos los objetos contenidos en el formulario adaptable. Muestra el título y el tipo de los objetos. Al escribir una regla, puede arrastrar y soltar objetos de formulario en el editor de reglas. Al crear o editar una regla cuando arrastra y suelta un objeto o función en un marcador de posición, el marcador de posición toma automáticamente el tipo de valor apropiado.
Los objetos de formulario que tienen una o más reglas válidas aplicadas se marcan con un punto verde. Si alguna de las reglas aplicadas a un objeto de formulario no es válida, este se marcará con un punto amarillo.
La pestaña Funciones incluye un conjunto de funciones integradas, como Sum Of (suma de), Min Of (mín. de), Max Of (máx. de), Average Of (promedio de), Number Of (número de) y Validate Form (validar formulario). Puede utilizar estas funciones para calcular valores en paneles repetibles y filas de tabla y utilizarlos en instrucciones de acción y condición al escribir reglas. Sin embargo, también puede crear funciones personalizadas.
En el árbol izquierdo de los objetos de formulario, puede pulsar los objetos de formulario para mostrar las reglas aplicadas a cada uno de ellos. No solo puede desplazarse por las reglas de los distintos objetos de formulario, sino que también puede copiar y pegar reglas entre los objetos de formulario. Para obtener más información, consulte Copiar y pegar reglas.
C. Alternar entre funciones y objetos de formulario c-form-objects-and-functions-toggle-br
Al pulsar el botón de cambio, se alternan los paneles de funciones y de objetos de formulario.
D. Editor de reglas visual d-visual-rule-editor
El editor de reglas visual es el área del modo de editor visual de la interfaz de usuario del editor de reglas donde se escriben las reglas. Permite seleccionar un tipo de regla y definir las condiciones y las acciones correspondientes. Al definir condiciones y acciones en una regla, puede arrastrar y soltar funciones y objetos de formulario desde el panel Objetos de formulario y el de Funciones.
Para obtener más información sobre el uso del editor de reglas visuales, consulte Escribir reglas.
E. Interruptor de editores de código visual e-visual-code-editors-switcher
Los usuarios del grupo forms-power-users pueden acceder al editor de código. Para otros usuarios, el editor de código no está disponible. Si tiene los derechos, puede cambiar del modo de editor visual al modo de editor de código del editor de reglas y viceversa, mediante el interruptor situado justo encima del editor de reglas. Cuando se inicia el editor de reglas por primera vez, se abrirá en el modo de editor visual. Puede escribir reglas en el modo de editor visual o cambiar al modo de editor de código para escribir un script de regla. Sin embargo, si escribe o modifica una regla en el editor de código, no puede cambiar al editor visual para esa regla a menos que borre el editor de código.
AEM Forms rastrea el modo de editor de reglas que utilizó por última vez para escribir una regla. Cuando inicie el editor de reglas la próxima vez, se abrirá en ese modo. Pero también puede configurar un modo predeterminado para abrir el editor de reglas en el modo especificado. Para ello:
-
Vaya a AEM consola web en https://[host]:[puerto]/system/console/configMgr.
-
Haga clic para editar Configuración del canal web de comunicaciones interactivas y formularios adaptables.
-
Elija Editor visual o Editor de código de la lista desplegable Modo predeterminado del editor de reglas
-
Haga clic en Guardar.
F. Botones Listo y Cancelar f-done-and-cancel-buttons
El botón Listo se utiliza para guardar una regla. Puede guardar una regla incompleta. Sin embargo, las que estén incompletas no son válidas y no se ejecutan. Las reglas guardadas en un objeto de formulario se enumeran cuando se inicia el editor de reglas la próxima vez desde el mismo objeto. Puede administrar las reglas existentes en esa vista. Para obtener más información, consulte Administrar reglas.
El botón Cancelar descarta los cambios realizados en una regla y cierra el editor de reglas.
Escribir reglas write-rules
Puede escribir reglas mediante el editor visual de reglas o el editor de código. Cuando se inicia el editor de reglas por primera vez, se abre en el modo de editor visual. Puede cambiar al modo de editor de código y escribir reglas. Pero si escribe o modifica una regla en el editor de código, no puede cambiar al editor visual para esa regla a menos que borre el editor de código. Cuando inicie el editor de reglas la próxima vez, se abrirá en el modo que utilizó por última vez para crear reglas.
Veamos primero cómo escribir reglas utilizando el editor visual.
Uso del editor visual using-visual-editor
Vamos a comprender cómo crear una regla en el editor visual utilizando el siguiente formulario de ejemplo.
La sección Loan Requirements (requisitos de préstamo) del formulario de solicitud de ejemplo requiere que los solicitantes especifiquen su estado civil, su salario y, si están casados, el salario de su cónyuge. En función de las entradas del usuario, la regla calcula la cantidad de idoneidad para el préstamo y se muestra en el campo Loan Eligibility (elegibilidad del préstamo). Aplique las siguientes reglas para implementar el escenario:
- El campo Spouse’s Salary (salario del cónyuge) solo se muestra cuando en el estado civil (Marital Status) se indica que se está casado o casada (Married).
- La cantidad de la elegibilidad del préstamo es el 50 % del salario total.
Siga estos pasos para escribir reglas:
-
En primer lugar, escriba la regla para controlar la visibilidad del campo del salario del cónyuge en función de la opción que seleccione el usuario para el botón de opción de estado civil.
Abra el formulario de solicitud de préstamo en modo de creación. Pulse el componente Marital Status y haga clic en
Al iniciar el editor de reglas, la regla When se selecciona de forma predeterminada. Además, el objeto de formulario (en este caso, Marital Status) desde el que se inició el editor de reglas se especifica en la instrucción When.
Aunque no puede cambiar ni modificar el objeto seleccionado, puede utilizar la lista desplegable de reglas, como se muestra a continuación, para seleccionar otro tipo de regla. Si desea crear una regla en otro objeto, pulse Cancelar para salir del editor de reglas y volver a iniciarla desde el objeto de formulario deseado.
-
Pulse el menú desplegable Seleccionar estado y haga clic en es igual a. Aparece el campo Escribir una cadena.
En el botón de opción Marital Status, las opciones Married y Single tienen los valores 0 y 1 asignados, respectivamente. Puede verificar los valores asignados en la pestaña Título del cuadro de diálogo del botón de opción Editar como se muestra a continuación.
-
En el campo Escribir una cadena de la regla, especifique 0.
Ha definido la condición como
When Marital Status is equal to Married. A continuación, defina la acción que se realizará si esta condición es True. -
En la instrucción Then, seleccione Show de la lista desplegable Seleccionar acción.
-
Arrastre y suelte el campo Spouse Salary de la pestaña Objetos de formulario en el campo Colocar objeto o seleccionar aquí. También puede pulsar el botón Colocar objeto o seleccionar aquí y seleccionar el campo Spouse Salary del menú emergente, que enumera todos los objetos del formulario.
La regla aparece de la siguiente manera en el editor.
Pulse Listo para guardar la regla.
-
Repita los pasos del 1 al 5 para definir otra regla que oculte el campo Spouse Salary si el estado civil es Single (soltero o soltera). La regla aparece de la siguiente manera en el editor.
note note NOTE Como alternativa, puede escribir una regla Show en el campo Spouse Salary, en lugar de dos reglas When en el campo Marital Status, para implementar el mismo comportamiento. 
-
A continuación, escriba una regla para calcular el importe de idoneidad para el préstamo, que es el 50 % del salario total, y muéstrela en el campo Loan Eligibility. Para lograr este resultado, cree reglas Establecer valor de sobre el campo Loan Eligibility.
En el modo de creación, pulse el campo Loan Eligibility y haga clic en
-
Seleccione la regla Set Value Of en la lista desplegable de reglas.
-
Pulse Seleccionar opción y seleccione Expresión matemática. Se abre un campo para escribir una expresión matemática.
-
En el campo de la expresión:
- Seleccione o arrastre y suelte desde la pestaña Objetos de formulario el campo Salary (salario) en el primer campo Colocar objeto o seleccionar aquí.
- Seleccione Más en el campo Seleccionar operador.
- Seleccione o arrastre y suelte desde la pestaña Objetos de formulario el campo Spouse Salary en el otro campo Colocar objeto o seleccionar aquí.
-
A continuación, pulse el área resaltada alrededor del campo de expresión y haga clic en Ampliar expresión.
En el campo para ampliar la expresión, seleccione divided byr en el campo Seleccionar operador y Número en el campo Seleccionar opción. A continuación, especifique 2 en el campo de número.
note note NOTE Puede crear expresiones complejas utilizando componentes, funciones, expresiones matemáticas y valores de propiedad del campo Seleccionar opción. A continuación, cree una condición que, cuando devuelva un valor True, ejecute la expresión.
-
Pulse Agregar condición para agregar una instrucción When.
En la instrucción When:
- Seleccione o arrastre y suelte desde la pestaña Objetos de formulario el campo Marital Status en el primer campo Colocar objeto o seleccionar aquí.
- Seleccione es igual a en el campo Seleccionar operador.
- Seleccione Cadena en el otro campo Colocar objeto o seleccionar aquí y especifique Married en el campo Escribir una cadena.
La regla finalmente aparece de la siguiente manera en el editor de reglas.
Pulse Listo para guardar la regla.
-
Repita los pasos del 7 al 12 para definir otra regla que calcule la idoneidad del préstamo si el estado civil es Single (soltero o soltera). La regla aparece de la siguiente manera en el editor.
Usar el editor de código using-code-editor
Los usuarios que se agregan al grupo de usuarios con capacidad para formularios pueden utilizar el editor de código. El editor de reglas genera automáticamente el código JavaScript para cualquier regla que cree con el editor visual. Puede cambiar del editor visual al editor de código para ver el código generado. Pero si modifica el código de regla en el editor de código, no podrá volver al editor visual. Si prefiere escribir reglas en el editor de código en lugar de en el editor visual, puede escribir reglas de nuevo en el editor de código. El interruptor de editores de código visual le ayudará a cambiar entre ambos modos.
El editor de código JavaScript es el lenguaje de expresión de los formularios adaptables. Todas las expresiones son expresiones JavaScript válidas y utilizan API de modelos de scripts de formularios adaptables. Estas expresiones devuelven valores de ciertos tipos. Para obtener la lista completa de clases, eventos, objetos y API públicas de los formularios adaptables, consulte Referencia de la API de la biblioteca JavaScript para formularios adaptables.
Para obtener más información sobre las directrices para escribir reglas en el editor de código, consulte Expresiones de formularios adaptables.
Mientras escribe código JavaScript en el editor de reglas, las siguientes indicaciones visuales le ayudarán con la estructura y la sintaxis:
- Elementos destacados de sintaxis
- Sangría automática
- Sugerencias para objetos de formulario, funciones y sus propiedades
- Finalización automática de nombres de componentes de formulario y funciones comunes de JavaScript
Funciones personalizadas en el editor de reglas custom-functions
Aparte de las funciones integradas como *Sum of, *que se enumeran en Salida de funciones, puede escribir funciones personalizadas que necesite con frecuencia. Asegúrese de que la función que escriba esté acompañada de una etiqueta jsdoc encima.
Incluir una etiqueta jsdoc es obligatorio:
- Si desea una configuración y descripción personalizadas…
- Porque hay varias formas de declarar una función en
JavaScript,y los comentarios permiten realizar un seguimiento de las funciones.
Para obtener más información, consulte usejsdoc.org.
Etiquetas jsdoc compatibles:
-
Privado
Sintaxis:
@privateUna función privada no se incluye como función personalizada.
-
Nombre
Sintaxis:
@name funcName <Function Name>Alternativamente
,puede utilizar:@function funcName <Function Name>o@funcfuncName <Function Name>.funcNamees el nombre de la función (no se permiten espacios).<Function Name>es el nombre para mostrar de la función. -
Miembro
Sintaxis:
@memberof namespaceAdjunta un área de nombres a la función.
-
Parámetro
Sintaxis:
@param {type} name <Parameter Description>También puede utilizar:
@argument{type} name <Parameter Description>o@arg{type}name <Parameter Description>.Muestra los parámetros utilizados por la función. Una función puede tener varias etiquetas de parámetro, una etiqueta para cada parámetro en el orden de ocurrencia.
{type}representa el tipo de parámetro. Los tipos de parámetros permitidos son:- cadena
- número
- booleano
Todos los demás tipos de parámetro se clasifican en una de las categorías anteriores. Ninguno no es compatible. Asegúrese de seleccionar uno de los tipos anteriores. Los tipos no distinguen entre mayúsculas y minúsculas. No se permiten espacios en el parámetro
name.<Parameter Descrption> -
Tipo de devolución
Sintaxis:
@return {type}Como alternativa, puede usar
@returns {type}.Agrega información sobre la función, como su objetivo.
{type} representa el tipo de valor devuelto de la función. Los tipos de valor devuelto permitidos son:
- cadena
- número
- booleano
- fecha
- matriz
Todos los demás tipos de valor devuelto se clasifican en una de las categorías anteriores. Ninguno no es compatible. Asegúrese de seleccionar uno de los tipos anteriores. Los tipos de devolución no distinguen entre mayúsculas y minúsculas.
Agregar una función personalizada
Por ejemplo, desea agregar una función personalizada que calcule el área de un cuadrado. La longitud lateral es la entrada del usuario a la función personalizada, que se acepta mediante un cuadro numérico en el formulario. El resultado calculado se muestra en otro cuadro numérico del formulario. Para agregar una función personalizada, primero debe crear una biblioteca de cliente y luego agregarla al repositorio CRX.
Realice los siguientes pasos para crear una biblioteca de cliente y agregarla en el repositorio CRX.
-
Crear una biblioteca de cliente. Para obtener más información, consulte Uso de bibliotecas del lado del cliente.
-
En CRXDE, agregue una propiedad
categoriescon valor de tipo de cadena comocustomfunctiona la carpetaclientlib.note note NOTE customfunctiones una categoría de ejemplo. Puede elegir cualquier nombre para la categoría que cree en la carpetaclientlib.
Después de agregar la biblioteca de cliente en el repositorio CRX, utilícela en el formulario adaptable. Permite utilizar la función personalizada como regla en el formulario. Realice los siguientes pasos para agregar la biblioteca de cliente en el formulario adaptable.
-
Abra el formulario en modo de edición.
Para abrir un formulario en modo de edición, seleccione un formulario y pulse Abrir.
-
En el modo de edición, seleccione un componente y, a continuación, pulse
-
En la barra lateral, bajo Nombre de la biblioteca de cliente, agregue la biblioteca de cliente. (
customfunctionen el ejemplo)
-
Seleccione el cuadro numérico de entrada y pulse
-
Pulse Crear regla. Con las opciones que se muestran a continuación, cree una regla para guardar el valor al cuadrado de la entrada en el campo Salida del formulario.
Tipos admitidos para la declaración de funciones function-declaration-supported-types
Instrucción de función
function area(len) {
return len*len;
}
Esta función se incluye sin comentarios jsdoc.
Expresión de función
var area;
//Some codes later
/** */
area = function(len) {
return len*len;
};
Instrucción y expresión de función
var b={};
/** */
b.area = function(len) {
return len*len;
}
Declaración de función como variable
/** */
var x1,
area = function(len) {
return len*len;
},
x2 =5, x3 =true;
Limitación: la función personalizada selecciona solo la primera declaración de función de la lista de variables, si están juntas. Puede utilizar la expresión de función para cada función declarada.
Declaración de función como objeto
var c = {
b : {
/** */
area : function(len) {
return len*len;
}
}
};
jsdoc para cada función personalizada. Aunque jsdoc se recomienda comentar, incluya uno vacío jsdoc para marcar la función como función personalizada. Permite la gestión predeterminada de la función personalizada.Administrar reglas manage-rules
Cualquier regla existente en un objeto de formulario aparece enumerada al pulsar el objeto y hacer clic en
Puede realizar las siguientes acciones en reglas:
-
Ampliar/contraer: la columna Contenido de la lista de reglas muestra el contenido de las reglas. Si todo el contenido de la regla no está visible en la vista predeterminada, pulse
-
Reordenar: cualquier regla nueva que cree se apilará en la parte inferior de la lista de reglas. Las reglas se ejecutan de arriba a abajo. La regla de la parte superior se ejecuta primero, seguida de otras reglas del mismo tipo. Por ejemplo, si tiene las reglas When, Show, Enable y When en las posiciones primera, segunda, tercera y cuarta desde la parte superior, respectivamente, la regla When en la parte superior se ejecuta primero, seguida de la regla When en la cuarta posición. A continuación, se ejecutan las reglas Mostrar y Habilitar.
Puede cambiar el orden de una regla al pulsar
-
Editar: para editar una regla, active la casilla de verificación situada junto al título de la misma. Aparecerán las opciones para editar y eliminar la regla. Pulse Editar para abrir la regla seleccionada en el editor de reglas en modo visual o editor de código, según el modo utilizado para crearla.
-
Eliminar: para eliminar una regla, selecciónela y pulse Eliminar.
-
Habilitar/Deshabilitar: es posible que tenga que suspender temporalmente el uso de una regla. Puede seleccionar una o varias reglas y pulsar Deshabilitar en la barra de herramientas Acciones para deshabilitarlas. Si una regla está deshabilitada, no se ejecuta en tiempo de ejecución. Para habilitar una regla que esté deshabilitada, puede seleccionarla y pulsar Habilitar en la barra de herramientas de acciones. La columna de estado de la regla muestra si la regla está habilitada o deshabilitada.
Copiar y pegar reglas copy-paste-rules
Puede copiar y pegar una regla de un campo a otros campos similares para ahorrar tiempo.
Para copiar y pegar reglas, haga lo siguiente:
-
Pulse el objeto de formulario del que desea copiar una regla y, en la barra de herramientas de componentes, pulse
Para obtener información sobre la administración de reglas existentes, consulte Administrar reglas.
-
Seleccione la casilla de verificación situada junto al título de la regla. Aparecerán opciones adicionales para administrar la regla. Pulse Copiar.
-
Seleccione otro objeto de formulario al que desee pegar la regla y pulse Pegar. Además, puede editar la regla para realizar cambios en ella.
note note NOTE Puede pegar una regla en otro objeto de formulario solo si dicho objeto de formulario admite el evento de regla copiada. Por ejemplo, un botón admite el evento de clic. Puede pegar una regla con un evento de clic en un botón, pero no en una casilla de verificación. -
Pulse Listo para guardar la regla.
Expresiones anidadas nestedexpressions
El editor de reglas permite utilizar varios operadores AND y OR para crear reglas anidadas. Puede combinar varios operadores AND y OR en las reglas.
A continuación verá un ejemplo de una regla anidada que muestra un mensaje al usuario sobre la elegibilidad para la custodia de un niño cuando se cumplen las condiciones requeridas.
También puede arrastrar y soltar condiciones dentro de una regla para editarla. Pulse y pase el ratón por encima del identificador (
Condiciones de expresión de fecha dateexpression
El editor de reglas permite usar comparaciones de fechas para crear condiciones.
A continuación verá una condición de ejemplo que muestra un objeto de texto estático si la hipoteca de la casa ya está cogida, lo que el usuario indica rellenando el campo de la fecha.
Cuando la fecha de la hipoteca de la propiedad tal como la ha rellenado el usuario es anterior, el formulario adaptable muestra una nota sobre el cálculo de ingresos. La siguiente regla compara la fecha rellenada por el usuario con la fecha actual y si la fecha rellenada por el usuario es anterior a la fecha actual, el formulario muestra el mensaje de texto, denominada Income (ingresos).
Cuando la fecha de rellenado es anterior a la fecha actual, el formulario muestra el mensaje de texto (Income) de la siguiente manera:
Condiciones de comparación de números number-comparison-conditions
El editor de reglas permite crear condiciones que comparen dos números.
A continuación verá una condición de ejemplo que muestra un objeto de texto estático si el número de meses que un solicitante permanece en la dirección actual es inferior a 36.
Cuando el usuario indica que lleva menos de 36 meses en su domicilio actual, el formulario muestra una notificación de que puede solicitarse una prueba de residencia adicional.
Impacto del editor de reglas en scripts existentes impact-of-rule-editor-on-existing-scripts
En las versiones de AEM Forms anteriores a AEM 6.1 Forms feature pack 1, los autores y desarrolladores de formularios solían escribir expresiones en la pestaña Scripts del cuadro de diálogo Editar componente para agregar el comportamiento dinámico a los formularios adaptables. La pestaña Scripts ahora se reemplaza con el editor de reglas.
Cualquier script o expresión que deba haber escrito en la pestaña Scripts estará disponible en el editor de reglas. Aunque no se pueden ver ni editar en el editor visual, si forma parte del grupo de usuarios avanzados de formularios, puede editar scripts en el editor de código.
Reglas de ejemplo example
Invocar servicio del modelo de datos de formulario invoke
Piense en un servicio web GetInterestRates que toma el importe del préstamo, el ejercicio y la puntuación crediticia del solicitante como entrada y devuelve un plan de préstamo que incluye el importe del EMI y el tipo de interés. Puede crear un modelo de datos de formulario con el servicio web como fuente de datos. Se agregan objetos del modelo de datos y un servicio get al modelo de formulario. El servicio aparece en la pestaña Servicios del modelo de datos de formulario. A continuación, cree un formulario adaptable que incluya campos de los objetos del modelo de datos para capturar las entradas del usuario para el importe del préstamo, el ejercicio y la puntuación crediticia. Agregue un botón que active el servicio web para obtener detalles del plan. La salida se rellena en los campos adecuados.
La siguiente regla muestra cómo configurar la acción Invocar servicio para que se realice el escenario de ejemplo.
Activación de varias acciones mediante la regla When triggering-multiple-actions-using-the-when-rule
En un formulario de solicitud de préstamo, se desea capturar si el solicitante del préstamo es o no un cliente existente. En función de la información que proporcione el usuario, el campo ID de cliente debería mostrarse u ocultarse. Además, desea centrarse en el campo ID del cliente si el usuario es un cliente existente. El formulario de solicitud de préstamo tiene los siguientes componentes:
-
Un botón de opción, Are you an existing Geometrixx customer? (¿Es cliente de Geometrixx?), que proporciona las opciones Yes (sí) y No. El valor de Yes es 0 y No es 1.
-
Un campo de texto, Geometrixx customer ID (ID de cliente de Geometrixx), para especificar el ID de cliente.
Cuando escriba una regla When en el botón de radio para implementar este comportamiento, la regla aparecerá de la siguiente manera en el editor de reglas visuales.
En la regla de ejemplo, la instrucción de la sección When es la condición que, cuando devuelve el valor True, ejecuta las acciones especificadas en la sección Then.
La regla aparece de la siguiente manera en el editor de código.
Usar una salida de función en una regla using-a-function-output-in-a-rule
En un formulario de pedido de compra, tiene la siguiente tabla, en la que los usuarios rellenan sus pedidos. En esta tabla:
- La primera fila es repetible, por lo que los usuarios pueden solicitar varios productos y especificar cantidades diferentes. Su nombre de elemento es
Row1. - El título de la celda de la columna Product Quantity (cantidad de producto) de la fila repetible es Quantity (cantidad). El nombre de elemento de esta celda es
productquantity. - La segunda fila de la tabla es no repetible y el título de la celda de la columna Product Quantity de esta fila es Total Quantity (cantidad total).
A. Row1 B. Quantity C. Total Quantity
Ahora, desea agregar cantidades especificadas en la columna Product Quantity para todos los productos y mostrar la suma en la celda Total Quantity. Puede conseguirlo si escribe una regla Establecer valor de en la celda Cantidad total como se muestra a continuación.
Validación de un valor de campo mediante una expresión validating-a-field-value-using-expression
En el formulario de orden de compra que se explica en el ejemplo anterior, se desea restringir el pedido de más de una cantidad de cualquier producto cuyo precio sea superior a 10 000. Para hacerlo, puede escribir una regla de validación como se muestra a continuación.
