Export to Word File task
The Export to Word file task exports datasets or other Rulex structures to a Word file.
Prerequisites
You must have created a flow;
The required datasets must have been imported into the flow.
Procedure
Drag the Export to a Word file task onto the stage.
Connect the task containing the data to export to it.
Double click the Export to Word file task.
Configure the task options as described in the table below in the Options and Export Options tabs.
Save and compute the task.
Export to a Word file options | |
---|---|
Parameter name | Description |
Data to be exported | Select what type data you want to export from the list of options. Possible options are:
|
Export mode | Select how you want to save the file, either by storing it in a location you will then specify (store file), by sending the file as an e-mail (send via email) or both. 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. |
Destination | You can choose between the Saved destinations (which can be set previously at environment level) and the Custom destinations, which have to be set by choosing the type from the drop down menu and clicking the pencil button to insert the details. Select whether the file will be saved locally (Local File System) or remotely (Http Remote API, Sharepoint, HDFS, AWS S3, FTP, Sftp Server, Azure BLOB Storage). If you chose to save the file remotely on a custom source, you must also configure the Remote Connection parameters in the Remote Connections tab by clicking on the pencil button. |
Files | Enter or browse to the directory where the file will be saved. |
File basename | Enter a name for the text file you want to export. If not specified, the name of the file will correspond to the upstream task in the flow. |
Export dataset as | You can choose how the data of your Word file are formatted:
|
Append data if the file already exists | If selected, the exported data will be appended to the file specified in the File basename option, if it already exists; otherwise the original data will be overwritten. |
Recipients for export via email (use comma as separator) | 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 options | |
Data separator | Select the data separator which delimits the values of the data to be exported in the output text file, by selecting comma, tabbing, semicolon, space or by specifying another separator. |
String for missing values | Enter the character (or string of characters) which should be used when there are empty values, for example Null or N/A. |
Text delimiter | Select the symbol used to identify strings. For example, if you select the symbol ” as the text delimiter, age will be exported as “age”. |
Put types in line | Specify the line where the attribute types will be saved. Specifying 0 means that the attribute type won’t be specified in the exported dataset. |
Put names in line | Specify the line where the attribute names will be saved. Its value is 1 by default, meaning that the headers will be placed in line 1. If 0 is specified, no attribute headers will be exported. |
If you want to export to a local filesystem, check the dedicated Local Filesystem page.