Skip to main content

Create User from JavaScript Client Using CoreService

This post presents some sample code on how to create a Tridion user from JavaScript client using the CoreService. It is based on the setup presented in previous posts and it only makes use of JQuery library.

The logic below is also assigning the newly created user to certain Tridion Groups identified either by TCMURI, Name or Description. This means the code will first call the CoreService to retrieve a list of groups, then identify those we need to assign the user to, then create the UserData object with all group memberships set, and then finally send the request to create the user to CoreService.

The code below is to be inserted into the ServiceProxy class. The entry point is the createUser method, which takes as parameters the user account, user name, and an array of groups to assign the new user. It also takes a success and fail callback functions.

The code makes use of a number of classes defined below, such as UserData, GroupMembershipData, LinkToGroupData, etc.

The logic follows roughly the following algorithm:
  • Create user data object and assign user account and user name into it
  • For each group in the array groups
    • find corresponding Tridion group
    • create link to Tridion group using its TCMURI
    • push group membership into the user data
  • send user data to CoreService to create user

createUser: function (userAccount, userName, groups, success, error) {
    var user = new UserData();
    user.Title = userAccount;
    user.Description = userName;
    user.GroupMemberships = [];

    var i = 0;
    while (groupName = groups[i++]) {
        var group = this.findGroup(groupName);
        if (!group) {
            error("Cannot find group " + groupName);
            return;
        }

        var linkToGroup = new LinkToGroupData();
        linkToGroup.IdRef = group.Id;

        var groupMembership = new GroupMembershipData();
        groupMembership.Group = linkToGroup;

        user.GroupMemberships.push(groupMembership);
    }

    var data = JSON.stringify({ data: user, readBackOptions: {} });
    this._doAjax("Create", data, success, error);
},

loadGroups: function () {
    var groups;
    var filter = new GroupsFilterData();
    this._doAjax("GetSystemWideList", JSON.stringify({ filter: filter }), function (result) {
        if (result.hasOwnProperty("d")) {
            result = result.d;
        }
        groups = result;
    }, null, false);

    return groups;
},

getGroups: function () {
    if (!this._groups) {
        this._groups = this.loadGroups();
    }
    return this._groups;
},

findGroup: function (name) {
    if (name.startsWith("tcm:")) {
        return { Id: "<TcmUri xmlns=\"http://www.sdltridion.com/ContentManager/R6\">" + name + "</TcmUri>" };
    }

    var groups = this.getGroups();
    if (!groups) return null;

    var i = 0;
    while (group = groups[i++]) {
        if (name == group.Description || name == group.Title) {
            return group;
        }
    }

    return null;
}

Method findGroup retrieves a list of Groups from Tridion and matches the group given as parameter into the list of groups by TCMURI, description or title.

Method getGroups retrieves an array of the cached groups it has, otherwise it loads the groups from the server.

Method loadGroups performs the actual retrieving of a list of groups from Tridion, by performing a synchronous (uhhh... bad) AJAX call to CoreService and sending a request to GetSystemWideList method and passing in a GroupsFilterData object.

The data classes used above are defined as follows. They are simply identifying the call with a namespace, so that CoreService knows which method to invoke on the web-service:

GroupsFilterData = function () {
    this.__type = "GroupsFilterData:http://www.sdltridion.com/ContentManager/R6"
}

GroupMembershipData = function () {
    this.__type = "GroupMembershipData:http://www.sdltridion.com/ContentManager/R6"
}

LinkToGroupData = function () {
    this.__type = "LinkToGroupData:http://www.sdltridion.com/ContentManager/R6"
}

UserData = function () {
    this.__type = "UserData:http://www.sdltridion.com/ContentManager/R6"
}

The code calling the createUser method above is the following:

function createSuccess(result) {
    if (!result) {
        alert("no result");
        return;
    }

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

    alert("Created user with ID: " + result.Id);
}

function createFail(result) {
    if (!result) {
        alert("no result");
        return;
    }

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

    if (result.hasOwnProperty("responseText")) {
        result = result.responseText;
    }

    alert("Failed: " + result);
}

$(document).ready(function () {
    var userAccount = "ADFS\\mihai";
    var userName = "Mihai Cadariu";
    var groups = ["System Administrator", "tcm:0-3-65568"];

    proxy.createUser(userAccount, userName, groups, createSuccess, createFail);
});




Comments

Popular posts from this blog

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: https://dba.stackexchange.com/questions/145982/sp-updatestats-vs-update-statistics I stumbled upon the following post from 2008 (!!!), https://social.msdn.microsoft.com/Forums/sqlserver/en-US/186e3db0-fe37-4c31-b017-8e7c24d19697/spupdatestats-fails-to-run-with-permission-error-under-dbopriveleged-user , 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

Content Delivery Monitoring in AWS with CloudWatch

This post describes a way of monitoring a Tridion 9 combined Deployer by sending the health checks into a custom metric in CloudWatch in AWS. The same approach can also be used for other Content Delivery services. Once the metric is available in CloudWatch, we can create alarms in case the service errors out or becomes unresponsive. The overall architecture is as follows: Content Delivery service sends heartbeat (or exposes HTTP endpoint) for monitoring Monitoring Agent checks heartbeat (or HTTP health check) regularly and stores health state AWS lambda function: runs regularly reads the health state from Monitoring Agent pushes custom metrics into CloudWatch I am running the Deployer ( installation docs ) and Monitoring Agent ( installation docs ) on a t2.medium EC2 instance running CentOS on which I also installed the Systems Manager Agent (SSM Agent) ( installation docs ). In my case I have a combined Deployer that I want to monitor. This consists of an Endpoint and a

SDL Web 8 - Content Delivery Microservices

Among the new features in SDL Web 8 there are the Content Delivery Microservices, namely: Audience Manager Content Deployer Contextual Image Delivery Discovery Service Dynamic Content Dynamic Linking Profiling and Personalization Metadata Query Taxonomy User Generated Content These microservices make up the Content Interaction Services and they expose the existing Content Delivery in-process APIs as RESTful services. They provide the server-side component in a Services-Oriented Architecture and act as data layer between the the web client and the Content Delivery Storage Layer. According to the SDL marketing, these microservices: Simplify upgrades, thus offering shorter time to value Modernize architecture, offering better separation between the web application and Tridion APIs Offer more flexibility with less downtime and improved scalability Improve quality, being self-running, contained and having less dependencies In technical words, these microservices