Report Template Setup

Prerequisites

Create report templates with a streamlined interface using the Report Templates tool in the Admin Portal.

Basics

A report template controls when an FX Report is available for use.

You must add a report template for every FX Report.

Best Practices

  • Know Your Objects

    • It is paramount to understand what Objects to include in the Report

    • Create a model of the referenced information (for example, using a visual diagram or written text).

      This helps to "map” what to include for each Object and understand the how to access the desired information.

      For example, you might have to navigate through several parent and/or child objects to get to the desired information.

      • Parent → Child → Grandchild

      • Parent → Grandparent → Children → Grandchildren

      • Parent → Children → Grandchildren → Parents

  • Plan White Space

    • Margins are intended to keep the data accessible and easy to read.

      In some cases, margins can go to the very edges of the template.

      Other cases require larger borders for a Header or Footer.

    • When reviewing the PDF example, consider the spacing on the left, top, right, and bottom margins.

    • Set margins at the Template level before any additional values within tables.

  • Consider Orientation

    • Be aware of height and width of the example provided by the Customer.

    • If the width is greater than the height, set pageOrientation=”landscape”.

      If you switch the pageOrientation mid-build, you must rework every table.

  • Conduct Test Prints

    • If there is a chance the report may ever be printed, always conduct a test print.

    • While XML/PDF’s generally match a printed counterpart, the look,feel, margins, text size, and other settings may vary on the printed report.

    • Always verify additional printed copies (carbon copies).

Additional Best Practice Notes

  • Margins Are Listed Clockise

    • When setting Template or Table margins, remember the rule:

      Left, Top, Right, Bottom

    • The first value is always the Left Margin.

      Example 1. Left and right margins = 36, top margin = 120, bottom margin = 72
       <template pageSize="LETTER" pageOrientation="portrait" pageMargins="36 120 36 72" preprocess="true">
      Example 2. Left and right marings = 36, top and bottomw margins = 40
       <table  margin="36 40 36 40" columnWidths=”* 100”>

  • Formula References

    • Formulas must have a prior reference of the field(s) that is included in the formula itself.

    • Formulas cannot “call” a field. The data must already be indicated in the Report.

    • Indicating the data can be done in any number of ways.

      One method is to indicate the Field either in a comment or outside of the <tableBody>.

      Example 3. Using a comment to reference the desired field.
      <!-- {{Field_Reference__c}} {{Field_Reference2__c}} -->
<row>
  <cell>{{formula "round({0} * {1},2)" Field_Reference__c Field_Reference2__c }}</cell>
</row>

Adding a Report Template

  1. Access FieldFX Back Office

  2. Open the Report Templates tab

  3. Click New

  4. Complete the following:

    1. In Report Template Name, enter a name for the report template

    2. In SObject, enter the API name of the object for which you added the report

      Enter FX5__Ticket__c if the report is for the Ticket object.

  5. Specify when to use the report:

    1. In Account, select a customer to use the report for that customer

    2. In Office, select an office to use the report for that office

    3. In Segment, select a business segment to use the report for that segment

    4. In SObject Record Type, enter a record type to use the report for that record type

  6. In Sequence Number, enter a sequence number to use for the report

    Sequence numbers control the order of reports in lists. Refer to the sequence number article for more information.

  7. Click Save

  8. Attach the template for a PDF report/HTML report:

    1. Click Attach File

    2. Click Choose File

    3. Select the template

    4. Click Attach File

    5. Click Done

  9. Configure sharing settings to grant access to the report template