Print Templates

Print templates are used to generate maps in print-ready formats, such as .pdf or .jpg. Print templates are really a special type of report that has a map image as its content. In addition to the map image, print templates can include additional elements like a title or description, overview map, north arrow, scale bar, legend, and charts to your print template.

Like report templates, print templates are created in Geocortex Report Designer.

Geocortex Essentials also has an Export feature that allows users to export the map image to an image file. The Export feature does not use print templates, so the exported image cannot have a title or description, overview map, north arrow, scale bar, legend, or charts.

You might want to share print templates across sites and keep them linked so that changes to the master copy are propagated to all sites. See Create a Dedicated Site for Print Templates for instructions.

Main Steps to Create and Use a Print Template

You may want to adapt one of the print templates that ship with the LA County sample site. In the default Essentials installation, the print templates are here:

C:\Program Files (x86)\Latitude Geographics\Geocortex Essentials\Default\REST Elements\Sample Sites\LA_County\Resources\PrintTemplates

The main steps to create a print template and use it in a site are:

  1. In Geocortex Report Designer, design the print template.

  2. Save the template to the Sites folder.

  3. In Geocortex Essentials Manager, add the template to the site.

  4. Edit the template in Manager and configure its settings.

  5. Provide a way to end users to generate the report from the viewer.

    You can add the Print tool to the viewer's toolbar, add an item to the I Want To menu, or provide a hyperlink or workflow that runs the report.

Design a Print Template

The general procedure to design a print template is:

  1. Open the desired panel at Report Designer's left side: Controls or Geocortex Essentials.

  2. Drag a control from the left panel to the design area.

    To add the map image to the template, drag the Main Map control from the Geocortex Essentials panel to the design area.

  3. Click the control to select it.

  4. To move the selected control, drag it across the design area.

  5. To resize the selected control, drag the control's handles.

  6. Configure the selected control's properties in the panel at Report Designer's right.

    To display feature data in the generated report, set the control's DataField property to the name of the data field. For the Main Map control, the DataField property must be set to _MainMap.

  7. Repeat this procedure until you have added and configured all the controls that you want in the template.

See also...

Include Data in a Report

Format a Report

Add a Print Template to an Essentials Site

To add a print template:

  1. In Geocortex Essentials Manager, edit the site that you want to configure, and then click Print Templates in the side panel.

  2. Click Add Print Template.

  3. Type a display name for the print template.

  4. If you want, type a description for the print template.

  5. Click Next.

  6. If the print template (.rpx file) is not already somewhere in the Sites folder, upload it:

    1. In the Filename list, open the folder that you want to upload the file to.

    2. Click Upload.

    3. Click Select.

    4. Browse to the file that you want to upload and select it.

    5. Click Open.

    6. Click Upload.

  7. Select the print template.

  8. Click Finish.

    The print template appears on the Print Templates page.

  9. Click Apply Changes.

To reorder list items, click and drag the  Sort handle Click and drag to change the order.

Import Print Templates from Another Site

To import print templates:

This procedure assumes that you have already created one or more print templates and added them to a site.

  1. In Geocortex Essentials Manager, edit the site that you want to configure, and then click Print Templates in the side panel.

  2. Click Import Print Template .

  3. Select the site where the print templates are configured, and then click Next.

  4. Select the print templates that you want to import.

    To select multiple templates, hold the Ctrl key down while selecting.

  5. Click Finish.

    The print templates appear on the Print Templates page.

  6. Click Apply Changes.

To reorder list items, click and drag the  Sort handle Click and drag to change the order.

Edit a Print Template in Geocortex Essentials Manager

To edit a print template:

  1. In Geocortex Essentials Manager, edit the site that you want to configure, and then click Print Templates in the side panel.

  2. Click Edit beside the template that you want to configure.

    The Edit Print Template page opens to the Details tab.

Print Template Settings

Print template settings are organized into tabs. To configure print template settings, edit the print template and click the desired tab.

The print template tabs are:

In some cases, features that are visible on a map are not included when the user prints the map. For information about ensuring that features are included for printing, see Respect the Map Scale for Printing.

Details Tab for Print Templates

The settings that can appear on the Details tab are:

Set the Default Print Template

To set the default print template:

The default print template is the print template that is initially selected in the drop-down list when the user makes a request to print the map.

  1. In Geocortex Essentials Manager, edit the site that you want to configure, and then click Print Templates in the side panel.

  2. In the Default Print Template drop-down list, select the print template that you want to use as the default.

  3. Click Apply Changes.

Map Scales

In the Geocortex Viewer for Silverlight, the user can select the scale in which the map prints. You can configure the scale options that appear in the drop-down list within Print Templates in Geocortex Essentials.

To configure map scales for printing:

  1. In Manager, edit the site that you want to configure, and then click Print Templates in the side panel.

  2. Click the Edit icon beside the print template that you want to configure.

    Scale option settings are part of a particular print template, so you need to make the edits individually in all the print templates where you want them to appear.

  3. Click the Map Scales tab.

  4. Do any of the following:

  5. Click Apply Changes.

Grids and Graticules

You can define grids that optionally print when the user makes a request to print the map. The grid coordinates print around the perimeter of the map image.

There are two types of grid:

Printed map with graticules (left) and measured grid (right)

You can configure as many measured grid and graticule definitions as you want for a template. The user also has the option to exclude the grid.

To add a grid to a print template:

  1. In Geocortex Essentials Manager, edit the site that you want to configure, and then click Print Templates in the side panel.

  2. Click Edit for the print template you want to configure.

  3. Select the Grids tab.

  4. Follow the instructions that apply to you:

  5. Graticules

    1. Click Add Graticules.

      The Add Graticules dialog box opens.

      Add graticules

    2. Type a display name for the grid.

      This is the name the end user will select to print this grid.

    3. Enter the number of intervals you want in the grid.

    4. If you do not want to use the default coordinate system, type the WKID or WKT of the coordinate system you want to use.

    5. Click OK.

      The dialog box closes. The graticules definition is listed on the Edit Print Template page.

    6. Click Save Site.

      If you want to change a graticules definition into a measured grid, edit the graticules and enter the WKID or WKT for the projection you want to use.

    Measured Grid

    1. Click Add Measured Grid.

      The Add Measured Grid dialog box opens.

      Add measured grid

    2. Type a display name for the grid.

      This is the name the end user will select to print this grid.

    3. Enter the number of intervals you want in the grid.

    4. If you want to use different units than the basemap's units, type the WKID or WKT of the projection you want to use.

    5. Click OK.

      The dialog box closes. The measured grid definition is listed on the Edit Print Template page.

    6. Save the site.

      If you want to change a measured grid into graticules, edit the measured grid and enter 4326 in the WKID or WKT for the coordinate system you want to use.
      The default coordinate system for graticules is GCS WGS 4326.

    Set the Default Grid

    To set the default grid:

    The default grid is the grid that is initially selected in the drop-down list when the user makes a request to print the map. The factory default is None (no grid).

    1. In Geocortex Essentials Manager, edit the site that you want to configure, and then click Print Templates in the side panel.

    2. Select the grid that you want to use as the default from the Default Grid drop-down list.

    3. Click Save Site.

North Arrow

You can configure the style and color of the north arrow to use in printouts. In order for the north arrow to appear on a printout, the print template must have a placeholder for the north arrow. The placeholder is added in Report Designer.

If you have created a dedicated site for print templates, sites that reference this site inherit the north arrow. You can override the north arrow by configuring a new one in the site.

To edit the north arrow:

  1. In Geocortex Essentials Manager, edit the site that you want to configure, and then click Print Templates in the side panel.

  2. Click Edit North Arrow.

  3. To select a different image, click the image preview , browse the thumbnail images, and then double-click the image that you want to use.

    The image preview shows the currently selected style and color of north arrow.

  4. To change the color, enter the hexadecimal value in the Select Color box, or click the Color icon and select a new color.

  5. Click Apply Changes.

Large-Format Printing

The creation of printed output is memory intensive. To avoid performance issues, Essentials offers a large-format printing feature that stores the output on disk instead of in memory. Large‑format printing enables you to create print templates for arbitrarily large output, including map images that are larger than the map service's maximum map image size. This means you can create high-resolution output that is as large as your printer or plotter supports, regardless of map service constraints.

By default, large-format printing is disabled. Each print template in a site has its own setting, so you can enable large-format printing for some print templates and leave it disabled for others. The end user cannot turn large-format printing on or off.

The following table compares the default handling of print templates (left column) to large-format printing (right column). Use the information in this table as your guide when deciding whether a template should be configured to use large-format printing or not.

Large-Format Printing Disabled

Large-Format Printing Enabled

Output is kept in memory as it is being created and after it is complete.

Output is written to disk as it is being created and after it is complete.

Output is available for download for a few minutes after the output is created. No housekeeping is required.

Output is available for download for up to three months, after which Essentials deletes the output. Status files are permanent. When the output is deleted, the status becomes "No longer available".

Large and concurrent print template requests can affect server performance due to memory shortage.

Large and concurrent print template requests have much less effect on server performance.

The size, resolution and number of print operations that can run concurrently are limited by RAM and CPU.

Size and resolution of print operations are limited only by available disk space on the server. Print operations are queued, so there is virtually no limit to the number of print operations that can be started concurrently.

Turnaround is quick, provided the size and resolution of the images are small.

Turnaround depends on the size of the job and the number of jobs in the queue.

The user is notified on screen when creation of the output has started and completed. Email notification is not supported.

The user is notified on screen and also optionally via email when creation of the output has started and completed. In addition, the user can check the progress of the print job at any time.

Multiple output formats are supported: PDF, RTF, TIFF, BMP, GIF, JPEG, PNG, and GeoTIFF.

One output format is supported: PDF.

If the paper size is smaller than the image size defined in the .rpx file, the printed image automatically breaks at page boundaries.

The image size defined in the .rpx file must be at most the paper size minus the margins. Page boundaries are not handled.

Configure a Print Template for Large-Format Printing

To configure a print template for large-format printing:

  1. In Geocortex Essentials Manager, edit the site that you want to configure, and then click Print Templates in the side panel.

  2. Edit the print template that you want to configure.

  3. Click Edit Print Job Settings.

  4. To turn on large-format printing, select the Enable Print Jobs checkbox.

  5. Select the Print Job Settings tab to edit the parameters for rendering the map:

    • Tile Size is the size (in pixels) of the square image tiles used to compose the map images. In most cases, a value between 512 and 2048 is ideal. Larger sizes consume more system memory.

    • Maximum Workers is the number of threads that will be used to render the map. A larger number of threads will increase the speed of the print job, but will consume more system resources. Select value between 1 and 3 to start to be safe, more if the system can handle it.

    • Output File Time-to-Live is the number of hours that the completed print job will persist on the server and be available for download.

  6. Select the Email Settings tab to manage email notifications.

    • To allow the user to be notified by email when report creation starts and ends, select the Enable Email Notifications checkbox.

    • Sender Email Address is the address that appears in the From field of notification emails to the user.

    • Sender Name is the name that appears in the From field of notification emails to the user.

  7. Select Message Settings to modify the text of notification emails to the user.

    If the settings on the Message Settings tab are grayed out, select the Enable Email Notifications checkbox on the Email Settings tab.

    • Printing Start Subject is the text that appears in the subject field of notification emails to the user when report creation starts.

    • Printing Start Message is the text that appears as the message of notification emails to the user when report creation starts. A link to the status page is automatically appended to the message.

    • Printing Success Subject is the text that appears in the subject field of notification emails to the user if report creation succeeds.

    • Printing Success Message is the text that appears as the message of notification emails to the user if report creation succeeds. A link to the status page is automatically appended to the message.

    • Printing Failure Subject is the text that appears in the subject field of notification emails to the user if report creation fails.

    • Printing Failure Message is the text that appears as the message of notification emails to the user if report creation fails. A link to the status page is automatically appended to the message.

  8. Select SMTP Settings to edit the SMTP server settings for sending status emails.

    If the settings on the SMTP Settings tab are grayed out, select the Enable Email Notifications checkbox on the Email Settings tab.

    • Use SSL: If you want emails related to print jobs to be sent using SSL (HTTPS), select the Use SSL checkbox. If the Use SSL checkbox is cleared, emails are sent using HTTP.

    • SMTP Server Host is the host name of the SMTP server.

    • SMTP Server Port is the port on the SMTP server. The default port is 25.

    • SMTP Server Username is the username used to access the SMTP server. If a username is not required, leave this setting blank.

    • SMTP Server Password is the password used to access the SMTP server. If a password is not required, leave this setting blank.

  9. Click OK.

Create a Dedicated Site for Print Templates

One way to manage print templates is to configure them all in one site that you create especially for that purpose. This gives you a central location to manage your print templates. To use one or more of the print templates in another site, you can either import the templates, or create a reference and inherit them.

Importing creates a copy of the print template component that you import. The copy's configuration is independent of the original's configuration—you can change the configuration of one without affecting the other.

Importing does not create a copy of the print template (.rpx) file. The print template component in the dedicated Print Templates site and the copy both refer to the same .rpx file. If you modify the .rpx file, the changes appear in both the original and any imported copies.

Instead of importing print templates, you can create a reference to the Print Templates site. This creates a linked reference to each print template. You can change the inherited configuration without affecting the source configuration. This allows you to customize a print template for different sites.

However, if you change the configuration of the source site, the changes also appear in the site that references it, without overriding any changes you have made. For example, you could add a new print template to the Print Templates site and it would appear in the sites that reference Print Templates.

Example

Suppose you want users to be able to use the County Roads print template in several different sites. You create an empty site called Print Templates and add the County Roads print template to it. Then you edit each of the sites that you want to have the County Roads template and add a reference to the Print Templates site. Each site inherits the County Roads template.

Now suppose you add a second print template, County Waterways, to the Print Templates site. All the sites that reference the Print Templates site automatically inherit the new County Waterways template. Note that if you had originally added or imported the County Roads template, instead of referencing the Print Templates site, you would now have to add or import the County Waterways template to each site.

Similarly, if you modify one of the templates on the Print Templates site, all the other sites will automatically inherit the changes.

Overview of Steps to Create a Dedicated Site for Print Templates

To use a dedicated site for print templates:

Step 1: Create the Print Templates Site

  1. Create an empty site.

  2. Add or import your print templates to the new site.

  3. Save the site.

Step 2: Reference the Print Templates Site

  1. Edit a site that you want to inherit the print templates.

  2. Add a reference to the site that contains the print templates.

  3. Click Print Templates in Manager's side panel to see the inherited print templates.

  4. Modify or remove the inherited print templates as desired.

    This does not affect the print templates in the dedicated print templates site.

  5. Save the site.

  6. Repeat Step 2 for each site that you want to inherit print templates.

© 2017 Latitude Geographics Group Ltd. All Rights Reserved.

Documentation Version 4.11