How to Add and Configure a "Web Services Domsrvr"

Document ID : KB000021206
Last Modified Date : 14/02/2018
Show Technical Document Details

Question:

Having the primary domsrvr process handle all Web Services transactions may not be optimal for high transaction volume environments.

Tomcat load balancing may also be needed. This document does not cover that aspect. The backend processing of Web Services requests is independent of which Service Desk Tomcat server is used. That aspect can be done separately or together with these changes.

Answer:

How to Add and Configure a "Web Services Domsrvr"

Releases: Service Desk 12.1 through 12.7 CA SDM

webservice_domsrvr

Specifies the name of the object engine that SOAP web services use. If not installed, (SOAP only in 12.7 CA SDM) the web services use "domsrvr".

The value of the option must be a string beginning with the characters "domsrvr:"

Having the primary domsrvr process handle all Web Services transactions may not be optimal for high transaction volume environments.

Tomcat load balancing may also be needed. This document does not cover that aspect. The backend processing of Web Services requests is independent of which Service Desk Tomcat server is used. That aspect can be done separately or together with these changes.

This document describes the steps needed to add a Web Services domsrvr.

  • Identify an environment for the Web Services domsrvr.

    This system should have a processor for each domsrvr (if there are other domsrvrs running on the same host). In a Virtualized environment, the processor should be dedicated to the Virtual Machine.
  • Run the pdm_edit script to add the additional domsrvr

    Open the command prompt on the primary server and switch to the samples\pdmconf\ folder:

    nxcd samples\pdmconf

    as shown in Figure 1:

    Figure 1.

    Figure 1
  • Run the command: pdm_perl pdm_edit.pl

    Select "Y" if the primary server is on a Windows platform as shown in Figure 2.

    Figure 2.

    Figure 2
  • Select "Y" to the next prompt also (as shown in Figure 3):  

    Figure 3.

    Figure 3
  • Select number 1 for "Edit Object Servers" (as shown in Figure 4):

    Figure 4.

    Figure 4
  • Select "A" for Add (as shown in Figure 5):

    Figure 5.

    Figure 5
  • Enter the server name of the secondary server (if adding the domsrvr to the primary, hit Enter). The hostname MUST match the case used in the Service Desk Configuration Wizard (pdm_configure) (as shown in Figure 6).

    Figure 6.

    Figure 6
  • Select "None" for Group (as shown in Figure 7):

    Figure 7.

    Figure 7
  • Do not Enter a value for the "Accept Mask", hit Enter (as shown in Figure 8):

    Figure 8.

    Figure 8
  • Do not enter a value for Display, hit Enter (as shown in Figure 9):

    Figure 9.

    Figure 9
  • The next screen should resemble the following, hit Enter (as shown in Figure 10):

    Figure 10.

    Figure 10
  • On the following screen Enter "X" for Save and Quit (as shown in Figure 11):

    Figure 11.

    Figure 11
  • You will be prompted with a screen like the following.

    If you have additional webengines and domsrvrs, this is the only step you need to follow (Figure 12):

    We have created a pdm_startup.rmt file in this directory.
    First, rename your existing $NX_ROOT/pdmconf/pdm_startup.tpl
    file to pdm_startup.tpl.orig. Then copy this pdm_startup.rmt
    file to the $NX_ROOT/pdmconf directory and rename it to
    pdm_startup.tpl. Change the permissions on this file so
    that it can be read by the Privileged user. Then run configuration.

    Copy the file, but do not run pdm_configure yet.

    Figure 12.

    Figure 12
  • Open NX_ROOT\samples\pdmconf\pdm_startup.rmt file in a text editor and you should see a new line for the domsrvr you added, (see below):

    DOMSRVR (_domsrvr_secondaryhostname1,"secondaryhostname",domsrvr:11,spelsrvr:secondaryhostname:1,"","")
    after bpvirtdb_srvr connects + 3 after _ddictbuild_secondaryhostname finishesafter _ver_ctl_secondaryhostname finishesafter _msgcat_build_secondaryhostname finishesafter ldap_virtdb connects + 3

    We want to pull the domsrvr slump name from this, in this case: "domsrvr:11".
  • Launch the Service Desk web interface and Go To "Administration" > "Options Manager" > "Web Service". Look for the "Web Services Domsrvr" option (Figure 13).

    Figure 13.

    Figure 13

    We want to set the value to the slump name of the domsrvr found in the pdm_startup.rmt file.
    Perform the change and "Install" the option".
  • Stop the Service Desk Services in the following order:

    • Stop the Service Desk Services on the primary server.
    • Stop the Service Desk Services on the secondary servers.
    • Run pdm_configure on all secondary servers.
    • Run pdm_configure on the primary server.
    • Start Service Desk Services on the secondary servers (if not already started).
    • Start Service Desk Services on the primary server (if not already started).
    With the Web Services domsrvr option installed and configured, all backend processing of Web Services requests will be handled by the new domsrvr.

    However, you may point your Web Services clients, integrations or IT PAM to the Tomcat of your choice.