Registering, Deploying, and Configuring the 3DOrchestrate Servers

Open a command-line prompt, and change the current directory to <server_install_dir>); for example:
```
C:\DassaultSystemes\R2020x\3DOrchestrate\
```

Register a 3DOrchestrate TomEE server as one member of the load balanced cluster by entering the following command on a single line:

./<os>/reffiles/SMAExeServer/deploy/smaexe-deploy.[bat|sh] -ha –eed [-v] deploy.param index=<EED-index> tag=<EED-tag> [host=<EED-hostname>] 
http=<HTTP-port> [ajp=<AJP-port>] [redirect=<redirect-port>] [shutdown=<shutdown-port>] [debug=<debug-port>] [transport=<connection-mode>] 
share=<network-share-path> EnlistEED,Save

You must use this command multiple times to locally register all 3DOrchestrate servers of the cluster. Each 3DOrchestrate server must have different index and tag values.

Option	Description
`-ha`	Enables the set of actions used for deploying and configuring a cluster of 3DOrchestrate servers.
`-eed`	Specifies the subset of actions related to the 3DOrchestrate servers.
`deploy.param`	Writes (adds) 3DOrchestrate server information to the deploy.param file. This is the same deployment parameters file used throughout the cluster configuration process.
`index=<EED-index>`	Numeric value between 1 and 99 used to keep track of information about this 3DOrchestrate server.
`tag=<EED-tag>`	Unique alphanumeric string used to identify this 3DOrchestrate server.
`[host=<EED-hostname>]`	Hostname of the 3DOrchestrate server computer. If this value is not provided, the default is the localhost.
`http=<HTTP-port>`	Port number on which the 3DOrchestrate server will listen for HTTP requests. There is no default; recommended ports start at 8080.
`[ajp=<AJP-port>]`	Port number on which the 3DOrchestrate server will listen for AJP requests. Apache JServ Protocol (AJP) is a binary protocol that can proxy inbound requests from a web server through to an application server that sits behind the web server. The default is 8009.
`[redirect=<redirect-port>]`	Redirect port number for the 3DOrchestrate server. The default is 8443.
`[shutdown=<shutdown-port>]`	Shutdown port number for the 3DOrchestrate server. The default is 8005.
`[debug=<debug-port>]`	Debug port number for the 3DOrchestrate server. The default is 8000.
`[transport=<connection-mode>]`	Specifies the connection mode for the 3DOrchestrate Station; either a public (regular) station or transient station. The default value is `mixed` which is appropriate in most cases. Other allowed values are `http` and `https`. Do not change this value unless necessary.
`share=<network-share-path>`	A network shared directory/folder that is used by all 3DOrchestrate servers of the cluster to share data files needed for standard operations. See Shared Network Disk Space. Depending on the operating system of the 3DOrchestrate server machine, you must give the `<network-share-path>` in the appropriate syntax: On Windows, use the Universal Naming Convention (UNC) syntax, for example: share=\\`<computername>`\`<share-name>`\ On Linux, use Network File System (NFS) syntax to mount the shared directory: mount -F nfs [-o mount-options] `server`:/`directory` /`mount-point` and then specify `<network-share-path>` as follows: share=/`<mount-point>`
`EnlistEED`	Instantiates the 3DOrchestrate server member configuration.
`Save`	Keeps the 3DOrchestrate server configuration in the deploy.param file.

Note: If you are using vertical clustering (multiple 3DOrchestrate servers on the same computer), you must ensure there are no port conflicts by specifying all necessary port numbers for each 3DOrchestrate server (TomEE) instance.

After you run the smaexe-deploy command with these options, the deploy.param file contains the following new values:

tomee.<index>.ajp=<value>
tomee.<index>.debug=<value>
tomee.<index>.host=<value>
tomee.<index>.http=<value>
tomee.<index>.redirect=<value>
tomee.<index>.shutdown=<value>
tomee.<index>.tag=<value>
tomee.<index>.transport=<value>

Encrypt and encode the database password that will be used by the 3DOrchestrate server instance to connect to the database:
```
./<os>/reffiles/SMAExeServer/deploy/smaexe-deploy.[bat|sh] -encrypt [-v]
```
You are prompted to enter any passphrase, and the corresponding encrypted and encoded string is returned. The passphrase you enter must match the Schema User Password provided when you configured the JDBC database connection (in Configuring the JDBC Database Connection).

Copy the encrypted string that is returned—it will be used in the next step.

Deploy and configure each 3DOrchestrate server as one member of the load balanced cluster by executing the following command:

./<os>/reffiles/SMAExeServer/deploy/smaexe-deploy.[bat|sh] -ha -eed [-v] deploy.param index=<EED-index> 
dbpw=<encrypted-db-pswd> DeployEED,ConfigEED

You must use this command multiple times to deploy and configure a 3DOrchestrate server on every computer necessary.

Option	Description
`-ha`	Enables the set of actions used for deploying and configuring a cluster of 3DOrchestrate servers.
`-eed`	Specifies the subset of actions related to the 3DOrchestrate servers.
`deploy.param`	The custom deployment parameters file that you have prepared and saved in the previous tasks. In this command you are reading 3DOrchestrate server information from the file.
`index=<EED-index>`	Numerical index (1-99) of one of the previously registered 3DOrchestrate servers.
`dbpw=<encrypted-database-pswd>`	Encrypted password generated in the last step. Similar to the plain-text password, the encrypted version is never saved in the deploy.param file.
`DeployEED`	Creates a TomEE CATALINA_BASE subdirectory structure under the local 3DOrchestrate server name directory `<server_install_dir>`/`<servername>`/. The subdirectory is named `/tomee-<tag>/` using the identifying string you assigned to this 3DOrchestrate server; for example: C:\DassaultSystemes\R2020x\3DOrchestrate\exe1\tomee-`<tag>`\
`ConfigEED`	Configures this 3DOrchestrate server instance by doing the following: Edit the server.xml file, tomee.xml file, and other configuration files in `<server_install_dir>`/`<servername>`/tomee-`<tag>`/conf/ to insert the specific port numbers you registered for this instance. Create `startup`, `shutdown`, and `version` scripts located in the directory `<server_install_dir>`/`<servername>`/tomee-`<tag>`/bin/.

After this command is finished, the local 3DOrchestrate server name directory (default /exe1/) contains one or more (with vertical clustering) TomEE/3DOrchestrate servers that are ready to run.

The cluster is now fully configured and ready to run.