NX Adding a collection to an existing UGDoc installation

NX System Administration



How do you add a collection of Help documenation to an existing UGDoc installation? 


Each Siemens product delivers its own documentation content installation package. These installations share the same "content.root" directory as defined in the 'plm_helpserver.properties' file, so they must be installed to the same directory. They also share the same Solr core directory for documentation 

Each new collection installs new Solr indexes as "<content>.zip". These content installs will automatically upload their Solr search indices as part of the installation. 

If it becomes necessary to manually upload the Solr search indices to your server, this can be done using the script 


located in: 

C:\Program Files\Siemens\PLM Documentation Server\solr_updates 

The script calls the Java program 'xpsSolr.jar', which is also in the 'solr_updates' directory. This must be run on the system where the Siemens PLM Solr Server is running. 

The script 'deploySolrIndex.bat' takes two mandatory arguments: 

1. The .zip file to upload, for example: nx11-nx_help-en_US.zip 
2. The URL for the Siemens PLM Solr Server, for example: 


You must run the script in the directory that contains the xpsSolr.jar and the solr .zip files. For example: 

C:\Program Files\Siemens\PLM Documentation Server\solr_updates 

To upload the Solr search indexes for the NX 11 English documentation to a local server on port 8283 the commands would be: 

    cd C:\Program Files\Siemens\PLM Documentation Server\solr_updates 
    deploySolrIndex nx11-release_notes-en_US.zip http://localhost:8283/solr 

    deploySolrIndex nx11-nx_help-en_US.zip http://localhost:8283/solr 

To test your installation, go to the Siemens Documentation on your web server and try a search. 

Notes and References

Hardware/Software Configuration

Platform: INTL64
OS: window
OS Version: 764SP1
Product: NX
Application: UGDOC
Version: V11.0
Function: INSTALL

Ref: 001-9089907

KB Article ID# PL8003598



Associated Components