Skip to Main Content
Return to Navigation

Configuring Verity Search Options

This section contains an overview and discusses how to:

Understanding PeopleSoft Search Configurations

PeopleSoft offers these configuration options for enabling PeopleSoft search:

  • Type-1: Verity running within the application server domain.

  • Type-2: Verity running within a separate process managed by the application server.

  • Type-3: Verity running within a separate search server.

Note: In some cases, the operating system determines which search configuration options can be used. Always refer to thePeopleSoft Hardware and Software Requirements guide, the Certifications area on Metalink, or customer support for the most recent support information.

Type-1: Verity Running within the Application Server Domain

Image: Type 1 search configuration: VDK bound to PSAPPSRV processes the request with the PSVERITY library

In this configuration, Verity runs within the application server. Its libraries are linked to the application server. For example, as shown in the following diagram, the Verity VDK is bound to the PSAPPSRV server process. When a search request is submitted, the VDK bound to PSAPPSRV processes the request with the PSVERITY library.

Type 1 search configuration: VDK bound to PSAPPSRV processes the request with the PSVERITY library

Note: This configuration has been used in PeopleSoft applications in all previous releases of the PeopleSoft Internet Architecture.

Type-2: Verity Running as a Separate Process Managed by the Application Server Domain

Having Verity run as a separately managed process enables application server domains running within the 64-bit framework to interoperate with Verity running within the 32-bit framework.

Image: Type 2 search configuration: The spawned process hosts the VDK processing on behalf of the application server domain

The following diagram illustrates that in this configuration, when the first search request is submitted, the PSAPPSRV server process spawns an auxiliary process to run within the application server domain. The spawned process hosts the VDK processing on behalf of the application server domain. A proxy search library within the application server routes search requests from the PeopleSoft Internet Architecture to the auxiliary search process.

Type 2 search configuration: The spawned process hosts the VDK processing on behalf of the application server domain

The proxy search library and the auxiliary search process transmit data using efficient system resources (anonymous pipes). Having both processes running on the same computer can reduce performance degradation introduced from the extra communication layer of the network in a Type-3 configuration.

Type-3: Verity Running within a Separate Search Server

Image: Type 3 search configuration: application server domain sends search requests to the search server on a separate physical machine

The following diagram illustrates an example that you can implement the Type-3 search configuration to centralize the configuration of the search features as well as the maintenance and storage of search indexes.

Type 3 search configuration: application server domain sends search requests to the search server on a separate physical machine

In this configuration, the application server domain routes search requests to the search domain running on a remote search server. Multiple application server domains may use the same search server to execute search requests. In this scenario, the application server domain is the "client," submitting search requests and the search domain is the "server," processing requests and returning results.

Note: Tuxedo must be installed on both the application server machine and search server machine.

Configuring Verity Search to run within the Application Server (Type-1)

This configuration requires the application server to be installed as outlined in the PeopleTools Installation guide for your platform. This installation process installs the required application server and Verity software.

In the Search section of PSADMIN, enter 1 for the Deployment Type parameter.

Values for config section - Search
    Deployment Type=1
    Application Server Port=
    Remote Search Server Credentials=

Note: If you do not assign a value to the Deployment Type parameter, the system assumes the default configuration for your operating system.

Configuring Verity Search to Run as a Separate Process (Type-2)

This configuration requires the application server to be installed as outlined in the PeopleTools Installation guide for your platform. This installation process installs the required application server and Verity software.

In the Search section of PSADMIN, enter 2 for the Deployment Type parameter.

Values for config section - Search
    Deployment Type=2
    Application Server Port=
    Remote Search Server Credentials=

Note: If you do not assign a value to the Deployment Option parameter, the system assumes the default configuration for your operating system.

Configuring a Separate Verity Search Server (Type-3)

Setting up a remote search server to process requests for application server domains requires you to complete configuration steps on the:

  • search server.

  • application server(s).

Configuring the Search Server Domain

To configure a separate search server:

  1. Ensure the environment is set up correctly.

    Configuring a search domain is comparable to creating an application server domain on an application server. You need to make sure:

    • Tuxedo is installed locally.

    • PS_HOME is available (locally or remotely)

    • PS_CFG_HOME is set correctly on the search server machine.

  2. Launch PSADMIN, and select Search Server from the PeopleSoft Server Administration menu.

  3. On the PeopleSoft Search Server Administration menu select 2) Create a domain, and enter a name for the search domain.

    --------------------------------------------
    PeopleSoft Search Server Administration
    --------------------------------------------
    
      1) Administer a domain
      2) Create a domain
      3) Delete a domain
      q) Quit
    
    Command to execute (1-3, q) : 2
    
    
    Please enter name of domain to create :SAMPLE
    
  4. Select 1) search, for a configuration template.

    Configuration templates:
    
      1) search
    
    Select config template number: 1
    
  5. When prompted to configure the search domain and change any configuration values, enter y to indicate "yes."

  6. In the [Startup] section, add the information required for the search domain to connect to the application database.

    The values entered should be identical to the connect information in any application server domain connecting to the same database.

    Note: The search domain must connect to the same database as the application servers sending requests to the search domain.

  7. In the [Database Options] section, select the same options you use for other application server domains in your environment.

  8. In the [Domain Settings] section, select the same options you use for other application server domains in your environment, including, for example, Add To Path for specifying database driver locations.

    Note: Make note of the unique Domain ID value. It is required when configuring the application server domains using the search server.

  9. Modify the options in the [PSSRCHSRV] section.

    Min Instances, Max Instances, Service Timeout

    These parameters operate the same as PSAPPSRV.

    See PSAPPSRV Options.

    Search Server Port

    Enter the port address the search domain will monitor for search requests.

    The default is 7778.

    Application Server Credentials

    Enter a list of application server domains that will be using the search domain. The application servers need to be identified by Domain ID, Server ID, and port in the following format.

    <Domain ID>|<Server ID>:<port>

    Note: Server ID can be an IP Address or a hostname.

    When multiple domains use the same search server, separate the entries by a comma (,). For example, the following illustrates how to enter two different domains running on two different servers.

    APPDOM1|appsrv_computer1:7777,APPDOM2|appsrv_computer2:7777

    Note: The Domain ID value can be found in the [Domain Settings] section of PSADMIN.

Configuring an Application Server Domain to use a remote Search Server

Once you have a remote search domain configured, you then need to modify each application server domain that will use that search server to process search requests.

To configure an application server domain to use a remote search server:

  1. Launch PSADMIN, and initiate the configuration interface for the desired application server domain.

  2. Modify the [Search] section.

    Deployment Type

    Enter 3 to indicate Type-3 configuration.

    Application Server Port

    Enter the port number on which the application server domain will "listen" for responses from the search domain. Make sure this value is the same port number you specified in the search domain in the Application Server Credentials parameter.

    Remote Search Server Credentials

    Specify the search server domain that will be used by the application server domain. The search server needs to be identified by Domain ID, Server ID, and port in the following format.

    <Domain ID>|<Server ID>:<port>
  3. When prompted to configure Domains Gateway (External Search Server) indicate y for "yes."

    Note: The Domains Gateway can also be enabled in the Quick Configure menu.

Setting Up Failover Search Domains

To provide high availability and to compensate for the possibility of issues with the network, a server machine, a search domain, or simply having to shut down a search domain for maintenance, you can configure failover search domains. In these situations, the unavailability of a primary search domain does not affect end users.

Failover search domains only process search requests when the primary search domain is unavailable. If the primary search domain is unavailable, the system seamlessly routes search requests to the next search domain specified in the failover string sequence.

For example, assume an application server domain has the following search domains specified in the search domain failover string in this order:

  • SRCH_PRIMARY

  • SRCH_FAILOVER1

  • SRCH_FAILOVER2

If SRCH_PRIMARY is unavailable, the system checks to see if SRCH_FAILOVER1 is available, and if so, begins routing search requests to SRCH_FAILOVER1. If SRCH_FAILOVER1 is not available, then the system checks the availability of SRCH_FAILOVER2, and so on. When the primary search domain becomes available again, the system begins routing search requests to that search domain.

To set up failover search domains:

  1. Install and configure the number of failover search domains you require.

    It is recommended that each failover search domain reside on a separate server machine for optimal failover coverage.

  2. For each failover search server domain, specify the complete list of application server domains that could potentially use the search domain for failover coverage.

    Use PSADMIN, or edit the PSSRCHSRV.CFG manually. Specify the application server domains using the Application Server Credentials parameter in the PSSRCHSRV section.

  3. For each application server domain using a particular set of search server domains, modify the Remote Search Server Credentials parameter in the [Search] section to include the connect information for each search domain, with the primary search domain appearing first and a comma (,) separating multiple values.

<Domain ID>|<Server ID>:<port>,<Domain ID>|<Server ID>:<port>

For example,

Remote Search Server Credentials=SRCH_PRIMARY|ts-sun04:7778,
SRCH_FAILOVER1|ts-sun05:7778,SRCH_FAILOVER2|ts-sun06:7778

Verity Search Server Administration

While the administrative tasks associated with search servers are similar to your application server or Process Scheduler administration, keep the following items in mind when managing search servers.

Working with Search Domains in PSADMIN

When administering search server domains, you use a subset of PSADMIN menu options.

--------------------------------
PeopleSoft Search Domain Administration
--------------------------------
     Domain Name: search01

  1) Boot this domain
  2) Domain shutdown menu
  3) Domain status menu
  4) Configure this domain
  5) TUXEDO command line (tmadmin)
  6) Edit configuration/log files menu
  7) Clean IPC resources of this domain
  8) Domain Gateway TUXEDO command line (dmadmin)
  q) Quit

Command to execute (1-8, q) :

Using these menus is similar to the menus for an application server domain, except that items that are not applicable do not appear. For example, there are no menu options for purging cache, preloading cache, or setting up messaging servers because they do not apply in the context of search servers.

For search servers, the following options differ slightly from application server domain options:

Boot this domain

For application server domains, you have options to boot a domain in serial or parallel mode. Because the number of server processes within a search domain are typically fewer than a large domain, the option of a parallel boot to save time is unnecessary. With search domains, you are not presented with boot options, and the domain boots in serial mode.

Domain Gateway TUXEDO command line (dmadmin)

The dmadmin is similar to the tmadmin interface. dmadmin is an interactive command interpreter used for the administration of domain gateway groups defined for a particular Tuxedo application.

Locating Logging Information in Type-3 Search Configurations

The system writes logging information to these files:

  • TUXLOG for both the application server and search server domain.

  • APPSRV_MMDD.LOG for the application server domain.

  • SRCHSRV_MMDD.LOG for the search server domain.

Monitoring Domain Gateway Connections

The domain gateway is a subcomponent of a Tuxedo domain that allows it to communicate with another domain through the network. The domain gateway ensures that the application server and search server domains are successfully connected and able to transmit data. An application server domain and search domain can start independent of one another and do not report any obvious signs of being successfully connected when they start.

When working with search domains and troubleshooting Domain Gateway issues:

  • Ensure that the domain gateway is enabled. Check the Tuxedo logs of both the application server and the search server. Both logs should indicate the gateway connection.

  • Check machine and port configuration. Failure to connect, or connections with numerous disconnections can be caused by incorrect port and machine address information or another machine using the same port. Use canonical names if you are using a non-numerical IP address.

Use the dmadmin command line interface to monitor a Domain Gateway connection between a local and remote domain. Access this interface through the PeopleSoft Search Domain Administration menu in PSADMIN. The following commands can be helpful when working with search domains.

Command

Description

pd -d <LOCAL DOMAIN ACCESSPOINT_ID>

Use the pd (print domain) command to confirm whether or not the application server and search server domains are connecting and transmitting data. Confirm successful connection by viewing the 'Connected domains' list.

The <LOCAL DOMAIN ACCESSPOINT_ID> is formed by prepending "SS" to the domain ID. For example, if the domain ID is SRCHSERV the value of <LOCAL DOMAIN ACCESSPOINT_ID> is SS_SRCHSERV.

The following is sample output:

pd -d SS_SRCHSERV
 
Local domain :SS_SRCHSERV
        Connected domains:
        Domainid: APPDOM1

If the search domain is not connected to the application server domain you will see output similar to this:

pd -d SS_SRCHSERV
 
Local domain :SS_SRCHSERV
  Connected domains:
  Disconnected domains being
 retried:
        Domainid: APPDOM1

This examples show only one application server domain and one search domain. In reality, multiple application server domains would connect to one search domain. The pd command lists the status of each of the application server domains connected to a search domain.

pstats -d  <LOCAL DOMAIN ACCESSPOINT_ID>

Use the pstats command to extract monitoring statistics from the Tuxedo MIB regarding the domain gateway connection. This can help to identify the amount of requests being processed for application server domain clients.

h

Displays and describes all dmadmin commands.

See Oracle Tuxedo documentation for complete dmadmin documentation.

Building Search Indices

For a search server (Type-3 configuration), a Process Scheduler deployed on the search machine should be used for indexing. Because Verity libraries may be available only on the search machine, and because any index would be used by the search server on the search machine, it is recommended to build the indices on the search machine to avoid having to relocate indexes from other machines. A recommended approach is to deploy a Process Scheduler server along side the search server and specify that Process Scheduler server for generating indexes (PeopleTools, Search Engine, Administration, Schedule).

Note: For building search indexes on a Type-3 configuration, it is strongly recommended to use the PSNT Process Scheduler Server running on the same server machine as the Type-3 configuration.

If Verity is not supported on the operating system where your production application server domains run, another option is deploying an application server domain along side the search server. This application server would be accessible through its own web server instance possibly on a different port than the production application server. This provides access to an application server with Verity support, allowing the creation of indices interactively. Also, the indices would be created where the search server can locate them.