The most fun you'll ever have editing reports!
To see how to access the report editor, please see this article on accessing custom reports.
To see a list of shortcuts that can be used in reports, please see this article.
1. Text Editor
Lots of options in here again; most of which should be pretty familiar. However, there are a couple of advanced items to highlight.
1.1. Source
Clicking on Source will allow you to modify the CSS code for this report segment directly. You probably don't want to touch this unless you know what you're doing.
You can also use this segment to easily copy this report segment from one report to another. So, if you want to copy this part of your report into another document, just select all the CSS coding, copy it, and paste it into your other document. It will match the formatting exactly. Anyone can do this!
1.2. HTML Layout Options
These options will allow you to modify the structure of the report using Quote Blocks and Div Containers, where as the "Show Blocks" button will show you the base structural elements being used in this report segment.
Again, you can probably ignore these buttons unless you know what you're doing.
1.3. Add an Image
This allows you to choose an image to include in this report, which is great for logos or other symbols. This pulls from the Manage Visuals page in this organization.
After clicking on the Image button, this dialog will pop up. Here are your options in this window:
- URL/Browse Server - This is used to choose your image. Clicking the Browse Server option will allow you to choose an image from your Manage Visuals page
- Alternative Text - What shows up on hovering over this image
- Width/Height - The width and height of this image, in pixels. Adjust these values based on how things look on your screen.
- Border - Allows you to apply a black border around the image. The value here is the border weight, in pixels
- HSpace/VSpace - The horizontal and vertical spacing, respectively, around the image.
- Alignment - You can choose between left and right.
- Preview - A preview of what your image can look like amongst some sample text.
- Link - Allows you to add a link when people click on the image
- Advanced - Don't worry about this unless you're a CSS/HTML expert.
Want some more fonts? This editor can also choose from any fonts that you've added in your Manage Fonts section!
2. Editing Report Content
For the most part, you can just start adding information into your reports as needed, using the appropriate replacement commands for the segment you're in. However, there are a couple of things you should note:
2.1. Adding Rows or Columns
Adding rows and columns works similarly to working in a table in a word processor or spreadsheet program.
Row height will be based on the height needed for the content up until the height specified in the document setup.
Column width can be adjusted by clicking-and-dragging on the column border. Note also that what appears on your screen here will be expanded out to match the width allowed in your document setup. If your content is too wide to fit in your columns as designed, they may be automatically adjusted upon export.
Note that your Header and Footer should only have 1 row of information. Your Body can have up to 4 rows of information.
See these tutorials for more details:
Headers and Footers Report Body
2.2. Cell Properties
To get even more precise in your design, you can modify the properties of each cell (or row or column) by right-clicking on it and choosing Cell Properties.
Here, you can add some more details, like width/height, word wrapping, text alignment, background colour, border colour, and more.
3. 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:
3.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 |
3.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. |
3.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
3.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
3.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.) |
3.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.
3.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 |
3.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 |
3.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 |
3.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. |
3.11. Header and Footer
| Replacement | Description |
|---|---|
| Header | |
| {organization} | The organization that this report is being run from |
| {date} | Today’s date |
| Footer | |
| {page} | The current page of this report |
| {total_pages} | The total number of pages in this report |