Customizable Service Report – Configuration Guide

The Customizable Service Report in FieldAx allows administrators to fully control how service details, photos, parts, checklists, and signatures appear in the final PDF report. All settings are managed at the Job Type level and can be updated at any time.

Accessing Job Type Configuration #

Before configuring the Service Report settings, follow these steps to open the Job Type:

1. Log in to Salesforce: Sign in to your Salesforce account with valid credentials.
2. Open the FieldAx App: Navigate to the App Launcher (grid icon) and select FieldAx.
3. Search for Job Type: In the App Launcher search bar, type Job Type.
4. Open a Job Type Record: Select any Job Type from the list to begin configuration.
5. Configure Job Type Settings: Each Job Type determines how the Service Report behaves. You can configure the sections outlined below.

Details Configuration #

Manage the foundational elements of the service report:

• Job Type Name
• Section Labels: Certificate Header Color, System Section Label, Parts Section Label, Checklist Section Label, Photos Section Label, Details Section Label, Summary Label, and Job Description Label.

Core Report Configuration #

Define the core structure and default behaviors of the generated report. This section controls the essential structure and printable format of the report.

You can customize:

• Report Title: e.g., “Installation Service Report”, “RO Maintenance Report”
• Report Subject Field: Adjust the subject displayed in the report header and email.
• Footer Text: Add support contacts, disclaimers, or company guidelines.
• Report Sections (JSON): Enable or disable sections such as Systems, Parts, Checklists, Photos, Signatures, Feedback, etc. You can also control the sequence of sections using sectionOrder, and choose whether empty sections are shown using showAllFields.

New: Control Section Order with sectionOrder #

By default, your Service Report sections appear in a fixed sequence. With the Sort Order feature, you can now control the exact sequence in which sections appear on the report simply by listing them inside the Report Sections (JSON) field.

How to enable it:

Add a sectionOrder array to your existing Report Sections (JSON) configuration, listing the sections in your preferred order:

{
  "showPhotos": true,
  "showSystems": true,
  "showParts": true,
  "showNotes": true,
  "requireSignatures": true,
  "showImages": true,
  "sectionOrder": [
    "details",
    "additionalSections",
    "jobDescription",
    "engineerNotes",
    "systems",
    "parts",
    "checklist",
    "photos",
    "signatures",
    "terms"
  ]
}

How it behaves:

• List all 10 sections: If you want to control the order, you need to include all 10 section keys. Do not skip any.
• Skipped sections fall back to default position: If you leave out one or more sections, those omitted sections will automatically appear in their normal default order, slotted in around the sections you listed.
• Revert to default order: Simply remove the sectionOrder array entirely from the JSON. The report will immediately revert to the standard default order.
• Using custom additional sections: If you have created two or more custom sections under Additional Section Fields, you can reference them by name instead of the generic additionalSections entry:
  • Replace "additionalSections" with your actual custom section name (e.g., "Additional Section 1").
  • If you do this, make sure to remove the generic "additionalSections" entry. Do not include both.

New: Show Empty Sections with showAllFields #

By default, a section is included in the Service Report only when its configured fields contain values. With the showAllFields attribute, you can choose whether sections with no data should still appear on the report.

How to enable it:

Add showAllFields to your existing Report Sections (JSON) configuration:

{
  "showAllFields": true,
  "showPhotos": true,
  "showSystems": true,
  "showParts": true,
  "showNotes": true,
  "requireSignatures": true,
  "showImages": true,
  "sectionOrder": [
    "details",
    "additionalSections",
    "jobDescription",
    "engineerNotes",
    "systems",
    "parts",
    "checklist",
    "photos",
    "signatures",
    "terms"
  ]
}

How it behaves:

• Default is false: If you leave out showAllFields, it behaves as false and empty sections are hidden.
• Disabled sections stay hidden: showAllFields only affects sections that are enabled in the JSON (for example, "showParts": true). A section set to false never appears, whether or not it has data.
• Works with sectionOrder: Empty sections that are shown still follow the sequence defined in sectionOrder.
• Fixed sections are unchanged: Header, Subject, and Footer always appear in their default positions.
• Revert to default behavior: Set showAllFields to false or remove it from the JSON.

Customizing a Section #

Each field entry contains three key attributes:

• Field: The underlying Salesforce API field being queried.
• Label: The customer-facing label shown on the report.
• Field Type: How it displays (text, picklist, date/time, number, etc.).

Steps to customize a section:

1. Open the Job Type record.
2. Find the configuration area for the section you want to modify.
3. Decide which placement each field belongs to: left panel, right panel, additional section, or table column.
4. Add, remove, or reorder the fields within that placement.
5. Click Save.
6. Generate a test report to verify the output matches your requirements.

Layout Configuration (JSON) #

Set how fields, tables, and labels appear inside the report. Labels and display order can be changed at any time; API names remain fixed. Use JSON configuration to control field visibility, order, and column layout. Updates take effect immediately in the generated PDF.

Configurable areas include:

• Left Panel Fields: Customer, Primary System, Priority, etc.
• Right Panel Fields: Job Number, Service Type, Completion Date, Status, etc.
• Job System Columns: System Name, Quantity, Status, Maintenance Performed, etc.
• Parts Consumed Columns: Part Number, Description, Quantity Used, etc.
• Checklist Columns: Define how checklist questions and responses appear in the PDF.

Email Settings #

Configure automated dispatch settings for the report:

• Email Templates: Select custom templates for distributing completed Service Reports.
• CC Recipients: Define additional stakeholders who receive the report automatically.

Signature & Feedback Requirements #

Configure whether the engineer signature, customer signature, and customer feedback rating are mandatory before completing the service. You can also define and manage the formal Terms & Conditions displayed during the job completion process.

Final Report Summary #

Based on your Job Type configuration, the final generated PDF may include:

• Job Details
• Systems & Equipment
• Checklist Responses
• Parts Consumed
• Return Order Details
• Product Requests
• Photos (Before, After, and Equipment Photos)
• Engineer & Customer Signatures
• Customer Feedback
• Summary Notes