Sitecore CDP and Personalize APIs Practical Reference

Automating Component-Level Personalization in Sitecore XM Cloud: From APIs to an AI-Assisted Workflow

If your Sitecore CM login is not redirecting to Identity Server, even though Identity Server opens correctly, the issue may be related to certificate trust, hostname configuration, IIS bindings, or Sitecore authentication settings.

I ran into this issue while manually configuring Sitecore using WDP packages without SIF or SIA. The CM and Identity Server configuration appeared to be correct, and Identity Server was accessible directly, but the Sitecore login page would not redirect.

In my case, the issue was a certificate-chain trust problem. The root CA certificate used by the Identity Server certificate was not trusted by the local machine.

This guide starts with the fix that worked in my environment, followed by additional checks for similar Sitecore CM > Identity Server issues.

Prerequisites

Before you start, make sure the following prerequisites are already in place:

Sitecore CM is already installed and accessible.
Sitecore Identity Server is already installed and configured.
The Identity Server SSL certificate has already been created and is being used by Identity Server.
The required Sitecore CM and Identity Server configuration is already in place.
The Identity Server hostname is configured consistently across Sitecore, IIS, the certificate SAN/DNS name, and the Windows hosts file.

For the examples in this article, I am using:

Sitecore CM: https://sc104cm.dev.local
Sitecore Identity Server: https://sc104identityserver.dev.local/

Your URLs will be different, but use the same Identity Server hostname consistently throughout your local setup.

Quick Fix

If Identity Server is already installed and accessible, start with the following checks. In my environment, the certificate-chain trust issue was the main problem.

1. Open the Local Machine certificate store

Press Win + R enter certlm.msc, and press Enter.
Go to Personal > Certificates and find the SSL certificate used by the identity server https://sc104identityserver.dev.local/

2. Check the certificate chain

Open the Identity Server certificate and select Certification Path.
Select the root CA certificate at the top of the chain and click View Certificate.
Go to Details > Copy to File... and export it as a .cer file.
You only need the public certificate for this step. Do not export the private key.

3. Trust the root certificate

Open the exported .cer file and select Install Certificate.
In the certificate import wizard, select the following options:

   Select Local Machine as the certificate store location.
   Choose Place all certificates in the following store.
   Select Trusted Root Certification Authorities as the certificate store.
   Complete the certificate import.
The certificate should be installed under: Local Computer > Trusted Root Certification Authorities

4. Verify the Identity Server IIS binding

Open IIS Manager, select the Identity Server website, and open Bindings...
Verify that the HTTPS binding uses port 443, the correct hostname, and the Identity Server SSL certificate.
Make sure the hostname matches the Identity Server URL and the certificate SAN.

5. Verify Sitecore, Identity Server, and Hostname Configuration

Make sure sc104identityserver.dev.local is used consistently across your Sitecore CM and Identity Server configuration. Check the following settings and files:

5.1) Sitecore CM configuration

Check the following files on the Sitecore CM instance:

C:\inetpub\wwwroot\sc104cm.dev.local\App_Config\ConnectionString.config

   Verify the sitecoreidentity.secret connection string.
C:\inetpub\wwwroot\sc104cm.dev.local\App_Config\Sitecore\Owin.Authentication.IdentityServer\Sitecore.Owin.Authentication.IdentityServer.config

   Verify that identityServerAuthority points to the correct Identity Server URL:

5.2) Identity Server configuration

Check the Identity Server configuration file:

   C:\inetpub\wwwroot\sc104identityserver.dev.local\Config\production\Sitecore.IdentityServer.Host.xml
Make sure the certificate and other Identity Server settings are configured correctly.

5.3) Certificate SAN/DNS name

Make sure the Identity Server domain name is included in the certificate's Subject Alternative Name (SAN).
You can check this from Certificate Manager > Certificate > Details > Subject Alternative Name.
The hostname should match the Identity Server URL you are using.

5.4) Windows hosts file

Check the Windows hosts file:

   C:\Windows\System32\drivers\etc\hosts
Make sure there is an entry for the Identity Server hostname and that it resolves to the correct IP address for your local setup.

6. Restart IIS

Run iisreset in the terminal to restart IIS and apply the changes. 
Then open https://sc104cm.dev.local/sitecore in your browser and try logging in again.

Frequently Asked Questions

1. Why does Identity Server work directly but CM does not redirect?

Direct browser access does not necessarily mean that Sitecore CM can establish a trusted HTTPS connection to Identity Server. The CM authentication flow can still fail because of certificate trust, hostname, SAN/DNS, IIS binding, or Sitecore configuration.

2. Where should the Identity Server root certificate be installed?

For the local Windows setup described in this article, install the root CA certificate under Local Machine > Trusted Root Certification Authorities.

3. Do I need to export the Identity Server private key?

No. For the certificate-trust fix described here, export only the public root CA certificate as a .cer file.

Conclusion

In this troubleshooting guide, we identified and fixed one specific issue: a certificate-chain trust problem between Sitecore CM and Identity Server. Installing the root CA certificate in the Local Machine > Trusted Root Certification Authorities store, along with verifying the IIS binding and hostname, resolved the redirect issue in our setup.

Related Links & Discussions

If you are troubleshooting Sitecore Identity Server or setting up a local Sitecore environment, these resources may also be useful:

How to Create SSL Certificates for Sitecore Locally
Sitecore CM Login Not Redirecting to Identity Server – Stack Exchange
My Stack Exchange Answer – Certificate Trust Fix

Sitecore CM Login Not Redirecting to Identity Server? Troubleshooting Guide

In Part 1, we scaffolded the app, configured App Studio, and ran it locally. This post (Part 2) focuses only on authorization, a common portal CORS issue, and verifying both extension points you enabled earlier.

Series navigation

Sitecore Marketplace Apps: Overview and Why They Matter
Build Fullstack Sitecore Marketplace App with Next.js & shadcn (Part 1)
Sitecore Marketplace App - Authentication, Testing & Conclusion (Part 2) — you are here

Prerequisites from Part 1

Before continuing, confirm:

The app runs at https://localhost:3000 with experimental HTTPS enabled
App Studio has Standalone and Page Builder context panel extension points
.env includes Client ID, App ID, Organization ID, and Tenant ID
The app is activated and installed on your SitecoreAI or XM Cloud instance

If any of those are missing, finish Part 1 first.

Developer Setup (Part 2): Authorize & Test Your Marketplace App

This guide continues from Step 3 in Part 1.

Step 4: Authorize Marketplace App on Sitecore Portal

Open https://localhost:3000 in a new browser tab. This triggers the OAuth flow and lets you authorize the app.

Authorize Marketplace App on Sitecore Portal

After authorization, reopen the app from the Sitecore portal to verify it. You can now explore its features.

Common issue: auth.sitecorecloud.io blocked in the portal iframe

The first time you open the app in the Sitecore Cloud portal, you may see CORS errors with auth.sitecorecloud.io because the OAuth flow gets blocked inside the embedded view.

Fix:

Keep the Marketplace app running locally (npm run dev).
Open the app URL once in a separate full browser tab (not inside the portal iframe).
Complete the OAuth consent / login flow there.
Return to the Sitecore Cloud portal and open the app again from Apps.

Issue - Auth Sitecore Cloud Refused to connect

This pattern is normal for local HTTPS Marketplace apps during the first authorize pass.

Step 5: Open Your Marketplace App in XM Cloud and Verify

Since we enabled two extension points during configuration—Standalone and Page Builder context panel—verify both.

Standalone

On the Sitecore Cloud portal home page, scroll down to the Apps section. Find your app and click it. This opens the app in Standalone mode.

Standalone - App View in Sitecore Cloud Portal

What success looks like: the app loads outside Page Builder, usually on the route you configured for the Standalone extension point (often the home route).

Page Builder context panel

Open your XMC or SitecoreAI instance where the app is installed.
Navigate to Page Builder and ensure you are on the Editor tab (top navigation in Page Builder).
Look for the Apps icon—the third icon from the top-right corner, after the Publish button.
Click the icon and select your application.

Marketplace App Icon in Sitecore Page Builder

Your app should now appear inside the Page Builder panel.

Page builder context panel - App View in Sitecore Cloud Portal

What success looks like: the panel opens beside the canvas without a blank iframe, and any client/server Marketplace SDK samples on the page can call APIs with your tenant context.

Step 6: Validate Marketplace SDK samples on the home route

Your app is up and running. The home route loads by default unless you changed the extension point settings.

The starter page typically includes:

Client-side Marketplace SDK examples (browser / iframe context)
Server-side examples for authorized API calls

Run both paths once after OAuth succeeds. If client calls work but server calls fail, re-check Client ID/Secret, allowed callback URLs, and that Tenant ID in .env matches the installed instance.

Troubleshooting quick reference

| Symptom | Likely cause | What to try |
| --- | --- | --- |
| auth.sitecorecloud.io refused in portal | OAuth blocked in iframe | Authorize once in a normal tab, then reopen from Apps |
| App missing under Apps | Not activated or not installed | Activate in App Studio, install on the target instance from My Apps |
| Blank Page Builder panel | Wrong extension point URL or app not installed on that site | Confirm Page Builder context panel URL and reinstall/update from My Apps |
| 401 on server SDK calls | Bad credentials or tenant mismatch | Regenerate credentials; confirm Tenant ID from the installed app URL |

Conclusion

You now have an end-to-end path for a full-stack Sitecore Marketplace app:

Concepts and architecture — Overview
Scaffold + App Studio + local HTTPS — Part 1
Authorize + verify Standalone and Page Builder — Part 2 (this post)

Was this guide helpful?

If you have questions, feedback, or ran into any setup issues, feel free to share them in the comments.


Sitecore Marketplace App - Authentication, Testing & Conclusion (Part 2)

In the previous blog, we explored what Marketplace apps are, why they matter, and how they fit into Sitecore XM Cloud.

This post (Part 1) is the hands-on setup guide: scaffold the project, wire App Studio, collect the right IDs, and get the app running on https://localhost:3000. Authorization inside the Sitecore portal and Page Builder testing are covered in Part 2.

Series navigation

Sitecore Marketplace Apps: Overview and Why They Matter
Build Fullstack Sitecore Marketplace App with Next.js & shadcn (Part 1) — you are here
Sitecore Marketplace App - Authentication, Testing & Conclusion (Part 2)

Here’s another way to build a Marketplace app using Next.js and shadcn. While Sitecore provides a Marketplace Starter Kit on GitHub, this approach includes preconfigured authentication and examples for both client-side and server-side use.

What you will have after Part 1

A scaffolded Next.js Marketplace app from the shadcn full-stack quickstart
App Studio configuration with Standalone + Page Builder context panel extension points
Client credentials and the four IDs required in .env
The app running locally over HTTPS (ready for OAuth in Part 2)

Developer Setup (Part 1): Create and Configure Your Marketplace App

Step 1: Scaffold Your Marketplace App

1. Scaffold the app using the npx command

Create a project folder, open it in VS Code or a terminal, and run:

npx shadcn@latest add https://blok-shadcn.vercel.app/r/marketplace/next/quickstart-with-full-stack-xmc.json

Scaffolding the app using the npx command - Sitecore Marketplace App

2. Enable Experimental HTTPS in package.json

Enable experimental HTTPS by adding a flag to your package.json scripts. This lets the app run locally over HTTPS, which is required for secure authentication.

Update the scripts section like this:

  "scripts": {
    "dev": "next dev --turbopack --experimental-https",
    "build": "next build --turbopack",
    "start": "next start --experimental-https",
    "lint": "eslint"
  },

3. Review the Environment Variables

This creates a .env file with variables like the ones below. You’ll fill some of these in Step 2.

NEXT_PUBLIC_AUTH0_DOMAIN=https://auth.sitecorecloud.io
NEXT_PUBLIC_AUTH0_AUDIENCE=https://api-webapp.sitecorecloud.io
NEXT_PUBLIC_AUTH0_SCOPE=openid profile email offline_access
NEXT_PUBLIC_AUTH0_CLIENT_ID=your-client-id
NEXT_PUBLIC_SITECORE_APP_ID=your-marketplace-app-id
NEXT_PUBLIC_SITECORE_ORGANIZATION_ID=your-org-id
NEXT_PUBLIC_SITECORE_TENENT_ID=your-tenant-id
NEXT_PUBLIC_APP_BASE_URL=https://localhost:3000

Step 2: Configure Your App in Sitecore App Studio

1. Create App in App Studio

Go to Sitecore Cloud Portal. Click on “App Studio” from top navigation.
Click on “Create App” button at top right corner of the screen.
Enter an app name and select Custom or Public, depending on your requirement. (Refer documentation: App types) 

  Create App in App Studio - Configure Marketplace App in Sitecore App Studio
Click Create, then configure the application. (App Studio > Click on the App)

2. Configure your application

Choose the Extension Points you want to enable, and optionally set a landing page for each.
  Here, we’re using Standalone and Page Context Panel.
API Access: Select the Sitecore Cloud products where your app can be installed. Currently, only XMC and SitecoreAI are available, but additional options may be added in the future.

  Selecting Sitecore Cloud products for API Access in Marketplace App
Deployment URL: For local development, use https://localhost:3000.
App Icon: Use a 512×512 publicly accessible image URL. Any logo works, as long as the URL is publicly accessible.

  e﻿g. https://fastly.picsum.photos/id/58/512/512.jpg?hmac=jxfe82GanXiWmTfpdeMNdzSvGv4RS_eqipxzUduQUeg

3. Create Credentials

Configure authorization credentials, as they are required for server-side custom authorization of Sitecore API requests. Add the allowed callback, logout, and origin URLs, then generate the Client ID and Client Secret. For now, include localhost URLs; you can add dev or staging URLs later.

Allowed callback URLs: https://localhost:3000/auth/callback, https://localhost:3000
Allowed logout URLs: https://localhost:3000
Allowed origins URLs: https://localhost:3000
Allowed web origins URLs: https://localhost:3000

Finally, click Create Credentials to generate the Client ID and Client Secret, and store them securely for future reference.

Create Credentials for Sitecore Marketplace App - Regular App

4. Collect Important IDs for Frontend Configuration

Collect the IDs you’ll add to your .env file.

App ID (Marketplace app ID section, available on right side)
Organization ID (from URL query, eg. ?organization=org_TLXXXXXXXPf)
Client ID (Generated from client credentials)
Tenant ID (we will get after Activating and Installing the app, refer 6 point)

Configured Final View in App Studio - Sitecore Marketplace App

5. Activate the application.

Click Activate in the top-right.
After activation, the app appears under My Apps (from top nav bar) in the Sitecore portal.

Sitecore Marketplace app displayed in the My Apps section after activation

6. Install App and get the Tenant Id

Install the App:

Go to My Apps and install the app on the SitecoreAI or XMC instance.

Retrieve Tenant ID:

After installing the app, navigate to the Home section of the Sitecore Cloud portal from the top navigation.
Scroll down to the Apps section.
Locate the app you recently created and click on it. It will open in a new tab.
Copy the tenantId from the query string in the URL.

Note: After installing the app, any changes made in App Studio must be updated again from the My Apps section to ensure they are reflected.

Step 3: Update .env and Run the App

Use the IDs collected in the previous steps to update your .env file.

NEXT_PUBLIC_AUTH0_CLIENT_ID=your-client-id
NEXT_PUBLIC_SITECORE_APP_ID=your-marketplace-app-id
NEXT_PUBLIC_SITECORE_ORGANIZATION_ID=your-org-id
NEXT_PUBLIC_SITECORE_TENENT_ID=your-tenant-id

Now, run npm run dev, then open https://localhost:3000 in a new tab.

At this point, your app is fully configured and running locally.

Part 1 checklist before you continue

[ ] npm run dev serves the app at https://localhost:3000 (not HTTP-only)
[ ] App Studio shows your chosen extension points and Deployment URL
[ ] Client ID / App ID / Organization ID / Tenant ID are set in .env
[ ] The app is activated and installed on your SitecoreAI or XM Cloud instance

In the next part, we’ll continue with authorization, testing inside XM Cloud, and validating extension points.

Continue reading: Next Part — Authorize & Test Your Marketplace App


Build Fullstack Sitecore Marketplace App with Next.js & shadcn (Part 1)

Overview

Welcome to the first post in our Sitecore Marketplace App series! 
In this article, we’ll cover the basics—what these apps do, how they work, and when it makes sense to build one. This will give you the foundation you need before jumping into the hands-on guide in the next part.
Here’s the full series (each part answers a different question—bookmark all three):

Sitecore Marketplace Apps: Overview and Why They Matter — architecture & when to build
Build Fullstack Sitecore Marketplace App with Next.js & shadcn (Part 1) — scaffold, App Studio, local HTTPS
Sitecore Marketplace App: Authentication, Testing & Conclusion (Part 2) — OAuth, CORS fix, Standalone & Page Builder tests

Sitecore Marketplace App Architecture Explained

A Sitecore Marketplace app is an independent web application—typically built with Next.js (though other stacks are supported; check Sitecore documentation) and integrated with Sitecore Cloud portal.

1. Hosted and managed by you: The app runs independently on infrastructure of your choice

2. Integrated inside Sitecore Portal (SaaS): Through extension points, the app integrates into the Sitecore UI (for example, as a Dashboard Widget or Page Builder Panel). Currently, it supports only Sitecore AI (formerly XM Cloud), but future updates may include other Sitecore SaaS products.

Standalone: The app appears on the Sitecore Cloud Portal’s home page and opens in a new tab. 
Full screen: The app is listed in the SitecoreAI/XM Cloud navigation bar and displays full-screen under the header — ideal for deep workflows.
Page builder context panel (SitecoreAI/XMC): The app shows up as a panel next to the canvas in Page Builder, perfect for page-specific tools.
Page builder custom field (SitecoreAI/XMC): The app is triggered by a custom field in Page Builder, popping up in a modal to provide specialized data or controls.
Dashboard widget: The app can be added to an SitecoreAI / XM Cloud dashboard to display metrics or insights across the site.

3. Custom Implementation: You can add any backend or frontend logic as per your needs—whether it’s calling external APIs, running workflows, or adding AI features.

4. Sitecore Marketplace SDK support: Sitecore is officially offering SDK to build custom sitecore marketplace apps. You can refer the official documentation, this provides an overview of the SDK, its modules, and how developers can start using it. Here is the repository link for reference.

A quick overview of the key modules in the Sitecore Marketplace SDK — what they are and how they work.

@sitecore-marketplace-sdk/core: Provides the foundational APIs and utilities for building Marketplace apps, including core logic and data models.
@sitecore-marketplace-sdk/client: Enables client-side integration with Marketplace services, handling authentication and communication from the browser or frontend.
@sitecore-marketplace-sdk/xmc: Offers tools to integrate with Sitecore XM Cloud, including APIs for sites, pages, and content management
experimental_XMC - Server-to-Server API Access: Provides server-to-server access to XM Cloud APIs using @sitecore-marketplace-sdk/xmc without iframe or client SDK, ideal for backend integrations

This architecture gives you full flexibility:

Build lightweight client-side apps for quick UI enhancements.
Or create full-stack apps with backend integrations for complex workflows.

Who Should Build a Sitecore Marketplace App & When

1. Who it’s for

The Sitecore marketplace app is ideal if you’re looking to extend Sitecore XM Cloud without altering its core. Typical audiences include:

Developers or partners who want to add new capabilities or UI components inside Sitecore.
Organizations that run repetitive tasks (e.g., publishing workflows, QA checks) and want to automate them.
Teams planning to integrate external services like DAM, CRM, AI, analytics, etc.
Agencies building reusable components that can serve multiple clients.

2. When it makes sense to build

Consider building a Marketplace app when you’re facing scenarios such as:

The need for custom UI elements within XM Cloud (for example, a new panel in Page Builder or a dashboard widget).
You want to connect Sitecore to external APIs - —for translation, personalization, CRM sync, analytics, and so on.
You aim to streamline editorial workflows, such as bulk publishing, content audits or automation of repetitive tasks.
You plan to share your solution publicly (or privately with one client or partner) so it can be reused or installed later.

3. Example Use Cases (Not Limited To These)

Integration Apps:

   Connect Sitecore with Salesforce, HubSpot, or AI services
Authoring Enhancements

   AI-powered content suggestions in Page Builder
   Custom field pickers for taxonomy or media
Monitoring & Analytics

   Health check dashboards
   Real-time KPI widgets
Marketing Tools

   Campaign management widgets
   Personalization rule builders
Agentic AI Applications

   AI Content Assistant: Suggest headlines, rewrite text, generate SEO-friendly content
   Autonomous Campaign Manager: AI monitors analytics and launches campaigns automatically
   Predictive Personalization: AI adjusts content blocks in real-time based on user intent
   Automated QA & Compliance: AI checks content for brand compliance or accessibility before publishing

What’s Next After Deciding to Build a Marketplace App?

Once you’ve decided to build a Sitecore Marketplace app, you have two great starting points:

1. The official Sitecore Marketplace Starter Kit

Available on GitHub, this kit is perfect for learning the basics and following Sitecore’s recommended patterns.

Features:

Demonstrates all five extension points: 

  Custom Field
  Dashboard Widget
  Fullscreen
  Pages Context Panel
  Standalone
Built using the Sitecore Marketplace SDK.
Ideal for quick onboarding and understanding Sitecore’s architecture.

2. The shadcn starter kit

If you prefer a full-stack approach and a quick start using the CLI, the ShadCN kit provides more preconfigured components and examples.

Features:

Pre-configured Auth0 integration for Sitecore Cloud
Includes client-side and server-side examples
Built with Next.js and provides multiple example approaches, including server-side implementations

Both options are solid—choose the one that fits your project needs and development style.

Conclusion

Sitecore Marketplace apps open up endless possibilities for extending XM Cloud without touching its core. Whether you want to integrate external services, streamline workflows, or add AI-powered features, these apps give you the flexibility to innovate.

In the next part of this series, we’ll walk through building a full-stack Marketplace app using Next.js and shadcn starter kit, complete with authentication and extension points. Stay tuned!

Sitecore Marketplace Apps: Overview and Why They Matter

Introduction

In Sitecore, the admin user password is stored in the core database (_Core) within the aspnet_Membership table. The password value is hashed and depends on the hashAlgorithmType configured for your instance.

This guide provides SQL queries to reset the "admin" password to "b" based on the hashing algorithm used in your Sitecore instance.

Identify the Hash Algorithm Used

Before resetting the password, you need to determine which hashing algorithm is being used in your Sitecore instance. The configuration can be found in the following files:

Case 1: Identity Server Enabled

Check the configuration file

C:\inetpub\wwwroot\\sitecore\Sitecore.Plugin.IdentityServer\Config\identityServer.xml

Password Hash Algorithm in Identity Server XML file - Identity Server Enabled

Case 2: Identity Server Disabled

Look for the following file:

C:\inetpub\wwwroot\\web.config

Password Hash Algorithm in Web.config file - Identity Server Disabled

Inside these files, search for the hashAlgorithmType setting to identify whether SHA1 or SHA512 is used.

SQL Queries to Reset Password

Once you have identified the hash algorithm, use the appropriate SQL query to update the admin password.

For SHA1

UPDATE [aspnet_Membership] 
  SET 
    [Password] = 'qOvF8m8F2IcWMvfOBjJYHmfLABc=', 
    [PasswordSalt] = 'OM5gu45RQuJ76itRvkSPFw==', 
    [IsApproved] = '1', 
    [IsLockedOut] = '0' 
  WHERE 
    UserId IN 
    (
          SELECT UserId FROM dbo.aspnet_Users WHERE UserName = 'sitecore\Admin'
    ) 

For SHA512

UPDATE [aspnet_Membership] 
	SET 
			[Password]='K8N8GUW8UiNT2mPdjvuBDH+QmvA3R61M9buVvCwFHwtDjpMzTxs34lg0uQ0azCITqh6FkUZlX4kM72lsAyuyXQ==', 
			[PasswordSalt]='p5B6HOWKt0ctMZaSNXTlfw==', 
			[IsApproved] = '1', 
			[IsLockedOut] = '0'
    WHERE 
			UserId IN 
            (
				SELECT UserId FROM dbo.aspnet_Users WHERE UserName = 'sitecore\admin'
            );

Note: Make sure you run this SQL query on the _Core database.



Hope you found this article helpful! Feel free to share any feedback or suggestions in the comments section.

If you're only looking to unlock the Sitecore admin user, check out this blog:
Fix Status Code 401 Error on SXA Commands or Unlock Sitecore Admin User.

How to Reset Sitecore Admin User Password Using SQL

In Sitecore's evolving landscape, efficiently managing and deploying SXA theme styles and scripts is crucial for non-headless projects. 

This blog builds on Richard Seal's insights on SXA theme deployment with Unicorn serialization, adapting them to the latest Sitecore Content Serialization technology. Special thanks to my colleague Mark Ruiz for invaluable guidance. 

We’ll explore setting up an auto theme build process using Azure DevOps and Sitecore Content Serialization.

Overview

This guide is designed for teams using it in non-headless SXA projects, aiming to streamline theme deployment and eliminate the need to manage  pre-optimized-min.css and pre-optimized-min.js files in source control. Managing these files can cause conflicts when multiple team members work on the theme simultaneously.

Background

In Richard Seal's blog, we saw how field filters can be used to skip fields like blobs, last modified dates, and others in the local environment, and then enable them in upper environments using Unicorn configs. This ensures that changes in the local environment don't appear in Git after every SXA theme build or rebuild.

Challange

After further research, we discovered that applying field filters at the item level and having environment-specific configurations is not possible with Sitecore Content Serialization.

Solution

As a result, we decided to take a different approach. We separated the optimized styles and scripts into a separate SCS module. This allows us to disable the module in local environments and enable it in upper environments using PowerShell. For the purpose of this guide, I'll assume that Sitecore Content Serialization has already been configured in your project, and that all the necessary items, including the media library and themes, have been successfully serialized. Let's go step by step.

Step 1. Add Sitecore Content Serialization Configs for Seperating Optimized Theme Files

Ignore Styles and Script folder

Let's assume your Site1 theme is located at /sitecore/media library/Themes/Tenant/Site1. You've already included all items under this node in your serialization. However, since we want to separate the pre-optimized scripts and styles, we need to exclude this specific folder. Below, we’ll add rules for this node to achieve that. Example module file: ~/App_Config/Include/Project/Site1.Website.module.json

{
  "namespace": "Project.Site1.Website",
  "references": [
    "Foundation.*",
    "Feature.*"
  ],
  "items": {
    "includes": [
      {
       
      },
      {
        "name": "Themes",
        "path": "/sitecore/media library/Themes/Tenant/Site1",
        "database": "master",    
        "rules": [
          {
            "path": "/Site1/styles",
            "scope": "ignored"
          },
          {
            "path": "/Site1/scripts",
            "scope": "ignored"
          }
        ]
      }
    ]
  }
}

Run \Pull\ operation

Now, run the command dotnet sitecore ser pull to remove the above styles and scripts folders, along with their item .yml files, from your source control (solution).

Add New Module Config File

Add a new configuration file at the same location specifically for the optimized files. For example, name it Site1.Website.OptimizedThemes.module.json.

{
  "namespace": "Project.Site1.Website.OptimizedThemes",
  "references": [
    "Project.Site1.Website"
  ],
  "items": {
    "includes": [
      {
        "name": "OptimizedThemes",
        "path": "/sitecore/media library/Themes/Tenant/Site1/Site1",
        "database": "master",
        "scope": "descendantsOnly",
        "rules": [
          {
            "path": "/styles",
            "scope": "itemAndDescendants"
          },
          {
            "path": "/scripts",
            "scope": "itemAndDescendants"
          },
          {
            "path": "/*",
            "scope": "ignored"
          }
        ]
      }
    ]
  }
}

Step 2. Pull and Store Styles and Scripts YAML Files for Placeholder Use in AzDo Pipeline

Run \Pull\ operation.

Run the command dotnet sitecore ser pull again to pull the styles and scripts folders, along with the pre-optimized .yml files, into your source control (solution). Commit the .yml files that will be used as placeholder files for scripts and styles in upper environments.

Change file extension of newly created module file

Now, change the extension of the newly created configuration file by adding .NONLOCAL at the end. For example, you can rename it as Site1.Website.OptimizedThemes.module.json.NONLOCAL. 

The reason for using the .NONLOCAL extension is to ensure that the file is not read as a module in Sitecore.json (located at the root of the project repository). 

For example:

Example: Sitecore Json File

Step 3. Download PowerShell Scripts and Update Theme and YAML Paths

Download and add /scripts/AzurePipeline folder to your sitecore solution.

Update the path of themes folder and yml folder

Now, edit the and update the theme details in the Invoke-ThemeOptimization.ps. You can also remove or add new entries in themes object.

Name: Enter your theme name.
ThemePath: Path to your SXA theme folder.
YmlPath: Path to the serialization folder for the OptimizedTheme. This folder should contain files such as scripts/pre-optimized-min.yml and others.

Edit paths in Invoke-ThemeOptimization.ps

Update Projects Directory Folder

Update the projects directory folder in Enable-ThemeOptmizationConfiguationFiles.ps1 to include all projects with their module.json files.

Enable ThemeOptimizationConfigurationFile.ps1

Save changes and commit. 

At this point, we have completed the necessary repository changes. In the next step, we need to edit our Azure DevOps build pipeline to automate the process of building the SXA theme using the Node SXA command (e.g., sxa build).

Step 4. AzDo Build Pipeline - Add Theme Build Task

For this step, we assume that a build pipeline is already set up for our project. We will simply add a few additional tasks to the build pipeline to automate the SXA theme build process.

Since we want to run the SXA build command in the pipeline, which is based on a Node environment, we first need to add a task that enables us to use Node in DevOps. Follow the steps mentioned below:

Add the "Use Node" Task (Node.js Tool Installer)

Click the "+" button.
On the right side, type "node" in the search box.
Select "Node.js Tool Installer."
Set the parameters as per your project.

Pipeline: Use Node Task

SXA Theme Build Task (Powershell)

Add a new task for the SXA theme build in the pipeline. For this, we will utilize our Invoke-ThemeOptimization.ps1 PowerShell script, which we included in our source control in previous steps. To do this, we need to add a PowerShell task and provide the parameters as shown in the image below. 

Pipeline: SXA Theme Build Task (Powershell)")

Save the build pipeline settings. 

How This Will Work:

The SXA theme optimization task will call the Invoke-ThemeOptimization.ps1 powershell. As a result, each theme will be built, and a pre-optimized physical file will be generated.

The script will also call the Set-ThemeYaml.ps1 function for each theme, which will replace the existing blob of placeholder YAML files with the newly generated pre-optimized YAML files.

In the end, we will have the latest YAML files in the Build.SourcesDirectory.

We have completed all the necessary settings and changes to set up the automatic SXA themes build in the Azure build pipeline. The next step follows the standard process for creating and installing Sitecore Content Serialization (SCS) item packages

Step 5: Configuring Build and Release Pipelines for Sitecore Content Serialization - Item Package Creation and Installation

I recommend reviewing the blog shared by Phil Paris on configuring the Azure pipeline for this process. Be sure to check out Automated Deployments with Sitecore Content Serialization in Azure DevOps for further steps.

Conclusion

Using Sitecore Content Serialization with Azure DevOps lets you automate and streamline SXA theme deployments in non-headless projects. This setup boosts efficiency and ensures consistent, reliable deployments. For more details and advanced configurations, check the official Sitecore documentation and community resources.

Deploy SXA Themes with Azure DevOps & Sitecore Content Serialization (SCS)

This article is the third post on creating a Submit Action to save Contacts into the List Manager in Sitecore. In the previous post, we developed the SPEAK editor layout for the custom Submit Action in the Core database for Submit Action to have Field mapping ability. In this part, we will construct a class to save contact list details in List Manager (Sitecore). We will also create a Submit action item in the master database and associate it with the SPEAK editor item we created in the previous article.

The series includes the following parts:

Submit Action to Save Contacts in List Manager – Basic Implementation

Submit Action to Save Contacts in List Manager with Fields Mapping Part 1: Create SPEAK Editor

Submit Action to Save Contacts in List Manager with Fields Mapping Part 2: Create Submit Action

Create Submit Action Class and Submit Action Item

Step 1: Create Submit Action Class to Save Contacts in the Contact List:

Create a new model ContactListParameter.cs for the parameter data as given below.

using System;

namespace Feature.FormsExtensions.Models
{
    public class ContactListParameters
    {
        public Guid FirstNameFieldId { get; set; }
        public Guid LastNameFieldId { get; set; }
        public Guid EmailFieldId { get; set; }
        public Guid ContactListId { get; set; }
    }
}

Now we will create a new class and override Execute method. Add a new class file named SaveToContactList.cs in the SubmitActions folder. The GitHub repository contains the entire solution.

using System;
using System.Collections.Generic;
using System.Linq;
using Sitecore.Diagnostics;
using Sitecore.ExperienceForms.Models;
using Sitecore.ExperienceForms.Processing;
using Sitecore.ExperienceForms.Processing.Actions;
using Sitecore.XConnect;
using Sitecore.XConnect.Client;
using Sitecore.XConnect.Client.Configuration;
using Sitecore.XConnect.Collection.Model;
using Feature.FormsExtensions.Models;

namespace Feature.FormsExtensions.SubmitActions
{
    public class SaveToContactList : SubmitActionBase
    {
        public SaveToContactList(ISubmitActionData submitActionData) : base(submitActionData)
        {
        }

        protected override bool Execute(ContactListParameters data, FormSubmitContext formSubmitContext)
        {
            Assert.ArgumentNotNull(data, nameof(data));
            Assert.ArgumentNotNull(formSubmitContext, nameof(formSubmitContext));

            var firstNameField = GetFieldById(data.FirstNameFieldId, formSubmitContext.Fields);
            var lastNameField = GetFieldById(data.LastNameFieldId, formSubmitContext.Fields);
            var emailField = GetFieldById(data.EmailFieldId, formSubmitContext.Fields);

            if (firstNameField == null && lastNameField == null && emailField == null)
            {
                return false;
            }

            try
            {
                using (var client = CreateClient())
                {
                    return SaveContactInListManager(client, firstNameField, lastNameField, emailField, data.ContactListId);
                }
            }
            catch (XdbExecutionException exception)
            {
                Logger.LogError(exception.Message, exception);
                return false;
            }
        }

        private bool SaveContactInListManager(IXdbContext client, IViewModel firstNameField, IViewModel lastNameField, IViewModel emailField, Guid contactListId)
        {
            try
            {
                var reference = new IdentifiedContactReference("ListManager", GetValue(emailField));

                var expandOptions = new ContactExpandOptions(
                        CollectionModel.FacetKeys.PersonalInformation,
                        CollectionModel.FacetKeys.EmailAddressList,
                        CollectionModel.FacetKeys.ListSubscriptions);

                var executionOptions = new ContactExecutionOptions(expandOptions);

                Contact contact = client.Get(reference, executionOptions);

                if (contact == null)
                {
                    contact = new Sitecore.XConnect.Contact();
                    client.AddContact(contact);
                }

                SetPersonalInformation(GetValue(firstNameField), GetValue(lastNameField), contact, client);
                SetEmail(GetValue(emailField), contact, client);
                SetSubscriptionList(client, contact, contactListId);

                var contactIdentifier = new ContactIdentifier("ListManager", GetValue(emailField), ContactIdentifierType.Known);
                if (!contact.Identifiers.Contains(contactIdentifier))
                {
                    client.AddContactIdentifier(contact, contactIdentifier);
                }

                client.Submit();
                return true;
            }
            catch (XdbExecutionException exception)
            {
                Logger.LogError(exception.Message, exception);
                return false;
            }
        }

        private static void SetPersonalInformation(string firstName, string lastName, Contact contact, IXdbContext client)
        {
            if (string.IsNullOrEmpty(firstName) && string.IsNullOrEmpty(lastName))
            {
                return;
            }

            PersonalInformation personalInfoFacet = contact.Personal() ?? new PersonalInformation();
            if (personalInfoFacet.FirstName == firstName && personalInfoFacet.LastName == lastName)
            {
                return;
            }

            personalInfoFacet.FirstName = firstName;
            personalInfoFacet.LastName = lastName;

            client.SetPersonal(contact, personalInfoFacet);
        }

        private static void SetEmail(string email, Contact contact, IXdbContext client)
        {
            if (string.IsNullOrEmpty(email))
            {
                return;
            }

            EmailAddressList emailFacet = contact.Emails();
            if (emailFacet == null)
            {
                emailFacet = new EmailAddressList(new EmailAddress(email, false), "Preferred");
            }
            else
            {
                if (emailFacet.PreferredEmail?.SmtpAddress == email)
                {
                    return;
                }

                emailFacet.  PreferredEmail = new EmailAddress(email, false);
            }

            client.SetEmails(contact, emailFacet);
        }

        private void SetSubscriptionList(IXdbContext client, Contact contact, Guid contactListId)
        {
            var subscriptions = contact.ListSubscriptions();

            var listSubscription = subscriptions?.Subscriptions.FirstOrDefault(sub => sub.ListDefinitionId == contactListId && sub.IsActive == true);

            if (listSubscription != null)
            {
                return;
            }

            if (subscriptions == null)
            {
                subscriptions = new ListSubscriptions();
            }

            var listId = contactListId;
            var isActive = true;
            var added = DateTime.UtcNow;

            ContactListSubscription subscription = new ContactListSubscription(added, isActive, listId);

            subscriptions.Subscriptions.Add(subscription);
            client.SetListSubscriptions(contact, subscriptions);
        }

        protected virtual IXdbContext CreateClient()
        {
            return SitecoreXConnectClientConfiguration.GetClient();
        }

        private static string GetValue(object field)
        {
            return field?.GetType().GetProperty("Value")?.GetValue(field, null)?.ToString() ?? string.Empty;
        }

        private static IViewModel GetFieldById(Guid id, IList fields)
        {
            return fields.FirstOrDefault(field => Guid.Parse(field.ItemId) == id);
        }
    }
}

Now build and deploy the solution.

Step 2: Create Submit Action Item in Master Database:

Switch to the master database and navigate to the following location.

Master: /sitecore/system/Settings/Forms/Submit Actions

Right-click on the Submit Actions item.

Click on Insert, and then select Insert from template.

Select the /System/Forms/Submit Action template, and add an item with the name Save To Contact List.

Update the value of the Model Type field with our custom model type name.

Update the value of the Error Message field. Example: “Failed to save contact details”.

Select the “Save To Contact List” option for the Editor field.

Change the icon from the Appearance section.



Save To Contact List Submit Action Item

Now the Save To Contact List custom submit action is ready. You will get this above created submit action item as a Sitecore package at Master-SaveToContactList-SubmitAction.

Adding the Submit Action and Testing its Functionality

Create an empty contact list called “Customer Contact List” in Launchpad > List Manager > Create > Empty Contact List.



Create Empty Contact List

Make a Sitecore form with the fields First Name, Last Name, and Email.

Add a Submit button and link it to the “Save To Contact List” submit action.

Map the form fields for first name, last name and email.

Save the form after selecting the newly created Contact list.



Form Submit Action – Save To Contact List – With Field Mapping

Add Sitecore Form Wrapper rendering to a page and set the data source to the previously created form.

Browse the web page and fill out the form’s required information.

Check the data that has been provided (Launchpad > List Manager > Contact List > “Customer Contact List” > Scroll below to the Contacts section)



Form Submission And Result Verification

Conclusion

The blogs provided a comprehensive guide to implementing the submit action for saving contacts in List Manager.

In the first blog, we explored the basic implementation process, which only allows us to save contacts to a specific Contact List.

In the second blog, we focused on creating a SPEAK editor to support field mapping, offering insights into customizing the user interface. Finally, in this third blog, we covered the creation of a submit action item and its backend logic that supports field mapping ability.

We hope you have found these blogs helpful. Happy Learning !!


Submit Action to Save Contacts in List Manager with Fields Mapping Part 2 Create Submit Action

This article is the second post in the series on creating a submit action to save contacts into the list manager in Sitecore. In the previous post, we saw a basic implementation without the ability to map form fields with the custom-created submit action. It only offered the option of configuring the Contact List via the Item Tree View field.

Here are the parts of the series related to the Submit Action to Save Contacts in List Manager:

Submit Action to Save Contacts in List Manager – Basic Implementation

Submit Action to Save Contacts in List Manager with Fields Mapping Part 1: Create SPEAK Editor

Submit Action to Save Contacts in List Manager with Fields Mapping Part 2: Create Submit Action

In this article, we will create a submit action that should have the ability to map Form fields to Contact fields. That allows us to assign the first name, last name, and email to any of the form's fields. Additionally, provide users with a tree view list to select the Contact List where they want to store the contact information.

Submit Action to Save Contacts in List Manager with Fields Mapping

We will start by creating the editor layout (SPEAK) for the submit action from scratch. The next part will cover the steps to creating the submit action item and its code.



Form Submit Action - Save To Contact List - With Field Mapping

The Sitecore official documentation includes a walkthrough for constructing a ⁠submit action with field mapping. In this implementation, we will introduce an additional option to allow users to choose the Contact List in the Submit action where the contacts will get stored.

Create SPEAK Editor Layout for Submit Action

To create the SPEAK editor from scratch, you need the Sitecore Rocks Visual Studio plugin installed. Open Visual Studio and connect it to your Sitecore instance.



Sitecore Rocks Connection

1. Item Creation and Layout Configuration

Go to core database: /sitecore/client/Applications/FormsBuilder/Components/Layouts/Actions.

Right-click on the Actions item, and Add a New Item.

Search for the Speak-BasePage template (/sitecore/client/Speak/Templates/Pages/Speak-BasePage). Give the item name as SaveToContactList in the “Enter the name of the new item” textbox at the bottom and click OK.

Right-click the newly formed SaveToContactList item and select Tasks, then Design Layout.

Click browse on the Layout field, and search for Speak-FlexLayout (/sitecore/client/Speak/Layouts/Layouts). Click OK after selecting it.



Item Creation And Layout Configuration

2. Adding Renderings

Click on the Add Rendering button in the top-left corner.

In the Select Renderings window, search for PageCode (If you do not see the result, make sure you have selected 'All' in the left pane).

Select PageCode under /sitecore/client/Speak/Layout/Renderings/Common and click OK.

Select the PageCode rendering. Go to the properties window and update the following values.

PageCodeScriptFileName: /sitecore/shell/client/Applications/FormsBuilder/Layouts/Actions/SaveToContactList.js (This will be the JavaScript path that contains the page code script, we will add this JS file in later steps)

SpeakCoreVersion: SPEAK 2-x



Page Code - Properties Window

Add renderings for HeaderTitle, HeaderSubtitle, and ValueNotInListText. Search for Text and then select the "/sitecore/client/Business Component Library/version 2/Layouts/Renderings/Common/Text" view rendering.

For HeaderTitle, select the added Text rendering and go to the properties window and set the following fields:

Id - HeaderTitle

IsVisible - False

PlaceholderKey - Page.Body

Repeat the same step for HeaderSubtitle, and ValueNotInListText. Only the Id property will change as per the name. IsVisible and PlaceholderKey will be the same as above.

Add Border view rendering (/sitecore/client/Business Component Library/version 2/Layouts/Renderings/Containers/Border) and set its Id property as MainBorder.

Add Form view rendering (/sitecore/client/Business Component Library/version 2/Layouts/Renderings/Forms/Form) and set its Id property as MapContactForm, select FieldsLayout property as 1-1-1-1 and set the PlaceholderKey property to MainBorder.Content.



Rendering And Placeholders

3. Adding Page and Form Parameters

Select the SaveToContactList item (/sitecore/client/Applications/FormsBuilder/Components/Layouts/Actions/SaveToContactList). Right-click > Add > New Item.

Search for the PageSettings template (/sitecore/client/Speak/Templates/Pages/PageSettings). Select and enter the name PageSettings and then click OK.

Right-click on the newly created PageSettings item.

Add new items with name HeaderTitle, HeaderSubtitle and ValueNotInListText using the Text Parameters template (/sitecore/client/Business Component Library/version 2/Layouts/Renderings/Common/Text/Text Parameters)

HeaderTitle – double-click on the item and update the Text field as the title of the editor popup. For example, Map form fields

HeaderSubtitle – double-click on the item and update the Text field as the subtitle title of the editor popup.

ValueNotInListText – double-click on the item and update the Text field. For example, the value is not in the select list.

Select the PageSettings item again. Right-click > New Folder and add a folder with the name MapContactForm.

Select the MapContactForm folder. Add three new items with the FormDropList Parameters templates with the following field values (/sitecore/client/Business Component Library/version 2/Layouts/Renderings/Forms/Form/Templates/FormDropList Parameters).



FormDropList Parameters

Click on the MapContactForm folder and add an item name ContactList with FormItemTreeView Parameters templates (/sitecore/client/Business Component Library/version 2/Layouts/Renderings/Forms/Form/Templates/FormItemTreeView Parameters). Update the field values as below:

StaticData - {3C94F086-453B-48FC-9F1B-2B00BC0A55C7}

Database - master

HelpText - 'Select the contact list to save contact details'.

FormLabel - "Contact List"

BindingConfiguration - contactListId/SelectedItemId



ContactList - Parameter

Note: For the StaticData field in the ContactList parameter item, update the GUID of the Contact List folder.

Move the ContactList item below the LastName item (drag the ContactList item down or update the sort order value).

Select the PageSettings item.

Add a new item named Stylesheet using the template Page-Stylesheet-File (/sitecore/client/Speak/Templates/Pages/Page-Stylesheet-File)

Double-click on the new stylesheet item. Assign the value "/sitecore/shell/client/Applications/FormsBuilder/Layouts/Actions/Actions.css" to the Stylesheet field.



Page Settings and Form Parameters

4. Updating the Form Parameter Folder ID in the Layout

Select the SaveToContactList item and right-click > Task > Design layout.

Select the added Form rendering.

In the properties window, set the ConfigurationItem property to the ID of the MapContactForm folder.



Update Form Parameter Folder Id In Layout

5. Adding the SaveToContactList.js File

The client script for the editor with field mapping is available here. We can't use this directly, as it is focused only on the FormDropList field in the MapContactForm. But we also have a FormItemTreeView (for the contact list). If we continue with the same script, it will cause a problem with the setDynamicData method.

To fix the issue, we can add an if check in the setDynamicData function, as shown below:

setDynamicData: function (propKey) {
                    if (this.MapContactForm.bindingConfigObject[propKey].split(".")[1] === "SelectedValue") { //To allow only FormDropList field
                        //logic to set Dynamic Data for FormDropList field
                    }
                }

Here is the final client script for the editor after making this modification. Add this SaveToContactList.js file in your feature project as location /sitecore/shell/client/Applications/FormsBuilder/Layouts/Actions/SaveToContactList.js



SaveToContactList Javascript In Project

Our SPEAK editor layout for the SaveToContactList custom Submit Action is now ready. The Sitecore package for the above editor item we created is available at Core-SaveToContactList-SPEAK-Editor. To access the entire solution, please visit the GitHub repository.

In the next post of this tutorial, we will go through the final steps for creating a submit action item and associated code.


Submit Action to Save Contacts in List Manager with Fields Mapping Part 1 Create SPEAK Editor

A custom submit action for Sitecore forms that will save contact information to the list manager's contact list. It will allow us to collect the contact details from the end user through a Sitecore form and save them to the contact list inside the list manager. The article contains a step-by-step guide for creating a custom submit action to save contacts in List Manager in Sitecore.

The series includes the following parts:

Submit Action to Save Contacts in List Manager – Basic Implementation

Submit Action to Save Contacts in List Manager with Fields Mapping Part 1: Create SPEAK Editor

Submit Action to Save Contacts in List Manager with Fields Mapping Part 2: Create Submit Action



Using Save Contacts To Contact List Custom Submit Action in Sitecore Form Editor

Here, we will cover the basic implementation without the ability to map form fields to the custom-created submit action. This custom submit action will only have the Item Tree View field to select the contact list. It can be created by cloning RedirectToPage (an existing submit action in Sitecore) to use its SPEAK editor layout. Find the below steps for creating the custom submit action to save contacts in Sitecore List Manager's contact list.

Developing a Custom Submit Action to Save Contacts in List Manager

Step 1: Create Editor layout

First, we will create an editor for custom submit action in the Core database.



Editor Layout For Submit Action

The editor layouts for form actions are in the path given below. First, navigate to this path.

Core: /sitecore/client/Applications/FormsBuilder/Components/Layouts/Actions

Now, follow the steps mentioned below:

Make a duplicate item for the "Redirect to Page" item.

Change the item name to "SaveToContactList."

Update the browser title and display name fields.

Expand the child items of the PageSettings item.

Core:/sitecore/client/Applications/FormsBuilder/Components/Layouts/Actions/SaveToContactList/PageSettings

Select HeaderTitle and change the "Text - Specifies the caption for the button fields" field value.

Example: "Select Contact list"

Select HeaderSubtitle and change the "Text - Specifies the caption for the button fields" field value.

For instance, Select the desired contact list for storing the contact details.

Select ItemTreeView and make changes in the following fields:

IsCheckModeEnabled - Make sure to keep it unchecked.

Database – Update the database from "$context_contentdatabase" to "master."

Static Data – Update Guid of Contact List folder located at "master: /sitecore/system/Marketing Control Panel/Contact Lists" and its guid is "{3C94F086-453B-48FC-9F1B-2B00BC0A55C7}."

Note: The current context database is core. We can't directly choose the contact list folder (which is in the master) from the item tree. We must update the field with the item's guid. Enable the display of field values as raw values, then change the field values.



Editor Layout Fields Update - Save To Contact List

Now, the editor layout for the SaveToContactList Submit Action is ready. After that, we must create an item for submit action in the master database.

Step 2: Create a Submit Action Item

Switch to the master database and navigate to the following location.

Master: /sitecore/system/Settings/Forms/Submit Actions

Make a duplicate item for the "Redirect to Page" item.

Rename it to "Save To Contact List."

Update the field value of Error Message, Example: "Failed to save contact details!!"

Select the "Save To Contact List" option for the Editor field

Change the icon from the Appearance section

Our custom submit action is almost ready but still refers to the RedirectToPage code. We must create a new class to save the form data into the contact list. The SaveToContactList also uses the same parameter key (used in RedirectToPage) named "referenceid". This parameter key stores the selected value of ItemTreeValue fields shown in the image below.



Parameters field- Save To Contact List Item

Step 3: Create Submit Action Class to Save Contacts in Contact List

Create a new model class for the parameter data as given below.

using System;

namespace Feature.FormsExtensions.Models
{
    public class ContactListParameters
    {
        public Guid ReferenceId { get; set; }
    }
}

Now we will create a new class and override Execute method. Add a new class file named SaveToContactList.cs in the SubmitActions folder.

Note: We use xConnect Client API instead of List Manager API for this implementation. Contact lists are stored in Sitecore as marketing definitions. You can only access contact lists programmatically via the List Manager API on the CM instance; the List Manager API will not work on CD instances because the List Manager application is disabled.

using System;
using System.Collections.Generic;
using System.Linq;
using Sitecore.Diagnostics;
using Sitecore.ExperienceForms.Models;
using Sitecore.ExperienceForms.Processing;
using Sitecore.ExperienceForms.Processing.Actions;
using Sitecore.XConnect;
using Sitecore.XConnect.Client;
using Sitecore.XConnect.Client.Configuration;
using Sitecore.XConnect.Collection.Model;
using Feature.FormsExtensions.Models;

namespace Feature.FormsExtensions.SubmitActions
{
    public class SaveToContactList : SubmitActionBase
    {
        public SaveToContactList(ISubmitActionData submitActionData) : base(submitActionData)
        {
        }

        protected override bool Execute(ContactListParameters data, FormSubmitContext formSubmitContext)
        {
            Assert.ArgumentNotNull(data, nameof(data));
            Assert.ArgumentNotNull(formSubmitContext, nameof(formSubmitContext));

            var firstNameField = formSubmitContext.Fields.FirstOrDefault(field => field.Name.Equals("FirstName"));
            var lastNameField = formSubmitContext.Fields.FirstOrDefault(field => field.Name.Equals("LastName")); ;
            var emailField = formSubmitContext.Fields.FirstOrDefault(field => field.Name.Equals("Email"));

            if (firstNameField == null && lastNameField == null && emailField == null)
            {
                return false;
            }

            try
            {
                using (var client = CreateClient())
                {
                    return SaveContactInListManager(client, firstNameField, lastNameField, emailField, data.ReferenceId);
                }
            }
            catch (XdbExecutionException exception)
            {
                Logger.LogError(exception.Message, exception);
                return false;
            }
        }

        private bool SaveContactInListManager(IXdbContext client, IViewModel firstNameField, IViewModel lastNameField, IViewModel emailField, Guid contactListId)
        {
            try
            {
                var reference = new IdentifiedContactReference("ListManager", GetValue(emailField));

                var expandOptions = new ContactExpandOptions(
                        CollectionModel.FacetKeys.PersonalInformation,
                        CollectionModel.FacetKeys.EmailAddressList,
                        CollectionModel.FacetKeys.ListSubscriptions);

                var executionOptions = new ContactExecutionOptions(expandOptions);

                Contact contact = client.Get(reference, executionOptions);

                if (contact == null)
                {
                    contact = new Sitecore.XConnect.Contact();
                    client.AddContact(contact);
                }

                SetPersonalInformation(GetValue(firstNameField), GetValue(lastNameField), contact, client);
                SetEmail(GetValue(emailField), contact, client);
                SetSubscriptionList(client, contact, contactListId);

                var contactIdentifier = new ContactIdentifier("ListManager", GetValue(emailField), ContactIdentifierType.Known);
                if (!contact.Identifiers.Contains(contactIdentifier))
                {
                    client.AddContactIdentifier(contact, contactIdentifier);
                }

                client.Submit();
                return true;
            }
            catch (XdbExecutionException exception)
            {
                Logger.LogError(exception.Message, exception);
                return false;
            }
        }

        private static void SetPersonalInformation(string firstName, string lastName, Contact contact, IXdbContext client)
        {
            if (string.IsNullOrEmpty(firstName) && string.IsNullOrEmpty(lastName))
            {
                return;
            }

            PersonalInformation personalInfoFacet = contact.Personal() ?? new PersonalInformation();
            if (personalInfoFacet.FirstName == firstName && personalInfoFacet.LastName == lastName)
            {
                return;
            }

            personalInfoFacet.FirstName = firstName;
            personalInfoFacet.LastName = lastName;

            client.SetPersonal(contact, personalInfoFacet);
        }

        private static void SetEmail(string email, Contact contact, IXdbContext client)
        {
            if (string.IsNullOrEmpty(email))
            {
                return;
            }

            EmailAddressList emailFacet = contact.Emails();
            if (emailFacet == null)
            {
                emailFacet = new EmailAddressList(new EmailAddress(email, false), "Preferred");
            }
            else
            {
                if (emailFacet.PreferredEmail?.SmtpAddress == email)
                {
                    return;
                }

                emailFacet.PreferredEmail = new EmailAddress(email, false);
            }

            client.SetEmails(contact, emailFacet);
        }

        private void SetSubscriptionList(IXdbContext client, Contact contact, Guid contactListId)
        {
            var subscriptions = contact.ListSubscriptions();

            var listSubscription = subscriptions?.Subscriptions.FirstOrDefault(sub => sub.ListDefinitionId == contactListId && sub.IsActive == true);

            if (listSubscription != null)
            {
                return;
            }

            if (subscriptions == null)
            {
                subscriptions = new ListSubscriptions();
            }

            var listId = contactListId;
            var isActive = true;
            var added = DateTime.UtcNow;

            ContactListSubscription subscription = new ContactListSubscription(added, isActive, listId);

            subscriptions.Subscriptions.Add(subscription);
            client.SetListSubscriptions(contact, subscriptions);
        }

        protected virtual IXdbContext CreateClient()
        {
            return SitecoreXConnectClientConfiguration.GetClient();
        }

        private static string GetValue(object field)
        {
            return field?.GetType().GetProperty("Value")?.GetValue(field, null)?.ToString() ?? string.Empty;
        }
    }
}

Note: The current code uses hardcoded values to take field references. Thus, the form must have FirstName, LastName, and Email fields.

var firstNameField = formSubmitContext.Fields.FirstOrDefault(field => field.Name.Equals("FirstName"));
var lastNameField = formSubmitContext.Fields.FirstOrDefault(field => field.Name.Equals("LastName")); ;
var emailField = formSubmitContext.Fields.FirstOrDefault(field => field.Name.Equals("Email"));

After building and deploying, update the submit action item with our extended Model Type. Make sure you have updated the submit action fields as below.



Save To Contact List Submit Action Item.

Now the Save To Contact List custom submit action is ready.

Let's Add this Submit Action and Test its Functionality

Create an empty contact list in Launchpad> List Manager > Create > Empty Contact List and name it "Customer Contact List."

Create a Sitecore form and add FirstName, LastName, and Email fields.

Add Submit button and assign "Save To Contact List" Submit Action to it.

Select the newly created Contact list and save the form.

Insert that Sitecore form in a page and save it.

Browse the page and submit the form with provided fields.

Verify the submitted data in Launchpad > List Manager > Contact List > "Customer Contact List."



Save To Contact List - Demo

As shown in the above image, adding the submit action to the forms prompts us to select the contact list. After submitting the form, we can see that the contact has added to the Contact List (List Manager).

But, the form designers have some restrictions here because they are forced to use the same field name in forms we hardcoded in the code. In the next post, we'll look at adjusting it for form designers, allowing them to choose any field name they want and map it to contact parameters. Stay tuned for the forthcoming post.

Happy Learning!!


Submit Action to Save Contacts in List Manager – Basic Implementation

This blog describes how to make any PowerShell script appear in the context menu of an item in Sitecore SXA. As a result, these menu options should only be available when necessary. We'll also see ShowRule and EnableRule fields in the PowerShell script items for hiding/showing and enabling/disabling based on some fundamental Sitecore rules.

Context Menu - When we right-click on any Sitecore item, a menu with multiple options such as Insert, search, duplicate, and so on appears. This menu is known as the Item Context Menu.

PowerShell Script in Context Menu - In Sitecore, we can add PowerShell scripts to the scripts area of the item context menu. The goal of adding Powershell scripts to the context menu is to make it possible to run the script from any item. As a result, it becomes more author-friendly.

Interactive PowerShell Scripts - We can create an interactive PowerShell script using the Sitecore PowerShell Extension. This improves an author's UI experience by displaying dialog boxes with results, outputs, or dialog boxes for taking any inputs from them.

Let's Add PowerShell Script to the Context Menu in Sitecore SXA

Let's start with a simple business scenario: suppose we have a "Zip Codes" list in a CSV file.

We should be able to run the file import on a specific data folder only.

We want all Zip Codes items automatically created inside the target folder. (Assumption: we have the template for the zip code item)

So, in this section, we will write an interactive PowerShell script. This will prompt the user to upload a CSV file via interactive dialogue. We will add the hand to the context menu. This script option should be available only for Zip Code Folder and hidden for any other Sitecore item.

Step 1: Create A PowerShell Script Module.

When we create a Powershell script, we need to save it somewhere. Sitecore PowerShell keeps all PowerShell scripts in the Script Library (PowerShell Script Library).

The script library is located at "Sitecore>System>Modules>PowerShell>Script Library." It organizes the script under modules for easier access.

Under the 'SPE' folder, we will create a folder with a module folder template for our project.

Creating a new folder with my project name, "DailySitecore."

Now, right-click the project folder and select Insert. There are several insert options available here. As shown in the image below, we will select "Module Wizard" to create a new module within our project folder.



To begin the process of creating a new PowerShell script module. When you click on the Module Wizard, a dialogue box will appear, asking for input. Because we only need this module for the context menu, I have only provided the inputs I require.

Give the module a meaningful name.

Check the "Enable Module" checkbox

Choose "Content Editor - Context Menu" from the list

Proceed



A module folder will be created when you click the "Proceed" button. The module folder will have the "Content Tree" and "Context Menu" folders.

Now that your PowerShell script module has been successfully created. You can keep the PowerShell script in the Context Menu folder.

Note: All scripts placed in this folder will now be visible in the Context Menu's Scripts sections for all Sitecore items.

Step 2: Create Interactive PowerShell Script for CSV Import.

Following the creation of the module, we will write an interactive PowerShell script using PowerShell ISE. Here, we can refer to the documentation to learn how to create interactive dialogs using Sitecore PowerShell.

Go to the Launchpad and launch the PowerShell ISE, then write the script shown below.

Upload CSV file
#It will create the folder if it is not found
$dataFolder = [Sitecore.Configuration.Settings]::DataFolder
$tempFolder = $dataFolder + "/tempupload"
$filePath = Receive-File -Path $tempFolder -overwrite -Description "Please Upload a CSV file" -Title "Data Import"
if($filePath -eq "cancel"){exit}

$importRows = Import-CSV $filePath
$index = 1;
$totalRows = $importRows.Count;
$PercentComplete = 0;
New-UsingBlock (New-Object Sitecore.Data.BulkUpdateContext){
    #Data Folder Location
    $item = Get-Item .
    $zipCodeFolderPath = $item.Paths.FullPath

    #Template Location
    $zipCodeTemplatePath = "/sitecore/templates/Project/DailySitecore/Zip Code"

    #Field Name
    $zipcodeItemField = "ZipCode"

    #Check If All Path are Valid
    Function Show-PathNotFound-Message($Path){
        Show-Alert -Title "'$Path' doesn't exist!"
        Write-Host "'$Path' doesn't exist!" -ForegroundColor Red;
        exit
    }

    if (-Not (Test-Path $zipCodeFolderPath)) {
        Show-PathNotFound-Message($zipCodeFolderPath);
    }

    #Get all entries from CSV
    foreach ($row in $importRows)
    {
        Write-Progress -Activity "Processing records ($index / $totalRows)" -Status "$PercentComplete% Complete:" -PercentComplete $PercentComplete

        $zipCode = $row.Zipcode

        Function Show-ErrorMessage($msg){
            Show-Alert -Title "$msg"
            Write-Host $msg -ForegroundColor Red;
            exit
        }
        if($zipCode -eq $null){
            Show-ErrorMessage("CSV should contains header row as Zipcode");
        }

        #Adding ZipCode if Not present
        $zipCodeItemPath = $zipCodeFolderPath+"/"+$zipCode
        if(Test-Path -Path $zipCodeItemPath){
            Write-Host "$zipCode is already Exits" -ForegroundColor Yellow;
        }
        else{
            $item  = New-Item -Path $zipCodeFolderPath -Name $zipCode -ItemType $zipCodeTemplatePath
            $item.Editing.BeginEdit()
            $item[$zipcodeItemField] = $zipCode
            $item.Editing.EndEdit()
            $newZipId = $item.ID;
            Write-Host "$index Item created for: $zipCode";
        }
     $index++;
     $PercentComplete = [int] (($index / $totalRows) * 100)
    }
}

After you've finished, click the save button and navigate to your module's Context Menu folder. Enter a name for the script and press the Select button.



Congratulations! Your script is now complete and appears in the Context Menu. Right-click on any item to confirm that you can now see the script in the menu, as shown in the image below.



But wait, the script will be displayed when you right-click on any item in the Sitecore tree. However, in this case, we only need this script to appear in the Zip Code Data Folder (An item created from a specific template). To accomplish this, we will need to add some rules to the script, which we will see in the next step.

Step 3: Setting up Rules for Script (Show-Rule & Enable-Rule)

Every Powershell script item has two fields: ShowRule and EnableRule. The show-rule and enable-rule are used to control the visibility of the script in the context menu for any item.

ShowRule: This field displays the script option only when the scenario matches the given condition.

EnableRule: This field enables or disables the script option only when the scenario matches the given condition. The script will still be visible but disabled if the condition does not match.

Follow the steps outlined below.

Choose the script item.

Navigate to the Interactive Section and then to the "ShowRule" / "EnableRule" Field

Edit Rules > Add the necessary rule (as shown below)



Only items created from the template "Zip Codes Folder" will display this script. The script option will not be available in the context menu for other Sitecore items.

Note: If you cannot see the fields, this may be due to security concerns; in this case, click on 'Elevate Session' at the top. It will prompt you for credentials before displaying all fields.

Step 4: Change the Appearance of the Script

We can also change how the script option appears. To give the authors a more descriptive appearance. Changing the appearance is similar to changing the appearance of other Sitecore items.

We will change the script's icon and want it to appear in the top second by order in the context menu.

In our case, select the script item 'Zip Code Import' from the CSV Import module in Script Library.

Go to the View tab and enable standard fields to view.

Modify the Icon in the Icon field (select the relevant icon concerning the script's working).

Modify the sort order (to specify an order of appearance in the menu).



Our script is now ready to appear in the context menu of the Zip Code Folder item.

I hope you found this helpful article. Happy Learning!!


Add PowerShell Script to the Context Menu in Sitecore SXA

Background:

There was a scenario where content authors has configured a sxa's search implementation in a page using search component (search result, result count, scope etc). The page is not published yet & it is in progress for editing. Authors have restricted the page for not to publishing.

Issue:

When authors goes to preview the page in Experience Editor, the search result are not showing any records. The search result is blank in Preview Mode of Experience Editor and Error messages are showing at top stating 'Object reference not set to an instance of an object' and 'Item is null'.

Error in preview mode on the search results page

While investigating matter, went to the browsers network tab to see the search API endpoint call. The call was successful & returns response without any error. But response data does not had appropriate data which needed.

Sitecore SXA's Search API response data

We can observe in given screenshot that its giving "7" in result count object which is correct, but giving empty in results object. Which looks odd. 

Findings & Workaround:

After a bit investigation, I found that search API call not getting either page item (from where search is called) or source of search result (defined in scope eg. any folder, any tree node). 

In my case, its was due to my item (page & search source folder) was set to not publishable (never publish). Because of that, Sitecore was not getting the item during search call & we were getting item null error & not results in response.

So conclusion was Sitecore SXA search not work in preview mode if items (or its parent) are set to unpublishable (never publish).

You can also refer to answer of question asked related to similar scenario in community site: preview and unpublishable item.

To fix this issue, check if your item (or its parents) has publishable 'unchecked' then 'check' this option.

To make item publishable follow below steps:

Select Item

Go to 'Publish' tab > Change

In Publishing Settings prompt go to Item tab > mark 'publishable' checked.

Make Sitecore Item Unpublishable

Hope this article was helpful. Happy Learning !

Getting no records for search results in preview mode - Sitecore SXA

In scenarios when we are migrating the website from other platforms to Sitecore CMS. We might have many URL to be get redirect to new URL. In such cases most of the older URLs may also contain extensions like \/oldurl.php, \/oldurlpdfdoc.pdf or ~/oldurl.aspx.

Sitecore SXA's provide redirect feature but with some limitations. Here we get the feasibility to set Redirect but that only work for below scenarios.

Redirecting existing item in Sitecore tree to new.
We can't redirect any link containing extensions like php or pdf.

But again old url can not always be in Sitecore item URL formats and we may need some other solutions apart from this. Hence such requirements can be fulfilled by using Constellation Redirect Manager (an external package for marketing redirects). Please refer the official documentation here. 

Constellation Redirect Manager:

Image: Constellation Redirect Manager

Redirecting any url (without extensions) to new which can be relative or absolute URLs (including other domains).
Including file extension in old URL does not come by default (but can be implemented).

I have read its documentation and found it has mentioned that file extensions can be included in old URLs only if developers can enable to use it in the Constellation Redirect Manager. 

Image: Constellation Documentation for file extensions in URLs.

How to Enable Redirect URLs Containing Extensions Like PDF and PHP Using Constellation Redirect Manager

To make it possible the request should be able to be reach to constellation redirect code. But here the problem is Sitecore NOT allowing any other request with contains file extensions in URL. It only allow the below file extensions in the request.

Image: Config for allow extensions in Sitecore

Because of that any request containing file extension can't reach to constellation program. So, here we add exception for pdf or php so that the request can be reach to constellations redirect code.

Here we will make some changes in Sitecore configurations. We will add the file extensions we want to the Allowed extensions list of the Sitecore configurations.

I have created a separate patch file and will keep Sitecore's existing file extensions (like aspx, ashx, asmx) & file extensions we need (like pdf, php) as shown below. Add this patch file to the respective project App_Config folder.


  
    
      
        
          aspx, ashx, asmx, pdf, php
        
      
    
  


Image: Patch Config file for allow extensions in Sitecore

Here, your Sitecore instance will start allowing the request with pdf and php urls. Now you can add redirect on your Redirect Manager and verify the changes.

Redirect URL with file extensions using Constellation Redirect Manager

Image: "Status Code: 401" error on sxa r cmd

In Sitecore SXA, for theme building, JS & CSS magnification we use "sxa r" command from theme folder. 

Challenge:

Due to some reasons, I was not able to complete the operation and I was getting "Status code: 401 Answer" error continuously on the terminal as shown in above image. I re-verified the credentials but it won't worked. Also I was not able to login to Sitecore. 

After doing some research I found it was blocking the theme to deploy into the Sitecore because Sitecore login was failing. It happens when the login get blocked due to multiple failed login attempts (FailedPasswordAttempt). This is Sitecore Locked situation.

Solution:

Here, we need to unlock the Sitecore login. Lets see how to unlock Sitecore login.

Unlock Sitecore user account:

Scenario 1: If you have direct access to MSSQL server

Select Core database: Run the below SQL command

UPDATE  [aspnet_Membership]
SET     IsLockedOut = 0, 
        FailedPasswordAttemptCount = 0
WHERE   UserId IN (SELECT UserId FROM [aspnet_Users] WHERE UserName = 'sitecore\Admin')

This will reset the IsLockedOut and FailedPaswordAttemptCount & you will be able to login with the respective account and try hitting "sxa r" command again it will work.

Image: SQL command to reset Sitecore User Lock

Scenario 2: Unlock Sitecore user account in Docker.

In my case, my Sitecore instance was running on Docker. So I didn't had direct access to MS SQL. Hence, I opted to replaced the Core database MDF & LDF files with older one I had as backup.

In docker instance, the MDF & LDF file of MS SQL database is located in the data/mssql folder.

eg. YourProjectFolder/docker/data/mssql/

Remember to take backup the mdf & ldf before replacing.

Image: Locate MDF & LDF for MSSQL in Docker

\[U﻿pdate on 26 Dec, 2024]

If you don't have backups or don't want to lose the changes you made in the code database, here's another option you can try. I highly recommend going through this blog by David.



Hope this article was helpful. Please use comment section if you have any suggestions on this.

Happy Learning !

How to Fix Status Code 401 Error on SXA Commands or Unlock Sitecore Admin User

In this article, we will discuss how we can get the value of Rendering Parameter of type droplink.

Challange:

There was a scenario content author should be able to choose the background color from droplink from rendering parameters and I want use the CSS class associated with background color inside the Scriban code.

Image: Droplink source

Image: Rendering Parameter Template

Image: Rendering Parameter Selection Dialog Box

I tried to using sc_parameter like below.

{{ backgroundColor = sc_parameter 'TipBackgroundColor' }}

And tried getting its value directly using {{ backgroundColor.Value }} but it was giving me blank value.

So, I tried to print backgroundColor directly I saw it was printing the ID of the selected item.

Solution:

I found a solution from other sources to get value of selected droplink item. That I am gonna share in this blog.

Here, we can use the ID of item which we are getting and search it in the tree to get the item using sc_query. Then after we can access item'schild field. The example is given below.

Scriban:

{{
  backgroundColorId = sc_parameter 'TipBackgroundColor' 
  backgroundColorCssClass = ''
}}

{{
  for i_child in (sc_query i_item "query:/sitecore/content/Tenant/Site/Presentation/Styles/Background color//*[@@id = '" + backgroundColorId + "']")
    backgroundColorCssClass = i_child.Value
    break
  end
}}

...
...


...


Hope this article was helpful !

Get droplink value of rendering parameter using scriban in Sitecore

This article will cover some of the rules which can be applied in URL Rewrite in IIS or rewriterules.config. The purpose of those rules will be to make the URL more SEO-friendly after the IIS handles the request. In this article, we will discuss two scenarios of URL.

This article is specific to Sitecore but can be helpful for other ASP.NET-based applications as well.

1. URL with Uppercase / Capital Letters:

It is recommended that the URL should be always in lowercase / small letters looking from an SEO perspective. Sometimes if the URL with a capital letter comes in through the request. We can detect it in URL Rewrite and redirect it by converting it to lowercase format. Eg.

URL with Lowercase or small letters (non-SEO friendly):

   https://mysite.local/products/VEHICLES/Wheel Based Arrow/Some Wheel Lok

URL with Uppercase or Capital letters (SEO friendly):

    https://mysite.local/products/vehicles/wheel\-based\-arrow/some\-wheel\-lok

Here, we have replaced the " " (blank space) from the URL with "- " and redirected the request to the newly formed URL.

2. URL with “ ” space in it or URL without Slug:

The URL request without any slug used in it or blank space within the URL is not considered SEO friendly. In such scenarios as well we can use URL Rewrite to redirect by replacing blank spaces with slug. Eg.

URL without Slug (non-SEO friendly):

    https://mysite.local/products/vehicles/wheel based arrow/some wheel lok

URL with Slug (SEO friendly):

    https://mysite.local/products/vehicles/wheel-based-arrow/some-wheel-lok

Here, we have replaced the " " (blank space) from the URL with "-" and redirected the request to the newly formed URL .

Let's see how to achieve it !!! 

Changes in Rewrite rules

Locate to rewriterule.config file of your instance. Normally it is located at C:\inetpub\wwwroot\App_Config .

Add the below rule under the ** node.

For Non Sitecore Applications:

The below rules are specific to the Sitecore instance, if you want to use this for other ASP.Net applications. The file location may be different, to get more details please refer the article from Microsoft. 

For non-Sitecore applications, you can remove conditions from line 5 to 21 (in config shown in both rules) and add new ones as per your need. 

1. Convert uppercase URLs to lowercase URLs:

To match pattern from the URL, we are using  `. Then we set an action to redirect the request using type attribute to the URL using url="{ToLower:{URL}}"`.

We also incorporated some URL patterns related to Sitecore system URLs to avoid the Rewrite Rule effect to it using negate="true". 

At last, we added conditions for all POST requests to be get ignored, so that it should not redirect any POST request.

Rule 1 in Rewriterules.config:

2. Replace blank space from URLs with dash/hyphen (-):

To match pattern from the URL, we are using \\ . Then we set an action to redirect the request using \\.

Rest is almost similar to Rule 1.


	
		
		
			
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
		
    

Now, you can see the rules will be now visible on IIS.

Related Articles:

Here are some articles if you want to explore URL rewrite in IIS:

https://itsmycode.com/sitecore-url-rewrite-redirect-using-iis-module/ 



Rewrite rule to convert URLs to small letters and removing spaces in IIS Website

In some scenarios, a non-sxa Sitecore instance with a multi-site setup may require separate Link Providers for each site. The non-sxa sitecore instance does not have the feasibility to do it directly.  In this article, we will be talking about the simple way to configure a Site-Specific Link Provider. We will create a custom link provider which will work as a link provider switcher. 

The article is inspired by the article "A Switching Link Provider in Sitecore (sitecoreskills.blogspot.com)" with a bit simple latest approach specific to sc9.1. 

Let's get started !!

Related git-hub repository is available here: .

Step 1: Site Definition Config

Set custom site definition attribute for link provider for all sites. Here we are linking Site with LinkProvider by adding a custom attribute.  

For the example, a custom attribute is added for mysite1 same way we can add it to mysite2 as well.

Image - Sitecore Site definition config for Link provider

Step 2: Changes in LinkManager config.

Link Manager Patch File:


    
        
            switcherLinkProvider
            sitecore
            
                
                
                
            
        
    


Image - Link Manager config 



(a) defaultProvider:

We have added a patch attribute in linkManager setting node to define the default link provider. In our case, it must be switcherLinkProvider. 

Eg. 

switcherLinkProvider



(b) fallbackProvider: 

We have added a custom patch attribute in linkManager setting node to define the fallback link provider. It will be used when the custom site definition attribute "linkProvider" is missing from any site setting. In the example, we kept the standard "sitecore" link manager as the fallback provider. It can be changed as per need.

Eg. 

sitecore



(c) We had declared all available site-specific custom link providers. 

Eg.  like mysite1, mysite2 & etc.



At last, we will keep the switcher link provider.

Eg. 



We can also validate all changes in config using the below steps: 

Login to Sitecore admin > Launchpad > Control Panel > Administration Section > Click "Administration tools" > Configuration Section > Click "Show Config"
Search for "linkManager" and validate the changes & order of all link providers. Make sure that switchLinkProvider should be at last.

Step 3: Back-end implementation for Switch Link Provider

Here, we have created a separate helix project for SwitchLinkManger named "DailySitecore.SwitchLinkManager". 

Created a new folder named "links" & added a class with the name "SwitchLinkProvider" which is inherited from LinkProvider.
Created a constructor, and added logic to get the fallback provider value from the config file & stored it in a variable. 
Created GetContextProvider() method to logically decide the related linkProvider for the context site to be returned.

To get all available linkproviders:

var providerHelper = ServiceLocator.GetRequiredResetableService>();

To get linkProvider of current site (context site):

var providerName = Sitecore.Context.Site.Properties["linkProvider"];

NOTE:

"LinkManager.Provider" is deprecated in Sitecore 9 so we can use the below code as an alternative to get linkprovider.

var providerHelper = ServiceLocator.GetRequiredResetableService>();

LinkProvider myLinkProvider = providerHelper?.Value?.Providers["providerName"]

If providerName for the site is set then it will return the linkProvider which contains a key similar to the providerName variable. Otherwise, it will return the fallback link provider using _fallbackProvider value.

Now, override all options of linkprovider and use GetContextProvider to get values.

SwitchLinkProvider.cs file:

using System.Web;
using System.Xml;
using Sitecore.Configuration;
using Sitecore.Data.Items;
using Sitecore.DependencyInjection;
using Sitecore.Links;
using Sitecore.Web;

namespace DailySitecore.SwitchLinkManager.Links
{
    public class SwitchLinkProvider : LinkProvider
    {
        private string _fallbackProvider;

        public SwitchLinkProvider()
        {
            XmlNode linkManagerNode = Factory.GetConfigNode("linkManager");
            _fallbackProvider = linkManagerNode.Attributes["fallbackProvider"].Value;
        }

        private LinkProvider GetContextProvider()
        {
            var providerHelper = ServiceLocator.GetRequiredResetableService>();
            var providerName = Sitecore.Context.Site.Properties["linkProvider"];
            return !string.IsNullOrEmpty(providerName) ? providerHelper?.Value?.Providers[providerName] : providerHelper?.Value?.Providers[_fallbackProvider];
        }

        public override bool AddAspxExtension
        {
            get { return GetContextProvider().AddAspxExtension; }
        }

        public override bool AlwaysIncludeServerUrl
        {
            get { return GetContextProvider().AlwaysIncludeServerUrl; }
        }

        public override bool EncodeNames
        {
            get { return GetContextProvider().EncodeNames; }
        }

        public override LanguageEmbedding LanguageEmbedding
        {
            get { return GetContextProvider().LanguageEmbedding; }
        }

        public override LanguageLocation LanguageLocation
        {
            get { return GetContextProvider().LanguageLocation; }
        }

        public override bool LowercaseUrls
        {
            get { return GetContextProvider().LowercaseUrls; }
        }

        public override bool ShortenUrls
        {
            get { return GetContextProvider().ShortenUrls; }
        }

        public override bool UseDisplayName
        {
            get { return GetContextProvider().UseDisplayName; }
        }

        public override string ExpandDynamicLinks(string text, bool resolveSites)
        {
            return GetContextProvider().ExpandDynamicLinks(text, resolveSites);
        }

        public override UrlOptions GetDefaultUrlOptions()
        {
            return GetContextProvider().GetDefaultUrlOptions();
        }

        public override string GetDynamicUrl(Item item, LinkUrlOptions options)
        {
            return GetContextProvider().GetDynamicUrl(item, options);
        }

        public override string GetItemUrl(Item item, UrlOptions options)
        {
            return GetContextProvider().GetItemUrl(item, options);
        }

        public override bool IsDynamicLink(string linkText)
        {
            return GetContextProvider().IsDynamicLink(linkText);
        }

        public override DynamicLink ParseDynamicLink(string linkText)
        {
            return GetContextProvider().ParseDynamicLink(linkText);
        }

        public override RequestUrl ParseRequestUrl(HttpRequest request)
        {
            return GetContextProvider().ParseRequestUrl(request);
        }
    }
}

References

https://www.partech.nl/en/publications/2017/06/how-to-get-the-deprecated-linkmanager-provider-and-providers-now#

A Switching Link Provider in Sitecore (sitecoreskills.blogspot.com)

Latest Sitecore & .NET Development Articles

Sitecore CDP and Personalize APIs Practical Reference

Automating Component-Level Personalization in Sitecore XM Cloud: From APIs to an AI-Assisted Workflow

Sitecore CM Login Not Redirecting to Identity Server? Troubleshooting Guide

Sitecore Marketplace App - Authentication, Testing & Conclusion (Part 2)

Publications & Contributions

Technical Skills

Sitecore

Sitecore Modules

Search

DevOps

Backend

Frontend

Latest Sitecore & .NET Development Articles

Sitecore CDP and Personalize APIs Practical Reference

Automating Component-Level Personalization in Sitecore XM Cloud: From APIs to an AI-Assisted Workflow

Sitecore CM Login Not Redirecting to Identity Server? Troubleshooting Guide

Sitecore Marketplace App - Authentication, Testing & Conclusion (Part 2)

I am Ravindra Mishra

Publications & Contributions

Perficient Blogs

Daily Sitecore Blogs

GitHub Profile

Sitecore Stack Exchange

Awards & Recognition

Q3 2023 - Appreciation Award

Q2 2022 - Appreciation Award

Q3 2021 - Appreciation Award

CRM Project Implementation - Recognition

Technical Skills

Sitecore

Sitecore Modules

Search

DevOps

Backend

Frontend