9 Command Line Deployment of Inline Services

In addition to deployment from Decision Studio, Inline Service deployment is also available from the command line. This type of Inline Service deployment can be performed either directly by a command in a command line window or from a script that calls the command.

This is useful in situations where several developers work on an Inline Service whose files are stored in a source control system. On a scheduled (or on-demand) basis, the Inline Service is retrieved from the source control system onto the production machine or onto another machine that can deploy the Inline Service into a production machine. You can then programmatically deploy the Inline Service to the production RTD server.

As released, the command line deployment tool is located in the zip file, rtd-deploytool-11.1.1.zip, in the directory RTD_HOME\client\CommandLineDeploy.

First, unzip the file rtd-deploytool-11.1.1.zip. The file can be unzipped into any machine running Linux or Windows. The machine must have JDK installed. The JDK version used to run the command line deploy tool must be the same as the JDK version used by the RTD server.

In this section, the directory into which rtd-deploytool-11.1.1.zip is unzipped is referred to as RTD_DEPLOYTOOL_DIR. The unzipping creates the folder structure OracleBI/RTD/deploytool under RTD_DEPLOYTOOL_DIR. The main command line deployment tool, deploytool.jar, which performs the command line deployment, is located in the RTDdeploytool folder.

Note:

To use the command line deployment tool, users must be associated with an application server role which permits deploying the Inline Service.

For example, if no permission assignments have been removed from the default roles after a Simple or Enterprise installation of Oracle RTD, then a user with the BIAuthor or BIAdministrator role is permitted to use the command line deployment tool.

9.1 Deploying the Inline Service

To deploy the Inline Service from the command line, perform the following steps:

Navigate to the directory containing the deploytool.jar file.
```
cd RTD_DEPLOYTOOL_DIR/OracleBI/RTD/deploytool/
```

Run the following command:

java [-Djavax.net.ssl.trustStore="<trust_store_location>"] -jar deploytool.jar -deploy [[<named_option>...] source [<positional_option> [...]]

The parameters for deploytool.jar are as follows:

<named_option>... - one or more of the name-value pairs listed in Table 9-1.

Table 9-1 Command Line Deployment Named Options

Format	Description
`-server` `address`	Hostname or IP address for the RTD server. Default is localhost.
`-port` `number`	Port on which the RTD server listed. Default is 8080.
`-sslConnection` `bool`	Whether SSL is used for connection. Default is false.
`-deploymentState` `name`	Deployment state for this Inline Service.Default is Development
`-releaseLock` `bool`	Releasing the lock allows other users to edit the Inline Service in Decision Center or to deploy it from Decision Studio. Default is true.
`-terminateSessions` `bool`	Terminating active sessions in the Decision Server. Do not use this option when deploying to a production server unless necessary. Default is false.

source - one of the following:
- Directory: Full path to the Inline Service project folder which holds the Inline Service to be deployed.
- Zip file: Full path to the zip file containing the Inline Service project folder which holds the Inline Service to be deployed.
  
  The zip file can contain only one Inline Service with up to one level parent folder.
Paths that include spaces must be enclosed within double quotes, for example, "C:\My Projects\CrossSell".

<positional_option>[...] - positional parameter list in the format:

[username password [server[port[ssl[state[unlock[endsessions]]]]]]]

as listed in Table 9-2.

Table 9-2 Command Line Deployment Positional Options

Parameter	Description (includes references to Table 9-1 Format entries)
`username`	Name of a user logging in to the RTD server.
`password`	The user's password. For a blank password, specify "".
`server`	Positional `-server`
`port`	Positional `-port`
`ssl`	Positional `-sslConnection`
`state`	Positional `-deploymentState`
`unlock`	Positional `-releaseLock`
`endsessions`	Positional `-terminateSessions`

The command line deployment program deploys Oracle RTD Inline Services found in a source to a server from the command line.

The parameter -deploy is the first required argument.

The parameters source, username, and password are mandatory parameters, and are positional. If the values of the username and password parameters are not specified initially, users will be prompted to enter them.

If values are specified for a named option and its corresponding positional option, then the positional option value overrides the named option value.

Notes:

Help text listing and describing the parameters appears if the jar file is called without parameters, for example, java -jar deploytool.jar.
<trust_store_location> is the full path to the trust store file. Use the -Djavax.net.ssl.trustStore parameter only if -sslConnection (or the equivalent positional parameter ssl) is set to true.

Examples without named options

java -jar deploytool.jar -deploy "c:\my workspace\CrossSell" scott brighton 192.168.0.15 8080 true Production false

java -jar deploytool.jar -deploy CrossSell sp34kc slater

java -jar deploytool.jar -deploy c:\OracleBI\RTD\examples\CrossSell sdsu b21k7e false QA

Examples using named options

java -jar deploytool.jar -deploy -server 192.168.0.15 -port 8081 c:\OracleBI\RTD\examples\CrossSell sysman mi22ty

java -jar deploytool.jar -deploy -port 8081 -server 192.168.0.15 c:\OracleBI\RTD\examples\DC_Demo sonar chimney

java -jar deploytool.jar -deploy -sslConnection true CrossSell.zip calzone twostep

java -Djavax.net.ssl.trustStore="C:\OracleBI\RTDdeploytool\etc\ssl\sdtrust.store" -jar deploytool.jar -deploy -sslConnection true -port 8443 "C:\OracleBI\RTD\examples\CrossSell" ssluser psword