Prime Technologies, Inc.

Describes the Agent CLI in detail and provides basic syntax, options, and usage examples for each operation.

Description

The Agent Command Line Interface is a tool to manage your ProcalV5 Agent service.

Synopsis

agent-installer [option...]

Use agent-installer -help command for information on command line options

Options

 -h,--help                      

To display information on command line options

 -i,--agent-id <string>            

To configure Agent ID

 -k,--generate-agent-keys        

To generate agent keys. If agent keys are already generated, installer will prompt the user to replace the existing keys. If yes, keys are replaced.

 -p,--mediator-public-key <string>  

To configure Mediator public key

 -q,--agent-queue <string>          

To configure Agent Queue

 -start,--start-agent            

To start the agent process

 -stop,--stop-agent              

To stop the agent process

 -v,--info                       

To display agent information like Agent Version, Agent ID, Upload & Download Queue

Examples

Help command to display information on command line options

Run the below command to get help on command line options

agent_installer.bat -help

Configure Agent ID

Run the below command to configure Agent ID

`                       agent_installer.bat -i <Agent ID>

Agent ID - Agent Installer should copy Agent ID from Primepcx.com agent area

If Agent ID is already configured, installer will prompt the agent whether to replace the existing Agent ID. If yes, Agent ID is replaced with the new one

When to run this command

Anytime the Organization Admin needs to generate or replace the Agent ID in the web application for Primepcx.com. Agent Installer need to run the above command to configure Agent ID (Login to your Organization's Primepcx.com Admin page and navigate to the Agent area. Copy and paste Agent Id from Agent Configuration).

Configure Agent Keys

Run the below command to configure Agent keys

agent_installer.bat -k

If agent keys already configured, installer will prompt the agent whether to replace the existing agent keys. If yes, keys are regenerated and replaced.

When to run this command

Anytime the Organization Admin needs to generate or replace the Agent ID in the web application for Primepcx.com. After doing this the Agent Installer may typically need to run the command to regenerate an Agent Key

Configure Mediator Public Key

Run the below command to configure Mediator public key

agent_installer.bat -p <Mediator Public Key>

Mediator Public Key - Agent Installer should copy public key from Primepcx.com agent area

When to run this command

Anytime mediator public key is changed, run this command to configure Mediator Public Key (Login to your Organization's Primepcx.com Admin page and navigate to the Agent area. Copy and paste Mediator Public Key from Public Key Configuration)

NOTE: Mediator Public Key would only change if Prime Technologies support agents inform you of the explicit need to update this information based on values in your organization's Agent Configuration page.

Configure agent queue

Run the below command to configure Agent Queue

agent_installer.bat -q <Queue Name>

Queue Name - Agent Installer should copy Agent Queue from Primepcx.com  agent area

If agent queue is already configured, installer will prompt the agent whether to replace the existing agent queue. If yes, keys are regenerated and replaced.

When to run this command

Anytime the Organization Admin needs to generate or replace the Agent ID in the web application for Primepcx.com. Agent Installer need to run the above command to configure Agent Queue (Login to your Organization's Primepcx.com Admin page and navigate to the Agent area. Copy and paste Agent Queue from Agent Configuration).

Display agent information (Agent Version, Agent ID, Agent Queue and Download Queue)

Run the below command to get Agent information

agent_installer.bat -info

When to run this command

To get Information about agent install such as Agent Version, Agent ID, Agent Queue (Upload Queue), and Download Queue

Start & Stop agent

To start the agent, run as administrator

agent_installer.bat -start

To stop the agent, run as administrator

agent_installer.bat -stop

Installer may get the response "ProcalV5Agent : Unexpected status    SERVICE_STOP_PENDING in response to STOP control.". Please ignore this, as   the agent would still be successfully stopped.

When to run this command

Anytime the below agent configuration is changed, agent installer should restart (stop and start) the agent

Agent ID

Agent Queue

Mediator Public Key

Agent Keys