<url_template>

The value of the <url_template> element is a String which may include references to other column values via dollar sign prefixed curly brackets (${...}). Each reference will be substituted with the actual value of the column for each row of the export results at runtime. Only references to columns which are guaranteed to be available at report runtime are permitted. These include:

<column id="addressStreet" name="address_street" displayName="Street Address"> 
    <url_template>/addressLookup?id=${@!addressId}</url_template>
</column>

This example demonstrates two <url_template> elements, one associated with the <report>'s base table and one associated with a child <relationship>. The former demonstrates a hyperlink into an external URL and the latter demonstrates a hyperlink into another Pull Report within the same <catalog>.

<?xml version="1.0" encoding="UTF-8"?>
<catalog xmlns="http://www.pullreports.com/catalog-1.6.1" id="class_info" name="Class Information"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.pullreports.com/catalog-1.6.1
    https://www.pullreports.com/docs/xsd/pullreports-catalog-1.6.1.xsd">
    <report id="student" name="Student Report" >
        <export_config defaultColumns='id,complete_name'/>
        <table id="student" name="class_info.student" displayName="Student"> 
            <column id="id" name="id" displayName="Student ID" paramType="java.lang.Integer"/>
            <column id="complete_name" name="complete_name" displayName="Complete Name">
                <!--  ${@id} references column class_info.student.id. ${@@id} would also be valid. -->
                <url_template>https://www.school-district.com/rest/api/student/${@id}.html</url_template>
            </column>
            <relationship>
                <join_column columnName="student_id" referencedColumnName="id" />
                <table id="grade" displayName="Grade" name="class_info.grade">
                    <column id="id" name="id" displayName="Grade ID" paramType="java.lang.Integer" export="false"/>
                    <column id="grade" name="grade" displayName="Grade"/> 
                    <column id="year" name="year" displayName="Year" paramType="java.lang.Integer"> 
                        <!--  ${@!id} references column class_info.student.id. ${/student@!id} is also valid. 
                              ${@@!year} references column class_info.grade.year 
                              
                              Since both ${@!id} and ${@@!year} contain the "!" character after "@", the
                              value of the class_info.student.id and class_info.student.complete_name
                              column must be non-null for Pull Reports to output the URL. 
                              
                              Although it is not used in this <url_template> example,
                              ${@@id} would reference class_info.grade.id 
                        -->
                        <url_template><![CDATA[
                        //${request.serverName}/${request.contextPath}/pullreports/catalog/class_info/report/evidence/export?format=htmltable&columns=%2Fevidence&filter=%40student_id%3D${@!id}&filter=%2Fevidence%40year%3D${@@!year}
                        ]]></url_template>
                    </column>
                </table>
            </relationship>
        </table>
    </report>
    <report id="evidence" name="Grade Evidence Report" >
        <table id="student" name="class_info.student" displayName="Student"> 
            <column id="student_id" name="id" displayName="Student ID" paramType="java.lang.Integer"/>
            <column id="complete_name" name="complete_name" displayName="Complete Name"/>
            <relationship join="inner">
                <join_column columnName="student_id" referencedColumnName="id" />
                <table id="evidence" displayName="Evidence" name="class_info.grade_evidence">
                    <column id="year" name="year" displayName="Year" paramType="java.lang.Integer"/>
                    <column id="evidence" name="evidence_text" displayName="Evidence"/>
                </table>
            </relationship>
        </table>
    </report>
</catalog>

To demonstrate the actual URL output, start with the <report>'s base, student table with rows:

Then the URL values for the rows will be:

Then assume a grade table with rows:

The two tables may be joined via the Export Report REST API URL:

/[context]/pullreports/catalog/class_info/report/student/export?columns=/grade

And the joined result rows will be:

In addition to simple substitution of column values, <url_template>s may contain other constructs supported by Groovy's SimpleTemplateEngine. For instance, use Groovy or Java math, logic, or String operators and invoke static method calls such as java.net.URLEncoder.encode(String,String), System.getProperty(String) or org.apache.commons.lang3.StringUtils.substring(String, int). The last example requires the commons-lang3.jar on the JVM classpath.

The following Pull Reports™ XML Catalog file demonstrates some of these advanced expressions.

<?xml version="1.0" encoding="UTF-8"?>
<catalog xmlns="http://www.pullreports.com/catalog-1.6.1" id="catalog" name="Catalog"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.pullreports.com/catalog-1.6.1
    https://www.pullreports.com/docs/xsd/pullreports-catalog-1.6.1.xsd">
    <report id="report" name="Report" >
        <export_config defaultColumns='id'/>
        <table id="some_table" name="schema.table1" displayName="Table1"> 
            <column id="id" name="id" displayName="ID" paramType="java.lang.Integer"/>
            <column id="date1" name="date1_field" displayName="Date 1" paramType="java.sql.Date"/>
            <column id="string1" name="string1_field" displayName="String 1">
                <!-- Demonstrates use of Groovy '.format(...)' method for formatting java.sql.Dates
                to Strings and URL encoding a parameter with the java.net.URLEncoder.encode(String,String)
                static method call. 
                 -->
                <url_template><![CDATA[
                /foo/bar?param1=${@date1.format('yyyy')}&param2=${URLEncoder.encode(@string1,'UTF-8')}
                ]]></url_template>
            </column>
            <column id="string2" name="string2_field" displayName="String 2">
                <!-- Demonstrates conditional logic with ternary operator -->
                <url_template><![CDATA[
                /foo2/bar2/${@id}${(@date1)?'/' + @date1.format('MM'):''}
                ]]></url_template>
            </column>
            <column id="integer1" name="integer1_field" displayName="Integer 1" paramType="java.lang.Integer"/>
            <relationship>
                <join_column columnName="ref_id" referencedColumnName="id" />
                <table id="table2" displayName="Table2" name="schema.table2">
                    <column id="code" name="code" displayName="Code"/>
                    <column id="name" name="name" displayName="name">
                        <!-- Demonstrates the static java.lang.System.getProperty(...) method call and 
                        a reference to columns on this relationship table and the <report>'s base table -->
                        <url_template><![CDATA[
                        ${System.getProperty('report.http.protocol')}://www.acme.com/path1?code=${@@code}&date1=${@date1}
                        ]]></url_template>
                    </column>
                </table>
            </relationship>
        </table>
    </report>
</catalog>