Adding the Registry key

Placing information in the Registry activates Monarch integration with the OnDemand Client. If during initialization, the OnDemand Client detects this information, it adds menu items and toolbar buttons to the client workspace.

Before you begin

You must install the OnDemand Client on the workstation before you add the Registry key.

About this task

When the user chooses one of the menu items or clicks one of the toolbar buttons, the OnDemand Client calls the associated entry point in the Monarch DLL. The Monarch DLL subkey values provide information about the subkey values and value data shown in the subkey and values for the Monarch DLL. Other DLL subkey values provide information about other values specified.

Subkeys under ExternalDlls contain the information used by the OnDemand Client to call the DLLs integrated into the client. If the subkey does not specify the name of a model file to run, the OnDemand Client simply starts Monarch with the current document.

When a user invokes Monarch from the OnDemand Client and no model file is specified in the Registry key, the OnDemand Client starts Monarch with the current document. The user can then use Monarch functions to analyze the data and optionally create and save a model. To subsequently run a model that was created and saved from the OnDemand Client, the model must be identified in DLLs and a subkey for the model must be added under ExternalDlls. The subkey for the model must specify the values that are required to run the model from the client. For example, the Parameter value must contain the full path name of the model file and any Monarch parameters that are required to run the model.

Table 1. Monarch DLL subkey values
Value and Data Description 
BitmapDll

64-bit client:
C:\Program Files\
IBM\OnDemand Clients\
V10.5\bin\ARSMON.DLL

32-bit client:
C:\Program Files (x86)\
IBM\OnDemand Clients\
V10.5\bin\ARSMON.DLL
 The full path name of the DLL file that contains the bitmap resource for the toolbar button used to invoke Monarch from the OnDemand Client. The example uses the default provided with the OnDemand Client. However, this DLL file can be different from the DLL file specified for the Path or you can use a different BitmapDll DLL file. The bitmap should be 16 picture elements (pel) wide and 16 pels high. This value is optional. If not provided, a toolbar bitmap will not be created. 
BitmapResId

140
 The resource identifier of the bitmap within the DLL file specified for BitmapDll. This value is ignored if BitmapDll is not specified and optional if it is. If not provided, a value of 0 (zero) is assumed. 
CopyDoc

ASCII
 Indicates that a copy of one or more documents is to be provided to Monarch and specifies the type of data to be provided. If the value is ASCII, the document data is converted to an ASCII file. If the value is ASIS, the document data is in its native format.

If the user chooses the menu item or toolbar button when a document is being viewed, the data provided is for the current document. If the document list is being displayed, the data is a concatenation of all documents selected in the document list.

This value is optional. If not provided, no document is provided to Monarch.		 
Doc

1
 Specified as one of the following values:
  • 0 (zero) indicates that enabling the associated menu item and corresponding toolbar button is limited only by the Folders and ExcludeFolders values.
  • 1 (one) indicates that the menu item and toolbar button are enabled only when a document is being viewed.
  • 2 (two) indicates that the menu item and toolbar button are enabled only when the document list is being viewed and at least one document is selected.
  • 3 (three) indicates that the menu item and toolbar button are enabled only when a document is being viewed or a document list is being viewed and at least one document is selected.
This value is optional. If not provided, a value of 3 (three) is assumed.		 
Function

MonarchFunc
 The name of the entry point into the Monarch DLL file. This value must be provided.
Table 2. Monarch DLL subkey values
Value and Data Description 
MenuText

Monarch
 The text that appears on the menu item used to invoke Monarch from the OnDemand Client. The menu item appears under the Window menu. The text also appears when the user passes the mouse pointer over the associated toolbar button. note. The text you specify can describe a specific application in Monarch, such as Loan Analysis. This value is optional. If not provided, the menu item is blank. 
Path

64-bit client:
C:\Program Files\
IBM\OnDemand Clients\
V10.5\bin\ARSMON.DLL

32-bit client:
C:\Program Files(x86)\
IBM\OnDemand Clients\
V10.5\bin\ARSMON.DLL
 The full path name of the Monarch DLL file on the user's workstation. The example shows the default installation drive and directory. This value must be provided.
Table 3. Other DLL subkey values
Value Description
ExcludeFolders Specifies the names of one or more Content Manager OnDemand folders. The syntax is the same as the Folders value.
The menu item and toolbar button are enabled whenever:
  • A document is being viewed and the folder associated with the document is not one of the specified folders, or
  • A document is not being viewed and the current folder is not one of the specified folders.
This value is optional. If not provided, enabling is controlled by the Folders value.
Folders Specifies the names of one or more Content Manager OnDemand folders. If you specify more than one name, you must separate the names with the backslash (\) character. An asterisk (*) character can be used as a wildcard character in the last position of the name. This is equivalent to listing all of the folder names that begin with the characters preceding the asterisk.
The menu item and toolbar button are enabled whenever:
  • A document is being viewed and the folder associated with the document is one of the specified folders, or
  • A document is not being viewed and the current folder is one of the specified folders.
This value is optional. If the ExcludeFolders value is provided, this value is ignored. If neither is provided, a folder name test is not performed before enabling the menu item and toolbar button.
Parameter Specifies a maximum of 255 characters to be passed as parameter data to Monarch. This value is optional. If not provided, then no parameter data is passed to Monarch. See the Monarch documentation for a list of the parameters that you can specify.

To run a specific Monarch model, the Parameter value must contain the full path name of the model file and any Monarch parameters that are required to run the model. If you do not specify the Parameter value, then Content Manager OnDemand simply starts Monarch with the current document. The user can then use Monarch functions to analyze the data and optionally create and save a model.

Procedure

To add the Registry key:

  • The ExternalDlls subkey contains a list of the DLLs that are integrated with the OnDemand Client. It also contains subkeys that define the properties of each DLL. Add the ExternalDlls subkey to the following subkey: HKEY_CURRENT_USER\Software\IBM\OnDemand32\Client
  • Add the value Dlls to the ExternalDlls subkey. Dlls must have a type of String (REG_SZ). The data value of Dlls is a comma-separated list of identifiers for the DLLs that are integrated with the OnDemand Client. Each identifier in the list must have an associated subkey under ExternalDlls. In this case, the identifier is Monarch.
  • Define each DLL listed in Dlls by adding a subkey under the ExternalDlls subkey. Each subkey that you add must be listed in Dlls. In this case, we added the Monarch subkey.
  • Define the properties of a DLL by adding string values to the subkey that you added. To run a specific Monarch model, the Parameter subkey value must contain the full path name of the model file and any Monarch parameters that are required to run the model.