Skip to main content

Anatomy of Sitecore Business Rules

By
A powerful part of Sitecore is the business rules engine. Many say it is an underutilized part of the platform. I think part of this is because it is not very well documented. I agree it is a very powerful part of Sitecore so I wanted to spend some time digging in and documenting more about how it works and how to utilize it.

First, let's level set at a high level on what this is. I don't want to rehash the intro stuff as Sitecore documentation does a good job at explaining it at a high level. The documentation that is slim is breaking down how it is configured and how to extend it.

There are a few blogs out there that show quick and dirty examples of how to create custom rules. Before we go there though I want to break down the anatomy of a rule that currently exists. I think this helps level set how a rule comes together. Once we understand its parts it is easier to create our own, and then the power is really unleashed.

Using a rule

There are many places where a business rule can be created, I will take just one example to work through. 

Here we are first, clicking on the default device. Then clicking on the "edit rule" link. This then brings up the "create rule" dialogue with a list of rules (both conditions and actions) we can configure to run. Again, there are a number of places you can access the "create rule" dialogue, this is just one example. For this post, we will be focusing on the "When query string matches value" rule. 

In the "edit rule" area you will notice I have selected it and set a value of "my test". You will notice in the choose condition area the word "value" is underlined. This means that field will be replaced with a value (in this case a string) and the condition will execute based on that value. 

Where is the rule defined in Sitecore

To start understanding how this rule works we need to dig into how it is set up in Sitecore. To find the above rule we navigate to  /sitecore/system/Settings/Rules/Definitions.

In this section is where all the configuration for rules are. If we open "Elements" and then "Device Detection" you will see a conditional rule called "Query string".

In the "Text" field you can see the sentence we saw before when we set up the rule to use. This time though the "value" area has some special syntax around it.

Then in the "Type" field the assembly and class that process this rule is called out.

We know this rule is a conditional rule via two methods. 1) If you look at the "template" field in the top it says it is using the "condition" template. Also, all conditional rules have a diamond icon. Actions will have a rectangle icon.

How are they categorized

If you move up the tree just a little you will notice there is an "ElementGroup" node. Under this node is all the groups we can organize our rules into. You can, of course, create a new grouping. Below you will see the rule we have been working with was configured to be in the "Device" group (bottom image). This, in turn, means when you open up the "Create rule" dialogue the rule shows up grouped under "Device".


So now we have seen how these show up in the rules editor based on how they are grouped. But how do we get the grouping we want to show up? This comes down to what you specify in the item template. Below the field "Rule" has a source defined as the Rule Group you want to have show up in the editor. 

With the rule source now in place the editor will open up and contain any rules that are part of that rule group. So let's look at the rule groups a bit more now. 

This all comes down to what the rule group and the rule is tagged to. You point to the rule field to a rule group. The rule group is linked to certain tags. Those tags are used to find all the rule elements that also have the same tags. 

In the image below you can see the tags configured for the group on the top left. Then each rule elements configured tags. If you remember from the first screenshot the rules that show up there. Here is a quick list of them (I left devices off because there is a long list and it is muddy up a little because of secondary tag groups).

Predefined Rules
- where predefined rule is true

Context
- where the current database name compares to value
- where the current device compares to value
- where the current web site name compares to value

Hopefully that helps breakdown and explain some of the organizational and anatomy aspects of Sitecore Business Rules. 

Labels:

Comments

Post a Comment

Popular posts from this blog

Uniting Testing Expression Predicate with Moq

By
I recently was setting up a repository in a project with an interface on all repositories that took a predicate. As part of this I needed to mock out this call so I could unit test my code. The vast majority of samples out there for mocking an expression predicate just is It.IsAny<> which is not very helpful as it does not test anything other then verify it got a predicate. What if you actually want to test that you got a certain predicate though? It is actually pretty easy to do but not very straight forward. Here is what you do for the It.IsAny<> approach in case someone is looking for that. this .bindingRepository.Setup(c => c.Get(It.IsAny<Expression<Func<UserBinding, bool >>>())) .Returns( new List<UserBinding>() { defaultBinding }.AsQueryable()); This example just says to always return a collection of UserBindings that contain “defaultBinding” (which is an object I setup previously). Here is what it looks like when you want to pass in an exp
2 comments
Read more

Anatomy of Sitecore Business Rule - Macros

By
In previous posts, we talked about  field syntax and the basic structure of business rules . This time we are going to dive into macros in the business rules. Macros are used as part of the business rule syntax. The syntax looks like this and calls for 4 parameters. [Property to set, Operator/Macro, AdditionalParameters, Display text]. When I first started working with business rules the difference between operator and macro was confusing. To add to this confusion some of the out-of-the-box macros are named with the term "operator" (like ListOperator who's configuration points to a class called ListMacro and the class implements IRuleMacro). Anything under the path /sitecore/system/Settings/Rules/Definitions/Macros should be a macro and should implement IRuleMacro. Macros have the follow characteristics: They inherit the IRuleMacro interface The interface requires this execute method void Execute(XElement element, string name, UrlString parameters, string value)
1 comment
Read more

Experience Profile Anonymous, Unknown and Known contacts

By
When you first get started with Sitecore's experience profile the reporting for contacts can cause a little confusion. There are 3 terms that are thrown around, 1) Anonymous 2) Unknown 3) Known. When you read the docs they can bleed into each other a little. First, have a read through the Sitecore tracking documentation to get a feel for what Sitecore is trying to do. There are a couple key things here to first understand: Unless you call " IdentifyAs() " for request the contact is always anonymous.  Tracking of anonymous contacts is off by default.  Even if you call "IdentifyAs()" if you don't set facet values for the contact (like first name and email) the contact will still show up in your experience profile as "unknown" (because it has no facet data to display).  Enabled Anonymous contacts Notice in the picture I have two contacts marked in a red box. Those are my "known" contacts that I called "IdentifyAs"
1 comment
Read more

Excel XIRR and C#

By
I have spend that last couple days trying to figure out how to run and Excel XIRR function in a C# application. This process has been more painful that I thought it would have been when started. To save others (or myself the pain in the future if I have to do it again) I thought I would right a post about this (as post about XIRR in C# have been hard to come by). Lets start with the easy part first. In order to make this call you need to use the Microsoft.Office.Interop.Excel dll. When you use this dll take note of what version of the dll you are using. If you are using a version less then 12 (at the time of this writing 12 was the highest version) you will not have an XIRR function call. This does not mean you cannot still do XIRR though. As of version 12 (a.k.a Office 2007) the XIRR function is a built in function to Excel. Prior version need an add-in to use this function. Even if you have version 12 of the interop though it does not mean you will be able to use the function. The
14 comments
Read more

Windows Workflow Unit Testing

By
I know people have very mixed opinions about Windows Workflow and, to be honest, so do I. Really I am not even sure if it has much of a future given the little attention Microsoft has given it. However, despite all that and rather your like it or not there are times when you may use it and want to unit test it. The question is how? Well there are not a lot of options but there is one, that for me, has proven valuable. People tend to use Windows Workflow in a few different ways, so first let me explain how I have use it most. I have never really used it where I programmatically created and instantiate of my own workflow. For me it has pretty much all been using the Windows Workflow designer and using IIS as my workflow host. Then inside those XAML workflows I have custom activities I create and need to test. Do to this I have found one tool that does this pretty well and pretty easy. Microsoft Activities Unit Testing It is an old framework but it still gets the job done. There is
Post a Comment
Read more