File panel

Pentaho Data Integration
Version
9.3.x
Audience
anonymous
Part Number
MK-95PDIA003-15

This panel includes fields for choosing the result file name, extension, and timestamp information. If the data is split over a number of rows, multiple files are created. You can also preview the results from this panel.

Field Description
Filename Specify name and location of the Excel file in which to write the incoming rows from PDI. Variables or parameters can be used in this field. Do not include a file extension when the date and time are to be appended and the Extension option is specified.
Extension

Select the Excel file extension to append to the file name. Options include:

  • .xls [Excel 97 and above]
  • .xlsx [Excel 2007 and above]

The default extension is .xls.
Stream XSLX data (check box)

Select this option when writing large XLSX files to the output file.

  • Select this option if you want to stream XLSX files. When you select this check box, the system uses a streaming API to write large files without any memory restrictions (not exceeding MS Excel's limit of 1,048,575 rows and 16,384 columns).
  • Clear this check box if you do not want to stream XLSX files.

This option is only available if you select the '.xlsx [Excel 2007 and above]' option in the Extension field above.
Split every ... data rows Specify a positive number to create a new output file every 'n' data rows. For example, if you want to split the file every 200 data rows, then enter 200 in this field. The files will be numbered.
Include stepnr in filename? (check box)

Select this option to include the copy number in the file name (_0, for example) when you run the step in multiple copies, such as launching several copies of a step simultaneously.

  • Select this option to append a copy number to the file name when multiple copies are launched.
  • Clear this option to keep the file name as is when multiple copies are launched. A copy number will not be appended.
Include date in filename? (check box)

Select this option to include the system date in the file name, such as in the format _20181231, for example.

  • Select this option to append the system date to the file name.
  • Clear this option to keep the file name as is. The system date will not be appended.
Include time in filename? (check box)

Select this option to include the system time in the file name, such as in the format _235959, for example.

  • Select this option to append the system time to the file name.
  • Clear this option to keep the file name as is. The system time will not appended.
Specify Date time format? (check box)

Select this option to include the date and time in the file name using a format from the Date time format field below.

  • Select this option to append the system date and time to the file name.
  • Clear this option to keep the file name as is. The system date and time will not be appended.
Date time format From the list, select the date and time format you want to include in the file name. See Common Formats for information on valid date and time formats you can use in this step.
Show filename(s)... (button) Click to display a list of the files which will be generated.
If output file exists

If the output file already exists, decide if you want to replace it with the new file or keep the original file.

  • Use existing file for writing: Keep the existing output file and write the new data to it.
  • Replace with new output file: Overwrite the existing output file with the new output file created in this transformation step.
Wait for first row before creating file (check box)

If this option is selected, the step creates the file only after it has detected a row. If this option is cleared, the output file is always created, regardless of whether rows are actually written to the file or not.

  • Select this option if you want this step to create the output file only after the system detects a row for writing to the file. If no rows are detected, no file will be created.
  • Clear this option if you want to always create the output file, regardless of whether rows are actually written to the file.
Add filenames to result (check box)

Using this option adds file names to the MS Excel output file.

  • Select if you want to add file names to the Excel output file.
  • Clear if you do not want to add file names to the Excel output file.