Automating tasks using the RemoteControlCLI utility
The Opportunity Detect command line utility, RemoteControlCLI (CLI), allows you to automate the management of deployment configurations and batch runs. You can use the CLI to perform the same actions you can perform on the Deployment & Batch Run tab of a workspace.
The RemoteControlCLI utility and sample batch or shell scripts are all located in the cli directory under your Opportunity Detect design time installation.
The following sample scripts are provided with your installation.
| Script | Usage |
|---|---|
| encode | Encrypt the password that the CLI uses to connect to the design time database. |
| deploy | Deploy a deployment configuration. |
| stop | Stop the deployment of a deployment configuration. |
| start | Re-start the deployment of a deployment configuration. |
| startBatch | Start a batch run by starting a deployed deployment configuration. |
| stopBatch | Stop a batch run by stopping a deployed deployment configuration. |
Prerequisites
The following are prerequisites for using the Opportunity Detect command line scripts.
- The computer where you run the scripts must have network access to machines where the Opportunity Detect design time and run time components are installed.
- Java version 7 must be installed on the machine where you run the scripts.
- You must set the JAVA_HOME system environment variable. You can do this either on the machine where you run the scripts, or by editing the scripts to set it temporarily when the scripts run.
Password security
The information the CLI uses to connect with the design time database is saved in the RemoteControlCLI.xml file, located in the cli directory. This information includes the user name and password for an account in the database.
You can encrypt the password that is stored in this file, to avoid storing the password in clear text.