Skip to main content

Variables for pipelines

See the source imageI recently stumbled on a post about adding configuration variables to Sitecore pipelines. This is one of the coolest hidden features of Sitecore and its pipelines! As you build custom pipelines one thing you will probably encounter pretty quickly is the need to pass in a parameter that changed based on the environment the code is deployed into. This is where pipeline variables save the day.

The first thing you need to do is create a variable that will hold the data you want to pass into your pipeline processor. This variable can be udpated by your deployment process to hold the value you want in each environment.

<sc.variable name="mySites" value="mySitesValue" />

Important: You of course want to create this variable in a patch file and not directly in any of the default Sitecore configuration files.

Next, you want to setup your pipeline configuration. This, of course, is also done by using a patch file.

1
2
3
4
5
<processor sites="$(mySites)" 
patch:after="processor[@type='where ever you are patching']" 
type="MyAssembly, MyNamespace.MyMethod">
   <allowedSites>$(sites)</allowedSites>
</processor>

The main thing to understand here is the indirection that is happening with this variables. The first  variable config you created as the name of "mySites", this links to the "sites" property in the processor config. The "sites" property then push that value to the "allowedSites" configfuration variable. The "allowsSites" is the property that needs to be exposed on your class file as a public property.

public string AllowedSites { get; set; }

Now when you deploy your code the "AllowedSites" property will have the value that was set in your first "sc.variable" config file. This allows you to use a deployment process to change the value of that variable based on your environment. Now you can control your pipeline code based on this information.

if (!this.AllowedForSite())
{
   // do some work here
}

private bool AllowedForSite()
{
    return !this.AllowedSites.Any() || this.AllowedSites.Contains(Context.Site.Name);
}

This little feature adds a lot of flexability to your pipeline code. This is the type of feature I like, simple but powerful.

Comments

Popular posts from this blog

Uniting Testing Expression Predicate with Moq

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

Password Management

The need to create, store and manage passwords is a huge responsibility in modern day life. So why is it that so many people do it so poorly? This is a loaded questions with answers ranging from people being uneducated, to lazy, to educated but not affective in their methods and many more. This blog is to help those (in some way even myself) around me strengthen their online security. Why does it matter? To answer this let's look at a few numbers. According to the US Department of Justice (DOJ)’s most recent study , 17.6 million people in the US experience some form of identity theft each year. Ok fine but that is identity theft that has nothing to do with password management. What is one way someone can start getting information about who you are? How do they get access to steal your money? From Cyber Security Ventures 2019 report : "Cybersecurity Ventures predicts that healthcare will suffer 2-3X more cyberattacks in 2019 than the average amount for other industries. W

Excel XIRR and C#

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

Experience Profile Anonymous, Unknown and Known contacts

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"

Anatomy of Sitecore Business Rule - Macros

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)