Files | ||
---|---|---|
Previous | Next | |
Preface | Internet and Networking |
File actions perform operations in the runtime engine file system.
Certain actions can store the list of the files they manipulated. To perform this storage, provide a
SQL Connection to the action or define a metadata link on the action to use this metadata’s connection. A table named
IND_SESSION_FILE_OP_LST
is automatically created and maintained in this connection to store the various file operations performed.
Moves a set of files on the runtime engine file system. This action also allows to store in a table the list of moved files.
Name | Mandatory | Default | Description |
---|---|---|---|
File To Dir | Target directory. Mandatory if File to File is not set. | ||
File To File | Target file. Mandatory if File to Dir is not set. | ||
File From Dir | Source directory. Use with File Includes and File Excludes. | ||
File From File | Source file. | ||
File Overwrite Mode | No | NOT | Overwrite behavior. NOT: Never overwrite. ALWAYS: Always overwrite, NEWER: Overwrite older file, AFTER_DELAY: overwrite only files older by more than File Overwrite Delay (milliseconds). |
File Overwrite Delay | No | 0 | Delay in milliseconds after which the file is considered older. Used with File Overwrite Mode = AFTER DELAY. |
File Includes Empty Dirs | No | False | In recursive mode, defines whether empty directories are moved. |
File Flatten Model | No | False | In recursive mode, defines whether the directory hierarchy is flattened. |
File Preserve Last Modified | No | False | If set to yes, the original update date of the file is preserved. |
File Includes | No | List of files to include. This is a semi-colon separated list of file masks. For example:
*.xls; *.xml; file.csv .
|
|
File Excludes | No | List of files to exclude. This is a semi-colon separated list of file masks. For example:
*.xls; *.xml; file.csv .
|
|
File Target Mapper | No | Correspondence mask for file names. For example:
*.txt = BI*.txt .
|
|
File Target Mapper Type | No | Type of the file target mapper (regexp of glob). | |
SQL Connection | No | SQL connection into which the list of moved files is published. | |
SQL Transaction Name | No | SQL transaction into which the list of moved files is published. | |
SQL Schema Name | No | SQL schema into which the list of moved files is published. |
Name | Description |
---|---|
FILE_NB | Number of files moved. |
Copies a set of files on the runtime engine file system. This action also allows to store in a table the list of copied files.
Name | Mandatory | Default | Description |
---|---|---|---|
File To Dir | Target directory. Mandatory if File to File is not set. | ||
File To File | Target file. Mandatory if File to Dir is not set. | ||
File From Dir | Source directory. Use with File Includes and File Excludes. | ||
File From File | Source file. | ||
File Overwrite Mode | No | NOT | Overwrite behavior. NOT: Never overwrite. ALWAYS: Always overwrite, NEWER: Overwrite older file, AFTER_DELAY: overwrite only files older by more than File Overwrite Delay (milliseconds). |
File Overwrite Delay | No | 0 | Delay in milliseconds after which the file is considered older. Used with File Overwrite Mode = AFTER DELAY. |
File Includes Empty Dirs | No | False | In recursive mode, defines whether empty directories are copied. |
File Flatten Model | No | False | In recursive mode, defines whether the directory hierarchy is flattened. |
File Preserve Last Modified | No | False | If set to yes, the original update date of the file is preserved. |
File Includes | No | List of files to include. This is a semi-colon separated list of file masks. For example:
*.xls; *.xml; file.csv .
|
|
File Excludes | No | List of files to exclude. This is a semi-colon separated list of file masks. For example:
*.xls; *.xml; file.csv .
|
|
File Target Mapper | No | Correspondence mask for file names. For example:
*.txt = BI*.txt .
|
|
File Target Mapper Type | No | Type of the file target mapper (regexp of glob). | |
SQL Connection | No | SQL connection into which the list of copied files is published. | |
SQL Transaction Name | No | SQL transaction into which the list of copied files is published. | |
SQL Schema Name | No | SQL schema into which the list of copied files is published. |
Name | Description |
---|---|
FILE_NB | Number of files copied. |
Deletes a set of files in the runtime engine file system. This action also allows to store in a table the list of deleted files.
Name | Mandatory | Default | Description |
---|---|---|---|
Del Dir | Directory to Delete. Use with Del Includes and Del Excludes. | ||
Del File | File to Delete. Note that both Del Dir and Del File can be used simultaneously. This will cause the two delete operations. | ||
Del Includes | No | List of files to include. This is a semi-colon separated list of file masks. For example:
*.xls; *.xml; file.csv
|
|
Del Excludes | No | List of files to exclude. This is a semi-colon separated list of file masks. For example:
*.xls; *.xml; file.csv
|
|
Del Fails on Error | No | True | The action completes in error state if a file cannot be deleted. |
Del Include Empty Dirs | In recursive mode, defines whether empty directories are deleted | ||
SQL Connection | No | SQL connection into which the list of deleted files is published. | |
SQL Transaction Name | No | SQL transaction into which the list of deleted files is published. | |
SQL Schema Name | No | SQL schema into which the list of deleted files is published. |
Name | Description |
---|---|
FILE_NB | Number of files deleted. |
Creates a file in the runtime engine file system and writes a text in this file.
The text written in this file is the text entered in the
Code of the action (in the expression editor).
Name | Mandatory | Default | Description |
---|---|---|---|
Txt Write Filename | Yes | Full path of the file to write. | |
Txt Write Newline Char | No | Line separator. Can be for example ‘\n’ or ‘\r\n’ or any string | |
Txt Write Encoding | No | Java charset of the file. The system charset is used by default. | |
Txt Write Append | No | False | If the file exists, append the text to it. |
Txt Write Append Line Separator | No | True | Automatically add a line separator at the end of the file. |
Creates a directory in the runtime engine file system. This action also allows to store in a table the created directory.
Name | Mandatory | Default | Description |
---|---|---|---|
File Dir | Yes | Full path of the directory to create. | |
File Fails on Error | No | False | The action completes in error state if a directory cannot be created. |
SQL Connection | No | SQL connection into which the created directory is published. | |
SQL Transaction Name | No | SQL transaction into which the created directory is published. | |
SQL Schema Name | No | SQL schema into which the created directory is published. |
Compresses a set of files in ZIP format in the runtime engine file system.
Name | Mandatory | Default | Description |
---|---|---|---|
Zip To File | Yes | Target file. | |
File From Dir | Yes | Source directory containing the files to compress. | |
Zip Includes | No | List of files to include. This is a semi-colon separated list of file masks. For example:
*.xls; *.xml; file.csv .
|
|
Zip Excludes | No | List of files to exclude. This is a semi-colon separated list of file masks. For example:
*.xls; *.xml; file.csv .
|
|
Zip Compress | No | True | If set to true, the archive is compressed. |
Zip Update | No | False | Update the zip file if it already exists. |
Zip Encoding | No | Zip file encoding. | |
Zip Action If Empty | No | Skip | Behavior when no file corresponds to the selection: fail the action, skip it or create the zip file anyway. |
Zip Action If Duplicated File | No | Add | Behavior when a file duplicate is found: fail the action, preserve the current file or add the new file. |
Zip Comment | No | Comment to add to the archive. | |
Zip Compression Level | No | -1 | Compression level. Can range from 0: No compression to 9:Maximum Compression |
Compresses a file in BZIP format in the runtime engine file system.
Name | Mandatory | Default | Description |
---|---|---|---|
BZip To File | Yes | Target file. | |
BZip From File | Yes | Source file to compress. |
Compresses a file in GZIP format in the runtime engine file system.
Name | Mandatory | Default | Description |
---|---|---|---|
GZip To File | Yes | Target file. | |
GZip From File | Yes | Source file to compress. |
Compresses a set of files in tar format in the runtime engine file system.
Name | Mandatory | Default | Description |
---|---|---|---|
Tar To File | Yes | Target file. | |
Tar From Dir | Yes | Source directory containing the files to compress. | |
Tar Includes | No | List of files to include. This is a semi-colon separated list of file masks. For example:
*.xls; *.xml; file.csv .
|
|
Tar Excludes | No | List of files to exclude. This is a semi-colon separated list of file masks. For example:
*.xls; *.xml; file.csv .
|
|
Tar Compression Method | No | none | Compression method used for the tarball file: none, gzip or bzip. |
Tar Longfile Method | No | warn | Behavior for files with long names (greater than 100 characters): truncate the name, fail the action or simply warn, omit the file or use GNU file extensions to store long file names in the archive. |
Uncompresses a ZIP file in the runtime engine file system.
Name | Mandatory | Default | Description |
---|---|---|---|
Unzip From File | Yes | File to uncompress. | |
Unzip To Dir | Yes | Target directory. | |
Unzip Encoding | No | Zip file encoding. | |
Unzip Overwrite | No | true | Set to true to overwrite existing files in the target directory. |
Uncompresses a file in BZIP format in the runtime engine file system.
Name | Mandatory | Default | Description |
---|---|---|---|
Bunzip From File | Yes | File to uncompress. | |
Bunzip To File | Yes | Target file. |
Uncompresses a file in GZIP format in the runtime engine file system.
Name | Mandatory | Default | Description |
---|---|---|---|
Gunzip From File | Yes | File to uncompress. | |
Gunzip To File | Yes | Target file. |
Uncompresses a TAR file in the runtime engine file system.
Name | Mandatory | Default | Description |
---|---|---|---|
Untar From File | Yes | File to uncompress. | |
Untar To Dir | Yes | Target directory. | |
Untar Compression Method | No | Compression method used for the tarball file: none, gzip or bzip. | |
Untar Overwrite | No | true | Set to true to overwrite existing files in the target directory. |
Waits and detects a set of files on the runtime engine file system using the poll technique. This action also allows to store in a table the list of detected files.
Name | Mandatory | Default | Description |
---|---|---|---|
Wait File Dir | Detection directory. Mandatory if Wait File is not set or if Wait File Includes/Excludes are set. | ||
Wait File | File to detect. Mandatory if Wait File Dir is not set. | ||
Wait File Includes | No | List of files to include. This is a semi-colon separated list of file masks. For example:
*.xls; *.xml; file.csv .
|
|
Wait File Excludes | No | List of files to exclude. This is a semi-colon separated list of file masks. For example:
*.xls; *.xml; file.csv .
|
|
Wait File Timeout | No | See description | Timeout in milliseconds after which the action stops trying to detect the files. -1 is an infinite waiting time. The default value is 1 if Wait File Nb Files=-1 and -1 otherwise. |
Wait File Pollint | No | 1000 | Polling interval in milliseconds. |
Wait File Nb Files | No | 1 | Number of files to wait for before completing the wait action. -1 means an infinite number of files. |
SQL Connection | No | SQL connection into which the list of detected files is published. | |
SQL Transaction Name | No | SQL transaction into which the list of detected files is published. | |
SQL Schema Name | No | SQL schema into which the list of detected files is published. |
Note: If this action is linked to a metadata schema, it will store in a table the list of detected files. In this case, the file names are stored when the detection criteria are met.
Name | Description |
---|---|
FILE_NB | Number of files detected. |
Concatenates a set of files on the runtime engine file system.
Name | Mandatory | Default | Description |
---|---|---|---|
Out File Name | Yes | Target concatenated file. | |
In File Mask | Yes | Mask of the files to concatenate. | |
Header Text | No | Header text to remove in each file. | |
Header Size | No | Number of header characters to remove in each file. | |
Footer Text | No | Footer text to remove in each file. | |
Footer Size | No | Number of footer characters to remove in each file. | |
Keep Header On First | No | True | Keep the header on the first file concatenated. |
Keep Footer On Last | No | True | Keep the footer on the last file concatenated. |
Append Mode | No | False | If the target file already exists, append the concatenated files to it. |
File Buffer Size | No | Size of the file buffer. | |
File Separator | No | System’s line break | ASCII separator written between each file content. It may be composed of several characters. \n, \r, \t and \f can be used to specify special characters. |
File Xseparator | No | Hexadecimal separator written between each file content. It may be composed of several characters. |
Name | Description |
---|---|
IN_NB_FILES | Number of files processed. |
OUT_FILE_SIZE | Size of the target file. |
Transforms an XML file into another XML file using a XSL-Transformation in the runtime engine file system.
Name | Mandatory | Default | Description |
---|---|---|---|
In File Name | Yes | Source XML file. | |
Out File Name | Yes | Target (transformed) XML file. | |
XSLT File Name | No | Name of the XSL-Transform file. |
Previous | Top | Next |
Preface | Internet and Networking |