Description

The easiest way to add Hotwords to a new Hotword Set in Enterprise Vault Compliance Accelerator (CA) / Veritas Advanced Surveillance (VAS) via the ImportExport utility is to first create the required Hotword Set in the UI, then Export the CA Customer, extract the required lines from the Export XML file to a new XML file, edit specific lines as needed, add the required hotwords and then import the new XML file.

Here are the steps.

1. Create a new Hotword Set under Application | Hotwords or Department | Hotwords. Do not add any Hotwords to the set. In the steps below, the new example Application Hotword Set name is New Application Hotword Set 01, the new example Department Hotword Set name is New Department Hotword Set 01.

2. Use the ImportExport utility to export the CA/VAS Customer:

2.1. Log on to the CA/VAS server as the Vault Service Account (VSA), start a command prompt, navigate to the CA Server installation folder in the command prompt and execute ImportExport.exe.

C:\Program Files (x86)\Enterprise Vault Business Accelerator>ImportExport.exe
Welcome to the Accelerator Export Tool

2.2. Select the option to Export:

Select Import or Export (default E):
Enter 'I' for Import or 'E' for Export:E

2.3. Select the CustomerID (use the question mark (?) to see the list of CustomerIDs):

Enter the customer ID ("?" for Customer list): ?

CustomerID      Customer Type   Customer Name
-----------------------------------------------------------------------------------------------------------------------
1               Compliance      EVCACustomer

Enter the customer ID ("?" for Customer list): 1

2.4. Enter the name of the Import XML file:

Enter the name of the export file (Default ConfigurationData.xml): E:\EVCACustomer.xml

2.5. Do not create a log file (not needed for an Export):

Do you want to create a log file? (Default Y)
Enter 'Y' for Yes or 'N' for No:N

2.6. Connect to the Accelerator server:

Do you want to connect to the Accelerator server? (Default Y)
Enter 'Y' for Yes or 'N' for No:Y

2.7. Do not log processes to the Customer database:

Do you want to log the processes to the Accelerator Database? (Default N)
Enter 'Y' for Yes or 'N' for No:N

2.8. Review the selected parameters and export the XML:

"Export will start with the following parameters:

Export File: E:\EVCACustomer.xml
Log File:
Overwrite Files: False
Use Service: True
Log to DB: False
Leave DB Log: False
Show Only Errors: False
Customer ID: 1"

Do you want to run the tool with these parameters? (Default Y)
Enter 'Y' for Yes or 'N' for No:Y

2.9. A successful export should look like this (note the time differences are due to GMT offsets):

ImportExport: Loading DTrace
ImportExport: Diagnostics assembly is KVS.EnterpriseVault.Runtime, Version=15.1.0.0, Culture=neutral, PublicKeyToken=26c5e2ccf2b9267c
10/11/2024 1:01:43 PM Starting ...
Exporting configuration data...
Writing XML file...
Creating Log File...
10/11/2024 5:01:43 PM Info

10/11/2024 1:01:44 PM Export Finished successfully in 0 hours 0 minutes 1 seconds
Writing Log file...
type return to exit

2.10. Press the Enter key on the keyboard to complete the ImportExport process and return to the command prompt. The Command prompt window can then be closed. If any errors are seen, review the log, correct the errors and retry the import process.

3. Use the information from the Export XML file to create a new XML file to add Hotwords to the newly created Hotword Set.
To add Hotwords to the new Hotword Set created under Application | Hotwords, see step 4.
To add Hotwords to the new Hotword Set created under Department | Hotwords, see step 5.

4. To add Hotwords to the new Hotword Set New Application Hotword Set 01 created under Application | Hotwords:

4.1. Create a new XML file with the following header lines:

4.2. Find the line with the new Application Hotword Category Set name from the Export XML, copy the line and paste below the opening lines in the new XML:

4.3. Remove the last space and forward slash from the line with the new Application Hotword Category Set line:

4.4. Add the required hotwords below the line using the following format. Use the new Application Hotword Set's CustHotWordCategoryID value for each Hotword entry. In the example lines below, the Hotwords to be added are ApplicationHotword01, ApplicationHotword02 and ApplicationHotword03. For example:

4.5. End the XML file with the following footer lines:

4.6. Example of the completed XML file:

5. To add Hotwords to the new Hotword Set New Department Hotword Set 01 created under Department | Hotwords:

5.1. Create a new XML file with the following header lines:

5.2. Find the lines in the Export XML for the Department under which the new Department Hotword Set was created. There will be multiple XML sections for each Department. Not all of them will be needed here. Copy the opening section for the Department and paste below the opening lines in the new XML - do NOT edit any information in the opening section:

5.3. Then find the line in the Export XML with the new Department Hotword Category Set name, copy the line and paste below the Department's opening section lines in the new XML:

5.4. Remove the last space and forward slash from the line with the new Department Hotword Category Set line:

5.5. Add the required hotwords below the line using the following format. Use the new Department Hotword Set's CustHotWordCategoryID value and CustID value for each Hotword entry. In the example lines below, the Hotwords to be added are DepartmentHotword01, DepartmentHotword02 and DepartmentApplicationHotword03. For example:

5.6. End the XML file with the following footer lines:

5.7. Example of the completed XML file:

6. Import the new XML file

6.1. Log on to the CA server as the Vault Service Account (VSA), start a command prompt, navigate to the CA Server installation folder in the command prompt and execute ImportExport.exe:

C:\Program Files (x86)\Enterprise Vault Business Accelerator>ImportExport.exe
Welcome to the Accelerator Export Tool

6.2. Select the option to Import:

Select Import or Export (default E):
Enter 'I' for Import or 'E' for Export:I

6.3. Select the CustomerID (use the question mark (?) to see the list of CustomerIDs):

Enter the customer ID ("?" for Customer list): ?

CustomerID      Customer Type   Customer Name
-----------------------------------------------------------------------------------------------------------------------
1               Compliance      EVCACustomer

Enter the customer ID ("?" for Customer list): 1

6.4. Enter the name of the Import XML file:

Enter the name of the import file (Default ConfigurationData.xml): E:\NewApplicationHotwordSet.xml

6.5. Create a log file (will be useful to review any errors in the XML file):

Do you want to create a log file? (Default Y)
Enter 'Y' for Yes or 'N' for No:Y

Enter the name of the Log file (default NewApplicationHotwordSet.log): E:\NewApplicationHotwordSet.log

6.6. Connect to the Accelerator server:

Do you want to connect to the Accelerator server? (Default Y)
Enter 'Y' for Yes or 'N' for No:Y

6.7. Do not log processes to the Customer database:

Do you want to log the processes to the Accelerator Database? (Default N)
Enter 'Y' for Yes or 'N' for No:N

6.8. Validate the ImportExport XML prior to import:

Validate XML before import? (Default Y)
Enter 'Y' for Yes or 'N' for No:Y

6.9. Only commit the changes if all validations are correct:

Commit only on full success? (Default N)
Enter 'Y' for Yes or 'N' for No:Y

6.10. Review the selected parameters and import the XML:

Import will starts with the following parameters:
Input File: E:\NewApplicationHotwordSet.xml
Log File: E:\NewApplicationHotwordSet.log
Overwrite Files: False
Use Service: True
Log to DB: False
Leave DB Log: False
XML Validation: True
Show Only Errors: False
Customer ID: 1
Commit only on success: True

Do you want to run the tool with these parameters? (Default Y)
Enter 'Y' for Yes or 'N' for No:Y

6.11. A successful import should look like this:

6.11.1. For Application Hotwords:

ImportExport: Loading DTrace
ImportExport: Diagnostics assembly is KVS.EnterpriseVault.Runtime, Version=15.1.0.0, Culture=neutral, PublicKeyToken=26c5e2ccf2b9267c
10/11/2024 2:08:03 PM Starting ...
Validating XML File...
Loading XML File...
Importing Configuration data...
Creating Log File...
10/11/2024 6:08:04 PM Info

10/11/2024 2:08:04 PM Import Finished successfully in 0 hours 0 minutes 0 seconds
Writing Log file...
type return to exit

6.11.1. For Department Hotwords:

ImportExport: Loading DTrace
ImportExport: Diagnostics assembly is KVS.EnterpriseVault.Runtime, Version=15.1.0.0, Culture=neutral, PublicKeyToken=26c5e2ccf2b9267c
10/11/2024 2:14:14 PM Starting ...
Validating XML File...
Loading XML File...
Importing Configuration data...
Creating Log File...
10/11/2024 6:14:15 PM Info

10/11/2024 2:14:15 PM Import Finished successfully in 0 hours 0 minutes 0 seconds
Writing Log file...
type return to exit

6.12. Press the Enter key on the keyboard to complete the ImportExport process and return to the command prompt. The Command prompt window can then be closed. If any errors are seen, review the log, correct the errors and retry the import process.
 

The log excerpts, information and/or screenshot(s) above were taken from a non-production test lab environment and are used for example purposes only.