Spreadsheet Export builder inputsAdded by IBM on June 28, 2011 | Version 1 (Original)
|This topic describes the inputs for the Spreadsheet Export builder.
This topic describes the inputs for the Spreadsheet Export builder.
XML Element Handling
Table 1. General inputs
|Name||Required. Enter a name for this builder call. The WebSphere® Portlet Factory Designer displays this name in the builder call list.|
|Export File Name||Specify the file name to be used for the exported spreadsheet content. If you do not specify a file name, the value spreadsheet_data is used. If you do specify a file and extension, no extension is applied.|
|Data Export||Required. Select a source of the data to export. You can choose: |
Export From Page Element
To export the contents of a named element on a page defined in your model. Typically, this page element contains data created by another builder (Data Page). For the export to be performed correctly, the content must be structured as an HTML table so that the builder can transform rows and columns in the table into corresponding rows and columns in the exported spreadsheet.Export From Indirect Reference
To export the content of a schema-typed source such as a variable in the model. As with page element sources, the XML content of the indirect reference must be structured as an HTML table. You should also review the input available in the XML Element Handling group for a way to have the builder automatically convert arbitrary table-like XML into HTML tables prior to export.
|Source Page||This input is available when Export From Page Element is selected for the Data Export input. |
Use this input to identify the page in your model that contains HTML table data to be exported by the builder.
|Source Element||This input is available when Export From Page Element is selected for the Data Export input. |
Use this input to identify the element on the selected page that contains the HTML table data to be exported as a spreadsheet file.
|Source Reference||This input is available if Export From Indirect Reference is selected for the Data Export input. |
Use this input to specify the indirect reference that provides the XML content to be exported.
|Header Lookup Table||This input is available if Export From Indirect Reference is selected for the Data Export input. |
Select one name from the names of the Lookup Table builder calls in the model. The builder generates a header row that uses the specified Lookup Table builder call inputs to derive labels for each column. The labels and values in the Lookup Table builder call must match the XML element names in the exported data. The case of the names must match. If an element name does not match a Lookup Table value, the element name is used as the column header label.
|Add Export Button/Link||Use this input to add a page control that, when clicked, causes your data to be exported. |
To use an image as an export buttonButton
To add an export button to the pageLink
To add an export link to the page.
|Export Button/Link Location||Specify the page or pages on which this builder call acts. The export button or link is placed on that location.|
If Export from Page Element is selected for the Data Export input, the page location should be on the same page where the data to be exported is displayed
|Image File||This input is available when Add Export Button/Link input is Image Button.|
Specify the image file which represents and initiates the spreadsheet Export operation.
Default Image File: /factory/images/tools/excel.gif
|Alt Image Text||This input is available when Add Export Button/Link is Image Button.|
This setting corresponds to the HTML image tag alt= and title= attributes. Enter the text to appear when the mouse pointer is placed over the image or when the image cannot be displayed.
|Export Button/Link Label||This input is available when Add Export Button/Link is Button or Link.|
Enter a label that is to be displayed as the text of the export button or link.
Example: Export Sales Data Worksheet
|Document Format||Specify one of the following choices to set the MIME type for the document that is being exported.|
Generates a .XLS file.OpenDocument
Generates a .ODS file. CSV
Generates an ASCII file in comma-separated value (CSV) format.
Note: CSV export is only supported from an indirect reference (Export from Indirect Reference is selected for the Data Export input). You cannot use a page element as the source data and export to a CSV format.
XML Element Handling
This input group is available if the Data Export
input is Export From Indirect Reference
Table 2. XML Element Handling input
|Table Element Names||This input determines how the builder handles XML-based data from an indirect reference when the export is run. If you are exporting custom XML data from an indirect reference, enter a comma-delimited list of XML element names that should be treated as table-like structures. The default values (ExcelContent, RowSet, SearchResults, ViewData) are set to handle various XML documents that the data integration builders produce. |
Before the builder performs an export, it looks for the named elements and converts them to HTML tables. If the indirect reference does not return an XML document, this input is ignored at runtime.
Parent topic: Spreadsheet Export builder