Upgrade Notes


Upgrading from 1.3 to 1.4

Major breaking changes

New pullreports-catalog-1.6.0.xsd

Release 1.4 contains a new pullreports-catalog-1.6.0.xsd schema file. Change the xmlns attribute in each Pull Reports™ XML Catalog file to the new value.

<catalog xmlns="http://www.pullreports.com/catalog-1.6.0"...>

Report Creator initialization change

Release 1.4 simplifies and improves the JavaScript initialization of the Report Creator. However, these improvements mean that Pull Reports™ 1.3 JavaScript initialization code will not work in 1.4. See the Report Creator Installation for instructions on how to correctly initialize the Pull Reports™ 1.4 creator.

Removal of catalogId and reportId initialization properties

Release 1.4 removes the catalogId and reportId Report Creator initialization properties. In order to open the creator to a specific <report>, see the section called “Linking to a Component” or use the new adHocCreatorParams initialization property.

creator dependency upgrades

Release 1.4 upgrades the following Report Creator JavaScript dependencies.

  • JQuery upgraded to 3.3

REST-API dependency upgrades

The following Java dependencies are upgraded.

  • org.codehaus.groovy:groovy-all to 2.4.16

Upgrading from 1.2 to 1.3

Major breaking changes

New pullreports-catalog-1.5.0.xsd

Release 1.3 contains a new pullreports-catalog-1.5.0.xsd schema file. Change the xmlns attribute in each Pull Reports™ XML Catalog file to the new value.

<catalog xmlns="http://www.pullreports.com/catalog-1.5.0"...>

Removed GET Global Label Value List REST API endpoint

Release 1.3 removes the GET Global Label Value List REST API endpoint because it was redundant with the GET Label Value List endpoint. This removal is unlikely to effect REST API users since the common use of the GET Global Label Value List REST API endpoint was within the Pull Reports™ Report Creator.

<subquery> provider attribute

The <subquery> factory attribute is renamed to provider. Additionally, the referenced class must implement SubqueryProvider.

Minor breaking changes

<export_config> defaultSort does not permit table path

The <export_config> element's defaultSort attribute no longer permits the base table path within the sort term list. Only @ prefixed column ids are valid.

Replace a defaultSort value defined like this:

<export_config defaultSort="/tablePath@columnId"/>

With the @ prefixed column id:

<export_config defaultSort="@columnId"/>

New <label_value_query_default> element

The <label_value_query> element now requires a SQL query within the element body. Use the new <label_value_query_default> element to configure a <column>'s label value list to contain the distinct set of values within the column.

Replace a <label_value_query> defined like this:

<column id="foo" name="bar" displayName="fooBar">
    <label_value_list>
        <label_value_query/>
    </label_value_list>
</column>

With a <label_value_query_default> like this:

<column id="foo" name="bar" displayName="fooBar">
    <label_value_list>
        <label_value_query_default/>
    </label_value_list>
</column>

GET Report Information API labelValueList property change

The GET Report Information API's column.labelValueList property is now a boolean instead of a string or a boolean.

This change relates to the removal of the GET Global Label Value List REST API endpoint and is unlikely to effect users.

Non-breaking changes

<relationship> cardinality default value

The <relationship> element's cardinality attribute now has a default value of many.

<relationship>s configured like this:

<relationship cardinality="many">...</relationship>

may now be configured like this:

<relationship>...</relationship>

REST-API dependency upgrades

The following Java dependencies are upgraded.

  • org.codehaus.groovy:groovy-all to 2.4.15