Administration guide > Configure the deployment environment > Configuring catalog and container servers > Configuring WebSphere eXtreme Scale with WAS > Configuring the catalog service in WAS > Create catalog service domains in WAS

Catalog service domain settings

Use this page to manage the settings for a specific catalog service domain. Catalog service domains define a group of catalog servers that manage the placement of shards and monitors the health of container servers in the data grid. You can define a catalog service domain that is in the same cell as the deployment manager. You can also define remote catalog service domains if the WebSphere eXtreme Scale configuration is in a different cell or the data grid is made up of Java™ SE processes.

To view this administrative console page, click System administration > WebSphere eXtreme Scale > Catalog service domains > catalog_service_domain_name.

Parent topic:

Create catalog service domains in WAS

Test connection

When you click the Test connection button, all of the defined catalog service domain end points are queried one by one, if any one end point is available, returns a message that indicates that the connection to the catalog service domain was successful. Use this button to test that you have configured the connection and security information correctly.


Specifies the name of the catalog service domain.

Enable this catalog service domain as the default unless another catalog service domain is explicitly specified

If you select this check box, the selected catalog service domain becomes the default catalog service domain for the cell. Each server profile in the cell that is augmented with the WebSphere eXtreme Scale profile belongs to the selected catalog service domain.

For WebSphere eXtreme Scale, all eXtreme Scale containers that are embedded in Java EE application modules connect to the default domain. Clients can connect to the default domain using the ServerFactory.getServerProperties().getCatalogServiceBootstrap() API to retrieve the catalog service endpoints to use when calling the ObjectGridManager.connect() API.

If you change the default domain to point to a different set of catalog servers, then all containers and clients refer to the new domain after they are restarted.

Catalog servers

Specifies a list of catalog servers that belong to this catalog service domain.

Click New to add a catalog server to the list. This catalog server must already exist in the eXtreme Scale configuration. You can also edit or delete a server from the list by selecting the endpoint and then clicking Edit or Delete.  Define the following properties for each catalog server endpoint:

Catalog server endpoint

Name of the existing application server or remote server on which the catalog service is running. A catalog service domain cannot contain a mix of existing application servers and remote server endpoints.

  • Existing application server: Specifies the path of an application server, node agent, or deployment manager in the cell. A catalog service starts automatically in the selected server. Select from the list of the existing application servers. All of the application servers that you define within the catalog service domain must be in the same core group.

  • Remote server: Specifies the host name of the remote catalog server.

    For WebSphere eXtreme Scale remote endpoints: Specifies the host name of the remote catalog server process. You must start the remote servers with the startOgServer script or the embedded server API.

Client Port

Specifies the port that is used for communication between the catalog servers in the catalog service domain. This value is required for catalog servers that are running in WAS processes only can be set to any port that is not being used elsewhere.

Listener Port

Specifies the port that is used for communication with clients. This value is required for remote endpoints and must match the value used when the catalog service was started. The listener port is used by clients and containers to communicate with the catalog service.

For WebSphere eXtreme Scale remote endpoints: Defines the Object Request Broker (ORB) listener port for containers and clients to communicate with the catalog service through the ORB. For WAS endpoints, the listener port value is inherited from the BOOTSTRAP_ADDRESS port configuration.


Table 1. Catalog server endpoint status
Icon Definition