Class MacroRuleMetadataContainer

Namespace

CMS.ContactManagement

Assembly

CMS.ContactManagement.dll

Class for registering MacroRuleMetadata to the system. Use RegisterMetadata(MacroRuleMetadata) or RegisterMetadata(Dictionary<string, MacroRuleMetadata>, MacroRuleMetadata) to speed up recalculation of contact groups when registered macro rule is used in group condition.

public static class MacroRuleMetadataContainer

Inheritance

object

MacroRuleMetadataContainer

Remarks

Registering MacroRuleMetadata can have two profound effects on speed of recalculation.

First is recalculating contacts in the database - normally, when a contact group is being rebuilt, system takes all contacts from database and runs the macro condition on each of those. By registering a translator to a rule, the computation can be inverted, that means at first, a database query will be constructed to select only those contacts that fit given macro condition.

All of the macro rules must be able to translate themselves to database query to use this functionality.

Second is recalculating the rule only when specified type of activity performs, for example when a PAGE_VISIT performs, there is no need to recalculate BIZFORM_SUBMIT macro rules. This can significantly reduce the count of contact groups that need rebuild on each request.

Methods

IsTranslatorAvailable(string)

Checks whether a translator is registered for given macro rule codename.

public static bool IsTranslatorAvailable(string ruleName)

Parameters

ruleName string

Returns

bool

True if translator is registered

RegisterMetadata(MacroRuleMetadata)

Registers metadata for a macro rule. Overrides already registered translators if the MacroRuleName collides.

public static void RegisterMetadata(MacroRuleMetadata metadata)

Parameters

metadata MacroRuleMetadata

Metadata to register