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 Ficheros de Texto ======



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

  * **FilePath:** La ruta completa, incluido el nombre del archivo representado por el adaptador en el diagrama.
  * **CharSet:** El conjunto de caracteres usados en el archivo a tratar. Por ejemplo, si usas ficheros para probar ficheros Webservices, el charset suele ser UTF-8. Si usas ficheros de Windows descargados a través de FTP/SFTP el charset suele ser CP1252. El Cp1047 es usado por defecto.\\ \\ **IMPORTANTE**: Es muy importante seleccionar correctamente el charset del fichero, porque el retorno de carro se interpreta de forma diferente según el charset seleccionado y esto puede impactar en todas las funciones predefinidas que gestionan el fichero de texto en TAST.\\ \\ Para seleccionar el charset correcto del fichero puedes identificarlo en el editor de texto de la siguiente forma:


{{:en:charset_example.png?700|}}


  * **Create/Overwrite:** Cuando el check está seleccionado, TAST creará un Nuevo fichero o lo sobrescribirá si ya existe. 



===== Funciones =====

  * **closeFile():** Cierra el archivo y libere los recursos asociados. Devuelve true si el archivo puede cerrarse correctamente o falso de lo contrario. No requiere parámetros de entrada.

  * **containsText(SearchString):** Devuelve verdadero si el valor de la cadena de texto del parámetro searchString existe en el archivo, de lo contrario es falso.

  * **countFileLine():** Devuelve el número de líneas del fichero. No requiere parámetros de entrada. 

  * **countTextFile():** La función cuenta el número de veces que una string aparece en un fichero. Cuenta con un parámetro searchString para buscar y realizar la comparación.

  * **deleteFtpFile():** Borra un fichero de un servidor FTP. Devuelve si la operación ha tenido éxito o no. Como parámetros de entrada tenemos:
       *El parámetro Host indica la dirección de la máquina remota donde reside el archivo.
       *El parámetro User indica el usuario de la conexión al sistema remoto.
       *El parámetro Password indica la contraseña del usuario en el sistema remoto.
       *El parámetro RemotePath indica la ruta en el sistema remoto del archivo que queremos transferir.
       *El parámetro LocalPath representa la ruta donde queremos transferir el archivo.
       *El parámetro Port determina el puerto del servidor.

  * **deleteSftpFile():** Borra un fichero de un servidor SFTP. Devuelve si la operación ha tenido éxito o no. Como parámetros de entrada tenemos:
       *El parámetro Host indica la dirección de la máquina remota donde reside el archivo.
       *El parámetro User indica el usuario de la conexión al sistema remoto.
       *El parámetro Password indica la contraseña del usuario en el sistema remoto.
       *El parámetro RemotePath indica la ruta en el sistema remoto del archivo que queremos transferir.
       *El parámetro LocalPath representa la ruta donde queremos transferir el archivo.
       *El parámetro Port determina el puerto del servidor.

  * **generateFileAsEvidence():** La función genera una copia del fichero txt en su estado actual, para ser añadido como evidencia.

  * **getFileText():** Lee el contenido del fichero y lo retorna como una variable TastDataString. No requiere parámetros de entrada.	

  * **getFtpFile(Host, User, Password, RemotePath, LocalPath):** Permite transferir un archivo a través del protocolo Ftp de un sistema remoto al sistema local en el que se ejecuta el diagrama. 
        * Devuelve verdadero si la operación finaliza con éxito, de lo contrario, falso. 
        * El parámetro Host indica la dirección de la máquina remota donde reside el archivo. 
        * El parámetro User indica el usuario de la conexión al sistema remoto. 
        * El parámetro Password indica la contraseña del usuario en el sistema remoto. 
        * El parámetro RemotePath indica la ruta en el sistema remoto del archivo que queremos transferir.
        * El parámetro LocalPath representa la ruta donde queremos transferir el archivo.

  * **getLineLength(lineNum):** Devuelve la longitud de la línea de archivo indicada por el parámetro lineNum.

  * **getNumColumns():** Devuelve el número de columnas contenidas en TastTableData que fue generado mediante la ejecución de la función loadCsvFile. **Requiere la ejecución de la función loadCsvFile en los pasos anteriores del diagrama**.

  * **getOwner():** Devuelve el propietario del fichero en el sistema de archivos. No requiere parámetros de entrada.

  * **getReadLine(lineNum):** Devuelve una variable de tipo String al ejecutor con el contenido del número de línea indicado por el parámetro lineNum.

  * **getSftpFile(Host, Port, User, Password, RemotePath, LocalPath):** Permite transferir un archivo a través del protocolo Sftp de un sistema remoto al sistema local en el que se ejecuta el diagrama.
      * Devuelve verdadero si la operación finaliza con éxito, de lo contrario, falso.
      * El parámetro Host representa la dirección del equipo remoto donde reside el archivo.
      * El parámetro Port representa el número de puerto en el que el servidor SFTP escucha las conexiones entrantes. El SFTP toma el puerto 22 por defecto.
      * El parámetro User representa el usuario de la conexión al sistema remoto.
      * El parámetro Password representa la contraseña del usuario en el sistema remoto
      * El parámetro RemotePath representa la ruta en el sistema remoto al archivo que queremos transferir.
      * El parámetro LocalPath representa la ruta, en el sistema de archivos local, donde queremos transferir el archivo.

  * **getSize():** Devuelve el tamaño del fichero en KiloBytes. No requiere parámetros de entrada.

  * **getTableValue(RowNum, ColNum):** Devuelve el valor contenido de la celda indicada por los parámetros RowNum y ColNum. **Requiere la ejecución de la función loadCsvFile en los pasos anteriores del diagrama**.

  * **getTextFileData():** Almacena el contenido del fichero en un array y otro fichero para futuras operaciones. No requiere parámetros de entrada. 

  * **lineContainsText(lineNum, StringToSearch):** Devuelve verdadero si la cadena de texto introducida en el parámetro StringToSearch existe en la línea del archivo indicada por el parámetro lineNum, y falso en caso contrario.

  * **loadCsvFile(Separator):** Lee el contenido de un archivo de tipo csv y lo transforma en una variable TastTableData con la que podamos operar sobre los datos en los siguientes pasos del diagrama. El parámetro separator indica el carácter separador de los campos en el archivo.

  * **newFile(FilePath):** Crea o anula 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 borrará el archivo actual y creará un nuevo archivo.

  * **openFile():** Comprueba la existencia del archivo en el sistema de ficheros y los permisos de lectura/escritura del mismo. Devuelve verdadero si al archivo se puede acceder correctamente o falso en caso contrario. No requiere parámetros de entrada.

  * **openNewFile():** Restablece el contenido del archivo configurado a vacío. Este archivo debe existir. No requiere parámetros de entrada.

  * **putFtpFile(Host, User, Pasword, LocalFileName, RemoteFileName, HostDirectory):** Permite transferir un archivo, mediante el protocolo Ftp, del sistema local en el que se ejecuta el diagrama al sistema remoto.         
        * Devuelve verdadero si la operación finaliza con éxito, de lo contrario, falso.
        * El parámetro Host representa la dirección del equipo remoto donde reside el archivo.
        * El parámetro User indica el usuario de la conexión al sistema remoto.
        * El parámetro Password indica la contraseña del usuario en el sistema remoto.
        * El parámetro LocalFileName representa la ruta completa al archivo en el sistema local.
        * El parámetro RemoteFileName representa el nombre del archivo en el sistema remoto.
        * El parámetro HostDirectory representa el directorio, en el sistema de archivos remoto, donde queremos transferir el archivo.

  * **putSftpFile(Host, Port, User, Password, LocalPath, RemotePathFormed):** Permite transferir un archivo, mediante el protocolo Sftp, del sistema local en el que se ejecuta el diagrama al sistema remoto.
      * Devuelve verdadero si la operación finaliza con éxito, de lo contrario, falso.
      * El parámetro Host indica la dirección de la máquina remota donde reside el archivo.
      * El parámetro Port representa el número de puerto en el que el servidor SFTP escucha las conexiones entrantes. El SFTP utiliza el puerto 22 por defecto.
      * El parámetro User indica el usuario de la conexión al sistema remoto.
      * El parámetro Password indica la contraseña del usuario en el sistema remoto.
      * El parámetro LocalPath representa la ruta completa y el nombre del archivo en el sistema local.
      * El parámetro RemotePathFormed representa la ruta completa y el nombre del archivo en el sistema remoto.

  * **replaceText(From_Str, To_Str):** Permite sustituir todas las ocurrencias de la cadena "From_Str" por la cadena "To_Str", y guardará el archivo de nuevo.

  * **writeEnter:** La función añade un salto de línea al fichero. No requiere parámetros de entrada. 

  * **writeTo(StringToWrite):** Escriba la cadena de texto en el archivo, al final del mismo. 
      * Devuelve verdadero si la operación de escritura fue exitosa, de lo contrario, falsa. Los parámetros de entrada son stringToWrite para recibir la cadena de texto y addBreakLine para saltar o no la línea (siendo un Boolean).
TAST DokuWiki

User Tools

Site Tools

Page Tools
