Cub XML Exports

This page describes how to configure an XML-based export to use the Cub architecture so your exported file can use a CSV or XLS file extension.

Verification

This assumes you already have an XML-based export.

If you're not sure if your export is XML-based, follow these steps:

1. Log into Aspen as an administrator
2. Click the "Tools" tab
3. Click the "Exports" side tab
4. Navigate to the export you're interested in.
5. Click the pencil icon next to "XML definition". A new window should open that contains several lines of XML.
6. Click the pencil icon next to "Source code". A new window should open that is mostly empty.

Installing the Customizations Jar

Make sure you have a copy of the customizations jar available. Follow the steps on this page and copy the "Jar ID" to your clipboard.

Configuring XML Export

1. Click the "Tools" tab
2. Click the "Exports" side tab
3. Navigate to the export you're interested in.
4. Make sure your current field set includes the Jar Plugin ID field. (It is hidden by default, so the first time you try this you'll need to add that field.)
5. Set the Jar Plugin ID field to Cust191013:com.follett.cust.cub.XmlDefinitionExportCub, but replace "Cust191013" with whatever your exact jar ID is.

Input Parameters

This part is optional. Now that this is a Cub export, you can (if you want to) add these input parameters:

<tool-input allow-school-select="false" district-support="false">
  <input name="exportFileType" data-type="string" display-type="select" display-name="File Type" default-value="csv" required="true">
 	<option value="csv" display-name="CSV" />
 	<option value="html" display-name="HTML" />
 	<option value="json" display-name="JSON" />
 	<option value="xls" display-name="XLS" />
 	<option value="zip" display-name="ZIP" />
  </input>
  <input name="emailRecipients" data-type="string" display-type="text" display-name="Email to" required="false" default-value="" />
  <input name="showSummary" data-type="boolean" display-type="checkbox" display-name="Show Summary View" default-value="true" />
</tool-input>