Cisco Vision Director Bulk Administration Tool

Available Languages

Download Options

  • PDF     (1.7 MB)
    View with Adobe Reader on a variety of devices
Updated:March 6, 2018

Bias-Free Language

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.

Table of Contents

Cisco Vision Director Bulk Administration Tool

Contents

Prerequisites for the Bulk Administration Tool

Restrictions for the Bulk Administration Tool

Information About the Bulk Administration Tool

TSV File Formats

Locations and DMPs TSV File Format

Locations to DMP Mapping TSV File Format

How to Use the Bulk Administration Tool

Exporting and Downloading a TSV File for Locations and DMPs

Editing a TSV File

Creating a DMP or Location Entry in a TSV File

Creating an IP Phone or Third-Party Device Entry

Deleting an Existing Entry

Updating an Existing Entry

Exporting and Downloading a TSV File for DMP Mapping

Importing a TSV File

Exporting Luxury Suite Names and PIN Information

Configuration Examples for the Bulk Administration Tool

Example: Linking and Unlinking Existing DMPs to Locations Using a TSV File

Troubleshooting the Bulk Administration Tool

Troubleshooting Tips

Error Messages

Feature Information for the Cisco Vision Director Bulk Administration Tool

Cisco Vision Director Bulk Administration Tool

First Published: November 4, 2011

Revised: December 12, 2017

 

The Bulk Administration Tool is functionality within the Cisco Vision Director software that provides an alternative to manually defining DMPs, IP Phones, locations, and third-party touch panels in the Devices area of the Control Panel. It allows you to add, delete, or modify device definitions in bulk to the Cisco Vision Director database as a batch export and import of data.

In addition to defining the DMPs, you can use the Bulk Administration Tool to associate the DMP with a particular location. This is referred to as linking or creating a DMP-to-location mapping.

Beginning in Cisco StadiumVision Director Release 2.4, you also can use the Bulk Administration Tool to export a list of configured suite names and PIN information.

Note : This document contains information about BAT through Cisco Vision Director Release 6.0. For a list of changes in Cisco Vision Director Release 6.0, see the Release Notes for Cisco Vision Director Release 6.0.

Prerequisites for the Bulk Administration Tool

Before you use the Bulk Administration Tool, be sure that the following requirements are met:

■You have a Cisco Vision Director user account that is configured for an administrator role.

■Determine the TV locations and a naming convention for devices that you want to add. A good naming convention will aid in problem isolation and troubleshooting, enabling you to more easily identify a TV or DMP that is experiencing difficulty.

Restrictions for the Bulk Administration Tool

When using the Bulk Administration Tool, consider the following restrictions:

■The Bulk Administration Tool has been tested with Microsoft Excel 2010. Other versions have not been tested, but might also work.

■The Bulk Administration Tool supports tab-delimited text format beginning in Cisco StadiumVision Director Release 2.4. This is the preferred format for Unicode text to support internationalization and localization.

Note : When updating files, be sure to save text files as ‘Unicode text (*.txt) and not ‘Text (Tab Delimited) (*.txt)’ format for import into Cisco Vision Director.

■To avoid errors due to truncation, limit the contents of the Cisco Vision fields to 200 characters in length.

■When you import a file, the following limitations exist:

–No message is displayed when the import is completely successful.

–No error message displays if the imported file is not saved as a unicode text file format “Unicode text (*.txt)” using tab-separated values. The file is simply ignored. Confirm that your imported data uploaded.

Information About the Bulk Administration Tool

The Bulk Administration Tool for Cisco Vision Director provides an alternative to manually adding, updating or deleting device information in the Cisco Vision Director database. Device information can include DMPs, IP Phones, and third-party touch screens used for local TV control.

The Bulk Administration Tool uses a tab-separated values (TSV) text file to import and export data. This file can be edited using a standard spreadsheet application, such as Microsoft Excel.

Before the data is imported, the Bulk Administration Tool gets the current configuration from Cisco Vision Director (which might be empty, if this is the first time you are using the tool), merges the two sets of information, and checks for errors. If no errors are found, the Bulk Administration Tool synchronizes the database. If errors are found, the Bulk Administration Tool returns an error message, as described in the “Possible Error Messages” section.

The Bulk Administration Tool in Cisco Vision Director Release 6.0 supports the following functions:

■DMPs, luxury suites, locations, and local control devices (IP Phone, AMX or Crestron touch panels) can be loaded into the Cisco Vision Director database in a bulk manner.

■Bulk association of DMP to Location is enabled using the “Entry Type” field to support the location association.

■Can be used in connection with an off-the-shelf bar code scanner for capturing DMP MAC addresses and TV Location IDs.

■Incremental updates are supported, allowing the tool and the Cisco Vision Director user interface to be used interchangeably.

■The Bulk Administration Tool supports internationalization (i18n) for import/export of data, and for localization (L10n) of messages and headers.

■Data files for the Bulk Administration Tool should be saved and imported as.txt data files in Unicode or UTF-16 format. Exported data is in UTF-16LE with Byte Order Mark (BOM)—this format is supported in Microsoft Windows and Apple MAC environments for all Unicode, including double-byte characters found in Chinese.

Note : Microsoft Excel does not support UTF-16LE format, but you can use Unicode UTF-8.

■TSV data is validated upon upload and any errors detected are logged in a separate file.

■Existing database records can be deleted or modified in bulk using the “Operation Type” field.

TSV File Formats

The format of the TSV file differs depending on whether you are using export/import from the Locations & DMPs tab or from the Locations-DMP Mapping tab in the Devices window of Control Panel Setup.

Locations and DMPs TSV File Format

Locations & DMPs TSV Field Information describes the TSV file format and field descriptions for the text file used for import and export of information from the Locations & DMPs tab on the Devices screen of the Control Panel Setup window.

 

Table 1 Locations & DMPs TSV Field Information

Field
Required?
Description
Possible Values
Description
No
A text description of the device.
Should only use A-Z a-z 0-9 space _ -
Invalid Characters % *, : ? = / \ " ' [ ] () +
Not to exceed 200 characters and spaces.
Entry Type
Yes, for DMPs, IP phones, and locations.
Indicates the type of entry to which the information in this row applies.
The following values are supported:
DMP —The entry is for a DMP. Data supplied should include MAC address, IP address, Name, and TV Type.
LOCATION —The entry is for the physical location of the TV to which the DMP is attached. Data supplied should include the Location Name and the Location ID (optional).
LOCATIONn —The entry is for both the DMP and the location.
External Suite ID
No
The suite ID used to identify this suite in the Point of Sale system.
The external suite ID must match value configured in the Point of Sale system.
External Suite Name
No
The suite name used to identify this suite in the Point of Sale system.
The external suite name (if configured) must match value configured in the Point of Sale system.
Group1–Group8
No
The name of each group with which the DMP is associated.
Note : You should add all DMPs to the nonevent_group.
Alphanumeric text. The group must match the group name configured in Cisco Vision Director, or if the group name does not exist it will be created.
IP Address
Yes, for DMPs and LOCATIONn entries.
The IP address of the device. For DMPs, this is the static address that was assigned to the DMP when it was installed.
Must be a unique, valid IPv4 address (e.g. 0.0.0.256 is not permitted).
Note : Cisco Vision Director does not validate the address or check for duplicates; it only verifies that the IP Address is in the correct format.
LocationID
No
This is user assigned and has no special meaning to Cisco Vision Director. The LocationID intended use is to easily identify the physical location of the devices. For example, a location that is identified by the Architectural Diagram or Map used to install TVs at a venue.
Should only use A-Z a-z 0-9 space _ -
Invalid Characters % *, : ? = / \ " ' [ ] () +
Not to exceed 200 characters and spaces.
Note : Cisco Vision Director does not prevent use of the same name for different devices. Therefore, ensure that you define unique names to each device.
MAC Address
No
The MAC address of the device.
May be in one of the following forms:
AA:BB:CC:DD:EE:FF
aabb.ccdd.eeff
aabbccddeeff (This is the format on the bar code label on the bottom of the DMP 4310)
The only permitted characters are 0-F and colon, dash, period as shown above and letters are not case sensitive.
Model Name
Yes, if device is a DMP.
The model of the DMP.
The following values are supported:
DMP-4305
DMP-4310
Name
Yes
The name that you would like to use to refer to this device.
If the entry type is LOCATION, then this is the LocationName that is referenced in the Location to DMP mapping file.
To be most effective a naming convention is typically employed by the user. This naming convention may use a hierarchical naming convention to efficiently identify a location and make its assignment to Zones and Groups more natural.
Cisco Vision Director does not enforce any naming convention, however, it does enforce uniqueness for the name attribute.
Should only use A-Z a-z 0-9 space _ -
Invalid Characters % *, : ? = / \ " ' [ ] () +
Not to exceed 200 characters and spaces.
Note : Cisco Vision Director does not prevent use of the same name for different devices. Therefore, ensure that you define unique names to each device.
See the StadiumVision Video Endpoint Design and Implementation Guide for recommended naming best practices.
Old Name
No
The existing name of the device.
This field is required if the operation type is Update and the Name is being changed.
Must match an existing device name.
Old Suite Controller Name
No
The existing name of the local control device.
This field is required if the operation type is Update and the Suite Controller Name is being changed.
Must match an existing device name.
Old Suite Name
No
The name of an existing luxury suite or other local control area.
This field is required if the operation type is Update and the Suite Name is being changed.
Must match an existing suite name.
Operation Type
Yes
Specifies the action that you want to take with this row of data in the TSV file.
The following values are supported:
Create —Creates an entry.
Delete —Deletes an entry in Cisco Vision Director that matches the data in this row.
Update —Updates an entry in Cisco Vision Director with the data in this row.
Service Type
No
For IP Phones that are used for local control, this indicates the Cisco Vision service to be run on the phone.
The following values are supported:
Luxury Suite —Service includes support for both Cisco Vision Director Video Management Services and Commerce Services.
AdminOffice —Service includes support for only the Cisco Vision Director Video Management Services. This is designed for use in locations where a Cisco IP Phone will be used for local TV control and there is no need for commerce integration, such as an administrative office.

State

No

The current state of the DMP. This field is provided in the export process for convenience. It is not used during the import process.

Not used during import.
Store
No
The name of the store (within the vendor installation) that will service this luxury suite.
Alphanumeric text. The store must match the store name configured in Cisco Vision Director.
Suite Control Type
Yes, if device is associated with a local control area.
The device to be used for local TV control in the luxury suite or other local control area.
The following values are supported:
Infrared
IP Phone
3rd Party
Suite Controller IP
Yes, if device is associated with a local control area (not required if Suite Control Type is Infrared).
The IP address of the IP phone or third party device that will be controlling this suite.
Must be unique. Must be a valid IPv4 address (e.g. 0.0.0.256 is not permitted). Cisco Vision Director does not validate the address or check for duplicates; it only verifies that the IP Address is in the correct format.
Suite Controller MAC
No
The MAC address of the IP phone or third party device that will be controlling this suite.
May be in one of the following forms:
AA:BB:CC:DD:EE:FF
aabb.ccdd.eeff
aabbccddeeff
The only permitted characters are 0-F and colon, dash, period as shown above and letters are not case sensitive.
Suite Controller Name
Yes, if device is associated with a local control area (not required if Suite Control Type is Infrared).
The name of the local control device.
Should only use A-Z a-z 0-9 space _ -
Invalid Characters % *, : ? = / \ " ' [ ] () +
Not to exceed 200 characters and spaces.
Suite DMP Logical ID
Yes, if device is associated with a local control area.
For a given suite, the logical number for each device. This determines the order in which the TV labels are displayed on the IP phone. For example, in a given suite, Main may be 1, Bar may be 2, outside may be 3.
A numeric value 1 through x, where x is the total number of TVs/DMPs in the suite.
Suite Name
Yes, if device is associated with a local control area.
The name of the luxury suite or other local control area.
Should only use A-Z a-z 0-9 space _ -
Invalid Characters % *, : ? = / \ " ' [ ] () +
Not to exceed 200 characters and spaces.
TV Name
No
The label shown on the TV when the banner is brought up on the TV. This is also the name displayed on the IP phone identify the TV. For example, the label may be a description of the TV's location in the suite, like Main or Bar.
Alphanumeric text. Because this name (or label) is displayed on the IP Phone, the name should be limited to 12 characters or less. Due to the space allotted for display labels on the IP Phone interface, more than 12 characters may have undesirable results.
TV Type
No
The display specification associated with the model of the TV to which the DMP is attached. All TVs of the same model should have the same TV Type. This information is used for managing the RS-232 codes for each model.
Must match the name of an existing display specification. Display specifications are created in Event Management > Control Panel > Setup > Devices > Display Specifications.
Vendor Installation
No
The name of a Point of Sale vendor that will service this luxury suite.
Alphanumeric text. The vendor installation must match the name configured in Cisco Vision Director.

Locations to DMP Mapping TSV File Format

Locations to DMP Mapping TSV Field Information describes the TSV file format and field descriptions for the text file used for import and export of information from the Event Management > Control Panel > Setup > Devices > Locations-DMP Mapping tab.

Table 2 Locations to DMP Mapping TSV Field Information

Field
Description
Possible Values
LocationID
This is user assigned and has no special meaning to Cisco Vision Director. The LocationID purpose is to easily identify the physical location of the devices. For example, a location that is identified by the Architectural Diagram or Map used to install TVs at a venue.
Should only use A-Z a-z 0-9 space _ -
Invalid Characters % *, : ? = / \ " ' [ ] () +
Not to exceed 200 characters and spaces.
Note : See the StadiumVision Video Endpoint Design and Implementation Guide for recommended naming best practices.
LocationName
This is the name column in the sne_device table.
The LocationName must already exist in the Cisco Vision Director server database for the mapping to be successful.
Should only use A-Z a-z 0-9 space _ -
Invalid Characters % *, : ? = / \ " ' [ ] () +
Not to exceed 200 characters and spaces.
See the StadiumVision Video Endpoint Design and Implementation Guide for recommended naming best practices.
MAC Address
The MAC address of the device.
Note: The DMP with this MAC address must already exist in the Cisco Vision Director server database in order for the mapping to succeed.
May be in one of the following forms:
AA:BB:CC:DD:EE:FF
aabb.ccdd.eeff
aabbccddeeff (This is the format on the bar code label on the bottom of the DMP 4310)
The only permitted characters are 0-F and colon, dash, period as shown above and letters are not case sensitive.

How to Use the Bulk Administration Tool

This section includes the following tasks:

■Exporting and Downloading a TSV File for Locations and DMPs

■Editing a TSV File

■Exporting and Downloading a TSV File for DMP Mapping

■Importing a TSV File

■Exporting Luxury Suite Names and PIN Information

Exporting and Downloading a TSV File for Locations and DMPs

TIP : If you do not yet have any information for Locations and DMPs in the Cisco Vision Director Server, you can export an empty file that will have the appropriate formatting for headings only so that you can add new Locations and DMPs from a spreadsheet application.

To export and download a TSV file for Location and DMP information from the Cisco Vision Director server:

1. Log into Cisco Vision Director as an administrator.

2. From the Cisco Vision Director Main Menu, click Event Management > Control Panel.

The Control Panel window displays in a new window.

3. From the Control Panel window, click Setup > Devices > Locations & DMPs tab.

4. Click Export.

 

5. When the Export box displays, click Download.

 

6. When the “Select location for download” window appears, type the name of the.txt file that you want to save, or accept the default name and click Save.

Editing a TSV File

This section describes some of the related tasks to modify a TSV file with data to be imported into Cisco Vision Director. This section includes the following tasks:

■Creating a DMP or Location Entry in a TSV File

■Creating an IP Phone or Third-Party Device Entry

■Deleting an Existing Entry

■Updating an Existing Entry

Figure 1 shows a sample TSV file with data showing delete, update, and create operation types as a reference for the tasks described in this section.

Figure 1 Sample Edit of a TSV File

 

Creating a DMP or Location Entry in a TSV File

To create a DMP or Location entry in a TSV file:

1. Open the file that you exported from the Cisco Vision Director Server in a standard spreadsheet application (such as Microsoft Excel), as a tab-delimited text (.txt) file.

2. In the first available cell of the Operation Type column, type create (see Figure 1).

3. In the corresponding Entry Type cell, type one of the following values with the appropriate case:

■ DMP —Specifies that the entry is for a new DMP.

■ LOCATION —Specifies that the entry is for a physical location of the TV to which the DMP is attached.

■ LOCATIONn —Specifies that the entry is for both the DMP and the location.

4. Complete the remaining cells according to the Entry Type that you specified, and refer to Locations & DMPs TSV Field Information for a description of optional and required fields:

■For a new DMP entry—Data supplied should include the IP address, Name, Model Name, and TV Type. Only the IP address, Name, and Model Name are required.

TIP : The MAC address is populated automatically when Cisco Vision Director polls the DMP using its IP address.

■For a new LOCATION entry— Data supplied should include the Location Name and the Location ID (optional).

5. Save the file as a Unicode text (*.txt) file.

Note : Do not save as ‘Text (Tab Delimited) (*.txt).

Creating an IP Phone or Third-Party Device Entry

To create an IP phone or third party device entry in a TSV file:

1. Open the file that you exported from the Cisco Vision Director Server in a standard spreadsheet application (such as Microsoft Excel), as a tab-delimited text (.txt) file.

2. In the first available cell of the Operation Type column, type create (see Figure 1).

3. In the corresponding Suite Control Type cell, type one of the following values with the appropriate case:

■ Infrared

■ IP Phone

■ 3rd Party

Note : An IP phone can only be created as part of a LOCATION or LOCATIONn entry type. So, you can either add the IP Phone as part of a LOCATION “create” entry, or a LOCATION “update” entry. For more information about updating an existing entry, see Updating an Existing Entry.

4. Complete the remaining cells according to the Suite Control Type that you specified, and refer to Table 1 for a description of optional and required fields.

5. Save the file as a Unicode text file.

Note : Do not save as ‘Text (Tab Delimited) (*.txt).

Deleting an Existing Entry

To delete an existing entry in a TSV file:

1. Open the file that you exported from the Cisco Vision Director Server in a standard spreadsheet application (such as Microsoft Excel), as a tab-delimited text (.txt) file.

2. In the Operation Type cell that corresponds to the entry that you want to remove, type delete (see Sample Edit of a TSV File).

3. Save the file as a Unicode text file.

Note : Do not save as ‘Text (Tab Delimited) (*.txt).

Updating an Existing Entry

For most fields that you want to update, simply overwrite the existing value and Cisco Vision Director will replace that value based on the matching MAC or IP address for the entry when you import the data.

For name-related fields, the updates are made in two separate cells—one that states the original “old” name, and one that specifies the modified name. For example, Figure 1 shows how to change the name of LOCATIONn at 10.50.1.4. The original name of “300-SW-021” is typed in the cell labeled “Old Name,” and the modified name of “100-SE-031” is typed in the cell labeled “Name.”

Note : If any required information is not given, you get an error message. To update existing information, you must have old information already filled in for that field.

To update an existing entry in a TSV file:

1. Open the file that you exported from the Cisco Vision Director Server in a standard spreadsheet application (such as Microsoft Excel), as a tab-delimited text (.txt) file.

2. In the Operation Type cell that corresponds to the entry that you want to modify, type update (see Sample Edit of a TSV File).

3. Complete the appropriate cells for the corresponding field values that you want to modify (according to the type of entry that you are changing), and refer to Table 1 for a description of optional and required fields.

TIP : Any field that you do not want to change can be left blank.

4. To change the value of a name-related field, do one of the following:

■To rename a device:

–Copy the value from the “Name” field, to the “Old Name” field.

–Type the new name in the “Name” field.

■To rename a suite:

–Copy the value from the “Suite Name” field, to the “Old Suite Name” field.

–Type the new name in the “Suite Name” field.

■To rename a suite controller:

–Copy the value from the “Suite Controller Name” field, to the “Old Suite Controller Name” field.

–Type the new name in the “Suite Controller Name” field.

5. Save the file as a Unicode text file.

Note : Do not save as ‘Text (Tab Delimited) (*.txt).

Exporting and Downloading a TSV File for DMP Mapping

You can export two forms of TSV files from the Location-DMP Mapping tab, with the following information:

■MAC address information only (exported from the Available Devices box)— TSV file that contains all of the MAC addresses from existing DMPs that you can use to copy into the TSV file with location information to link existing MAC addresses to locations.

■MAC address and location information (exported from the Locations box)—TSV file that contains MAC addresses, location names, and location IDs. This file is used to link or unlink DMPs from locations.

To export and download a TSV file for DMP mapping information from the Cisco Vision Director server:

1. Log into Cisco Vision Director as an administrator.

2. From the Cisco Vision Director Main Menu, click Event Management > Control Panel. The Control Panel window displays.

3. From the Control Panel window, click Setup > Devices > Location-DMP Mapping tab.

(Optional) To export a list of available MAC addresses only for existing DMPs:

1. In the Available Devices box, click Export.

 

a. When the Export box displays, click Download.

b. When the “Select location for download” window appears, type the name of the.txt file and specify the file location, or accept the default name and click Save.

A TSV file that contains only MAC addresses is created.

To export the current mapping of DMPs to Locations:

1. In the Locations box, click Export.

 

a. When the Export box displays, click Download.

b. When the “Select location for download” window appears, type the name of the.txt file and specify the file location, or accept the default name and click Save.

A TSV file that contains MAC addresses, Location names, and Location IDs is created.

Importing a TSV File

To import a TSV file to Cisco Vision Director server:

1. Log into Cisco Vision Director as an administrator.

2. From the Cisco Vision Director Main Menu, click Event Management> Control Panel. The Control Panel window displays.

3. Do one of the following:

■To import a TSV file for DMP mapping, from the Control Panel window, click Setup > Devices > Locations & DMPs tab. Click Import.

 

■To import a TSV file for DMP mapping, from the Control Panel window, click Setup > Devices > Location-DMP Mapping tab. Click Import.

 

4. When the “Select file for upload” window appears, select the location and name of the.txt file that you want to import, and click Open.

When the import is complete, a message displays that shows the total number of records that were processed, the number that were successfully processed, and the number that failed.

No confirmation is provided if the import is completely successful. See Restrictions for the Bulk Administration Tool.

If any records failed, a message box displays that allows you to save a text file that includes only the rows that contain errors and an indicator of the error. For more information, see Troubleshooting the Bulk Administration Tool.

Exporting Luxury Suite Names and PIN Information

Beginning in Cisco StadiumVision Director Release 2.4, you can generate PINs for luxury suites, and you can manage these assignments by exporting the configured PINs for all luxury suites in a tab-delimited text file using the Bulk Administration Tool.

Note : You cannot import PIN information to Cisco Vision Director.

To export luxury suite names and PIN information from the Cisco Vision Director server:

1. Log into Cisco Vision Director as an administrator.

2. From the Cisco Vision Director Main Menu, click Event Management > Control Panel.

The Control Panel window displays.

3. From the Control Panel window, click Setup > Luxury Suite > Local Control PINs tab.

4. Click Export.

 

5. When the Export box displays, click Download.

6. When the “Select location for download” window appears, type the name of the.txt file that you want to save, or accept the default name and click Save.

A TSV file that contains suite names, PIN names, PIN types, and modify dates is created. You can import this file into a standard spreadsheet application as a tab-delimited text file as with other downloaded text files from the Bulk Administration Tool.

Configuration Examples for the Bulk Administration Tool

This section provides examples of how to modify TSV files to implement specific types of changes.

Example: Linking and Unlinking Existing DMPs to Locations Using a TSV File

To link the DMP to a location:

1. Open the TSV file for DMP mapping that you exported from the Locations box of the Cisco Vision Director Server in a standard spreadsheet application (such as Microsoft Excel), as a tab-delimited text (.txt) file.

For more information, see Exporting and Downloading a TSV File for DMP Mapping.

To link an existing DMP to a location:

1. In the MAC field, enter the MAC address of an existing DMP.

Note : If you exported a list of existing DMP MAC addresses, you can copy the MAC addresses from that text file.

a. In the LocationName field, type a name for the location that you want to link to the corresponding DMP.

b. (Optional) In the LocationID field, type an ID for the location.

To unlink an existing DMP from a location:

1. In the MAC field for an existing DMP, delete the MAC address.

2. Save the file as a Unicode text file.

Note : Do not save as ‘Text (Tab Delimited) (*.txt).

3. Import the TSV file to Cisco Vision Director. See Importing a TSV File.

Troubleshooting the Bulk Administration Tool

If any records failed while importing a TSV file to Cisco Vision Director, a message box displays that allows you to click Download to create a text file that includes only the rows that contain errors along with an error message.

 

After you download this file and save it as a text file, you can open it in a spreadsheet application as you would any of the downloaded text files from Cisco Vision Director to view the specific errors.

Troubleshooting Tips

■You must open the error file with Microsoft Excel or another spreadsheet application.

If you double-click the file to open it, the content is opened in Notepad (by default on a Windows computer), but the error information is unreadable.

■Confirm that your imported data uploaded to the Cisco Vision Director server because when you import a file, the following limitations exist:

–No confirmation message displays when the import is fully successful.

–No error message displays if the imported file is not saved as a unicode text file format “Unicode text (*.txt)” using tab-separated values. The file is simply ignored.

■If you cannot get your import to work as expected, try to simplify the content in the import file until it works. Then, add additional information for import.

Error Messages

CAUTION : No error message displays if the imported file is not saved as a unicode text file format “Unicode text (*.txt)” using tab-separated values. The file is simply ignored. Confirm that your imported data uploaded.

Table 3 provides a list of possible error messages, their meanings, and recommended resolutions.

I

Table 3 Bulk Administration Tool Error Messages

Message in the Error Text Field

Description

Resolution

Could not get the device, ID:{deviceid}, Exception:{Data Access Layer Exception}

An error occurred while retrieving the Device information for export.

Verify that the device ID being exported exists in the database.

If it exists, then further troubleshooting is required based on the Data Access Layer Exception. Contact the escalation team.

Destination Device is null

The Destination Device referred to by the LocationName or Location ID in the CSV file does not exists in the database.

Verify the LocationName or LocationID using Export.

Destination Device:{destiondeviceid} not found

The Destination Device ID specified in the Unlink Operation does not exist in the database.

Enter a valid Destination Device ID.

Destination Object Types is invalid for link operation (it should be Type- #2 or Type - #3)

In the linking process, the Destination Object can be a LOCATION (Type 2) or a LOCATIONn (Type 3).

Verify that the destination object being linked is either a LOCATION or a LOCATIONn.

Destination Object Type invalid for Unlink operation (it should be Type- #3)

In the unlinking process, the Destination Object must be a LOCATIONn (Type 3).

Verify that the destination object being unlinked is either a LOCATIONn.

Device Name has invalid character colon

The device name contains a colon, which is not allowed.

Remove or replace the colon from the device name in the row that contains this error.

Device Name is Empty

The device name either was not entered or was entered as blank.

Enter the device name in the row that contains this error.

Device named {device name} has empty IP Address

The IP address of the device either was not entered or was entered as blank.

Enter a valid IP address in the row that contains this error.

Duplicate entry '{value}' for key 1
Duplicate entry '{value}' for key 2
Duplicate entry '{value}' for key 3

A duplicate value was entered for one of the following fields: Name, MAC address, or LocationID.

Search for {value} in the row that contains this error and correct the duplication.

Error: Could not get the Destination device, ID:{DestinationDeviceID}

The Destination Device ID specified does not exists in the database.

This message is generated when the Link Operation is performed using the UI.

Verify the Destination Device ID using Export.

Error: Could not get the source device, ID:{SourceDeviceID}

The Source Device ID specified does not exists in the database.

This message is generated when the Link Operation is performed using the UI.

Verify the Source Device ID using Export.

Invalid Controller IP Address Format{IP Address}

The format of IP address entered was incorrect.

Correct the format of the IP address in the row that contains this error.

Invalid CSV File Heading (Column #1 should be MAC, and Column #2 should be LocationName or LocationID

When importing a CSV file on the Locations-DMP Mapping tab, the first row of the CSV file (which is the header) is incorrect.

Check the input CSV file. The first entry in the row should be MAC address, the second column should be LocationName or LocationID. Other columns are ignored.

Invalid Destination ID Specified, ID:{Destination ID}

The Destination ID specified in the Unlink Operation is invalid.

Specify a valid Destination ID.

Invalid Device MAC Address:{MAC}

The MAC address entered was not 12 valid hexadecimal characters.

The Bulk Administration Tool translates the MAC address entered into a valid MAC format (for example, 00:0f:01:02:03:04) after which the tool validates the format and characters.

Enter 12 valid hexadecimal characters in the row that contains this error.

Invalid IP Address Format:{IP Address}

The format of IP address entered was incorrect.

Correct the format of the IP address in the row that contains this error.

Invalid Model Name

The device model is invalid. Only DMP-4305G and DMP-4310G are valid entries.

Enter a valid model name (DMP-4305G or DMP-4310).

Invalid Source and Destination device id specified in LinkRequestVO

The Source Device or the Destination Device ID specified does not exists in the database.

This message is generated when the Link Operation is performed using the UI.

Verify the Source Device ID and the Destination Device ID using Export.

Invalid source or destination id

The Source Device or the Destination Device ID specified does not exists in the database.

This message is generated when the Link Operation is performed using the UI.

Verify the Source Device ID and the Destination Device ID using Export.

Invalid Suite Controller MAC Address:{MAC}

The MAC address entered was not 12 valid hexadecimal characters.

The Bulk Administration Tool translates the MAC address entered into a valid MAC format (for example, 00:0f:01:02:03:04) after which the tool validates the format and characters.

Enter 12 valid hexadecimal characters in the row that contains this error.

Link Unsuccessful, For SouceMAC : {SourceDevice MAC Address}, Destination Location Name: {destnLocName} Exception Message: {Exception Message returned from Data Access Layer}

This is a Duplicate or Database low level error.

Report this error to the escalation team.

Mac Address is null or empty

The Source Device MAC is null or empty.

This message is generated when the Link Operation is performed using the UI.

Check the Source Device MAC address. If it is empty, run getstat().

Source, Destination Object Type combination is invalid for link operation

In the linking process:

■The Destination Object can be a LOCATION (Type 2) or a LOCATIONn (Type 3).

■The Source Object can be a DMP (Type 1) or a LOCATIONn (Type 3).

Verify that the source and destination object types are correct.

Source and Destination Device are the same

The Source MAC address and Destination Location specified in the CSV file refers to the same device. For Link Operation these should be different.

Verify the Source MAC address and Destination Location using Export.

Source Device is null

The Source Device referred to by the MAC address in the CSV file, does not exists in the database.

Verify the MAC address using Export.

Source Device MAC address is null or empty

The MAC address for the Source Device is empty or null.

The Source MAC address must exist before performing a Link Operation. Run getStatus before running the Link Operation.

Source Object Type is invalid for link operation (It should be #1 or #3)

In the linking process, the Source Object can be a DMP (Type 1) or a LOCATIONn (Type 3).

Verify that the source object being linked is either a DMP and a LOCATIONn.

Suite Controller Ip Address is empty

The IP address of the Suite Controller either was not entered or was entered as blank.

Enter a valid IP address in the row that contains this error.

Unknown Operation Mode**

The Operation Type field for the entry is empty.

Enter one of the following values:

■ create

■ delete

■ update

UnLink Unsuccessful, Destination: {destiondeviceid} Exception Message:{Data Access Layer exception

This is a Duplicate or Database low level error.

Report this error to the escalation team.

Feature Information for the Cisco Vision Director Bulk Administration Tool

Feature Information for the Cisco Vision Director Bulk Administration Tool lists the release history for this feature.

Table 4 Feature Information for the Cisco Vision Director Bulk Administration Tool

Date

Releases

Feature Information

December 12, 2017

Release 6.0.0-740

■Updated figures to reflect new 6.0 release and UI updates.

■Resolved defect number CSCvc51526 regarding exporting list of all devices.

November 4, 2011

Release 2.4.0-147

Initial release for Cisco StadiumVision Director Release 2.4. The following enhancements are introduced for the Bulk Administration Tool:

■The tool has been modified to support internationalization (i18n) for import/export of data, and for localization (L10n) of messages and headers, and includes the following changes:

–The.csv file extension is no longer supported. The tool now supports.txt files for saving of data in Unicode format.

–Comma-delimited data for import is no longer supported; it is replaced by tab-delimited format (preferred format for Unicode text).

–Data files for the Bulk Administration Tool should be saved and imported as.txt data files in unicode or UTF-16 format. Exported data is in UTF-16LE with Byte Order Mark (BOM)—this format is supported in Microsoft Windows and Apple MAC environments for all Unicode, including double-byte characters found in Chinese, and so on.

■The tool adds support for export of suite names and PIN information.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1721R)

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.

© 2017 Cisco Systems, Inc. All rights reserved.

Was this Document Helpful?

FeedbackFeedback

Contact Cisco

This Document Applies to These Products