How to customize Enterprise Vault web applications using the WebApp.ini file

Article:TECH54559  |  Created: 2010-01-25  |  Updated: 2014-09-04  |  Article URL http://www.symantec.com/docs/TECH54559
Article Type
Technical Solution


Issue



The WebApp.ini file is a way of customizing the appearance of the web parts within Enterprise Vault (EV). A full list of settings for each application is listed below. 


Solution



To customize the application do the following:
 
1. Create an ANSI file called WebApp.ini within the EV installation folder. (Eg c:\program files\enterprise vault\WebApp.ini)
 
2. Type in the settings as listed in the tables below.  ***Important: This file is CASE-SENSITIVE.***
 
3. A value of 1 turns the setting ON, A value of 0 turns the setting OFF.
 
For example:
 
To show the 'Delete from Vault' button in the Integrated Search page:
 
ISDeleteButton=1
 
To hide the 'Delete from Vault' button:
 
ISDeleteButton=0
 
4. Once the WebApp.ini has been saved, restart the IIS Admin Service. Note: Restarting IIS is not required on EV Servers running Windows Server 2008 R2 (IIS 7.5), and the change is effective immediately.
 
5. Log onto a client computer to test the new settings. If the new settings are not being picked up by the client:
 
a. Restart Internet Explorer
 
b. Delete the temporary internet files: In Internet explorer go to Tools - Internet Options - General - Delete Files - OK
 

Archive Explorer Settings
These settings alter the Archive Explorer search page.
Please note, the Archive Explorer settings are not supported in EV versions 8.0 base and 11.0.x.  The values below marked with an Exception ( * ) have been added in EV 8.0 SP1.
 

WebApp Value

Exception

Description

ArchiveExplorerHelp

*

Displays upper left Help Button

ArchiveExplorerSearch

*

Displays upper left Search Button

ArchiveExplorerSettings

*

Displays upper left Settings button

ArchiveExplorerDelete

*

Allow deletion of items

ArchiveExplorerRestore

*

Allow restoring of items

ArchiveExplorerForward

*

Allow forwarding of the items

ArchiveExplorerReply

*

Allow replying of items

ArchiveExplorerReplyAll

*

Allow replying to all of items

ArchiveExplorerSaveAs

*

Allow saving of items

UseFederatedSearch

*

Enables Federated Search functionality

FederatedSearchMaxVolSets

*

Spans the number of IndexVolumeSets to search simultaneously using Federated Search, 5 is the default

FederatedSearchMaxItems

*

Limit the global number of items that a federated search can return, default is 1000, means 10 pages

MaxVolSetsToSearch

 

Spans the number of IndexVolumeSets to search simultaneously, 5 is the default

MaxVolSetsItems

 

Limit the global number of searched items, default is 1000, means 10 pages

MaxRestoreItems

 

Set the maximum number of items to export

RestoreTOPSTOption = All

 

Restore all items to a PST file



NOTES:
 
  • ArchiveExplorerSearch and ArchiveExplorerHelp control both the top row buttons and the right-click menu options.
  • ArchiveExplorerRestore set to "0" disables both Copy and Move menu options.
  • ArchiveExplorerDelete set to "0" disables both Delete and Move options.
  • The Archive Explorer setting "View archived items using" must be set to "Microsoft Outlook" in order to display the contextual menu options Save As..., Reply, Reply to All and Forward.  Otherwise the settings will not be available.
  • When selecting more than one item, the menu options Open, Save As..., Reply, Reply to All and Forward are disabled.


Integrated Search settings
These settings alter the search page from within Microsoft Outlook.
 
WebApp Value Description
ISDeleteButton Controls whether the 'Delete from Vault' button is visible next to the search results after a search has been conducted or not
ISRestoreButton Controls whether the 'Restore Item' button is visible next to the search results after a search has been conducted or not  
ISShowProperty  Controls whether the 'Properties' button is visible next to the search results after a search has been conducted or not  
ISShowRetention Controls whether the Retention Period of the items returned by a search will be displayed alongside the results
ISShowExpiry Controls whether the "Expiry Date" of the items returned by a search will be displayed alongside the results
ISDefaultRankResults Controls the order in which the search results are displayed in. The most useful values are [-]date(date item sent); [-]size (size of item); [-]subj (subject of mail); [-]auth(author of mail); [-]locn (folder mail was archived from); [-]edat (expiry date of item)  E.g. ISDefaultRankResults =-size The [-] is an optional parameter that will display the results in descending order rather than the default which is ascending


Browser Search settings
 
WebApp Value Description
NoExchange Removes all basket and restore functionality from the search.asp, as if it were a Domino system

Note: As with all webapp.ini entries, this variable requires a value.  NoExchange=1 will remove all basket and restore functionality from Search.asp.


Setting Description Values
BSRestoreButton Controls whether Browser Search displays options that are related to restoring archived items. 0. The options that are related to restoring archived items are not displayed. / 1 (default). The options that are related to restoring archived items are displayed.
BSDeleteButton Controls whether Browser Search displays options that are related to deleting archived items. 0. The options that are related to deleting archived items are not displayed. / 1 (default). The options that are related to deleting archived items are displayed.
 



Legacy ID



292820


Article URL http://www.symantec.com/docs/TECH54559


Terms of use for this information are found in Legal Notices