NX NX 11 Help / Documentation – When, where and how UGII_UGDOC_BASE is to be defined

Objective:
The NX environment variable UGII_UGDOC_BASE defines where the NX client will find its Help / Documentation. The following configuration "Scenarios" will illustrate when, where, and how UGII_UGDOC_BASE is to be defined. 

Solution

Scenario 1 – NX 11.0 Help / Documentation is ready to work immediately:
After installing NX 11.0, NX 11 is already set up to point to the Siemens PLM online Help / Documentation. As long as the NX 11 client has network connectivity to the outside world, additional install and configuration of the NX Help / Documentation (if the user chooses so) will not be necessary.


UGII_UGDOC_BASE, by default, is defined in its ugii_env_ug.dat file to point toward the
Siemens PLM online Help / Documentation:
Example: C:\Program Files\Siemens\NX 11.0\UGII\ugii_env_ug.dat
To confirm further, after opening NX 11.0, go to File -> Help -> Log File. 

TEST: 
Note: Not to be confused, https://docs.plm.automation.siemens.com in and of itself is not a sufficient URL.


However, to test the NX 11 client machine's connectivity to Siemens PLM online Help for NX 11.0 specifically, enter the following URL (or click on this link below) using the default browser of the NX 11 client machine:


https://docs.plm.automation.siemens.com/tdoc/nx/11/nx_help/

Now launch the NX 11.0 Help – File -> Help -> NX Help:




Conclusion - Scenario 1: NX 11.0 Help / Documentation is ready to work immediately:
When?              UGII_UGDOC_BASE is already defined. No extra configuration is required.
Where?             UGII_UGDOC_BASE default defined inside the ugii_env_ug.dat file.
How?                UGII_UGDOC_BASE=https://docs.plm.automation.siemens.com

Scenario 2 - SPLM Documentation Server / NX 11.0 Help configured on company site:
IF the company has configured a centralized internal SPLM Help / Documentation server on site, an NX 11 client within that site may choose to point to that SPLM Help / Documentation server as follows. 


UGII_UGDOC_BASE must therefore be proactively defined inside the NX 11 client's ugii_env.dat file:


Example:
The hostname or computer name of the company's SPLM Documentation server is splmdocserverhost
The port is 8282 (the default port from an SPLM Documentation server for NX 11)


TEST:
Open the NX 11 client machine's default browser and type in the following URL:
Be sure to include the slash on the very end of the URL address (../nx_help/, NOT …/nx_help )


http://splmdocserverhost:8282/tdoc/nx/11/nx_help/


NOTE: Be sure to confirm the port.  If the SPLM Documentation server was setup back in NX 10.0, and has now been upgraded to accommodate NX 11.0, it is very possible the port used at that time (default of 8181), remains the same port for what is now an upgraded SPLM Documentation server. 

Once the SPLM Documentation server hostname and port have been confirmed, proceed to define UGII_UGDOC_BASE inside the ugii_env.dat file on the NX 11 client machine. 


Close NX 11.0 before proceeding.
C:\Program Files\Siemens\NX 11.0\UGII\ugii_env.dat
Open in Notepad and define UGII_UGDOC_BASE under "Override any variables here" as follows:

Launch NX 11.0 and examine UGII_UGDOC_BASE in the Log File to confirm the value matches how it was defined in the ugii_env.dat file.  Then launch the NX 11.0 Help.


Conclusion – Scenario 2 - SPLM Documentation Server / NX 11.0 Help configured on company site:
When?              UGII_UGDOC_BASE must proactively be defined on each NX 11 client machine, 
                                    pointing to their internal company SPLM Help / Documentation server.                


Where?             UGII_UGDOC_BASE to be defined inside the NX 11 client's ugii_env.dat file.
                                    Defining it in ugii_env.dat now supersedes the default value which originally 
                                     points to the Siemens PLM online Help / Documentation.


How?                UGII_UGDOC_BASE=http://splmdocserverhost:8282

 


Scenario 3 – SPLM Documentation Server / NX 11 Documentation on the local client machine:
After an NX 11 client machine has had BOTH the SPLM Documentation Server AND the NX 11.0
Documentation installed on its local machine:


TEST:
Inside the default browser on the NX 11 client machine, test this URL:
Assuming the default port of 8282 was chosen from the NX 11.0 SPLM Documentation Server configuration:


http://localhost:8282/tdoc/nx/11/nx_help/


Launch NX 11.0 and examine UGII_UGDOC_BASE in the Log File:


Then Launch the NX 11.0 Help:


About UGII_UGDOC_BASE for a local NX 11.0 Documentation installation:
A local installation of the NX Documentation software now places UGII_UGDOC_BASE in 2 locations inside the registry of the NX 11 client machine:


HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Control\Session Manager\Environment\

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\Environment\

VERY IMPORTANT:


From this point on, the presence of these 2 UGII_UGDOC_BASE entries in the NX 11 client machine's registry will supersede BOTH the default value of UGII_UGDOC_BASE defined inside the ugii_env_ug.dat file (which points to the Siemens PLM online Help / Documentation) AND any entries of UGII_UGDOC_BASE inside the local NX 11 client's ugii_env.dat file. 

Later on, if the user decides to redirect where UGII_UGDOC_BASE points to, this adjustment must now be performed in these 2 registry locations. After making such adjustments to UGII_UGDOC_BASE in the 2 registry key areas, a RESTART of the NX 11 client machine will be necessary to have those adjustments go into effect.


Conclusion - Scenario 3 – SPLM Documentation Server / NX 11 Documentation on the local client machine:
When?              UGII_UGDOC_BASE - Local installation of the NX 11 Documentation software on the 
                                            NX 11 client machine introduces 2 registry entries.


Where?            UGII_UGDOC_BASE – 2 locations in the registry:


            HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Control\Session Manager\Environment\
            HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\Environment\


How?                UGII_UGDOC_BASE=http://localhost:8282


 

Hardware/Software Configuration

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

Ref: 002-8002335