Description

The ExcelFileReceiver morphs generated data into a formatted Excel file. The Excel file format may be specified as xlsx or xls within the parameter configuration. Additional formatting options are available for specifying the characters used for quoted text, the masking format for Boolean objects, and NULL values within the generated output file. 


Parameters

The following parameters can be defined for the ExcelFileReceiver. Items with an asterisk (*) are required: 

  • *path - Defines the location to store the newly generated Excel output file.
  • *fileName - Defines the name of the output file.
  • uniqueAttribute - Defines a Domain Attribute the Receiver will use to identify a unique value that has already been inserted into the file and prevents it from being inserted twice.
  • *quoteTextData - Defines the character to be used for text data that will be contained in quotes (single or double).
  • *booleanValue - Defines the format of a Boolean object with a selected mask (true/false, yes/no, etc.).
  • *nullValue - Defines the value that will be placed in the output file for a NULL value. 
  • *type- Defines the Excel file format for the output file:
    • xlsx
    • xls



Property Keys

The Receiver defines two property keys that can be modified on any of its associated Domain Attributes:

  • columnName - Defines the column name as it will be output in the delimited file header.
  • include - Determines if the Attribute will be included as a column in the output.



Example Stories

The example stories below, show different use cases where the ExcelFileReceiver is used to morph generated data into an Excel output file. In some cases, the parameters or property key values determine the behavior of the Receiver and how or if data within a given fixed file, are updated. 


All of the example stories below share the same configuration for the id Attribute property key , which has been set to false and will will not appear in the generated output file.



Story 1 - Generate a User Data Excel File with Capitalized Column Names

This example shows how to output Domain Attribute values for user data to an Excel file (xlsx). Each column name in the generated output file will be capitalized. 


Receivers Parameters

For this example, all Receiver parameters have been left as their default value. User Data has been entered for the fileName parameter.


Receivers Property Keys

The columnName property key has been altered for every Attribute except the id Attribute. 


Output File