Defining Managed Object Schema using Groovy

As referenced in my previous post(Defining Schema for Managed Objects using Javascript), OpenIDM allows you to decide what goes in and what is visible outside. In this section we are going to write a groovy script to allow only a certain list of attributes to be entered. Below is the groovy script code:

def allowedAttributes = ["userName","givenName","mail","_id","password","sn","department","country","creator","startdate","status","designation","isManager"];
Map jvMap = object.asMap();
Set keys = jvMap.keySet();
for( key in keys)
{
if(!allowedAttributes.contains(key))
throw new Exception("Attribute "+key+" not allowed");
}

We can change the attributes list as per our requirement. We need to reference this in Managed.json as below:

managed.json

Similarly, if we can reference this script on "onUpdate" to control the attributes while updating the managed object.

Defining Schema for Managed Objects using Javascript

OpenIDM allows any attributes to be pushed for a Managed Object, which makes it a easy to customize as per the requirement. To allow only certain set of attributes to be pushed for a certain managed object, we need to create a script.

Let us consider an example, I want the managed user object to just have the below mentioned attributes:

_id (Mandatory attribute for Managed Object. This is defined internally so we cannot skip this)
userName
givenName
sn
mail

Now to implement this let's go to managed.json and reference the script under Managed Object User as below:

managed.json

Now go to this path bin\defaults\script\ui and create the javascript with below piece of code:

/*Initializing non-mandatory attributes*/

if ( !object.mail )           { object.mail = ""; }
if ( !object.sn )          { object.sn = ""; }


/*Checking the allowed attributes*/
var requestContentAttribute;
var allowedObjectAttributes = ["_id","userName","givenName","mail","sn"];
var index = 0;

    for (requestContentAttribute in object)
    {
var fl = null;
for(index = 0; index < allowedObjectAttributes.length ; index++)
{

if(allowedObjectAttributes[index] === requestContentAttribute)
{
fl = true;
}

}
if (fl == null){
throw("Attribute Not Allowed!!!! " + requestContentAttribute);
}
       
    }

Now try to create a user with attributes other than that provided above, error message should get displayed:

CreatUserRequest

Error Message in Logs

Now try creating a user with only allowed attributes, user will be created successfully...:)

Creating Managed Objects in OpenIDM

We can create as many managed object as we want in OpenIDM as per our requirement. To create a managed object, we just need to introduce the entry in /conf/managed.json file as below:

managed.json