Ctrl K
ring2all.com

Provisioning Templates Module Documentation

Table of Contents

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

---

1. Module Overview (Technical)

What Are Provisioning Templates?

Provisioning Templates is a device configuration template module that creates reusable configurations for IP phones. Templates define DSS keys, expansion modules, phonebooks, GUI settings, and custom configuration using Jinja2 syntax.

Architecture

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│            Provisioning Templates Architecture                 │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Admin Panel                                                    │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Provisioning Templates                            │   │
│  │                                                          │   │
│  │  Template Settings:                                      │   │
│  │  ├─ Model Selection (Yealink T54W)                      │   │
│  │  ├─ Server & Localization                               │   │
│  │  ├─ DSS Keys (BLF, Speed Dial)                          │   │
│  │  ├─ Expansion Modules                                   │   │
│  │  ├─ Phonebooks                                          │   │
│  │  ├─ GUI Settings (Wallpaper)                            │   │
│  │  └─ Custom (Jinja2 Template)                            │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Applied to devices                                     │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Provisioning Devices                              │   │
│  │                                                          │   │
│  │  Device (MAC) → Template → Generated Config            │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Generates config files                                 │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Configuration Files                               │   │
│  │                                                          │   │
│  │  /var/www/provisioning/                                 │   │
│  │  ├─ AA-BB-CC-DD-EE-FF.cfg                              │   │
│  │  │   (Template + Device variables)                      │   │
│  │  └─ 11-22-33-44-55-66.cfg                              │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Key Tables

TablePurpose
public.provisioning_templatesTemplate definitions

Key Files

FileDescription
modules/provisioningTemplates/Frontend module
/var/www/provisioning/.cfgGenerated config files
---

2. Module Overview (Commercial/Business)

Business Value

Provisioning Templates provides standardized device configuration:

Without TemplatesWith Templates
Manual configAutomated setup
InconsistentStandardized
Error-proneTemplate-driven
Time-consumingRapid deployment

Use Cases

  1. Bulk Deployment

- Deploy many phones quickly

- Consistent settings

  1. Department Templates

- Sales phone setup

- Support desk config

  1. DSS Key Programming

- BLF/Line keys

- Speed dial buttons

  1. Custom Branding

- Wallpapers

- Display settings

Feature Highlights

FeatureBenefit
Model-SpecificCorrect capabilities
DSS KeysBLF, speed dial, line keys
Expansion ModulesKey attachment config
PhonebooksDirectory integration
GUI SettingsWallpaper customization
Jinja2 TemplatesDynamic configuration
---

3. Module Overview (End User/Administrator)

What Can You Do?

  • Create templates for phone models
  • Configure DSS keys (BLF, speed dial, line)
  • Set up expansion module keys
  • Assign phonebooks
  • Upload wallpapers
  • Write custom Jinja2 configurations
  • Set timezone and language

Provisioning Templates Interface

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Provisioning Templates                             │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  [+ Create Template]                                            │
│                                                                 │
│  ┌───────────────────────────────────────────────────────────┐  │
│  │ Name              │ Vendor      │ Model   │ Devices │     │  │
│  ├───────────────────┼─────────────┼─────────┼─────────┼─────┤  │
│  │ Sales Team        │ Yealink     │ T54W    │ 25      │ ✏️  │  │
│  │ Support Desk      │ Yealink     │ T46U    │ 12      │ ✏️  │  │
│  │ Reception         │ Grandstream │ GXP2170 │ 3       │ ✏️  │  │
│  │ Conference Room   │ Polycom     │ VVX450  │ 5       │ ✏️  │  │
│  └───────────────────────────────────────────────────────────┘  │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Create/Edit Template

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Create Template                                    │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Template Name: [Sales Team                  ]                 │
│                                                                 │
│  Vendor: [Yealink ▼]    Model: [T54W ▼]                        │
│                                                                 │
│  Server: [pbx.example.com             ]                        │
│  Timezone: [America/New_York ▼]                                │
│  Language: [English ▼]                                         │
│                                                                 │
│  Admin Password: [••••••••              ]                      │
│  Time Format: [12-hour ▼]                                      │
│  Date Format: [MM/DD/YYYY ▼]                                   │
│  Daylight Savings: ✓                                           │
│                                                                 │
│  ──────────────────────────────────────────────────────────────│
│                                                                 │
│  [DSS Keys] [Key Expansion] [Phonebooks] [GUI Settings] [Custom]│
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

DSS Keys Tab

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              DSS Keys Configuration                             │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  T54W supports 10 DSS Keys                                      │
│                                                                 │
│  ┌─────────────────────────────────────────────────────────────┐│
│  │ Key │ Type        │ Value          │ Line │               ││
│  ├─────┼─────────────┼────────────────┼──────┼───────────────┤│
│  │ 1   │ BLF         │ 1001           │ 1    │ ✏️ 🗑        ││
│  │ 2   │ BLF         │ 1002           │ 1    │ ✏️ 🗑        ││
│  │ 3   │ BLF         │ 1003           │ 1    │ ✏️ 🗑        ││
│  │ 4   │ Speed Dial  │ 5551234567     │ -    │ ✏️ 🗑        ││
│  │ 5   │ Line        │ 2              │ 2    │ ✏️ 🗑        ││
│  │ 6   │ N/A         │ -              │ -    │ ✏️           ││
│  │ ... │ ...         │ ...            │ ...  │ ...          ││
│  └─────────────────────────────────────────────────────────────┘│
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Custom Tab (Jinja2)

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Custom Configuration Template                      │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Use Jinja2 syntax: {{ variable }} for dynamic values          │
│                                                                 │
│  Available Variables: [mac] [extension] [password] [server]    │
│                                                                 │
│  ┌─────────────────────────────────────────────────────────────┐│
│  │ # Custom Yealink Configuration                             ││
│  │ account.1.label = {{ extension }}                          ││
│  │ account.1.display_name = {{ name }}                       ││
│  │ account.1.user_name = {{ extension }}                     ││
│  │ account.1.password = {{ password }}                       ││
│  │ account.1.sip_server_host = {{ server }}                  ││
│  │                                                             ││
│  │ local_time.time_zone = -5                                  ││
│  │ local_time.dst_time_type = 1                               ││
│  └─────────────────────────────────────────────────────────────┘│
│                                                                 │
│  38 lines | 1,245 characters                                   │
│                                                                 │
│  [Reset to original template]                                   │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Quick Tips

TIP
Select Model First: Model determines available DSS keys.
TIP
Jinja2 Variables: Use {{ mac }}, {{ extension }}, {{ password }}.
NOTE
Reset Available: Revert custom config to original template.

---

4. Configuration Tabs

DSS Keys Tab

SettingDescription
KeyKey number
TypeBLF, Speed Dial, Line, etc.
ValueExtension/number
LineAssociated SIP line

Key Expansion Tab

SettingDescription
ModuleExpansion module number
Keys per ModuleKeys available
Key ConfigurationSame as DSS keys

Phonebooks Tab

SettingDescription
PhonebookSelect phonebook
Server AddressRemote phonebook URL
AuthenticationUser/password

GUI Settings Tab

SettingDescription
WallpaperPhone background image

Custom Tab

SettingDescription
TemplateJinja2 configuration text
---

5. Settings Reference

DSS Key Types

TypeDescription
BLFBusy Lamp Field (extension monitor)
Speed DialQuick dial number
LineSIP line registration
TransferCall transfer button
HoldHold button
DNDDo Not Disturb toggle
VoicemailDirect voicemail access

Jinja2 Variables

VariableDescription
{{ mac }}Device MAC address
{{ extension }}SIP extension number
{{ password }}SIP password
{{ server }}SIP server address
{{ name }}Display name
{{ domain }}SIP domain

Time Formats

FormatExample
12-hour2:30 PM
24-hour14:30
---

6. Common Scenarios & Examples

Scenario 1: Create Basic Template

  1. Click "Create Template"
  2. Enter name
  3. Select vendor and model
  4. Set server and timezone
  5. Save

Scenario 2: Configure BLF Keys

  1. Open template
  2. Go to DSS Keys tab
  3. For each key:

- Type = BLF

- Value = extension number

- Line = 1

  1. Save

Scenario 3: Add Custom Config

  1. Open template
  2. Go to Custom tab
  3. Enter Jinja2 configuration
  4. Use available variables
  5. Save

Scenario 4: Set Up Phonebook

  1. Open template
  2. Go to Phonebooks tab
  3. Select phonebook
  4. Configure server if remote
  5. Save

---

7. Limitations & Important Notes

Technical Notes

NOTE
Model Selection: Template is model-specific.
NOTE
DSS Limits: Key count depends on model.
WARNING
Cannot Delete: Templates with devices cannot be deleted.

Best Practices

  1. Name Clearly: "Sales Team Yealink T54W"
  2. Select Model First: Before configuring keys
  3. Test Template: Create test device first
  4. Document Keys: Keep record of BLF mappings
  5. Backup Custom: Save custom templates elsewhere

Jinja2 Tips

Jinja2
{# Comment #}
{{ variable }}

{# Conditional #}
{% if extension %}
account.1.user_name = {{ extension }}
{% endif %}

{# Loop #}
{% for i in range(1, 3) %}
linekey.{{ i }}.type = 1
{% endfor %}

---

8. Troubleshooting Tips

Common Issues

SymptomPossible CauseSolution
Can't delete templateHas devicesRemove devices first
Keys not workingWrong typeCheck key type
Config not appliedTemplate errorCheck Jinja2 syntax
BLF not lightingWrong extensionVerify extension exists

Check Template

Sql
SELECT 
  t.name,
  m.model_name,
  t.settings
FROM public.provisioning_templates t
JOIN public.provisioning_device_models m ON m.id = t.model_id
WHERE t.name = 'template-name';

Validate Jinja2

Test template rendering before deployment using the preview feature.

---

9. Glossary

TermDefinition
TemplateReusable configuration
DSS KeysProgrammable phone buttons
BLFBusy Lamp Field
Jinja2Template syntax
Expansion ModuleKey attachment
PhonebookContact directory
---

Lua Script Status ℹ️

Configuration Module

ComponentStatus
Provisioning Templatesℹ️ Configuration generator - processes Jinja2 templates
Provisioning Templates is a configuration module. Templates are processed with Jinja2 to generate device-specific configuration files. No Lua handlers are used.

---

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?