TAST DokuWiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Adaptador de Archivos de Excel ======


===== Configuración =====

En el proceso de inicialización, el Adaptador de Excel intentará leer y analizar la hoja de Excel indicada por el parámetro NumSheet.

El adaptador llamará automáticamente a la función GetExcelSheet, de esta manera el usuario puede operar sobre los datos sin dibujar un mensaje GetExcelSheet en el diagrama.

===== Parámetros de Inicialización =====

  * **FilePath:** representa la ruta completa y el nombre del archivo de Excel que se trata en esta instancia del adaptador de Excel.
  * **Password(Opt.)**: indica la contraseña con la que se protegerá el fichero Excel. Es un parámetro opcional.
  * **NumSheet:** indica el número de la hoja dentro del libro de Excel en el que queremos trabajar.
  * **Template:** si se ha registrado, el archivo se creará o sobrescribirá en cualquier caso, independientemente de si se ha registrado la casilla de verificación "Crear/sobreescribir".
  * **Template File:** este es el nombre del archivo de plantilla utilizado para crear el archivo de Excel para las pruebas. En caso de que la casilla de verificación Template (véase arriba) esté registrada, este campo es obligatorio.
  * **Create/Overwrite:**  cuando la casilla de verificación está marcada, TAST creará un nuevo archivo o lo sobrescribirá si el archivo ya existe.
  * **Use first line as column name:** marcar esta casilla hace que se salte la primera fila de cualquiera de las funciones usadas, y esta se cuenta como el nombre de las columnas. Si buscas la celda en la Columna 1 y fila 1, se mostrará la celda en la Columna 1 y fila 2 en su lugar.




===== Funciones =====


  * **addSheet:** agrega una nueva hoja con el nombre que el usuario pone como parámetro.

  * **clearCell:** permite al usuario eliminar el valor de una celda en la hoja de Excel activa en el adaptador. Los parámetros row y num indican la celda.

  * **clearCellByColumnName:** permite al usuario eliminar el valor de una celda en la hoja de Excel activa en el adaptador. Los parámetros row y columnName indican la celda, siendo columnName el valor de la primera celda en la columna que se quiere seleccionar.

  * **deleteSheet:** permite al usuario eliminar una hoja del libro de trabajo. Usando el nombre o índice de la hoja para ello como parámetros de entrada. Devuelve una variable booleana para indicar el resultado de la operación. Si la hoja eliminada es la que está actualmente activa en el adaptador, entonces la primera hoja del libro pasa a ser la hoja activa.

  * **generateFileAsEvidence()**: genera una copia del archivo Excel en su estado actual para añadirlo como evidencia.

  * **getActiveSheetIndex**: nos devuelve la pestaña que está activa en ese momento.

  * **getCellValue(CellReference):**  esta función devuelve el valor de una celda con la referencia de dicha celda (por ejemplo: C7, C12, D2…); acepta la referencia de la celda tanto en minúsculas como mayúsculas.

  * **getColumnByRowSearch():** devuelve una cadena TastDataString, que contiene el valor de la columna indicada a recuperar, si el valor coincide con el parámetro searchColumn. Como parámetros de entrada tenemos (SearchRow, SearchValue y ColumnToRetrieve).

  * **getExcelSheet(numSheet):** lee la hoja de cálculo de Excel indicada por el parámetro NumSheet y devuelve los resultados como una variable de tipo TastTableData al sistema para permitir trabajar con los datos en los pasos posteriores del diagrama.

  * **getNumColumns():** devuelve el número de columnas de la TastTableData generadas al leer la hoja de Excel. Si introduces nuevas columnas y luego vuelves a contarlas, hay que poner un setSheet antes para que las cuente. No necesita parámetro de entrada.

  * **getNumRows():** devuelve el número de filas de la TastTableData generadas al leer la hoja de Excel. Si introduces nuevas filas y luego vuelves a contarlas, hay que poner un setSheet antes para que las cuente. No necesita parámetro de entrada.

  * **getNumValueSearchOnColumn:** permite al usuario buscar un valor en la columna seleccionada y devuelve el número de veces que el valor aparece en la columna. En el mapeo el usuario pone el valor a buscar en el campo SearchValue y el número de columna en el campo Columna.

  * **getNumberOfSheets**: nos devuelve el número de hojas.

  * **getRowByColumnSearch():** devuelve un TastTableData, que contiene el subconjunto de filas en las que la columna tiene el valor indicado. Como parámetros de entrada contamos con un SearchColumn para buscar la columna y el valor con un SearchValue.

  * **getTableValue(RowNum, ColNum):** devuelve el valor contenido en la celda indicada por el parámetro Posición que se llena con los valores RowNum y ColNum.

  * **getTableValueByColumnName():** permite recuperar el valor de una celda de la hoja Excel, indicando como parámetros el nombre de la columna (ColName) y el número de fila a recuperar (RowNum).

  * **getValuesByPosition():** devuelve un array de valores correspondientes a las posiciones de las celdas indicadas por los parámetros. 

  * **newFile(FilePath):** crea o sobrescribe un archivo, con la ruta y el nombre indicados por el parámetro filePath.\\ Si el archivo no existe, TAST lo creará, como un archivo vacío.\\ Si el archivo existe, TAST eliminará el archivo actual y creará uno nuevo vacío.

  * **setCellValue(CellReference, value):** esta función introduce el valor en una celda con la referencia de dicha celda (por ejemplo: C7, C12, D2...), acepta la referencia tanto en minúsculas como mayúsculas.

  * **setCellValueOneParameter()**: lo mismo que el setCellValue, pero en un parámetro en lugar de dos. Formato: cellReference; cellValue.

  * **setColumnValues():** genera los valores de la columna en el archivo Auxiliar Excel, basado en el valor indicado por los parámetros Columna (los parámetros de entrada son ColNum y ValueCell), valor1, valor2, etc.  

  * **setHeader():** genera los encabezados de la fila 1 del archivo de Excel", basado en el valor indicado por los parámetros ValueHeader1, ValueHeader2, etc.

  * **setRowValues():** genera los valores de la fila en el archivo Auxiliar Excel, basado en el valor indicado por los parámetros Fila (los parámetros de entrada son RowNum y ValueCell), valor1, valor2, etc. 
   
  * **setSheet:** permite al usuario seleccionar la hoja que estará activa en el adaptador. Una vez configurada la hoja como activa, todas las funciones de lectura y escritura ejecutadas, funcionarán en la hoja seleccionada. Tiene un parámetro de entrada (Name).

  * **setTableValue():** genera el valor de la celda en el archivo Auxiliar Excel, basado en el valor indicado por los parámetros  RowNum, ColNum y ValueCell. El parámetro "Use first line as column name" no se tiene en cuenta en esta función.

  * **vTableLookUp():** devuelve un TastDataString, que contiene los valores de la columna indicada a recuperar, por cada fila que coincida con la condición. Los parámetros de entrada en este caso serían ColToSearch, ValueToSearch y ColToRetrieve.

  * **vTableLookUpArray():** devuelve un TastRowtableData, que es una lista de valores ubicados en la columna indicada para recuperar, por cada fila que coincida con la condición. Los parámetros de entrada en este caso serían ColToSearch, ValueToSearch y ColToRetrieve.
TAST DokuWiki

User Tools

Site Tools

Page Tools
