Installing RME- eClient rendering content URL

Update the URL that IBM® Records Manager will use to invoke the eClient viewer extensions for rendering the content. A default URL is displayed. In most cases, you need to replace only virtual host name with the host name of your eClient server.

The default URL is specified as follows.

<URL scheme>://<virtual host name>/
<eClient application name>/ IDMIntegrator<arguments>

Sample URL: http://cmhost/eclient/IDMIntegrator?eClientToken=rmetoken&iType=view &IPFile=RME&ReleaseLevel=RME8_3_0&itemids=%%D

The URL must specify the host name (virtual host name), the location of the eClient application (eClient application name), the servlet name (servlet name), and the argument properties (argument properties), for example, http://host name/eClient application name/servlet name?argument properties.

A valid URL for single sign-on contains the servlet specification (IDMIntegrator), five required parameters (the release level argument, the integrator properties file name, the iType, itemids and eClientToken) and four optional parameters (the server, serverType arguments, userid and password).

The URL specifies argument values that identify the type of integration and the name of an Integration Properties File (IP File). The following argument values can be specified:

ReleaseLevel

This property indicates the release level. It is required.

IPFile

This property specifies the name of the integration properties file. It is required. The IP File has a file extension of .properties. However, you do not include .properties when you specify the IPFile value in the URL. The case sensitivity of the IPFile property varies by platform.

Important: Any parameter that is specified in the URL will overwrite parameters in this file.

Before you use DB2® Content Manager to render the URL, create the IP file in the eClient directory, which by default is %IBMCMROOT%\CMeClient.

The IP file normally contains:

eClientToken=rmetoken
server=
serverType=ICM
userid=
password=
type=4
cssPrefix=
iconPrefix=

The eClientToken value is determined by a system administrator and must be provided in the URL. When the eClientToken value is provided in the URL, it is compared to the token specified in this properties file. Valid characters for use within the eClientToken value are any of the ISO 8859-1 Latin 1 characters, with the exception of ";", "/", "?", ":", "@", "&", "=", "+", ",", and "$", which are reserved characters within the query string of a URL. The other values are:

server: Specifies the name of the content server database.
serverType: Specifies the type of content server. It must be specified as serverType=ICM.
userid: Specifies the user ID that is used to access the content server database.
password: Specifies the password for the user ID that is used to access the content server database.
type: Controls the objects that appear and the capabilities that are supported within a Web page that is generated by the JavaServer Pages. Set this value to 4 (type=4).
cssPrefix: Specifies a file name prefix for the Cascading Style Sheet file that is used by the JavaServer Pages. The specification determines the text fonts, colors, on so on that are used. A value of alt1 specifies the use of alt1eclient81.css.
iconPrefix: Specifies a file name prefix for the icon files that is used by the JavaServer Pages. These GIF files contain graphical buttons for the document viewer toolbar.

iType

This property specifies the type of integration to use. It is required.

server

This property is the name of the DB2 Content Manager server database to which the eClient connects. It is not required.

serverType

This property is the type of DB2 Content Manager server to which the eClient connects. It is not required.

userid

This property specifies the user ID that is used to log on to the DB2 Content Manager library server database. It is not required.

password

This property specifies the password for the user ID (userid). The password must be specified if userid is used.

eClientToken

This property specifies the token. It is required.

itemids

This property specifies the list of the PIDs, if iType=view or iType=list.

In addition, one or all of the following macros can be used within the URL. They are substituted for the values at run time:

%%H: Virtual name of the DB2 Content Manager host.
%%D: PID of the DB2 Content Manager document to render.
%%U: ID of the currently logged in user.
%%P: Password of the currently logged in user. Because the user ID and password is transmitted as part of the URL request, specifying them in the IP file provides more security.