Última modificación el 18/04/2024
Una Función de Usuario (XDU) corresponde a una determinada acción – ejecutada por el sistema – que implementa una determinada regla de negocio.
Esta funcionalidad permite garantizar y dar respuesta a todas las reglas de negocio específicas de cada empresa, por ejemplo:
- Envío de mensajes de email personalizadas para cada empresa;
- Ejecución de stored procedures o queries sobre la base de datos de la empresa;
- Ejecución de formularios del usuario o macros de extensibilidad;
- Ejecución y/o envío por email de informes de usuario;
- Ejecutar otras utilidades externas o documentos.
El concepto de Función de Usuario sirve como base a la implementación de Menús y Procesos de Usuario.
Crear tipos de funciones del usuario
La Plataforma ofrece los siguientes tipos de funciones del usuario:
- Email - envío de mensajes por email;
- Aplicación Externa - ejecución de aplicaciones o documentos externos;
- Macro Extensibilidad - ejecución de macros definidas en proyectos PEX asociados a la empresa;
- Formulario del Usuario - ejecución de Formularios Personalizados;
- Informe de Usuario - Impresión de informes de usuario con posibilidad de exportación y/o envío por email.
- Stored Procedure - ejecución de stored procedures existentes en la base de datos de la empresa;
- User Defined Function - ejecución de user defined functions existentes en la base de datos de la empresa (solamente disponible en SQL Server 2000 o superior);
- Query SQL - ejecución de queries SQL ad-hoc.
Dependiendo del tipo, cada función de usuario permite la definición de:
- Parámetros - permiten hacerla dinámica y adaptable a diversas situaciones idénticas;
- Resultados - en forma de valores discretos (numéricos o alfanuméricos), listas de valores o listas de registros.
Para crear el tipo de funciones de usuario, deben seguirse los siguientes pasos:
Crear una función de usuario Query SQL
- Acceder a Extensibilidad | Funciones en el área de configuraciones del ERP (backstage);
- Hacer clic en Nueva;
- En la pestaña General, definir el nombre de la función;
- Definir el tipo de función, seleccionando la función Query SQL;
- Indicar una descripción de la función (opcional);
- En la pestaña Definición ,indicar la Query SQL a utilizar en la ejecución;
- Por fin, Confirmar.
Al definir las funciones del usuario tipo Query SQL, podrás utilizar parámetros en la especificación de la Query. De este modo, se potencializa la adaptabilidad a escenarios que utilicen componentes de naturaleza variable.
También deberás definir el resultado de la función, una vez que la manera como la datatable resultante de la Query SQL será interpretada por el motor de ejecución depende del tipo de resultado seleccionado:
- Ningún: la Query SQL no devuelve ningún resultado;
- Texto, Entero, Numérico, Fecha, Booleano: la Query SQL devuelve una datatablecon solo un registro y una sola columna, que se debe interpretar según el tipo de datos seleccionado;
- Lista de Registros: la Query SQL devuelve una datatable con diversos registros y diversas columnas.
Crear una función de usuario Email
- Acceder a la opción Extensibilidad | Funciones en el área de configuraciones del ERP (backstage);
- Hacer clic en Nueva;
- En la pestaña General, definir el nombre de la función;
- Definir el tipo de función, hacer clic en la opción Email;
- Indicar una descripción de la función (opcional);
- En la pestaña Definición, definir el destinatario, seleccionando la opción Para e indicar la dirección de email del destinatario;
- Definir el asunto, indicando el tópico del asunto del mensaje;
- Definir el mensaje e introducir el contenido del mensaje;
- Indicar los adjuntos, seleccionando los archivos a adjuntar al mensaje (opcional);
- Por fin, Confirmar.
Al definir las funciones de usuario del tipo Email, se sugiere el uso de parámetros en la configuración del mensaje de email. Así, puede reforzarse el envío del mensaje, independientemente de los destinatarios y de otras particularidades meramente adaptables en el contexto del mensaje.
Nota: Las funciones del tipo Email no permiten la definición de los respectivos resultados.
Crear una función de usuario Formulario de Usuario
- Acceder a Extensibilidad | Funciones en el área de configuraciones del ERP (backstage);
- Hacer clic en Nueva;
- En la pestaña General, definir el nombre de la función;
- Definir el tipo de función, hacer clic en la opción Formulario de Usuario;
- Indicar una descripción de la función (opcional);
- En la pestaña Definición, seleccionar el formulario de usuario a utilizar en la ejecución;
Nota: Los formularios personalizados deben ser previamente implementados en PEX (Extensibility) y las extensiones deben ser asociadas a la empresa;
- Por fin, Confirmar.
Las funciones do tipo Formulario de Usuario no permiten la definición de parámetros ni de resultados.
Crear una función de usuario Aplicación Externa
- Acceder a Extensibilidad | Funciones en el área de configuraciones del ERP (backstage);
- Hacer clic en Nueva;
- En la pestaña General, definir el nombre de la función;
- Definir el tipo de función, hacer clic en la opción Aplicación Externa;
- Indicar una descripción de la función (opcional);
- En la pestaña Definición, definir el comando, identificando la ubicación de la aplicación/documento externo;
- Definir los parámetros, enumerando los parámetros adicionales a aplicar en la ejecución (opcional);
- Definir el directorio inicial, identificando la respectiva ubicación física (opcional);
- Definir el tipo de ventana a utilizar en la ejecución;
- Por fin, Confirmar.
Al definir las funciones de usuario del tipo Aplicación Externa, se sugiere el uso de parámetros en la configuración del mensaje de email. De este modo, la ejecución de una determinada aplicación o documento se potencializa con base en criterios dinámicos.
La ejecución de aplicaciones externas permite definir que tratamiento aplicar al resultado, permitiendo especificar dos tipos de resultados:
- Ningún: el motor de ejecución no gestionará el resultado de la ejecución;
- Entero: la aplicación ejecutada producirá un exit code que el motor gestionará al final de la ejecución.
Crear una función de usuario Informe de Usuario
- Acceder a Herramientas | Funciones del Usuario;
- Hacer clic en Nueva;
- En la pestaña General, definir el nombre de la función;
- Definir el tipo de función, hacer clic en la opción Informe de Usuario;
- Indicar una descripción de la función (opcional);
- En la pestaña Definición, definir el informe a ser ejecutado;
- Seleccionar el formato del informe;
- Definir el envío por email, si se desea enviar el resultado de la ejecución del informe por email (opcional);
- Definir la ubicación física, si se desea guardar el resultado de la ejecución del informe en archivo (opcional);
- Por fin, Confirmar.
Al definir las funciones del tipo Informes de Usuario se sugiere la utilización de parámetros en la configuración del informe, de forma a facilitar la adaptación al proceso de exportación. Si el informe de usuario tiene parámetros definidos en el Crystal Reports, estos serán automáticamente detectados y añadidos a la lista de parámetros de la función.
El resultado de este tipo de función es fijo y corresponde siempre a la ubicación física del informe de usuario después de exportado en el formato seleccionado.
No será ofrecido el resultado de la ejecución si la configuración de la función de usuario no incluye el envío del informe por email y/o la exportación para un directorio en el disco.
Crear una función macro de extensibilidad
Las macros de extensibilidad deben ser creadas en extensiones PEX y cargadas en la configuración de extensibilidad antes de que sea posible crear funciones con base en las macros de estas extensiones.
Podrás consultar las extensiones en Extensibilidad | Extensiones en el área de configuraciones del ERP.
Para crear una función macro de extensibilidad, deben seguirse los siguientes pasos:
- Acceder a Extensibilidad | Funciones en el área de configuraciones del ERP (backstage);
- Hacer clic en Nueva;
- Seleccionar la pestaña General;
- Definir el nombre de la función;
- Seleccionar la opción Macro Extensibilidad en el tipo de función;
- Indicar una descripción de la función (opcional);
- Seleccionar la pestaña Definición;
- Definir el proyecto en el cual está definida la macro;
- Seleccionar la macro definida en el proyecto Extensibilidad;
- Por fin, clicar em Confirmar.
Nota: Los parámetros de la función de usuario serán los parámetros que corresponden a la función que implementa la macro. El resultado de la función de usuario también será determinado por la definición de la macro, como el tipo de retorno de la función que implementa la macro.
Crear una función de usuario Stored Procedure
- Acceder a Extensibilidad | Funciones en el área de configuraciones del ERP (backstage);
- Hacer clic en Nueva;
- En la pestaña General, definir el nombre de la función;
- Definir el tipo de función, seleccionando la función Stored Procedure;
- Indicar una descripción de la función (opcional);
- En la pestaña Definición, seleccionar la Stored Procedure a utilizar en la ejecución;
- Por fin, Confirmar.
Los parámetros de la función de usuario serán determinados por la propia definición de la Stored Procedure en la base de datos.
Deberá definirse el resultado de la función. A pesar de que normalmente una stored procedure no produzca resultados, el SQL Server permite que la respectiva definición incluya queries en la base de datos.
Si definidas correctamente, estas queries permiten simular un resultado en forma de un recordset. La forma como el motor de ejecución interpreta el recordset depende del tipo de resultado seleccionado:
- Ningún: la Stored Procedure no devuelve ningún resultado;
- Texto, Entero, Numérico, Fecha, Booleano: la Stored Procedure devuelve un recordset con solo un registro y una sola columna, que se debe interpretar según el tipo de datos seleccionado;
- Lista de registros: la Stored Procedure devuelve un recordset con diversos registros y diversas columnas.
Crear una función de usuario User Defined Function
- Acceder a Extensibilidad | Funciones en el área de configuraciones del ERP (backstage);
- Hacer clic en Nueva;
- En la pestaña General, definir el nombre de la función;
- Definir el tipo de función, seleccionando la función User Defined Function;
- Indicar una descripción de la función (opcional);
- En la pestaña Definición, seleccionar la User Defined Function a utilizar en la ejecución;
- Por fin, Confirmar.
Nota: Los parámetros y resultados de la función de usuario serán determinados por la propia definición User Defined Function en la base de datos.
Configurar función de usuario
Para configurar una función de usuario, deben ejecutarse los siguientes pasos:
- Acceder a la opción Extensibilidad | Funciones en el área de configuraciones del ERP (backstage);
- Seleccionar la función de usuario que deseas configurar;
- Hacer clic en Editar o hacer un doble clic en la función seleccionada;
- En la ventana función de usuario proceder a la configuración de la función de usuario (descripción, definición y configuración de los parámetros);
- Por fin, Confirmar.
La definición de las propiedades y posterior parametrización dependen del tipo de función especificada.
Eliminar funciones del usuario
Para remover una función de usuario, deben ejecutarse los siguientes pasos:
- Acceder a Extensibilidad | Funciones en el área de configuraciones (backstage) del ERP;
- Seleccionar la función de usuario que deseas configurar;
- Hacer clic en Anular.
Se presentará un mensaje de confirmación para remover la función. En el caso de que la respuesta sea afirmativa, la función del usuario será removida del sistema.
Ejecutar una función del usuario
Se puede realizar una función de usuario:
- A partir de la ventana de Configuración de Funciones;
- A partir del menú a través de un Acceso directo y/o de un Menú del Usuario;
- Como consecuencia de la ejecución de un Proceso del Usuario.
La ejecución de la función de usuario será realizada inmediatamente. Sin embargo, se pedirá al usuario (excepto en los procesos de usuario) que solicite los valores de todos los parámetros (no completamente definidos en la configuración). Posteriormente, se presentarán los resultados, caso existan.
Para ejecutar una función de usuario, deben ejecutarse los siguientes pasos:
- Acceder a Extensibilidad | Funciones, en el área de configuraciones (backstage) del ERP;
- Seleccionar la función de usuario que deseas ejecutar;
- Hacer clic en Ejecutar.
Nota: El ejemplo se refiere a la ejecución de una función a partir de la ventana de configuración de funciones.
Según el tipo de configuración aplicada en la definición de la función, se podrá eventualmente solicitar la introducción de los parámetros.
El envío de mensajes es asíncrono, es decir, siempre que se ejecuta una función de usuario de tipo Email, el mensaje correspondiente se colocará en una cola de espera para enviar.
El envío se realizará a través de la aplicación Windows Scheduler Services, según el calendario de ejecución definido.
Guarda o comparte este artículo