The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Cisco HCS supports Service Inventory, an application that periodically queries the Cisco Unified Communications Domain Manager server and reports the current operating state of the underlying Unified Communications applications. The data provides information about customers, subscribers, devices, and other details that are currently provisioned for Cisco HCS through Cisco Unified Communications Domain Manager. This data gets used by the service provider to generate appropriate billing records for end customers as part of regular business processes. It also can report on the overall state of the system. For more information on the data that is generated, see "Service Inventory Common Format" section on page 13-1.
The Service Inventory administrative interface allows you to schedule, configure, and generate Service Inventory billing reports, which use a Cisco common format. The generated reports get backed up for a configured amount of time, which is 60 days by default. Service Inventory automatically transfers the report files at regular intervals to the remote SFTP servers that you configure in the Service Inventory administrative interface. If report generation fails, Service Inventory sends you an email failure notification if an email address is configured.
Tip Service Inventory also provides the ability to customize reports. To customize reports, contact Cisco Advanced Services for assistance.
Service Inventory requires specific user accounts for administrative and SFTP access. To access the Cisco HCS administrative interface and Cisco HCM-F CLI for service inventory, you must use the administrator username and password that was set up during the Cisco HCM-F platform installation (unless you changed the administrator username and password). SFTP access requires that the adminsftp user has the same password as the Cisco HCS administrator.
This chapter contains information on the following topics:
•Configuration Checklist for Service Inventory
•How Report Generation Works for Service Inventory
•Configure Infrastructure Manager for Service Inventory Support
•Configure General Settings for Service Inventory
•Configure the Schedule for Daily Report Generation
•Display the List of Generated Reports
•Transfer a Report to the Remote SFTP Server
Table 6-1 lists the steps that you must perform to get Service Inventory up and running. Service Inventory uses configuration data from Cisco Unified Communications Domain Manager, so this section assumes that you have configured the data in Cisco Unified Communications Domain Manager.
If you want to do so, you can use the Cisco HCM-F NBI to configure Service Inventory, instead of the Service Inventory administrative interface.
|
|
|
---|---|---|
Step 1 |
If you have not already done so, install the Cisco HCM-F platform, which installs Service Inventory. You perform this task if you are installing Cisco HCM-F for 8.6(2) for the first time or migrating Service Inventory from Cisco HCS 8.6(1). |
|
Step 2 |
If you used Service Inventory in Cisco HCS 8.6(1), perform migration tasks. |
Upgrading the Components for Cisco Hosted Collaboration Solutions (HCS) 8.6(2) |
Step 3 |
Verify that you have added an Cisco Unified Communications Domain Manager application instance in the Infrastructure Manager administrative interface. (Management Network > Management Application)
|
Configure Infrastructure Manager for Service Inventory Support |
Step 4 |
If you have not already done so, enter utils service activate Cisco HCS Inventory Service through the CLI on the Cisco HCM-F platform. If you have not already done so, enter utils services list through the CLI on the Cisco HCM-F platform to verify that the following services are running: •Cisco CDM Database •Cisco Tomcat •Cisco HCS SI UI —Use this service if you plan on configuring Service Inventory through the Service Inventory administrative interface. •Cisco HCS North Bound Interface Web Service—Use this service if you plan on configuring Service Inventory through the Cisco HCM-F NBI. •Cisco HCS Fulfillment Service—Ensure that this service is running if you plan to run Cisco HCS CUCDMSync Service. •Cisco HCS CUCDMSync Service—Use this service so that automatic synchronization can propagate Cisco Unified Communications Domain Manager data to the Shared Data Repository. Service Inventory obtains the connection data for Cisco Unified Communications Domain Manager from the Shared Data Repository. |
|
Step 5 |
Configure general settings for Service Inventory. In the Service Inventory administrative interface, click Configuration. |
|
Step 6 |
Set up the schedule to generate daily reports. In the Service Inventory administrative interface, click Overview. If you activated the Cisco HCS CUCDMSync service, ensure that the service has performed at least one synchronization before you generate a daily report. Verify the synchronization occurred in the Jobs page in Infrastructure Manager. |
|
Step 7 |
If you want to do so, transfer a backup report to the remote SFTP server. In the Service Inventory administrative interface, click Backup. |
Display the List of Generated Reports |
Step 8 |
Interpret the data in the report. |
This section describes how service inventory generates reports. This section assumes that you have configured the system, as described in the "Configuration Checklist for Service Inventory" section.
At the time that is specified in the Service Inventory configuration, Service Inventory sends a real-time query request to Cisco Unified Communications Domain Manager for information. Cisco Unified Communications Domain Manager generates the necessary files and sends the files to Service Inventory through SFTP. Service Inventory processes the files, including but not limited to backing up the files for troubleshooting purposes, creating the report, and transferring the report to the SFTP servers that are configured in the Service Inventory administrative interface.
The generated report contains data for the previous 24 hours, up to and including the end time that you specify on the Overview page in the Service Inventory administrative interface.
For Service Inventory to interact with Cisco Unified Communications Domain Manager, verify that an application instance is configured for Cisco Unified Communications Domain Manager on the Management Network page in the Infrastructure Manager administrative interface (Management Network > Management Application). If you determine that an instance does not exist, configure the settings in Table 6-2.
In the Service Inventory administrative interface, you manage credentials and configure general settings for Service Inventory on the Configuration page. Table 6-3 provides a list of settings that you configure on the Configuration page.
Tip Service Inventory works with Cisco Unified Communications Domain Manager. For service inventory to work, make sure that you configure Cisco Unified Communications Domain Manager in the Infrastructure Manager administrative interface, as described in the "Configuration Checklist for Service Inventory" section.
In the Service Inventory administrative interface, click Configuration. Enter the configuration for the settings in Table 6-3; then click Save.
The Overview page in the Service Inventory administrative interface displays the current status for Service Inventory and any events that you scheduled.
Tip Before you schedule a report generation time, ensure that you have performed the tasks that are described in the "Configuration Checklist for Service Inventory" section. If you do not configure the required options on the Configuration page in the Service Inventory administrative interface, the report generation fails.
If the Enable Schedule check box is unchecked, the report does not get generated at the specified time. Keep the Enable Schedule check box unchecked until you are ready to send billing files and until you have performed the tasks from the "Configuration Checklist for Service Inventory" section. If the Configuration page is not configured correctly, the report generation fails.
To schedule the generation of daily reports, perform the following procedure:
Step 1 Check Enable Schedule.
Step 2 Set a time when you want the reporting to be executed. Enter a format that uses HH:MM:SS, where HH equals hours, MM equals minutes, and SS equals seconds.
Set the time that you want the reporting to end. The generated report contains data for the previous 24 hours, up to and including this end time.
Tip Enter the report time by using GMT; you can hover over the i icon to see the GMT report time converted to your local client (browser) time.
Step 3 Select the version for the report format that you want to view.
Tip The Cisco HCS 8.6(2) report format version is only compatible with Cisco Unified Communications Domain Manager 8.0 (and later). The Cisco HCS 8.6(1) report format version is compatible with Cisco Unified Communications Domain Manager 7.4 and 8.0 (and later).
Step 4 Click Save.
In the Service Inventory administrative interface, the Backup page displays a list of generated report files. The Backup page displays the file name, date, and file size for the generated report. Filter the results by selecting an option from the Show drop-down list box or by clicking one of the columns on the page.
Tip The configuration for the Local Backup Retention Period setting on the Configuration page determines the files that appear in the list on the Backup page. Service Inventory deletes reports based on the value that you configure for this setting. For example, if you configure this setting as 35, and the report is 36 days old, the report name does not appear in the list.
You can transfer a report to the remote SFTP server that you configured on the Configuration page in the Service Inventory administrative interface. To transfer a report, perform the following procedure:
Step 1 In the Service Inventory administrative interface, click Backup.
Step 2 The list of generated reports appear. Locate and select the files that you want to transfer to the remote SFTP server.
Step 3 Click Transfer Selected Files.
Step 4 To view the file backup job status in the Infrastructure Manager administrative interface, select Administration > Jobs.
To understand the data that displays in the Service Inventory report, see "Service Inventory Common Format" section on page 13-1.
•Service Inventory Common Format, page 13-1
•Troubleshooting Service Inventory, page 12-8
•Upgrading the Components for Cisco Hosted Collaboration Solutions (HCS) 8.6(2)
•Developer Guide for Cisco Hosted Collaboration Mediation Fulfillment 8.6(2)