Skip to main content

Create Sitecore Custom Admin Page

Create Sitecore Custom Admin Page




Sitecore provides you lots of Admin pages just like ShowConfig.aspx, cache.aspx, Logs.aspx, howServicesConfig.aspx, etc. which you can check from here http://<yoursite>/sitecore/admin/. All Sitecore Admin pages is available in this folder “sitecore/admin/*”

admin, adminpage, custom admin page, Sitecore,



Sometimes there can be requirement that you want to create custom Admin page which will be accessible to Admin/Non-Admin user.

Here is an example:

  • Create aspx page “CustomAdminPage.aspx” inside “<root>/sitecore/admin” folder
 <%@ Page Language="C#" AutoEventWireup="true" CodeBehind="CustomAdminPage.aspx.cs" Inherits="Namespace.CustomAdminPage" %>  
 <!DOCTYPE html>  
 <html xmlns="http://www.w3.org/1999/xhtml">  
 <head runat="server">  
   <title>Custom Admin Page</title>  
   <link rel="stylesheet" type="text/css" href="/sitecore/shell/Themes/Standard/Default/WebFramework.css" />  
   <link rel="Stylesheet" type="text/css" href="./default.css" />  
 </head>  
 <body>  
   <form id="form1" runat="server" class="wf-container">  
     <div class="wf-content">  
       <h1>Custom Admin Page  
       </h1>  
         <div class="root">  
           <asp:button runat="server" text="Click" ID="btnClick" OnClick="btnClick_Click"/>  
           <br />  
           <asp:Label ID="lblMessage" runat="server"></asp:Label>  
       </div>  
     </div>  
   </form>  
 </body>  
 </html>  
 
  • Implement server-side code 
  • Add "Sitecore.Client" assembly

 namespace Namespace  
 {  
   public partial class CustomAdminPage : AdminPage  
   {  
     protected void Page_Load(object sender, EventArgs e)  
     {  
     }  
     protected override void OnInit(EventArgs e)  
     {  
       //CheckSecurity will check that user should have admin rights  
       CheckSecurity(true);  
       base.OnInit(e);  
     }  
     protected void btnClick_Click(object sender, EventArgs e)  
     {  
       lblMessage.Text = "Button Clicked";  
    // Do your custom code  
     }  
   }  
 }  
  • Now go to in browser and type http://<yoursite>/sitecore/admin/CustomAdminPage.aspx
admin, adminpage, custom admin page, Sitecore,

Comments

Saddam Mohd said…
from where we can sitecore.client assembly and where we need to add?

Swati Gupta said…
In project, where are you implementing CustomAdminPage class. Sitecore.Client is require for AdminPage. You can find Sitecore.Client via Nuget
Anjum Rizwi said…
Thank you for writing blog. It helped me a lot.

I was searched a lot then I found this "Add "Sitecore.Client" assembly"
Anjum Rizwi said…
In Helix architecture project, use Sitecore.Client.NoReferences so that no need to overwrite. Sitecore.Client.dll in website root bin folder

Popular posts from this blog

Sitecore 10.2 - “Failed to start service ‘Sitecore Marketing Automation Engine’” on Windows 11

Sitecore 10.2 - “Failed to start service ‘Sitecore Marketing Automation Engine' ” on Windows 11 Today I started to install Sitecore 10.2 using Sitecore Instance Manager on Windows 11 and I got this issue “Failed to start service ‘Sitecore Marketing Automation Engine' ” . Error : On event viewer it was showing the below error: I also tried to run ‘ Sitecore.MAEngine.exe ’ like this C:\Windows\system32>C:\inetpub\wwwroot\sclocal102xconnect.dev.local\App_Data\jobs\continuous\AutomationEngine\Sitecore.MAEngine.exe Which was throwing below error: Starting Marketing Automation Engine... 2022-01-29 22:21:11 ERR Error initializing XConnect client. System.AggregateException: One or more errors occurred. ---> Sitecore.XConnect.XdbCollectionUnavailableException: An error occurred while sending the request. ---> System.Net.Http.HttpRequestException: An error occurred while sending the request. ---> System.Net.WebException: The underlying connection was closed: An unexpected err...

Sitecore Custom API Issue with Federation Authentication

Sitecore Custom API Issue with Federation Authentication In earlier segments, detailed in Part 1 and Part 2 of the blogs on Keycloak Integration with Sitecore, I introduced Keycloak functionality for CM login. Concurrently, I addressed a necessity to develop custom APIs for retrieving Sitecore users and roles. Following the development of custom APIs, during authentication failures, the API erroneously returned a status code of 200 instead of 401. The problem arose because API requests were being routed through the "owin.identityProviders" pipeline, which was not intended for API usage. Solution: When OWIN identifies a 401 response and the AuthenticationMode is set to "Active," it fails to capture the URL hash included in the request. Another choice is to activate the "Passive" AuthenticationMode, wherein OWIN refrains from actively intercepting 401 responses. In passive mode, your application needs to explicitly issue a Challenge to trigger the OWIN aut...

Azure AD Integration with Sitecore 10.2

 Azure AD Integration with Sitecore 10.2 Sitecore identity server that comes with Sitecore 9.1 allows you to log in through an external identity provider like Azure Active Directory, Facebook, Apple, or Google. It is built on Federation Authentication. What is Federation Authentication? Federation authentication is a technology to allows users to access multiples application, tools, and domains using one credential. Using one set of credential user can access multiple applications, and resources after authentication.  Federation authentication consists of two systems, the Identity provider and the Service provider. Identity providers that maintain/create/manage identity information like name, email address, device, and location. Some examples of identity providers are Azure AD, Google, Facebook, and Apple. Service providers basically refer to a website, software, or app that the user is trying to access and SP basically relies on the identity provider to authenticate the user ...