VBScript no es case sensitive, de modo que los nombres de objetos y métodos, deberían emplearse como se indican a continuación, pero no suponen un error de sintaxis si se emplean con una notación diferente.

El objeto AppData contiene la referencia a la aplicación XOne dentro de la cual se está ejecutando cualquier script.

Sea cual sea el nivel de anidamiento, el ámbito activo o cualquier otra condición, este objeto es siempre el mismo y siempre está disponible. Sus Métodos son los siguientes:

Devuelve el valor de la macro ##ENTIDCOLL## tal como quedaría en los filtros de los SQLs o en cualquier otro lugar que se sustituya la macro.

Se puede asignar valor a esta macro para que al sustituir ##ENTIDCOLL## se haga con el valor asignado a esta propiedad (i.e. Durante el <onlogon> para trabajar con los filtros de todas las colecciones que usen esta macro.)

Devuelve el valor de la macro ##USERIDCOLL##.
El comportamiento es similar al de AllowedEnterprises, es decir, se puede asignar para que se use el nuevo valor en los filtros y demás.

Devuelve la ruta en la que se está ejecutando la aplicación.

Esta ruta es la que se utiliza como raíz para la búsqueda de todos los ficheros de datos y de configuración (mappings, appwizard, etc.) así como los ficheros de script y la base de datos si su acceso lleva una ruta (i.e. SQLite).

Ejemplo de Uso:

	fichero=appdata.AppPath+"files\"+cstr(obj("FOTO_ALBARAN"))

Contiene la cadena de conexión de la conexión principal de la aplicación.

Normalmente, las aplicaciones tienen una conexión principal y de forma opcional pueden tener un número adicional de conexiones.
Esta propiedad se refiere a la conexión principal de la aplicación.
Modificar el valor de esta propiedad después que se ha llamado a IniciarApp no tiene efecto en el funcionamiento del programa, por lo que se debe asignar antes de iniciar el runtime, o en su defecto, cambiarla, llamará a TerminateApp y después volver a iniciar la aplicación (logon incluído).

Contiene una cadena con todo lo que se ha escrito en la consola de ejecución mediante WriteConsoleString.

Se puede cambiar el valor, lo cual se puede usar para reiniciar el contenido de la consola:

 (i.e. Mediante un botón “Limpiar” en una ventana o algo por el estilo)

Ejemplo de Uso:

	This("MSG") = Cstr(appData.ConsoleOutput)
	appData.ConsoleOutput = ""

Devuelve un objeto de datos representando la empresa que está actualmente seleccionada (empresa del usuario logueado).

Este objeto se asigna después del proceso de logon, de modo que si se llama antes de que se conecte el usuario, su resultado será Nothing.

Si el logon falla, o el usuario no tiene empresa asignada, el valor de esta propiedad también será Nothing.
Por tanto, no se debe asumir que tiene valor siempre.

Contiene la máscara de fecha de la conexión principal de la aplicación.

Esta máscara no tiene que ver con el orden de fecha del local del sistema operativo que se esté usando, sino con la de la base de datos de la conexión principal.

Se puede modificar en cualquier momento, aunque lo suyo sería cambiarla antes de hacer nada con la conexión, ya que normalmente al iniciarse una aplicación se hacen accesos a base de datos, y si hay alguno de ellos que lleve campos de fecha, el valor de DateMask ya debería ser correcto en ese momento.

Esta propiedad normalmente la inicializa el framework y como mucho lo que se hace con ella es consultarla.

Descifra una cadena de texto que se pasa como parámetro.

Utiliza como clave la que se haya asignado mediante los ficheros de claves, el almacén de certificados local, o usando valores aleatorios, dependiendo del valor del parámetro Flags.
La cadena se debe suministrar en Base64.
La función convertirá la cadena en un bloque binario que será posteriormente descifrado y devuelto en forma de cadena.

Ejemplo de Uso:

	stDec=appData.DecryptString(stEnc,0)

Cifra y codifica una cadena que se pasa como parámetro.
La clave usada dependerá del valor del parámetro Flags.
La cadena se devuelve una vez cifrada en formato Base64 para poder almacenarse en un campo de base de datos o en un fichero de texto.

Ejemplo de Uso:

	stEnc=appData.encryptString(st,0)

Ejecuta una sentencia SQL en la conexión principal de la aplicación.

1. Si la réplica está activa (IsReplicating=True) la sentencia se ejecutará dejando las trazas correspondientes en la cola de réplica.
2. Solo se pueden ejecutar INSERT, UPDATE o DELETE, no se pueden hacer truncates ni ninguna otra instrucción SQL.
3. No se pueden utilizar macros.

Ejemplo de Uso:

	appdata.executeSQL "UPDATE Gen_Rutas SET VISITADO=0 WHERE IDUSUARIO=" + CStr(This("IDUSUARIO"))

Devuelve un objeto que contiene los datos de error de la aplicación.

En este objeto se puede encontrar la información del último error ocurrido durante la ejecución de la aplicación.

Ejemplo de código:

on error resume next
 
set coll=appdata.getcollection("ArticulosBuscar")
filtro=coll.filter
coll.filter="CODARTICULO="+cstr(articulo)
coll.startbrowse
if appdata.error.Number<>0 then
	appdata.userinterface.msgbox "Error " + CStr(appdata.error.Description),"ERROR",0
	'appdata.userinterface.msgbox "Error " + CStr(appdata.error.failedsql),"ERROR",0
	appdata.error.Clear
else
	'hacerloquesea
end if
coll.filter=filtro

Sus propiedades se describen en la sección Manejo Errores.

Esta función se emplea para indicarle a la maquinaria que algo ha fallado dentro del script.

El código pasado como parámetro será el que quede en los datos de error de AppData.Error después de llamar a esta función.

Ejemplo de Uso:

	if This("IMPRESO")<>2 then
		st_msg =""
		if This("TESTIFICADOR")="" then st_msg="Debe indicar un Testificador."
		if This("MATRICULA2")="" then st_msg="Debe introducir una Matricula."
		if st_msg = "" then
			This("IMPRESO") =2
			This("LEIDO") =0
			This.save
		else
			AppData.FailWithMessage -8100,st_msg
		end if
	end if

Devuelve la colección global cuyo nombre se indica.

Si la colección no existe, devuelve Nothing. Las colecciones globales son únicas, por lo que llamar varias veces a esta función con el mismo nombre devolverá siempre la misma colección.

El nombre de la colección distingue entre mayúsculas y minúsculas.
Ejemplo de Uso:

	Set dispo =appdata.GetCollection("Dispositivos")("CODIGO",Cstr(appdata.CurrentEnterprise.Variables("APP_device")))
	if not dispo is nothing then
		This("IDDEVICE")=dispo("ID")
		set dispo =nothing
	end if

Devuelve el número de colecciones que hay definidas en la aplicación.

Devuelve el valor de la macro que se le pase en el primer parámetro.

Esta propiedad tiene como valor True si la aplicación está replicando o False cuando las operaciones SQL no generan datos de réplica.

Cuando la aplicación tiene varias conexiones, esta propiedad de AppData solamente se refiere a la conexión principal.

Ejemplo de Uso:

	AppData.IsReplicating = true

Contiene el prefijo que se le adiciona a las tablas de la base de datos para la conexión principal.

Para las demás conexiones que tenga la aplicación habrá que indicar este dato en la definición de cada una de ellas.

Por defecto los frameworks inicializan este valor con “Gen”.

Es importante tener en cuenta que el guión no debe incluirse en el prefijo, ya que lo añade la maquinaria.

Devuelve un valor sacado del tope del stack de parámetros de la aplicación.

Este mecanismo se usa para intercambiar datos entre scripts ejecutados en diferentes ámbitos, con recursividad incluida.

Si el stack está vacío, la función causará un error de ejecución.

Debido a las mejores realizadas en las diferentes plataformas, este método es utilizado internamente y ya no se utiliza en los scripts.

Coloca el valor que se pasa como parámetro en el stack de la aplicación.

De aquí se puede sacar con PopValue.

Normalmente esta función no debería dar errores a menos que hubiera problemas de memoria, y en casos como ese, el error debería haber ocurrido antes.

Ejemplo de Uso:

' Tendremos un boton que llame a una funcion que lanza el objeto en edición
Function TestigosCYC()
	tareaid=Cstr(This("TAREAID"))
	Set CollT=appdata.GetCollection("TestigosCYCIn")
	'Buscamos si el registro ya existe
	Set ObjT=CollT("TAREAID",tareaid)
	if not ObjT is nothing then
		'Si existe lo lanzamos en edición
		AppData.PushValue ObjT
	End If
End Function
 
' En la colección llamada por el AppData.PushValue, tendremos otro botón que hará las validaciones pertinentes 
' y saldrá de la edición para volver a la pantalla original.
 
Function VolverTestigosCYCIn()
	st_msg=""
	if This("MAP_OP11")=1 and This("TESTIGOSV")="" then
		st_msg="Debe introducir un comentario."
	end if
	if This("MAP_OP10")=0 and This("MAP_OP11")=0 then
		st_msg="Debe Indicar si los testigos son Ok o No Ok."
	end if
	if st_msg="" then
		'Si no hay error, guardamos y salimos
		This.save
		appdata.failwithmessage -11888,"##EXIT##"
	else
		'Si hay error, le decimos el problema pero no salimos.
		appdata.userinterface.msgbox st_msg,"ATENCION!",0
	end if
End Function

Similar a PushValue, pero al lanzar el nuevo objeto en edición, cierra previamente la ventana que lo llama.

Devuelve el MID con que se ha configurado la conexión principal de la aplicación para replicar.

Cuando la aplicación se inicializa, se leen los valores de réplica del registro o de donde estén configurados dependiendo de la plataforma.

Mediante esta propiedad, el desarrollador puede conocer con qué MID está replicando para poder efectuar la depuración de la aplicación o cualquier otra cosa que necesite.

Redondea el valor que se le pasa como parámetro a la cantidad de dígitos que se indica.

Las reglas que se usan para redondear son válidas para redondear cantidades en euros tal como se ha definido en la regla correspondiente, por lo que esta función puede usarse para sacar cuentas con valores monetarios.

Devuelve el objeto que se utiliza para interactuar con el usuario (UI).

Mediante este objeto se pueden mostrar mensajes, solicitar datos al usuario, etc.

Se explica en profundidad todas las posibilidades que tiene dicha función aquí.

Esta función se utiliza para formatear valores siguiendo las reglas de formato de la base de datos empleada en la conexión principal.

Esto es útil sobre todo cuando se emplea para componer filtros en tiempo de ejecución.

Las fechas, las cadenas y los números se pueden formatear para colocar directamente en sentencias SQL.

Ejemplo de Uso:

	fecha=AppData.VariantToString(Now())

Saca por la consola de depuración el texto que se pasa como parámetro.

Si la maquinaria está en modo depuración o desarrollo, dependiendo de la plataforma y de la versión, también se saca el texto por la consola de depuración o por la salida estándar del sistema.

Ejemplo de Uso:

	appdata.writeconsolestring " /  CODIGO LEIDO: "+cstr(this("MAP_LECTURA"))

El manejo de errores se realiza a través del objeto appdata.error que describimos a continuación de forma independiente, debido a su importancia. Los valores que pueda tomar este objeto error pueden ser manejados durante la ejecución de la aplicación. Las funciones disponibles son las siguientes:

Contiene el código del último error ocurrido en la maquinaria.

Valores negativos suelen indicar errores, códigos positivos suelen indicar situaciones “anormales” pero que no representan errores fatales.

Cero indica que no hay error.

....
appdata.GetCollection("ForMaintenance").ExecuteSqlString "ALTER TABLE GEN_PRUEBA ADD COLUMN  CAMPOTXT varchar(10) NULL"
 
If AppData.Error.Number=0 Then
   ' Indica que se pudo crear el campo correctamente
    This("MAP_OK")=1
Else
   'Ocurrio un error, como por ejemplo, el campo ya estaba creado 
    This("MAP_OK")=0
    ...
End If

Descripción del último error ocurrido en la maquinaria.

Si el error de la última operación se debe a un SQL que ha fallado, la sentencia en cuestión está en esta propiedad del objeto de error.

Algunos métodos pueden optar también por dejar información en esta propiedad, pero lo normal es que si no hay SQLs implicados en el error, esta propiedad esté vacía.

Limpia las variables del objeto de error, dejándolo listo para la siguiente operación.

....
appdata.GetCollection("ForMaintenance").ExecuteSqlString "ALTER TABLE GEN_PRUEBA ADD COLUMN  CAMPOTXT varchar(10) NULL"
 
If AppData.Error.Number=0 Then
   ' Indica que se pudo crear el campo correctamente
    This("MAP_OK")=1
Else
   'Ocurrio un error, como por ejemplo, el campo ya estaba creado 
    This("MAP_OK")=0
    'Limpiar el ERROR al final para que no se propague y controlar por mi cuenta el mensaje que quiero mostrar
    AppData.Error.Clear
End If

Se ha definido una nueva forma de hacer login en las aplicaciones XOne.

Dentro del objeto appData, encontramos los siguientes métodos relacionados con el login.

El objeto que se le pase tiene la siguiente estructura:

  {
      userName: /*usuario*/,
      password: /*contraseña*/,
      entryPoint: /*Colección entryPoint que se abrirá cuando el login sea correcto.*/,
      /*Opcional*/
      onLoginSuccessful: function() {
          /*Esto se llamara si el login ha sido correcto.*/
      },
      /*Opcional*/
      onLoginFailed: function() {
          /*Esto se llamara si el login no ha sido correcto.*/
      }
  };

Ejemplo:

   function doLogin() {
    var params = {
        userName: self.MAP_USER,
        password: self.MAP_PASSWORD,
        entryPoint: "MenuEntrada2",
        /* Opcional */
        onLoginSuccessful: function() {
            ui.showToast("Login OK!");
        },
        /* Opcional */
        onLoginFailed: function() {
            ui.showToast("Login failed!");
        }
    };
    appData.login(params);
}

Ejemplo:

  function doLogout() {
    appData.logout();
  }

Ejemplo:

  function exit() {
    appData.exit();
  }