Pre-General Availability: 2024-09-02

Start the Robot Agent

You must start the robot agent from the computer on which it is installed. If a robot agent isn't running on a computer, the computer can't run any robots.

1. Open the location to which you extracted the ZIP file for the robot agent.
2. Note the version number in the orpa-agent JAR file.

   For instance, for the orpa-agent-0.1.80.jar file, the version number is 0.1.80.

3. Open a command-line tool.

   You have the following options.

   Operating system	Places where you can start the robot agent
   Windows	Command Prompt Open a Command Prompt, and navigate to the location of the unzipped files. Command Prompt as an administrator If your Windows machine doesn't allow you to run scripts from the command line, you can start the robot agent from a Command Prompt that you run as an administrator. Run a Command Prompt as an administrator, and navigate to the location of the unzipped files.
   MacOS	Open the Terminal app, and navigate to the location of the unzipped files.

4. Build the following command:

   java -jar agent_install_directory-folder_name\orpa-agent-name_of_agent_JAR_file

   where:

   • agent_install_location is the location of the unzipped files. Oracle recommends not including any spaces in the directory path.

   • folder_name is the name of the folder that contains the robot agent's files. Do not include any spaces in the folder name, or you won't be able to install the robot agent.

   • name_of_agent_JAR_file is the name of the robot agent's JAR file, including its version number in the X.X.XX format (such as 0.1.80) and its .jar extension.

   For example, if the folder is on your C:\ drive, you named the folder robot_agent, and the JAR file is named orpa-agent-0.1.80.jar, the command looks like this:

   java -jar C:\robot_agent\orpa-agent-0.1.80.jar

5. Run the command in the command-line tool.

   Information messages appear. When the following message appears, the robot agent has started successfully:

   INFO - Requesting messages from ControlRoom

   After the robot agent starts successfully for the first time, Oracle Integration removes the values of the IDCS_CLIENT_ID= and IDCS_CLIENT_SECRET= from the file and writes them to the computer's local keystore for security properties. For auditing purposes, Oracle Integration adds a commented-out message to the file about the change. During subsequent starts of the robot agent, the values are read from the local keystore.

6. If you don't see the previous message, or if any errors appear after you try to start the agent, run the command again, up to a few times if required.

   Network issues sometimes prevent the robot agent from starting.

What if the robot agent doesn't start successfully? Troubleshoot the issue. See Cannot Start a Robot Agent.

If you shut down the computer that runs the robot agent, the robot agent stops running. You must start the agent again after you restart the computer, or configure the robot agent to start automatically. See Start the Robot Agent Automatically.