Ctrl K
ring2all.com

Dispatch Locations Module Documentation

Table of Contents

  1. Module Overview (Technical)
  2. Module Overview (Commercial/Business)
  3. Module Overview (End User/Administrator)
  4. Configuration Fields Reference
  5. Address Components
  6. Common Scenarios & Examples
  7. Limitations & Important Notes
  8. Troubleshooting Tips
  9. Glossary

---

1. Module Overview (Technical)

What Are Dispatch Locations?

Dispatch Locations are dispatchable address records that provide precise physical location information for E911 compliance. They support RAY BAUM's Act requirements by associating detailed location data (street, building, floor, room) with extensions, devices, or trunks.

Architecture

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│                  Dispatch Locations System                      │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │               Dispatch Location Record                   │   │
│  │                                                          │   │
│  │  Location Name: Main Building - 3rd Floor East           │   │
│  │                                                          │   │
│  │  Assignment:                                             │   │
│  │  ├─ Type: Extension                                      │   │
│  │  └─ Extension: 1001                                      │   │
│  │                                                          │   │
│  │  Address:                                                │   │
│  │  ├─ Street: 123 Main Street, Suite 300                   │   │
│  │  ├─ City: Miami                                          │   │
│  │  ├─ State: FL                                            │   │
│  │  └─ ZIP: 33131                                           │   │
│  │                                                          │   │
│  │  Building Details:                                       │   │
│  │  ├─ Building: Main Building                              │   │
│  │  ├─ Floor: 3                                             │   │
│  │  ├─ Room: 310                                            │   │
│  │  └─ Wing: East                                           │   │
│  │                                                          │   │
│  │  Emergency:                                              │   │
│  │  ├─ ELIN: +13055551234                                   │   │
│  │  └─ Contact: John Smith (305) 555-9999                   │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Used during 911 calls                                   │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │  Emergency Call Routing                                  │   │
│  │                                                          │   │
│  │  Extension 1001 dials 911                                │   │
│  │  → Lookup dispatch location by extension                 │   │
│  │  → Override Caller ID with ELIN                          │   │
│  │  → Include dispatchable location in call                 │   │
│  │  → Route to PSAP                                         │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Key Tables

TablePurpose
public.dispatch_locationsLocation records
public.sip_extensionsExtension association

Key Files

FileDescription
modules/dispatchLocations/DispatchLocationsPage.tsxMain page
modules/dispatchLocations/DispatchLocationFormView.tsxConfiguration form
---

2. Module Overview (Commercial/Business)

Business Value

Dispatch Locations provides E911 location compliance:

Without Dispatch LocationsWith Dispatch Locations
Generic addressBuilding/floor/room
Delayed responsePinpoint accuracy
Compliance riskRAY BAUM's compliant
Manual updatesCentralized management

Regulatory Compliance

RegulationRequirementSolution
RAY BAUM's ActDispatchable locationFloor/room/wing data
NG911Precise coordinatesLat/long support
Kari's LawOn-site notificationEmergency contact

Use Cases

  1. Multi-Floor Buildings
- Per-floor location records

- Room-level precision

  1. Campus Environments
- Multiple buildings

- Building-specific ELINs

  1. Remote Workers
- Home office addresses

- Per-device locations

  1. Multi-Tenant Systems
- Tenant-specific locations

- Shared building compliance

Feature Highlights

FeatureBenefit
Full AddressComplete street address
Building DetailsFloor, room, wing
ELIN SupportLocation-specific callback
GPS CoordinatesPrecise positioning
Assignment TypesExtension, device, trunk
Special InstructionsFirst responder notes
---

3. Module Overview (End User/Administrator)

What Can You Do?

  • Create location records with full addresses
  • Add building/floor/room details
  • Assign locations to extensions or devices
  • Configure ELIN numbers
  • Add emergency contact info
  • Include special instructions

Dispatch Location Form

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Create Dispatch Location                           │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Section: Basic Information                                     │
│  ├─ Location Name: Main Building - 3rd Floor East              │
│  ├─ Location Code: MB-3E                                       │
│  └─ Enabled: ✓                                                 │
│                                                                 │
│  Section: Assignment                                            │
│  ├─ Assignment Type: [User/Extension ▼]                        │
│  └─ Extension: [1001 - John Smith ▼]                           │
│                                                                 │
│  Section: Street Address                                        │
│  ├─ Street Number: 123                                         │
│  ├─ Street Name: Main                                          │
│  ├─ Street Suffix: Street                                      │
│  ├─ Unit Type: [Suite ▼]                                       │
│  ├─ Unit Number: 300                                           │
│  ├─ City: Miami                                                │
│  ├─ State: FL                                                  │
│  ├─ ZIP Code: 33131                                            │
│  └─ Country: US                                                │
│                                                                 │
│  Section: Building/Room Details                                 │
│  ├─ Building Name: Main Building                               │
│  ├─ Floor: 3                                                   │
│  ├─ Room: 310                                                  │
│  └─ Wing: East                                                 │
│                                                                 │
│  Section: Emergency Information                                 │
│  ├─ ELIN: +13055551234                                         │
│  ├─ Contact Name: John Smith                                   │
│  ├─ Contact Phone: (305) 555-9999                              │
│  └─ Special Instructions: Enter through main lobby...         │
│                                                                 │
│  [Save] [Cancel]                                                │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Quick Tips

TIP
Be Specific: Include floor, room, and wing for large buildings.
TIP
Update Regularly: Verify locations when employees move.
CAUTION
Critical Data: Inaccurate locations delay emergency response.

---

4. Configuration Fields Reference

Basic Information

FieldDescriptionExample
Location NameDescriptive nameMain Bldg - 3rd Fl East
Location CodeShort identifierMB-3E
EnabledActive statusOn/Off

Assignment

FieldDescription
Assignment TypeUser/Extension, Device, or Trunk
Extension IDAssociated extension
Device MACDevice MAC address
Site IDSite identifier

Street Address

FieldDescriptionExample
Street NumberBuilding number123
Street NameStreet nameMain
Street SuffixTypeStreet, Avenue
Unit TypeUnit categorySuite, Floor
Unit NumberUnit value300
CityCity nameMiami
StateState codeFL
ZIP CodePostal code33131
CountryCountry codeUS

Building/Room Details

FieldDescriptionExample
Building NameBuilding identifierMain Building
FloorFloor number3
RoomRoom number310
WingBuilding wingEast
LatitudeGPS latitude25.7617
LongitudeGPS longitude-80.1918

Emergency Information

FieldDescription
ELINEmergency Location ID Number
Contact NameOn-site emergency contact
Contact PhoneContact phone number
Special InstructionsFirst responder notes
ValidatedAddress verified
---

5. Address Components

Unit Types

TypeUsage
NoneNo sub-unit
ApartmentResidential apt
SuiteOffice suite
FloorEntire floor
OfficeSpecific office
BuildingEntire building
DepartmentDept area
PenthouseTop floor unit
BasementBelow ground

Assignment Types

TypeDescription
User/ExtensionAssigned to extension
DeviceAssigned to MAC address
TrunkAssigned to SIP trunk
---

6. Common Scenarios & Examples

Scenario 1: Single Floor Office

Location:
FieldValue
NameMiami Office
Street123 Main Street
Suite300
City/State/ZIPMiami, FL 33131
ELIN+13055551001
Assigned ToAll extensions

Scenario 2: Multi-Floor Building

Per-Floor Locations:
LocationFloorELIN
Main Bldg - 1st Floor1+13055551001
Main Bldg - 2nd Floor2+13055551002
Main Bldg - 3rd Floor3+13055551003

Scenario 3: Campus with Multiple Buildings

Per-Building Locations:
BuildingAddressELIN
Main Building100 Campus Dr+13055551100
Warehouse200 Campus Dr+13055551200
Annex300 Campus Dr+13055551300

Scenario 4: Remote Worker

Home Office Location:
FieldValue
NameJohn Smith - Home Office
Street456 Oak Lane
City/State/ZIPFort Lauderdale, FL 33301
ELIN+19545552001
Assigned ToExtension 1050
---

7. Limitations & Important Notes

Technical Notes

IMPORTANT
RAY BAUM's Act: Dispatchable locations required as of January 2022.
WARNING
Accuracy Critical: Wrong location = delayed emergency response.
NOTE
ELIN Required: Each location needs unique callback number.

Validation Requirements

FieldRequirement
Street NumberRequired
Street NameRequired
CityRequired
StateRequired
ZIP CodeRequired
CountryRequired

Best Practices

  1. Verify Addresses: Validate with USPS/carrier
  2. Update Regularly: When employees move
  3. Unique ELINs: One per location
  4. Contact Info: Current emergency contact
  5. Special Instructions: Access codes, hazards

---

8. Troubleshooting Tips

Common Issues

SymptomPossible CauseSolution
Location not usedNot assignedAssign to extension
Wrong locationOutdated recordUpdate location
No ELINMissing fieldAdd ELIN number
Address rejectedInvalid formatUse standard format
Not validatedNot verifiedValidate with carrier

Diagnostic SQL

List dispatch locations:

Sql
SELECT id, location_name, street_number, street_name, city, state, 
       building_name, floor, room, elin, enabled
FROM public.dispatch_locations
WHERE domain_id = [domain_id];

Find location by extension:

Sql
SELECT dl.* 
FROM public.dispatch_locations dl
JOIN public.sip_extensions se ON dl.extension_id = se.id
WHERE se.extension = '1001';

---

9. Glossary

TermDefinition
Dispatchable LocationPrecise physical address with floor/room
ELINEmergency Location Identification Number
RAY BAUM's ActUS law requiring dispatchable locations
NG911Next Generation 911
PSAPPublic Safety Answering Point
GPS CoordinatesLatitude/longitude location
---

Lua Script Status ℹ️

No Dedicated Lua Handler

ComponentStatus
Dispatch Locationsℹ️ Configuration module - data used by Emergency Numbers handler
Dispatch Locations is a configuration module. Location data is queried during emergency call routing by the E911 handler when determining caller location.

---

Documentation last updated: January 2026
AI Assistant

👋 Hello! I'm your Ring2All documentation assistant. I can help you find information about configuring and using the Ring2All PBX platform.

How can I help you today?