# Dispatch Notify
This submodule: * Notifies officers of incoming calls * [Allows officers to attach to calls via command](#2-officer-attaches-to-the-call) * Automatically routes attached units to the postal code * Unit GPS routing is updated whenever the dispatch postal is updated * [Allows the call postal and GPS routing to be automatically updated to the primary unit's location](#primary-unit-tracking-pursuit) * Notifies the civilian making the emergency call when an officer is en-route. ## Activation Guide ### 1. Download and Install the Resource {% hint style="info" %} This submodule is already **enabled by default** when installing the [Sonoran CAD FiveM resource](/cad/integration-plugins/in-game-integration/fivem-installation.md). \ The [locations submodule](/cad/integration-plugins/in-game-integration/available-plugins/locations.md) includes required logic to send location data and is **already enabled by default**. Keep this submodule enabled to maintain functionality. \ The [call commands submodule](/cad/integration-plugins/in-game-integration/available-plugins/call-commands.md) includes required logic to create emergency calls and is **already enabled by default**. Keep this submodule enabled to maintain functionality. \ The [postals submodule](/cad/integration-plugins/in-game-integration/available-plugins/postals.md) is optional and also enabled by default. Keep this submodule enabled if you wish to include postal code information with emergency calls. {% endhint %} ### 2. Adjust the Configuration The CAD display settings are stored inside of the `/configuration/dispatchnotify_config.lua` file. ### 3. Ensure Players are Linked Ensure the players have already [linked their CAD](/cad/integration-plugins/in-game-integration/link-user-in-game.md) for this integration to work. ### Configuration Review the `dispatchnotify_config.lua` file to configure the submodule to behave how you like. The file is well documented. Please review **all** the settings! {% hint style="info" %} Dispatch Notify no longer has its own per-submodule notification selector. All user-facing FiveM notifications are now configured in `/configuration/config.json` with `notificationSystem`. Supported values: * `auto` * `ox_lib` * `lation_ui` * `pnotify` * `chat` `auto` resolves in this order: 1. `ox_lib` 2. `lation_ui` 3. `pnotify` 4. `chat` {% endhint %}
dispatchnotify_config.lua | Config Value | Description | | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | enableUnitNotify | Enable incoming 911 call notifications | | emergencyCallType | Specifies what emergency calls are displayed as. Some countries use different numbers (like 999) | | civilCallType | Specifies non-emergency call types. If unused, set to blank ("") | | dotCallType | Some communities use 511 for tow calls. Specify below, or set blank ("") to disable | | respondCommandName | Command to respond to calls with | | enableUnitResponse |

Enable call responding (self-dispatching)

If disabled, running commandName will return an error to the unit

| | dispatchDisablesSelfResponse | If a dispatcher is detected to be online, automatically disable the response command. | | dispatchDisablesUnitNotify | If a dispatcher is detected to be online, automatically suppress incoming 911 call notifications to units. | | enableUnitNotifyToggleCommand | Enable an in-game command to override unit 911 notifications | | unitNotifyToggleCommand | In-game command to override unit 911 notifications | | unitNotifyToggleAce | Ace permission allowed to use the command. Leave blank ("") to allow anyone to use the command | | enableCallerNotify | Enable "units are on the way" notifications | | notifyMessage |

NotifyMessage: Message template to use when sending to the player

You can use the following replacements:

{officer} - officer name

| | incomingCallMessage |

How should officers be notified of a new 911 call? Parameters:
{location} - location of call (street + postal)
{description} - description as given by civilian
{caller} - caller's name
{callId} - ID of the call so LEO can respond with /r911
{command} - The command to use

| | unitDutyMethod |

How to detect if units are online?
incad: units must be logged into the CAD
permissions: units must have the "sonorancad.dispatchnotify" ACE permission (see docs)
esxjob: requires esxsupport submodule, use jobs instead for on duty detection
custom: Use custom function (defined below as unitDutyCustom)

| | esxJobsAllowed | What jobs should count as being on duty? | | waypointType |

Customise the title of a call made in the CAD
postal: set gps to caller's postal (less accurate, more realistic) - REQUIRES CONFIGURED POSTAL SUBMODULE
exact: set gps to caller's position (less realistic)
none: disable waypointing

| | waypointFallbackEnabled | Fall back to postal if exact coordinates cannot be found (for self-generated calls) | | callTitle |

Type of waypoint to use when officer is attached
Default: OFFICER RESPONSE

| | sendNotesToUnits | Enable "the sending of notes to units" notifications | | notifyMessage |

NotifyMessage: Message template to use when sending to the player

You can use the following replacements:

{callid} - The CAD Call ID

{note} - The Note Added

| | enableAddNote | Enable "the adding of the notes" notifications | | addNoteCommand | Command to add notes to a call with | | enableAddPlate | Enable "the adding of plates that are locked" notifications - REQUIRES [CONFIGURED WRAITHV2 ](broken://pages/-M7U3aBbrsfrj1Cmeqmm)SUBMODULE | | addPlateCommand | Command to add plates to a call with |
## Commands In-game commands can be used to * `/dn respond [id`] Respond/Attach to the newly created dispatch call ID * `/dn notify [on/off/auto]` - Toggle chat alerts on, off, or auto (using the configuration file's default) * `/dn note [text]` Add a note to the current dispatch call * `/dn plate` Adds your currently locked license plate number as a note from the [Wraith ALPR](/cad/integration-plugins/in-game-integration/available-plugins/wraithv2.md) submodule * `/dn gps` Toggles on/off automatic GPS routing to the call's postal code
## Dispatch Call Responding ### 1. Civilian Places a 911 Call This call can be placed from the Civilian menu of the CAD, or via the `/911` command in-game, supplied by the [callcommands](/cad/integration-plugins/in-game-integration/available-plugins/call-commands.md) submodule. ### 2. Officer Attaches to the Call The unit will see a notification message of the incoming call, complete with the command to run in order to attach.
## Primary Unit Tracking (Pursuit) Dispatch notify can also be used to track the primary unit on a call. This will automatically update the postal code on the dispatch call to the primary unit's current location. This is highly useful for pursuits, where additional units need to catch up and join the chase. ### 1. Toggle Unit Tracking for the Primary Unit Dispatchers (or self-dispatch) can set the primary unit to any unit currently attached to the call. The slider next to the Primary Unit box will toggle tracking mode. When enabled, the postal will automatically update based on the primary unit's location and be sent to all attached units.
## Troubleshooting * No notifications for 911 calls * Units must be logged into the CAD (by default) or meeting the requirements depending on how the submodule is configured. * Verify `/configuration/config.json` has the correct `notificationSystem` value. * If `notificationSystem` is `auto`, Sonoran CAD will use `ox_lib`, then `lation_ui`, then `pnotify`, then `chat`. * Units do not automatically attach to calls * Ensure the players have already [linked their CAD](/cad/integration-plugins/in-game-integration/link-user-in-game.md) for this integration to work. * Caller is not notified when units attach to the call * If the caller ever leaves the server and rejoins, this feature does not work. * If dispatch created the call within the CAD, there is no way to notify a caller. * Ensure you are not overriding the 911 command (default `/911`) with another resource. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/available-plugins/dispatch-notify.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.