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.
The HCS Intelligent Loader (HIL) is used to perform bulk operations like bulk add, delete, and update on Cisco Unified Communications Domain Manager. Using the HIL, you can map the user data information to the Cisco Unified Communications Domain Manager information. When the data is loaded, HIL mapping is used to translate data between the source (user data) and destination (Cisco Unified Communications Domain Manager) formats. HIL validates the user data and corrects errors, if any.
Note | HIL relies on Cisco Unified Communications Domain Manager for user authentication. If a user is configured on Cisco Unified Communication Domain Manager, the same credentials are required to access HIL. In Cisco Unified Communications Domain Manager, users can only use Single Sign-On to access the GUI. |
Note | To use HIL, the Cisco Unified Communications Domain Manager version you are using must support it. |
Term |
Definition |
---|---|
Model |
The models are derived from Cisco Unified Communications Domain Manager and conform to the customized display policies for the hierarchy. |
Mapper |
The mapper file is the bridge between the HCS Intelligent Loader column and the Cisco Unified Communications Domain Manager GUI field. |
Loader |
The loader file contains the data. |
Hierarchy |
The HCS Intelligent Loader uses the same hierarchy as Cisco Unified Communications Domain Manager. For more information, see Cisco Unified Communications Domain Manager, Release 10.6(1) Planning and Install Guide or Control Row. |
The first column of the loader is the Control Column.
The control column can use the following values at the start of the column:
# - Comments out a row. You can have a dedicated control column, ideally the first column. When the row's first column has # or starts with #, HIL will consider it as commented row and does not validate nor load the row.
*<#> - Multiple rows are grouped together using * followed by an integer . The number next to * indicates the no of rows starting the current row, that needs to be grouped together. . This means the next rows (the number specified after *, minus one) will not be used for validation, but only for loading. The rows will be grouped together with the master row, and loaded as one transaction. For example:
The control row can be any row after the column headers or titles. At each control row, HIL sets the hierarchy to the hierarchy designated in the control row. The data in the following rows is loaded to the hierarchy specified.
You can use the control row to load data to multiple hierarchies, for example $hierarchy:sys.hcs.provider.customer.
If you prefix the data with "?", the Cisco Unified Communications Domain Manager macro value is evaluated and replaced with the result of evaluation, and then the replaced value gets loaded into the loader.
If you don't prefix the data with "?", then the Cisco Unified Communications Domain Manager existing macro value is loaded into the loader.
Set up the HCS Intelligent Loader platform through an HCM-F service.
This section describes common tasks used in HIL.
The following workflow outlines the tasks for bulk-adding operations.
Create at least one customer and site in the Cisco Unified Communications Domain Manager before you start using the HIL to create mappers.
Step 1 | Navigate to https://<host name>/HIL and login to HIL using your CUCDM email id as your username. | ||||||
Step 2 | Select the model from the menu on the left. | ||||||
Step 3 | Select the required hierarchy at the top of the page. | ||||||
Step 4 | Create mapper, see to Create Model Mapper or Create Multi Model Mapper. | ||||||
Step 5 | Add field
values to source file by choosing one of these options:
For more information, see to Loader Tab Reference. | ||||||
Step 6 | Validate the source file. See to Validate a File. You must validate files before adding, editing, or deleting data in Cisco Unified Communications Domain Manager. | ||||||
Step 7 | Submit the source file to CUCDM. See to Submit to CUCDM. |
The following workflow outlines the normal tasks with bulk updating.
Step 1 | Navigate to the following URL https://<host name>/HIL and login with your CUCDM credentials | ||||||
Step 2 | Select the model from the menu on the left. | ||||||
Step 3 | Select the required hierarchy at the top of the page. | ||||||
Step 4 | Select the Loader tab. | ||||||
Step 5 | Select the file in the table. | ||||||
Step 6 | Edit field
values to source file.
For more information, refer to Loader Tab Reference. | ||||||
Step 7 | Validate the source file, refer to Validate a File. You must perform validation before adding, editing, or deleting data in Cisco Unified Communications Domain Manager. | ||||||
Step 8 | Submit to CUCDM, refer to Submit to CUCDM. |
Step 1 | Select the model from the menu on the left. |
Step 2 | Select the required hierarchy at the top of the page. |
Step 3 | Select the Mapper tab. |
Step 4 | Click Create. The Create Mapper: <Model Name> window opens |
Step 5 | Enter a Name and Description for the mapper. |
Step 6 | Select a Source File, either by selecting Choose from uploaded files or Upload new file from desktop. You create the source file on the Loader tab, by performing an Import from CUCDM or Upload from Desktop prior to creating the map. The mandatory fields for the model selected load automatically. To load all fields click Map All or Add Row. If you add a row, you will need to select the Target Field and Default value.
|
Step 7 | Click
Save
Changes to save the changes or click
Close to close without saving the changes.
Example:When you create a mapper for subscriber model, by default, the mapper displays minimum mandatory fields that are required for adding a subscriber. If user adds any fields related to phone, the mapper will automatically populate, a set of dependent fields (phone) that are required to successfully add phone along with subscriber.
Example:In Cisco Unified Communications Domain Manager Quick Add Subscriber, when you check the checkbox for voice, additional fields such as phone type and phones are displayed. In HIL, if you want to add voice, the fields voice, phone type, and phones must mapped manually. When you add a row for specific models, all the dependent fields appears in target field. While mapping them with the source field, you must select the fields values from the drop-down list.
|
Step 1 | Select . |
Step 2 | Select the required hierarchy at the top of the page. |
Step 3 | Click Create. The Create Mapper: Multi Model Mapper window opens |
Step 4 | Enter a Name and Description for the mapper. |
Step 5 | Select a Source File, either by selecting Choose from uploaded files or Upload new file from desktop. |
Step 6 | Select a Source Sheet. |
Step 7 | Select a Model. |
Step 8 | Click Load. The mandatory fields for the model selected load automatically. To load all fields click Map All or Add Row. If you add a row, you will need to select the Target Field and Default value.
|
Step 9 | Click Save & Close, to close the window, or Save & Continue, to load another mapper. |
When you add data into Cisco Unified Communications Domain Manager, HIL will validate all data in the selected source data sheet.
When you edit data in Cisco Unified Communications Domain Manager, HIL will validate the selected fields from the spreadsheets.
when you delete data from Cisco Unified Communications Domain Manager, HIL will validate only the selected fields from the spreadsheets.
Note | Add, edit, and delete operations are disabled or enabled based on the permissions in Cisco Unified Communications Domain Manager. |
Step 1 | Select the model from the menu on the left. | ||
Step 2 | Select the required hierarchy at the top of the page. | ||
Step 3 | Select the Loader tab. | ||
Step 4 | Select the file name you want to validate. | ||
Step 5 | Click Validate, and then select the type of validation. | ||
Step 6 | The validate window will open. Click Validate. | ||
Step 7 | Click OK on the validation status window. | ||
Step 8 | Check the File Status for validation status message.
|
You can load the Excel spreadsheet into Cisco Unified Communications Domain Manager. You can perform add, edit, or delete functionality while submitting a file in Cisco Unified Communications Domain Manager.
Files must be validated with the status "VALIDATION COMPLETED"
Step 1 | Select the Loader tab. | ||||||||
Step 2 | Select the file you want to submit. | ||||||||
Step 3 | Click Submit to CUCDM, and select one of the following:
Delete is disabled for Site Management and Customer Management, because they have Delete Site and Delete Customer options. | ||||||||
Step 4 | Select the sheets you want to submit. | ||||||||
Step 5 | Click Load. After the loading begins, an icon is displayed at the extreme right of the File Status message. You can click this icon to see the progress status of the file. When the file is loaded, a success message is displayed |
This section describes the HCS Intelligent Loader.
The following table outlines the functions available on the loader tab.
Item |
Description |
||
---|---|---|---|
Select Template |
Drop down to select the available mapper templates. |
||
Preview |
Displays a preview of the selected mapper template. |
||
Upload from desktop |
Allows the user to upload a file from their computer. |
||
Download to desktop |
Allows the user to download a file to their desktop. Users can then edit the spreadsheet and then upload. |
||
Delete |
Deletes the file from HIL. |
||
Rename |
Renames the file. |
||
Import from CUCDM |
Allows the user to select to import the content from CUCDM. The model schema will determine what information is available in the spreadsheet. |
||
Copy |
Copies the file |
||
View/Edit |
Allows the user to view and edit the file in HIL. |
||
Submit to CUCDM |
Allows the user to select to export the loader file into CUCDM. Users can select Add, Edit, Delete. |
||
Validate |
Allows the user to validate the content in the file before, and must be completed before submitting to CUCDM.
|
||
Search |
Allows the user to search for a file. |
||
File |
Displays the file name. |
||
Last Used Template |
Displays the mapper template last used for the loader file. |
||
File Status |
Displays the status of the last action performed with the file. |
The following table describes the file status.
Status |
Description |
---|---|
FILE IMPORTED |
When data is imported successfully from Cisco Unified Communications Domain Manager. |
FILE IMPORT FAILED |
When file import from Cisco Unified Communications Domain Manager fails. |
FILE IMPORT IN PROGRESS |
When file import from Cisco Unified Communications Domain Manager is in progress. |
FILE MODIFIED |
When a file is modified from the View or Edit. |
LOAD COMPLETE WITH ERRORS |
When loading of a file is complete but record shows error in loading the file. |
LOAD FAILED |
Load failed due to network issues or exceptions. |
LOAD IN PROGRESS |
When load is in progress. |
LOAD SUCCESSFUL |
When load completed successfully without errors. |
NEW FILE |
When a new file is uploaded from desktop. |
NO STATUS FOUND |
When no status for the file is available. |
VALIDATION COMPLETED |
When validation is complete successfully (full or partial validation). |
VALIDATION ERRORS |
When validation is complete and have errors (full or partial validation). |
VALIDATION FAILED |
When validation fails to kick off or exceptions (full or partial validation). |
VALIDATION IN PROGRESS |
When validation of file is in progress (full or partial validation): |
VALIDATION PROLONGS |
When validation status does not change withing 5 seconds. Click on Refresh Table icon to update the validation status. |
The following table outlines the functions available on the loader tab.
Item |
Description |
---|---|
Create |
Opens the create window. |
Delete |
Deletes the file from HIL. |
Edit |
Allows the user to edit the file. |
Download to desktop |
Allows the user to download a file to their desktop. Users can then edit the spreadsheet and then upload. |
Upload from desktop |
Allows the user to upload a file from their computer. |
Copy |
Copies the file |
Rename |
Renames the file. |
View |
Allows the user to view the file. |
Name |
Displays the name of the file. |
Owner |
Displays the owner of the file. |
Modified |
Displays the date the file was last modified. |
Last Modified by |
Displays the name of the user that last modified the file. |
After you click the config tab, you can view or edit the configured target system's (Cisco Unified Communications Domain Manager) host name and host ID.
Field |
Description |
---|---|
Target System |
Displays the name of the target system (CUCDM) |
Target System Host |
Displays the name of the target system host |
Target System IP |
Displays the IP address of the target system |