RESTful con Omnis Studio (Parte 1 de 3)

Para la implementación de servicios web basados en REST, Omnis Studio dispone de un componente externo y un “plugin” encargado de publicar el código Omnis como Servicio Web, ambos son complementados mediante el nuevo componente externo JSON denominado “OJSON”, que permite la adecuada gestión de objetos basados en JSON, profusamente utilizados con REST.

¿Qué es REST? REST es sin lugar a dudas el modelo más extendido hoy en día para usar y publicar servicios web, está considerado como la mejor alternativa al uso de otras tecnologías como SOAP. Un servicio web RESTful es identificado mediante una URI, donde los clientes interactúan con el recurso a través de solicitudes HTTP, obteniendo respuestas mediante un conjunto ya predeterminado de métodos HTTP.

 

Creación de un “Web Service” cliente

Dentro del grupo de objetos externos “Web Worker Objects”, podemos encontrar el “HTTPClientWorker” que es un objeto de tipo “Worker”. Esto significa que funciona de modo similar a como lo hacen los ya conocidos objetos DAM de este mismo tipo, es decir que son ejecutados en segundo plano.

Para utilizar el objeto, deberemos crear una “Object Class” con el “HTTPClientWorker” como subclase. Tal como mostramos en la siguiente imagen:

En la clase-objeto así creada, será necesario definir dos métodos, “$completed” y “$cancelled”, los cuales serán respectivamente invocados tras la obtención del resultado de una solicitud o al producirse su cancelación. A continuación, deberemos crear una variable-instancia de tipo objeto sobre una clase “remote-form” JavaScript, desde donde poder instanciar la clase-objeto anteriormente creada, con la finalidad de poder interactuar con el servicio Web mediante sus métodos. De entre ellos el objeto “HTTPClientWorker” incluye: El “$init()” que lo inicializa de forma que quede listo para realizar las peticiones HTTP que se especifiquen; El “$run()” que ejecuta un hilo en primer plano; El “$start()” que ejecuta un hilo en segundo plano y el “$cancel()” que cancela el subproceso en marcha. El método “$cancel()” es invocado cuando se cancela la solicitud y el “$completed()” cuando se complete la solicitud, la cual retornará una única variable-parámetro de tipo “row” con diversas columnas, el contenido de la respuesta estará incluido en la última columna.

 

Ejemplo de cliente “Web Sercice” basado en REST.

Desde la web de Aula Omnis, podrá descargar una librería dispuesta a modo de ejemplo, sobre el uso de un Servicio Web basado en REST.

Dicha librería permite mostrar información básica sobre la previsión del tiempo, mediante el acceso a un servicio web público proporcionado por WorldWeatherOnline.com. La compañía ofrece dos versiones de su API; una gratuita y otra de pago. El ejemplo se basa en el servicio gratuito, éste puede ser invocado con un límite de 12.000 accesos diarios y 5 veces por segundo, lo cual es más que suficiente para nuestro propósito. Para hacer uso del servicio, deberá obtener antes una clave de la API desde WorldWeatherOnline.com e introducirla al ejecutar la librería por primera vez.

Para probar el servicio y conseguir mostrar el pronóstico del tiempo, abra primero la librería de ejemplo, haga clic derecho sobre el “remote-form” “jsWeather” y seleccione “Test Form” desde el menú contextual. El formulario deberá abrirse en su navegador y mostrar el pronóstico del tiempo para 5 días en Saxmundham. Tenga en cuenta que se ésta utilizando la versión gratuita de la API, la cual tiene un límite de 5 consultas por segundo, por lo que se hace uso de un temporizador para evitar la devolución de un error desde el servidor. Si publica el formulario a un servidor web, el servicio tratará de identificar su ubicación mediante su dirección IP en uso.

Cuando examine el código de la librería de ejemplo, notará que los métodos clave son “GetWeather”, “getData”, “readCurrentData” y “readForecastData” en el caso del “remote-form”  “jsWeather”. “$completed, “$returnVa” en el caso de la clase-objeto “Orest”. A continuación mostramos el método de iniciación “$init()” encargado de inicializar el objeto “Web Services”, configurando los parámetros principales e invocando el servicio web.

; iURI (Char) inicializado como "http://api.worldweatheronline.com"
; iHTTPMethod (Int) iniciado con el valor “kOWEBhttpMethodGet”
; iHeadersList (List)
; iContentChar (Char)
Do iHeadersList.$define(iHeaderName,iHeaderValue)
; call the web service
Do iRestfulObj.$init(iURI,iHTTPMethod,iHeadersList,iContentChar)
Do iRestfulObj.$run() Returns lStatus
A continuación mostramos, el método “$completed” del objeto “Orest”:

; invocado desde el “worker” del cliente con los resultados
Calculate iResponse as pRow
Calculate iResponseHeaders as pRow.responseHeaders
Do OJSON.$formatjson(pRow.responseContent) Returns iReturnStr
Do OJSON.$jsontolistorrow(pRow.responseContent) Returns iJSONRow
Para procesar la salida que nos llega en formato JSON, se hace uso del  nuevo componente externo “OJSON”.

Creando nuestros propios “Web Services”

Un plug-in “Web Server” permite publicar el código de nuestras aplicaciones Omnis, que permitirá a los posibles cliente hacer uso de nuestros “Web Services”. La interfaz para éstos servicios web es vista por los clientes como una API o conjunto de APIs. Omnis genera las API’s RESTful (o ORAs) usando una definición "Swagger", que es el estándar más utilizado con las API’s RESTful.

Podrá ver las Omnis APIs RESTul desde el navegador de Omnis Stido (Studio Browser) como hijos del nodo de su librería bajo el grupo “Web Service Server” (tal cómo ya venia ocurriendo con los servicios basados en WSDL). Cada “ORA” se muestra bajo un nodo separado en el árbol, y varias opciones o acciones con hipervínculos. Podrá ver su definición “Swagger” navegando a trabes de los hipervínculos.

Configurando un trabajo de impresión (Job Setup)

El diálogo “job setup” o “configuración de impresión” permite al usuario escoger cosas como bandejas de salida, páginas a imprimir, etc. Además de los comandos “Print report” y “Prepare for print” que tradicionalmente permitían mostrar éste diálogo al usuario, podemos hacer uso del comando de notación, con éste único fin.

Toda instancia-informe contiene un nuevo método denominado “$openjobsetup()”, que permite mostrar el diálogo de impresión una vez que creada la instancia-informe. Si se especifica kTrue en el parámetro “$openjobsetup”, el diálogo se abrirá independientemente de cual sea el destino del mismo.

Debemos tener en cuenta que el diálogo sólo se puede abrir una vez creada la instancia-informe y antes de la impresión del primer registro. De modo que deberá usarse durante o inmediatamente después de la ejecución del método “$construct”.

El ejemplo siguiente muestra como hacer uso del método durante la construcción del informe.

Método: “$construct”
Parametro         Tipo

pPrompt           Boolean   

Variable local    Tipo

ok                Boolean   

Código del método

If pPrompt
  Do $cinst.$openjobsetup(kTrue) Returns ok
  If not(ok) ;; si el usuario cancela el trabajo se cierra la instancia
    Do $cinst.$close()
    Quit method
  End If
End If

Guardado de la selección

Todo lo establecido en el diálogo de configuración de impresión quedará automáticamente guardado junto con el informe. Sin embargo, debemos tener en cuenta que tal información no es multiplataforma, por lo que sólo será válida si se está imprimiendo en la misma plataforma.

Introducción a la abstracción y la herencia

Éste artículo está especialmente dirigido a los desarrolladores que tras una larga experiencia programando con Omnis 7, han decidido dar el salto a la programación con Omnis Studio. Mostramos una pequeña introducción sobre cómo utilizar las posibilidades de la herencia que aporta Omnis Studio, atendiendo a lo que en programación orientada a objeto (OO) significa la “abstracción”. La abstracción y la herencia (en Omnis Studio) se entiende como la creación de elementos genéricos, con la intención de ser usados muchas veces en nuestra aplicación, consiguiendo que su tiempo de programación sea menor a la vez que más consistente, más sencilla y más fácil de mantener.

Imaginemos que disponemos de una ventana donde mostrar el domicilio y otros datos de un registro de direcciones, seguramente también deseemos disponer de algunos botones en ella, que permitan al usuario buscar, editar, insertar y eliminar registros. Sin embargo éste tipo de funciones a menudo serán también necesarias en muchas otras ventanas, tales como contactos, proveedores, etc. Por supuesto podríamos optar por programar de nuevo todas estas funciones para cada ventana, pero naturalmente no es eso lo que pretendemos.

Aquí es donde la abstracción y la herencia entran en juego. La idea es crear una clase-ventana principal con los botones estándar de manejo de datos, mientras que los campos en sí, estarían dibujados sobre otras ventanas secundarias y los datos a manejar sobre una única variable de tipo “row”, como por ejemplo "ivDataRow", la cual sería una variable del ámbito instancia, definida sobre la clase-ventana principal. Note que ésta variable “row” no se llama algo así como "ivDireccionesRow", sino que tiene un nombre genérico, pues la idea es que pueda ser usada con todas las tablas de datos y no sólo con la de direcciones, además (en este momento del diseño de nuestra aplicación), se supone que aún no sabemos qué tablas vamos a manejar, por lo tanto, deberemos disponer de una segunda variable de instancia de tipo “Item Reference”, a la que llamaremos “ivTableRef”, la cual apuntará a la hipotética tabla en uso.

Usaremos la variable “Item Reference”, en el método “$construct()” de la ventana, posteriormente éste método será abstraído (Overwrite) en cada sub-ventana, para sustituir la asignación de la clase-tabla a su correspondiente. Su código sería el siguiente:

Do ivDataRow.$definefromsqlclass(ivTableRef)

Ahora heredaríamos la clase-ventana principal, junto con el método anterior, a continuación mostramos una imagen de una posible ventana para la edición de datos, naturalmente tendremos que añadir los botones de buscar, editar, y así por el estilo, en la super-clase, junto con la programación que cada uno necesite.

 

A modo de ejemplo, mostramos lo que podría ser el código para el botón “Borrar”:

On evClick

  No/Yes message (Icon,Sound bell) {¿Desea realmente eliminar el

   registro "[IvDataRow.[ivColsToBeDisplayed.c1]]"?}

  If flag true

    If ivDataRow.$delete()

      Do ivDataRow.$clear() 

      Do $cinst.$redraw()

    Else

      OK message Database message (Sound bell) {El registro no 

      ha podido    eliminarse.//Error: [ivDataRow.$getErrorText()]}
    End If
  End If

Puesto que no sabemos cual es el nombre de la columna que queremos mostrar en el mensaje genérico, usamos la forma corta “c1” para mostrar la primera columna de “ivDataRow”. Atendiendo a nuestra filosofía de trabajo, deberemos programar todos los métodos específicos de cada tabla de datos en su propia clase-tabla. Para crear una sub-clase, podemos hacer clic sobre la clase-principal en el navegador (Studio Browser) y seleccionar la opción del menú contextual “Make Subclass”, tal y como mostramos a continuación:

Ahora vamos a ver cómo crear una ventana para la edición de registros, especificando la tabla a usar. Por ejemplo, creamos la clase ventana “wAddress”, que a su vez hereda los elementos de la ventana principal. A continuación abstraemos (Overwrite) el método “$construct()” haciendo clic sobre él con él botón derecho del ratón y seleccionando la opción “Overwrite”, ha continuación configuramos la variable de instancia “ivTableRef” mediante el comando “Set Reference” y finalmente (no olvidar) activamos la ejecución del código en la ventana principal mediante el comando “Do inherited”. Por ejemplo:

Set reference ivTableRef to $tables.T_Address
Do inherited

Ahora sólo tendríamos que añadir los campos a la ventana, asignándole sus respectivos “$dataname” referenciados des la variable “ivDataRow”, tal y como se muestra en el ejemplo siguiente:

De éste modo podemos crear nuestras ventanas en sólo unos pocos pasos y poner en práctica el uso de ventanas heredadas. Las funciones generales pueden ser escritas de forma genérica en la super-clase y en el futuro agregar otras nuevas que serán automáticamente heredadas o puestas a disposición de todas las sub-clases.