[Index]

Model: data/DeviceProfileConfigMapping

Device Profile Configuration Mapping

Full HTML Help

Configuration mapping is available for higher level administrators as a part of the overall configuration as well as for other purposes.

The table describes the purpose of configuration mapping:

Type Purpose
For phones and device profiles
  • Define the phones types available for selection.
  • Define the configuration settings used when a specific phone type is selected.
  • Allow multiple configurations, for example, different button templates for the same phone type.
  • Provide business-friendly names for different phone type configurations, rather than CUCM-defined names. For example: "Executive Phone with 2 lines".
  • Make use of phone-type-agnostic configuration templates (CFTs), allowing for the management of fewer CFTs in the system rather than a CFT for each phone type.
For lines, phones and device profiles Define a set of feature templates for use by lower-level administrators, and customize the configuration of the applicable item. This allows you to have different versions of configuration, as required.
For soft phones (specifically) Provide CFTs to manage the process of moving the soft phones of subscribers.

Phone Configuration Mapping

There may only be one phone configuration mapping at any hierarchy. This phone configuration mapping must be Default.

Mapping Profiles

The mapping profiles define the list of phone types that can be selected, and includes:

The value in the Profile Name field is presented to the lower-level administrator user in Phone drop-downs in the Admin Portal.

For example, if the administrator selects "Cisco 7841", then:

Note

The Base Configuration Template and the Feature Configuration Template may also contain profile item fields such as Phone Type and Protocol. In this case, the order of precedence for the values is:

  1. Feature Configuration Template
  2. Base Configuration Template
  3. Profile items

For example, a phone type specified in the Phone Type field under Profiles is superceded by the phone type specified in the Base Configuration Template or the Feature Configuration Template.

Feature Templates

The Feature Templates section of the Phone and Device Profile configuration mapping allows a higher-level administrator to configure a list of Feature Configuration Template CFTs, providing different configurations to complete the setting of the phone, device profile or line.

The image shows the list of available Feature templates:

The Feature templates are presented to the lower-level administrator as the list of templates (phone, device profile or line) that can be chosen when adding either a phone, extension mobility, or line. The Feature templates will contain the additional configuration settings that are applied on top of the settings mentioned above.

Macros for Phone Configuration Mapping

The table describes the available context macro variables when defining configuration templates for the phone mappings:

Macro Description
{{ input.standalone }} Flag whether it is a standalone phone or being associated with a subscriber.
{{ input.username }} Username of the subscriber the phone is being associated with. Only when standalone is false.
{{ input.device_type }} The user selected device type. This in fact is the phone mapping profile name.
{{ input.template_name }} The user selected feature template.
{{ input.name }} The user entered phone name.
{# input.lines #} The user entered list of lines.
{{ input.lines.0.directory_number }} The number of the first line.
{{ input.lines.0.template_name }} The user selected line template.
{{ input.lines.0.label }} The user entered line label.
{{ input.lines.0.display }} The user entered line display.
{{ pwf.user }} Object containing all UCM user settings of the associated subscriber. Only when standalone is false.

Device Profile Configuration Mapping

There may only be one device profile configuration mapping at any hierarchy, and the name of this mapping (at any hierarchy) must be Default.

The setup for device profile configuration mapping is identical to the phone configuration mapping. The phone type list and Feature* templates are presented to the administrator when adding an extension mobility service to a subscriber via the Subscriber Management page. See Feature Templates under Phone Configuration Mapping.

Line Configuration Mapping

There may only be one line configuration mapping at any hierarchy, and this line configuration mapping (at any hierarchy) must be Default.

A list of line templates can be configured and these will be presented to the administrator when new lines are be created, for example when adding a new phone.

Macros for Line Configuration Mapping

The table describes the available context macro variables when defining configuration templates for the line mappings:

Macro Description
{{ input.userid }} User ID for description.
{{ pwf.PassedLine.pattern }} Line pattern description.
{{ input.firstName }} User first name for Alerting name or ASCII Alerting name.
{{ input.lastName }} User last name for Alerting name or ASCII Alerting name.
{{ input.Phone.0.lines.line.0.dirn.pattern }} The destination.

The table describes the named macros that can be used when defining configuration templates for the line mappingse. High-level administrators with access to data/Macro can inspect and evaluate these named macros to verify result values. For details on Configuration Template customizations, see the Advanced Configuration Guide.

Device Profile Configuration Mapping

Full HTML Help

Configuration mapping is available for higher level administrators as a part of the overall configuration as well as for other purposes.

The table describes the purpose of configuration mapping:

Type Purpose
For phones and device profiles
  • Define the phones types available for selection.
  • Define the configuration settings used when a specific phone type is selected.
  • Allow multiple configurations, for example, different button templates for the same phone type.
  • Provide business-friendly names for different phone type configurations, rather than CUCM-defined names. For example: "Executive Phone with 2 lines".
  • Make use of phone-type-agnostic configuration templates (CFTs), allowing for the management of fewer CFTs in the system rather than a CFT for each phone type.
For lines, phones and device profiles Define a set of feature templates for use by lower-level administrators, and customize the configuration of the applicable item. This allows you to have different versions of configuration, as required.
For soft phones (specifically) Provide CFTs to manage the process of moving the soft phones of subscribers.

Phone Configuration Mapping

There may only be one phone configuration mapping at any hierarchy. This phone configuration mapping must be Default.

Mapping Profiles

The mapping profiles define the list of phone types that can be selected, and includes:

The value in the Profile Name field is presented to the lower-level administrator user in Phone drop-downs in the Admin Portal.

For example, if the administrator selects "Cisco 7841", then:

Note

The Base Configuration Template and the Feature Configuration Template may also contain profile item fields such as Phone Type and Protocol. In this case, the order of precedence for the values is:

  1. Feature Configuration Template
  2. Base Configuration Template
  3. Profile items

For example, a phone type specified in the Phone Type field under Profiles is superceded by the phone type specified in the Base Configuration Template or the Feature Configuration Template.

Feature Templates

The Feature Templates section of the Phone and Device Profile configuration mapping allows a higher-level administrator to configure a list of Feature Configuration Template CFTs, providing different configurations to complete the setting of the phone, device profile or line.

The image shows the list of available Feature templates:

The Feature templates are presented to the lower-level administrator as the list of templates (phone, device profile or line) that can be chosen when adding either a phone, extension mobility, or line. The Feature templates will contain the additional configuration settings that are applied on top of the settings mentioned above.

Macros for Phone Configuration Mapping

The table describes the available context macro variables when defining configuration templates for the phone mappings:

Macro Description
{{ input.standalone }} Flag whether it is a standalone phone or being associated with a subscriber.
{{ input.username }} Username of the subscriber the phone is being associated with. Only when standalone is false.
{{ input.device_type }} The user selected device type. This in fact is the phone mapping profile name.
{{ input.template_name }} The user selected feature template.
{{ input.name }} The user entered phone name.
{# input.lines #} The user entered list of lines.
{{ input.lines.0.directory_number }} The number of the first line.
{{ input.lines.0.template_name }} The user selected line template.
{{ input.lines.0.label }} The user entered line label.
{{ input.lines.0.display }} The user entered line display.
{{ pwf.user }} Object containing all UCM user settings of the associated subscriber. Only when standalone is false.

Device Profile Configuration Mapping

There may only be one device profile configuration mapping at any hierarchy, and the name of this mapping (at any hierarchy) must be Default.

The setup for device profile configuration mapping is identical to the phone configuration mapping. The phone type list and Feature* templates are presented to the administrator when adding an extension mobility service to a subscriber via the Subscriber Management page. See Feature Templates under Phone Configuration Mapping.

Line Configuration Mapping

There may only be one line configuration mapping at any hierarchy, and this line configuration mapping (at any hierarchy) must be Default.

A list of line templates can be configured and these will be presented to the administrator when new lines are be created, for example when adding a new phone.

Macros for Line Configuration Mapping

The table describes the available context macro variables when defining configuration templates for the line mappings:

Macro Description
{{ input.userid }} User ID for description.
{{ pwf.PassedLine.pattern }} Line pattern description.
{{ input.firstName }} User first name for Alerting name or ASCII Alerting name.
{{ input.lastName }} User last name for Alerting name or ASCII Alerting name.
{{ input.Phone.0.lines.line.0.dirn.pattern }} The destination.

The table describes the named macros that can be used when defining configuration templates for the line mappingse. High-level administrators with access to data/Macro can inspect and evaluate these named macros to verify result values. For details on Configuration Template customizations, see the Advanced Configuration Guide.

Stores default Device Profile Configuration Mappings.

Model Details: data/DeviceProfileConfigMapping

Title Description Details
Name * Name of the Device Profile Configuration Mapping. Default: Default
  • Field Name: name
  • Type: String
  • Default: Default
Profiles List of profile configuration mappings. The profiles listed here will be available to users creating or managing extension mobility profiles.
  • Field Name: profiles.[n]
  • Type: Array
Profile Name * Name to be used for this profile configuration. This is what will be displayed in dropdowns.
  • Field Name: profiles.[n].profile_name
  • Type: String
Phone Type * Phone type of this profile.
  • Field Name: profiles.[n].type
  • Type: String
Protocol * Protocol of this profile.
  • Field Name: profiles.[n].protocol
  • Type: String
Button Template Button template of this profile.
  • Field Name: profiles.[n].button_template
  • Type: String
Base Configuration Template * Base configuration template to be used when provisioning device profiles using this profile.
  • Field Name: profiles.[n].config_template
  • Type: String
Feature Templates List of feature configuration template. These template definitions will be available to users creating or managing extension mobility profiles.
  • Field Name: feature_templates.[n]
  • Type: Array
Template Name * Name to be used for this feature template. This is what will be displayed in dropdowns.
  • Field Name: feature_templates.[n].template_name
  • Type: String
Feature Configuration Template * Configuration template to use when provisioning extension mobility profiles when selected by the user.
  • Field Name: feature_templates.[n].config_template
  • Type: String
Feature Template Inclusion Overrides List of feature template inclusion overrides. These additional template will also be displayed only for the corresponding profile.
  • Field Name: feature_template_inclusion_overrides.[n]
  • Type: Array
Profile Name * Profile to create an inclusion override for. These additional feature templates will be available to be selected by the user when this profile is selected.
  • Field Name: feature_template_inclusion_overrides.[n].profile_name
  • Type: String
Template Name * Name to be used for this feature template. This is what will be displayed in dropdowns.
  • Field Name: feature_template_inclusion_overrides.[n].template_name
  • Type: String
Feature Configuration Template * Configuration template to use when provisioning extension mobility profiles when selected by the user.
  • Field Name: feature_template_inclusion_overrides.[n].config_template
  • Type: String
Feature Template Exclusion Overrides List of feature template exclusion overrides. The templates listed here will not be available for selection for the corresponding profile.
  • Field Name: feature_template_exclusion_overrides.[n]
  • Type: Array
Profile Name * Name to be used for this feature template. This is what will be displayed in dropdowns.
  • Field Name: feature_template_exclusion_overrides.[n].profile_name
  • Type: String
Template Name * Name to be used for this feature template. This is what will be displayed in dropdowns.
  • Field Name: feature_template_exclusion_overrides.[n].template_name
  • Type: String