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. If this is the first time that you're starting the robot agent on the computer, ensure that the computer has access to the public internet.

    The robot agent requires this access to download its required dependencies. This requirement exists only for the first time that you start the robot agent.

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

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

  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. If the computer's home directory contains a folder with a space in its name, create a new home directory, and update the command so that it specifies this new directory.

    This step is required even if you install the robot agent somewhere other than the home directory. Regardless of where you install the robot agent, the robot agent must create files in the home directory, and the robot agent is unable to create the files if the home directory contains any spaces.

    1. Create a home directory without any spaces.

      For example, if your home directory is C:\Users\John Smith, create the following new directory:

      C:\Users\JohnSmith

    2. Update the command so that it specifies the new home directory as the location to install files for the robot agent.

      Use the following command to set the home directory: -Duser.home=

      For example: -Duser.home=C:\Users\JohnSmith

      Use the following format to include this command in the previous sample command:

      java -Duser.home=C:\Users\JohnSmith -jar C:\robot_agent\orpa-agent-0.1.80.jar
  6. 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.

  7. Start the robot agent by running the command that you built in the command-line tool.
  8. 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.

How to Determine if the Robot Agent Started Successfully

Information messages appear in the command-line tool. When the following message appears, the robot agent has started successfully:

INFO - Requesting messages from ControlRoom

If the following message appears in the command-line tool, the robot agent was already running prior to your attempting to start it:

ORPA Agent process is already running.

A robot agent might be running already if you configured it to start automatically. See Start the Robot Agent Automatically.

What Happens After the Robot Agent Starts the First Time

After the robot agent starts successfully for the first time, Oracle Integration removes the values of the following properties from the robot agent's configuration file for security properties:

  • IDCS_CLIENT_ID=
  • IDCS_CLIENT_SECRET=

Oracle Integration writes the properties to the computer's local keystore and 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.

What to Do if the Robot Agent Doesn't Start Successfully

Troubleshoot the issue. See A Robot Agent Doesn't Start.

The Robot Agent Runs as Long as the Computer Is On

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