How Reporting Works

XML Report

The xml report, is of course an .xml file. This is a basic summary of the format.

There are five main sections to the report:

  • General Report information

Indicates the date and time the report was generated, the last sync time and the billing reporting mode.

  • Bundles

Includes details the features all the bundles the Service Provider has, plus the allocated and used count.

  • Customers

A list of all customers, their allocated bundles, devices, sites, users and voice mailbox details.

  • Resellers

A list of all Value-Added Resellers and Virtual Service Providers, including their customer's data.

  • Service Provider License Details

A list of all manually entered license counts specified in the Edit Licensing page.

The basic structure of the xml will be formatted as shown below.

<Billing>

<ServiceProviderSnapshot>

General information ...

<BundleDetailsList>

Bundle details ...

</BundleDetailsList>

<CustomerSnapshotList>

Customer details ...

</CustomerSnapshotList>

<ResellerSnapshot>

Reseller details ...

</ResellerSnapshot>

<ServiceProviderLicenseDetails>

Manual License details ...

</ServiceProviderLicenseDetails>

</ServiceProviderSnapshot>

</Billing>

The following sections will describe each bolded section above in more detail.

General Information

The bolded sections below show where the general information is in the report.

<Billing>

<ServiceProviderSnapshot>

<billingMode></billingMode>

<BundleDetailsList>

Bundle details ...

</BundleDetailsList>

<CustomerSnapshotList>

Customer details ...

</CustomerSnapshotList>

<ResellerSnapshot>

Reseller details ...

</ResellerSnapshot>

<ServiceProviderLicenseDetails>

Manual License details ...

</ServiceProviderLicenseDetails>

<time></time>

<synctime></synctime>

</ServiceProviderSnapshot>

</Billing>

Details about each highlighted field:

Field name

Format

Description

Possible values

Billing Mode

<billingMode></billingMode>

The mode the Service Provider is reporting in, which is either OPEX or CAPEX.

  • OPEX

  • CAPEX

Report Generation Time

<time></time>

The time the report was generated.

Time format is YYY/MM/DD - HH:MM:SS and is in 24 hour clock format

Last Platform Sync time

<synctime></synctime>

The last time a platform synchronization was done before this report was generated.

Time format is YYY/MM/DD - HH:MM:SS and is in 24 hour clock format

Bundle Details

The bolded values below show where the Bundle details are found in the report.

Within the <BundleDetailsList>, each Service Provider bundle will be listed with its details which is contained in the <BundleDetails> tag.

<Billing>

<ServiceProviderSnapshot>

<BundleDetailsList>

<BundleDetails>

<allocated></allocated>

<ALaCarteFeatures>

<phoneButtonManagement></phoneButtonManagement>

<chat></chat>

<knowledgeManagement></knowledgeManagement>

<launchpad></launchpad>

<miCollabClientForSmartPhones></miCollabClientForSmartPhones>

<presence></presence>

<presenceOnMitelSets></presenceOnMitelSets>

<compactMode></compactMode>

<softphone></softphone>

<sipmobile></sipmobile>

<rssWindow></rssWindow>

</ALaCarteFeatures>

<id></id>

<licenseType></licenseType>

<miteamEnabled></miteamEnabled>

<name></name>

<productCode></productCode>

<serviceType></serviceType>

<used></used>

</BundleDetails>

</BundleDetailsList>

<CustomerSnapshotList>

Customer details ...

</CustomerSnapshotList>

<ResellerSnapshot>

Reseller details ...

</ResellerSnapshot>

<ServiceProviderLicenseDetails>

Manual License details ...

</ServiceProviderLicenseDetails>

</ServiceProviderSnapshot></Billing>

General Bundle Details

The general bundle details are bracketed by the <BundleDetails> tag. Here are the details about each highlighted field:

Field name

Format

Description

Possible values

Allocated count

<allocated></allocated>

The total number of this bundle allocated across all customers.

integer

A la Carte Features

<ALaCarteFeatures>

</ALaCarteFeatures>

The optional features allocated to a bundle.

See the table below for the list of all optional features.

Bundle Identifier

<id></id>

Unique Management Portal internal identifier

string

License Type

<licenseType></licenseType>

The UCC License Type this bundle is based on.

  • Basic IPT

  • Standard IPT

  • Entry UCC

  • Standard UCC

  • Premium UCC

MiTeam Feature

<miteamEnabled></miteamEnabled>

Indicates whether MiTeam is enabled for this bundle

  • true

  • false

Bundle Name

<name></name>

The name assigned to the bundle by the Service Provider when the bundle was created

string

Product Code

<productCode></productCode>

The produce code assigned to the bundle by the Service Provider when the bundle was created. For bundles discovered during platform sychronization, this field will be empty.

string

Platform Service Type

<serviceType></serviceType>

What type of platform is this bundle targeted to. This is assigned when the bundle is created by the Service Provider.

  • MiCloud Business Multi-tenant

  • MiCloud Business Virtual

Bundle Used Count

<used></used>

The total number of this bundle used across all customers

integer

Managed State

<managed></managed>

Indicates whether this bundle was created in Management Portal or discovered during platform synchronization.

  • true

  • false

A la Carte Features

The A la Carte Features for each bundle are bracketed by the <ALaCarteFeatures> tag. Here are the details about each highlighted field within that tag:

Field name

Format

Description

Possible values

Phone Button Programming

<phoneButtonManagement></phoneButtonManagement>

Users can configure the buttons on their 6905, 6910, 6920, 6930, 6940, 5312, 5320, 5324, 5330, 5340, or 5360 IP phone from the Desktop Client. This feature is limited to users on MiVoice Business communication platforms only.

  • 0 if this feature is not enabled

  • 1 if the feature is enabled

Chat

<chat></chat>

Users can participate in online chat sessions with other MiCollab Client users also licensed for chat. Users access the Chat submenu from the Corporate Contacts context menu.

  • 0 if this feature is not enabled

  • 1 if the feature is enabled

Knowledge Management

<knowledgeManagement></knowledgeManagement>

Users can index computer files and documents associated with a contact. When the user receives an incoming call, the Knowledge Management popup window appears presenting the user with a list of files associated with the caller including e-mail messages, contact entries, and documents (Microsoft Word, Excel® PowerPoint ®, Outlook and Adobe® Portable Document Format).

  • 0 if this feature is not enabled

  • 1 if the feature is enabled

Launchpad

<launchpad></launchpad>

Users can access the Launchpad view, which provides quick access to frequently completed actions, from their Desktop Client. Actions include dialing a number, browsing to a URL, running a program, and exploring a folder.

  • 0 if this feature is not enabled

  • 1 if the feature is enabled

MiCollab Mobile Client for Smart Devices

<miCollabClientForSmartPhones></miCollabClientForSmartPhones>

Users can install and use the MiCollab Mobile Client client application on their Android, BlackBerry, iPad, or iPhone mobile device. The MiCollab Mobile Client application provides Dynamic status updates based on location, time, WiFi, GPS and/or Bluetooth (depending on the device). The application also provides an integrated environment in which users can manage Dynamic Status, communicate with corporate contacts, and access visual voice mail and call history.
The MiCollab Mobile Client for Smart Devices was formally known as the Locator.

  • 0 if this feature is not enabled

  • 1 if the feature is enabled

Presence

<presence></presence>

MiCollab Client Service uses Dynamic Presence (which is a replacement for Universal and On-Demand Presence) for telephony presence. The Desktop client will display presence for the contacts in the current view.

  • 0 if this feature is not enabled

  • 1 if the feature is enabled

Presence on Mitel Sets

<presenceOnMitelSets></presenceOnMitelSets>

Users can configure presence information for multiple contacts on their 5320, 5330, 5340, or 5360 IP phone from the Desktop Client. This feature is limited to users on MiVoice Business communication platforms only.

  • 0 if this feature is not enabled

  • 1 if the feature is enabled

Compact Mode

<compactMode></compactMode>

Users can switch between the full mode and compact mode Desktop Client interfaces.

  • 0 if this feature is not enabled

  • 1 if the feature is enabled

Softphone

<softphone></softphone>

Users' softphone extensions, as programmed on the PBX, are integrated with MiCollab Client.

  • 0 if this feature is not enabled

  • 1 if the feature is enabled

Mobile SIP Softphone

<sipmobile></sipmobile>

Allows user to have SIP-Based Softphone on Android and iOS clients. This feature is supported on MiVoice Office 250 and MiVoice Business systems only

  • 0 if this feature is not enabled

  • 1 if the feature is enabled

RSS Window

<rssWindow></rssWindow>

Users have access to the RSS window, located at the bottom of the desktop client UI. Typically, RSS feeds provide syndicated content such as events listings, news stories, headlines, excerpts from discussion forums, or corporate information to the user. Depending on how you configure the RSS Window options for the user's account, users may be able to hide or display the RSS window and change the RSS URL.

  • 0 if this feature is not enabled

  • 1 if the feature is enabled

Customer Details

The bolded values below show where the Customer details are found in the report.

Within the <CustomerSnapshotList>, each Service Provider customer will be listed with its details which is contained in the <CustomerSnapshot> tag.

<Billing>

<ServiceProviderSnapshot>

General information ...

<BundleDetailsList>

Bundle details ...

</BundleDetailsList>

<CustomerSnapshotList>

<CustomerSnapshot>

<accountNumber></accountNumber>

<CustomerBundleDetails>

<BundleList>

<Bundle>

Same as the information shown for a Bundle in the Service Provider bundle list

</Bundle>

</BundleList>

</CustomerBundleDetails>

<CustomerDeviceDetails>

<DeviceList>

<Device>

<id>9</id>

<name></name>

<numberUsed></numberUsed>

</Device>

</DeviceList>

</CustomerDeviceDetails>

<CustomerDidDetails>

<numberAssigned></numberAssigned>

<numberUsed></numberUsed>

</CustomerDidDetails>

<CustomerHotDeskPhoneDetails>

<HotDeskPhoneList>

<HotDeskPhone>

<deviceName></deviceName>

<extension></extension>

<name></name>

</HotDeskPhone>

</HotDeskPhoneList>

</CustomerHotDeskPhoneDetails>

<CustomerSiteList>

<CustomerSite>

<primaryMcdName></primaryMcdName>

<secondaryMcdName></secondaryMcdName>

<siteId></siteId>

<siteInUse></siteInUse>

<siteName></siteName>

</CustomerSite>

</CustomerSiteList>

<CustomerUserDetails>

<UserList>

<User>

<bundleName></bundleName>

<deviceName></deviceName>

<extension></extension>

<firstName></firstName>

<lastName></lastName>

<licenseType></licenseType>

<productCode></productCode>

<siteId></siteId>

<siteName></siteName>

<username></username>

</User>

</UserList>

</CustomerUserDetails>

<customerVoiceMailDetails>

<numberVoicemailboxesByAA></numberVoicemailboxesByAA>

<numberVoicemailboxesByGroup></numberVoicemailboxesByGroup>

<numberVoicemailboxesByUser></numberVoicemailboxesByUser>

<totalnumberVoicemailboxes></totalnumberVoicemailboxes>

</customerVoiceMailDetails>

<name></name>

<reportingStatus></reportingStatus>

<time></time>

<synctime></synctime>

</CustomerSnapshot>

</CustomerSnapshotList>

<ResellerSnapshot>

Reseller details ...

</ResellerSnapshot>

<ServiceProviderLicenseDetails>

Manual License details ...

</ServiceProviderLicenseDetails>

</ServiceProviderSnapshot>

</Billing>

Customer General Information

The general information for each Customer are bracketed by the <CustomerSnapshot> tag. Here are the details about each highlighted field within that tag. Note that each customer is encased in their own <CustomerSnapshot> tag.

Field name

Format

Description

Possible values

Account Number

<accountNumber></accountNumber>

The number assigned to the customer by the Service Provider when the customer was created.

string

Bundle List

<CustomerBundleDetails>

</CustomerBundleDetails>

All bundles assigned to a customer.

This tag contains a list of customer bundles. See the Customer Bundles detail table below.

Device List

<CustomerDeviceDetails>

</CustomerDeviceDetails>

All devices in use by the customer

This tag contains information regarding the devices a customer uses. See the Customer Device details table below for more information.

DID Information

<CustomerDidDetails>

</CustomerDidDetails>

Information regarding the DIDs in use by the customer.

See the Customer DID Details table below.

Hot Desk Phone List

<CustomerHotDeskPhoneDetails>

</CustomerHotDeskPhoneDetails>

All hot desk phones in use by the customer

See the Customer Hot Desk Phone details table below.

Site List

<CustomerSiteList>

</CustomerSiteList>

All Sites used by a customer.

See the Customer Site Details table below.

User List

<CustomerUserDetails>

</CustomerUserDetails>

A list of all Users for that customer.

See the Customer User Details table below.

Voice mail details

<customerVoiceMailDetails>

</customerVoiceMailDetails>

Voice mail details for the customer.

See the Customer Voice Mail details table below.

Customer Name

<name></name>

The customers name

string

Reporting Status

<reportingStatus></reportingStatus>

Determines whether license reporting is enabled for this customer

  • Active

  • Inactive

Report Generation time

<time></time>

The time the report was generated.

Time format is YYY/MM/DD - HH:MM:SS and is in 24 hour clock format

Last sync Time

<synctime></synctime>

The last time this customer had a successful sync.

Time format is YYY/MM/DD - HH:MM:SS and is in 24 hour clock format

Customer Bundle Details

The list of bundles allocated to each customer. The list is bracketed by the <BundleList> tag. Each bundle within the list is bracketed by the <Bundle> tag.

Field name

Format

Description

Possible values

Customer Bundle list

<BundleList></BundleList>

The list of bundles for the customer

A list of bundles bracketed by the <Bundle> tag.

Customer Bundle

<Bundle></Bundle>

Details on a specific bundle.

See the Bundle Details section/table that describes the list of Service Provider bundles. The same information type and format will be displayed here for the customer bundles

Customer Device Details

The list of devices used by the customer. The list is bracketed by the <DeviceList> tag. Each device within the list is bracketed by the <Device> tag.

Field name

Format

Description

Possible values

Customer Device list

<DeviceList></DeviceList>

The list of customer devices

For each device type, information on that device will be contained with a <Device> tag.

Customer device

<Device></Device>

Information describing one type of device assigned to the customer.

Each tag will bracket information on a particular device

Device Identifier

<id></id>

The Mitel Identifier for a device

string

Device Name

<name></name>

The device name

  • 5235 IP

  • 5224 dual mode

  • 5304 IP

  • 5312 IP

  • 5320 IP

  • 5324 IP

  • 5330 IP

  • 5340 IP

  • 5360 IP

  • 5212 dual mode

  • 5215 IP

  • 5220 dual mode

  • 5320e IP

  • 5330e IP

  • 5340e IP

  • 5610 SIP

  • 5603 SIP

  • 5604 SIP

  • 5607 SIP

  • 5610 SIP

  • 5624 SIP

  • 612 SIP DECT

  • 622 SIP DECT

  • 632 SIP DECT

  • 650 SIP DECT

  • 6905 IP

  • 6910 IP

  • 6920 IP

  • 6930 IP

  • 6940 IP

  • 6970 Conference Phone

  • Openphone 26/26

  • 112 DECT

Used Count

<numberUsed></numberUsed>

The number of devices in use by the customer

integer

Customer DID Details

Information regarding the DIDs assigned to a customer.

Field name

Format

Description

Possible values

Assigned DID count

<numberAssigned></numberAssigned>

The number of DIDs assigned to a customer

integer

Used DID Count

<numberUsed></numberUsed>

The number of DIDs in use by the customer

integer

Customer Hot Desk Phone Details

The list of hot desk phones used by the customer. The list is bracketed by the <HotDeskPhoneList> tag. Each device within the list is bracketed by the <HotDeskPhone> tag.

Field name

Format

Description

Possible values

Customer hot desk list

<HotDeskPhoneList></HotDeskPhoneList>

The list of customer hot desk phones

For each hot desk phone, information on that phone will be contained with a <HotDeskPhone> tag.

Hot desk phone

<HotDeskPhone></HotDeskPhone>

Information describing one hot desk phone

Each tag will bracket information on one hot desk phone. There will be one for each hot desk phone.

Extension

<extension></extension>

The extension of the hot desk phone

string

Name

<name></name>

The name assigned to the hot desk phone

string

Device Name

<deviceName></deviceName>

The device name

  • 5235 IP

  • 5224 dual mode

  • 5304 IP

  • 5312 IP

  • 5320 IP

  • 5324 IP

  • 5330 IP

  • 5340 IP

  • 5360 IP

  • 5212 dual mode

  • 5215 IP

  • 5220 dual mode

  • 5320e IP

  • 5330e IP

  • 5340e IP

  • 6905 IP

  • 6910 IP

  • 6920 IP

  • 6930 IP

  • 6940 IP

  • 6970 Conference Phone

Customer Site Details

The list of sites used by the customer. Information for each site is bracketed by the <CustomerSite> tag.

Field name

Format

Description

Possible values

Customer Site

<CustomerSite></CustomerSite>

Each customer site is bracketed by this tag.

Each tag will bracket information on a particular site

Primary MiVoice Business Name

<primaryMcdName>

</primaryMcdName>

The name of the primary MiVoice Business for the site.

string

Secondary MiVoice Business Name

<secondaryMcdName></secondaryMcdName>

The name of the secondary MiVoice Business for the site.

string

Site Identifier

<siteId></siteId>

The identifier assigned to the site by the service provider

string

Site In Use state

<siteInUse></siteInUse>

Will show true if at least one user or group or mailbox is using the site.

  • true

  • false

Site Name

<siteName></siteName>

The name assigned to the Site by the Service Provider

string

Managed state

<managed></managed>

If true, the site was created and is managed by Management Portal. If false, the site was discovered during a platform sync.

  • true

  • false

Customer User Details

The list of users for this customer are bracketed within the <UserList> tag. Each user's data is contained within a <User> tag.

Field name

Format

Description

Possible values

User's Bundle

<bundleName></bundleName>

The name of the bundle assigned to the user

string

User's Device

<deviceName></deviceName>

The name of the device assigned to the user

  • 5235 IP

  • 5224 dual mode

  • 5304 IP

  • 5312 IP

  • 5320 IP

  • 5324 IP

  • 5330 IP

  • 5340 IP

  • 5360 IP

  • 5212 dual mode

  • 5215 IP

  • 5220 dual mode

  • 5320e IP

  • 5330e IP

  • 5340e IP

  • 5610 SIP

  • 5603 SIP

  • 5604 SIP

  • 5607 SIP

  • 5610 SIP

  • 5624 SIP

  • 612 SIP DECT

  • 622 SIP DECT

  • 632 SIP DECT

  • 650 SIP DECT

  • 6905 IP

  • 6910 IP

  • 6920 IP

  • 6930 IP

  • 6940 IP

  • 6970 Conference Phone

  • Openphone 26/26

  • 112 DECT

User's extension

<extension></extension>

User's assigned prime extension

string

User's first name

<firstName></firstName>

User's first name

string

User's last name

<lastName></lastName>

User's last name

string

Number of Dids.

<numberOfDids></numberOfDids>

Number of DIDs assigned to the user. This does not include any external hotdesk numbers that the user may have.

string

User's License Type

<licenseType></licenseType>

The UCC license type assigned to the user

  • Basic IPT

  • Standard IPT

  • Entry UCC

  • Standard UCC

  • Premium UCC

  • Contact Center Agent

User's Bundle Product code

<productCode></productCode>

The product code of the user's bundle

string

User's site id

<siteId></siteId>

The Identifier of the site assigned to the user

string

User's site name

<siteName></siteName>

The name of the site assigned to the user

string

User's username

<username></username>

The user's username

string

Managed status

<managed></managed>

If true, the user was created and is managed by Management Portal. If false, the user was discovered during a platform sync.

  • true

  • false

Customer Voicemail Details

Information about the voice mailboxes used by this customer. This data is bracketed by the <customerVoiceMailDetails> tag.

Field name

Format

Description

Possible values

Auto Attendant Voice mailbox count

<numberVoicemailboxesByAA>

</numberVoicemailboxesByAA>

The number of mailboxes used by the auto attendant for that customer

integer

Group Voice mailbox count

<numberVoicemailboxesByGroup>

</numberVoicemailboxesByGroup>

The number of mailboxes used by the groups for that customer

integer

User Voice mailbox count

<numberVoicemailboxesByUser>

</numberVoicemailboxesByUser>

The number of mailboxes used by the users for that customer

integer

Total Voice mailbox count

<totalnumberVoicemailboxes>

</totalnumberVoicemailboxes>

The total number of mailboxes for that customer

integer

Reseller Details

The reseller details will list all Value-Added Resellers and Virtual Service Providers for the Service Provider.

The list of Value-Added Resellers are bracketed within the <ValueAddedResellerSnapshotList> tag with data for each value added reseller bracketed by the <ValueAddedResellerSnapshot> tag. All data within these tags, meaning bundles, customers, etc, is formatted the same as the data is for the service provider and the description will not be duplicated here.

The list of Value-Added Resellers are bracketed within the <VirtualServiceProviderSnapshotList> tag with data for each value added reseller bracketed by the <VirtualServiceProviderSnapshot> tag. All data within these tags, meaning bundles, customers, etc, is formatted the same as the data is for the service provider and the description will not be duplicated here.

<Billing>

<ServiceProviderSnapshot>

General information ...

<BundleDetailsList>

Bundle details ...

</BundleDetailsList>

<CustomerSnapshotList>

Customer details ...

</CustomerSnapshotList>

<ResellerSnapshot>

<ValueAddedResellerSnapshotList>

<ValueAddedResellerSnapshot>

All the same information and in the same format with the same tags as for a Service Provider, meaning all bundles, customers, etc

</ValueAddedResellerSnapshot>

</ValueAddedResellerSnapshotList>

<VirtualServiceProviderSnapshotList>

<VirtualServiceProviderSnapshot>

All the same information and in the same format with the same tags as for a Service Provider, meaning all bundles, customers, etc

</VirtualServiceProviderSnapshot>

</VirtualServiceProviderSnapshotList>

</ResellerSnapshot>

<ServiceProviderLicenseDetails>

Manual License details ...

</ServiceProviderLicenseDetails>

</ServiceProviderSnapshot>

</Billing>

Manual License Details

This section of the report will list all the manually entered license information that were specified on the Edit Licensing page. The list is bracketed by the <ManuallyEnteredLicensesList> tag. Each license within the list is bracketed by the <ManuallyEnteredLicensesDetails> tag.

Field name

Format

Description

Possible values

License description

<description>

</description>

Management Portal provided description of each license

  • MIVOICE_SFDC_ADV

  • SCREEN_RECORDING

  • MITEL_CRM_PRO

  • REPORT_EXTENSION

  • NPM_TTS

  • BR_X50

  • BA_PRIVATE_CLOUD

  • INSIGHT_EXTENSION

  • HOSPITALITY

  • OIG_GOOGLE

  • ACD_AGENT

  • NPM_SAA_CORP_DIR

  • MICOLLAB_PORT

  • OIG_SFDC

  • ANALOG_ONS

  • NPM_FAX

  • MIVOICE_BUSINESS_CONSOLE

  • BR_CLIENT_X1

  • MBG_SIP_TRUNK

  • CALL_RECORDING

  • SPEECH_SEARCH

  • MITEL_CRM_PREMIUM

  • CALL_ACCT_EXTS

  • SRC

  • MICOLLAB_CONSOLE

  • VOICE_MAILBOX

  • QUALITY_MONITORING

  • MITEL_CRM_BASIC

  • IVR_STD_PORTS

  • MICLOUD_CC_IVR

  • MICLOUD_CC_AGENT

  • _CC_SOFTPHONE

  • STD_AGENTS

  • ADV_AGENTS

  • MICLOUD_CC_MULTIMEDIA_AGENT

  • IVR_PREM_PORTS

  • BASIC_AGENTS

  • MICLOUD_CC_MULTITENANT_AGENT

  • PREM_AGENTS

  • WFS_STANDARD_X1

  • Entry UCC

  • Standard IPT

  • Basic IPT

  • Contact Center Agent

  • Premium UCC

  • Standard UCC

  • UC_TELEWORKER

  • Softphone

  • Mobile Sip

License Type

<licenseType>

</licenseType>

Type of License

  • MIBUSINESS

  • MICONTACT

  • M2CLOUD

  • UCC_LICENSE

  • MW_UCC_LICENSE

  • MW_ALACARTE

Part Number

<partnumber>

</partnumber>

The part number of the license

string

License count

<usageCount>

</usageCount>

The total number used. This number was entered on the Edit Licensing page.

integer