Sitecore Space - 사이트코어

2019년 5월 29일 수요일

API를 사용하여 Datasource를 생성하고 페이지 레이아웃 업데이트하기 [Part 3]

이번 포스트는 API를 사용하여 렌더링 아이템의 Datasource를 생성한 Implementaion의 추가로써, xEditor에서 Datasource를 생성하고 페이지에 저장 및 Apply를 조금 더 효율적으로 할수있는 팁을 알아보자.
우린 Datasource 생성 버튼을 클릭하여 메인 소스를 만들었지만, 추가적으로 필드 에디터 버턴을 생성하여 Content Editor를 Dialog Popup 형식으로 xEditor 띄워 필드정보를 수정할수있다.
데이타소스의 필드정보 업데이트는 "webedit:fieldeditor" 커맨드를 통하여 실행할 수 있지만, "webedit:componentoptions"처럼 Content Editor 팝업에서 "OK" 버튼을 클릭할시 자동저장 (autosave) 기능이 없다.

"webedit:fieldeditor" 커맨드는 Sitecore의 Content Manager 어플리케이션의 FieldEditorPage 클래스를 호출하며 우리는 간단한게 "FieldEditor.aspx" 페이지에 Javascript을 추가하여 Auto-Saving을 적용할것이다. 추후 "componentoptions" 커맨드처럼 기능이 추가될지 모르겠으나, 이 업데이트는 Sitecore 버전 9.1 (현재 가장 최근 버전) 및 하위 버전까지 모두 적용되어질수 있다.

자, 이제 렌더링 아이템의 데이터소스 필드를 xEditor에서 손 쉽게(?) 수정하는 방법과 업데이트 되어진 Field값을 자동저장하는 방법에 대하여 알아보도록 하겠다.

우선, 해당 경로의 FieldEditor 파일을 오픈하고, 아래의 자바스크립을 추가한다.

"\sitecore\shell\Applications\Content Manager\FieldEditor.aspx"

<script type="text/javascript">
    var p = parent.parent;
    var iframes;
    try {
        iframes = p.jQuery('#jqueryModalDialogsFrame').contents().find('.ui-dialog');
    } catch (e) { }
    if (p && typeof iframes != 'undefined' && iframes.length == 1) {
        var footerRow = document.getElementById("FooterRow");
        var inp = footerRow.getElementsByTagName("input");
        var btn;
        for (i = 0; i < inp.length; i++) {
            if (inp[i].value == "OK") {
                if (p.autoSaveItems != false) {
                    btn = inp[i];
                    btn.setAttribute("onclick", "javascript:return ClickAndSave()");
                }
                break;
            }
        }
    }
    function ClickAndSave() {
        if (p.Sitecore.PageModes.PageEditor.isModified()) {
            p.Sitecore.PageModes.PageEditor.postRequest("webedit:save", function() { p.onbeforeunload = null; }, false);
        }
        scForm.invoke("contenteditor:saveandclose");
        p.Sitecore.PageModes.PageEditor.postRequest("webedit:saved", function() { p.location.reload(); }, true);
    }
</script>

아래는 업데이트 되어진 VIEW (RichTextEditor.cshtml)이다.

@model Sitecore.Custom.Component.Models.RichTextEditor
@if (!Model.IsDatasourceSet && Sitecore.Context.PageMode.IsExperienceEditor)
{
    <div style="padding:20px 0;" class="border border-success">
        <h4>RichText Editor Added</h4>
        <button type="button" class="btn btn-success" onclick="SendAjaxPOST(); return false;">Create Rich Text Editor Datasource</button>
        <script>
        function SendAjaxPOST() {
            if (Sitecore.PageModes.PageEditor.isModified()) {
                alert("There are unsaved items on this page.\rPlease save the page, then create a new datasource.");
                return false;
            }
            var xhr = new XMLHttpRequest();
            xhr.open("POST", "http://sc910.sc/customapi/createitem/@Model.PageItem.ID.Guid.ToString()");
            xhr.setRequestHeader("Content-Type", "application/json");
            xhr.send("{\"itemName\": \"@Model.NewItemName\", \"templateGuid\": \"@Model.RteTemplate.ID.Guid.ToString()\", \"isDatasourceItem\": \"1\", \"renderingUid\": \"@Model.Rendering.UniqueId.ToString()\"}");
            xhr.onreadystatechange = function () {
                if (this.readyState == 4) {
                    if (this.status === 200) {
                        window.onbeforeunload = null;
                        this.returnValue = true;

                        setTimeout(function () { location.reload() }, 500);
                    } else {
                        console.log('Error Status: ' + this.status + '\nHeaders: ' + JSON.stringify(this.getAllResponseHeaders()) + '\nBody: ' + this.responseText);
                    }
                }
            };
        }
        </script>
    </div>
} else if (Sitecore.Context.PageMode.IsExperienceEditor) {
    <div style="border-bottom: solid 1px grey;">
        <button type="button" class="btn btn-warning" style="margin-bottom: 5px;" onClick="updateRTEStyle()">Update Style</button>
    </div>
    <div style='@Model.Rendering.Item.Fields["Custom CSS"].Value'>@Html.Sitecore().Field("Content")</div>
    <script>
        function updateRTEStyle() {
            Sitecore.PageModes.PageEditor.postRequest(
                "webedit:fieldeditor(" +
                    "command={11111111-1111-1111-1111-111111111111}, " + 
                    "fields=Custom CSS, " + 
                    "id=@(Model.RenderingDatasource))"
                );
        }
    </script>
} 
else
{
    <div style='@Model.Rendering.Item.Fields["Custom CSS"].Value'>@Html.Sitecore().Field("Content")</div>
}

아래는 최종적으로 업데이트 되어진 화면이며, ContentEditor 팝업박스의 OK 버턴을 누르면 자동으로 업데이트되고 xEditor가 Reload 되는것을 볼수가 있다.

2019년 4월 11일 목요일

사이트코어 대쉬보드의 Custom Analytics 패널 숨기기

사이트코어 Experience Analytics(xA)는 User Experience를 다이나믹하게 분석 및 수집을 할뿐 아니라 수집되어진 정보를 통하여 마케팅의 목족으로 다양하게 Customize하여 사용할수있다. xA의 대쉬보드를 엑세스하면 웹사이트 방문자들의 정보를 다양하게 분석하고 최적화하여 차트 통계를 제공한다.

xA의 접근은 아래 리스트(v9.1.0 기준) 처럼 마테팅 및 분석과 관련된 사이트코어 펄밋이 필요하다. 이는 Makerting Control Panel을 통하여 새로운 마케팅 캠페인, 목표 (Goal), Profile 및 Asset 등을 설정하여 다양하게 방문자 정보를 수집한다.

sitecore\Analytics Advanced Testing
sitecore\Analytics Content Profiling
sitecore\Analytics Maintaining
sitecore\Analytics Management Reporting
sitecore\Analytics Personalization
sitecore\Analytics Reporting
sitecore\Analytics Testing
sitecore\Marketing Automation Editors
sitecore\EXM Advanced Users (이메일 캠페인)
sitecore\EXM Users (이메일 캠페인)

사이트코어 관리자 입장에서 새로운 유저를 등록하고 유저타입에 상응하는 Permit을 주는데 있어서 굳이 Non-Marketing 유저에게 xA 정보 및 엑세스 권한을 부여할 필요는 없다. 이는 해당 유저에게 xA와 관련된 Role을 부여하지 않으면 되지만, 유저는 Sitecore 메인 대쉬보드에서 Custom Analytics라는 통계 프리뷰를 볼수가 있다. 이 패널의 뷰는 기본값으로써 권한에 관계없이 모든 사이트코어 CMS유저에 보여진다. 사이트코어 관리자 및 Stakeholder의 입장에서는 CMS유저 및 서비스를 제공하고 Client 유저에게 얼마나 많은 사용자가 웹사이트를 방문했고 그의 Value가 얼마나 되는지 정보를 제공할 필요는 없다. 이번 포스트에서는 Core DB에 접근하여 쉽게 Custom Analytics 패널을 Disable하도록 하자.

CMS 로그인 후, Desktop 뷰 또는 QueryString을 업데이트하여 Core DB로 이동
"/sitecore/client/Applications/ExperienceAnalytics/Shared/LaunchPad/Parameters" 이동
Parameters 트리안에는 "Interactions by visits and value per visits Parameters" 와 "Top five campaigns by visits Parameters" 차트 렌더링 아이템이 존재한다.
해당 아이템에서 "IsVisible" 값을 Uncheck하고 저장한다.
CMS의 Master DB로 이동 후, Dashboard를 Refresh하면 Custom Analyze의 패널이 없어진것을 확인할수있다.

2019년 3월 22일 금요일

API를 사용하여 Datasource를 생성하고 페이지 레이아웃 업데이트하기 [Part 2]

이전 포스트의 API를 사용하여 데이타소스(DS) 아이템을 만드는 방법에 이어서 이번에는 어떻게 API를 컴포넌트에 적용시키는지 알아보도록 하자. 필자는 아주 심플한 RichText Editor 컴포넌트를 만들었고, 컴포넌트 내에 API를 XMLHttpRequest를 통하여 Ajax Call을 실행하였다.

페이지 아이템의 xEditor에서 API를 이용하여 DS를 생성할시 아이템은 아래의 스크린샷처럼 하위경로의 DS폴더안에 생성된다.

해당 DS를 다른 페이지에서 재사용 할 경우 페이지 구조상으로 문제가 될수 있지만, 필자는 API를 컴포넌트에서 쉽게 사용하는 방법의 목적의 예제이므로 컨턴츠 구조 문제는 다루지 않겠다. 아래는 Controller Rendering의 RichText Editor 컴포넌트이다.

CustomComponentController.cs (Controller)

using Sitecore.Mvc.Controllers;
using Sitecore.Mvc.Presentation;
using System;
using System.Web.Mvc;
using Sitecore.Data;

namespace Sitecore.Custom.Component.RichTextEditor
{
    public class CustomComponentController : SitecoreController
    {
        /// <summary>
        /// RichText Editor의 Action Method
        /// </summary>
        /// <returns>ActionResult</returns>
        public ActionResult RichTextEditor()
        {
            Models.RichTextEditor rte = new Models.RichTextEditor();
            rte.PageItem = PageContext.Current.Item;
            rte.Rendering = RenderingContext.CurrentOrNull.Rendering;
            rte.RenderingDatasource = rte.Rendering.DataSource;

            // 레이아웃에 적용되어진 RTE 컨트롤에 데이타소스가 적용되었는지 확인한다.
            rte.IsDatasourceSet = (!String.IsNullOrEmpty(rte.RenderingDatasource) ? true : false);

            // 새로운 데이타소스 아이템의 이름을 선업한다.
            rte.NewItemName = rte.PageItem.Name + "_" + rte.DatasourceItemSuffix;

            // RTE DS의 템플릿을 선언한다.
            rte.RteTemplate = rte.PageItem.Database.GetTemplate(new ID("{0B57D07C-F406-4700-9CAC-D4C4B84D1B78}"));

            return PartialView(rte);
        }
    }
}

RichTextEditor.cs (Model)

using Sitecore.Data.Items;
using Sitecore.Mvc.Presentation;

namespace Sitecore.Custom.Component.Models
{
    public class RichTextEditor
    {
        // Initialize component's rendering info
        public Item Item { get; set; }
        public Item ResourceFolder { get; set; }
        public Rendering Rendering { get; set; }
        public TemplateItem RteTemplate { get; set; }
        public string NewItemName { get; set; }
        public string DatasourceItemSuffix { get { return "RTE"; } }
        public string RenderingDatasource { get; set; }
        public Item PageItem { get; set; }
        public bool IsDatasourceSet { get; set; }
    }
}

RichTextEditor.cshtml (Views)

@model Sitecore.Custom.Component.Models.RichTextEditor
@if (!Model.IsDatasourceSet && Sitecore.Context.PageMode.IsExperienceEditor)
{
    <div style="padding:20px 0;" class="border border-success">
        <h4>RichText Editor Added</h4>
        <button type="button" class="btn btn-success" onclick="SendAjaxPOST(); return false;">Create Rich Text Editor Datasource</button>
        <script>
            function SendAjaxPOST() {
                // 현재 페이지에서 다른 아이템 및 필드가 수정되었는지 확인한다.
                if (Sitecore.PageModes.PageEditor.isModified()) {
                    alert("There are unsaved items on this page.\rPlease save the page, then create a new datasource.");
                    return false;
                }

                // XHR 시작
                var xhr = new XMLHttpRequest();
                xhr.open("POST", "http://sc910.sc/customapi/createitem/@Model.PageItem.ID.Guid.ToString()");
                xhr.setRequestHeader("Content-Type", "application/json");
                xhr.send("{\"itemName\": \"@Model.NewItemName\", \"templateGuid\": \"@Model.RteTemplate.ID.Guid.ToString()\", \"isDatasourceItem\": \"1\", \"renderingUid\": \"@Model.Rendering.UniqueId.ToString()\"}");
                xhr.onreadystatechange = function () {
                    if (this.readyState == 4) {
                        if (this.status === 200) {
                            window.onbeforeunload = null;
                            this.returnValue = true;

                            setTimeout(function () { location.reload() }, 500);
                        } else {
                            console.log('Error Status: ' + this.status + '\nHeaders: ' + JSON.stringify(this.getAllResponseHeaders()) + '\nBody: ' + this.responseText);
                        }
                    }
                };
            }
        </script>
    </div>
}
else
{
    <div>@Html.Sitecore().Field("Content")</div>
}

해당 컴포넌트를 사이트코어 페이지에 적용하고 실행하면 ContentEditor 와 xEditor의 페이지 이동 및 확인없이 쉽게 데이타소스를 생성할수있다. 이는 Non-Technical 유저 입장에서 쉽게 페이지를 생성하고 데이터소스를 다이나믹하게 생성하는데 도움이된다.

2019년 2월 26일 화요일

API를 사용하여 Datasource를 생성하고 페이지 레이아웃 업데이트하기 [Part 1]

이번 포스트에서는 Non-Technical 사이트코어 Author 또는 Contributor를 타켓으로 하여 어떻게 xEditor에서 아이템을 생성하고 페이지에 적용을 시키는지에 알아보도록 하자. 필자는 새로운 API를 생성하여 XMLHttpRequest를 통하여 아이템을 생성하는 방법을 택하였다.

새로운 API를 생성하기 전, 페이지 아이템 및 데이터소스 구조를 정하여야 한다. 각 컴퍼니 또는 비지니스의 컨셉, 그리고 웹사이트의 수에 따라 아이템 스트럭쳐는 다양하게 변경되어있을 수 있으므로 이번 예제에서는 어떻게 사이크코어의 사용자가 렌더링 아이템을 적용 시키고 그에 맞는 데이타소스를 손쉽게(?) 적용할수 있도록 포커스를 두었다. 이는 경우에 따라 언제든지 확장 및 수정이 가능할수 있다.

아래는 기본적으로 유저가 렌더링 아이템을 적용하고 데이타소스를 생성하여 페이지 레이아웃에 적용하는 순서이다.

업데이트를 하고자 하는 페이지 아이템으로 이동
Content Editor에 원하는 경로에 컴포넌트의 데이터소스 생성한다.
xEditor로 이동 후, 적용되어진 Placeholder에 컴포넌트를 Insert한다.
적용 되어진 컴포넌트의 속성을 열어, 데이터소스 아이템을 Datasource 필드에 적용을 시킨다.

아래의 API를 통하여 컴포넌트와 관련된 아이템을 페이지에 적용하는 방법이다.

업데이트 하고자 하는 아이템의 xEditor 오픈
Placeholder에 원하는 컴포넌트 Insert
생성되어진 Input 버튼 (One-Click)을 통하여 컴포넌트의 데이터소소를 정해진 경로에 생성

필자의 방법처럼 API를 사용하여 아이템을 생성과 동시에 Layout에 데이터소스를 적용하면 Content Editor 와 xEditor의 변경 없이 손쉽게 누구나 페이지에 컴포넌트 및 그에 맞는 데이터소스를 적용시킬수가 있다. 좀 더 자세히 알아보기 위하여 필자는 아래의 샘플 소스를 작성하였다.

먼저 새로운 Route을 적용 시키고 "CreateItem" 이라는 API 액션을 생성하도록 하자.

필자는 API라는 새로운 프로젝트를 만든 후, RouteMap을 "{controller}/{action}/{id}" 으로 설정하고 CustomApiController와 Api 모델을 생성하였다. Controller에는 새로운 아이템을 생성하는 ActionResult와 페이지 아이템 하위의 데이터소스폴더 및 생성되어진 데이타소스의 키를 업데이트할수 있는 레이아웃 업데이트 Method도 같이 생성하였다.

CustomApiController.cs

using System.Web.Mvc;
using Sitecore.Data.Items;
using Sitecore.Data;
using Sitecore.Globalization;
using Sitecore.SecurityModel;
using Sitecore.Layouts;

namespace Sitecore.Custom.Component.API.Controllers
{
    public class CustomApiController : Controller
    {
        Database masterDb = Configuration.Factory.GetDatabase("master");
        Database webDb = Configuration.Factory.GetDatabase("web");

        /// <summary>
        /// 새로운 ResourceFolder 페이지 아이템 하위에 생성한다.
        /// 해당 페이지 아이템과 관련된 모든 컴포넌트의 데이타소스는 
        /// 페이지 하위 ResourceFolder에 모두 생성된다.
        /// </summary>
        /// <param name="api">api</param>
        /// <param name="parentItem">ResouceFolder가 만들어진 상위의 페이지 아이템</param>
        /// <returns></returns>
        public Item CreateResourceFolder(Models.Api api, Item parentItem)
        {
            var localResourceFolder = parentItem.Database.GetItem(parentItem.Paths.FullPath + "/" + api.localResourceFolderName);
            using (new SecurityDisabler())
            {
                TemplateItem template = parentItem.Database.GetTemplate("User Defined/Local Resource Folder");
                if (localResourceFolder == null)
                {
                    localResourceFolder = parentItem.Add(api.localResourceFolderName, template);
                }
            }
            return localResourceFolder;
        }

        /// <summary>
        /// 생성되어진 Datasource Item의 ID아이디를 페이지 레이아웃에 업데이트한다.
        /// </summary>
        /// <param name="pageItem">현재 페이지 아이템</param>
        /// <param name="datasourceItem">새로운 데이타소스 아이템</param>
        /// <param name="renderingUid">렌더링 아이템의 유니크 아이디</param>
        public void UpdateDatasourceKey(Item pageItem, Item datasourceItem, string renderingUid)
        {
            using (new SecurityDisabler())
            {
                // Get the layout definitions and the device
                string deviceId = Context.Device.ID.ToString();
                DeviceItem device = pageItem.Database.Resources.Devices[deviceId];
                Data.Fields.LayoutField layoutField = new Sitecore.Data.Fields.LayoutField(pageItem.Fields[Sitecore.FieldIDs.FinalLayoutField]);
                LayoutDefinition layoutDefinition = LayoutDefinition.Parse(layoutField.Value);
                DeviceDefinition deviceDefinition = layoutDefinition.GetDevice(device.ID.ToString());
                foreach (RenderingDefinition rd in deviceDefinition.Renderings)
                {
                    // Update the renderings datasource value accordingly 
                    if (rd.UniqueId == "{" + renderingUid.ToUpper() + "}")
                    {
                        rd.Datasource = datasourceItem.ID.ToString();
                        // Save the layout changes
                        pageItem.Editing.BeginEdit();
                        layoutField.Value = layoutDefinition.ToXml();
                        pageItem.Editing.EndEdit();
                    }
                }
            }
        }

        /// <summary>
        /// 새로운 아이템을 정해진 템플릿에 맞게 생성한다
        /// </summary>
        /// <param name="itemName">새로운 아이템을 이름</param>
        /// <param name="id">{id}에 생성될 다이나믹 아이디</param>
        /// <param name="templateGuid">새로운 아이템의 템플릿 Guid</param>
        /// <param name="isDatasourceItem">현재 생성될 아이템이 데이타소스인지 확인 (Default: false)</param>
        /// <param name="renderingUid">레이아웃에 업데이트 되어진 렌더링 아이템의 유니크 아이디</param>
        /// <returns></returns>
        public ActionResult CreateItem(string itemName, string id, string templateGuid, string isDatasourceItem = "0", string renderingUid = null)
        {
            Models.Api api = new Models.Api();

            using (new LanguageSwitcher("en"))
            {
                Item pageItem = masterDb.GetItem(ID.Parse(id));
                // 새로운 데이타소스가 생성되었다면, 레이아웃을 업데이트한다

                if (isDatasourceItem == "1")
                {
                    api.item = CreateResourceFolder(api, pageItem);
                }
                api.templateItem = masterDb.GetTemplate(ID.Parse(templateGuid));
                Item newDatasource = api.item.Add(itemName, api.templateItem);

                // 새로운 데이타소스가 생성되었다면, 레이아웃을 업데이트한다
                if (isDatasourceItem == "1" && newDatasource != null)
                {
                    UpdateDatasourceKey(pageItem, newDatasource, renderingUid);
                }
            }
            return new EmptyResult();
        }
    }
}

Api.cs

using Sitecore.Data.Items;
using Sitecore.Data;

namespace Sitecore.Custom.Component.API.Models
{
    public class Api
    {
        public string actionType { get; set; }
        public Item item { get; set; }
        public Database sourceDb { get; set; }
        public Database targetDb { get; set; }
        public TemplateItem templateItem { get; set; }
        public string localResourceFolderName {
            get
            {
                return "Local Resource";
            }
        }
    }
}

API는 준비되었으므로 다음 포스트에서 심플한 컴포넌트를 만들어 API를 xEditor에서호출하여 보자.

2019년 1월 15일 화요일

사이트코어 Federated Authentication - Azure AD Workflow

이전 포스트에서는 Sitecore Federated Authentication을 사용하여 어떻게 Azure AD를 컨넥하고 유저정보를 인증하는지 그리고 어떻게 Customize한 코드를 적용하는지에 대하여 알아보았다.
이번에는 조금 더 디테일하게 접근하기위하여 필자는 유저의 이벤트 Request부터 시작하여 어떻게 Azure AD를 통하여 사이트코어 로그인을 성공하는지에 대하여 Workflow를 그려보았다.

순서부터 설명하자면,

유저는 Authentication 버튼이 생성되어진 로그인 페이지로 이동한다.
개발자의 의해 Customize되어진 사이트코어 Pipleline을 통하여 등록되어진 Microsoft Identity Server로 이동한다.
MS 로그인페이지에서 유저 이메일 및 암호를 입력하고 로그인을 시도한다.
MS Identity Server는 사이트코어 Pipeline를 통하여 받은 정보와 유저의 로그인 정보를 통하여 Azure AD로 이동한다.
유저정보가 Azure AD에 등록 또는 이용가능한 정보인지 검증한다.
검증이 확인되면 다시 MS Identity Server로 이동 후, 유정정보를 이용하여 Unique한 Token을 생성한다.
사이트코어는 생성된 Token과 함께 유저정보를 사이트코어 Pipeline에 보낸다.
사이트코어 Pipeline 및 설정에 등록된 Claims에 따라 유저정보 및 프로파일을 업데이트 한다.
유저는 사이트코어 Dashboard로 이동하여 사이트코어 CMS를 이용한다.

2018년 12월 4일 화요일

사이트코어 퍼블리쉬 서비스 (Sitecore Publishing Service) 설치하기

사이트코어 퍼블리슁 서비스 (Sitecore Publishing Service)는 대량의 아이템 퍼브리쉬를 실행할때, 사이트코어의 웹서버를 이용하지 않고 별개의 퍼브리쉬용 웹서버를 만들어 High Performance의 퍼블리쉬를 실행한다.
이는 사이트를 퍼브리슁하는데 속도를 높일뿐 아니라 퍼블리쉬 상태 및 결과를 Dashboard를 통하여 쉽게 확인할수가 있다.

이번에는 어떻게 퍼블리슁 서비스를 설치하고 사용하는지 알아보자.
필자는 사이트코어를 Azure PaaS로 사용하므로 퍼블리쉬 서비스의 웹호스팅을 Azure에 새로운 VM를 만들어 IIS를 설치하고 Publishing Service Provider를 생성하였다.

Sitecore Publishing Service (SPS) 다운로드
SPS를 설치할 서버로 이동 후, .NET Core 프레임웍을 설치하고 Window Server Hosting을 설치한다.
SPS를 설치할 컴퓨터 또는 환경으로 이동 후, IIS를 설치하고 다운받은 SPS를 "C:\inetpub\wwwroot\sitecorepublishing" 경로에 압출을 푼다.
IIS의 Application Pools에서 새로운 Application Pool를 생성한다.
*필자는 SitecorePublishProd라고 이름을 지었다.
IIS의 Sites 트리에서 새로운 사이트를 추가하고, 등록한 Application Pool을 사이트에 적용한다.
등록되어진 사이트에 "IIS AppPool\SitecorePublishProd"에 READ, EXECUTE, WRITE의 권환을 준다.
만약 다른 로컬 사이트가 적용중이라면 사이트 Binding을 업데이트하고 정상적으로 사이트가 작동되는지 그리고 다른 등록되어지 도메인이름이 있는지 "C:\Windows\System32\drivers\etc\"에서 확인한다.
*필자의 경우 해당 VM에는 SPS만 존재하므로, 로컬호스트 기본 경로를 사용한다.

"C:\inetpub\wwwroot\SitecorePublishingProd\config\global" 의 경로로 이동하여 아래의 설정처럼 해당 Master, Web, Core 데이타베이스의 정보를 입력하고 반드시 "MultipleActiveResultSets=True" Attribute을 추가한다.

<Settings>
    <Sitecore>
        <Publishing>
            <ConnectionStrings>
                <Master>user id={userId};Password={Password};Data Source={Datasource};Database={my-sitecore-master-db;MultipleActiveResultSets=True;</Master>
                <Web>user id={userId};Password={Password};Data Source={Datasource};Database={my-sitecore-web-db;MultipleActiveResultSets=True;</Web>
                <Core>user id={userId};Password={Password};Data Source={Datasource};Database={my-sitecore-core-db;MultipleActiveResultSets=True;</Core>
            </ConnectionStrings>
        </Publishing>
    </Sitecore>
</Settings>

사이트 설정을 마쳤으면 Host Service의 데이타베이스 엑세스가 필요하고 SPS의 필요한 데이타베이스를 추가적으로 설치하여야 하므로, "C:\inetpub\wwwroot\sitecorepublishing" 경로로 이동 후 아래의 커맨드를 Command Prompt를 통하여 실행한다.

Microsoft Windows [Version 10.0.14393]
(c) 2016 Microsoft Corporation. All rights reserved.

C:\inetpub\wwwroot\SitecorePublishingProd>Sitecore.Framework.Publishing.Host schema upgrade --force

Schema 업데이트가 끝나고, 사이트코어의 데이타베이스를 확인하면 추가적으로 생성된 테이블을 확인할수가 있다.
IIS 세팅과 Schema 업데이트를 마친 후, 브라우저를 열고 "http://localhost/api/publishing/operations/status"로 이동하여 결과가 "{"Status" : 0}" 나오면 SPS설치는 성공적으로 완료된것이다.
SPS 웹호스트 설치는 마쳤으므로, 이젠 사이트코어 CMS로 이동 후 Sitecore Publishing Service Module를 다운받고 Installation Widzard를 통하여 설치한다.

설치가 완료되면 사이트코어와 SPS 웹호스팅을 연결하기 위하여 아래의 Patch 파일을 만들고, "App_Config/Include/" 폴더에 파일(예, z.PublishingService.config) 파일을 추가한다.
*필자의 경우 SPS 웹호스팅을 사이트코어 서버가 아닌 다른 서버에 설치하였으므로 localhost 대신 서버의 아이피 주소를 입력하였다.

<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
    <sitecore>
        <settings>
            <setting name="PublishingServiceUrlRoot">http://123.123.123.123/</setting>

  </settings>

    </sitecore>
</configuration>

모든 설치가 완료되었으며 이젠 사이트코어에 접속하여 대시보드의 Sitecore Publishing Service 버튼을 클릭하여 실행하여 본다.

2018년 11월 19일 월요일

사이트코어의 새로운 MVC Route 적용하기

이번 블로그에서는 새로운 MVC Route를 사이트코어에 적용하는 방법을 알아보자.
사이트코어의 기본 MVC Route는 "/api/sitecore/{controller}/{action}"으로써 Sitecore 9 이상의 버전에서는 Sitecore.Mvc.config, 그리고 Sitecore 9 하위 버전에서는 Sitecore.Speak.Mvc.Config 파일에서 확인할 수가 있다.
Sitecore의 자체적인 MVC Application의 컨트롤는 "/sitecore/layout/controllers" 아이템 트리에 등록되어진 Application 렌더링 아이템을 작동시키지만, 간혹 아이템의 등록없이 새로운 API를 만들어 외부 소스를 Ajax Call로 불러들여 원하는 기능을 작동시킬수가 있다.

이를 위하여, 새로운 MVC Route를 만듬으로써 기본 API 경로에 구애받지 않고 사이트코어 내에 다른 어플리케이션을 독립적으로 수행할수가 있다. 지금부터 어플리케이션을 만들고 적용시키는 방법을 알아보자.

Visual Studio에서 새로운 Empty MVC 프로젝트를 만든다.

App_Start 폴더에 RouteConfig.cs을 새로운 Route를 레지스터하기 위하여 수정한다.

using System.Web.Mvc;
using System.Web.Routing;

namespace SitecoreSpaceNewRoute
{
    public class RouteConfig
    {
        public static void RegisterRoutes(RouteCollection routes)
        {
            //// 
            //// 기본 MVC Route
            ////
            //routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

            //routes.MapRoute(
            //    name: "Default",
            //    url: "{controller}/{action}/{id}",
            //    defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
            //);


            ////
            //// 사이트코어 스페이스의 새로운 MVC Route
            ////
            routes.MapRoute(
                name: "SitecpreSpaceRouting",
                url: "new/sitecore/space/routing/{controller}/{action}/{id}",
                defaults: new { controller = "SitecoreSpace", action = "MyView", id = UrlParameter.Optional }
            );
        }
    }
}

새로운 폴더 "CustomRouting" 이라는 폴더를 만들고, Sitecore.Kernel assembly를 Reference에 추가하고 사이트코어의 Bin 폴더의 System.Web.Mvc를 사용하도록 프로젝트에 업데이트한다. 레지스터한 Route를 Sitecore.Pipeline의 프로세스에 적용을 시킨다.

using System.Web.Routing;
using Sitecore.Pipelines;

namespace SitecoreSpaceNewRoute.CustomRouting
{
    public class InitializeRoutes
    {
        /// <summary>
        /// 새로 등록한 Route는 Sitecore Pipeline에 적용시킨다.
        /// </summary>
        /// <param name="args"></param>
        public void Process(PipelineArgs args)
        {
            RouteConfig.RegisterRoutes(RouteTable.Routes);
        }
    }
}

간단하게 새로운 Route의 레지스트를 마쳤으며, 이젠 Simple MVC을 만들자.

Controller (SitecoreSpaceController.cs)

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;

namespace SitecoreSpaceNewRoute.Controllers
{
    public class SitecoreSpaceController : Controller
    {
        // GET: SitecoreSpace
        public ActionResult MyView()
        {
            Models.SitecoreSpace ssnr = new Models.SitecoreSpace();

            // Valuable 값을 다른 소스 (예, 데이타베이스)에서 불러들일수 있지만,
            // 이번은 예제이므로, Static 값을 메뉴얼로 적용하겠다.
            ssnr.Subject = "사이트코어의 새로운 MVC Routing";
            
            ssnr.Description = "사이트코어 스페이스의 새로운 MVC Routing으로써, 기존 (Default)의 Routing 제한을 받지않고, 임의의 새로운 Route를 적용시켜 독립적인 MVC 어플리케이션을 Sitecore XP내에서 작동시킬수 있다.";
            ssnr.CurrentDateTime = DateTime.UtcNow;

            return View(ssnr);
        }

        // Redirect가 아니 다른 View rendering으로 사용할수가 있다.
        public ActionResult RedirectToBlog()
        {
            Models.SitecoreSpace ssnr = new Models.SitecoreSpace();
            ssnr.BlogUrl = "https://SitecoreSpace.Blogspot.com";

            return Redirect(ssnr.BlogUrl);
        }
    }
}

Model (SitecoreSpace.cs)

using System;
namespace SitecoreSpaceNewRoute.Models
{
    public class SitecoreSpace
    {
        public string FullBlogName { get; set; }
        public string BlogUrl { get; set; }
        public string Subject { get; set; }
        public string Description { get; set; }
        public DateTime CurrentDateTime { get; set; }
    }
}

View (MyView.cshtml)

@model SitecoreSpaceNewRoute.Models.SitecoreSpace

<!DOCTYPE html>
<html>
<head>
    <meta name="viewport" content="width=device-width" />
    <title>MyView</title>
</head>
<body>
    <div class="form-horizontal">
        <h4>SitecoreSpace</h4>
        <hr />
        <div class="col-md-10">
            @Html.DisplayTextFor(model => model.Subject)
        </div>
        <br />
        <div class="col-md-10">
            @Html.DisplayTextFor(model => model.FullBlogName)
        </div>
        <br />
        <div class="col-md-10">
            @Html.DisplayTextFor(model => model.Description)
        </div>
        <br />
        <div class="col-md-10">
            링크: @Html.ActionLink("Sitecore Space Blog", "RedirectToBlog", null, new { target = "_blank" })
        </div>
        <br />
        <div class="col-md-10">
            현재시간: @Model.CurrentDateTime.ToString("yyyy-MM-dd h:mm:ss tt")
        </div>
    </div>
</body>
</html>

View (RedirectToBlog.cshtml)

<!DOCTYPE html>
<html>
<head>
    <meta name="viewport" content="width=device-width" />
    <title>RedirectToBlog</title>
</head>
<body>
    <div> 
        추가 extra 페이지
    </div>
</body>
</html>

새로운 패치파일을 만들어 사이트코어 파일시스템의 "/App_config/Include/" 폴더에 z.Sitecore.Space.Route.config을 만든다.

<?xml version="1.0" encoding="utf-8"?>
<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/" xmlns:set="http://www.sitecore.net/xmlconfig/set/">
  <sitecore>
    <pipelines>
      <initialize>
        <processor type="SitecoreSpaceNewRoute.CustomRouting.InitializeRoutes, SitecoreSpaceNewRoute" 
                   patch:after="processor[@type='Sitecore.Pipelines.Loader.EnsureAnonymousUsers, Sitecore.Kernel']" />
      </initialize>
    </pipelines>
  </sitecore>
</configuration>

이젠 브라우저에서 패치되어진 API 경로를 이동을 해본다.