El comando xlsFx, se encuentra dentro de la categoría de comandos RPA. Su función es agrupar todas las funciones genéricas sobre archivos Excel (insertar/eliminar filas/columnas, filtros, búsquedas, inmovilizar celdas, etc.)
Este comando presenta los parámetros que se muestran a continuación:
Dentro de sus parámetros se debe ingresar el archivo xls con el que se desea interactuar en la automatización.
Luego se debe especificar la función a utilizar. Presenta 10 opciones:
- Borrar fila
- Borrar columna
- Insertar fila
- Insertar columna
- Nueva hoja
- Editar hoja
- Exportar a CSV
- Congelar celda
- Filtrar valores
- Buscar
- Formato fecha
- Borrar hoja
- Copiar hoja
- Ordenar
IMPORTANTE: Al momento de ejecutar la automatización utilizando este comando, el archivo XLS debe estar cerrado en el dispositivo.
- Función borrar filas:
Esta función permite al usuario eliminar un rango de filas del Archivo Excel.
El Parámetro 1 representa el rango de filas a eliminar. En Excel los rangos de filas son representados de la siguiente manera N:M, con N y M números naturales y N <= M.
En caso de que el dato ingresado no represente un rango correcto de filas el comando deberá retornar un mensaje de error en los datos al usuario al momento de ejecutar.
El comando no tiene ningún retorno más allá de su resultado, por lo que no se actualizará el valor en la variable de Guardar Resultado.
En caso de que la flag de actualizar este en VERDADERO, al finalizar la operación, si la misma fue exitosa, se impactarán los cambios en el Archivo original.
- Función borrar columnas:
Esta función permite al usuario eliminar un rango de columnas del Archivo Excel.
El Parámetro 1 representará el rango de columnas a eliminar. En Excel los rangos de columnas son representados de la siguiente manera X:Y, con X y Y letras / pares de letras y X < Y.
En caso de que el dato ingresado no represente un rango correcto de columnas el comando deberá retornar un mensaje de error en los datos al usuario al momento de ejecutar.
El comando no tendrá ningún retorno más allá de su resultado, por lo que no se actualizará el valor en la variable de Guardar Resultado.
En caso de que la flag de actualizar este en VERDADERO, al finalizar la operación, si la misma fue exitosa, se impactarán los cambios en el Archivo original.
- Función insertar fila:
Esta función permite al usuario agregar una cantidad de filas al Archivo Excel indicando también arriba de qué fila se generan las nuevas filas.
El Parámetro 1 representa la cantidad de filas a agregar. El valor ingresado debe ser un número entero. En caso de que el valor ingresado en este parámetro no pueda ser transformado en un valor entero el comando deberá reportar un error de datos al usuario al momento de ejecutar.
El Parámetro 2 representa la fila sobre la que se generarán las nuevas filas. Las filas en Excel son representadas por números enteros, por lo que acá también aplica que si el valor ingresado no puede ser transformado en un valor entero el comando deberá reportar un error de datos al usuario al momento de ejecutar.
El comando no tendrá ningún retorno más allá de su resultado, por lo que no se actualizará el valor en la variable de Guardar Resultado.
En caso de que la flag de actualizar este en VERDADERO, al finalizar la operación, si la misma fue exitosa, se impactarán los cambios en el Archivo original.
- Función insertar columna:
Esta función permite al usuario agregar una cantidad de columnas al Archivo Excel, indicando también a la izquierda de qué columna se generarán las nuevas columnas.
El parámetro 1 representa la cantidad de columnas a agregar. En caso de que el valor ingresado en este parámetro no pueda ser transformado en un valor entero el comando deberá informar un error de datos al usuario al momento de ejecutar.
El Parámetro 2 representa la columna donde las nuevas columnas serán producidas (a la izquierda de ella ). Las columnas en Excel son representadas por letras, por lo que en caso de que el valor ingresado no represente un nombre de columna válido el comando deberá reportar un error de datos al usuario al momento de ejecutar.
El comando no tendrá ningún retorno más allá de su resultado, por lo que no se actualizará el valor en la variable de Guardar Resultado.
En caso de que la bandera de actualizar este en VERDADERO, al finalizar la operación, si la misma fue exitosa, se impactarán los cambios en el Archivo original.
- Función nueva hoja:
Esta función permite al usuario crear una nueva hoja de cálculo en blanco dentro del archivo Excel.
El Parámetro 1 representa el nombre de la nueva Hoja de Cálculo.
El Parámetro 2 es un parámetro opcional donde se puede indicar la posición dentro de la lista de hojas de cálculo del archivo. Esta posición se indica con un número (1 = Primero, 2 = Segundo, etc.).
En caso de que no venga un valor o que el valor no pueda ser transformado en un número Natural que represente una posición se asume que se debe crear la Hoja de cálculo al final de la lista (también si el número indicado es mayor a la cantidad de hojas existentes se asume que se debe agregar al final).
El comando no tendrá ningún retorno más allá de su resultado, por lo que no se actualizará el valor en la variable de Guardar Resultado. En caso de que la bandera de actualizar este en VERDADERO, al finalizar la operación, si la misma fue exitosa, se impactarán los cambios en el Archivo original.
- Función editar hoja:
Esta función permite al usuario editar el nombre de una hoja de cálculo en blanco dentro del archivo Excel.
El parámetro Hoja representa el nombre de la Hoja de Cálculo a editar. En caso de que la hoja de cálculo no exista el comando devuelve un mensaje de error indicando que la Hoja de Cálculo indicada no existe.
El Parámetro 1 será el Nuevo nombre que tendrá la hoja de cálculo. En caso de que ya exista una Hoja de cálculo con ese nombre y no se pueda modificar (Excel no lo permite), avisa al usuario con un mensaje de error.
El comando no tiene ningún retorno más allá de su resultado, por lo que no se actualizará el valor en la variable de Guardar Resultado.
En caso de que la flag de actualizar este en VERDADERO, al finalizar la operación, si la misma fue exitosa, se impactarán los cambios en el Archivo original.
- Función exportar a CSV:
En caso de seleccionar la función Exportar a CSV, como origen de los datos otro archivo XLS / CSV se deberá obtener leer la información desde el archivo XLS/CSV origen y guardarla en el archivo XLS/CSV destino.
El campo archivo, representa la ruta del archivo Excel en formato CSV Original
El parámetro 1 indica la ubicación del archivo CSV sobre el que se va a escribir. Por último, en el campo Hoja se debe indicar el nombre de la hoja Excel de la que se leerá la información.
- Función congelar celda:
Esta función permite al usuario congelar / inmovilizar filas y columnas de una Hoja de Cálculo.
El Parámetro 1 representa la celda sobre la cual se va a aplicar la acción de inmovilizar. En caso de que este valor no represente un número de celda válido se avisará al usuario con un mensaje de error en tiempo de ejecución.
Al decidir inmovilizar filas y columnas lo que se hace es inmovilizar todas las filas arriba de la celda indicada y todas las columnas a la izquierda de la celda indicada.
A modo de ejemplo, Inmovilizar D2 inmovilizará la fila 1 y las columnas A, B y C.
Otro ejemplo sería inmovilizar A5. Esto congelaría las filas 1 a 4, pero no congelaría ninguna columna, ya que no hay columnas a la izquierda de la columna A.
El comando no tiene ningún retorno más allá de su resultado, por lo que no se actualizará el valor en la variable de Guardar Resultado. En caso de que la flag de actualizar este en VERDADERO, al finalizar la operación, si la misma fue exitosa, se impactarán los cambios en el Archivo original.
- Función filtrar valores:
Esta función permite al usuario seleccionar un rango de la Hoja de Cálculo y eliminar los valores de filas que cumplan con ciertas condiciones.
El Parámetro 1 representa el rango celdas a analizar (ej. B6:D10). En caso de que este valor no represente un rango valido de Excel el comando retornará un mensaje de error de datos al usuario.
Los Parámetros 2, 3 y 4 pueden ser utilizados para indicar condiciones que las filas deben cumplir para ser eliminadas. Para establecer una condición se utiliza la siguiente nomenclatura:
Columna: Condición
Por ejemplo: B:Juan representará aquellas filas donde la columna B tenga el valor Juan. En caso de que una fila tenga en su Columna B el valor Juan se eliminarán los datos de toda esa fila dentro del rango, dejando todas las celdas vacías.
Si se usaran múltiples condiciones (se aceptan hasta 3) serán seleccionadas aquellas filas que cumplan las 3 condiciones. En caso de que alguna condición no respete la nomenclatura o no represente una Columna / Condición válida se le avisará al usuario con un mensaje de error de datos al momento de ejecutar.
Las condiciones pueden estar fuera del rango indicado (ejemplo, condición sobre columna A pero se borran solo datos desde B6 a D12).
El comando no tendrá ningún retorno más allá de su resultado, por lo que no se actualizará el valor en la variable de Guardar Resultado.
En caso de que la flag de actualizar este en VERDADERO, al finalizar la operación, si la misma fue exitosa, se impactarán los cambios en el Archivo original
- Función buscar:
Esta función permite al usuario buscar filas dentro de un rango que cumplan con ciertas condiciones
El Parámetro 1 representa el rango celdas a analizar (ej. B6:D10). En caso de que este valor no represente un rango valido de Excel el comando retornará un mensaje de error de datos al usuario.
Los Parámetros 2, 3 y 4 pueden ser utilizados para indicar condiciones que las filas deben cumplir para obtener sus datos. Para establecer una condición se utiliza la siguiente nomenclatura:
Columna: Condición
Por ejemplo: B:Juan representará aquellas filas donde la columna B tenga el valor Juan.
En caso de que una fila tenga en su Columna B el valor Juan todos los datos de la fila dentro del rango serán almacenados como resultado en _wrk_datos.TMP
Si se usaran múltiples condiciones (se aceptan hasta 3) serán seleccionadas aquellas filas que cumplan las 3 condiciones.
- Función formato fecha:
Permite al usuario modificar el formato de una celda ya existente indicándole el formato de fecha que quiere darle.
Este comando utiliza dos parámetros:
El primer parámetro representa una celda o rango sobre el que se quiere aplicar el formateo. En caso de que en ese parámetro no se indique una celda o rango válida, se retornará un mensaje de error en tiempo de ejecución avisando que la celda/rango indicado no es correcta
El segundo parámetro representará el formato de fecha que se le dará a la celda / rango. Permite al usuario ingresar el formato de fecha que se desee.
Ejemplos de formatos de fecha válidos:
- (“m/d/yy”)
- (“d-mmm-yy”)
- (“dddd”)
- (“m/d/yy h:mm”)
- (“h:mm:ss”)
- (“hh:mm:ss.MM AM/PM”)
- (“m:s AM/PM”)
Además de estos parámetros, este comando deberá realizarse sobre la hoja indicada e impactar / actualizar los cambios en caso de que sea indicado.
- Función borrar hoja:
Permite eliminar una hoja del archivo Excel con el que se desea interactuar.
En el primer parámetro se debe indicar el nombre de la hoja que se desea borrar. Es posible ingresar una variable o una constante, así como también un numero para eliminar hojas por índice si el usuario lo desea.
- Función copiar hoja:
En el parámetro 1 se debe ingresar el nuevo nombre que tendrá la hoja a copiar, este parámetro es obligatorio.
El parámetro 2 refiere a la posición en donde se desea colocar la nueva hoja, por defecto siempre será al final de todas las hojas existentes.
El parámetro “hoja” es obligatorio y corresponde al nombre de la hoja que se desea copiar, por defecto siempre será la primera hoja de la planilla.
Este comando también permite copiar el contenido entero de una carpeta en lugar de realizar esta acción con archivos individualmente. Para esto se debe indicar como origen la ruta a la carpeta cuyo contenido se desea copiar.
- Función ordenar:
Esta función permite ordenar filas en un archivo Excel. Funciona de la misma manera que cuando se selecciona en Excel la opción ordenar de A-Z ó Z-A para un rango de celdas en una hoja específica.
Parámetro 1: Rango a ordenar
Parámetro 2: Columna el cual se basa para ordenar
Parámetro 3: Indicar si se quiere ordenar de A-Z o Z-A (solo se ordenará de Z-A si se pone este valor, cualquier otro valor que no sea este se tomará como A-Z)