Sitecore Install Framework

Sitecore Installation Framework (SIF)

This is the first in my series breaking down the installation of Sitecore Experience Platform 9. I’ve tried to chunk the required steps, allowing you to take your time moving through the installation. The serires will conclude with how I suceeded in installing everything in 15 steps.


The Sitecore Install Framework (SIF) enables users to deploy and configure a Sitecore environment using a standard configuration design that can be extended through custom PowerShell functions.

It is based on a combination of Microsoft PowerShell commands and JSON based configuration files.

Installation of SIF is provided in two flavors, a manual process and a MyGet feed based process via PowerShell.

You can find SIF at

SIF Install

As I prefer to script for repeatability and ease of sharing with my dev team, this guide will be based on installing SIF via the MyGet feed approach.

Setup PowerShell to interact with the Sitecore MyGet feed

  1. Open a PowerShell command prompt, ensure you are running it as Admin
  2. Register the connection to MyGet feed, at the prompt enter
    Register-PSRepository -Name SitecoreGallery -SourceLocation

    SIF - Register Sitecore Gallery

  3. Install the SIF module, at the prompt enter
     Install-Module SitecoreInstallFramework
  4. PowerShell will ask if untrusted scripts can be ran, enter ‘A’ and hit Enter.
    SIF - Accept Untrusted Scripts
  5. Before performing any other steps, and each time before you use the module, you will want to perform a check and update of the module via
     Update-Module SitecoreInstallFramework
  6. Confirming everything installed correctly is as easy as running the following command, at time of writing the current version is 1.1.0
    Get-Module SitecoreInstallFramework -ListAvailable

    SIF - Available Versions

You should now be ready to continue forward leveraging SIF to install and manage your Sitecore 9 Experience Cloud instance.


A Master Key to Your Content

Once in a while I find myself in a situation where workflow hasn’t been completed but users have begun content entry or cleanup. Normally these users also have not been setup as site admins, but with some level of custom accesses. This causes the editors to spend time dealing with locking and unlocking items for editing. At times they’ll not even realize and they locked the item, and you start to get a trail of items edited then forgotten.

What’s an admin to do?

Without too much work you can turn-on the gutter icon for ‘Locked Items’, then drill through the tree visual identifying and jotting down what’s locked and who.

Locked Items Gutter Setting

But that’s tedious (and a bit error prone). As with all cool administrative tasks in Sitecore we are best to turn our attention to Sitecore PowerShell Extensions (SPE) in the marketplace

The SPE ships with function that gives us the ability to see and react to locked items on our site.


Step 1 – Import Function

By default the function Get-LockedChildItem is not callable. You must first ‘import’ it into your console or ISE session.

Import-Function Get-LockedChildItem

 Import-Function Get-LockedChildItem

If you don’t perform an import of the function, then you’ll receive a red error message like the following

Get-LockedChildItem : The term ‘Get-LockedChildItem’ is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again.

Step 2 – Get a Report

Before performing any sort of automation on our content tree, we should always produce a report that provides some context of what may get changed. In this case we want to get a listing of all items that are locked

Get-LockedChildItem -Recurse | Show-ListView

Here we are using the ‘Recurse’ flag to walk the entire tree. The collection of items locked are then piped to the very nice Show-ListView, allowing for easy review and export.

Get-LockedChildItem as a Report

We can also run the report for specific users via the -LockedBy parameter

Get-LockedChildItem -Recurse -LockedBy 'sitecore\editor' | Show-ListView

Step 3 – Time to Free the Content

Once we understand who has what locked we can start performing some mass freeing of content with the -Unlock parameter. To unlock everything, we run

Get-LockedChildItem -Recurse -Unlock

If we want to perform some hand picking of section of the site, we can either open the console to a certain node of the tree and run the above or define the start point with -Path parameter. This will unlock all the children of the item defined by path, even providing a nice output of what was unlocked.

Get-LockedChildItem -Recurse -Unlock -Path {85E0AF8C-ED9F-4CDA-BFB2-084015E17634}
Get-LockedChildItem -Recurse -Unlock -Path /sitecore/content/Coffeehouse/Home/About-Us

Unlock for a path

Finally, if we want to unlock for a specific individual we can re-use the -LockedBy parameter,

Get-LockedChildItem -Recurse -Unlock -LockedBy 'sitecore\editor'

Not a Replacement for workflow (i.e. the Disclaimer)

Being able to execute unlocking of content on a mass scale is helpful, but this shouldn’t be the replacement for properly planned and built workflow on your site.

Planning for Cache in Sitecore

This is a follow-up to my Unofficial Sitecore Planning Checklist, where I try to consolidate as much information as I can find on Sitecore’s built in caching.

One of the easiest ways to improve a visitor’s perceived impression of any website visit is through a well-tuned cache. A cache which has been properly tuned will be able to server of requested content quicker, sometimes magnitudes faster than rebuilding the HTML for a page on each request.

Sophisticated caching scenarios can be configured through third-party tools and applications, but even for the most highly trafficked site properly tuning Sitecore’s different cache options should provide the desired performance gains. As site cache is configured and tuned, be aware the need for vertical or horizontal scaling may become necessary. (For details on scaling Sitecore checkout Scalability)

Determine the cache limits required

The general practice for Sitecore caching tuning is to turn all cache limits off via the following simple cache patch config:

<configuration xmlns:patch="">
      <setting name="Caching.DisableCacheSizeLimits">
    <patch:attribute name="value">true</patch:attribute>

With the cache limits now disabled, Sitecore will try to manage based on current traffic and available resources to cache as much as possible. By performing well structured load test or allowing the site to run in this manner, the team should monitor both server resource utilization as well as the Sitecore cache levels to determine areas that should be manually limited to maximize performance.

To monitor what Sitecore has cached you can use the Sitecore admin page, http://&lt; your domain >/Sitecore/admin/cache.aspx, or leverage the Sitecore Marketplace module Caching Manager,

Cache Manager Options

After data collection has occurred you are ready to begin to evaluate which caches need their limits adjusted from the default level. For more information on the different cache limits that can be set see Sitecore CMS 7.0 – 7.2 CMS Performance Tuning Guide.pdf and Sitecore CMS 6.6 or later Cache Configuration Reference.pdf.

Configuring HTML Cache of Components

The first level of caching to configure to is review each rendering that is created and set the appropriate HTML level caching on it.

Rendering Cache Option

To turn HTML cache on for the rendering, select the first option Cacheable. From here you can customize the how different variations of the control should be cached via the different ‘Vary By’ options. Finally, you can mark that all cache be cleared when the search index is updated via the ‘Clear on Index Update’ selection.

The following fuller description of each cache option is taken from Chapter 4: Output Caching in Sitecore CMS 7.0 or later Presentation Component Reference.pdf.

Clear on Index Update

The Clear on Index Update property controls whether or not a control clears its cache when an item that is associated with the control is updated in the index. This is useful for any control that uses the new Search API to populate its data sources. For example:

  • You have a control that returns all the products that are on special offer from the index.
  • The Clear on Index Update property for this control is set to True.
  • The price of each product is stored in the index.

If someone updates the price of one of the products on special offer, the Clear on Index Update property will the trigger the control to clear its cache because something has been updated in the index that is bound to the control.


The VaryByData property controls whether or not output caching varies based on the data source of the presentation component.

Set the VaryByData property:

  • To False for components that do not generate different output when used with different data sources.
  • To True for components that generate different output when used with different data sources.


The VaryByDevice property controls whether or not caching varies based on the name of the context device.

Set the VaryByDevice property:

  • To False for components that do not generate different output when used with different devices.
  • To True for components that generate different output when used with different devices.


The VaryByLogin property controls whether or not output caching varies based on whether or not the user has authenticated. For caching configuration involving the VaryByLogin property, the layout engine treats all anonymous users as a single authenticated user.

Set the VaryByLogin property:

  • To False for components that do not generate different output for authenticated than for unauthenticated visitors.
  • To True for components that generate different output for authenticated than for unauthenticated visitors.


The VaryByParm property controls whether or not output caching varies based on rendering parameters passed to the presentation component. Solutions built with earlier versions of Sitecore may have used the token VaryByParam instead of VaryByParm. Update any instances of VaryByParam to VaryByParm.

Developers set the VaryByParm property:

  • To False for components that do not generate different output when passed different rendering parameters.
  • To True for components that generate different output when passed different parameters.


The VaryByQueryString property controls whether or not output caching varies based on query string parameters passed in the URL. The VaryByParm property causes output caching to vary based on rendering parameter values passed by the developer. The VaryByQueryString property causes output caching to vary based on parameters passed in the URL query string.

Developers set the VaryByQueryString property:

  • To True for components that generate different output when supplied different query string parameters.
  • To False for components that do not generate different output when supplied different query string parameters.


The VaryByUser property controls whether or not output caching varies by the domain and username of the context user.

Developers set the VaryByUser property:

  • To False for components that do not generate different output for different users.
  • To True for components that generate different output for different users, when the number of active users between publishing operations is relatively small. The VaryByUser treats all anonymous users as a single authenticated user.

To avoid excess memory consumption, avoid using the VaryByUser property except in solutions with relatively small numbers of users, or monitor cache utilization closely. The VaryByLogin property causes Sitecore to generate different output depending based on whether or not a user has authenticated, differentiating anonymous users from authenticated users. The VaryByUser property causes Sitecore to generate different output for each user

Other Caches

Sitecore contains a number of other caches that help to lower the number of calls required to the database for item information and indexes. These are best described in a post from the Sitecore Tactics blog entitled How Sitecore caching work.

Additional Helpful references

One Final Note

Starting in Sitecore 8.2, the Cache APIs where refactored, creating breaking changes to any custom cache providers used in previous versions. Be sure to check out the change list,


How to plan for performance

Recently I had the opportunity to sit through a series of management courses. One of the main focuses was how to provide an environment to help motivate your team members and increase performance. In parallel to these courses I was working with a client to define the steps required to properly secure and architect a scalable Sitecore installation. After some extensive research and reading, followed by re-reading I’ve tried to compile the ‘Unofficial Sitecore Planning Checklist’.

As Sitecore has matured as a product so has the method of documenting the product, sadly it seems we continue to be in a slow shift to easily consumable and discoverable documentation, it reminds me of the early days of my SharePoint work, where the community documented better the product team. Because of this positive growing pain, you may end up on really old blog posts as well as some ‘ancient’ PDF documentation, which is still plenty applicable. Finally, this checklist is a starting point as documentation and feature sets continue to change and growth with the product always check for the latest before finalizing your organizations plans.

Some Basics

Begin with Sitecore Experience Platform 8.0 the ability to scale both horizontally and vertically was introduced through flexibility to place different Sitecore components on individual or combined servers.

The key components to be accounted for during server architecture is

  • Content delivery (CD) server (including personalization)
    • the touch point to the visitors, HTML, personalization, etc..flow from here
  • Content management (CM) server
    • Central nerve to the entire site, authoring and reporting occur here
  • Content databases (SQL)
    • SQL databases that houses your content
  • Session state server
    • This is the method you choose to track contacts while the actively visit the site.
    • Listed as an actual server this can take the form of a server, SQL database, MongoDB collection, or just ran in memory.
  • Collection database (MongoDB)
    • Storehouse for xAnalytics as data is collected
  • Processing server
    • Performs the heavy lifting job number crunching
  • Reporting database (SQL)
    • Just a database that all the pretty tables and charts come from
  • Reporting service
    • Service that moves data from SQL to those pretty tables and charts
  • Email Experience Manager Dispatch database (SQL)
    • Finally a clearly named item (database used to manage the queueing and sending of emails)
  • Email Experience Manager Dispatch service
    • Another straight named item (API that the servers use to perform the actual sending, dispatching, of emails)

You’ll notice there are a number of SQL databases that are required to support the system. These can all run on the same SQL instance or cluster without issue.

If you plan to place any of the service components on individual servers, you will need be properly licensed by Sitecore for an additional server install as they all require an installation of Sitecore just like a content delivery or management server.

Checkpoint 1: CM and CD Setup

  • CD Server
    • Bare minimum requirements: 16GB RAM, 4 cores resulting in 8 threads
    • Things to watch out for
      • Site must process heavy business or search logic making it computationally heavy CPU increase may be needed
      • Caching strategy may require additional RAM to support better cache retrieval of HTML and images
      • In-Proc Session State will be store to RAM, in which case a high traffic site is going to need more RAM
  • CM Server
    • Bare minimum: 16GB RAM, 4 cores resulting in 8 threads
    • Things to watch out for
      • As increase of con-current authors editing increases additional RAM becomes required to provide the better experience (this number may be around 10 to 15)
      • In a standard installation the CM server performs the additional duties of processing server, reporting service, and EXM Dispatch manager
        • All these will impact the performance of the CM requiring both additional CPU (helps with processing) to additional RAM (helpful for large EXM dispatches as each email is built in memory before being sent.)

Checkpoint 2: Experience Database (xDB)

The Experience Database commonly referred to as the ‘xDB’, is based on the NoSQL solution MongoDB. The xDB is the primary storage for all analytics information and the registry of contacts and engagement automation states. Both Content Delivery and Content Management servers talk to the xDB performing read and write actions against it.

Because data is written and read at high rates from the xDB as visitor’s sessions start and end requires a proper amount of RAM and high speed disk, such as SSD, to maximize performance.

Using MongoDB as your collection database, you should install plenty of RAM and use SSD drives. Sharding can also improve performance significantly. Read the documentation on the MongoDB website to learn about the MongoDB architecture, replication, sharding, and configuration options. (taken from xDB Hardware Guidelines)

Depending on the version of Sitecore running there are official supported MongoDB versions. This does not mean a newer/older version will not work with your version of Sitecore, but Paragon nor Sitecore can guarantee the behavior.

Sitecore XP 7.5 series Sitecore XP 8.0 Initial Release to Update 4 Sitecore XP 8.0 Update 5 and later Sitecore XP 8.1 and later Sitecore XP 8.2 and later
Mongo 2.6 mmapv1 Yes Yes Yes Yes Yes
Mongo 3.0 mmapv1 No No Yes Yes Yes
Mongo 3.0 Wired Tiger No No Yes Yes Yes
Mongo 3.2.1 mmapv1 No No No No Yes
Mongo 3.2.1 Wired Tiger No No No No Yes
Mongo 3.2.1 Enterprise with data-at-rest encryption (Wired Tiger only) No No No No Yes

For the latest supported version table see Sitecore’s documentation:

Sitecore recommends that MongoDB is setup in a replication architecture with sharding enabled. The minimum configuration is to run two full capacity MongoDB servers for data and a third lower capacity server to act as the arbiter. This third server would not need to handle any data in the basic configuration.

MongoDB can run on either Windows or Linux/Unix servers, as long as the proper version of MongoDB is used the Sitecore application does not care.

Additional Helpful references

EXM 3.4 Support for a Local MTA

With the release of Sitecore Email Experience Manager (EXM) 3.4, I felt the need to revisit my original post on configuring EXM for usage with a local mail transfer agent (MTA), as there have been some changes in the steps.

Sending through Sitecore

The default sending is through a product called ‘Sitecore Email Cloud’ which is uses a new third party service Spark Post. The basic steps for setting this up post install are

  1. Navigate to -> App_Config \ Include \ EmailExperience on the file system
  2. Remove ‘.disabled’ from
    • Sitecore.EDS.Providers.SparkPost.config.disabled
    • Sitecore.EDS.Providers.SparkPost.Sync.config.disabled
    • Spark Post Config Files
  3. Talk with your Sitecore Representative to confirm purchase and licensing of Sitecore Email Cloud. A new screen exists in EXM that helps you track your current licensing state.

    EXM Subscription Administration

Custom SMTP Sending

In previous versions of EXM you could setup the usage of a ‘Local MTA’ via the configuration of a single flag as well as a few Sitecore Setting fields. In the latest version, we now have to turn on a self-contained config file, Sitecore.EDS.Providers.CustomSMTP.config.

  1. Navigate to -> App_Config \ Include \ EmailExperience on the file system
  2. Remove ‘.disabled’ from
      • Sitecore.EDS.Providers.CustomSMTP.config.disabled
      • Sitecore.EDS.Providers.CustomSMTP.Sync.config.disabled
  3. Custom SMTP Config Files
  4. Next, we need to configure our SMTP connection for our MTA inside of Sitecore.EDS.Providers.CustomSMTP.config. Full documentation of all settings can be found at Custom SMTP Config Settings
<smtpSettings type="Sitecore.EDS.Core.Net.Smtp.SmtpSettings, Sitecore.EDS.Core" 
    <proxySettings ref="exm/eds/proxySettings" />
  1. To connect to Amazon’s AWS as I showed in the older post MTA Configuration in Sitecore, check this post out for steps to registering and setting up AWS. The basic patch file would be
<configuration xmlns:patch="">
    type="Sitecore.EDS.Core.Net.Smtp.SmtpSettings, Sitecore.EDS.Core" 
          <userName>SMTP Username as provided by AWS, 
            NOT your Amazon account usernameuserName>
          <password>SMTP Password as provided by AWS, 
            NOT your Amazon account passwordpassword>
          <proxySettings ref="exm/eds/proxySettings" />

Download from GIST

Custom SMTP Sync

Sending of emails is great, but if you want to see data collected from you custom SMTP you must also make some updates to the Sitecore.EDS.Providers.CustomSMTP.Sync.config file. This file controls the POP3 connection to gather data.

To see what needs to be configured see The EXM configuration settings.


Using the Custom SMTP is great for use in development and even testing environments, but strong consideration needs to be taken into account before rolling it out into production. One of the challenges of using a Custom SMTP, is the lack of full analytics collection that can occur. This is mostly due to the limited amount of information that can be retrieved via POP3. The other major challenge when using Custom SMTP in production is the additional configuration and management you must perform for DNS processing, blacklisting, etc…

Be for committing one way or the other in production be sure to review the differences as laid out by Sitecore in The Sitecore Email Cloud compared to the Custom SMTP.


Cleaning up log messages for Geo IP Location

Starting with Sitecore 8.1 Geo IP lookup services come pre-installed and configured. All a site owner than need to do is log into the App Center and purchase the service. This is great from an implementer standpoint this is great as it’s one less configuration step that we have to take.

On the downside, if the site owners never purchase the lookup service the log will quickly clutter with ERROR messages.

ManagedPoolThread #12 16:01:15 ERROR Failed to perform GeoIp lookup for dd4795c0-1dca-ea8d-93c4-06d7f7aa5063
Exception: System.Net.WebException
Message: The remote name could not be resolved: ‘’
Source: System
at System.Net.HttpWebRequest.GetResponse()
at Sitecore.CES.Client.WebClient.ExecuteRequest(String requestUri)
at Sitecore.CES.Client.ResourceConnector`1.Request(String endpoint, Object[] parameters)
at Sitecore.CES.Discovery.EndpointSource.GetEndpoint(String serviceName)
at Sitecore.CES.GeoIp.SitecoreProvider.GetInformationByIp(String ip)
at Sitecore.Analytics.Lookups.GeoIpManager.GetDataFromLookupProvider(GeoIpHandle geoIpHandle)

The Fix

The fix isn’t hard; all it requires is a simple patch config to disable the lookup service.

<configuration xmlns:patch="">
            <setting name="Analytics.PerformLookup">
                <patch:attribute name="value">false</patch:attribute>

For the full details on the lookup service checkout the full documentation at

Guide to Segments in xAnalytics

Quick Refresher: The business has asked the Sitecore team to provide additional reporting views for data already being collected by Experience Analytics. (To understand the full request take a look at the first part of the guide.

This post covers the final steps to using custom views on our data

Step 3: Create New Segment

Segments are used by Sitecore to show the summarization of a value (dimension) in context to a specific business question.

  • Launch the Marketing Control Panel from the Sitecore Launchpad
  • In the content tree, expand Experience Analytics -> Dimensions
  • Expand the grouping folder for your dimension
  • Right-click on the dimension, choose Insert from the context menu, and select Filter
  • In the dialog box, provide a Name for the filter. This will also be the name of the segment when it is shown on charts and tables. (It is possible to change the display name in the item’s properties)
  • Click OK, to close-out the Message Dialog box
    Guide to Segments in xAnalytics - Image One
  • Update the Name field to the text that will be shown on charts and tables. (This is optional, as it will auto-populate with the value entered at creation)
  • Click the Filter drop-down to select the filter that will set the conditions on the type of contact data that will be included
    Guide to Segments in xAnalytics - Image Two
  • Save your changes
  • For the segment to begin collecting data for reporting, it must be deployed. In the ribbon, click the Review tab
  • From the available options, click Deploy
    Guide to Segments in xAnalytics - Image Three

Once a new segment is created, there will be a 30 minute delay before any actions on the website are aggregated into the segment for reporting.

To allow historical data to aggregate into a recently created segment, you will need to rebuild the reporting database via https://your site/sitecore/admin/rebuildreportingdb.aspx. Before running the rebuild, you will want to update the Deploy Date column of the Segments table in your MS SQL reporting database. This will allow all of the data to be aggregated into the segment.

Step 4: Using the New Segment

Creating the segment to slice data can be done by more advanced Content Editors with access to the Marketing Control Panel section of the content tree. Sadly, by default, just because a segment is created, does not make it readily available on any existing tables or charts in xAnalytics.

  • Before adding the new segment to an existing table or chart, we need to open xAnalytics and identify where we would like to see our segment overlaid. For our sample segment, I’ve chosen the ‘Top entry Pages by Visits’ bar chart found on the Behavior -> Pages -> Entry Pages dashboard
    Guide to Segments in xAnalytics - Image Four
  • Launch the Sitecore Desktop from the launch pad
  • Once in the Sitecore Desktop, we need to switch which database we are working with. Sitecore artifacts that support the xAnalytics are kept in the Core database. Click the ‘hamburger menu icon’ in the bottom-right corner of the screen
  • A menu will display listing all databases of the system, click on Core
    Guide to Segments in xAnalytics - Image Five
  • Click the Sitecore Start icon in the bottom-left corner
    Guide to Segments in xAnalytics - Image Six
  • Click Content Editor from the options
  • Expand the content tree to / Sitecore / client / Applications / Experience Analytics / Dashboard / Behavior / Pages / Entry Pages / Page Settings
    • After Dashboard, you will need to drill into the page of the chart you plan to supplement. For my example, this would be the Entry Pages dashboard
    • The ‘Page Settings’ child item is where the Sitecore Artifacts are assigned as the data source for the charts and tables
  • Click the item that defines the table or chart you wish to change. For my example, this would be Top Entry Pages by Visits
  • In the Segments field, drill through the dimensions until you find your custom segment. Move it to the left by either double-clicking it or using the selection arrows
    Guide to Segments in xAnalytics - Image Seven
  • Save item, return to the launch pad and open xAnayltics. You should now see your segment listed as an option on the table or chart
    Guide to Segments in xAnalytics - Image Eight

As always, feel free to tweet me questions or comments @thecodeattic or on Sitecore Slack Community as @gillissm.

This post originally appeared at