Report Body

A tutorial on effective body language, in a manner of speaking.

This series will walk you through the basics of customizing reports in SignAgent.

This tutorial will show you how to adjust the body of your reports.

1. Body Structure

The body of your report will behave differently based on how many rows you include in the body. These adjustments can be made by right-clicking in the body of the report to add or remove rows.

1.1. Body with 1 Row: Content Only

Jesse - Demo Org - SignAgent

This will behave as expected, with each sign getting its own row. There will be no additional sub-headers, titles, or summaries beyond what's specified in your replacements.

Jesse - Demo Org - SignAgent

1.2. Body with 2 Rows: Content with Headers

Adding a second row allows you to have Content Headers at the top of the body. These will appear at the top of the body section on every page.

Jesse - Demo Org - SignAgent

1.3. Body with 3 Rows: Content with Headers and Sub-Headers

Adding a 3rd row allows you to include sub-headers in your body. These will appear at the beginning of each sub-section, based on the first item in your sorting order. So, if you're sorting by Type/Location/Number, you'll get a sub-section for each type.

Jesse - Demo Org - SignAgent

1.4. Body with 4 Rows: Content with Headers, Sub-Headers, and Summaries

Finally, adding a 4th row allows you to add a summary row to each sub-section. Most typically, this is used to calculate total quantities or costs for a sub-section.

Jesse - Demo Org - SignAgent

2. Body Replacements

There's lots of available replacements you can use in the body of your reports. Here's a complete list, with a brief description of what it will include:

2.1. Sign ID

Replacement Description
{number} The contents of the Number field
{sign_id} The combination of Type Shortcode, Location Shortcode, and Number
{sign_code} The sign code, as it shows up on your location plans, without colour
{sign_code_with_color} The sign code, as it shows up on your location plans, with colour

2.2. Messages

Replacement Description
{artwork} The artwork for this sign
{artwork_no_scale} The artwork for this sign, ignoring any scaling set up in the sign type. This still follows the max width and height set up in the Document Setup
{all_messages} All messages for this sign, with headers. This will not include artwork

{artwork_or_messages}

The artwork for this sign, or, if there is no artwork, all messages for this sign, with headers.

You can also use any replacements found on the sign type.

2.3. Details

Replacement Description
{files} This will list the filenames of any files that have been attached to this sign, or to the relevant folders, sign types, locations, states, projects, or organization.
Note that this filename will also function as a link to the file stored within SignAgent
{photos} Any photos attached to this sign
{details} The contents of any details fields for this sign, including headers
{tags} Any tags added to this sign
{tags_with_header} Any tags added to this sign, with a small header stating “Tags"
{quantity} The quantity attached to this specific sign
{quantity_with_header} The quantity attached to this specific sign, with a small header stating “Quantity"

You can also use any replacements found on the sign type

2.4. Sub-Headers and Summaries

Replacement Description
{title} The Short Code and Name of this Sub-Section
{total_quantity} The total quantity for this Sub-Section
{total_cost} The total cost for this Sub-Section

You can also use any replacements found on the sign type

2.5. Project and State

Replacement Description
{project} Name of the Project
{state} Name of the State
{review_state} Name of the Review State (Approved, Rejected, Review, etc.)

2.6. Type

Replacement Description
{type} The short code for this sign type, with the type’s color as the background, and the name of the sign type
{type.short_code} The short code for this sign type
{type.short_code_with_color}
The short code for this sign type, with the type’s color as the background
{type.short_code_combo}
The short code for this sign type, with any relevant folder short codes included
{type.full_short_code_comment}
The short code for this sign type and the name of the sign type, with any relevant folder short codes included and the names of those folders
{type.name}
The name of the sign type
{type.details} The contents of the Details field for this sign type.
{type.quantity} The quantity of this sign type (within the relevant section or sub-section)
{type.unit_cost} The unit cost for this sign type
{type.cost} The total cost for this sign type (within the relvant section or sub-section)
{type.number_of_sides} The number of sides for this sign type
{type.scale} The scaling value for this sign type
{type.width} The width of this sign type (based on the artwork template)
{type.height} The height of this sign type (based on the artwork template)
{type.scaled_width} The width of this sign type after scaling
{type.scaled_height} The height of this sign type after scaling
{type.color} The hexcode for the type’s color within SignAgent
{type.font_color} The hexcode for the type’s font color as displayed in SignAgent (either FFFFFF or 000000)
{type.artwork} The default artwork from the template for this sign type

Note that some of the above replacements will only work in Sub-Headers or if you're using a "Types" Report.

2.7. Location

Replacement Description
{location} The name of the location
{location.short_code} The short code of this location
{location.short_code_combo} The short code of this location, including any relevant folders
{location.full_short_code_comment} The name and short code of this location, including the names and short codes of any relevant folders

2.8. Date

Replacement Description
{date} Today's Date
{last_modified_date} The date on which this sign was last modified
{last_modified_year}
The year in which this sign was last modified
{last_modified_month}
The month in which this sign was last modified
{last_modified_day}
The day on which this sign was last modified

2.9. Audit Trail

Replacement Description
{comments} Any comments left on this sign, including photos
{comments_without_photos} Any comments left on this sign, not including photos
{comments_last_5} The last 5 comments left on this sign, including photos
{comments_without_photos_last_5} The last 5 comments left on this sign, not including photos
{audit} Any audit trail entries on this sign, not including comments or photos
{audit_last_5} The last 5 audit trail entries on this sign, not including comments or photos
{audit_with_comments} Any audit trail entries on this sign, including comments and photos
{audit_with_comments_last_5}
The last 5 audit trail entries on this sign, including comments and photos
{audit_with_comments_without_photos}
Any audit trail entries on this sign, including comments, but not photos
{audit_with_comments_without_photos_last_5}
The last 5 audit trail entries on this sign, including comments, but not photos
{detailed_audit}
Any audit trail entries on this sign, including differences, but not including comments or photos
{detailed_audit_last_5}
The last 5 audit trail entries on this sign, including differences, but not including comments or photos
{detailed_audit_with_comments}
Any audit trail entries on this sign, including differences, comments, and photos
{detailed_audit_with_comment_last_5}
The last 5 audit trail entries on this sign, including differences, comments, and photos
{detailed_audit_with_comments_without_photos}
Any audit trail entries on this sign, including differences and comments, but not photos
{detailed_audit_with_comments_without_photos_last_5}
The last 5 audit trail entries on this sign, including differences and comments, but not photos

2.10. Position

Replacement Description
Latitude The latitudinal coordinate of this sign. Note that this only works if the sign is placed on an exterior location plan.
Longitude The longitudinal coordinate of this sign. Note that this only works if the sign is placed on an exterior location plan.
Replacement Description
{organization} The organization that this report is being run from
{date} Today’s date
{page} The current page of this report
{total_pages} The total number of pages in this report

0 Comments

Add your comment

E-Mail me when someone replies to this comment