HP LoadRunner Protocol SDK
Protocol Configuration: The LRP File
In This Topic

The file <LoadRunner installation>\dat\protocols\<protocol id>.lrp is the master configuration file for the protocol.

In addition, there is an sdkbase.lrp file that contains common settings for all protocols created with the HP Protocol SDK.

Do not edit sdkbase.lrp. To apply values different from those specified in sdkbase.lrp, override the value in the protocol LRP file.    

The most used sections of the LRP file include the following:

The Protocol Section

Setting Name

Description

Category

The general category of the protocol, for example, E-Business or ERP/CRM. For a full, current list of existing categories, open the New Virtual User dialog in Vugen and open the Category list.

CommonName

The display name may have spaces and punctuation.

DerivedFrom

The protocol ID of the protocol on which this protocol is based. All settings are taken from the LRP of this base protocol. However, if a setting in the LRP of the base protocol is also specified in the LRP of this protocol, these settings override those of the base protocol.

Description

A free text description of the protocol.

DontSupportGroup

This protocol cannot be used in a multi-protocol script with protocols from the groups specified with these codes. Do not edit this value.

EnableAutoTranPerFunc

Enables (1) or disables (0) display of the check box in VuGen that allows the user to configure handling each step as a transaction. Do not enable this check box unless the protocol implements this feature.

Hidden

Indicates whether not to list (1) or to list (0) the protocol in the New Protocol Script dialog.

Icon

The icon of the protocol for the New Protocol Script dialog. The icon is a 16x16 bitmap (BMP file). Use the relative path starting from the dat folder. For example, for file <LoadRunner installation>\dat\bitmaps\myicon.bmp, enter Icon=bitmaps\myicon.bmp

MaxThreadPerProcess

The maximum number of threads per process. The default is 50. May be reduced to solve problems of performance on the client running on the load generator.

Multi

Indicates whether to enable (1) or disable (0) the protocol as a multi-protocol Vuser type.

Name

The protocol name. Use the same string entered for the ProtocolID parameter.

PostSaveNotify

The callback function for notification on a save operation. After a save operation, the specified function in the specified DLL is invoked. The format is PostSaveNotify=<function_name>:<dll_name>. For example:

PostSaveNotify=PostSaveNotify:DotNetRecordUtils.dll

PostRecordingNotify

The function name and DLL of the callback to be invoked when a recording session is completed. The function name is required to be PostRecordingCallback, but the DLL is specific to the protocol. For example:

PostRecordingNotify=PostRecordingCallback:SDKProtocol.dll

ProtocolId

A string of up to eight characters that follows the rules for C language variable names. It is used internally by VuGen to identify the protocol.

PreRecordingCheck

The function name and DLL of the callback to be invoked before starting a recording session. The function name is required to be PreRecordingCallback, but the DLL is specific to the protocol. For example:

PreRecordingCheck=PreRecordingCallback:SDKProtocol.dll

ResultsDirUI

Enables (1) or disables (0) the Prompt for results directory check box in the Tools->Options dialog.

Set to 1 if the Test Results Report is implemented and used.

RTS_DynamicTreeBmpDir_1 RTS_DynamicTreeBmpDir_2

...

RTS_DynamicTreeBmpDir_n

The folder containing resources for use on dynamic tree tabs, relative to the <LoadRunner installation>\dat directory. Always use folder bitmaps.

For example:

RTS_DynamicTreeBmpDir_1=bitmaps

SDKVersion

The version of the HP Protocol SDK on which this version of the protocol was developed.

Single

Indicates whether to enable (1) or disable (0) the protocol as a single Vuser type.

Version

The version of this protocol.

VISUAL_LOG

Set to 1 if the Test Results Report is implemented and used. For protocols created with the SDK, set this value to 1.

WINNT
WIN2000
WINXP
WIN95

SUNOS
SOLARIS
HPUX
AIX

The names of the test run processes for the platforms supported by the protocol.

The process is mmdrv.exe for all Windows platforms and mrdv.exe for all UNIX platforms.

The Template Section

This section can contain the following default settings:

@@TestName@@.usr=myReplay.usr

vuser_init.c=vuser_init.c

vuser_end.c=vuser_end.c

Action.c=Action.c

default.cfg=default.cfg

default.usp=default.usp

globals.h=globals.h

For information on these settings, see The Template Folder.

The Replay Section

This section can contain the following default setting for changing the default for the principal protocol header file:

HEADERS=myReplay.h

For information on this setting, see Header Files.

The Vugen Section

Name

Description

Configuration Topic

RTS_DynamicTreeInitXmlFile_n

(RTS_DynamicTreeInitXmlFile_1

RTS_DynamicTreeInitXmlFile_2

...

RTS_DynamicTreeInitXmlFile_n)

See also, "RO_DynamicTreeOutIniFile_n" on page 174

Specifies the XML presentation configuration file for a dynamic tree tab. The user enters configuration data in the tab for use in running a test that uses this protocol. The first tab is File_1, the second tab is File_2 and so on.

For example:

RTS_DynamicTreeInitXmlFile_1=citrix_rts.xml

RTS_DynamicTreeInitXmlFile_2=citrix_rts_2.xml

Run- time settings

AllowScriptEdit

Enable (1) editing of the script.

(Default = 1)

General

EnableThreads

Enables (1) or disables (0) the "Run Vuser as a thread" check box in the Run Time Settings dialog.

General

LangSupported

Comma-delimited list of the languages supported for this protocol. For protocols created with the HP Protocol SDK, only C is supported. For example:

LangSupported=C ,VBA,VBS,JS

(Default = C)

General

Mulit_OutputTabName#
Mulit_OutputTabFile#
Mulit_OutputTabIcon#
Mulit_OutputID#

When defining multiple tabs for a file in the Output window, set values for the tab name, file, tab icon and tab ID settings.

For example:

; Multi Code Generation Log

Mulit_OutputTabName1="Generation Log"

Mulit_OutputTabFile1=data\CodeGenerationLog.txt

Mulit_OutputTabIcon1="5"

Mulit_OutputID1="33088"

General

OutputTabFile#

The path and name of the file whose contents are displayed in the corresponding tab in the Output window. # is the index number for the tab.

For example, to display the Generation Log in the first tab of the output window:
OutputTabFile1=data\CodeGenerationLog.txt

General

OutputTabName#

The name for a tab in the Output window, where # is the index number for the tab.

For example, to create a tab for the Generation Log:
OutputTabName1=Generation Log

General

Platform executables

The names of the run-time environment executable files for supported platforms. For example:

AIX=mdrv

HPUX=mdrv

LINUX=mdrv

SOLARIS=mdrv

WIN2000=mmdrv.exe

WINNT=mmdrv.exe

WINXP=mmdrv.exe

General

RecordingLogFile

The name of the log file for recording. The default is RecordingLog.txt. For example:
RecordingLogFile=data\RecordingLog.txt

General

SupportMultipleAction

Allow (1) multiple actions in a script.

(Default = 1)

General

TemplateDir

The name of template directory. It must be identical to the protocol ID. For example:
TemplateDir=Oracle_NCA

General