Exporting Data to an Excel File
The Export to Excel task exports datasets or other Rulex structures to a series of Excel sheets within an Excel file.
Prerequisites
the required datasets have been imported into the process.
Additional tabs
The following additional tabs are provided:
Remote connections tab where you can configure the connection to the remote location where the file will be exported.
Documentation tab where you can document your task
Parametric options tab where you can configure process variables instead of fixed values. Parametric equivalents are expressed in italics in this page (PO).
File format where you can configure the exact format of the output file.
Procedure
Drag and drop the Export to Excel task onto the stage.
Connect a task, which contains the data you want to export, to the new task.
Double click the Export to Excel task.
Configure the task options as described in the table below in the Options and File Format tabs.
Save and compute the task.
Export to Excel File options | ||
Parameter Name | PO | Description |
---|---|---|
Data to be exported | reflist | Select what type data you want to export from the list of options. Possible options are:
|
Mode | mode | Select how you want to save the file, either by storing it in a location you will then specify, by sending the file as an e-mail or both ways. If you select to send the file by e-mail, you must then specify the e-mail address in the Recipients for export via email edit box. |
Export URI | uri | Select whether the file will be saved locally (Local File System) or remotely (SharePoint, HDFS, AWS S3, FTP, Azure Storage). If you chose to save the file remotely you must also configure the Remote Connection parameters in the Remote Connections tab. |
Directory | dirname | Enter or browse to the directory where the file will be saved. |
File basename | basename | Enter a name for the name that will be given to the exported file. If you are exporting to a Azure Storage repository you can either:
|
Sheet name | sheetname | The name of the sheet where the dataset will be exported. If left blank, the default name "Dataset" will be used for the sheet. |
Append a sheet to the file, it it exists | apppendfile | If selected, a sheet will be appended to the file, if a file corresponding to the specified basename already exists. Be aware that if you export another dataset, with the same file basename, the same sheet name and with this option selected you will overwrite the original sheet with the new exported sheet. |
Add current date and time as prefix | timestampprefix | If selected, the date and timestamp will be added to the start of the file basename as a prefix |
Add current date and time as suffix | timestampsuffix | If selected, the date and timestamp will be added to the end of the file basename as a suffix |
Recipients for export via email (use comma as separator) | recipients | Specify the email addresses where the exported file will be sent, separated by commas. This option will only be valid if you have selected Send via email or Both in the Mode option. |
Export to Excel File - File Format options | ||
Write attribute names | writenames | If selected, the attribute names will be included in the exported excel file. |
Write attribute types | writetypes | If selected, the attribute types will be included in the exported excel file. |
Write covering statistics (only for Rules) | writecov | If selected covering statistics for rules will be added to the exported excel file. |
Write error statistics (only for Rules) | writeerr | If selected error statistics for rules will be added to the exported excel file. |
Write condition covering statistics (only for Rules) | writeccov | If selected covering statistics for conditions will be added to the exported excel file. |
Write condition error statistics (only for Rules) | writecerr | If selected error statistics for conditions will be added to the exported excel file. |
Rule format (only for Rules) | ruleformat | Select whether you want the rule data to be expressed as If-then rules or as a matrix (C-like). |