Cub XML Imports

This page describes how to configure an XML-based import to use Cub-style output.

(Also this will let your XML import accept XLSX files.)

Verification

This assumes you already have an XML-based import.

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

1. Log into Aspen as an administrator
2. Click the "Tools" tab
3. Click the "Imports" side tab
4. Navigate to the import 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 Import

1. Click the "Tools" tab
2. Click the "Imports" side tab
3. Navigate to the import 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.XmlDefinitionImportCub, but replace "Cust191013" with whatever your exact jar ID is.

Input Parameters

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

<tool-input allow-school-select="false" district-support="false">
  <input name="saveBehavior" data-type="string" display-type="select" display-name="Save Behavior" default-value="saveZeroErrors" required="true">
    <option value="saveNever" display-name="Don't Save Any Changes" />
    <option value="saveAlways" display-name="Save All Possible Changes" />
    <option value="saveZeroErrors" display-name="Only Save If Error-Free" />
  </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>