Skip to main content

JQuery JavaScript Client for CoreService

In my previous post, I presented a JavaScript CoreService client that was using the out-of-the-box Visual Studio project and a WCF generated JS proxies using the Microsoft AJAX framework.

In this blog post, I write about a JQuery client for CoreService that is lighter and only depends on JQuery. I took my inspiration from Yoav's blog post Creating a Webservice Proxy with jQuery

The server part remains untouched. This means I can only focus on the JavaScript client.

CoreService is secured with Basic or Federated authentication. I am focusing on Basic auth in this post, mainly because it is so simple to use from JS.

The main entry point in the code is the ServiceProxy class. This is where we define the constructor and where we set the endpoint to use for CoreService and the username, password combination to use.

The ServiceProxy makes use of the JQuery's $.ajax function, where it performs a POST to the CoreService endpoint, sets the payload to send, Authorization header and the success, failed callback functions.

ServiceProxy = function (adminUser, adminPassword, endpoint) {
    this._basicAuth = "Basic " + btoa(adminUser + ":" + adminPassword);
    this._baseURL = endpoint;

ServiceProxy.prototype =
    _defaultErrorHandler: function (xhr, status, error) {
        alert(xhr.status + " " + xhr.statusText + "\r\n" + xhr.responseText);

    _doAjax: function (method, data, fnSuccess, fnError, isAsync) {
        if (!data) data = {};
        if (isAsync == undefined) isAsync = true;
        if (!fnError) fnError = this._defaultErrorHandler;

            type: "POST",
            url: this._baseURL + method,
            data: data,
            contentType: "application/json; charset=utf-8",
            headers: { "Authorization": this._basicAuth },
            success: fnSuccess,
            error: fnError,
            async: isAsync

    getCurrentUser: function (success, error) {
        this._doAjax("GetCurrentUser", null, success, error);

The code above also declares method getCurrentUser, which calls the CoreService GetCurrentUser method without posting any payload.


The sample code below connects to the CoreService endpoint defined earlier and performs a sample call to retrieve the current user.

Notice that the JS code only requires the JQuery library and the ServiceProxy we defined earlier.

Since we are declaring contentType as application/json, JQuery will parse and decode the JSON response from the web-service into a JavaScript object.

<!DOCTYPE html>
    <script src="jquery-1.10.2.js"></script>
    <script src="ServiceProxy.js"></script>
    <script type="text/javascript">
        var proxy = new ServiceProxy("mihai@adfs", "p@assword",

        function userSuccess(result) {
            if (!result) {
                alert("no result");

            if (result.hasOwnProperty("d")) {
                result = result.d;

            alert("Retrieved user: " + result.Id + " | " + result.Description);

        $(document).ready(function () {


Popular posts from this blog

A Implementation - Custom Binary Publisher

The default way to publish binaries in DD4T is implemented in class DD4T.Templates.Base.Utils.BinaryPublisher and uses method RenderedItem.AddBinary(Component) . This produces binaries that have their TCM URI as suffix in their filename. In my recent project, we had a requirement that binary file names should be clean (without the TCM URI suffix). Therefore, it was time to modify the way DD4T was publishing binaries. The method in charge with publishing binaries is called PublishItem and is defined in class BinaryPublisher . I therefore extended the BinaryPublisher and overrode method PublishItem. public class CustomBinaryPublisher : BinaryPublisher { private Template currentTemplate; private TcmUri structureGroupUri; In its simplest form, method PublishItem just takes the item and passes it to the AddBinary. In order to accomplish the requirement, we must specify a filename while publishing. This is the file name part of the binary path of Component.BinaryConten

Event System to Create Mapped Structure Groups for Binary Publish

As a continuation of last week's Publish Binaries to Mapped Structure Group , this week's TBB is in fact the Event System part of that solution. Make sure you do check out the previous post first, which explains why and what this Event System does. To reiterate, the Event System intercepts a Multimedia Component save, take its Folder path and create a 1-to-1 mapping of Structure Groups. The original code was written, again, by my colleague Eric Huiza : [ TcmExtension ( "MyEvents" )] public class EventsManager  : TcmExtension {     private Configuration configuration;     private readonly Regex SAFE_DIRNAME_REGEX = new Regex ( @"[\W_]+" );     public EventsManager() {         ExeConfigurationFileMap fileMap = new ExeConfigurationFileMap ();         fileMap.ExeConfigFilename = Path .GetDirectoryName( Assembly .GetExecutingAssembly().Location) + "\\EventSystem.config" ;         configuration = ConfigurationManager

Running sp_updatestats on AWS RDS database

Part of the maintenance tasks that I perform on a MSSQL Content Manager database is to run stored procedure sp_updatestats . exec sp_updatestats However, that is not supported on an AWS RDS instance. The error message below indicates that only the sa  account can perform this: Msg 15247 , Level 16 , State 1 , Procedure sp_updatestats, Line 15 [Batch Start Line 0 ] User does not have permission to perform this action. Instead there are several posts that suggest using UPDATE STATISTICS instead: I stumbled upon the following post from 2008 (!!!), , which describes a way to wrap the call to sp_updatestats and execute it under a different user: create procedure dbo.sp_updstats with execute as 'dbo' as