Named Macros

Note:

For background on macros, context (e.g. input, pwf, cft), the macro evaluator, and so on, refer to the Macro Reference in the Advanced Configuration Guide.
The hierarchy at which the macro evaluates, affects its return value. For example, by default, the macro: DPSITE resolves to the site name at the current hierarchy, in other words, the value of :
```
{{ data.BaseSiteDAT.SiteName }}
```
at the current hierarchy.
The name of the macro usually gives some indication as to its nature and from that one can usually deduce the applicable hierarchy although not always. Best practice is to test the macro using the Macro Evaluator to confirm the expected results and hierarchy.
Duplicate macro names in the list indicate the same macro at different hierarchies.

Macros

Macro

AccessProfileNamesAtSysDotHcsMCR

{# data.AccessProfile.name | __hierarchy_friendly_path:sys.hcs #}

No description available.

hierarchy=sys.hcs

[Top]

AccessProfileNamesDownMCR

{# data.AccessProfile.name || direction:down #}

No description available.

hierarchy=sys.hcs

[Top]

ActionFriendlyMCR

(( input.action == add )) <Associate> <Disassociate>

This macro is specific for the GUIR for view/AddRemoveDeviceAppUser (one or more of the nested macros in this macro, contain references to specific GUI input-context of that view).

hierarchy=sys

[Top]

ADD_EM_EXCLUDED_SCHEMA_KEYS

{{ device.cucm.PhoneType.ProtocolTemplates.*.ExcludedSchemaKeys|PhoneType:pwf.dp_profile.type, ProtocolTemplates.*.Protocol: pwf.dp_profile.protocol | direction:up, limit:1 }}

This macro returns all unsupported fields for a given phone type. This macro uses the view/AddPhone context.

hierarchy=sys

[Top]

ADD_EM_USER_ASSOC_DEVICES_EXIST

{# pwf.user.phoneProfiles.profileName #}

This macro returns the CUCM user's device profiles.

hierarchy=sys

[Top]

ADD_EM_USER_PHONE_PROFILE_NEW

{# input.name #}

No description available.

hierarchy=sys

[Top]

ADD_PHONE_EXCLUDED_SCHEMA_KEYS

{{ device.cucm.PhoneType.ProtocolTemplates.*.ExcludedSchemaKeys|PhoneType:pwf.phone_profile.type, ProtocolTemplates.*.Protocol: pwf.phone_profile.protocol | direction:up, limit:1 }}

This macro returns all unsupported fields for a given phone type. This macro uses the view/AddPhone context.

hierarchy=sys

[Top]

ADD_PHONE_USER_ASSOC_DEVICE_NEW

{# input.name #}

No description available.

hierarchy=sys

[Top]

ADD_PHONE_USER_ASSOC_DEVICES_EXIST

{# pwf.user.associatedDevices.device #}

This macro returns the CUCM user's existing phones.

hierarchy=sys

[Top]

AddSharedCustomer_PORTS_ALLOWED

{{ fn.sequence 5062, 5162 }}

Macro function list (M)
No description available.

hierarchy=sys

[Top]

AddSharedCustomer_PORTS_AVALABLE

{# fn.list_set_left macro.AddSharedCustomer_PORTS_ALLOWED, macro.AddSharedCustomer_PORTS_USED #}

Macro function list (M)
No description available.

hierarchy=sys

[Top]

AddSharedCustomer_PORTS_USED

{# device.cuc.SipSecurityProfile.DisplayName || device:pwf.unity_pkid, direction:down #}

Sip Security Profile

hierarchy=sys

[Top]

AGENT_LINE_PROCESSING

(( fn.is_none_or_empty pwf.update_device == fn.true ))<{{ fn.true }}>(( fn.list_count pwf.lines_removed > 0 ))<{{ fn.true }}><{{ fn.false }}>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

ALL_DEVICE_PROFILES_OF_USERS_AT_HN

{# device.cucm.User.phoneProfiles.profileName | phoneProfiles.profileName:macro.NOT_NULL_REGEX, __hierarchy_friendly_path:macro.MY_SITE_HIERARCHY #}

Lists all Device Profiles associated with all CUCM users at a specific Hierarchy Node

hierarchy=sys

[Top]

AllowedUserRolesMCR

{# fn.get_user_roles_allowed_at_hn fn.hierarchy_friendly_path #}

Macro function list (M)
No description available.

hierarchy=sys

[Top]

analog_gateways

{# fn.split VG224 VG310 VG320 VG350 #}

Macro function list (M)
No description available.

hierarchy=sys

[Top]

ASSOCIATED_DEVICES_LIST

{# device.cucm.User.associatedDevices.device | associatedDevices.device: macro.NOT_NULL_REGEX | device:input.cucm_pkid, direction:down #}

No description available.

hierarchy=sys

[Top]

ASSOCIATED_DEVICES_LIST_ALL_PHONES

{# device.cucm.Phone.name || device:input.cucm_pkid, direction:down #}

No description available.

hierarchy=sys

[Top]

ASSOCIATED_DEVICES_LIST_CANDIDATES

{# fn.list_set_left macro.ASSOCIATED_DEVICES_LIST_ALL_PHONES, macro.ASSOCIATED_DEVICES_LIST_FLATTENED #}

Macro function list (M)
No description available.

hierarchy=sys

[Top]

ASSOCIATED_DEVICES_LIST_COUNT

{{ fn.list_count macro.ASSOCIATED_DEVICES_LIST_CANDIDATES }}

Macro function list (M)
No description available.

hierarchy=sys

[Top]

ASSOCIATED_DEVICES_LIST_FLATTENED

{# fn.flatten_list_of_lists macro.ASSOCIATED_DEVICES_LIST #}

Macro function list (M)
No description available.

hierarchy=sys

[Top]

associatedAppUserDevProf

{{ fn.as_list device.cucm.AppUser.ctiControlledDeviceProfiles.deviceProfile.* | userid:input.gui_userid | direction:up, device:macro.SITE_CUCM }}

Macro function list (M)
No description available.

hierarchy=sys.hcs

[Top]

associatedAppUserPhones

{{ fn.as_list device.cucm.AppUser.associatedDevices.device | userid:input.gui_userid | direction:up, device:macro.SITE_CUCM }}

Macro function list (M)
No description available.

hierarchy=sys.hcs

[Top]

AssociatedDnListMCR

(( data.HierarchyNode.node_type || direction:local == LinkedSite )) <{{ fn.associated_dn_list fn.hierarchy_parent }}> <{{ fn.associated_dn_list }}>

Macro function list (M)
Wrapper macro created to either: a) in the case of breadcrumb == LinkedSite -> then call the fn. function with new optional hierarchy-override input-parameter to make it evaluate at the Site-node above it, or b) in the case of breadcrumb anything else: call the fn. function exactly as we used to before (i.e. with no input-parameter)

hierarchy=sys.hcs

[Top]

audiocodes_cooling_duration

2

No description available.

hierarchy=sys.hcs

[Top]

AuthorizedAdminHierarchy_down

{# data.AuthorizedAdminHierarchy.name || direction:down #}

No description available.

hierarchy=sys

[Top]

AuthorizedAdminHierarchy_up

{# data.AuthorizedAdminHierarchy.name || direction:up #}

No description available.

hierarchy=sys

[Top]

AvailableStatesListMCR

{{ fn.split Available:Used,: }}

Macro function list (M)
Returns a list of the (currently two) different INI statuses which are seen as 'available for use' by normal devices (this is not applicable to the exception case of Utilities that won't/can't share a line).

hierarchy=sys

[Top]

Azure_Service_Names_Input_UserPrincipalName

{{ fn.as_list device.msgraph.MsolUser.Licenses.*.ServicePlans.*.ServiceName | UserPrincipalName:input.UserPrincipalName }}

Macro function list (M)
No description available.

hierarchy=sys

[Top]

AZUREADONLINE_TEST_CONNECTION_TEMPLATE

"{%- set status=response_text|from_json %} {%- if status['success'] is sameas true %} success {%- else %} failure {%- endif %}"

Returns the Jinja template for the test connection template in the MS Online connection parameters.

hierarchy=sys

[Top]

BASESITECOUNTRY_LOCAL

{{ data.BaseSiteDAT.Country | | direction:local }}

Return local BaseSite Country.

hierarchy=sys

[Top]

BASESITECOUNTRY_UP

{{ data.BaseSiteDAT.Country | | direction:up }}

Return BaseSite Country with direction up

hierarchy=sys

[Top]

BaseSiteDAT_custom_boolean_1

(( data.BaseSiteDAT.custom_boolean_1 || direction:up == fn.true )) <{{ fn.true }}> <{{ fn.false }}>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

BaseSiteDAT_custom_boolean_10

(( data.BaseSiteDAT.custom_boolean_10 || direction:up == fn.true )) <{{ fn.true }}> <{{ fn.false }}>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

BaseSiteDAT_custom_boolean_2

(( data.BaseSiteDAT.custom_boolean_2 || direction:up == fn.true )) <{{ fn.true }}> <{{ fn.false }}>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

BaseSiteDAT_custom_boolean_3

(( data.BaseSiteDAT.custom_boolean_3 || direction:up == fn.true )) <{{ fn.true }}> <{{ fn.false }}>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

BaseSiteDAT_custom_boolean_4

(( data.BaseSiteDAT.custom_boolean_4 || direction:up == fn.true )) <{{ fn.true }}> <{{ fn.false }}>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

BaseSiteDAT_custom_boolean_5

(( data.BaseSiteDAT.custom_boolean_5 || direction:up == fn.true )) <{{ fn.true }}> <{{ fn.false }}>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

BaseSiteDAT_custom_boolean_6

(( data.BaseSiteDAT.custom_boolean_6 || direction:up == fn.true )) <{{ fn.true }}> <{{ fn.false }}>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

BaseSiteDAT_custom_boolean_7

(( data.BaseSiteDAT.custom_boolean_7 || direction:up == fn.true )) <{{ fn.true }}> <{{ fn.false }}>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

BaseSiteDAT_custom_boolean_8

(( data.BaseSiteDAT.custom_boolean_8 || direction:up == fn.true )) <{{ fn.true }}> <{{ fn.false }}>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

BaseSiteDAT_custom_boolean_9

(( data.BaseSiteDAT.custom_boolean_9 || direction:up == fn.true )) <{{ fn.true }}> <{{ fn.false }}>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

BaseSiteDAT_custom_string_1

{{ data.BaseSiteDAT.custom_string_1 || direction:up }}

No description available.

hierarchy=sys

[Top]

BaseSiteDAT_custom_string_10

{{ data.BaseSiteDAT.custom_string_10 || direction:up }}

No description available.

hierarchy=sys

[Top]

BaseSiteDAT_custom_string_2

{{ data.BaseSiteDAT.custom_string_2 || direction:up }}

No description available.

hierarchy=sys

[Top]

BaseSiteDAT_custom_string_3

{{ data.BaseSiteDAT.custom_string_3 || direction:up }}

No description available.

hierarchy=sys

[Top]

BaseSiteDAT_custom_string_4

{{ data.BaseSiteDAT.custom_string_4 || direction:up }}

No description available.

hierarchy=sys

[Top]

BaseSiteDAT_custom_string_5

{{ data.BaseSiteDAT.custom_string_5 || direction:up }}

No description available.

hierarchy=sys

[Top]

BaseSiteDAT_custom_string_6

{{ data.BaseSiteDAT.custom_string_6 || direction:up }}

No description available.

hierarchy=sys

[Top]

BaseSiteDAT_custom_string_7

{{ data.BaseSiteDAT.custom_string_7 || direction:up }}

No description available.

hierarchy=sys

[Top]

BaseSiteDAT_custom_string_8

{{ data.BaseSiteDAT.custom_string_8 || direction:up }}

No description available.

hierarchy=sys

[Top]

BaseSiteDAT_custom_string_9

{{ data.BaseSiteDAT.custom_string_9 || direction:up }}

No description available.

hierarchy=sys

[Top]

BKEY_OF_CUCM_0_OF_SITE_NDLR

{{ data.NetworkDeviceList.devices.CallManager.0 | name: macro.NDL_NAME_OF_SITE_NDLR | direction:up }}

Get the Business-key of the first CUCM of the NDLR of the Site.

hierarchy=sys

[Top]

BKEY_OF_SITE_NDLR

(( macro.SITE_NDLR != '' )) <{{ fn.from_business_key_format macro.SITE_NDLR }}><>

Macro function list (M)
Get the business-key of the NDLR of the Site.

hierarchy=sys

[Top]

BROADSOFT_OCIP_CONN_PARAM_TEST_CONNECTION_TEMPLATE

"{%- if '<html>' in response_text %}failure{%- else %}success{%- endif %}"

Returns the Jinja template for the test connection template in the Avaya System Manager connection paramerters.

hierarchy=sys

[Top]

BUILD_DROPDOWN_FILTER

{{ fn.build_filter_macro pwf.create_input, input.ddf_action }}

Macro function list (M)
Build filter macro for dropdown choices

hierarchy=sys

[Top]

CALL_PICKUP_GROUPS_ON_CURRENT_HIERARCHY

{# device.cucm.CallPickupGroup.name | __hierarchy_friendly_path:fn.hierarchy_friendly_path #}

Macro function list (M)
Gets all the Call pickup group names on the current hierarchy level as well as above.

hierarchy=sys

[Top]

CALL_PICKUP_GROUPS_ON_HIERARCHY_ABOVE

{# device.cucm.CallPickupGroup.name || direction: up #}

Gets all the Call pickup group names on the current hierarchy level as well as above.

hierarchy=sys

[Top]

cfDeviceNormaliseName_MCR

/{{ pwf.deviceName }}/i

No description available.

hierarchy=sys

[Top]

CFTS_AT_SYS

{# dataConfigurationTemplate.name | __hierarchy_friendly_path:sys, target_model_type:device/cucm/Phone #}

CFTs at sys level

hierarchy=sys

[Top]

CFTS_UP

{# data.ConfigurationTemplate.name | target_model_type:device/cucm/Phone, __meta.system_resource:false | direction:up #}

No description available.

hierarchy=sys

[Top]

CFTS_UP_NO_SYS

{{ fn.list_set_right macro.CFTS_AT_SYS, macro.CFTS_UP }}

Macro function list (M)
No description available.

hierarchy=sys

[Top]

CFTS_UP_Replace_Phone

{# data.ConfigurationTemplate.name | feature_usage:replacephone,target_model_type:device/cucm/Phone, __meta.system_resource:false | direction:up #}

No description available.

hierarchy=sys.hcs

[Top]

CLEAR

##CLEAR

Hardcode value to indicate intention to have the field cleared (set to blank).

hierarchy=sys

[Top]

ClusterwideDirectedCallParkGetFreeDn_MCR

{# data.InternalNumberInventory.internal_number | status:Available | direction:up #}

No description available.

hierarchy=sys.hcs

[Top]

COMMA_SPACE

,

No description available.

hierarchy=sys

[Top]

ConversationCHOICES

{# data.MenuEntryTargetConversationDAT.title,value | action:21 #}

Return list of dicts, with two keys each ('title' and 'value') for all found entries of data/MenuEntryTargetConversationDAT objects.

hierarchy=sys

[Top]

CoolingExpiryDateFromGlobalSettingsMCR

{{ fn.add_x_days_to_startdate macro.global_setting_cooling_duration, macro.TODAY_YYYY_MM_DD, macro.DateTimeFormatter_YYYY_MM_DD }}

Macro function list (M)
Nested macro to calculate the cooling EXPIRY date, using the current breadcrumb to determine which hn-level global setting applies here

hierarchy=sys

[Top]

COPILOT_ACTION_MODELS

[ { "description": "Use this to onboard a new multi-vendor user (subscriber). Use this when you don't know the type of the user.", "model_type": "view/AddSubscriberFromProfile" }, { "description": "Use this to onboard a new Microsoft user (subscriber)", "model_type": "view/MicrosoftSubscriberQas" }, { "description": "Use this to onboard a new Cisco user (subscriber)", "model_type": "view/QuickSubscriber" }, { "description": "Use this to create a new Cisco phone", "model_type": "view/AddPhone" }, { "description": "Use this to add a range of numbers to the number inventory", "model_type": "view/NumberInventoryRangeMgmtVIEW" } ]

Defines the model types and description of actions that can be recommended by Copilot.

hierarchy=sys

[Top]

COPILOT_REPORTER_RESOURCE_SUMMARY_ATTRS

{ "voss4uc_data_user": [ { "name": "first_name", "friendly_name": "First Name" }, { "name": "last_name", "friendly_name": "Last Name" }, { "name": "email", "friendly_name": "Email" } ], "voss_device_cucm_user": [ { "name": "firstName", "friendly_name": "First Name" }, { "name": "lastName", "friendly_name": "Last Name" }, { "name": "mailid", "friendly_name": "Email" } ], "voss_device_cucm_phone": [ { "name": "name", "friendly_name": "Name" }, { "name": "product", "friendly_name": "Product" } ], "voss_data_InternalNumberInventory": [ { "name": "internal_number", "friendly_name": "Number" }, { "name": "status", "friendly_name": "Status" } ] }

Defines a JSON object specifying the summary attributes for Reporter Resources. This is used by Copilot.

hierarchy=sys

[Top]

COPILOT_REPORTER_RESOURCES

[ { "description": "Users", "resource": "voss4uc_data_user" }, { "description": "Cisco Users", "resource": "voss_device_cucm_user" }, { "description": "Cisco Phones", "resource": "voss_device_cucm_phone" }, { "description": "Numbers", "resource": "voss_data_InternalNumberInventory" } ]

Defines the resources and descriptions of Insights resources that can be looked up by Copilot

hierarchy=sys

[Top]

COUNTRY

{{ data.Countries.iso_country_code | country_name:macro.COUNTRYNAME }}

No description available.

hierarchy=sys

[Top]

COUNTRY_2_LETTER_CODE

(( pwf.CC == AFG )) <AF> (( pwf.CC == ALA )) <AX> (( pwf.CC == ALB )) <AL> (( pwf.CC == DZA )) <DZ> (( pwf.CC == ASM )) <AS> (( pwf.CC == AND )) <AD> (( pwf.CC == AGO )) <AO> (( pwf.CC == AIA )) <AI> (( pwf.CC == ATA )) <AQ> (( pwf.CC == ATG )) <AG> (( pwf.CC == ARG )) <AR> (( pwf.CC == ARM )) <AM> (( pwf.CC == ABW )) <AW> (( pwf.CC == AUS )) <AU> (( pwf.CC == AUT )) <AT> (( pwf.CC == AZE )) <AZ> (( pwf.CC == BHS )) <BS> (( pwf.CC == BHR )) <BH> (( pwf.CC == BGD )) <BD> (( pwf.CC == BRB )) <BB> (( pwf.CC == BLR )) <BY> (( pwf.CC == BEL )) <BE> (( pwf.CC == BLZ )) <BZ> (( pwf.CC == BEN )) <BJ> (( pwf.CC == BMU )) <BM> (( pwf.CC == BTN )) <BT> (( pwf.CC == BOL )) <BO> (( pwf.CC == BIH )) <BA> (( pwf.CC == BWA )) <BW> (( pwf.CC == BVT )) <BV> (( pwf.CC == BRA )) <BR> (( pwf.CC == VGB )) <VG> (( pwf.CC == IOT )) <IO> (( pwf.CC == BRN )) <BN> (( pwf.CC == BGR )) <BG> (( pwf.CC == BFA )) <BF> (( pwf.CC == BDI )) <BI> (( pwf.CC == KHM )) <KH> (( pwf.CC == CMR )) <CM> (( pwf.CC == CAN )) <CA> (( pwf.CC == CPV )) <CV> (( pwf.CC == CYM )) <KY> (( pwf.CC == CAF )) <CF> (( pwf.CC == TCD )) <TD> (( pwf.CC == CHL )) <CL> (( pwf.CC == CHN )) <CN> (( pwf.CC == HKG )) <HK> (( pwf.CC == MAC )) <MO> (( pwf.CC == CXR )) <CX> (( pwf.CC == CCK )) <CC> (( pwf.CC == COL )) <CO> (( pwf.CC == COM )) <KM> (( pwf.CC == COG )) <CG> (( pwf.CC == COD )) <CD> (( pwf.CC == COK )) <CK> (( pwf.CC == CRI )) <CR> (( pwf.CC == CIV )) <CI> (( pwf.CC == HRV )) <HR> (( pwf.CC == CUB )) <CU> (( pwf.CC == CYP )) <CY> (( pwf.CC == CZE )) <CZ> (( pwf.CC == DNK )) <DK> (( pwf.CC == DJI )) <DJ> (( pwf.CC == DMA )) <DM> (( pwf.CC == DOM )) <DO> (( pwf.CC == ECU )) <EC> (( pwf.CC == EGY )) <EG> (( pwf.CC == SLV )) <SV> (( pwf.CC == GNQ )) <GQ> (( pwf.CC == ERI )) <ER> (( pwf.CC == EST )) <EE> (( pwf.CC == ETH )) <ET> (( pwf.CC == FLK )) <FK> (( pwf.CC == FRO )) <FO> (( pwf.CC == FJI )) <FJ> (( pwf.CC == FIN )) <FI> (( pwf.CC == FRA )) <FR> (( pwf.CC == GUF )) <GF> (( pwf.CC == PYF )) <PF> (( pwf.CC == ATF )) <TF> (( pwf.CC == GAB )) <GA> (( pwf.CC == GMB )) <GM> (( pwf.CC == GEO )) <GE> (( pwf.CC == DEU )) <DE> (( pwf.CC == GHA )) <GH> (( pwf.CC == GIB )) <GI> (( pwf.CC == GRC )) <GR> (( pwf.CC == GRL )) <GL> (( pwf.CC == GRD )) <GD> (( pwf.CC == GLP )) <GP> (( pwf.CC == GUM )) <GU> (( pwf.CC == GTM )) <GT> (( pwf.CC == GGY )) <GG> (( pwf.CC == GIN )) <GN> (( pwf.CC == GNB )) <GW> (( pwf.CC == GUY )) <GY> (( pwf.CC == HTI )) <HT> (( pwf.CC == HMD )) <HM> (( pwf.CC == VAT )) <VA> (( pwf.CC == HND )) <HN> (( pwf.CC == HUN )) <HU> (( pwf.CC == ISL )) <IS> (( pwf.CC == IND )) <IN> (( pwf.CC == IDN )) <ID> (( pwf.CC == IRN )) <IR> (( pwf.CC == IRQ )) <IQ> (( pwf.CC == IRL )) <IE> (( pwf.CC == IMN )) <IM> (( pwf.CC == ISR )) <IL> (( pwf.CC == ITA )) <IT> (( pwf.CC == JAM )) <JM> (( pwf.CC == JPN )) <JP> (( pwf.CC == JEY )) <JE> (( pwf.CC == JOR )) <JO> (( pwf.CC == KAZ )) <KZ> (( pwf.CC == KEN )) <KE> (( pwf.CC == KIR )) <KI> (( pwf.CC == PRK )) <KP> (( pwf.CC == KOR )) <KR> (( pwf.CC == KWT )) <KW> (( pwf.CC == KGZ )) <KG> (( pwf.CC == LAO )) <LA> (( pwf.CC == LVA )) <LV> (( pwf.CC == LBN )) <LB> (( pwf.CC == LSO )) <LS> (( pwf.CC == LBR )) <LR> (( pwf.CC == LBY )) <LY> (( pwf.CC == LIE )) <LI> (( pwf.CC == LTU )) <LT> (( pwf.CC == LUX )) <LU> (( pwf.CC == MKD )) <MK> (( pwf.CC == MDG )) <MG> (( pwf.CC == MWI )) <MW> (( pwf.CC == MYS )) <MY> (( pwf.CC == MDV )) <MV> (( pwf.CC == MLI )) <ML> (( pwf.CC == MLT )) <MT> (( pwf.CC == MHL )) <MH> (( pwf.CC == MTQ )) <MQ> (( pwf.CC == MRT )) <MR> (( pwf.CC == MUS )) <MU> (( pwf.CC == MYT )) <YT> (( pwf.CC == MEX )) <MX> (( pwf.CC == FSM )) <FM> (( pwf.CC == MDA )) <MD> (( pwf.CC == MCO )) <MC> (( pwf.CC == MNG )) <MN> (( pwf.CC == MNE )) <ME> (( pwf.CC == MSR )) <MS> (( pwf.CC == MAR )) <MA> (( pwf.CC == MOZ )) <MZ> (( pwf.CC == MMR )) <MM> (( pwf.CC == NAM )) <NA> (( pwf.CC == NRU )) <NR> (( pwf.CC == NPL )) <NP> (( pwf.CC == NLD )) <NL> (( pwf.CC == ANT )) <AN> (( pwf.CC == NCL )) <NC> (( pwf.CC == NZL )) <NZ> (( pwf.CC == NIC )) <NI> (( pwf.CC == NER )) <NE> (( pwf.CC == NGA )) <NG> (( pwf.CC == NIU )) <NU> (( pwf.CC == NFK )) <NF> (( pwf.CC == MNP )) <MP> (( pwf.CC == NOR )) <NO> (( pwf.CC == OMN )) <OM> (( pwf.CC == PAK )) <PK> (( pwf.CC == PLW )) <PW> (( pwf.CC == PSE )) <PS> (( pwf.CC == PAN )) <PA> (( pwf.CC == PNG )) <PG> (( pwf.CC == PRY )) <PY> (( pwf.CC == PER )) <PE> (( pwf.CC == PHL )) <PH> (( pwf.CC == PCN )) <PN> (( pwf.CC == POL )) <PL> (( pwf.CC == PRT )) <PT> (( pwf.CC == PRI )) <PR> (( pwf.CC == QAT )) <QA> (( pwf.CC == REU )) <RE> (( pwf.CC == ROU )) <RO> (( pwf.CC == RUS )) <RU> (( pwf.CC == RWA )) <RW> (( pwf.CC == BLM )) <BL> (( pwf.CC == SHN )) <SH> (( pwf.CC == KNA )) <KN> (( pwf.CC == LCA )) <LC> (( pwf.CC == MAF )) <MF> (( pwf.CC == SPM )) <PM> (( pwf.CC == VCT )) <VC> (( pwf.CC == WSM )) <WS> (( pwf.CC == SMR )) <SM> (( pwf.CC == STP )) <ST> (( pwf.CC == SAU )) <SA> (( pwf.CC == SEN )) <SN> (( pwf.CC == SRB )) <RS> (( pwf.CC == SYC )) <SC> (( pwf.CC == SLE )) <SL> (( pwf.CC == SGP )) <SG> (( pwf.CC == SVK )) <SK> (( pwf.CC == SVN )) <SI> (( pwf.CC == SLB )) <SB> (( pwf.CC == SOM )) <SO> (( pwf.CC == ZAF )) <ZA> (( pwf.CC == SGS )) <GS> (( pwf.CC == SSD )) <SS> (( pwf.CC == ESP )) <ES> (( pwf.CC == LKA )) <LK> (( pwf.CC == SDN )) <SD> (( pwf.CC == SUR )) <SR> (( pwf.CC == SJM )) <SJ> (( pwf.CC == SWZ )) <SZ> (( pwf.CC == SWE )) <SE> (( pwf.CC == CHE )) <CH> (( pwf.CC == SYR )) <SY> (( pwf.CC == TWN )) <TW> (( pwf.CC == TJK )) <TJ> (( pwf.CC == TZA )) <TZ> (( pwf.CC == THA )) <TH> (( pwf.CC == TLS )) <TL> (( pwf.CC == TGO )) <TG> (( pwf.CC == TKL )) <TK> (( pwf.CC == TON )) <TO> (( pwf.CC == TTO )) <TT> (( pwf.CC == TUN )) <TN> (( pwf.CC == TUR )) <TR> (( pwf.CC == TKM )) <TM> (( pwf.CC == TCA )) <TC> (( pwf.CC == TUV )) <TV> (( pwf.CC == UGA )) <UG> (( pwf.CC == UKR )) <UA> (( pwf.CC == ARE )) <AE> (( pwf.CC == GBR )) <GB> (( pwf.CC == USA )) <US> (( pwf.CC == UMI )) <UM> (( pwf.CC == URY )) <UY> (( pwf.CC == UZB )) <UZ> (( pwf.CC == VUT )) <VU> (( pwf.CC == VEN )) <VE> (( pwf.CC == VNM )) <VN> (( pwf.CC == VIR )) <VI> (( pwf.CC == WLF )) <WF> (( pwf.CC == ESH )) <EH> (( pwf.CC == YEM )) <YE> (( pwf.CC == ZMB )) <ZM> (( pwf.CC == ZWE )) <ZW> <>

Determine the 2 letter code for Country in pwf.CC variable.

hierarchy=sys

[Top]

COUNTRYNAME

{{ self.Country }}

No description available.

hierarchy=sys

[Top]

CSOL_FIELDS_TO_COMPARE

{# fn.split TeamsMeetingPolicy:TeamsCallParkPolicy:TeamsCallHoldPolicy:TeamsEmergencyCallingPolicy:TeamsVideoInteropServicePolicy:TeamsCallingPolicy:TeamsMessagingPolicy:TenantDialPlan:ExternalAccessPolicy:TeamsUpgradePolicy:TeamsMeetingBroadcastPolicy:LineURIType:LineURItel:LineURIext:IPPhonePolicy:OnlineVoiceRoutingPolicy:AudioVideoDisabled:HostedVoicemailPolicy:AccountEnabled:TeamsEmergencyCallRoutingPolicy:CallingLineIdentity:TeamsAppPermissionPolicy:TeamsAppSetupPolicy:TeamsChannelsPolicy:TeamsUpdateManagementPolicy:TeamsEnhancedEncryptionPolicy:OnlineVoicemailPolicy:TeamsTemplatePermissionPolicy:TeamsAudioConferencingPolicy,: #}

Macro function list (M)
CSOL fields used for object comparison

hierarchy=sys

[Top]

CSONLINEUSER_ACCOUNT_ENABLED_FEATURE_TYPE_FILTER

{# device.msteamsonline.CsOnlineUser.UserPrincipalName | AccountEnabled:fn.true,FeatureTypes:/PhoneSystem/ | direction:down #}

Macro function list (M)
Return back a list of CsOnlineUser UPN's filtered on AccountEnabled: True and FeatureTypes:PhoneSystem

hierarchy=sys

[Top]

CsOnlineUser_PureOnlineApplicationInstancesMCR

{# device.msteamsonline.CsOnlineUser.UserPrincipalName | InterpretedUserType: PureOnlineApplicationInstances | direction:fulltree, device:macro.PKID_OF_MSTEAMS_ONLINE_FOR_SITE #}

Return back a list of CsOnlineUser UPN's filtered on InterpretedUserType: PureonlineApplicationInstances

hierarchy=sys

[Top]

CtiRoutePoint_names

{# device.cucm.CtiRoutePoint.name #}

No description available.

hierarchy=sys

[Top]

CUC_CLUSTERS

{# data.HCSHcmfCUCxnDAT.bkCUCxnCluster_name | isUCPublisher:fn.true #}

Macro function list (M)
This macro returns a list of CUC cluster names. It is deployment aware i.e. HCM-F vs Decoupled.

hierarchy=sys

[Top]

CUC_CSSMEMBER_CSSOBJID

{{ device.cuc.SearchSpaceMember.SearchSpaceObjectId | Name : input.SearchSpaceItem.cssName }}

No description available.

hierarchy=sys.hcs

[Top]

CUC_DEFAULT_USER_TEMPLATE

{{ data.SiteDefaultsDoc.defaultcucsubscribertemplate | | direction:local }}

Fetch CUC User template Site Defaults Document.

hierarchy=sys

[Top]

CUC_HTML_NotificationTemplateID

{{ device.cuc.NotificationTemplate.NotificationTemplateID | NotificationTemplateName:macro.CUC_HTML_NotificationTemplateName | device:pwf.cuc_pkid,direction:up }}

No description available.

hierarchy=sys

[Top]

CUC_HTML_NotificationTemplateName

{{ data.SiteDefaultsDoc.defaultcuchtmlnotificationtemplate | name:macro.DPSITE }}

No description available.

hierarchy=sys

[Top]

CUC_Language

{{ fn.as_int macro.CUC_Language_Code }}

Macro function list (M)
CUC Language code as Integer (required by CUC API.)

hierarchy=sys

[Top]

CUC_Language_Code

{{ data.Locales.LCID_decimal | Locale:macro.CUC_Language_Text }}

Code lookup for CUC Language.

hierarchy=sys

[Top]

CUC_Language_Custom

{{ fn.as_int macro.CUC_Language_Text }}

Macro function list (M)
Custom CUC Language code as Integer (required by CUC API.)

hierarchy=sys

[Top]

CUC_Language_Final

(( fn.is_none_or_empty macro.CUC_Language_Code == True )) <{{ fn.null }}> <{{ macro.CUC_Language }}>

Macro function list (M)
CUC Language code as Integer (required by CUC API) as retrieved from the Site Defaults Doc (SDD). Will be set to null of no value is found in the SDD.

hierarchy=sys

[Top]

CUC_Language_Text

{{ data.SiteDefaultsDoc.defaultcuclanguage }}

SDD value for defaultcuclanguage

hierarchy=sys

[Top]

CUC_LG1

{# data.Locales.Locale #}

Macro to retrieve all CUC LG Locale Names

hierarchy=sys

[Top]

CUC_LG_JOIN

{{ fn.join macro.CUC_LG1,; }}

Macro function list (M)
Macro to join all CUC LG Locale name's delimited by a ;

hierarchy=sys

[Top]

CUC_MODEL_COUNT_SPLIT

{{ fn.split cft.cuc_model_X.DATA,: }}

Macro function list (M)
Split the metric string into a list.

hierarchy=sys

[Top]

CUC_PHONE_SYSTEM

{{ data.SiteDefaultsDoc.defaultcucphonesystem }}

No description available.

hierarchy=sys

[Top]

CUC_SERVERS

{# data.HCSHcmfCUCxnDAT.name #}

This macro returns a list of CUC server names. It is deployment aware i.e. HCM-F vs Decoupled.

hierarchy=sys

[Top]

CUC_SMPP_PROVIDER

{{ data.SiteDefaultsDoc.defaultcucsmppprovider }}

No description available.

hierarchy=sys

[Top]

CUC_STATICCFG_VMS_HOSTADDRESS

{{ device.cuc.ConnectionLocation.HostAddress || direction : up, device : pwf.contextCucPkid }}

No description available.

hierarchy=sys.hcs

[Top]

CUC_TimeZone

{{ fn.as_int macro.CUC_TimeZone_Code }}

Macro function list (M)
CUC TimeZone code as Integer (required by CUC API.)

hierarchy=sys

[Top]

CUC_TimeZone_Code

{{ device.cuc.TimeZone.TimeZoneId | DisplayName:macro.CUC_TimeZone_Text | direction:up, device: macro.NDL_CUC_PKID_FOR_SITE }}

Code lookup from device model for SDD (string)friendly name related CUC TimeZone

hierarchy=sys

[Top]

CUC_TimeZone_Final

(( fn.is_none_or_empty macro.CUC_TimeZone_Code == True ))<{{ fn.null }}><{{ macro.CUC_TimeZone }}>

Macro function list (M)
CUC TimeZone code as Integer (required by CUC API) as retrieved from the Site Defaults Doc (SDD). Will be set to null of no value is found in the SDD.

hierarchy=sys

[Top]

CUC_TimeZone_Text

{{ data.SiteDefaultsDoc.defaultcuctimezone }}

Lookup from SDD, the (string)friendly name for CUC Time Zone.

hierarchy=sys

[Top]

CUC_TZ1

{# device.cuc.TimeZone.DisplayName #}

Macro to retrieve all CUC TZ Display Names

hierarchy=sys

[Top]

CUC_TZ_JOIN

{{ fn.join macro.CUC_TZ1,; }}

Macro function list (M)
Macro to join all CUC TZ Displayname's delimited by a ;

hierarchy=sys

[Top]

CUC_USER_DEVICE_HIERARCHY_PKID

{{ fn.one data.UnityConnection.__hierarchy | __pkid: macro.CUC_USER_DEVICE_PKID }}

Macro function list (M)
Return the CUC User Device Hierarchy PKID

hierarchy=sys

[Top]

CUC_USER_DEVICE_PKID

{{ fn.one device.cuc.User.__device_pkid | Alias: input.username }}

Macro function list (M)
Return the CUC User Device PKID

hierarchy=sys

[Top]

CUC_USER_TEMPLATE

(( fn.is_none_or_empty macro.INPUT_CUC_USER_TEMPLATE == false )) <{{ macro.INPUT_CUC_USER_TEMPLATE }}> <{{ macro.CUC_DEFAULT_USER_TEMPLATE }}>

Macro function list (M)
Fetch CUC User template from input context or Site Defaults Document.

hierarchy=sys

[Top]

CUC_USER_TEMPLATE_VMR

(( fn.is_none_or_empty macro.INPUT_CUC_USER_TEMPLATE_VMR == false )) <{{ macro.INPUT_CUC_USER_TEMPLATE_VMR }}> <{{ macro.CUC_DEFAULT_USER_TEMPLATE }}>

Macro function list (M)
Fetch CUC User template from input context or Site Defaults Document.

hierarchy=sys

[Top]

CUC_USER_templateAlias

{{ data.SiteDefaultsDoc.defaultcucsubscribertemplate }}

No description available.

hierarchy=sys

[Top]

CUC_UT_TEMPLATE

voicemailusertemplate

No description available.

hierarchy=sys.hcs

[Top]

CucAddress_from_LocationId

{{ device.cuc.ConnectionLocation.HostAddress | ObjectId:macro.LocationId_from_CallhandlerName }}

Get the LocationObjectId of a Callhandler instance by supplying the Callhandler name.

hierarchy=sys

[Top]

CucBkey_from_CucAddress

{{ data.UnityConnection.__bkey | host:macro.CucAddress_from_LocationId }}

Get the LocationObjectId of a Callhandler instance by supplying the Callhandler name.

hierarchy=sys

[Top]

CucBkey_from_NDLname

(( fn.is_none_or_empty input.ndl_name == fn.false ))<{{ data.NetworkDeviceList.devices.UnityConnection.0 | name:input.ndl_name || direction:up }}>(( fn.is_none_or_empty pwf.ndl_name == fn.false ))<{{ data.NetworkDeviceList.devices.UnityConnection.0 | name:pwf.ndl_name || direction:up }}><{{ fn.unset }}>

Macro function list (M)
Returns the BKEY of the CUC part of an NDL instance, using input [ndl_name]. It looks oup the NDL instance, finds the Unity block and returns the BKEY.

hierarchy=sys

[Top]

CucCallhandlerCHOICES

{# device.cuc.Callhandler.ObjectId,DisplayName | IsPrimary:fn.false | direction:up, device:macro.GetCucPkidFromNdlName #}

Macro function list (M)
Return list of dicts, with two keys each ('ObjectId' and 'DisplayName') for 'system-callhandler' entries of cuc.Callhandler objects.

hierarchy=sys

[Top]

CucCallhandlerTITLES

{# device.cuc.Callhandler.DisplayName | IsPrimary:fn.false | direction:up, device:macro.GetCucPkidFromNdlName #}

Macro function list (M)
Return list of CH names, for 'system-callhandler' entries of cuc.Callhandler objects.

hierarchy=sys

[Top]

CucCallhandlerVALUES

{# device.cuc.Callhandler.ObjectId | IsPrimary:fn.false | direction:up, device:macro.GetCucPkidFromNdlName #}

Macro function list (M)
Return list of CH names, for 'system-callhandler' entries of cuc.Callhandler objects.

hierarchy=sys

[Top]

CucDirectoryHandlerCHOICES

{# device.cuc.DirectoryHandler.ObjectId,DisplayName || direction:up, device:macro.GetCucPkidFromNdlName #}

Return list of dicts, with two keys each ('ObjectId' and 'DisplayName') for all found entries of cuc.InterviewHandler objects.

hierarchy=sys

[Top]

CucDirectoryHandlerTITLES

{# device.cuc.DirectoryHandler.DisplayName || direction:up, device:macro.GetCucPkidFromNdlName #}

Return linear list, of ObjectId string items, from the device.cuc.DirectoryHandler model

hierarchy=sys

[Top]

CucDirectoryHandlerVALUES

{# device.cuc.DirectoryHandler.ObjectId || direction:up, device:macro.GetCucPkidFromNdlName #}

Return linear list, of ObjectId string items, from the device.cuc.DirectoryHandler model

hierarchy=sys

[Top]

CucInterviewHandlerCHOICES

{# device.cuc.InterviewHandler.ObjectId,DisplayName || direction:up, device:macro.GetCucPkidFromNdlName #}

Return list of dicts, with two keys each ('ObjectId' and 'DisplayName') for all found entries of cuc.InterviewHandler objects.

hierarchy=sys

[Top]

CucInterviewHandlerTITLES

{# device.cuc.InterviewHandler.DisplayName || direction:up, device:macro.GetCucPkidFromNdlName #}

Return linear list, of DisplayName string items, from the device.cuc.InterviewHandler model

hierarchy=sys

[Top]

CucInterviewHandlerVALUES

{# device.cuc.InterviewHandler.ObjectId || direction:up, device:macro.GetCucPkidFromNdlName #}

Return linear list, of ObjectId string items, from the device.cuc.InterviewHandler model

hierarchy=sys

[Top]

CucLanguageDataFiltersMCR

{# data.CUCLanguage.* #}

Return all fields for all instances of data/CUCLanguage. (When a macro doesn't specify direction, it will return all instances located at the lowest loaded hierarchy, which is what we want)

hierarchy=sys

[Top]

CUCM_APPLICATION_SPACE_ADDRESS

{{ fn.get_cucm_network_address_by_host macro.FIRST_NDL_CUCM, APPLICATION_SPACE }}

Macro function list (M)
This macro returns a CUCM's application space network address given the data/CallManager hostname.

hierarchy=sys

[Top]

CUCM_BKEYS_FROM_NDLS

{# fn.get_cucm_bkeys_associated_via_ndl #}

Macro function list (M)
Get all CUCM servers' business keys from NDL's on current hierarchy.

hierarchy=sys

[Top]

CUCM_CLUSTERS

{# data.HCSHcmfCUCMDAT.bkCUCMCluster_name | isUCPublisher:fn.true,typeCucmServer:VOICE_VIDEO #}

Macro function list (M)
This macro returns a list of CUCM Cluster names. It is deployment aware i.e. HCM-F vs Decoupled.

hierarchy=sys

[Top]

CUCM_CPARK_routePartitionName

(( fn.is_site == True )) <{{ data.SiteDefaultsDoc.defaultcppt || direction:local }}><{{ fn.null }}>

Macro function list (M)
When at Site level this returns the value defined for Call Park Partition in Site Defaults Doc, else retuns null

hierarchy=sys

[Top]

CUCM_CPUG_routePartitionName

(( fn.is_site == True )) <{{ data.SiteDefaultsDoc.defaultcpupt || direction:local }}><{{ fn.null }}>

Macro function list (M)
When at Site level this returns the value defined for Call Pickup Partition in Site Defaults Doc, else retuns null

hierarchy=sys

[Top]

CUCM_DP_defaultplarcss

{{ data.SiteDefaultsDoc.defaultplarcss }}

No description available.

hierarchy=sys

[Top]

CUCM_DP_emccCallingSearchSpace

{{ data.SiteDefaultsDoc.default_dp_emcc_css }}

No description available.

hierarchy=sys

[Top]

CUCM_DP_lines_line_e164Mask

{{ data.SiteDefaultsDoc.default_cucm_dp_e164_mask }}

No description available.

hierarchy=sys

[Top]

CUCM_DP_phoneTemplateName

{{ data.SiteDefaultsDoc.default_cucm_dp_template }}

No description available.

hierarchy=sys

[Top]

CUCM_DP_product

{{ data.SiteDefaultsDoc.default_cucm_dp_product }}

No description available.

hierarchy=sys

[Top]

CUCM_DP_protocol

{{ data.SiteDefaultsDoc.default_cucm_dp_protocol }}

No description available.

hierarchy=sys

[Top]

CUCM_HIERARCHY_PKID

(( fn.is_site == fn.true ))<{{ data.CallManager.__hierarchy | __pkid: macro.SITE_CUCM }}><{{ fn.hierarchy }}>

Macro function list (M)
Return the CUCM Hierarchy PKID

hierarchy=sys

[Top]

CUCM_HOSTNAME_FROM_PKID

{{ data.CallManager.host | __pkid:input.device }}

Returns the data/CallManager hostname given the PKID.

hierarchy=sys

[Top]

CUCM_HOTDIAL_defaultplarcss

(( fn.is_site == True )) <{{ data.SiteDefaultsDoc.defaultplarcss || direction:local }}><{{ fn.null }}>

Macro function list (M)
When at Site level this returns the value defined for Default PLAR CSS in Site Defaults Doc, else returns null

hierarchy=sys

[Top]

CUCM_HPILOT_routePartitionName

(( fn.is_site == True )) <{{ data.SiteDefaultsDoc.defaulthppt }}><{{ fn.null }}>

Macro function list (M)
Override the default behavior of this macro at sys.hcs to return empty when not evaluated at a site HN.

hierarchy=sys.hcs

[Top]

CUCM_LINE_callForwardAll_callingSearchSpaceName

(( fn.is_site == fn.true ))<{{ data.SiteDefaultsDoc.defaultlinecfacss || direction:local }}>(( fn.is_none_or_empty pwf.move_to_hn_pkid == fn.false ))<{{ data.SiteDefaultsDoc.defaultlinecfacss | __hierarchy_friendly_path: pwf.move_to_hn_pkid }}><>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

CUCM_LINE_callForwardAll_secondaryCallingSearchSpaceName

(( fn.is_site == fn.true ))<{{ data.SiteDefaultsDoc.defaultlineseccss || direction:local }}>(( fn.is_none_or_empty pwf.move_to_hn_pkid == fn.false ))<{{ data.SiteDefaultsDoc.defaultlineseccss | __hierarchy_friendly_path: pwf.move_to_hn_pkid }}><>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

CUCM_LINE_callForwardAlternateParty_callingSearchSpaceName

(( fn.is_site == fn.true ))<{{ data.SiteDefaultsDoc.defaultlinecfapcss || direction:local }}>(( fn.is_none_or_empty pwf.move_to_hn_pkid == fn.false ))<{{ data.SiteDefaultsDoc.defaultlinecfapcss | __hierarchy_friendly_path: pwf.move_to_hn_pkid }}><>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

CUCM_LINE_callForwardBusy_callingSearchSpaceName

{{ fn.evaluate macro.CUCM_LINE_callForwardBusy_callingSearchSpaceName-2 }}

Macro function list (M)
No description available.

hierarchy=sys

[Top]

CUCM_LINE_callForwardBusy_callingSearchSpaceName-2

(( fn.is_site == fn.true ))<{{ data.SiteDefaultsDoc.defaultlinecfbcss || direction:local }}>(( fn.is_none_or_empty pwf.move_to_hn_pkid == fn.false ))<{{ data.SiteDefaultsDoc.defaultlinecfbcss | __hierarchy_friendly_path: pwf.move_to_hn_pkid }}><>

Macro function list (M)
Override the default behavior of this macro at sys.hcs to return empty when not evaluated at a site HN.

hierarchy=sys.hcs

[Top]

CUCM_LINE_callForwardBusyInt_callingSearchSpaceName

(( fn.is_site == fn.true ))<{{ data.SiteDefaultsDoc.defaultlinecfbicss || direction:local }}>(( fn.is_none_or_empty pwf.move_to_hn_pkid == fn.false ))<{{ data.SiteDefaultsDoc.defaultlinecfbicss | __hierarchy_friendly_path: pwf.move_to_hn_pkid }}><>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

CUCM_LINE_callForwardNoAnswer_callingSearchSpaceName

(( fn.is_site == fn.true ))<{{ data.SiteDefaultsDoc.defaultlinecfnacss || direction:local }}>(( fn.is_none_or_empty pwf.move_to_hn_pkid == fn.false ))<{{ data.SiteDefaultsDoc.defaultlinecfnacss | __hierarchy_friendly_path: pwf.move_to_hn_pkid }}><>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

CUCM_LINE_callForwardNoAnswerInt_callingSearchSpaceName

(( fn.is_site == fn.true ))<{{ data.SiteDefaultsDoc.defaultlinecfnaicss || direction:local }}>(( fn.is_none_or_empty pwf.move_to_hn_pkid == fn.false ))<{{ data.SiteDefaultsDoc.defaultlinecfnaicss | __hierarchy_friendly_path: pwf.move_to_hn_pkid }}><>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

CUCM_LINE_callForwardNoCoverage_callingSearchSpaceName

(( fn.is_site == fn.true ))<{{ data.SiteDefaultsDoc.defaultlinecfnccss || direction:local }}>(( fn.is_none_or_empty pwf.move_to_hn_pkid == fn.false ))<{{ data.SiteDefaultsDoc.defaultlinecfnccss | __hierarchy_friendly_path: pwf.move_to_hn_pkid }}><>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

CUCM_LINE_callForwardNoCoverageInt_callingSearchSpaceName

(( fn.is_site == fn.true ))<{{ data.SiteDefaultsDoc.defaultlinecfncicss || direction:local }}>(( fn.is_none_or_empty pwf.move_to_hn_pkid == fn.false ))<{{ data.SiteDefaultsDoc.defaultlinecfncicss | __hierarchy_friendly_path: pwf.move_to_hn_pkid }}><>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

CUCM_LINE_callForwardNotRegistered_callingSearchSpaceName

(( fn.is_site == fn.true ))<{{ data.SiteDefaultsDoc.defaultlinecfnrcss || direction:local }}>(( fn.is_none_or_empty pwf.move_to_hn_pkid == fn.false ))<{{ data.SiteDefaultsDoc.defaultlinecfnrcss | __hierarchy_friendly_path: pwf.move_to_hn_pkid }}><>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

CUCM_LINE_callForwardNotRegisteredInt_callingSearchSpaceName

(( fn.is_site == fn.true ))<{{ data.SiteDefaultsDoc.defaultlinecfnricss || direction:local }}>(( fn.is_none_or_empty pwf.move_to_hn_pkid == fn.false ))<{{ data.SiteDefaultsDoc.defaultlinecfnricss | __hierarchy_friendly_path: pwf.move_to_hn_pkid }}><>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

CUCM_LINE_callForwardOnFailure_callingSearchSpaceName

(( fn.is_site == fn.true ))<{{ data.SiteDefaultsDoc.defaultlinecfofcss || direction:local }}>(( fn.is_none_or_empty pwf.move_to_hn_pkid == fn.false ))<{{ data.SiteDefaultsDoc.defaultlinecfofcss | __hierarchy_friendly_path: pwf.move_to_hn_pkid }}><>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

CUCM_LINE_GetRoutePartitionFromSDD

{{ data.SiteDefaultsDoc.defaultlinept | name:macro.SITENAME }}

Get the line route partition for the current site from its Site Defaults Doc.

hierarchy=sys

[Top]

CUCM_LINE_presenceGroupName

(( fn.is_site == fn.true ))<{{ data.SiteDefaultsDoc.default_cucm_line_presencegroup || direction:local }}>(( fn.is_none_or_empty pwf.move_to_hn_pkid == fn.false ))<{{ data.SiteDefaultsDoc.default_cucm_line_presencegroup | __hierarchy_friendly_path: pwf.move_to_hn_pkid }}><>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

CUCM_LINE_routePartitionName

(( fn.is_site == fn.true ))<{{ data.SiteDefaultsDoc.defaultlinept }}>(( fn.is_none_or_empty pwf.move_to_hn_pkid == fn.false ))<{{ data.SiteDefaultsDoc.defaultlinept | __hierarchy_friendly_path: pwf.move_to_hn_pkid }}><>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

CUCM_LINE_shareLineAppearanceCssName

(( fn.is_site == fn.true ))<{{ data.SiteDefaultsDoc.defaultlinecss || direction:local }}>(( fn.is_none_or_empty pwf.move_to_hn_pkid == fn.false ))<{{ data.SiteDefaultsDoc.defaultlinecss | __hierarchy_friendly_path: pwf.move_to_hn_pkid }}><>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

CUCM_LINE_vmprofile

(( fn.is_site == fn.true ))<{{ data.SiteDefaultsDoc.default_cucm_line_vmprofile || direction:local }}>(( fn.is_none_or_empty pwf.move_to_hn_pkid == fn.false ))<{{ data.SiteDefaultsDoc.default_cucm_line_vmprofile | __hierarchy_friendly_path: pwf.move_to_hn_pkid }}><>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

CUCM_MEETME_routePartitionName

(( fn.is_site == True )) <{{ data.SiteDefaultsDoc.defaultmmpt || direction:local }}><{{ fn.null }}>

Macro function list (M)
When at Site level this returns the value defined for MeetMe Partition in Site Defaults Doc, else retuns null

hierarchy=sys

[Top]

CUCM_MODEL_COUNT_SPLIT

{{ fn.split cft.cucm_model_X.DATA,: }}

Macro function list (M)
Split the metric string into a list.

hierarchy=sys

[Top]

CUCM_networkLocale

{{ data.SiteDefaultsDoc.defaultNL }}

No description available.

hierarchy=sys

[Top]

CUCM_PHONE_callingSearchSpaceName

{{ data.SiteDefaultsDoc.defaultdevicecss }}

No description available.

hierarchy=sys

[Top]

CUCM_PHONE_commonDeviceConfigName

{{ data.SiteDefaultsDoc.default_cucm_phone_commondeviceconfig }}

No description available.

hierarchy=sys

[Top]

CUCM_PHONE_devicePoolName

{{ data.SiteDefaultsDoc.defaultDP }}

No description available.

hierarchy=sys

[Top]

CUCM_PHONE_dndStatus

(( False ))

No description available.

hierarchy=sys

[Top]

CUCM_PHONE_enableExtensionMobility

{{ data.SiteDefaultsDoc.default_cucm_phone_enableEM }}

No description available.

hierarchy=sys

[Top]

CUCM_PHONE_isDualMode

(( False ))

No description available.

hierarchy=sys

[Top]

CUCM_PHONE_lines_line_e164Mask

(( fn.is_site == True )) <{{ data.SiteDefaultsDoc.default_cucm_phone_e164_mask }}><{{ fn.null }}>

Macro function list (M)
Override the default behavior of this macro at sys.hcs to return empty when not evaluated at a site HN.

hierarchy=sys.hcs

[Top]

CUCM_PHONE_locationName

{{ data.SiteDefaultsDoc.defaultLOC }}

No description available.

hierarchy=sys

[Top]

CUCM_PHONE_phoneTemplateName

{{ data.SiteDefaultsDoc.default_cucm_phone_template }}

No description available.

hierarchy=sys

[Top]

CUCM_PHONE_presenceGroupName

{{ data.SiteDefaultsDoc.default_cucm_phone_presencegroup }}

No description available.

hierarchy=sys

[Top]

CUCM_PHONE_product

{{ data.SiteDefaultsDoc.default_cucm_phone_product }}

No description available.

hierarchy=sys

[Top]

CUCM_PHONE_protocol

{{ data.SiteDefaultsDoc.default_cucm_phone_protocol }}

No description available.

hierarchy=sys

[Top]

CUCM_PHONE_securityProfileName

{{ data.SiteDefaultsDoc.default_cucm_phone_securityprofile }}

No description available.

hierarchy=sys

[Top]

CUCM_PHONE_sipProfile

{{ data.SiteDefaultsDoc.default_cucm_phone_sipprofile }}

No description available.

hierarchy=sys

[Top]

CUCM_PHONE_softkeyTemplateName

{{ data.SiteDefaultsDoc.default_cucm_phone_softkey }}

No description available.

hierarchy=sys

[Top]

CUCM_PHONE_subscribeCallingSearchSpaceName

{{ data.SiteDefaultsDoc.default_phone_subscriber_css }}

No description available.

hierarchy=sys

[Top]

CUCM_PKID_FROM_INPUT_BKEY

{{ fn.bkey_to_pkid input.cucm_bkey, data/CallManager }}

Macro function list (M)
Get the CUCM pkid from the input.cucm_bkey context.

hierarchy=sys

[Top]

CUCM_PKID_FROM_INPUT_PHONENAME

{{ device.cucm.Phone.__device_pkid | name:input.phone_name | direction:down, limit:1 }}

No description available.

hierarchy=sys

[Top]

CUCM_PKID_FROM_INPUT_USERID

{{ device.cucm.User.__device_pkid | userid:input.userid | direction:down, limit:1 }}

No description available.

hierarchy=sys

[Top]

CUCM_PROVIDER_SPACE_ADDRESS

{{ fn.get_cucm_network_address_by_host macro.FIRST_NDL_CUCM, SERVICE_PROVIDER_SPACE }}

Macro function list (M)
This macro returns a CUCM's provider space network address given the data/CallManager hostname.

hierarchy=sys

[Top]

CUCM_RDP_callingSearchSpaceName

{{ data.SiteDefaultsDoc.default_rdp_css }}

No description available.

hierarchy=sys

[Top]

CUCM_RDP_devicePoolName

{{ data.SiteDefaultsDoc.defaultDP }}

No description available.

hierarchy=sys

[Top]

CUCM_RDP_lines_line_e164Mask

{{ data.SiteDefaultsDoc.default_cucm_rdp_e164_mask }}

No description available.

hierarchy=sys

[Top]

CUCM_RDP_rerouteCallingSearchSpaceName

{{ data.SiteDefaultsDoc.default_rdp_rr_css }}

No description available.

hierarchy=sys

[Top]

CUCM_SERVERS

{# data.HCSHcmfCUCMDAT.name #}

This macro returns a list of CUCM server names. It is deployment aware i.e. HCM-F vs Decoupled.

hierarchy=sys

[Top]

CUCM_UDT_commonPhoneProfile

Standard Common Phone Profile

Used in USP Relation - Universal Device Templates.

hierarchy=sys

[Top]

CUCM_UDT_devicePool

{{ data.SiteDefaultsDoc.defaultDP }}

Used in USP Relation - Universal Device Templates.

hierarchy=sys

[Top]

CUCM_UDT_ownerUserId

Current Device Owner's User ID

Used in USP Relation - Universal Device Templates.

hierarchy=sys

[Top]

CUCM_UDT_ownerUserId_asList

{# fn.as_list macro.CUCM_UDT_ownerUserId #}

Macro function list (M)
Used in USP Relation - Universal Device Templates.

hierarchy=sys

[Top]

CUCM_UDT_phoneButtonTemplate

Universal Device Template Button Layout

Used in USP Relation - Universal Device Templates.

hierarchy=sys

[Top]

CUCM_USER_DEVICE_HIERARCHY_PKID

{{ fn.one data.CallManager.__hierarchy | __pkid: macro.CUCM_USER_DEVICE_PKID }}

Macro function list (M)
Return the CUCM User Device Hierarchy PKID

hierarchy=sys

[Top]

CUCM_USER_DEVICE_PKID

{{ fn.one device.cucm.User.__device_pkid | userid: input.username }}

Macro function list (M)
Return the CUCM User Device PKID

hierarchy=sys

[Top]

CUCM_USER_EMAIL

{{ device.cucm.User.mailid | userid:input.gui_user }}

This macro returns the mailid of the cucm user to get the pexip email

hierarchy=sys

[Top]

CUCM_USER_FIRSTNAME

{{ device.cucm.User.firstName | userid:input.userid | device:macro.SITE_CUCM }}

This macro does a lookup of a Cisco UCM User's firstname based on userid input. This macro must be used at Site level.

hierarchy=sys

[Top]

CUCM_USER_LASTNAME

{{ device.cucm.User.lastName | userid:input.userid | device:macro.SITE_CUCM }}

This macro does a lookup of a Cisco UCM User's lastname based on userid input. This macro must be used at Site level.

hierarchy=sys

[Top]

CUCM_USER_NAME

{{ macro.CUCM_USER_FIRSTNAME }} {{macro.CUCM_USER_LASTNAME }}

This macro returns a combination of a Cisco UCM user's first and last name

hierarchy=sys

[Top]

CUCM_USER_NAME_TRIMMED

(( fn.is_none_or_empty macro.CUCM_USER_FIRSTNAME == True)) <{{ fn.sub_string macro.CUCM_USER_LASTNAME,0,30 }}> (( fn.length macro.CUCM_USER_FIRSTNAME >= 30 )) <{{ fn.sub_string macro.CUCM_USER_FIRSTNAME,0,1 }} {{ fn.sub_string macro.CUCM_USER_LASTNAME,0,28 }}> <{{ macro.CUCM_USER_FIRSTNAME }}>

Macro function list (M)
This macro returns a combination of a Cisco UCM user's first and last name, trimmed to fit in 30 characters.

hierarchy=sys

[Top]

CUCM_USER_presenceGroupName

{{ data.SiteDefaultsDoc.default_cucm_user_presencegroup }}

No description available.

hierarchy=sys

[Top]

CUCM_USER_serviceProfile

(( fn.is_site == fn.true ))<{{ data.SiteDefaultsDoc.default_cucm_user_serviceprofile || direction:local }}>(( fn.is_none_or_empty pwf.move_to_hn_pkid == fn.false ))<{{ data.SiteDefaultsDoc.default_cucm_user_serviceprofile | __hierarchy_friendly_path: pwf.move_to_hn_pkid }}><>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

CUCM_USER_subscribeCallingSearchSpaceName

{{ data.SiteDefaultsDoc.default_user_subscriber_css }}

No description available.

hierarchy=sys

[Top]

CUCM_userLocale

(( fn.is_site == fn.true ))<{{ data.SiteDefaultsDoc.defaultUL || direction:local }}>(( fn.is_none_or_empty pwf.move_to_hn_pkid == fn.false ))<{{ data.SiteDefaultsDoc.defaultUL | __hierarchy_friendly_path: pwf.move_to_hn_pkid }}><>

Macro function list (M)
No description available.

hierarchy=sys

[Top]

CucmBkey_from_NDLname

{{ data.NetworkDeviceList.devices.CallManager.0 | name:input.ndl_name | direction:up }}

Returns the BKEY of the CUCM part of an NDL instance, using input [ndl_name]. It looks up the NDL instance, finds the Call Manager block and returns the BKEY.

hierarchy=sys

[Top]

CucmUserLdapDirectoryMCR

{{ device.cucm.User.ldapDirectoryName | userid:input.userid | direction:up, device:pwf.cucmPkid }}

Check if cucm/User is ldap-auth-synced.

hierarchy=sys.hcs

[Top]

CucPkid_from_CucBkey

{{ fn.bkey_to_pkid macro.CucBkey_from_CucAddress, data/UnityConnection }}

Macro function list (M)
Uses nested macros: the starting required input is the Callhandler name (input.DisplayName), and the final output of this wrapper macro is the pkid of the CUC the Callhandler instance resides on.

hierarchy=sys

[Top]

WebexApp_E164functionGetE164FromFunction_MCR

{{ fn.get_e164_number macro.WebexApp_E164functionInput_MCR }}

Macro function list (M)
No description available.

hierarchy=sys.hcs

[Top]

WebexApp_E164functionGetNumber_MCR

(( fn.is_none_or_empty macro.WebexApp_E164functionGetE164FromFunction_MCR == false ))<{{ fn.remove_and_trim macro.WebexApp_E164functionGetE164FromFunction_MCR,\ }}><{{ data.DpSite.pubNumber || direction:local }}>

Macro function list (M)
No description available.

hierarchy=sys.hcs

[Top]

WebexApp_E164functionInput_MCR

(( fn.is_none_or_empty pwf.spark_line == false )) <{{ pwf.spark_line }}> <{{ pwf.directory_number }}>

Macro function list (M)
No description available.

hierarchy=sys.hcs

[Top]

WebexAppCallingBehaviourListMCR

(( macro.WebexAppCallingLicenseMCR == macro.WebexAppCallingLicenseNameUCPREM ))<{# fn.split Calling in Webex App:Cisco Jabber app:Third-Party app:Calling in Webex App (Unified CM),: #}><{# fn.split Calling in Webex App,: #}>

Macro function list (M)
No description available.

hierarchy=sys.hcs

[Top]

WebexAppCallingLicenseListMCR

{# device.spark.License.name || device:macro.WebexAppDeviceIdMCR,direction:up #}

No description available.

hierarchy=sys.hcs

[Top]

WebexAppCallingLicenseMCR

{{ fn.one device.spark.License.name | name:macro.WebexAppCallingLicenseNameUCPREM | device:macro.WebexAppDeviceIdMCR,direction:up }}

Macro function list (M)
No description available.

hierarchy=sys.hcs

[Top]

WebexAppCallingLicenseNameUCPREM

Unified Communication Manager (UCM)

No description available.

hierarchy=sys.hcs

[Top]

WebexAppCallingLicenseNameWCP

Webex Calling - Professional

No description available.

hierarchy=sys.hcs

[Top]

WebexAppCallingProfileListMCR

{# device.spark.CallingProfile.name || device:macro.WebexAppDeviceIdMCR,direction:up #}

No description available.

hierarchy=sys.hcs

[Top]

WebexAppDeviceIdMCR

{{ data.Spark.__pkid || direction:up }}

No description available.

hierarchy=sys.hcs

[Top]

WebexAppIsDirSyncEnabledMCR

{{ data.SparkCustomer.dirsync_enabled || direction:up }}

No description available.

hierarchy=sys.hcs

[Top]

WebexCallingNumberMgmtConfigCheck

(( fn.is_none_or_empty data.Spark.__pkid || direction:up == fn.true )) <{{ fn.false }}> (( data.SiteDefaultsDoc.webexLocationId | name:input.gui_targetSite == '' )) <{{ fn.false }}> <{{macro.WebexCallingNumberMgmtEnabledSite}}>

Macro function list (M)
Check that Webex Calling is Configured to allow Number Management

hierarchy=sys

[Top]

WebexCallingNumberMgmtEnabledSite

{{ fn.true }}

Macro function list (M)
Is Number Management Enabled at Site

hierarchy=sys

[Top]

WebexCallingProUserEmails

{# device.spark.User.email | calling_pro:fn.true | direction:local #}

Macro function list (M)
List of Webex Calling Pro Users Emails

hierarchy=sys

[Top]

WebexCallParkAgents

{# device.spark.CallParkGroup.agents.id | agents.id:/^(?!null)/ #}

List of Agents in Call Park Groups

hierarchy=sys

[Top]

WebexDeviceSupportedForList

{# fn.one device.spark.SupportedDevices.supportedFor | displayName:input.gui_product #}

Macro function list (M)
No description available.

hierarchy=sys

[Top]

WebexLanguage

{{ fn.one data.Language.lcid | name:input.gui_lang_name | direction:up }}

Macro function list (M)
No description available.

hierarchy=sys

[Top]

WebexPickupAgents

{# device.spark.CallPickup.agents.id | agents.id:/^(?!null)/ #}

List of Agents in Pickup Groups

hierarchy=sys

[Top]

WebexWorkspaceIdWithDeviceList

{# device.spark.Device.workspaceId #}

No description available.

hierarchy=sys

[Top]

WebexWorkspaceNameSupportingPhonesList

{# device.spark.Place.displayName | supportedDevices:phones #}

No description available.

hierarchy=sys

[Top]

WebexWorkspaceNameWithDeviceList

{# device.spark.Place.displayName | id:macro.WebexWorkspaceIdWithDeviceList #}

No description available.

hierarchy=sys

[Top]

WebexWorkspaceNameWithoutDeviceList

{{ fn.list_set_left macro.WebexWorkspaceNameSupportingPhonesList, macro.WebexWorkspaceNameWithDeviceList }}

Macro function list (M)
No description available.

hierarchy=sys

[Top]

WLCD_PSTNACCESSNETWORKINFO_SUPPORTED_COUNTRIES

{{ fn.split BE;FR;DE,; }}

Macro function list (M)
Webex Location Calling Details: Specifies a list of supported countries for setting of PSTN Access Network Info.

hierarchy=sys

[Top]

WorkflowCore_CFT_Type

{{ input.gui_entityName }}

No description available.

hierarchy=sys.hcs

[Top]

WorkflowCore_GetSiteCountry

{{ data.BaseSiteDAT.Country | SiteName:input.siteName }}

No description available.

hierarchy=sys.hcs

[Top]

WorkflowCore_LC

{

No description available.

hierarchy=sys.hcs

[Top]

WorkflowCore_RC

}

No description available.

hierarchy=sys.hcs

[Top]

WT_DELETE_EXISTING_JABBER_DEVICES

{{ fn.false }}

Macro function list (M)
Determines whether or not a Subscriber's existing Jabber devices are deleted when enabling WT Calling with CUCM. It defaults to true, but can be overridden at lower hierarchies.

hierarchy=sys

[Top]

WT_GENERATED_EMAIL_PLACE_HYBRID_CALLING

wt_{{ fn.generate_random_number 12 }}@{{ data.SparkCustomer.email_domain || direction:up,limit:1 }}

Macro function list (M)
Generate a random email address for the Unified CM user provisioned when enabling hybrid calling for a Webex App Place.

hierarchy=sys

[Top]

WT_JABBER_ANDROID

{{ fn.jabber_device_name 'Cisco Dual Mode for Android', pwf.username_with_wt }}

Macro function list (M)
Generate a random JABBER name from pwf.username_with_wt (a PWF variable with a 'WT' prefixed to the username).

hierarchy=sys

[Top]

WT_JABBER_CSF

{{ fn.jabber_device_name 'Cisco Unified Client Services Framework', pwf.username_with_wt }}

Macro function list (M)
Generate a random JABBER name from pwf.username_with_wt (a PWF variable with a 'WT' prefixed to the username).

hierarchy=sys

[Top]

WT_JABBER_IPAD

{{ fn.jabber_device_name 'Cisco Jabber for Tablet', pwf.username_with_wt }}

Macro function list (M)
Generate a random JABBER name from pwf.username_with_wt (a PWF variable with a 'WT' prefixed to the username).

hierarchy=sys

[Top]

WT_JABBER_IPHONE

{{ fn.jabber_device_name 'Cisco Dual Mode for iPhone', pwf.username_with_wt }}

Macro function list (M)
Generate a random JABBER name from pwf.username_with_wt (a PWF variable with a 'WT' prefixed to the username).

hierarchy=sys

[Top]

WT_PRIMARY_EXTENSION

(( fn.is_none_or_empty pwf.spark_line == false )) <{{ pwf.spark_line }}> <{{ device.cucm.User.primaryExtension.pattern | userid:pwf.userid }}>

Macro function list (M)
No description available.

hierarchy=sys.hcs

[Top]

WT_PRIMARY_EXTENSION_E164

{{ fn.replace macro.WT_PRIMARY_EXTENSION_GET_E164,\,}}

Macro function list (M)
No description available.

hierarchy=sys.hcs

[Top]

WT_PRIMARY_EXTENSION_GET_E164

{{ fn.get_e164_number macro.WT_PRIMARY_EXTENSION }}

Macro function list (M)
No description available.

hierarchy=sys.hcs

[Top]

WT_UC_MANAGER_PROFILES

(( fn.is_none_or_empty macro.WebexAppCallingProfileListMCR == False )) <{{ macro.WebexAppCallingProfileListMCR }}> <{{ fn.list_empty }}>

Macro function list (M)
Returns a list of UC Manage Profiles configured against a specific customer's Webex App account.

hierarchy=sys

[Top]

WT_UC_MANAGER_PROFILES_WITH_AUTO

{{ fn.list_append 'Auto Configure',macro.WT_UC_MANAGER_PROFILES }}

Macro function list (M)
Returns a list of UC Manage Profiles configured against a specific customer's Webex App account as well as an 'Auto Configure option'.

hierarchy=sys

[Top]

WT_WORK_NUMBER

(( fn.is_none_or_empty macro.WT_PRIMARY_EXTENSION_E164 == false )) <{{ macro.WT_PRIMARY_EXTENSION_E164 }}> (( fn.is_none_or_empty macro.WT_PRIMARY_EXTENSION == false )) <{{ macro.WT_PRIMARY_EXTENSION }}> <{{ fn.null }}>

Macro function list (M)
No description available.

hierarchy=sys.hcs

[Top]

zoom_http_proxy

{{ data.ZoomAccount.http_proxy | __pkid:input.pkid | direction:fulltree }}

Customer Zoom App HTTP Proxy

hierarchy=sys

[Top]

zoom_https_proxy

{{ data.ZoomAccount.https_proxy | __pkid:input.pkid | direction:fulltree }}

Customer Zoom App HTTPS Proxy

hierarchy=sys

[Top]

Named Macros

Contents

Macros