Función

La función definible por el programador. Las instrucciones se ejecutarán de forma secuencial y harán uso de comandos de instrucción de proceso que pueden acceder a otros objetos de los proyectos incluyendo otros procesos.

Es similar al objeto proceso, pero con unas características especiales:

Solamente pueden ser ejecutados en primer plano.

Puede recibir parámetros.

No tiene origen, es decir, el origen de la función siempre es “Ninguno”. Para crear un objeto de este tipo seleccionar la opción nuevo objeto/función del menú objetos de Velneo vDevelop o a través de la galería de objetos.

Las propiedades de este objeto son:

Identificador

Etiqueta alfanumérica que identifica de forma unívoca al objeto dentro del proyecto. Este identificador será el que usemos para referenciarlo en otras propiedades de otros objetos.

El identificador constará de mayúsculas y números exclusivamente. Al identificar de forma unívoca un objeto no puede haber duplicidad.

Nombre

Etiqueta alfanumérica que servirá como descriptor del objeto. Se usará para presentar información del objeto en otros objetos y en los inspectores.

Podemos definir una etiqueta por cada idioma presente en el proyecto.

Estilos

Podemos definir los estilos:

Privado

Limita el acceso del usuario final al objeto desde puntos donde no se haya programado el acceso al mismo.

Ejecutable en remoto

Si está activado la función podrá ser ejecutada de forma remota desde otros proyectos de Velneo.

Comentarios

Esta propiedad nos permite documentar el uso del objeto.

Parámetro 1 a n

Si la función va a recibir parámetros tendremos que crear en la misma tantas variables locales como parámetros necesite.

Una vez establecidas las propiedades podremos pasar a crear las instrucciones.

Podremos hacer llamadas a funciones declaradas en el proyecto.

En ambos casos, podremos hacer la llamada desde cualquier objeto o subobjeto donde pueda declararse una fórmula.

Para conocer cómo hacer llamadas a funciones locales consultar el punto Funciones de proceso.

Para hacer llamadas a funciones remotas tendremos que escribirlo directamente en la fórmula, siguiendo la sintaxis siguiente:

rfc:idFuncion(dominioIP, idInstancia, usuario, contraseña, parámetros)

Donde:

rfc: acrónimo de Remote Function Call. Es un dato fijo. Es un prefijo que indica al calculador de fórmulas que se trata de una llamada a una función remota.

idFuncion: identificador de la función a ejecutar.

dominioIP: dominio o IP de la máquina donde está instalado el Velneo vServer y el número de puerto.

Para conectarnos a un vServer con servicio VATPS vía función remota y que produce excepciones (por ejemplo cuando nos conectamos a un vServer con un certificado autogenerado), debemos añadir la excepción en un fichero.

En Windows hay que añadirlo a la rama de registro:

HKEY_CURRENT_USER\Software\Velneo\SslExceptions

Añadiendo como claves alfabéticas (REG_SZ), las VRL’s correspondientes, con la clave vacía, por ejemplo:

subdominio.dominio.com:9999

En Linux la ruta del fichero es (en el usuario que lanza el componente):

$HOME/.config/Velneo/SslExceptions.conf

Por ejemplo, si queremos ignorar las excepciones cuando nos conectamos a localhost:6900, el fichero quedaría de la siguiente manera:

[General] localhost:6900=""

En macOS, el fichero estará en ~/Library/Preferences y se llamará com.velneo.SslExceptions.plist.

idInstancia: identificador de la instancia haciendo doble clic sobre la definición de instancia. Debe ser el identificador de la instancia del proyecto en el que se encuentre declarada la función. Si, por ejemplo, instanciamos un proyecto de aplicación que hereda uno de datos en el que tenemos declarada una función, al definir la llamada a la misma el identificador será el de la instancia del proyecto de datos y no la del de aplicación.

usuario: nombre de un usuario que tenga permisos de acceso a la instancia donde está definida la función. El usuario debe tener permisos de acceso explícitos al proyecto que contiene la función. No es suficiente con que tenga permisos de ejecución de un proyecto que lo herede.

contraseña: del usuario anterior. Si ese usuario no tiene contraseña este parámetro será resuelto "".

parámetros: si la función tiene declarado más de un parámetro, éstos irán separados por comas.

rfc:GET_USER_SESION_NUMBER("vatp://localhost:85", "GESTION", "velneo", "", "[e-mail]", "ib3zax1")

Existe una librería de funciones dll para Windows, que permite hacer llamadas a funciones remotas declaradas en proyectos de Velneo. Consultar el punto librería para la ejecución de funciones remotas para ampliar información al respecto.

Notas

El límite máximo de parámetros soportados por una función es de 10.

Si la función genera transacción (escribe en la bb.dd.) siempre generará una transacción independiente. Esto quiere decir que, si ejecutamos un proceso que transacciona y desde él llamamos a una función que también transacciona, no quedará todo englobado en una única transacción, sino que se generarán dos transacciones independientes: la del proceso y la de la función.

Cuando una función es ejecutada de forma remota, si una instrucción de la misma dura más de 10 minutos, hará que la función no pueda reportar al llamador que continúa ejecutándose, por lo que de desenganchará y se deshará.

No podemos usar funciones remotas transaccionales en contenidos iniciales de campos de tipo fórmula.

Librería para la ejecución de funciones remotas

El aplicativo que nos permite disponer de esta funcionalidad es la librería vRemoteFunctionV7.dll, la cual es distribuida con el componente Velneo vClient.

Esta librería es funcional solamente en sistemas operativos Windows.

Esta librería debe ser distribuida junto todas las librerías que encontremos en la carpeta de instalación de Velneo vClient. Todas ellas las encontraremos en el directorio de instalación de Velneo vClient. Además, deben cumplirse los requerimientos indicados en la página de requerimientos de la versión.

Funciones de la librería vRemoteFunctionV7.dll

El nombre de la librería es vRemoteFunctionV7.dll.

Dicha librería contiene una función. La configuración debe ser:

Los parámetros que afectan a la función son los siguientes:

1.- El retorno será "char *", por lo que la función definida en Velneo siempre devolverá una cadena de texto. Caso de no ser así, y si por ejemplo devolviese un número, dicho número sería convertido automáticamente a cadena de texto.

2.- La convención será "_cdecl" por diseño

3.- El nombre de la función debe ser "RemoteFunc"

4.- El número de parámetros definidos para la función serán 13, todos ellos del tipo "char *". Los parámetros serían:

char* szServer: contiene el Velneo vServer al que deseamos conectarnos. La cadena debe comenzar siempre por "vatp://" seguido del nombre o dirección IP del servidor y su puerto. Por ejemplo: "vatp://80.80.80.80:691" o "vatp://servidor.com"

char* szInstancia: contiene el identificador que definimos para la instancia que queremos ejecutar. Para las capturas de imagen anteriores, el identificador sería "FUNCAPP".

char* szIdFuncion: contiene el identificador de la función que queremos ejecutar dentro de la instancia definida en el punto anterior. Para las capturas de imagen anteriores, el identificador sería "FUNCION"

char* szUsuario: el nombre de usuario con el que conectarnos al Velneo vServer.

char* szPassword: la clave del usuario anterior.

char* szParam1, char* szParam2, …. , char* szParam8: son los parámetros que enviamos a la función remota para su ejecución. El número máximo de parámetros como vemos es 8, no es posible introducir más. En caso de que nuestra función necesite menos de 8 parámetros, para evitar problemas deberemos definir igualmente los 8 aunque posteriormente no se usen.

Una función remota no podrá durar más de 30 minutos.