LogoLogo
SupportServer Hosting
  • Sonoran CAD
  • 📱Download The App
    • Steam Browser - Workaround
    • Web Browser - Clear Cache
    • Desktop App - Clear Cache
    • GTA RP Tablet - Clear Cache
    • Steam Browser - Clear Cache
  • Why Choose Sonoran CAD?
    • 🏆Why Choose Sonoran CAD?
  • Other Products
    • 🖥️FiveM Hosting
    • 📝Sonoran CMS
    • 📡Sonoran Radio
  • Tutorials
    • Getting Started
      • Registering Your Account
      • Registering Your Community
      • Inviting Users to Your CAD
      • Granting Account Permissions
      • View Your Limits
      • Community ID and API Keys
      • Troubleshooting
    • Customization
      • Custom Domain & Login Page
      • Customizing Your Layout
      • Community Branding and Settings
      • Creating Custom Record and Report Types
      • Sharing Custom Records
      • Custom Search Types
      • Geographical Settings
      • Penal Codes
      • 10-Codes
      • Addresses and Street Names
      • Unit Status Codes
      • Tone Board
      • Custom Audio Notifications
      • Custom Emails
      • Quick Links
      • Custom Page Colors
      • User Account Restrictions
      • Configuring Multiple Servers
      • Advanced Query Strings
    • Dispatching
      • Creating a Call
      • Self Dispatch
      • Timers
      • Command Line Interface (CLI)
    • Records Management
      • Record Lookups
      • Adding a Record
      • PDF Records
      • Scene Diagram Builder
    • Administration
      • System Logs
      • Remove User Account
      • Deleting or Transferring your CAD
    • Other Features
      • Configurable Hotkeys
      • Voice Commands
      • Volume and Language
  • Integration Capabilities
    • 🗃️Paid Integration Resources
      • Mobile Command Center
      • ATM Robbery
      • In-Vehicle Radar
      • Evidence Camera
      • Power Grid
      • Speed Cameras
      • Shot Spotter
    • 🛠️Integrated Vendors
    • 📺Twitch Bodycam, Bot, & Lighting Integration
    • Database Sync and Merge
      • Database Sync Credentials
      • QB Core Mapping Tutorial
      • Troubleshooting
    • Discord Bot Integration
    • Discord Rich Presence
    • Discord Webhooks
    • TeamSpeak 3 Integration
    • Stream Deck Integration
    • 🎮FiveM
      • FiveM Installation
        • Submodule Configuration
          • Submodule Troubleshooting
          • Submodule Configuration Updates
        • FiveM Submodules
          • Body Camera
          • Call Commands
          • Check API ID
          • Civilian Integration
          • Dispatch Notify
          • Emergency Response Simulator (ERS)
          • Framework Support (ESX/QBCore) and Auto Fines
          • FivePD
          • ForceReg
          • Kick
          • Locations
          • Live Map
          • Lookups
          • Postals
          • Smart Signs
          • Sonoran Radio (sonrad)
          • Station Alert
          • Tablet & Mini-CAD
          • TeamSpeak 3
          • Traffic Stop
          • Unit Status
          • VehReg
          • WraithV2
      • FiveM Development Documentation
        • Client Functions
        • Shared Functions
        • Server Functions
        • Server Events
        • HTTP Request Handling
      • Error Codes
    • 🎮Roblox ER:LC
  • Developer API Documentation
    • 📖API Integration
      • Getting Started
        • Retrieving Your Credentials
        • Integration API ID
        • Account Secret ID
      • Push Events
        • Event Restrictions
        • Record Events
          • Record Added
          • Record Edited
          • Record Removed
        • Unit Events
          • Unit Panic
          • Unit Login
          • Unit Logoff
          • Unit Status Update
          • Unit Group Name Change
          • Unit Group Add
          • Unit Group Remove
        • Dispatch Events
          • New Dispatch
          • Modified Dispatch
          • Closed Dispatch
          • Dispatch Note
          • Attach Unit
          • Detach Unit
          • Toggle Bodycam
        • Event 911
        • Remove 911
        • Sign Updated
        • Tone Played
        • Civilian
          • Character Selected
        • ERS
          • New Callout
        • Station Alert
          • New Station Alert
      • API Endpoints
        • API Restrictions
        • Emergency
          • Identifiers
            • Get Identifiers
            • Modify Identifier
            • Set Identifier
            • Unit Panic
            • Kick Unit
            • Unit Status
            • Get Active Units
            • Update Unit Location
          • Dispatch and Emergency Calls
            • Get Calls
            • New Dispatch
            • Attach Unit
            • Detach Unit
            • Update Call Postal
            • Add Call Note
            • Update Call Primary
            • Close Dispatch
            • New 911 Call
            • Remove 911
          • Custom Blips
            • Get Map Blips
            • Add Blip
            • Modify Blip
            • Remove Blip
          • Street Signs
            • Set Street Sign Config
            • Update Street Sign
          • ERS
            • Set Available Callouts
          • Station Alert
            • Set Stations
        • Civilian
          • Set Character
          • Get Characters
          • New Character
          • Edit Character
          • Remove Character
          • DB Sync: Get Character Links
          • DB Sync: Link Character
        • General
          • Get Servers
          • Set Servers
          • Get Version
          • Set Penal Codes
          • Set API IDs
          • Custom Records
            • API Options for Adding and Modifying Records
            • Get Record Templates
            • New Record
            • Edit Record
            • Remove Record
          • Lookup By Value
          • Lookup Name or Plate
          • Get Account
          • Get Accounts
          • Check API ID
          • Apply Permission Key
          • Modify Account Permissions
          • Kick or Ban User
          • Verify Secret
          • Auth Street Signs
          • Set Postal Config
          • Set Clock Time
          • Send Photo
          • Leave Community
          • Join Community
        • Local Endpoints
          • Smart Lighting
        • Internal
          • FiveM Download
      • API Examples
        • Emergency
          • LUA Examples
            • Dispatch and Emergency Calls
              • New 911 Call
              • Remove 911
              • Add Call Note
              • Set Call Postal
            • Custom Blips
              • Add Blip
              • Add Blips
              • Add Temp Blip
              • Get Map Blips
              • Remove Blip
              • Remove Blip With Subtype
            • General
              • Lookup Name or Plate
          • JavaScript Examples
            • Dispatch and Emergency Calls
              • New 911 Call
              • Remove 911
              • Add Call Note
              • Set Call Postal
            • Custom Blips
              • Add Blip
              • Add Blips
              • Add Temp Blip
              • Get Map Blips
              • Remove Blip
              • Remove Blip With Subtype
            • General
              • Lookup Name or Plate
      • Development Branch
    • 💵Developer Bounties
    • 🌎Translation Support
  • Pricing
    • Pricing FAQ
      • Military and First Responder Discount
      • Expert Installation
      • Accessing the Payment Center
      • Create and Manage a Subscription
      • Request Discord Role
    • View and Compare Plans
  • Roadmap
    • 📋Changelog
  • Other
    • AI QA
    • Contact Us
    • Policy
      • Rocket CAD Closure
      • Terms of Service
      • Privacy Policy
      • Refund and Purchase Policy
      • Discord Bot
    • Archive
      • Fire Siren
Powered by GitBook
On this page
  • Video Tutorial
  • Creating a new Report or Record:
  • 1. Navigate to the Record Editor
  • 2. Select the new Record Type
  • 3. Add Custom and Pre-made Sections
  • 4. Save the Record
  • Using your new Record Type
  • Using your New Report
  • 1. Accessing the Reports Center
  • 2. Creating a New Report
  • 3. Supervisor Panel
  • Updating Old Records with New Preview Fields
  • How does the re-sync work?
  • Linking Vehicle and Character Searches
  • Civilian Field UIDs
  • Vehicle Field UIDs
  • Common Issues
  • ERROR: This record template has no fields enabled for preview.

Was this helpful?

Edit on GitHub
  1. Tutorials
  2. Customization

Creating Custom Record and Report Types

Learn how to create custom record and report types for your community!

PreviousCommunity Branding and SettingsNextSharing Custom Records

Last updated 6 months ago

Was this helpful?

Custom record and reports are limited based upon your subscription version. For more information, please view our .

Sonoran CAD allows your community to create custom records and incident reports for police, fire, and EMS services. This tutorial will cover the basics of creating a new custom report or record and general usage of the system.

Video Tutorial

Creating a new Report or Record:

1. Navigate to the Record Editor

Navigate to Admin > Customization > Custom Records

2. Select the new Record Type

From the "New Record Type" dropdown, select the desired record type. Records follow the standard record editing and lookup system, and require a civilian or vehicle field to be searched. Reports can be searched in the unit's report center via number or identifier.

3. Add Custom and Pre-made Sections

Add your desired custom and premade sections, edit fields, and more!

The enable duplicate button allows users to click and create a new copy of the section while filing the record.

Field Types

Text

These fields are generic text boxes.

Select

The select field allows you to customize a dropdown box.

Text Area

The text area field allows you to create a large text area.

Checkboxes

The checkboxes type allows you to create multiple checkboxes.

Date

The date field allows you to specify a date field. You can also specify the formatting in the mask column.

When readOnly is selected, this field will auto-fill the current date for new records.

The time field allows you to specify a time field.

Image

The image field allows you to specify an image to be displayed.

Linked Records

The linked records field allows you to link and cross-reference other records and reports to this record.

Flags

Custom flag options can be added to every record template. When checked, these flags will show up as alerts on any lookup. Similar to a checkboxes section, you will need to expand the section and add options.

Label

Labels can display static text, along with color attributes.

Address

Unit Information

The UNIT_NUMBER, UNIT_NAME, UNIT_RANK, UNIT_AGENCY, UNIT_DEPARTMENT, UNIT_SUBDIVISION, UNIT_AGENCY_LOCATION, UNIT_AGENCY_ZIP, and UNIT_LOCATION field types will all automatically insert the unit's information when they create a new record.

Field Options

Preview

This will show the field label and value in the lookup table preview.

Supervisor

This will disable the field for all non-supervisor unit identifiers. Your unit's supervisor status can be set in the unit identifier editor.

Required

Required fields will require the unit to enter something into the field before the record can be submitted.

Unique

Unique fields enforce that no duplicate values for this field are stored in the database. These values are enforced for the specific record template only.

Unique fields can only be on non-DB Sync records and in custom sections.

Read Only

Read only fields prevent the user from entering new or modified text. This is used for auto-filled fields like unit information when a new record is created.

Field Mask

The field mask allows you to specify a required format for the field.

  • #: Number

  • S: A-Z Letter

  • X: Alphanumeric

Example: Numbers

Specifying ### allows the user to only enter 3 numbers in the field.

Example: Phone Number

Specifying (###) ### - #### formats the user's input into a phone number.

Field Size

The field size slider allows you to select a field size value between 1 and 12.Every row of a record has a space divisible by 12.

Dependencies

Dependencies allow you to make an individual field or entire section visible based on conditions.

Copy Parent Field ID

Expand a field and copy the unique Field Mapping ID.

Set Child Dependency

On a section or field, click the dependency button to open the editor.

Paste the unique Field Mapping ID from before. The box will light up green when a valid ID is entered.

Checkbox or Select fields as the dependency parent will allow you to select what values will display this section or field.

Text fields as the dependency parent will allow you to enter what text values will display this section or field.

Dependency Types

There are multiple options for dependency types.

  • Equal

    • Dependency will display if the entered content are an exact match to the specified value(s)

  • Not Equal

    • Dependency will display if the entered content is NOT equal to the specified value(s)

  • Contains

    • Dependency will display if the entered content contains any of the specified values(s)

4. Save the Record

Be sure to set the record name, and press SAVE

Using your new Record Type

Using your New Report

1. Accessing the Reports Center

In the police, dispatch, fire, or EMS page, select "REPORTS" in the top action menu bar From here, you can create a new report, search existing reports, and view reports requiring supervisor actions.

2. Creating a New Report

Select "New Report" and the desired custom report type from the dropdown button From there, you can fill out the fields and add the record.

3. Supervisor Panel

Updating Old Records with New Preview Fields

Many communities decide to enable a custom field for preview after many records of that type have already been created.

Ex: Adding a previewed field to show the license "Type"

Communities can process a manual updating of historical records in the custom records menu.

How does the re-sync work?

Sonoran CAD will search for all records of this type and attempt to automatically update any historical records with the latest preview field preferences.

Because Sonoran CAD records are entirely customizable, changing the field UID (unique ID) from one revision to the next will result in a failure to match and update the preview field.

Database sync records do not have the option to re-sync, as they will always be up-to-date.

A re-sync is only available once per 10 minutes.

Linking Vehicle and Character Searches

Custom records allow the addition of a character and vehicle search button in sections. Clicking these allows the user to search and import a vehicle or character into the record section.

Character and vehicle searches will not fill out fields in your record if the record field UIDs are incorrect.

In order for these searches to properly place the vehicle and civilian record in your custom record fields, specific field uid values must match.

Civilian Field UIDs

The default Civilian record has the following field UIDs:

first last mi dob age sex aka zip occupation height weight skin hair eyes emergencyContact emergencyRelationship emergencyContactNumber residence

When creating your custom record section with civilian search imports, those field UIDs will also need to match. The image below shows a custom record with the civilian search section toggled with the matching field UIDs.

Vehicle Field UIDs

The default Vehicle Registration record has the following field UIDs

type plate make model color year

When creating your custom record section with vehicle search imports, those field UIDs will also need to match. The image below shows a custom record with the vehicle search section toggled with the matching field UIDs.

Common Issues

ERROR: This record template has no fields enabled for preview.

You may encounter this error whilst attempting to save a custom record template.

"Preview Fields" are what show up when you run a record lookup (first, last, age, plate, etc.). The image below shows an example of "preview fields" on a vehicle registration record.

We require at least one field to be enabled for preview, as running a lookup with no preview fields would return a blank list of records.

To designate a field as a "preview field", simple toggle the magnifying glass icon in the custom record editor, as shown below.

View our on creating custom reports and records.

If your section is a custom character or vehicle field, you can toggle on the search button. This allows the section to be filled via when creating a new one. .

The address dropdown will auto-filter .

Note: The date and time fields will auto-fill with the current date/time if readOnly is toggled, based on the .

In the police, dispatch, fire, or EMS page you can now or for the new record type.

If the "NEW REPORT" button, or actions on the report viewer are disabled, you are missing the to do so.

The supervisor panel shows all reports that have a blank field that requires supervisor permissions. If you do not have the supervisor panel enabled, you will need to have the .

video tutorial
street address names that have been imported via CSV
community's timezone
add
search
permissions
supervisor permission granted on your account
Learn more about ensuring civilian and vehicle searches link to your custom record fields
pricing page
Sonoran CAD's Custom Record Types
Select custom or premade sections from the dropdown buttons
Sonoran CAD: Custom Record Section Options
Saving your new custom record
Sonoran CAD Reports Center
Resync Preview Fields
Resync Preview Fields - Confirm
Custom Record - Vehicle and Civilian search sections
Sonoran CAD - Preview Fields Example (Shown in Yellow)
Sonoran CAD - Enable Field for Preview
The 'SELECT' field option
A 'SELECT' field shown in the record editor
A 'TEXTAREA' field shown in the record editor
The 'TEXTAREA' field option
The 'CHECKBOXES' field option
A 'CHECKBOXES' field shown in the record editor.
The 'DATE' field option
The 'TIME' field shown in the record editor
The 'TIME' field option
The 'IMAGE' field option.
The 'IMAGE' field shown in the record editor
Sonoran CAD - Linked Records
The 'DATE' field shown in the record editorTime
Sonoran CAD - Custom Record Label
Sonoran CAD - Custom Flags
Sonoran CAD - Custom Record Address Field
Input field with SUPERVISOR toggled
Supervisor field highlighted red
Input field with REQUIRED toggled
Required field shown in the record editor
Custom Records - Read Only Toggle
Custom Records - Read Only Fields