Adding and removing components from the Notes® install kit using UpdateSiteMgr

If you are installing Notes® clients on Windows, the UpdateSiteMgr tool allows you to customize the Notes® install kit by listing components available for removal, removing components, and adding components.

Before you begin

Before adding new features to the install kit, see related topics on adding features to and customizing the kit. For example, before using the tool, you must perform the following tasks:
  • Create and sign any new Eclipse features that you want to add to the Notes® install kit.
    Note: Attempting to install or upgrade unsigned components will cause the Notes® install executable to fail. See the related topics for instructions on signing features and plug-ins.
  • Place the new features and plug-ins .jar files in the features and plugins update site subdirectories (updateSite.zip\features and updateSite.zip\plugins).
  • Create and validate the new site.xml manifest file (updateSite.zip\site.xml).
  • Create and validate the new install.xml install manifest in the deploy directory (deploy\install.xml).

About this task

The UpdateSiteMgr tool is supplied as UpdateSiteMgr.exe in the kit customization zip file in the deploy\Utility folder. This tool is used in command line mode only.
Note: For Windows, this tool supersedes the trimUpdateSite and addToKit tools used in earlier releases of Domino®. If using Linux, see the related topic on customizing Notes® install on that platform. If installing on Macintosh, see the related topics on the addToKit tools.

Procedure

  • To display the usage information and command line parameter help, open a command prompt window and type UpdateSiteMgr.exe or UpdateSiteMgr.exe -h.

    An example of the information you see is as follows:

    Usage 1: UpdateSiteMgr.exe -[dhnVrL] kitpath
    Merges info from kitpath into the kit that is in the same folder as this executable.
    kitpath defaults to "." (current directory)
    -d Turn Debug On
    -h Print usage
    -n Do a dryrun
    -V Print version info
    Usage 2: UpdateSiteMgr.exe [-rL] componentId
    Remove info from kit that is in the same folder as this executable.
    -r Remove specified component from kit
    -L List all components that can be trimmed (removed) from kit
  • To list components currently resident in and available for removal from the Notes® install kit, type UpdateSiteMgr.exe -L
    For example, for a supplied Notes® install kit, that list would be as follows:
    • Activities (Connections)
    • Sametime®
    • CAE (Composite Applications Editor)
    • Feedreader
    • OpenSocial component
    Note: If you remove or add components to the Notes® install kit, and then run this command again, the UpdateSiteMgr.exe - L command output will change to reflect the current state of the Notes® install kit.
  • To remove a single component from the Notes® install kit, use UpdateSiteMgr.exe -r and specify the component's designation.
    For example, to remove Feedreader, use the following command line statement:
    UpdateSiteMgr.exe -r feedreader
  • To remove multiple components from the Notes® install kit, use UpdateSiteMgr.exe -r and specify each component separated by space characters.
    For example, to remove Feedreader and the Composite Applications Editor from the Notes® install kit use the following command line statement:
    UpdateSiteMgr.exe -r feedreader CAE
  • To add a non-supplied or third-party signed component (feature or plug-in) to the Notes® install kit, use UpdateSiteMgr.exe and specify the new updateSite in which that component resides, and that you want to merge into the Notes® install kit's updateSite.zip file.
    For example, to add the signed contents of a custom updateSite use the following command line statement, where kitpath is the path to the custom updateSite.
    UpdateSiteMgr.exe kitpath