FreePBX Match Pattern Check Tool

Wildcards and Special Characters

FreePBX provides a variety of wildcards and special characters that can be used in Match Patterns to create flexible and precise rules. The following table provides an overview of the most important wildcards:

Match Patterns Without an Underscore

In Outbound Routes (outgoing routes), Match Patterns are entered without the underscore (_). FreePBX automatically adds the underscore in the backend when pattern matching is required. This simplifies configuration, as the administrator does not need to manually manage the underscore.

Example:
For local numbers, you would simply use NXXXXXXX instead of _NXXXXXXX.

Configuration Steps:

1. Navigate to Outbound Routes: Log in to the FreePBX Dashboard and go to Connectivity > Outbound Routes.
2. Create or Edit an Outbound Route: Click on Add Outbound Route or select an existing route.
3. Set the Match Pattern: In the Dial Patterns field, enter the pattern without the underscore, e.g., NXXXXXXX.
4. Define the Destination: Select the desired trunk or destination for this route.
5. Save and Apply: Click Submit and then Apply Config.

Match Patterns With an Underscore

In certain contexts such as Caller ID (CID) fields or custom dialplan scripts, Match Patterns with an underscore (_) can be used. The underscore signals to Asterisk that the following pattern should be interpreted as a regular expression.

Step-by-Step Guide:

1. Define Requirements:
   Begin with a thorough analysis of the required types of numbers. Determine which types of numbers (e.g., local numbers, internal extensions) need to be handled and identify the target groups.
2. Select Wildcards:
   Decide which wildcards best fit your requirements. Use N, Z, X according to the digit restrictions, and use [ ] to define specific groups.
3. Add Fixed Characters if Needed:
   Add fixed characters like numbers or the + sign, if necessary.
4. Create and Test the Pattern:
   Combine the selected wildcards and fixed characters into a complete pattern. Test the pattern using tools available on this page and, of course, by simulating calls with various numbers to ensure everything works as expected.

Best Practices:

• Clarity and Simplicity: Keep patterns as simple as possible to ensure maintainability. Complex patterns can be hard to understand and manage.
• Documentation: Document each pattern and its function. Clear documentation helps with traceability and future modifications.
• Specificity Over Generalization: Define patterns as specifically as possible to avoid unwanted matches. More precise patterns reduce the risk of misrouting and security gaps.
• Use of Contexts: Use different inbound routes to organize different patterns for different purposes. This enhances clarity and simplifies management.
• Consider Security: Limit the number of allowed calling numbers to prevent abuse. Implement security measures like Access Control Lists (ACLs) and rate limiting.
• Regular Review and Adjustment: Regularly review patterns and adjust them according to changed requirements. Continuous monitoring and adjustment ensure that the system functions optimally.

Match Patterns ohne Unterstrich

In den Outbound Routes (ausgehende Routen) werden Match Patterns ohne den Unterstrich (_) eingegeben. FreePBX fügt den Unterstrich automatisch im Backend hinzu, wenn ein Pattern-Matching erforderlich ist. Dies vereinfacht die Konfiguration, da der Administrator sich nicht manuell um den Unterstrich kümmern muss.

Beispiel:
Für lokale Nummern wird einfach NXXXXXXX verwendet, anstatt _NXXXXXXX.

Konfigurationsschritte:

1. Navigieren zu Outbound Routes: Melden Sie sich im FreePBX-Dashboard an und gehen Sie zu Connectivity > Outbound Routes.
2. Erstellen oder Bearbeiten einer Outbound Route: Klicken Sie auf Add Outbound Route oder wählen Sie eine bestehende Route aus.
3. Festlegen des Match Patterns: Im Feld Dial Patterns geben Sie das Muster ohne Unterstrich ein, z.B. NXXXXXXX.
4. Ziel-Destination definieren: Wählen Sie den gewünschten Trunk oder die Ziel-Destination für diese Route.
5. Speichern und Anwenden: Klicken Sie auf Submit und dann auf Apply Config.

Match Patterns mit Unterstrich

In bestimmten Kontexten, wie beispielsweise in Caller ID (CID)-Feldern oder benutzerdefinierten Dialplan-Skripten, können Match Patterns mit einem Unterstrich (_) verwendet werden. Der Unterstrich zeigt Asterisk an, dass das folgende Muster als regulärer Ausdruck interpretiert werden soll.

Schritt-für-Schritt-Anleitung

1. Anforderungen definieren:
   Beginnen Sie mit einer gründlichen Analyse der benötigten Nummernarten. Bestimmen Sie, welche Arten von Nummern (z. B. lokale Nummern, interne Durchwahlen) behandelt werden sollen und identifizieren Sie die Zielgruppen.
2. Platzhalter auswählen:
   Entscheiden Sie, welche Platzhalter am besten zu Ihren Anforderungen passen. Nutzen Sie N, Z, X entsprechend den Ziffernbeschränkungen und verwenden Sie [ ], um spezifische Gruppen zu definieren.
3. Gegebenenfalls feste Zeichen integrieren:
   Fügen Sie feste Zeichen wie Zahlen oder das + hinzu, wenn notwendig.
4. Muster erstellen und testen:
   Kombinieren Sie die ausgewählten Platzhalter und festen Zeichen zu einem vollständigen Muster. Testen Sie das Muster z. B. mit dem verfügbaren Prüftool und simulieren Sie Anrufe mit verschiedenen Nummern, um sicherzustellen, dass alles wie erwartet funktioniert.

Best Practices

• Klarheit und Einfachheit:
  Halten Sie die Muster so einfach wie möglich, um die Wartbarkeit zu gewährleisten. Komplexe Muster können schwer verständlich und schwer zu verwalten sein.
• Dokumentation:
  Dokumentieren Sie jedes Muster und dessen Funktion. Eine klare Dokumentation erleichtert die Nachvollziehbarkeit und zukünftige Anpassungen.
• Spezifität statt Allgemeinheit:
  Definieren Sie Muster so spezifisch wie möglich, um unerwünschte Übereinstimmungen zu vermeiden. Präzisere Muster minimieren das Risiko von Fehlleitungen und Sicherheitslücken.
• Verwendung von Kontexten:
  Nutzen Sie unterschiedliche Inbound Routes, um verschiedene Muster für unterschiedliche Zwecke zu organisieren. Dies verbessert die Übersichtlichkeit und vereinfacht die Verwaltung.
• Sicherheit berücksichtigen:
  Begrenzen Sie die Anzahl der erlaubten Anrufnummern, um Missbrauch zu verhindern. Implementieren Sie Sicherheitsmaßnahmen wie Access Control Lists (ACLs) und Ratenbegrenzung.
• Regelmäßige Überprüfung und Anpassung:
  Überprüfen Sie die Muster regelmäßig und passen Sie sie an geänderte Anforderungen an. Eine kontinuierliche Überwachung und Anpassung stellt sicher, dass das System stets optimal funktioniert.