Funciones API
Conjunto de Funciones de fórmula que hacen de uso del API de Velneo para retornar valores propios de los proyectos y objetos en tiempo de ejecución.
getAppUserParam()
Devuelve una cadena con el parámetro recibido por Velneo vClient.
getAppUserParam()
Parámetros
No tiene.
Ejemplo
Ejecución de vClient pasando como parámetro un JSON:
vclient.exe "vatps://velneo:1234@localhost/MIAPP" /userParam={'key':'value','key2':'value2'}
getAppUserParam() = {'key':'value','key2':'value2'}
getCurrentInstanceCode
Devuelve el código de la instancia en curso. Se refiere al código que ésta tiene en Velneo vAdmin. Podemos verlo en el título de la ventana de las propiedades de la misma en Velneo vAdmin:
getCurrentInstanceCode()
Parámetros
No tiene.
Ejemplo
getCurrentInstanceCode() = 12
getCurrentInstanceConnectionToken
Devuelve el testigo del enganche de la instancia en curso, es decir, en enganche que se ha generado en Velneo vAdmin.
getCurrentInstanceConnectionToken()
Parámetros
No tiene.
Ejemplo
getCurrentInstanceConnectionToken() = 2-10-800-0529
getCurrentInstanceId()
Devuelve el identificador de la instancia en curso. Se refiere al identificador que ésta tiene en Velneo vAdmin. Podemos verlo en el título de la ventana de las propiedades de la misma en Velneo vAdmin:
getCurrentInstanceId()
Parámetros
No tiene.
Ejemplo
getCurrentInstanceId() = VERP
getCurrentInstanceName
Devuelve el nombre de la instancia en curso, es decir, el nombre que tiene la isntancia en Velneo vAdmin. Podemos verlo en las propiedades de la misma en Velneo vAdmin:
getCurrentInstanceName()
Parámetros
No tiene.
Ejemplo
getCurrentInstanceName() = vERP
getCurrentObjectId
Devuelve el identificador del objeto en curso. Devuelve una cadena con el identificador del objeto en curso.
getCurrentObjectId()
Parámetros
No tiene.
Ejemplo
Para obtener el identificador del formulario en curso desde un manejador de evento del mismo:
getCurrentObjectId() = ENT_M
getCurrentObjectName
Devuelve el nombre del objeto en curso. Devuelve una cadena con el nombre del objeto en curso.
getCurrentObjectName()
Parámetros
No tiene.
Ejemplo
Para obtener el nombre del formulario en curso desde un manejador de evento del mismo:
getCurrentObjectNAME() = Contacto
getCurrentObjectTableId
Devuelve una cadena con el identificador de la tabla asociada al objeto en curso. Si el objeto no tiene tabla asociada, no devolverá nada.
getCurrentObjectTableId()
Parámetros
No tiene.
Ejemplo
Para obtener el identificador de la tabla del formulario en curso desde un manejador de evento del mismo:
getCurrentObjectTableId() = ENT_M
getCurrentObjectTableName
Devuelve una cadena con el nombre de la tabla asociada al objeto en curso. Si el objeto no tiene tabla asociada, no devolverá nada.
getCurrentObjectTableName()
Parámetros
No tiene.
Ejemplo
Para obtener el nombre de la tabla del formulario en curso desde un manejador de evento del mismo:
getCurrentObjectTableName() = Contactos
getCurrentObjectTableSingleName
Devuelve una cadena con el nombre singular de la tabla asociada al objeto en curso. Si el objeto no tiene tabla asociada, no devolverá nada.
getCurrentObjectTableSingleName()
Parámetros
No tiene.
Ejemplo
Para obtener el nombre de la tabla del formulario en curso desde un manejador de evento del mismo:
getCurrentObjectTableSingleName() = Contacto
getCurrentObjectType
Devuelve una cadena con el nombre del tipo de objeto en curso.
getCurrentObjectType()
Parámetros
No tiene.
Ejemplo
Para obtener el tipo de objeto del formulario en curso desde un manejador de evento del mismo:
getCurrentObjectType() = Formulario
getExecutionComponent
Devuelve una cadena con el nombre del componente que está ejecutando la fórmula donde se use la función.
cliente: cuando, se usa, por ejemplo, en un proceso disparado desde Velneo vClient en primer o segundo plano.
gestorbbdd: cuando se usa en un proceso lanzado en primer plano en Velneo vDataClient.
servidor: cuando la función se usa en un proceso ejecutado en el servidor.
apache: cuando la función se usa en un proceso ejecutado en Velneo vModApache.
agente: cuando la función se usa en un proceso ejecutado en 5º plano.
editor: cuando la función se ejecuta en Velneo vDevelop.
administrador: cuando la función se ejecuta en Velneo vAdmin.
getExecutionComponent()
Parámetros
No tiene.
Ejemplo
getExecutionComponent() = cliente
getExecutionLevel
Devuelve el plano en el que se está ejecutando un proceso. Devuelve un número correspondiente al plano de ejecución en el que se esté ejecutando el proceso donde se use. Los planos posibles son: 1, 2, 3 y 4. 5º plano no es un plano real.
getExecutionLevel()
Parámetros
No tiene.
Ejemplo
getExecutionLevel() = 3
getMainInstanceCode
Devuelve el código de la instancia principal, es decir, el código que ésta tiene en Velneo vAdmin. El valor que devuelva cuando hay herencia variará en función del proyecto en el que usemos la función y el plano de ejecución. Para entenderlo mejor partiremos de una solución con un proyecto de datos que hereda uno de aplicación. En el proyecto de datos creamos un proceso que usa esta función:
Ejecutado en primer plano desde Velneo vCleint, devolverá el código de la instancia del proyecto de aplicación.
Ejecutado en tercer plano desde Velneo vCleint, devolverá el código de la instancia del proyecto de aplicación.
Ejecutado en primer plano desde Velneo vDataClient, devolverá el código de la instancia del proyecto de datos.
Ejecutado en tercer plano desde Velneo vDataCleint, devolverá el código de la instancia del proyecto de datos.
getMainInstanceCode()
Parámetros
No tiene.
Ejemplo
getMainInstanceCode() = 12
getMainInstanceConnectionToken
Devuelve el testigo del enganche de la instancia principal. es decir, , es decir, en enganche que se ha generado en Velneo vAdmin. El valor que devuelva cuando hay herencia variará en función del proyecto en el que usemos la función y el plano de ejecución. Para entenderlo mejor partiremos de una solución con un proyecto de datos que hereda uno de aplicación. En el proyecto de datos creamos un proceso que usa esta función:
Ejecutado en primer plano desde Velneo vCleint, devolverá el testigo del enganche del proyecto de aplicación.
Ejecutado en tercer plano desde Velneo vCleint, devolverá el el testigo del enganche del proyecto de aplicación.
Ejecutado en primer plano desde Velneo vDataClient, devolverá el el testigo del enganche del proyecto de datos.
Ejecutado en tercer plano desde Velneo vDataCleint, devolverá el el testigo del enganche del proyecto de datos.
getMainInstanceConnectionToken()
Parámetros
No tiene.
Ejemplo
getMainInstanceConnectionToken() = 2-10-800-0529
getMainInstanceId
Devuelve el identificador de la instancia principal, es decir, el identificador que ésta tiene en Velneo vAdmin. El valor que devuelva cuando hay herencia variará en función del proyecto en el que usemos la función y el plano de ejecución. Para entenderlo mejor partiremos de una solución con un proyecto de datos que hereda uno de aplicación. En el proyecto de datos creamos un proceso que usa esta función:
Ejecutado en primer plano desde Velneo vCleint, devolverá el identificador de la instancia del proyecto de aplicación.
Ejecutado en tercer plano desde Velneo vCleint, devolverá el identificador de la instancia del proyecto de aplicación.
Ejecutado en primer plano desde Velneo vDataClient, devolverá el identificador de la instancia del proyecto de datos.
Ejecutado en tercer plano desde Velneo vDataCleint, devolverá el identificador de la instancia del proyecto de datos.
getMainInstanceId()
Parámetros
No tiene.
Ejemplo
getMainInstanceId() = VERP
getMainInstanceName
Devuelve el nombre de la instancia principal, es decir, el nombre que ésta tiene en Velneo vAdmin. El valor que devuelva cuando hay herencia variará en función del proyecto en el que usemos la función y el plano de ejecución. Para entenderlo mejor partiremos de una solución con un proyecto de datos que hereda uno de aplicación. En el proyecto de datos creamos un proceso que usa esta función:
Ejecutado en primer plano desde Velneo vCleint, devolverá el nombre de la instancia del proyecto de aplicación.
Ejecutado en tercer plano desde Velneo vCleint, devolverá el nombre de la instancia del proyecto de aplicación.
Ejecutado en primer plano desde Velneo vDataClient, devolverá el nombre de la instancia del proyecto de datos.
Ejecutado en tercer plano desde Velneo vDataCleint, devolverá el nombre de la instancia del proyecto de datos.
getMainInstanceName()
Parámetros
No tiene.
Ejemplo
getMainInstanceName() = vERP
getMainObjectId
Devuelve una cadena con el identificador del objeto principal que se está ejecutando. Por ejemplo, si estamos ejecutando un menejador de evento de una rejilla que está incrustada en un formulario, nos devolverá el identificador del formulario.
getMainObjectId()
Parámetros
No tiene.
Ejemplo
Para obtener el identificador del formulario donde está incrustada una rejilla en curso desde un manejador de evento de la misma:
getMainObjectId() = ENT_M
getMainObjectName
Devuelve una cadena con el nombre del objeto principal que se está ejecutando. Por ejemplo, si estamos ejecutando un menejador de evento de una rejilla que está incrustada en un formulario, nos devolverá el nombre del formulario.
getMainObjectName()
Parámetros
No tiene.
Ejemplo
Para obtener el nombre del formulario donde está incrustada una rejilla en curso desde un manejador de evento de la misma:
getMainObjectName() = Contacto
getMainObjectType
Devuelve una cadena con el tipo del objeto principal que se está ejecutando. Por ejemplo, si estamos ejecutando un menejador de evento de una rejilla que está incrustada en un formulario, nos devolverá el tipo de objeto del formulario.
getMainObjectType()
Parámetros
No tiene.
Ejemplo
Para obtener el tipo de objeto del formulario donde está incrustada una rejilla en curso desde un manejador de evento de la misma:
getMainObjectType() = Formulario
getParentObjectId
Devuelve el identificador del objeto padre que contiene el objeto en curso.
getParentObjetctId()
Parámetros
No tiene.
Ejemplo
Ejecutamos esta función desde un menejador de evento de una rejilla que está incrustada en un formulario:
getParentObjectId() = ENT_M_MEN
getParentObjectName
Devuelve el nombre del objeto padre que contiene el objeto en curso.
getParentObjectName()
Parámetros
No tiene.
Ejemplo
Ejecutamos esta función desde un menejador de evento de una rejilla que está incrustada en un formulario:
getParentObjectName() = Contacto.
getParentObjectType
Devuelve el tipo del objeto padre que contiene el objeto en curso.
getParentObjectType()
Parámetros
No tiene.
Ejemplo
Ejecutamos esta función desde un menejador de evento de una rejilla que está incrustada en un formulario:
getParentObjectType() = Formulario.
getPathObjectIds
Devuelve una cadena separada por comas con los identificadores de todos los objetos desde el objeto principal hasta el objeto en curso.
getPathObjectIds()
Parámetros
No tiene.
Ejemplo
Ejecutamos esta función desde un menejador de evento de una rejilla de facturas que está incrustada en un subformulario de un formulario de Clientes:
getPathObjectIds() = CLI,CLI_SUB,FAC.
getPathObjectINames
Devuelve una cadena separada por comas con los nombres de todos los objetos desde el objeto principal hasta el objeto en curso.
getPathObjectNames()
Parámetros
No tiene.
Ejemplo
Ejecutamos esta función desde un menejador de evento de una rejilla de facturas que está incrustada en un subformulario de un formulario de Clientes:
getPathObjectNames() = Cliente,Facturas,Facturas.
getPathObjectITypes
Devuelve una cadena separada por comas con los tipos de todos los objetos desde el objeto principal hasta el objeto en curso.
getPathObjectTypes()
Parámetros
No tiene.
Ejemplo
Ejecutamos esta función desde un menejador de evento de una rejilla de facturas que está incrustada en un subformulario de un formulario de Clientes:
getPathObjectTypes() = Formulario,Formulario,Rejilla.
getProjectName
Devuelve el nombre del proyecto en curso.
getProjectName()
Parámetros
No tiene.
Ejemplo
getProjectName() = Velneo vSalesDaybook
getProjectVersion
Devuelve la versión del proyecto en curso.
getProjectVersion()
Parámetros
No tiene.
Ejemplo
getProjectVersion() = 0.1 Beta
getTableHandle
Devuelve el manejador o handle de la tabla en curso en formato hexadecimal. Este manejador se corresponderá con el orden de creación de la tabla dentro del proyecto. El manejador correspondiente a la primera tabla creada en el proyecto será 0.
getTableHandle()
Parámetros
No tiene.
Ejemplo
getTableHandle() = 1A
Última actualización
¿Te fue útil?