Install and Start the Robot Agent

Learn how to install and start the robot agent and then confirm its success.

Install the Robot Agent

After extracting the ZIP file and updating the configuration file, install the robot agent.

  1. Build the appropriate command using the following tabs:
    .\scripts\windows\installAgents.ps1 -p agent_install_directory [-n parallel_agents_count]

    where:

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

    • parallel_agents_count is the number of robot agents to run.

    bash scripts/unix/installAgents.sh -p agent_install_directory [-n parallel_agents_count]

    where:

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

    • parallel_agents_count is the number of robot agents to run.

  2. Open a command-line tool, and run the command that you built.

    You have the following options for command-line tools.

    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.

Start the Robot Agent

Start the robot agent from the VM or computer on which you extracted the files. A VM or computer can run robots only if a robot agent is running on it.

  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. Build the appropriate command using the following tabs:
    .\scripts\windows\startAgent.ps1
    .\scripts\windows\startAgents.ps1 -c parallel_agents_count -p agent_install_directory
    

    where:

    • parallel_agents_count is the number of robot agents to run.

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

    bash scripts/unix/startAgents.sh -c parallel_agents_count -p agent_install_directory

    where:

    • parallel_agents_count is the number of robot agents to run.

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

  3. Open a command-line tool, and run the command that you built.
  4. Be aware that network issues sometimes prevent the robot agent from starting. If any errors appear in the command-line tool, run the command again, up to a few times if required.

Determine Success

To determine whether the robot agent started successfully, review the information messages in the command-line tool.

  • Review messages in the command line

    • 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.

  • Determine the number of running robot agents

    When you install the robot agent, the agents_pids.properties is created in the installation directory that you specify in the command.

    This file provides the following information:

    • The number of robot agents that are running in the directory at any time.

    • The start times for the robot agents.

    • The process identifiers of the robot agents.

First Time Starting the Robot Agent

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.

If the Robot Agent Doesn't Start

If the robot agent doesn't start successfully, troubleshoot the issue.

See A Robot Agent Doesn't Start.

Stop a Robot Agent

As long as its computer is on, the robot agent continues running. You can stop a robot agent by running a command or by shutting down the computer that runs the robot agent.

To stop a robot agent by running a command, open a command-line tool, and run one of the following commands.

Goal Command

Stop all robot agents

When multiple robot agents are running from a directory

Windows:

.\scripts\windows\stopAgents.ps1 -p agent_install_directory

Mac or Linux:

bash scripts/unix/stopAgents.sh -p agent_install_directory

where:

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

Stop a single robot agent

When a single robot agent is running from a directory

Windows:

.\scripts\windows\stopAgent.ps1

Mac or Linux:

bash scripts/unix/stopAgent.sh

After stopping a robot agent, you can restart it at any time. If you don't want to manually start the robot agent, configure it to start automatically. See Start the Robot Agent Automatically.