[Tutorial 04] Xactions, Pentaho Design Studio y Editor de Xactions

[Bernabeu R. Dario]

Los temas que se tratarán en este tutorial son:

• Qué es una Xaction?
• Qué es Pentaho Design Studio?
• Cómo Instalar Pentaho Design Studio?
• Cómo Iniciar Pentaho Design Studio?
• Cómo crear un nuevo Proyecto en Pentaho Design Studio?
• Cómo crear una Xaction?
• Qué es el Editor de Xactions?

Software necesario:

• Pentaho BI Server 4.8.0 (o anterior)
• Pentaho Design Studio 4.0.0 (o anterior)

 

Qué es una Xaction?

Una Xaction o secuencia de acción es un conjunto predefinido de acciones. Las xactions son ejecutados por Pentaho BI Server, ya sea cuando se inicializa, a través de la orden de un@ User, un evento calendarizado, etc.

Una Xaction básicamente es un archivo XML con extensión .xaction, que recibe inputs, realiza una serie de Actions y devuelve Outputs.

Es muy común leer o escuchar que “las xaction son la piedra angular de Pentaho” y esto se debe a que vinculan todos los demás componentes. Las Xaction tienen sentido solo en el ámbito de Pentaho BI Server, así que cada vez que se las mencione tengamos esto en mente.

Hasta aquí es bastante abstracto el concepto de Xaction, pero si vemos algunos ejemplos típicos podremos clarificar un poco más el panorama:

• Cuando creamos una carpeta de solución, Pentaho BI Server ejecuta una xaction que realiza esa tarea.
• Cuando le hacemos doble clic a un reporte para visualizarlo, Pentaho BI Server ejecuta una xaction que realiza esta tarea.
• Cuando refrescamos el repositorio, la metadata, etc., también se realiza mediante la ejecución de una xaction.

Detrás de la gran mayoría de las acciones que podemos llevar a cabo a través de Pentaho User Console (PUC), se encuentran las Xactions.

Nosotr@s también podemos crear nuestras propias xactions, para luego ejecutarlas desde PUC. Podemos por ejemplo crear un Xaction que obtenga de una base de datos un listado de client@s, y que luego de acuerdo a su tendencia de compra, les envíe un mail con las últimas ofertas, en el formato que cada client@ lo haya establecido (PDF, HTML, etc.).

 

Qué es Pentaho Design Studio?

Pentaho Desing Studio (PDS) es una herramienta de la suite Pentaho que se utiliza para describir y mantener Xactions.

PDS esta basado en el IDE de Eclipse, esto nos da la pauta de que la UI (User Interface) es sumamente familiar e intuitiva.

A través de PDS podremos crear nuestras propias Xactions de forma visual y simple, solo basta un poco de práctica, ya que al inicio suele ser complicado. Además, PDS cuenta con selectores para muchas de sus opciones, lo cual nos facilita mucho el trabajo a la hora de editar o crear una Xaction.

 

Cómo Instalar Pentaho Design Studio?

Hay dos formas de instalar PDS, dependiendo si ya se tiene Eclipse instalado o no.

a) Si no se tiene instalado Eclipse llevaremos a cabo los siguientes pasos:

    a.1) Iremos a esta dirección de Source Forge... (PDS versión 4.0.0)

    a.2) Seleccionaremos y descargaremos de la lista el archivo indicado de acuerdo a nuestro sistema operativo y arquitectura:

• Linux 32bits...
• Linux 64bits...
• Window$ 32bits...
• Window$ 64bits...

    a.3) Descomprimimos el archivo en algún directorio de nuestra elección.

b) Si ya se tiene instalado Eclipse llevaremos a cabo los siguientes pasos:

    b.1) Iremos a esta dirección de Source Forge... (PDS versión 4.0.0)

    b.2) Seleccionaremos y descargaremos de la lista el archivo indicado de acuerdo a nuestro sistema operativo y arquitectura (Idem paso a.2).

    b.3) Descomprimimos el archivo en un directorio de nuestra elección.

    b.4) Copiaremos la carpeta [PDS_HOME]/plugin/org.pentaho.designstudio.editors.actionsequence_4.0.0.stable en la carpeta [ECLIPSE_HOME]/plugin. Con esto hemos añadido el plugin de PDS en nuestro Eclipse.

 

Cómo Iniciar Pentaho Design Studio?

A continuación iniciaremos PDS o Eclipse con el plugin de PDS, según corresponda.

a) En Linux:

    a.1) Abrimos una terminal y escribimos:

• shell> cd [PDS_HOME]

    a.2) Para iniciar PDS escribimos:

• shell> ./eclipse

b) En Window$:
    b.1) Abrimos una terminal y escribimos:

• shell> cd [PDS_HOME]

    b.2) Para iniciar PDS escribimos:

• shell> eclipse.exe

Una vez que inicia PDS nos presenta un cuadro de diálogo en el cual nos pregunta el path a nuestro workspace. Podemos utilizar el path que nos propone por defecto o colocar uno propio.

El Workspace es una carpeta que contendrá los proyectos y soluciones que creemos en PDS, además de la metadata que los define. También es posible crear links a proyectos y/o carpetas que se encuentran en otras ubicaciones.

 

Cómo crear un nuevo Proyecto en Pentaho Design Studio?

Un Proyecto dentro de PDS es una colección de archivos y carpetas. Para crear un nuevo Proyecto en PDS vamos a seguir los siguientes pasos:

• 1) Nos dirigimos al menú superior y seleccionamos la opción File → New → Proyect.... Esto nos abrirá la siguiente ventana:

• 2) Seleccionaremos el nodo General → Proyect y presionaremos el botón Next >:

• 3) En este nuevo formulario completaremos las opciones de la siguiente manera:
  • Project name = Pentaho Solutions
  • Destildamos la opción Use default location
  • Location = [BISERVER_HOME]/biserver-ce/pentaho-solutions

Recordar cambiar [BISERVER_HOME] por la ruta completa. Para continuar presionamos el botón Finish.

• 4) Si es que aún se encuentra abierta, cerraremos la pestaña de Welcome.

El Project Explorer, que se encuentra arriba a la izquierda nos debería mostrar lo siguiente:

 

Cómo crear una Xaction?

Crearemos a continuación una Xaction simple para que nos vayamos tomando confianza con el entorno.

• 1) En el Project Explorer nos posicionamos en la carpeta de solución Steel Wheels (u otra carpeta de solución de nuestra elección). Y crearemos una Xaction haciendo clic en la flechita hacia abajo que tiene el icono  en la barra de accesos rápidos y seleccionaremos New Action Sequence Wizard. También podemos crear una xaction seleccionando la opción File → New → Other... y luego seleccionando Pentaho → New Action Sequence Wizard.
• 2) En el campo File name colocaremos myFirstXaction.xaction. y presionamos el botón Finish. El selector Template posee una serie de Xactions predefinidas que podemos utilizar.

Podemos observar que en la parte derecha de la UI se nos abrió en una nueva pestaña la Xaction que acabamos de crear. Dicha Xaction se nos presenta mediante un Editor de Xaction.

En la parte inferior del Editor de Xactions podemos visualizar cuatro pestañas, cada una de la cuales cumple con una función en especial, se hablará de ellas en breve, pero por ahora solo se las mencionará porque se las utilizarpá a continuación:

• 3) Hacemos clic en la pestaña General y configuraramos lo siguiente:
  • Title = My First Xaction
• 4) Hacemos clic en la pestaña Define Process, y en la sección Process Action haremos clic en el icono  y seleccionaremos la opción Utilities → Hello World.
• 5) Hacemos clic en la pestaña XML Source para ver cuál es el código XML que se ha generado.
• 6) Hacemos clic en la pestaña Test para ejecutar y probar nuestra Xaction en Pentaho BI Server. Es fundamental para testear las Xactions que Pentaho BI Server se encuentre corriendo.
  • Colocamos en Pentaho Server URL = http://localhost:8080/pentaho
  • Presionamos el botón Test Server y nos logueamos en Pentaho BI Server.

• Refrescamos el repositorio de soluciones de Pentaho BI Server para que tome las modificaciones realizadas (Tools → Refresh → Repository Cache).
• Ahora ejecutaremos nuestra Xaction. Para ello podemos hacer doble clic desde PUC o en el Editor de Xactions presionar el botón Generate URL y luego Run.

Podemos configurar la URL de Pentaho BI Server seleccionando en el menú superior de PDS la opción Window → Preferences. Luego en el panel de la izquierda seleccionar Pentaho Design Studio y completar el campo Pentaho Sever URL con el valor http://localhost:8080/pentaho.

 

Qué es el Editor de Xactions?
Acabamos de crear una Xaction, para lo cual debimos emplear el Editor de Xactions, lo que se hará a continuación será explicar con más detalle cada una de sus pestañas, opciones y características.

Como se mencionó anteriormente el Editor de Xactions cuenta con cuatro pestañas, ahora se describirán cada una de ellas y sus principales características:

 

1) Pestaña General
Esta pestaña como su nombre lo indica, posee información a nivel general de la Xaction. Aquí podemos configurar, entre otras, las siguientes opciones:

• Title: este es el nombre con el que veremos a las Xaction en Pentaho User Console (PUC).
• Logging Level: nivel de detalle del registro de log.
• Visible: indica si la Xaction será visible o no para l@s Users de PUC. Esto es muy útil ya que nos permite ocultar las Xaction que utilicemos de forma interna.
• Description: descripción que será usada como tooltip en PUC.
• Los valores de Version, Author, Result Type y Help sirven para uso interno, para ayudar al seguimiento y posterior edición de las Xactions.

 

2) Pestaña Define Process
Esta pestaña contiene la parte más importante del Editor de Xactions, es aquí en donde le daremos vida a nuestras acciones y estableceremos su modo y forma de ejecución. Aquí es donde nos paseremos la mayor parte de nuestro tiempo a la hora de editar nuestras propias Xactions.

Como podemos observar, en la parte izquierda del Editor de Xactions tenemos tres secciones: Process Inputs, Process Actions y Process Outputs.

Básicamente en Process Inputs definiremos variables que utilizaremos en nuestra Xaction; en Process Actions definiremos todas las acciones que deberán llevarse a cabo, su orden y modo; y en Process Outputs definiremos cuál serán las salidas de nuestra Xaction.

Describiremos un poco más acerca de estas tres secciones a continuación.
Process Inputs
Esta sección divide los Inputs en dos carpetas, inputs y resource. Para crear un input o resource se debe presionar la flechita hacia abaja del icono  y seleccionar según corresponda. Para añadir un nuevo resource se debe seleccionar la opción resource, para añadir un input cualquiera de las demás opciones, dependiendo el tipo de dato que se desea.

Un input básicamente es una variable que será utilizada en nuestra Xaction, a la cual podemos configurarle lo siguiente:

• Name: es el nombre de la variable para uso interno.
• Type: tipo de dato que contendrá la variable, por ejemplo, String, Integer, List, Result-set, etc.
• Default value: aquí debemos especificaremos el valor por defecto de esta variable.
• Source Of Input: aquí estableceremos la relación de esta Xaction con el mundo exterior, es decir, definiremos la forma en que se obtendrá su valor, esta puede ser mediante un simple Request, u obteniendo valores de variables de tipo Session, Global, etc.

Un resource es básicamente un archivo que tomaremos como entrada, para luego trabajar con él, los detalles del mismo son:

• Name: es el nombre de este recurso para uso interno.
• Location y Source Type: entre estos dos campos estableceremos el path hacia el resource en cuestión.
• Mime Type: como su nombre lo indica es el Mime Type del recurso. Aquí se pueden ver algunos ejemplos...

 

Process Actions
Aquí estableceremos todas las acciones que realizará la Xaction, para añadir una Action nueva solo basta con presionar el icono  y seleccionar la que deseemos.

Mediante Get Data From podemos obtener datos de diferentes maneras, entre ellos:

• Ralational: permite conectarnos a un RMDB y ejecutar una consulta SQL.
• OLAP: permite conectarnos a un schema y ejecutar una consulta MDX.
• Pentaho Data Integration: permite ejecutar una Transformation PDI (con todo las posibilidades que esto nos puede dar!).
• JavaScript: permite ejecutar nuestro propio código JavaScript.

Prompt/Secure Filter nos permite mostrar una ventana para que l@s Users ingresen valores para las variables que deseemos.

Con Message Template podremos crear código HTML utilizando los valores de las variables que estemos utilizando. Esta Action es muy útil.

Mediante Custom podremos ejecutar cualquier tipo de componente de Pentaho, con Send To → E-Mail podemos realizar envió de mails y con Chart podremos crear gráficos.

Todas las Actions que agreguemos serán ejecutadas en el orden en que se muestra en esta sección.

Para modificar dicho orden podemos utilizar las opciones .

También existen dos Actions muy particulares, que permiten condicionar la ejecución de las Actions y que además podremos añadirles una o más Actions como nodos hijos. De esta forma su ejecución afectará solo a sus hijos. Dichas Actions son:

• If Statement: permite crear una condición de ejecución, si esta condición es cierta se iniciará la ejecución de sus Actions hijos.
• Loop: permite establecer una condición de repetición, mediante la cuál iniciará la ejecución de sus Actions hijos tantas veces como corresponda.

 

Process Outputs
Son las salidas que tendrá nuestra Xaction, dichas salidas pueden utilizarse como Response, para setear variables de tipo Session, Global, Runtime, o para grabar el valor de una variable en un File.

 

3) Pestaña XML Source

Todas las configuraciones que hagamos en nuestra Xaction se irán escribiendo en código XML. Esta pestaña nos mostraŕa dicho código XML para que podamos analizarlo o bien modificarlo. Existen oportunidades en que es más fácil o viable editar una Xaction desde esta pestaña.

 

4) Pestaña Test

La pestaña Test se utiliza para testear la Xaction sin necesidad de tener que abandonar la UI de PDS.