On the Media Blender Server: The Trailhead medium (Trailhead.properties)

Setting up the Trailhead medium involves these steps:

1. Define the Trailhead medium on the Media Blender

2. Configure Trailhead properties

Define the Trailhead Medium on the Media Blender

You must identify Trailhead as a medium in the properties file for Media Blender (blender.properties). In the Medium# property, enter Trailhead.properties.

Note: You must have the proper Blender key code to install and use the Trailhead medium.

Configure Trailhead Properties

Properties for configuring Trailhead are in the Trailhead.properties file that resides in the \CiscoMB\servlet\properties\blender directory on the Blender server. (You identify this file to Media Blender using the Medium property in the Blender properties file. )

Use this property file to determine which events the Trailhead medium can accept and share. See "Event Filters" in the Media Blender Reference Guide for complete information about event filter parameters.

Use each property only once in each properties file. If you include a property more than once in a file, Media Blender automatically recognizes the setting in the last occurrence of the property, overwriting the value in preceding occurrences.

In addition to CTI event filter parameters, Trailhead.properties contains these properties:

name=

Display only. This property identifies the medium. It should be set to Trailhead.

package=

This property displays the Java package name of this Blender medium. In this file, it must be set to Com.WebLine.Blender.Trailhead. This package must be accessible to the servlet engine (either JWS or servlet exec) through its CLASSPATH. See your Installation Guide for information on setting the Classpath.

serverport=

Property type: Numeric

Default: None

This property identifies the port Trailhead uses to connect to the Web PG.

destchooser=

Property type: string

Default: Com.WebLine.Trailhead.DcICM

Required

This property identifies the destination chooser used by the Trailhead medium on the Media Blender server. In ICM Web configurations, this should be Com.WebLine.Trailhead.DcICM

Media Blender Startup Properties

Use these properties to adjust the amount of time Media Blender should wait for the incoming Web PG connection at start up.

serverconntimeout=

Property type: numeric

Default: 120

This property specifies the amount of time Media Blender should wait for the incoming Web PG connection at start up.

serverstartwithoutconn=

Property type: boolean

Default: true

This property specifies whether to allow Media Blender to start if the timeout specified in serverconntimeout is exceeded.

If this property is set to true, the Media Blender will complete its own startup regardless of whether it detects the incoming Web PG connection. Since the Web PG connection will not exist, any route request messages sent to it will be routed to the System Error destination. The Trailhead medium will continue to look for a connection and will generate alerts until one is made.

If this property is set to false, Media Blender will not start up if the Web PG connection is not made within the serverconntimeout limit.

Specifying Trailhead Connections

Use these properties to set up the connections from your Trailhead servers to your Trailhead media. Note that, even though connections are numbered sequentially, you can delete a connection within the sequence without having to renumber your remaining connections.

In the properties that follow, note that "local" properties refer to the Trailhead medium. Properties that refer to "remote" values indicate the Trailhead server.

connection<n>.localservername=

Property type: String

Default: blender

This property identifies the local name for this connection; that is, the name of the Trailhead server end of the connection. This is the name that a destination must specify in a destination<n>.queueconn property.

Note: In previous versions, the value for the Media Blender end of the connection was specified.

connection<n>.localregistryport=

Property type: Numeric

Default: 1099

This property identifies the local port for this connection (i.e. the Trailhead medium).

connection<n>.localpassword=

Property type: String

Default: blenderpw

This property identifies the password for this connection. The value here must match the value indicated in the connection<n>.remotepassword property on the Trailhead server. Note that this password is automatically encrypted; when you edit this file, the value you enter here will appear as an encrypted code.

connection<n>.remoteservername=

Property type: String

Default: trailhead

This property identifies the remote name for this connection; that is, the Trailhead server. The value here must match the value in the connection<n>localservername property on the Trailhead server.

connection<n>.remotehost=

Property type: String

Default: None

This property identifies the host name of the Trailhead server.

connection<n>.remoteregistryport=

Property type: Numeric

Default: 1099

This property identifies the remote port for this connection; that is, the Trailhead server. The value here must match the value entered in the localregistryport property on the Trailhead server.

connection<n>.remotepassword=

Property type: String

Default: trailheadpw

This property identifies the password for this connection. The value here must match the value indicated in the connection<n>.localserverpassword property on the Trailhead server. Note that this password is automatically encrypted; when you edit this file, the value you enter here will appear in an encrypted code.

Specifying Trailhead Destinations

Use these properties to set up your Trailhead destinations. Note that, even though connections are numbered sequentially, you can delete a connection within the sequence without having to renumber your remaining connections.

destination<n>.name=

Property type: String

Default: None

This property defines the name for a destination in your configuration. When specifying destinations, number each destination sequentially, beginning with 1.

Example:

destination1.name=Boston1

destination2.name=Boston2

destination<n>.type=

Property type: String

Default:

This property lets you specify the type of response this destination will provide to web requests. Acceptable values are:

Value

Description

CALLONLY

Basic Callback

COLLAB

Web Collaboration

NOCALL

Noncalling

destination<n>.queueconn=

Property type: string

Default: None

This property is required for CALLONLY destinations. It identifies the local server name of a connection, defined on a Trailhead server, to which queue requests are sent for this destination.

Note: This is a change from previous versions when the value of the Trailhead medium on the Media Blender end of the connection was used.

destination<n>.URL=

Property type: Valid URL

Default: None

This property maps a valid URL to a particular destination. When a request is routed to the destination, Trailhead serves the URL specified here.

Note for NOCALL destinations: You can choose to serve a URL here, or, instead, serve only an HTTP error code and reason to the caller. If you choose to serve an error code instead, do not use this property; instead, use destination<n>errorcode and destination<n>errorreason, described below.

We provide sample URLs for different destination types. See Maintaining Trailhead HTML Pages and Forms in this guide for more information.

destination<n>.substitute=

Property type: Boolean

Default: None

This property lets you specify whether data will be dynamically substituted into HTML fields on the URL specified for the destination. This property should be set to True for COLLAB destinations.

destination<n>.errorcode=

Property type: Integer

Default: None

This property specifies that a HTTP error code should be sent to a user when callback is unavailable or to handle crank or troublesome calls. Use this property for NOCALL destinations if you want serve users an error code rather than an HTML page explaining the problem. If you use this property, do not specify a URL in the destination<n>.URL property for this destination.

Acceptable values are 404, 500, or any numeric HTTP error code.

destination<n>.errorreason

Property type: string

Default: None

This property explains the error specified in destination<n>errorcode.

Setting System Defaults

The following properties let you specify default destinations that should be used when the ICM script returns any of these labels:

In addition, you can set a default for when the ICM script returns an error.

destination<n>.systemdefault=

Property type: Boolean

Default: False

This property lets you specify whether the destination should be used whenever the ICM script returns a default label.

destination<n>.systembusy=

Property type: Boolean

Default: false

This property lets you specify whether the destination should be used whenever the ICM script returns a busy label.

destination<n>.systemnoagents

Property type: Boolean

Default: false

This property lets you specify whether the destination should be used whenever the ICM script returns a ring label.

destination<n>.systemerror=

Property type: Boolean

Default: false

This property lets you specify whether the destination should be used whenever the ICM script returns an error label or any error occurs.

Specifying the Trailhead Input and Output Maps

Use these properties to identify the input and output maps used in your system.

inmap=

Property type: Filename

Default: in.map.properties

This property identifies the file used to translate web-based data into data that can be used by the ICM scripts. See the Input Map in this guide for more information

outmap=

Property type: Filename

Default: out.map.properties

This property identifies the file used to translate information returned by the ICM script into textual information that can be used by the Collaboration Server. See Creating the Output Map for more information

ICM Label Information

icmlabeldelimiter=

Property type: Character

Default: - (hyphen)

This property identifies the delimiter used to separate the two distinct portions of the ICM label output by scripts. Use this property if you are not using the IcmLabelLength method of parsing ICM labels. For information on ICM script labels, see ICM Script Label Configuration in this guide.

Note: If you specify a delimiter here, do not specify a label length using the icmlabellength property, explained below.

icmlabellength=

Property type: Numeric

Default: None

This property lets you determine which portion of the ICM label should be used as a routing address based on length. For more information, see ICM Script Label Configuration in this guide.

Note: If you specify a length here, do not specify a label delimiter using the icmlabeldelimiter property, explained above.

Verify URLs

checkurls=

Property type: Boolean

Default: False

This property determines whether Trailhead or the Trailhead Medium should check for the existence of the URLs referred to by each destination.