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

Toolkit - Dynamic Content Queries

This post if part of a series about the  File System Toolkit  - a custom content delivery API for SDL Tridion. This post presents the Dynamic Content Query capability. The requirements for the Toolkit API are that it should be able to provide CustomMeta queries, pagination, and sorting -- all on the file system, without the use third party tools (database, search engines, indexers, etc). Therefore I had to implement a simple database engine and indexer -- which is described in more detail in post Writing My Own Database Engine . The querying logic does not make use of cache. This means the query logic is executed every time. When models are requested, the models are however retrieved using the ModelFactory and those are cached. Query Class This is the main class for dynamic content queries. It is the entry point into the execution logic of a query. The class takes as parameter a Criterion (presented below) which triggers the execution of query in all sub-criteria of a Criterio

A DD4T.net 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

Scaling Policies

This post is part of a bigger topic Autoscaling Publishers in AWS . In a previous post we talked about the Auto Scaling Groups , but we didn't go into details on the Scaling Policies. This is the purpose of this blog post. As defined earlier, the Scaling Policies define the rules according to which the group size is increased or decreased. These rules are based on instance metrics (e.g. CPU), CloudWatch custom metrics, or even CloudWatch alarms and their states and values. We defined a Scaling Policy with Steps, called 'increase_group_size', which is triggered first by the CloudWatch Alarm 'Publish_Alarm' defined earlier. Also depending on the size of the monitored CloudWatch custom metric 'Waiting for Publish', the Scaling Policy with Steps can add a difference number of instances to the group. The scaling policy sets the number of instances in group to 1 if there are between 1000 and 2000 items Waiting for Publish in the queue. It also sets the