<url_template>

A <url_template> is a Freemarker template which may reference column values within the result row within template expressions. Only references to columns which are guaranteed to be available at runtime are valid. These are:

<column id="addressStreet" name="address_street" displayName="Street Address"> 
    <url_template><![CDATA[<#if @addressId??>/addressLookup?id=${@addressId}</#if></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.7.0" id="class_info" name="Class Information"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.pullreports.com/catalog-1.7.0
    https://www.pullreports.com/docs/xsd/pullreports-catalog-1.7.0.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.
                              ${@@year} references column class_info.grade.year
                              
                              The <#if> check ensures both ${@id} and ${@@year}
                              are 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[
                        <#if @id?? && @@year??>
                        //${getServerName()}/${getContextPath()}/pullreports/catalog/class_info/report/evidence/export?format=htmltable&columns=%2Fevidence&filter=%40student_id%3D${@id}&filter=%2Fevidence%40year%3D${@@year}
                        </#if>
                        ]]></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:

<url_template>s may use Freemarker directives to fulfill complex use cases. The following Pull Reports™ XML Catalog file demonstrates directive usage.

<?xml version="1.0" encoding="UTF-8"?>
<catalog xmlns="http://www.pullreports.com/catalog-1.7.0" id="catalog" name="Catalog"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.pullreports.com/catalog-1.7.0
    https://www.pullreports.com/docs/xsd/pullreports-catalog-1.7.0.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 Freemarker '?string[...]' and '?url' methods -->
                <url_template><![CDATA[
                /foo/bar?param1=${@date1?string['yyyy']}&param2=${@string1?url('ISO-8859-1')}
                ]]></url_template>
            </column>
            <column id="string2" name="string2_field" displayName="String 2">
                <!-- Demonstrates conditional logic -->
                <url_template>/foo2/bar2/${@id}${(@date1??)?then('/' + @date1?string['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 referencing columns on this relationship table
                        and the <report>'s base table -->
                        <url_template><![CDATA[
                        //www.acme.com/path1?code=${@@code}&date1=${@date1?date}
                        ]]></url_template>
                    </column>
                </table>
            </relationship>
        </table>
    </report>
</catalog>