Unicorn for Sitecore Setting up Separate Core/Master Database Serialization

After getting the Unicorn sync to work I wanted to have separate folders for the Core and Master database items. It will keep things organized much better that way IMHO. After researching an asking around in Slack I came up with the following solution.

First  based on the Unicorn.Configs.Default.example I created two new configs. Unicorn.Configs.Core.config and Unicorn.Configs.Master.config.

coremasterconfig

In each file I changed the configuration name and description. Also it is very important that you add an entry for the physicalRootPath. This will override the default path.

This is what I did for the Core database. You will notice that the path ends in \Core.

 <configuration name="SitecoreTestSiteCore" description="This is my Sitecore Test Site. I am testing Unicorn and syncing CORE only.">
 <targetDataStore physicalRootPath="C:\Projects\SitecoreTestSite\src\WebApplication1\WebApplication1\App_Data\Unicorn\Serilization\Core" type="Rainbow.Storage.SerializationFileSystemDataStore, Rainbow" useDataCache="false" singleInstance="true" />

This is what I did for the Master database. You will notice that the path ends in \Master.

 <configuration name="SitecoreTestSiteMaster" description="This is my Sitecore Test Site. I am testing Unicorn and syncing Master only.">
 <targetDataStore physicalRootPath="C:\Projects\SitecoreTestSite\src\WebApplication1\WebApplication1\App_Data\Unicorn\Serilization\Master" type="Rainbow.Storage.SerializationFileSystemDataStore, Rainbow" useDataCache="false" singleInstance="true" />

After Initialization I did a sync. Look it is a cool looking unicorn.

unicorn

Now I have two separate directories for Core and Master files.

coremasterdirectory

Let me know if you have any questions.

Unicorn for Sitecore and Version Control First Time Setup

After I got #Unicorn for #Sitecore setup for the first time I noticed the folders and yml files were created in my sites data folder. I want those files as part of my project and source controlled similar to TDS. So doing some research I found this setting in the Unicorn.config folder.

<targetDataStore
physicalRootPath=$(dataFolder)\Unicorn\$(configurationName)
useDataCache=false
type=Rainbow.Storage.SerializationFileSystemDataStore, Rainbow
singleInstance=true/>

I changed to my local folder in my project. I created two new folders under App_Data (Unicorn\Serialization).

<targetDataStore
physicalRootPath=C:\Projects\SitecoreTestSite\src\WebApplication1\WebApplication1\App_Data\Unicorn\Serilization
useDataCache=false
type=Rainbow.Storage.SerializationFileSystemDataStore, Rainbow
singleInstance=true/>

*Please note there is a Unicorn.CustomSerializationFolder.config.example that you can also change this setting in. Just remove the .example to use it.

When I went to [site]/unicorn.aspx I received the following error. If you receive this error either change the path to a smaller length or in my case I changed the value in App_Config\Include\Rainbow.config.

I changed this line:

<setting name=”Rainbow.SFS.SerializationFolderPathMaxLength” value=”103″ />

To

<setting name=”Rainbow.SFS.SerializationFolderPathMaxLength” value=”105″ />

Now after going back in to the Unicorn Control Panel I was able run an Initial Serialization. I had to do this since the folder path changed.

Then Sync Selected.

SitecoreTestSite sync complete: 1767 items evaluated, 0 items modified (0 added, 0 updated, 0 recycled) in 6331ms (~3.6ms/item).

Now back in my solution I show hidden files and folders and there are my files. I can then include them in my project.


So now you can make the files part of any source control sytem you are using. It is worth mentioning that there are other methods you can use like Sitecore Courier and Sitecore Ship. Also since projects are sometimes setup different locally for developers using something like slowcheetah might be a good idea to have your own development configuration for the Unicorn.config and Rainbow.config.

Update. In your publish settings I recommend checking the box that says Exclude files from the App_Data folder. You probably don’t want to publish those files.

localdeploy

Now I need to figure out how to sync someone else’s changes. I suspect it might be using the Publish Unicorn and Replace Unicorn from Server options.

Unicorn for Sitecore Setting up for the First Time

Most of my #Sitecore projects have been spent using packages and TDS to get Sitecore items updated. I was told recently about another tool and decided with a cool name like Unicorn I had to try it out. I like the name being that in my house at one point my kids believed Unicorns were real. I told them they are real, but Noah forgot to take them on the Arc with him. Anyhow let’s get started.

I started with following the documentation. It was straightforward.

https://github.com/kamsar/Unicorn/blob/master/README.md

How to get the Nuget package.

https://www.nuget.org/packages/Unicorn/

Included in the installation is a sample config file. You can copy it and change the extension from sample to config. I just kept it simple and named mine Unicorn.Configs.Default.config.

In the config file under the predicate section you can add paths here. You can see ones already defined with include tags. I just changed the stuff highlighted in yellow.

<configuration name=”SitecoreTestSite” description=”This is my Sitecore Test Site. I am testing Unicorn.“>

    <predicate type=”Unicorn.Predicates.SerializationPresetPredicate, Unicorn” singleInstance=”true”>

        <!–

            PREDICATE

                The predicate controls what items are included in the configuration.

                Each include can also exclude specific subitems in various ways. For a reference of the most current predicate grammar, consult the tests here:

                https://github.com/kamsar/Unicorn/blob/master/src/Unicorn.Tests/Predicates/TestConfiguration.xml

                NOTE: after changing what is included or excluded, you should reserialize all items, or at least the added items for additions.

                NOTE: the “name” attribute controls the folder name the items will go into. If unspecified, the last path segment is used. Names must be unique across the configuration.

                NOTE: You cannot use excludes with Transparent Sync. See https://github.com/kamsar/Unicorn/wiki/The-Transparent-Sync-Guide

        –>

                <include name=”Layouts” database=”master” path=”/sitecore/layout/Layouts/ ” />

                <include name=”Templates” database=”master” path=”/sitecore/templates/” />

                <include database=”master” path=”/sitecore/system/Languages” />

                <include database=”master” path=”/sitecore/system/Tasks”>

                    <exclude path=”Schedules” />

                </include>

                <include database=”master” path=”/sitecore/system/Workflows” />

                <include database=”master” path=”/sitecore/system/Settings” />

                <include database=”master” path=”/sitecore/content/”></include>

            </predicate>

After publishing your site just go to http://[Your Site Goes Here]/unicorn.aspx. You will see a message about not having any valid serialized items and to do an initial serilization.

No problem. The developers included a button to click to do the initial serialization.

After clicking the button the following came up.

Now I get the following option.

Clicking on the checkbox you get a Sync Selected and Reserialize Selected option.

After clicking on Sync Selected. An awesome Unicorn appears with messages below.

Now in my data directory I can see Unicorn created folders and within those folders are yml files (more about these types of files https://rhnh.net/2011/01/31/yaml-tutorial/).

On a side note. I installed a Unicorn utility that caused a dll version issue. So I had to copy back some files to get it to work again. So if you run into this issue make sure all the file versions are the latest even the MicroCHAP dll.

So that is it for now. As I use this more on projects I will blog about it some more. Let me know if you have any questions. Thanks.

Attaching to Sitecore Sites with Smart Debug Attacher

I’m sure everyone has a set of tools they use for speeding up debugging. One of my favorites to use is the Smart Debug Attacher.

You can find the Visual Studio extension here.

It is very easy to use. After you install it you will see the following on the Visual Studio tool bar:

If you haven’t used it before and attached to a process you will see the following message. Just click OK.

The following display appears. Simply find the process you want to attach to,select it and then double click. Then click on the Attach button. Visual Studio will then attach to the process and go into debug mode.

The nice thing about this tool is that you can see the app pool so if you have several sites you can attach to the correct one. It will also remember what you attached to last time so you don’t have to keep selecting the process you want to attach to.

So does anyone else have a good tool for debugging?

xGenerator is Installed in Sitecore Now What?

So after installing xGenerator for #Sitecore I started poking around to see what changed and to check out the xGenerator interface. This blog is more for seeing what gets installed and getting started. As I work with xGenerator more I will blog about its features.

After the installation in content editor you can see different items that were installed.

After the installation I noticed some new things on the LaunchPad.

Clicking on the Experience Generator I get the following tabs.

I’m still learning what each tab does. One of the tabs I tried was the Landing Pages tab. By clicking on the Add landing page button an explorer window popped up. In this case I just chose the home page.

Once you make changes to any tabs you can save your settings on the lower right. You can also select and load your presets again.

Clicking on the Profile Experience Generator I get the following screen. Looks like a way you can setup different contacts.

The xGenerator tool looks to be a very powerful testing helper. I am going to keep looking at all the features of xGenerator and get some things set up. I will blog about what I find. If anyone knows the original author of it I would like to have a conversation with him and get a general overview.

xGenerator Introduction and Installing

Recently I was given the task of installing xGenerator for a #Sitecore site. I haven’t used this tool before so I started doing some research on it. It is a great testing for creating realistic traffic for your Sitecore site. I found that you can download the code in GitHub. I didn’t find an installation package, but the code contains a package definition that you can use to create a package with Sitecore Rocks.

I got the code from here:

https://github.com/Sitecore/xGenerator

I followed the instructions here https://github.com/Sitecore/xGenerator/blob/master/src/Build%20instructions.txt. After following the steps and publishing I noticed I was getting a lot of version errors on my local Sitecore test site. The mistake I made was that my site was version 8.1, but the code was for version 8.2. So I had to go back and get a version pre 8.2. I went to the releases page. https://github.com/Sitecore/xGenerator/releases. I ended up downloading the nightly commit. For some reason the download that came after that was still 8.2. Maybe I overlooked something. In any case the nightly commit worked.

So after redoing the steps in the build instructions I was able to publish to my Sitecore site and get it to work. Building the package was easy.

I already have Sitecore Rocks installed so I double clicked on the package.

Sitecore Rocks brings up a connection window. You just need to connect to the instance of where you installed the xGenerator updates with Unicorn.

Now you can easily generate and download a package.

Just for my own piece of mind I created a new 8.1 site and installed the package. Just to make sure it worked. It did and I was off and running. I want to play around with this tool more and get familiar with it. Stay tuned for another blog on xGenerator in the future.

Sitecore Rocks Visual Studio Creating View Rendering

One of the nice time savers of Sitecore Rocks is creating a view and the matching #Sitecore rendering at the same time.

Right click on the folder you want to create the new view for and select New Item.

You have many options to select from, but in this case I will select Sitecore View Rendering.

A Sitecore explorer window displays and you will be prompted to select a place where you want to create the rendering. Click OK once you select the folder.

In solution explorer you can now see the cshtml file and in Sitecore you can see the corresponding rendering.

Code Generated:

@using Sitecore.Mvc

@using Sitecore.Mvc.Presentation

@model RenderingModel

@{

}

<div>

div>

This is just one of the shortcuts you can do. I will blog about some more. Let me know what other ones you would like to see.

Field Ordering When Inheriting Sitecore Templates

I have come across this many times before. I will have a base #Sitecore template that is inherited by another template. The fields from both templates are combined in one section. The content editor though wants the order of the fields changed. That is easy to do if the fields are from the same template, but it is not so easy to do it when the fields are from two different #Sitecore templates. I will show you an easy workaround though to get the correct order.

In my example I have a ProductBase template that has a Description field. The Product template inherits from this template so it will have the Description field.

This is what the current product item looks like. As you can see it is currently in the default alphabetical order. What if though the content editor wants the Description under the Name?

In order to have the fields reordered you will need to go to your main template. Select the field you want to reorder and navigate to the Appearance section and then the Sortorder field. Sitecore usually numbers their fields starting at 100, 200, 300 and so on. So in this case we want Name on the top. Giving it a -100 value in the Sortorder field will make it automatically be the top field since it will then be displayed before 100.

As you can see the order has now changed and the content editor will be able to edit in their preferred order.

This was a simple example. For more multiple field reorders changing the Sortorder fields with different values will take a little more of playing with the value, but the concept will be the same. I suggest never changing the Sortorder on a base template. The reason being is that for other templates they may want a different order and it would be the same for all templates that inherit the base template and/or will make it difficult to reorder your main template. Let me know if you have any questions.

Sitecore Rocks Query Analayzer

One of the features I like about Sitecore Rocks is the built in the query analyzer. This has speed things a long when I needed to create simple queries or test some more complex ones. To use the query analyzer is very simple.

Right click on an item and select Tools|Query Analyzer.

This is the screen that appears. Notice on this screen there is also a link to a XPath builder if that is what you prefer.

Simple query, but I like that you can use syntax like T-SQL. You will need to convert it to XPath syntax though if you are using this Sitecore query in your code. Please not the Insert Path and Insert Field links. Those are great shortcuts for building your queries.

So that is the simple overview of the query analyzer. Let me know if you have any questions thanks.

Quick Template Creation Options Sitecore Rocks Continued

I wanted to show you a few more things that you might find useful when creating/editing templates with Sitecore Rocks.

Standard Values

  • Simply right click on the template and select standard values.


  • Once standard values are created you have all the options and more in one place to set for the template.


Insert Options

  • Parent templates are not complete without insert options. Insert options are easy to set in Sitecore Rocks.


  • Using the search function you can find the template(s) you want for an insert option.


Design Layout

  • After you have your template set adding a design layout is very simple.


  • You can select a main layout first and then after that you have the option to drag a rendering from the Sitecore Rocks explorer or simply click the Add Rendering button.


So those are some more of the basic things you can do with templates and Sitecore Rocks. Please let me know if there is something else you would like to see.