Creating the deployment environment using a pattern

You can use the deployment environment configuration wizard to create the cluster or clusters and configure all the required components for the IBM® Business Monitor network deployment (ND) topology.

To configure the deployment environment, complete the following steps:

1. In the administrative console, click Servers > Deployment Environments.
2. To launch the deployment environment configuration wizard, click New on the Deployment Environments page.
   1. The Create a deployment environment based on a pattern option is selected.
   2. Enter a unique name for the deployment environment in the Deployment environment name field.
   3. If you want to view all of the configuration steps in the wizard, select Detailed: Show all steps. If you choose Fast path: Show only needed steps, the wizard displays only those pages that do not have assigned default values. Choose Fast path: Show only needed steps only if you are agreeable to accepting the system-provided default values for the deployment environment configuration. This topic assumes that you have chosen Detailed: Show all steps.
   4. Click Next to display the Deployment Environment Features page.
3. On the Deployment Environment Features page, select the feature for the deployment environment and click Next to either view a list of compatible features, or to view a list of deployment environment patterns. Features represent the runtime processing capabilities of your deployment environment. The list of available features on the Deployment Environment Features page is based on the deployment manager profile. If your deployment manager profile has been augmented to include other products as well as IBM Business Monitor (for example, IBM Business Process Manager) the Deployment Environment Features page lists these features as well. The default value for the deployment environment feature matches the runtime capabilities of your deployment manager.
4. On the Select compatible deployment environment features page, select additional features as necessary and click Next to view the list of patterns associated with your feature selections. Only one deployment environment configuration can exist with the WBM feature. If a deployment environment configuration with the WBM feature already exists, you will not be able to continue, even if the deployment environment configuration has not been generated.
5. On the Select the deployment environment pattern page, select the pattern and click Next to display the Select Nodes page.
   The list of patterns that display on the Deployment Environment Patterns page is dynamic. This list is activated by, and dependent on, the following environment conditions and configuration decisions:

   • The platform on which you have installed the software
   • The selections that you have made on the Select the deployment environment feature page and the Select compatible deployment environment features page.

   Typically you will have a choice between the Single Cluster pattern and the Remote Messaging, Remote Support, and Web (four-cluster) pattern. For descriptions of these patterns, see the "High availability (network deployment) topology" page in the planning section.

6. On the Select Nodes page, select the nodes that you want to include in this deployment environment, then click Next to display the Cluster members page.

   Select one or more IBM Business Monitor nodes for the deployment environment. You can identify the IBM Business Monitor nodes by an entry for WBM in the version column of the list. If a node does not have an entry for WBM in the version column and you want to enable it for IBM Business Monitor, augment the node's profile with IBM Business Monitor and restart the deployment environment configuration wizard.

   All selected nodes must be IBM Business Monitor nodes. If you selected additional features in step 3, select nodes that also support the additional features.

   For high-availability and failover environments, select at least two nodes on at least two separate hosts. For additional scalability, select more than two nodes.

   To include a node, select the check box next to the node name.

7. On the Clusters page, assign at least one cluster member on at least one node for each function of the deployment environment.

   By default one cluster member is assigned on each node for each function. You change the number by replacing the number in each column. For network deployment, clusters can collaborate to provide specific functionality to the environment. Depending on your requirements, you assign specific functions to each cluster within the deployment environment, to provide performance, failover, and capacity.

   A 0 (zero) value for a node means that the node does not contribute to the selected function, based on features that you have selected.

   There must be at least one cluster member assigned for each function. For high-availability and failover environments, indicate at least two cluster members per function. For additional scalability, indicate more cluster members for a function.

   You can specify the initial port using the Specify the port number for the first cluster group (Optional): text box. Port numbers are reserved and assigned to each node for the cluster members using the port number that is specified. If you specify an initial port when you create the deployment environment, that same initial port specified would be assigned to the first cluster member and subsequent cluster groups would be assigned ports after increasing the port value by 20. For example, if the port number for the first cluster group is 2000, the port numbers of the cluster members would be 2000, 2001, 2002, and so on. The port number of the second cluster group would be 2020 and the port numbers for the members of the second cluster group would be 2020, 2021, 2022, and so on. The port number of the third cluster group would be 2040.

   Note: If there is already a node on that physical system then there may be port conflicts and these would need to be resolved manually by changing the port values.

   After assigning cluster members, you can click Next to display the Cluster naming pages for each cluster type of the deployment environment. The Cluster naming substeps that display will vary depending on the deployment environment pattern selected. If you do not want to customize cluster names or cluster member names, use the wizard navigation pane to go directly to the REST services page and continue to the next step.

   1. Optional: Customize the cluster names and cluster member names. Use the Cluster naming page to customize cluster names or cluster member names for the cluster type. You can also modify cluster short names and cluster member short names. There is one substep page for each cluster type in the pattern that you have selected. The information on each substep page is as follows:

      Field	Description	Value
      Cluster	A read-only field specifying the functional role of the cluster.	The value varies depending on the cluster type, as follows: Application Deployment Target Supporting Infrastructure Messaging Infrastructure Web Application Infrastructure For information on the functional role provided by each cluster type, see "Topologies and deployment environment patterns."
      Cluster name	The system-generated default value for the cluster name.	The default values are based on a naming convention of Deployment Environment Name.Cluster type name, where Cluster type name is one of the following values: AppTarget - For clusters performing the role of application deployment target Messaging - For clusters performing the role of messaging infrastructure Support - For clusters performing the role of supporting infrastructure Web - For clusters performing the role of supporting web applications
      Cluster short name	A short name for the cluster.	You can leave this field blank or enter a short name of your choosing. Cluster short names cannot exceed 8 characters in length, and must be unique so as to avoid naming collisions. Note: The system does not check if the short name is unique.
      Cluster member name	The system-generated default value for the cluster member name. Servers that are a part of a cluster are called cluster members.	Accept the system-generated default value or specify a name of your choosing. The default value for the cluster member name is based on the following naming convention: cluster name.node name.node number sequence. The number of cluster member names that display in the table match the number of cluster members that you entered for the cluster type column and node row on the Clusters page.
      Cluster member short name	The system-generated default value for the cluster member short name. The option for cluster member short name displays when the following configuration conditions exist: If any one known node in the cell is on a z/OS platform. The node metadata should support the platform on which the node resides. If the deployment manager resides on a z/OS platform.	Accept the system-generated default value or specify a name of your choosing. The system-generated value for cluster member short name is based on the following naming convention: deployment environment name[0:5]cluster type name. The cluster member short name is limited to 7 characters and MUST BE UNIQUE. If the cluster member short name is not unique, the system appends a unique number to it. As an example, for a deployment environment named DEVENV, the system-generated short name for the application target cluster member is DEVENVAT.

8. On the System REST Service endpoints page, configure service endpoints for Representational State Transfer (REST) application programming interfaces (APIs).

   If you want widgets to be available in Business Space, you must configure the REST service endpoints for those widgets. For the host name and port, if you want REST requests to go directly to the application server, enter the application server host name and port. If you want REST requests to go to a proxy server or HTTP server that sits in front of one or more application servers, enter the host name and port of the proxy server or HTTP server. In the second case, you must have already set up a proxy server or an HTTP server. Otherwise, skip this page and configure the endpoints later.

   1. Configure a full URL path for all REST services by selecting either https:// or http:// from the Protocol list.
   2. Enter the name of the proxy server or HTTP server in the Host Name or Virtual Host in a Load-Balanced Environment field.

      Enter the host or virtual host name and port number that a client needs to communicate with the server or cluster. In a clustered environment, this is typically the load balancer host name and port. If you leave the host and port fields empty, the values default to the values of an individual cluster member host and its HTTP port. For a load-balanced environment, you must later change the default values to the virtual host name and port of your load balancer. Make sure to designate a fully qualified host name.

   3. In the Port field, enter the port that a client needs to communicate with the server or cluster.
   4. In the table of REST services, if you want to modify the description of the REST service endpoint, overtype the entry in the Description field. The other fields are read-only.
   5. Click Next to go to the Import the database configuration page.
9. Optional: On the Import the database configuration page, click Browse to go to the database design document or enter the path to the database design document and then click Next to go to the Data sources page. If you import a design document, the information from the design document is reflected on the Database page of the wizard. The design document can be based on a database design that you created using the database design tool, or it can be the supplied design document based on the pattern and feature that you have selected.
10. On the Database page, configure the database parameters for data sources of the deployment environment, then click Next to go to the Security page.

    On this page, define the database information for the components that are included in this deployment environment. Where possible, the wizard supplies default information for the parameters, but change those values to match the values that you defined when you planned the environment. If you change providers, you can click the Edit Provider button to edit the provider that you selected.

    Note: If you imported a database design document, the information on the Database page reflects the data source configuration as it exists in the database design document that you imported. If you make changes to the data source configuration after importing a database design document, your changes might be incompatible with the DDL generated by the database design tool and the original values.

    Whether or not this step displays for a fast path deployment environment configuration is conditional. This step displays for a fast path deployment environment configuration if more than one database has been defined.

    This step always displays if you are using a DB2® for z/OS® or an Oracle database provider.

    The IBM Business Monitor feature provides the following entries:

    Component	Data source
    Business Monitor messaging engine data source	Data source for the IBM Business Monitor messaging engine.
    Cognos Content Store	Data source for the IBM Cognos® Business Intelligence content store. (Displayed only if IBM Cognos BI has been installed and not yet configured.) The Content Store data source is created in the IBM Cognos BI configuration and not as a WebSphere data source. Leave the Create tables option checked; otherwise this data source is marked as a deferred configuration. IBM Cognos BI creates the tables on first startup. A WebSphere authentication alias (Cognos_JDBC_Alias) is created based on the user name and password provided for this data source. This authentication alias is not used directly by IBM Cognos BI but it enables all database user names and passwords to be maintained using the same process. On server startup, IBM Business Monitor sends the current user name and password values to the IBM Cognos BI configuration. For DB2 on z/OS, you must install the COGNOSCS database manually.
    Business Space	Data source for the Business Space component. If you select the Create tables option, the schema name used by Business Space must already exist in the database. Important: For Oracle only, you must run app_server_root/dbscripts/BusinessSpace/Oracle/createSchema_BusinessSpace.sql to create the schema user and grant the required rights.

    If you selected other product features for this topology, other feature-specific entries might also appear here.
    The default schema names that are displayed on this page might conflict with your site naming convention or might conflict with existing schemas. As such, it is likely that you will need to change the schema name.

    Note: For DB2 for z/OS databases, the schema name that is configured on the panel will be used for the DB2 z/OS SQLID value. If the DB2 z/OS SQLID value needs to be different in your environment, then after the deployment environment wizard is finished, you can manually update the data sources that have been created and change the currentSQLID Custom Property to the correct value.
    You can edit all key parameters, such as the database name, whether or not to create tables, the data source runtime user name, and the user name and password for the data source to connect to the database.

    Note: For DB2 for z/OS databases, the database name is the database subsystem name. For other versions of DB2, the database name is the MONITOR database name. For Oracle databases, the database name is the Oracle System ID.

    You can select which database to use for the given component.

    The Create tables option is not available if you are using a DB2 for z/OS or an Oracle database provider.

    For Oracle, the Schema field is disabled and empty, and the User name is not pre-filled with the common database user name. You must enter a user name and password for each data source.

    Note: No validation takes place to ensure that user names are unique, so be aware that you might create a duplicate user name, resulting in table conflicts.
11. On the Security page, enter the user IDs and passwords that are needed to configure the IBM Business Monitor components. The IBM Business Monitor feature provides the following entries:

    Component	ID and Password
    Authentication alias for the CEI event service JMS resources	Specify the user ID and password to use to secure the default common event infrastructure (CEI) service integration bus.
    Cognos Administration access authentication	Specify a user ID and password with administrative rights to the IBM Cognos BI service. (Displayed only if IBM Cognos BI has been installed and not yet configured.)

    If you selected other product features for this topology, other feature-specific entries might also appear here.
12. Optional: If the Business Process Choreographer page is displayed, set parameters for the Business Process Choreographer configuration and then click Next to display the Web application context roots page. On this page you specify the values for:
    • Security roles
    • Authentication aliases
13. Optional: If the Web application context roots page is displayed, set the context root for component-based web applications in your deployment environment or accept the system-provided default values for the context roots. Then click Next to display the Summary page.
    The table contains the following control information.

    Web Application

    The name of the web application.

    Some of the components that are part of the deployment environment you are creating contain web applications. The Web application column can include the following components:

    • Business Process Choreographer Explorer
    • Business Space
    • Business Process Rules Manager

    Context Root

    The current value of the context root for the component.

    By default, the default context root for the web application applies. You can change the context roots by typing over the value in the Context Root field.

    Note: The Business Space context root is read only and cannot be edited.

    Description

    The description of the web application context root.

14. Verify that the information on the Summary page is correct and click Finish and Generate Environment to save and complete the configuration of the deployment environment. To exit without completing the configuration, click Finish.

    Clicking Finish saves the deployment environment configuration - but does not generate it.

    Click Cancel cancels the deployment configuration and does not save the configuration.

15. If you clicked Finish and Generate Environment to generate a deployment environment, stop and restart all clusters, nodes, and the deployment manager.

What to do next

After generating the deployment environment, change the cluster and server short names to meet z/OS system naming conventions.

The cluster short name is limited to 8 characters and must be unique. To change the cluster short name for z/OS, perform the following steps:

1. From the administrative console, navigate to Servers > Clusters > WebSphere application server clusters.
2. Click the name of the cluster that you want to change.
3. Type the new cluster short name in the Short Name area. For example, change the existing short name from BBOC001 (which is typically the default value) to WCLxx where xx is the prefix of the cell, for example WCLT5.

The server short name should be limited to seven characters to allow an S or an A to be added to designate servant regions or adjuncts. To change the server short name for z/OS, perform the following steps:

1. From the administrative console, navigate to Servers > Server Types > WebSphere application servers.
2. Click the name of the server that you want to change.
3. Type the new server short name in the Short Name area. For example, change the existing short name from BBOS001 to WZxxZ1 where xx is the prefix of the cell, for example WZT5Z1.

For more information on cluster and server naming conventions for z/OS, see the WebSphere® Application Server information center.