Using the Command-Line Interface

Command-Line Interface

Harmony Agent Adapter

The command-line interface (remote console) is the Harmony Agent Adapter's main interface console. You can use the command-line interface to get information directly from the Harmony Agent Adapter process. The impact on the system’s performance is minimal. Please note that only one access at once is supported (by default localhost). To navigate or edit the executed commands use the <Up> or <Down> arrows on the keyboard. A telnet monitor session can be started by entering the following command at a DOS command prompt:

C:\>telnet localhost 9010

localhost indicates a connection to the local server and is the same as the 127.0.0.1 IP address which always points to the current machine. 9010 is the default <RemoteConsole-Port>. It can be configured in the Harmony Agent Adapter's Initialization File. b+s recommends not changing its value.

After the monitor is started the following prompt is visible:

List of Commands

In order to display a basic list of commands, type help. The following list is displayed

 Status Information

In order to display Harmony AgentAdapter service status information type status (or its alias: s). The following list is displayed:

Harmony Gate Commands

In order to display harmony gate related information, use the following command pattern

$harmony [command] [parameters]

The following commands are available

Command	Alias	Parameters	Description
cfg		Host, Port, ChatVariableMapping, EmailVariableMapping, EnvironmentName, RequestProcessingTimeoutInSeconds, SessionInitTimeoutInSeconds, ShutdownDelayInSeconds	Set the current configuration for the Harmony Gate
help			Shows all available commands for the $harmony gate
agents	la		List of agents
agent	a	agentid	Detailed information for specific agent
agentreasons	ar	agentid	List of available reason codes for specific agent

Example $harmony la

Finesse Agent Gate Commands

In order to display Finesse agent gate related information, use the following command pattern

$fin [command] [parameters]

The following commands are available

Command	Alias	Parameters	Description
help			Shows all available $fin gate commands
status	s		Shows the status of the finesse gate
cfg		DefaultLogoutReason, DefaultNotReadyReason, DefaultNotReadyReason-Suffix, EncryptXmppConnection, FeedbackWaiter-TimeoutInMs, FinesseNodeDeployment, MediaReroute, MediaRouting, NotReadyReasonHidePre-fix, PrimaryNode, RonaNotReadyReasonSuf-fix, SecondaryNode, XmppConnectTimeout	Shows available Finesse gate Configuration parameters
finesse	node, f, n	c / Configuration, si / systeminfo, f / failover, off / offline, on / online	Shows detailed information on the current node. Parameters c and si provides corresponding information. f initiates a failover process. on / off respectively, connects / shutdown Finesse connection(s).

Example $fin cfg MediaRouting

 Harmony Routing Adapter

The command line interface (remote console) is the main interface to the Harmony Routing Adapter process. You can use the command line interface to get status information directly from the Routing Adapter process. The impact on the system’s performance is minimal. Please note that only one access at once is supported (by default localhost). To navigate or edit the executed commands, use the <Up> or <Down> arrows on the keyboard. A tenlet monitoring session can be started by entering the following command at a DOS command prompt:

C:\>telnet localhost 9012

localhost indicates a connection to the local server and is synonymous to the 127.0.0.1 IP address, which always points to the current machine. <RemoteConsolePort> is the address of the gateway port, which is set by the following parameter in the [core] section of the Harmony Routing Adapter initialization file.

TelnetServerPort=9012 (Default: 9012)

After the monitor is started, the following prompt will be visible:

List of Commands

In order to display a basic list of commands type help. The following list is displayed:

 Status Information

In order to display status information type status (or its alias: s). The following list will be displayed:

Harmony Routing Gate Commands

In order to display harmony routing gate related information, use the following command pattern

$harmony [command] [parameters]

The following commands are available

Command	Parameters	Description
cfg	LocalWebService	Show Harmony gate configuration parameters
help		Shows all available commands for the Harmony gate

Example $harmony cfg LocalWebService

MRI Routing Gate Commands

In order to display MRI routing gate related information, use the following command pattern

$mri [command] [parameters]

Command	Parameters	Description
cfg	MaxAllowedTasksBeforeOverflow, MaxQueuedTasks, MaxQueuedTasksLabel, MaxQueuedTasksPrioReservation, MaxTasksPerSecond, MediaUrlVariable, OverflowDefaultTimeInSec, PreferredAgentPeripheralVariable, PriorityVariable, RecipientVariable, RoutingReasonVariable, TcpPortNumber	Shows MRI gate configuration parameters
help		Shows all MRI gate available commands

Example $mir cfg MaxQueuedTasks

Reroute Routing Gate Commands

In order to display Reroute routing gate related information, use the following command pattern

$reroute [command] [parameters]

Command	Parameters	Description
cfg	ServerURI	Shows Reroute gate configuration parameters
help		Shows all available Reroute gate commands

Example $reroute cfg ServerURI

Web Status Page

Harmony Agent Adapter

To verify that the Harmony Agent Adapter service is up and running, open a browser and point it to:

http://<hostname>:9080

<hostname> is the name of the server where the b+s Harmony Agent Adapter service is running and <port> is the port number configured in the configuration file. This port number can be found in the HttpServerPort setting in the [core] section of the Harmony AgentAdapter configuration file or by typing “httpsrv status” on the command-line interface.

HttpServerPort=9080 (Default: 9080)

By default, only local access is granted. To enable remote access, use the key httpal-lowedhosts in the [core] section of the Harmony AgentAdapter configuration file.

Harmony Routing Adapter

In order to verify that the Harmony Routing Adapter service is ready and running, open a browser and point it to:

http://<hostname>:9082

<hostname> is the name of the server where the Harmony RoutingAdapter service is running and <port> is the port number configured in the configuration file. This port number can be found in the HttpServerPort setting in the [core] section of the Harmony RoutingAdapter configuration file or by typing httpsrv status on the command line interface.

HttpServerPort=9082 (Default: 9082)

By default, only local access is granted. To enable remote access use the key httpallowedhosts in the [core] section of the Harmony RoutingAdapter configuration file

MediaRoutingPlugin

Logging

All log outputs for the MediaRoutingPlugin are part of the ordinary Harmony QueueAdapter logs.

Please be aware that in Queue Adapter settings the option Trace Listener Enabled in section Logging / Logging Manager(s) / Logging Manager must be activated to enable log messages from MediaRoutingPlugin in logfiles of QueueAdapter.

Loading

(INFO) 2016-11-18-10:27:38.612: CustomConnect-or::LoadConnectorDLLThroughReflection filePath=C:\Program Files\OpenMethods\OmQueueAdapter\bsMediaRoutingPlugin.dll, className=HarmonyMediaRoutingPlugin.MediaRoutingConnector (->Connect)(RightNow Queue (EMAIL2CUSTOM))

Prefix

All log outputs of the MediaRoutingPlugin plugin, after being loaded, are prefixed with bsMediaRoutingPlugin.

Examples

Kind	Logline
Connect	(INFO) 2016-11-18-10:27:38.690: bsMediaRoutingPlugin Connect (->WriteLine)(RightNow Queue (EMAIL2CUSTOM))
Email task	(INFO) 2016-11-18-10:27:39.455: bsMediaRoutingPlugin SubmitInteraction: 689 -> rnIncidentId:689, omQAName:OMQA:LABHARDEVMD, omQAVersion:4.0.112.0, In-cidentId:689, FromAddress:john.doe@sample.com, Email_Address:john.doe@sample.com, TimeCreat-ed:18.11.2016 10:27:38, Subject:Table and Chairs (->WriteLine)(RightNow Queue (EMAIL2CUSTOM))
Chat task	(INFO) 2016-11-18-10:42:36.112: bsMediaRoutingPlugin SubmitInteraction: 459 -> rnChatId:459, omQAName:OMQA:LABHARDEVMD, omQAVersion:4.0.112.0, pv7:John, pv8:Doe, FromAddress:john.doe@sample.com, Email_Address:john.doe@sample.com, pv3:Product 1->Superproduct, pv4:Unknown, TimeCreated:18.11.2016 10:42:36 (->WriteLine)(RightNow 3PQQueue)