Export (0) Print
Expand All

Customizing the Exchange Load Generator Test

 

Topic Last Modified: 2008-02-12

Microsoft Exchange Load Generator simulates some calls that Microsoft Office Outlook makes to the server that is running Exchange Server. The most common user tasks are combined into one Exchange Load Generator task named Read and Process Message. With the Read and Process Message task, the simulated user reads all the e-mail in the Inbox and replies to, replies to all, forwards, moves, deletes, or loads attachment to a certain percentage of the e-mail messages.

This topic lists the parameters, by task alphabetically, that can be changed in the configuration file. These tasks include the common tasks for MAPI, Microsoft Office Outlook Web Access, Outlook Mobile Access Browse, Outlook-specific tasks, and Office Outlook 2003–specific tasks.

Generally, to customize the test, you have to make changes in the XML configuration script file. The following table of tasks, positioned alphabetically by task name, describes the meaning and purpose of each parameter listed in the configuration file.

BrowseCalendar opens the Calendar folder and performs modify or delete actions on content within the folder. If BrowseCalendarActionCount is 0, no action will be performed on calendar items.

 

Parameter Comment

MinimumActionMessages

The minimum number of calendar items to perform an action on.

MaximumActionMessages

The maximum number of calendar items to perform an action on.

ChangePercentage

The percentage of calendar items to be changed.

DeletePercentage

The percentage of calendar items to be deleted.

BrowseContacts opens the Contacts folder and performs modify actions on content within the folder.

There are no parameters for this task.

BrowsePublicFolder browses Public Folder content. This action can include opening 1 or more (1-n) public folders, reading new content, reading 0 or more (0-n) previously read messages, creating or deleting sub folders, and performing the same processing actions that the ReadAndProcessMessages task performs on mailbox content.

 

Parameter Comment

FolderOpenCount

The number of folders that will be opened.

OldPostReadCount

The number of old posts to read, in addition to any new posts, in each folder opened.

CreateSubFolderPercentage

The percentage of task invocations in which a new sub folder will be created.

DeleteSubFolderPercentage

The percentage of task invocations in which a sub folder will be deleted.

MinimumFolderDepth

The minimum folder depth for the public folder hierarchy that must be used when you create sub folders.

MaximumFolderDepth

The maximum folder depth for the public folder hierarchy that must be used when you create sub folders.

AverageFolderDepth

The average folder depth for the public folder hierarchy that must be used when you create sub folders.

ResolveConflictsPercentage

The percentage of conflicts that must be resolved if there are any.

ApplyViewPercentage

The percentage of folder opens in which a random view will be applied.

ReplyPercentage

The percentage of processed messages that will result in a reply to action.

ReplyToFolderPercentage

The percentage of processed messages that will result in a post reply to folder action.

ForwardPercentage

The percentage of processed messages that will result in a forward action.

DeletePercentage

The percentage of processed messages that will result in a delete action.

MovePercentage

The percentage of processed messages that will result in a move action.

CopyPercentage

The percentage of processed messages that will result in a copy action.

ChangePostPercentage

The percentage of processed messages that will result in a content change action.

MaximumMessages

The maximum number of messages that can remain in any processed folders.

BrowseTasks opens the Tasks folder and performs modify or delete actions on content within the folder. The status of the task must be complete before a deletion is performed.

There are no parameters for this task.

CreateContact adds a contact to the Contacts folder in the user's mailbox.

There are no parameters for this task.

CreateFolder creates a folder in the mailbox folder hierarchy. The CreateFolder task can be tuned to create at the top level of the hierarchy at a given percentage, and also takes minimum, maximum, and average parameters for the desired hierarchy depth.

 

Parameter Comment

CreateAtTopLevelPercentage

The percentage of folders to be created at the top level.

MaxDepth

The maximum depth of the folder to be created if it is not at the top level.

AvgDepth

The average depth of the folder to be created if it is not at the top level.

MinDepth

The minimum depth of the folder to be created if it is not at the top level.

CreateTask adds a task to the Tasks folder in the user's mailbox.

No parameters for this task.

DeleteMail deletes mail from a selected folder, which is controlled by DeleteFromDeletedItemsPercentage. If you are not deleting from the DeletedItems folder, Exchange Load Generator randomly selects one from any other folder. The source folder can be weighted to select the Deleted Items folder.

 

Parameter Comment

MinimumMessagesToDelete

The minimum number of e-mail messages to be deleted.

MaximumMessagesToDelete

The maximum number of e-mail messages to be deleted.

AverageMessagesToDelete

The average number of e-mail messages to be deleted.

DeleteFromDeletedItemsPercentage

The percentage of e-mail messages deleted from the Deleted Items folder.

DownloadOAB downloads the offline address book. This operation should simulate downloading the content based on the usual operation of the simulated client type and should ignore the received data (that is, do not store it locally).

 

Parameter Comment

FullDownload

Specify whether to always download the Offline Address Book instead of to make incremental changes since the last download.

FullDetails

Collect full details instead of partial details.

EditRules modifies the rules in a user's mailbox. This can include create, change, and delete operations.

 

Parameter Comment

MinimumRules

The minimum number of rules that should exist in a mailbox.

MaximumRules

The maximum number of rules that should exist in a mailbox.

DeletePercentage

The percentage of task invocations in which a rule will be deleted.

CreatePercentage

The percentage of task invocations in which a rule will be created.

ChangePercentage

The percentage of task invocations in which a rule will be changed.

ConditionFromDistributionListPercentage

The percentage of rules that will be triggered by a From-Distribution-List condition.

ConditionFromPersonPercentage

The percentage of rules that will be triggered by a From-Person condition.

ConditionSentOnlytoMePercentage

The percentage of rules that will be triggered by a Sent-Only-To-Me condition.

ConditionWithWordInSubjectBodyPercentage

The percentage of rules that will be triggered by a With-Word-In-Subject-Or-Body condition.

ConditionNameInToCcBoxPercentage

The percentage of rules that will be triggered by a Name-In-To-or-Cc-Box condition.

ConditionWithAttachmentPercentage

The percentage of rules that will be triggered by a With-Attachment condition.

ConditionNameNotInToBoxPercentage

The percentage of rules that will be triggered by a Name-Not-In-To-Box condition.

ConditionWithWordInSubjectPercentage

The percentage of rules that will be triggered by a With-Word-In-Subject condition.

ActionDeletePercentage

The percentage of rules that result in a delete action.

ActionMoveToFolderPercentage

The percentage of rules that result in a move to folder action.

ActionCopyToFolderPercentage

The percentage of rules that result in a copy to a folder action.

ActionForwardtoPersonPercentage

The percentage of rules that result in a forward to person action.

ActionForwardtoDistributionListPercentage

The percentage of rules that result in a forward to distribution list action.

ActionPermanentlyDeletePercentage

The percentage of rules that result in a permanently delete action.

ActionStopProcessingMoreRulesPercentage

The percentage of rules that result in a stop processing more rules action.

EditSmartFolders modifies the smart folders in a user's mailbox. This can include create, change, and delete operations.

 

Parameter Comment

MinimumSmartFolders

The minimum number of smart folders that should exist in each mailbox.

MaximumSmartFolders

The maximum number of smart folders that should exist in each mailbox.

DeletePercentage

The percentage of task invocations that should result in a delete action.

CreatePercentage

The percentage of task invocations that should result in a create action.

BrowsePercentage

The percentage of task invocations that should result in a browse action. Be aware that the parameters specified for the browse folder task will be used if a browser action is selected.

CriteriaUnreadPercentage

The percentage of smart folders that should use Unread criteria.

CriteriaImportantPercentage

The percentage of smart folders that should use Important criteria.

CriteriaOldPercentage

The percentage of smart folders that should use Old criteria.

CriteriaForFollowUpPercentage

The percentage of smart folders that should use For-Follow-Up criteria.

CriteriaConversationWithRandomPersonOrDistributionListPercentage

The percentage of smart folders that should use Conversation-With-Person-Or-Distribution-List criteria.

CriteriaUnreadOrForFollowUpPercentage

The percentage of smart folders that should use Unread-or-For-Follow-Up criteria.

CriteriaReceivedThisWeekPercentage

The percentage of smart folders that should use Received-This-Week criteria.

CriteriaFromRandomPersonOrDistributionListPercentage

The percentage of smart folders that should use From-Person-or-Distribution-List criteria.

CriteriaSentToRandomDistributionListPercentage

The percentage of smart folders that should use Sent-to-Distribution-List criteria.

CriteriaWithSpecificWordsPercentage

The percentage of smart folders that should use With-Specific-Words criteria.

CriteriaLargePercentage

The percentage of smart folders that should use the Large criteria.

ExportMail simulates the effect of exporting the content of a folder from the mailbox. The ExportMail task can be configured to include subfolders of the selected folder, or the whole mailbox.

noteNote:
This action should not actually result in content being stored locally on the client as that will not scale. The task should only simulate the effect of the server of performing this action.

 

Parameter Comment

ExportEntireMailboxPercentage

The percentage of the whole tree exported. Otherwise randomly select a top level folder and export.

IncludeSubFolder

Specify whether to include subfolders in export.

Logoff disconnects from the server in such a way that client and server side resources associated with the user connection are released.

 

Parameter Comment

EmptyDeletedItems

Specify whether the Deleted Items Folder will be emptied on logoff.

Logon establishes a user connection to the server. Depending on the type of client being simulated, this can involve more than one connection being established, and can involve any processing that is typically run as part of starting the client or performing a user initiated action within the client to establish a connection to the server. For example: authentication, fetching any information that is required to build the user interface, and so on.

noteNote:
By default, all the mailbox connections are encrypted. There is currently no parameter available to disable MAPI encryption.

 

Parameter Comment

AutoDiscoveryPercentage

The percentage of autodiscovery performed during logon. This parameter applies only when the user's mailbox server is running Microsoft Exchange Server 2007.

MakeAppointment adds an appointment to the calendar folder in the user's mailbox.

 

Parameter Comment

MinimumAppointmentHours

The minimum length of appointment in hours.

MaximumAppointmentHours

The maximum length of appointment in hours.

AverageAppointmentHours

The average length of appointment in hours.

RecurringPercentage

The percentage of meetings that will have a random recurrence pattern.

AllDayPercentage

The percentage of meetings that will be marked as all day.

OOFAppointmentPercentage

The percentage of appointments that will be marked as OOF. If the user's mailbox server is running Exchange 2007, and it runs Office Outlook 2007 simulation, whenever an OOF appointment is created, Web service will be called to set the user's OOF settings.

MoveMail moves messages from a selected folder to another selected folder in the mailbox. The source folder selection can be weighted to select the Inbox, and the destination folder can be weighted to select the Deleted Items folder.

 

Parameter Comment

MinimumMessagesToMove

The minimum number of e-mail messages to be moved.

MaximumMessagesToMove

The maximum number of e-mail messages to be moved.

AverageMessagesToMove

The average number of e-mail messages to be moved.

MoveToDeletedItemsPercentage

The percentage of e-mail messages moved to Deleted Items

MoveFromInboxPercentage

Percentage of e-mail messages moved from the Inbox folder.

PostFreeBusy simulates the action of publishing free/busy data for clients that perform this behavior.

noteNote:
This task will not be run if the user's mailbox is running Exchange 2007.

 

Parameter Comments

UpdateFreeBusyInformation

Specify whether to update public Free Busy information.

MonthCount

Specify how many calendar months of Free Busy information to publish.

PublicFolderPost post a single item to a Public Folder.

 

Parameter Comments

MessageFiles

Specify that custom message files be used for this task.

ReadAndProcessMessages simulates the action of a user processing mail in the mailbox. Processing mail typically consists of reading and responding to unread items. This task will select a folder to process with a given weight for the Inbox folder. The task will optionally apply a view to the folder that has been selected. All unread content (or a maximum number of unread messages) will be read. Some of this content may be left open if a particular client and protocol support that. For each read message, various actions will be applied based on configured percentages such as reply, reply all, forward, move, delete, permanent delete, and copy. Additionally, Incoming meeting requests will be processed by this task.

 

Parameter Comment

ReplyPercentage

The percentage of messages processed that will result in a Reply action.

ReplyAllPercentage

The percentage of messages processed that will result in a Reply All action.

Forward Percentage

The percentage of messages processed that will result in a Forward action.

MovePercentage

The percentage of messages processed that will result in a Move action.

DeletePercentage

The percentage of messages processed that will result in a Delete action.

PermanentDeletePercentage

The percentage of messages processed that will result in a Permanent Delete action.

CopyPercentage

The percentage of messages processed that will result in a Copy action.

ApplyViewPercentage

The percentage of task invocations in which a random view on the folder will be attached.

LoadAttachementsPercentage

The percentage of messages opened that contain attachments in which the attachments will be opened.

PreviewItems

Specify whether to preview items in the folder without opening them.

RespondToMeetingsPercentage

The percentage of responses to a meeting request.

AcceptMeetingPercentage

The percentage of meeting requests that will result in an acceptance.

MaximumOpenMessages

The maximum number of messages that can be kept open.

KeepMessagesOpenPercentage

The percentage of messages that can be kept open.

MaximumFolderMessages

The maximum number of messages that can remain in the folder when the task has completed. Note that Exchange Load Generator operates only on a number that is great than zero.

ProcessInboxPercentage

The percentage of processing an Inbox.

MaximumMessagesToProcess

The maximum number of unread messages that will be processed during the task.

RequestMeeting sends a meeting request message to a set of recipients.

 

Parameter Comment

MinimumMeetingHours

The minimum meeting length in hours.

MaximumMeetingHours

The maximum meeting length in hours.

AverageMeetingHours

Average meeting length in hours.

MinimumMeetingAttendees

The minimum number of attendees to invite to meetings.

MaximumMeetingAttendees

The maximum number of attendees to invite to meetings.

AverageMeetingAttendees

The average number of attendees to invite to meetings.

AddDistributionListPercentage

The percentage of task invocations in which a distribution list will be added to the attendee list of the meeting request.

AddDynamicDistributionListPercentage

The percentage of task invocations in which a dynamic distribution list will be added to the attendee list of the meeting request.

AddExternalRecipientPercentage

The percentage of task invocations in which an external recipient will be added to the attendee list of the meeting request.

ExternalContactPercentage

The percentage of contacts picked as external recipients.

AvailabilityCheckPercentage

The percentage of attendee availability checks. This parameter applies only when the user's mailbox server is running Exchange 2007.

Search performs a content search on a folder or throughout the whole mailbox. This results in the default search behavior for the client platform. For example, on a cached mode Outlook client, this would be a no-op. For an online mode Outlook client, this would call into the content index (CI) on an Exchange 2007 server.

This task is not implemented in Office Outlook simulation modules.

SynchronizeFolders simulates the effect of the server during a synchronize folders operation. This should simulate the actual effect on the server that would be caused by synchronizing a local version of mailbox data with the data that is stored on the server that uses whatever method is appropriate for the given client type and protocol.

This task is not implemented in Office Outlook simulation modules.

TopologyMonitorGroup is where you define a set of rules for Exchange Load Generator to use. This is done to monitor the health of the target environment.

 

Parameter Comment

Duration

Specify the time period that threshold detection will be run. Default is the test run time.

Event

Specify the details in the <Event> tag. The values are not case-sensitive.

TargetMachine

Specify the computer name that the threshold data is collected from.

Actions

Specify what actions are turned on or off. By default, all the actions are off. Specify "true" to the corresponding attribute to enable the action.

PollFrequency

Specify the rate of threshold data collection.

DelayStartTime

Specify the time period before threshold detection starts.

NumberOfSamples

Specify the number of samples that will be used to calculate the statistics. Default is 10.

PerfHealthEntities

Specify the details of the performance counter threshold detection under the <PerfHealthEntities> tag followed by the <PerfHealthEntity> tag. Multiple threshold entities can be added as the <PerfHealthEntity> tag under <PerfHealthEntities>.

ThresholdRules

Specify threshold values: aggregation Maximum, Average, and Standard deviation. Each threshold rule has attributes Aggregate, Lower, Upper, and Enabled to specify what types of aggregation, the minimum values, the maximum values, and the on and off value respectively.

ServiceHealthEntity

Specify the service display name or the short name. The names are not case-sensitive. For example, both MSExchangeIS and Microsoft Exchange Information Store are valid.

The MailboxStoreProfile and the PublicStoreProfile define the mailbox initialization and public store initialization respectively. The procedures for working with them are in the topic How to Customize the Initialization of a Test.

 

Parameter Comment

InboxUnreadPercentage

The percentage of messages that will be marked as unread in the Inbox folder.

NewFolderUnreadPercentage

The percentage of messages that will be marked as unread in the new folders.

BuildInboxRules

Specify whether to create rules. If set to false, Exchange Load Generator does nothing. Additionally, if there are existing rules in the mailbox, they are kept there. If this option is set to true, the FixUpInboxRules option is ignored.

FixUpInboxRules

Specify whether to fix up Inbox rules. If set to true, Exchange Load Generator follows the existing rules and tries to fix the condition and actions by setting the valid recipients and folders. This option takes effect only if BuildInboxRules is set to false. Generally this option is used when the mailboxes are restored by using production data.

InboxMessageCount

The number of e-mail messages that will be created in the Inbox folder.

DeletedMessageCount

The number of e-mail messages that will be created in the Deleted Items folder.

NewFolderCount

The number of new folders that will be created in a mailbox.

NewFolderMessageCount

The number of e-mail messages that will be created by the Exchange Load Generator.

SmartFolderCount

The number of smart folders that will be created.

InboxRuleCount

The number of rules that will be created in each mailbox.

AppointmentCount

The number of appointments that will be created in each calendar.

ContactCount

The number of contacts that will be generated in the Contacts folder.

UseOrdinalFolderName

Specify whether to use the ordinal number for folder name. If set to true, the folder name will resemble Folder1, Folder2, and so on. Otherwise, the GUID will be used for folder names.

InitializeFreeBusy

Specify whether to generate a free/busy status message on an appropriate public folder store for each mailbox

InitializeIndices

Specify whether to pre-create the standard indexes, for example, for Contacts.

InitializeCachedModeIndices

Specify whether to pre-create the cached mode indexes.

MessagePercentageRecent

The percentage of messages that have a delivery date that is within the time frame defined by the <MessageRecentContentTimeFrame> tag.

MessageRecentContentTimeFrame

The period of time frame percentage that messages within a delivery time, within this period, are classified as recent.

MessageContentTimeFrame

The period of time frame percentage that the delivery times of all messages are within this time frame.

AppointmentPercentageRecent

The percentage of calendar items that are scheduled within the time frame that is defined by the <AppointmentRecentContentTimeFrame> tag.

AppointmentRecentContentTimeFrame

A time frame from the last day of the current month backward. All calendar items scheduled within this period are classified as recent. The default value is two months.

AppointmentContentTimeFrame

The period of time from the last day of the current month that all calendar items are scheduled within this time frame. The default value is two months.

TaskCount

The number of tasks in the users' mailboxes. The task completion percentage is defined by <BrowseTasksActionParameters> under <ActionProfile>. An example is as follows:

<ExtendedProperties>

<Item Name="PercentageComplete"Type="Double">Administrator</Item>

</ExtendedProperties>

 

Parameter Comment

TopLevelFolderCount

The number of folders at the top level of the hierarchy.

NonTopLevelFolderCount

The number of folders that are not at the top level of the hierarchy.

MinimumFolderDepth

The minimum depth of folder hierarchy in the public folders.

AverageFolderDepth

The average depth of folder hierarchy in the public folders.

MaximumFolderDepth

The maximum depth of folder hierarchy in the public folders.

MinimumMessageCount

The minimum number of e-mail messages in the public folders.

AverageMessageCount

The average number of e-mail messages in the public folders.

MaximumMessageCount

The maximum number of e-mail messages in the public folders.

UseOrdinalFolderName

Specify whether to use the ordinal number for folder name. If set to true, the folder name will resemble Folder1, Folder2, and so on. Otherwise the GUID will be used for folder names.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2015 Microsoft