Docs: Document how to include Sketches in Reports (FLCRM-20058) by nehilor · Pull Request #35 · fulcrumapp/api

nehilor · 2026-03-05T17:11:45Z

Summary

This PR updates the Report Builder documentation to include instructions and examples on how to incorporate Sketches into custom reports. It adds the missing SKETCHURL function reference and provides a new dedicated example page for better developer guidance.

Jira Ticket

FLCRM-20058

Changes

1. Documentation of `SKETCHURL` Function

Updated docs/REPORT BUILDER/reports-introduction/functions.md to include the SKETCHURL(id, options) function.
Updated the RENDERVALUES global function example to include logic for isSketchElement, showing how to render sketches alongside photos and signatures.

2. New Sketches Example Page

Created docs/REPORT BUILDER/reports-examples/sketches.md which provides:
- A code snippet for the BODY section of a report.
- Instructions on how to resize sketches via CSS styles.
- An example of how to access a specific sketch using a field's data name.

3. Navigation & Consistency

Added the new Sketches example to docs/REPORT BUILDER/reports-examples/_order.yaml to ensure it appears in the documentation portal's sidebar.
Standardized formatting in functions.md:
- Replaced *** horizontal rules with ---.
- Enforced the use of double quotes in JS examples.
- Added missing semicolons for code consistency.

How to Verify

Review the modified functions.md and ensure the SKETCHURL section is accurate.
Verify the new sketches.md example file follows the project's documentation style.
Confirm that the _order.yaml correctly references the new file.

Copilot

Pull request overview

Updates Report Builder docs to explain how to include Sketch fields in custom reports, adding the missing SKETCHURL function reference and a dedicated example page.

Changes:

Added documentation for SKETCHURL(id, options) in the functions reference.
Extended the RENDERVALUES example to render sketches alongside other media types.
Added a new “Sketches” examples page and included it in the examples navigation order.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 7 comments.

File	Description
docs/REPORT BUILDER/reports-introduction/functions.md	Adds `SKETCHURL` docs and updates existing examples/formatting
docs/REPORT BUILDER/reports-examples/sketches.md	New example page showing how to render and style sketches
docs/REPORT BUILDER/reports-examples/_order.yaml	Adds the new sketches page to the sidebar order

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

docs/REPORT BUILDER/reports-introduction/functions.md

docs/REPORT BUILDER/reports-examples/sketches.md

nehilor

Applied feedback: downgraded headings in sketches.md to H2 for consistency.

m1g

Looks good.. just one note

docs/REPORT BUILDER/reports-examples/sketches.md

Copilot

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

- Added comprehensive documentation for SKETCHURL function parameters and options - Documented sketch data structure (mediaID, caption, isEmpty properties) - Added examples for accessing sketch data and handling empty fields - Included practical examples for common use cases: - Display only first sketch - Access specific sketch by field name - Add metadata (creation dates) to sketches - Hide labels when field is empty - Number sketches automatically - Grid layout for multiple sketches - Page break handling - Improved metadata with better title, description, and robots index - Added code examples for querying sketch metadata from database - Included CSS examples for responsive layouts and styling

docs/REPORT BUILDER/reports-examples/sketches.md

corporealshift

We should consolidate on mediaID for all examples for consistency. We should also remove caption from sketch examples since we don't have a way to save a caption yet

docs/REPORT BUILDER/reports-examples/sketches.md

- Restore missing code fence in RENDERVALUES example - Remove trailing comma from RENDER params for wider JS compatibility - Replace curly quotes in STATICMAP examples with straight quotes - Standardize sketch examples to use mediaID - Remove sketch caption examples not currently supported - Switch EJS snippets in sketches docs to html fenced blocks

nehilor · 2026-03-09T18:15:59Z

Addressed all review feedback in commit f512658.

Summary of fixes:

Restored missing code fence in example
Removed trailing comma in params for broader JS compatibility
Replaced curly quotes in STATICMAP snippets with straight quotes
Standardized sketch docs to examples
Removed sketch caption examples that are not supported
Updated EJS snippets in sketches docs to fences

All review threads are now resolved.

Copilot

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

nehilor · 2026-03-09T18:40:16Z

Addressed all review feedback in commit f512658.

Summary of fixes:

Restored missing code fence in RENDERVALUES example
Removed trailing comma in RENDER params for broader JS compatibility
Replaced curly quotes in STATICMAP snippets with straight quotes
Standardized sketch docs to mediaID examples
Removed sketch caption examples that are not supported
Updated EJS snippets in sketches docs to html fences

All review threads are now resolved.

nehilor · 2026-03-09T18:40:23Z

Addressed all review feedback in commit f512658.

Summary of fixes:

Restored missing code fence in RENDERVALUES example
Removed trailing comma in RENDER params for broader JS compatibility
Replaced curly quotes in STATICMAP snippets with straight quotes
Standardized sketch docs to mediaID examples
Removed sketch caption examples that are not supported
Updated EJS snippets in sketches docs to html fences

All review threads are now resolved.

Copilot

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

nehilor added 2 commits March 5, 2026 10:49

Docs: Add SKETCHURL and sketches examples to Report Builder

4d0a89b

Docs: Fix typo in sketches example

a95075b

Copilot AI review requested due to automatic review settings March 5, 2026 17:11

nehilor requested review from a team as code owners March 5, 2026 17:11

nehilor self-assigned this Mar 5, 2026

Copilot AI reviewed Mar 5, 2026

View reviewed changes

Docs: Downgrade headings to H2 in sketches example per PR feedback

4b22f05

nehilor commented Mar 5, 2026

View reviewed changes

m1g previously approved these changes Mar 6, 2026

View reviewed changes

docs/REPORT BUILDER/reports-examples/sketches.md Show resolved Hide resolved

Docs: Clarify sketch ID usage in example per PR feedback

1e4cc11

Copilot AI review requested due to automatic review settings March 6, 2026 20:32

nehilor dismissed m1g’s stale review via 1e4cc11 March 6, 2026 20:32

Copilot started reviewing on behalf of nehilor March 6, 2026 20:33 View session

Copilot AI reviewed Mar 6, 2026

View reviewed changes

chrisworkmode reviewed Mar 9, 2026

View reviewed changes

docs/REPORT BUILDER/reports-examples/sketches.md Outdated Show resolved Hide resolved

m1g previously approved these changes Mar 9, 2026

View reviewed changes

corporealshift requested changes Mar 9, 2026

View reviewed changes

docs/REPORT BUILDER/reports-examples/sketches.md Show resolved Hide resolved

Copilot AI review requested due to automatic review settings March 9, 2026 18:14

nehilor dismissed m1g’s stale review via f512658 March 9, 2026 18:14

Copilot started reviewing on behalf of nehilor March 9, 2026 18:14 View session

Copilot AI reviewed Mar 9, 2026

View reviewed changes

nehilor requested review from chrisworkmode, corporealshift and m1g March 9, 2026 18:42

nehilor requested a review from Copilot March 9, 2026 18:42

Copilot started reviewing on behalf of nehilor March 9, 2026 18:43 View session

Copilot AI reviewed Mar 9, 2026

View reviewed changes

Conversation

nehilor commented Mar 5, 2026 • edited by atlassian bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Jira Ticket

Changes

1. Documentation of SKETCHURL Function

2. New Sketches Example Page

3. Navigation & Consistency

How to Verify

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nehilor left a comment

Choose a reason for hiding this comment

Uh oh!

m1g left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

corporealshift left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nehilor commented Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

nehilor commented Mar 9, 2026

Uh oh!

nehilor commented Mar 9, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

nehilor commented Mar 5, 2026 •

edited by atlassian bot

Loading

1. Documentation of `SKETCHURL` Function

nehilor commented Mar 9, 2026 •

edited

Loading