Creating deployment environment definitions using the command line

You can create a deployment environment definition using the wsadmin command. Running createDeploymentEnvDef provides the definition of the deployment environment.

Before you begin

You must be on the deployment manager to create the deployment environment definition.

Required security role for this task: When security and role-based authorization are enabled, you must use a userid and password with administrator or operator authority to perform this task.

IBM® Business Process Manager supports a set of patterns, Remote messaging and remote support being the pattern to use for a network deployment production environment. If your deployment manager supports other products in addition to IBM Business Process Manager, you might want to use patterns for those products when creating a deployment environment definition. For information about patterns for other products, see the documentation for those products.

About this task

This task creates a deployment environment definition that is based on a specific pattern and uses the wsadmin command.

You can use the wsadmin command to create the same deployment environment as you can create from the administrative console. This capability allows you to run the administrative task to create a deployment environment definition with all the default values based on an existing configuration (the configuration that you created at profile creation time). The command also includes an optional property that imports a database design document. The database design document holds the database configuration for the topology you are creating.

When you generate the deployment environment, the information about whether to create tables is taken from the design document. Make sure that the createTables parameter is correctly set in the database design file that you specify.

Important: If you use the createTables parameter, the databases must already exist. Do not use createTables for a production environment where you want to customize the generated database scripts. Do not use createTables if you have a remote database server.

For DB2 and SQL Server databases, IBM Process Server and IBM Performance Data Warehouse should not use the same database as the rest of the components. However, if you are using an Oracle database, the IBM Process Server and IBM Performance Data Warehouse can use the same database instance, but should use different users.

For Oracle databases, make sure that the user name and schema name are exactly the same. The user must exist in the database before you generate the environment.

For SQL Server databases, make sure that the user name and schema exist before the configuration is done. The schema value must be the default schema for the user chosen.

For a production environment, set the same values for user name and schema name and do not select createTables. Create the required schemas manually and use the generated SQL files to create the tables.

A deployment environment definition describes the specific component, configuration (of clusters, nodes, and servers), resources and related configuration parameters that make up a deployment environment. This definition can also be referred to as an instance of a deployment environment configuration. A deployment environment configuration can be exported into a deployment environment definition. You can import a deployment environment definition to add a new deployment environment configuration to your system.

Procedure

Open a command window. The wsadmin command can be found in either of the following directories:
```
install_root/profiles/dmgr profile/bin
install_root/bin
```
At the command prompt, enter the wsadmin command to enter the wsadmin environment.
Use the createDeploymentEnvDef command to create the deployment environment definition with a specific name for a particular runtime and pattern.
Note: If administrative security is on, and you did not supply a user ID and password in the command, you are prompted for a user ID and password.

Example

This example creates a deployment environment definition for a remote messaging and remote support pattern on the IBM Business Process Manager runtime, with myDepEnv on the host myDmgr with administrative security enabled. The example imports a database design document named nd.topology.dbDesign:

Note: The value you assign to -topologyRuntime varies depending on the IBM BPM configuration (Advanced or Standard) and the environment selection. For example:

For IBM BPM Standard, -topologyRuntime can be:
- BPMSPS, for IBM BPM Standard Process Server
- BPMSPC, for IBM BPM Standard Process Center
For IBM BPM Advanced, -topologyRuntime can be:
- BPMAPS, for IBM BPM Advanced Process Server
- BPMAPC, for IBM BPM Advanced Process Center

wsadmin -connType SOAP -host myDmgr -port 8879
> $AdminTask createDeploymentEnvDef { -topologyName topOne 
-topologyPattern RemoteMessagingAndSupport
-topologyRuntime BPMSPS -dbDesign C:\dbDesigns\z.nd.topology.dbDesign}
> $AdminConfig save

Note: If you disable administrative security, you do not need to provide a user ID and password.

What to do next

After you have imported or created a deployment environment on a deployment manager, you can configure the deployment environment using the generateDeploymentEnv command.

Important: If you use additional servers with unique ports, WebSphere® Application Server does not automatically configure the virtual host for the server. Specifically, WebSphere Application Server does not automatically add the host alias ports to a virtual host. However, you can use the administrative console to add a new host alias for each of the ports that are used by the new server. For more information, see the WebSphere Application Server documentation about configuring virtual hosts.