Current Release

Previous
Create server-side Business Objects
Next
Server-Side – Access Connectors

Server-Side Business Object API

7495 views 5

You can access any methods, like Logging, Utils/Tools, Email, Connectors, Business Objects, Plugins, Users, Permissions, Groups and Roles of Simplifier by using the Simplifier object.

Variables marked with question marks are optional parameters.

Connectors

Connectors

Simplifier.Connector.<ConnectorName>.<CallName>
Executes a connector call. The input parameters are defined in the input object (payload).
Input : (payload?: string|object) Result: object

input object structure depends on the input parameters configured in the connector call

 The result object of the defined connector call, as defined in the output parameters.

Examples:

var connectorCallResult = Simplifier.Connector.Fruits.selectAllFruits({});
var connectorCallResult2 = Simplifier.Connector.Fruits.insertFruit({name: "apple", color: "red"});

 

Simplifier.Connector.<ConnectorName>
**DEPRECATED** Executes a connector. The connector call and the input parameters are defined in the input object (payload).
Input : (payload?: string|object) Result: object

input object structure depends on the connector type (SQL, SOAP, etc.)

For example, for SQL:

request: String
mode: String

 The result object of the defined connector call.

Example:

var connectorResult = Simplifier.Connector.Fruits({request: "SELECT * FROM Fruit;", mode: "query"});

Business Objects

Business Objects

Simplifier.BusinessObject.<BusinessObjectName>.<FunctionName>
Executes a server-side business object function.
Input : (payload?: string|object, parametrized?: boolean = true) Result: object

payload: Object – the input parameters, as defined in the business object function. If the function has no input parameters, the payload can either be an empty object or omitted
parametrized: Boolean? (default: true)

 The result object of the business object function, as defined in the output parameters.

Examples:

var oResult = Simplifier.BusinessObject.ITIZ_User.getUserDataByUsername({s_username: "trainer"});
var oResultUnparametrized = Simplifier.BusinessObject.ITIZ_User.getUserDataByUsername("{\"s_username\": \"trainer\"}", false);

 

Simplifier.CurrentBusinessObject.<FunctionName>
Executes a server-side business object function contained within the currently used server-side business object.
Input : (payload?: string|object, parametrized?: boolean = true) Result: object

payload: Object – the input parameters, as defined in the business object function. If the function has no input parameters, the payload can either be an empty object or omitted
parametrized: Boolean? (default: true)

 The result object of the business object function, as defined in the output parameters.

Examples:

var oResult = Simplifier.CurrentBusinessObject.getUserDataByUsername({s_username: "trainer"});
var noArgsResult = Simplifier.CurrentBusinessObject.getFruits();

 

.

Plugin

Plugins

Simplifier.Plugin.<PluginName>.<SlotName>
Executes a slot of a Simplifier plugin.
Input : (payload?: string|object) Result: object

payload: Object – the input parameters, as defined in the plugin slot

 The result object of the executed plugin slot.

Examples:

var aRepositories = Simplifier.Plugin.contentRepoPlugin.contentRepositoryList(); 
var oNewRepo = Simplifier.Plugin.contentRepoPlugin.contentRepositoryAdd({name: "MyRepo"});

Email

Email

Simplifier.Email.sendTemplateMail
Sends an email based on a template.
Input : (payload?: string|object) Result: ()

payload: Object

templateNamespace: String,
templateName: String,
emailCharset: String,
emailMime: String,
sender: String,
receiver: String,
receiverCC?: Array(String),
receiverBCC?: Array(String),
replyTo?: Array(String),
subject: String,
data: Object (input parameters of the email template. If the template has no input parameters, set data to an empty object),
attachments?: Array(AttachmentObject)

 

AttachmentObject: Object

mimeType: String,
fileName: String,
b64Data?: String (base64-encoded PDF file),
uploadSession?: String (ID of the upload session)

Example:

Simplifier.Email.sendTemplateMail({    
templateNamespace: "MyNamespace", // folder of template
templateName: "MyTemplate", // template id
emailCharset: "UTF-8", // Charset
emailMime: "text/html",  // html MIME-Type 
sender: "sender@test.de", // sender email
receiver: "test@test.de",  // receiver email
receiverCC: ["cc@test.de"],  // list of carbon copy email (s)
receiverBCC: ["bcc@test.de"], // list of blind carbon copy email(s)
replyTo: ["test@test.de"], // list of reply-to email(s)
subject: "My Mail", // subject
data: {"Var1": "Replacement1"}, // input parameters for template
attachments: [
// attachments can directly send via base 64 encoded string
               {
                mimeType: "application/pdf",
                fileName: "test.pdf",
                b64Data: "base64EncodedPdfFile"
                }, 
// or a simplifier business app upload session id
                {
                mimeType: "image/jpeg",
                fileName: "test.jpg",
                uploadSession: "upload-session-id"
                }
        ]
});

Util

Utils

Simplifier.Util.encodeBase64
Encodes a string to base64. 
Input : (string) Result: string

inputString: the string to encode

 The encoded string, in base64 format

 

Simplifier.Util.decodeBase64
Decodes a base64-encoded string. 
Input : (string) Result: string

inputString: the string in base64 format

 The decoded string

Examples:

var encoded = Simplifier.Util.encodeBase64("String to encode");
var decoded = Simplifier.Util.decodeBase64(encoded);

 

Simplifier.Util.xml2json
Converts a string in XML format to a stringified JSON.
Input : (string) Result: string

xml: the string in XML format

 The stringified JSON

 

Simplifier.Util.xml2jsonValue
Converts a string in XML format to a JSON object.
Input : (string) Result: object

xml: the string in XML format

 The JSON object

Examples:

var sStringifiedJSON = Simplifier.Util.xml2json("<root><test>hello</test></root>");
var oJSON = Simplifier.Util.xml2jsonValue("<root><test>hello</test></root>");

 

Simplifier.Util.json2xml
Converts a stringified JSON to a string in XML format.
Input : (string) Result: string

json: the stringified JSON

 The string in XML format

 

Simplifier.Util.jsonValue2xml
Converts a JSON object to a string in XML format.
Input : (object) Result: string

json: the JSON object

 The string in XML format

Examples:

var sXmlFromStringifiedJSON = Simplifier.Util.json2xml(JSON.stringify({test: "hello"}));
var sXmlFromJSON = Simplifier.Util.jsonValue2xml({test: "hello"});

Log

Logging

Simplifier.Log.info
Creates a log entry with level INFO.
Input : (string, string|object?) Result: ()
message: String
details?: String|Object		 – 
Simplifier.Log.info(message: string, details: string|object): void

 

Simplifier.Log.warn
Creates a log entry with level WARNING.
Input : (string, string|object?) Result: ()
message: String
details?: String|Object		 – 
Simplifier.Log.warn(message: string, details: string|object): void

 

Simplifier.Log.error
Creates a log entry with level ERROR.
Input : (string, string|object?) Result: ()
message: String
details?: String|Object		 – 
Simplifier.Log.error(message: string, details: string|object): void

 

Simplifier.Log.critical
Creates a log entry with level CRITICAL.
Input : (string, string|object?) Result: ()
message: String
details?: String|Object		 – 
Simplifier.Log.critical(message: string, details: string|object): void

 

Simplifier.Log.debug
Creates a log entry with level DEBUG.
Input : (string, string|object?) Result: ()
message: String
details?: String|Object		 – 
Simplifier.Log.debug(message: string, details: string|object): void

Examples:

These examples apply to all log levels.

Simplifier.Log.warn("Test log entry");

Simplifier.Log.info("Test log entry with Details", "Details String");

Simplifier.Log.error("Test log entry with Details", {'key': 'value'}); 
 
Simplifier.Log.info("test", ["Array",1337,42.1,null,true, {key:"value"},[1,3,3,7]]);
 
Simplifier.Log.critical("test", 1337);
 
Simplifier.Log.debug("test", 42.1);
 
Simplifier.Log.info("test", null);
 
Simplifier.Log.warn("test", true);

User

Get Users

Simplifier.User.getAll
Retrieves all users on the current Simplifier instance.
Input : () Result: Array(object)
– 
[{
  id: Number,
  login: String,
  firstName: String,
  lastName: String,
  email: String,
  mobileNumber: String,
  salutation: String,
  activeFrom: String,
  activeTill: String,
  active: Boolean,
  blocked: Boolean,
  externalUser: Boolean,
  createdOn: String,
  lastLogin: String,
  preferredLanguage: String
}]

 

Simplifier.User.getById
Retrieves the user with the given ID. Also retrieves the user’s roles, groups and attributes.
Input: (number) Result: object|null
id: Number 
{
  id: Number,
  login: String,
  firstName: String,
  lastName: String,
  email: String,
  mobileNumber: String,
  salutation: String,
  activeFrom: String,
  activeTill: String,
  active: Boolean,
  blocked: Boolean,
  externalUser: Boolean,
  createdOn: String,
  lastLogin: String,
  preferredLanguage: String,
  attributes:
  [{
    name: String,
    category: String,
    value: String,
    description: String
  }],
  roles:
  [{
    id: String,
    name: String,
    description: String,
    active: Boolean
  }],
  groups:
  [{
    id: Number,
    name: String,
    description: String
  }]
}

 

Simplifier.User.getByName
Retrieves the user with the given login name. Also retrieves the user’s roles, groups and attributes.
Input: (string) Result: object|null
loginName: String 
{
  id: Number,
  login: String,
  firstName: String,
  lastName: String,
  email: String,
  mobileNumber: String,
  salutation: String,
  activeFrom: String,
  activeTill: String,
  active: Boolean,
  blocked: Boolean,
  externalUser: Boolean,
  createdOn: String,
  lastLogin: String,
  preferredLanguage: String,
  attributes:
  [{
    name: String,
    category: String,
    value: String,
    description: String
  }],
  roles:
  [{
    id: String,
    name: String,
    description: String,
    active: Boolean
  }],
  groups:
  [{
    id: Number,
    name: String,
    description: String
  }]
}

 

Simplifier.User.getCurrentUser
Retrieves the currently logged in user. Also retrieves the user’s roles, groups and attributes. (the roles-Array will only be present in the response if the currentUser has the role/right to read the roles.)
Input: () Result: object|null
– 
{
  id: Number,
  login: String,
  firstName: String,
  lastName: String,
  email: String,
  mobileNumber: String,
  salutation: String,
  activeFrom: String,
  activeTill: String,
  active: Boolean,
  blocked: Boolean,
  externalUser: Boolean,
  createdOn: String,
  lastLogin: String,
  preferredLanguage: String,
  attributes:
  [{
    name: String,
    category: String,
    value: String,
    description: String
  }],
  roles:
  [{
    id: String,
    name: String,
    description: String,
    active: Boolean
  }],
  groups:
  [{
    id: Number,
    name: String,
    description: String
  }]
}

 

Examples

var oMyUser = Simplifier.User.getById(12);
var oMyUser = Simplifier.User.getByName("MyUserLoginName");
var oCurrentUser = Simplifier.User.getCurrentUser();

Create, update and delete a User

Simplifier.User.create
Creates a new user.
Input: (data: object) Result: object 
data: Object
{
  login: String,
  firstName: String,
  lastName: String,
  email: String,
  mobileNumber: String?,
  salutation: String?,
  activeFrom: String?,
  activeTill: String?,
  active: Boolean?,
  blocked: Boolean?,
  preferredLanguage: String?
  roles: [String]?,
  groups: [Number]?,
  attributes: [{ name: String, category: String, value: String, description: String? }]?
}
 
{
  id: Number,
  login: String,
  firstName: String,
  lastName: String,
  email: String,
  mobileNumber: String,
  salutation: String,
  activeFrom: String,
  activeTill: String,
  active: Boolean,
  blocked: Boolean,
  externalUser: Boolean,
  createdOn: String,
  lastLogin: String,
  preferredLanguage: String,
  attributes:
  [{
    name: String,
    category: String,
    value: String,
    description: String
  }],
  roles:
  [{
    id: String,
    name: String,
    description: String,
    active: Boolean
  }],
  groups:
  [{
    id: Number,
    name: String,
    description: String
  }]
}

 

Simplifier.User.createWithActivationMail
Creates a new user and sends an email for the user to activate their account.
Input: (object) Result: () 
data: Object
{
  userData:
  {
    login: String,
    firstName: String,
    lastName: String,
    email: String,
    mobileNumber: String?,
    salutation: String?,
    activeFrom: String?,
    activeTill: String?,
    active: Boolean?,
    blocked: Boolean?,
    preferredLanguage: String?,
    roles: [String]?,
    groups: [Number]?,
    attributes: [{ name: String, category: String, value: String, description: String? }]?
  },
  emailConfig: 
  {
    templateNamespace: String,
    templateName: String,
    registrationUri: String - the URL of the Simplifier app where the user can set their password,
    subject: String?,
    emailMime: String = "text/html",
    emailCharset: String = "UTF-8",
    additionalData: Object? 
  }
}
 
{
  id: Number,
  login: String,
  firstName: String,
  lastName: String,
  email: String,
  mobileNumber: String,
  salutation: String,
  activeFrom: String,
  activeTill: String,
  active: Boolean,
  blocked: Boolean,
  externalUser: Boolean,
  createdOn: String,
  lastLogin: String,
  preferredLanguage: String,
  attributes:
  [{
    name: String,
    category: String,
    value: String,
    description: String
  }],
  roles:
  [{
    id: String,
    name: String,
    description: String,
    active: Boolean
  }], 
  groups:
  [{
    id: Number,
    name: String,
    description: String
  }]
}

With this call you can pass your own (or different per user group) registrationUrl. This registrationUrl will be prefixed to the {{link}} placeholder of your custom email template, which is mandatory to work with this BO call.

Additionally you will need to implement the registrationUri yourself (e.g with an App, that extracts the oneTimeHashToken). When the registrationUri is called and a password has been defined by the user, you need to call  Simplifier.User.activateWithOneTimeLink to complete the activation of the the user.

 

Simplifier.User.update
Updates the user identified by the assigned login name.
Input: (loginName: string, data: object) Result: object 
loginName: String
data: Object{
  firstName: String,
  lastName: String,
  email: String,
  mobileNumber: String?,
  salutation: String?,
  activeFrom: String?,
  activeTill: String?,
  active: Boolean?,
  blocked: Boolean?,
  preferredLanguage: String?,
  roles: [String]?,
  groups: [Number]?,
  attributes: [{ name: String, category: String, value: String, description: String? }]?
}
 
{
  id: Number,
  login: String,
  firstName: String,
  lastName: String,
  email: String,
  mobileNumber: String,
  salutation: String,
  activeFrom: String,
  activeTill: String,
  active: Boolean,
  blocked: Boolean,
  externalUser: Boolean,
  createdOn: String,
  lastLogin: String,
  preferredLanguage: String,
  attributes:
  [{
    name: String,
    category: String,
    value: String,
    description: String
  }],
  roles:
  [{
    id: String,
    name: String,
    description: String,
    active: Boolean
  }],
  groups:
  [{
    id: Number,
    name: String,
    description: String
  }]
}

 

Simplifier.User.updateImage
Updates the user’s profile image.
Input: (loginOrId: string|number, data: object) Result: () 
loginOrId: String|Number - the user ID or login name
data: object - the image data
{
  uploadId: String - the session ID of the uploaded image,
  mimeType: String
}

 

Simplifier.User.delete
Deletes a user identified by the given ID.
Input: (number) Result: ()

id: Number

 –

 

Simplifier.User.checkLogin
Checks whether a user can login providing the given credentials. 
Input: (string, string) Result: (boolean)

login: String

password: String

 true, false 


		

	


Allowed language codes for preferredLanguage are:


bg_BG, ca_ES, hr_HR, cs_CZ, da_DK, nl_NL, en_US, et_EE, fi_FI, fr_FR, de_DE, el_GR, hi_IN, hu_HU, it_IT, ja_JP, kk_KZ, ko_KR, lv_LV, lt_LT, ms_MY, mt_MT, no_NO, pl_PL, pt_PT, ro_RO, ru_RU, zh_CN, sk_SK, sl_SL, es_ES, sv_SE, th_TH, zh_TW, tr_TR, uk_UA, vi_VN



	

		

			
Examples


var oNewUser = Simplifier.User.create({
    login: "janedoe",
    firstName: "Jane",
    lastName: "Doe",
    email: "jande.doe@testmail.com",
    mobileNumber: "123456789",
    salutation: "Miss",
    roles: ["131702554218077DC71EBD1A569CC81025ADDE6D48F3000291192B88E2D64CA3"], // IDs of existing roles
    groups: [1,2], // IDs of existing groups
    attributes: [{name: "Department", category: "Company", value: "Berlin", description: "company departments"}]
});
var oUpdatedUser = Simplifier.User.update("janedoe", {
    firstName: "updatedFirstName",
    lastName: "updatedLastName",
    email: "updatedEmail",
    mobileNumber: "updatedMobileNumber",
    active: true,
    blocked: true,
    salutation: "Miss",
    roles: ["15BEB553CC701C8C6488AD823E052BECD18F12969027EE286AE6F1294C8DF1E2"], // IDs of existing roles
    groups: [2], // IDs of existing groups
    attributes: [{name: "Department", category: "Company", value: "Munich", description: "company departments"}]
});
var oCurrentUser = Simplifier.User.getCurrentUser();
if (oCurrentUser) {
   if (oCurrentUser.id) {
     Simplifier.User.updateImage(oCurrentUser.id, {
            uploadId: input.profileImage, // the upload session ID
            mimeType: "image/jpeg" // mime type of the image
     });
   }
}
var oNewUserWithActivationMail = Simplifier.User.createWithActivationMail({ 
    userData: { 
        login: "janedoe", 
        firstName: "Jane",
        lastName: "Doe",
        email: "jande.doe@testmail.com",
        mobileNumber: "123456789",
        salutation: "Miss",
        roles: ["131702554218077DC71EBD1A569CC81025ADDE6D48F3000291192B88E2D64CA3"], // IDs of existing roles
        groups: [1,2], // IDs of existing groups
        attributes: [{name: "Department", category: "Company", value: "Berlin", description: "company departments"}]
    },
    emailConfig: {
        templateNamespace: "MyNamespace", // folder of template 
        templateName: "MyTemplate",
        registrationUri: "https://www.simplifier.io/example" , // the URL of the Simplifier app where the user can set the new password
        subject: "Set your password now!",
        emailMime: "text/html",
        emailCharset: "UTF-8"
    }
 });




		

	


	

		

			
User Role and Group assignment






Simplifier.User.assignRole




Assigns the role with the given ID to the user with the given ID/login name.




Input: (string|number, string)
Result: ()




loginOrId: String|Number –  User login name or user ID


roleId: String

–






 






Simplifier.User.unassignRole




Removes the given role from the given user.




Input: (string|number, string)
Result: ()




loginOrId: String|Number –  User login name or user ID

roleId: String		
–






 






Simplifier.User.assignGroup




Assigns the group with the given ID to the user with the given ID/login name.




Input: (string|number, number)
Result: ()




loginOrId: String|Number –  User login name or user ID


groupId: Number

–






 






Simplifier.User.unassignGroup




Removes the given group from the given user.




Input: (string|number, number)
Result: ()




loginOrId: String|Number –  User login name or user ID


groupId: String

–






 






Simplifier.User.getBusinessRoles




Retrieves all business roles of the current logged in user.




Input: ()
Result: Array (object)





[project: String


businessRole: String]







 






Simplifier.User.getBusinessRolesInProject




Retrieves all business roles of the current logged in user within a given project.




Input: (string)
Result: Array (string)




projectID: String – ID of the project
[“roleName1”, “roleName2]






 






Simplifier.User.checkBusinessRole




Checks if the current logged in user has a specific business role within a given project.




Input: (string, string)
Result: (boolean)




projectID: string – ID of the project


roleName: string – Name of the Business Role

true, false






 






Simplifier.User.assignBusinessRole




Assigns the business role with the given name and project to the user, identified by the given login name. 




Input: (string, string, string)
Result: ()




loginName: String – The user’s login name


projectID: String – ID of the project


roleName: String – Name of the Business Role








 






Simplifier.User.unassignBusinessRole




Removes the given business role from the given user.




Input: (string, string, string)
Result: ()




loginName: String – The user’s login name


projectID: String – ID of the project


roleName: String – Name of the Business Role








 


Examples


Simplifier.User.assignRole(21, "131702554218077DC71EBD1A569CC81025ADDE6D48F3000291192B88E2D64CA3");
Simplifier.User.assignGroup("myUserLogin", 1);
var bHasBusinessRole = Simplifier.User.checkBusinessRole("MYPROJECT", "administrator");
Simplifier.User.assignBusinessRole("myUserLogin", "MYPROJECT", "administrator");





		

	


	

		

			
User Attributes






Simplifier.User.getAttributes




Retrieves all attributes of the user identified by the given loginName/ID.




Input: (string|number)
Result: Array (object)






loginOrId: String –  User login name or user ID




[{
  name: String,
  category: String,
  value: String,
  description: String
}]








 






Simplifier.User.getAttribute




Retrieves the attribute with the given name and category of a user identified by the given loginName/ID. 




Input: (string|number, string, string)
Result: (object | null)




loginOrId: String|Number –  User login name or user ID

name: String – name of the attribute

category: String – attribute category		


{
  name: String,
  category: String,
  value: String,
  description: String
}








 






Simplifier.User.setAttribute




Sets (adds or updates) an attribute of the user identified by the given loginName/ID.




Input: (string|number, string, string, string)
Result: ()






loginOrId: String –  User login name or user ID


name: String – name of the attribute


category: String – attribute category


value: String – new value for the attribute

–






 






Simplifier.User.deleteAttribute




Deletes the given attribute of the user identified by the given loginName/ID.




Input: (string|number, string, string)
Result: ()






loginOrId: String|Number –  User login name or user ID


name: String – name of the attribute


category: String – attribute category

–






 


Examples


var oAttribute = Simplifier.User.getAttribute("myUserLogin", "attributeName", "attributeCategory");
Simplifier.User.getAttribute("myUserLogin", "attributeName", "attributeCategory", "attributeValue");
Simplifier.User.deleteAttribute("myUserLogin", "attributeName", "attributeCategory");





		

	


	

		

			
User Password and Activation






Simplifier.User.activateWithOneTimeLink




Sets a user password for the provided one-time-hash.




Input: (string)
Result: ()






oneTimeHash: String – The URL Query Parameter that is generated via resetPasswordWithEmailTemplate to validate the Passwort Reset Link (resetURI)


newPassword: String – new Passwort


–






 






Simplifier.User.resendActivationMail




Sends the activation mail again to the given user.




Input: (object)
Result: ()






data: Object
{
  login: String,
  email: String,
  emailConfig: {
    templateNamespace: String,
    templateName: String,
    registrationUri: String - the URL of the Simplifier app where the user can set their password,
    subject: String?,
    emailMime: String = "text/html",
    emailCharset: String = "UTF-8",
    additionalData: Object?
  }
}


–






 






Simplifier.User.resetPasswordWithEmailTemplate




Sends an email with a template for password restoration and resets the password for the provided user identified by the given ID or login name.




Input: (string|number, object)
Result: ()




 


 


loginOrId: String|Number - ID or login name of the user
emailData : Object
{
  templateNamespace: String,
  templateName: String,
  resetURI: String - the URL of the Simplifier app where the user can set the new password,
  subject: String?,
  emailMime: String = "text/html",
  emailCharset: String = "UTF-8",
  additionalData: Object?
}


–






 






Simplifier.User.setPassword




Sets a user password for the provided one-time-hash.




Input: (string, string)
Result: ()






oneTimeHash: String – The URL Query Parameter that is generated via resetPasswordWithEmailTemplate to validate the Passwort Reset Link (resetURI)


newPassword: String – new Passwort


–








		

	


Group

	

		

			
Groups






Simplifier.Group.getAll










Returns all groups on the current Simplifier instance.










Input : ()
Result: Array[object]




–
[{


id: Number,

groupName: String,

description: String


}]







 






Simplifier.Group.getById










Returns the group with the given ID. Also returns the users that are assigned to this group.










Input : (number)
Result: object|null




id: Number
{


id: Number,

groupName: String,

description: String,

assignedUsers:

[{

id: Number,

loginName: String,

firstName: String,

lastName: String,

email: String

}]


}







 






Simplifier.Group.getByName










Returns the group with the given name. Also returns the users that are assigned to this group.










Input : (string)
Result: object|null




groupName: String
{


id: Number,

groupName: String,

description: String,

assignedUsers:

[{

id: Number,

loginName: String,

firstName: String,

lastName: String,

email: String

}]


}







 






Simplifier.Group.getUsersByGroup










Returns all users that are members of the given group ID.










Input : (number)
Result: object|null




id: Number
[{

id: Number,

loginName: String,

firstName: String,

lastName: String,

email: String

}]		






Examples


var aAllGroups = Simplifier.Group.getAll();
var oMyGroup = Simplifier.Group.getByName("Group1");
var aUsersOfGroup = Simplifier.Group.getUsersByGroup(1);


 






Simplifier.Group.create










Creates a new group with the given details.










Input : (data: object)
Result: object|null




data: Object


{


name: String,

description: String,

assignedUserIDs: [Number]


}

{


id: Number,

groupName: String,

description: String,

assignedUsers:

[{

id: Number,

loginName: String,

firstName: String,

lastName: String,

email: String

}]


}







 






Simplifier.Group.update




Updates an existing group with the given group data.




Input : (id: number, data: object)
Result: object|null




id: Number

data: Object{

name: String,

description: String,

assignedUserIDs: [Number]

}		
{


id: Number,

groupName: String,

description: String,

assignedUsers:

[{

id: Number,

loginName: String,

firstName: String,

lastName: String,

email: String

}]


}







 






Simplifier.Group.delete










Deletes the group with the given ID.










Input : (number)
Result: ()




id: Number







Examples


var oNewGroup = Simplifier.Group.create({name: "NewGroup", description: "this is a new group", assignedUserIDs: [1,2]});
var oUpdatedGroup = Simplifier.Group.update(1, {name: "MyGroup", description: "updated description", assignedUserIDs: [1,2,3]});
Simplifier.Group.delete(1);


		

	


Role

	

		

			
Roles






Simplifier.Role.getAll










Returns all roles on the current Simplifier instance.










Input : ()
Result: Array[object]




–
[{


id: String,

roleName: String,

active: Boolean,

description: String


}]







 






Simplifier.Role.getById










Returns the role with the given ID. Also returns the users that are assigned to this role as well as the permissions that are included in this role.










Input : (string)
Result: object|null




id: String
{


id: String,

roleName: String,

active: Boolean,

description: String,

assignedUsers:

[{

id: Number,

loginName: String,

firstName: String,

lastName: String,

email: String

}],

permissions:

[{

technicalName: String,

name: String,

description: String,

characteristicTechnicalName: String,

characteristicName: String,

characteristicDescription: String,

characteristicValue: [String],

characteristicDisplayType: String

}]


}







 






Simplifier.Role.getByName










Returns the role with the given name. Also returns the users that are assigned to this role as well as the permissions that are included in this role.










Input : (string)
Result: object|null




roleName: String
{


id: String,

roleName: String,

active: Boolean,

description: String,

assignedUsers:

[{

id: Number,

loginName: String,

firstName: String,

lastName: String,

email: String

}],

permissions:

[{

technicalName: String,

name: String,

description: String,

characteristicTechnicalName: String,

characteristicName: String,

characteristicDescription: String,

characteristicValue: [String],

characteristicDisplayType: String

}]


}







 






Simplifier.Role.getUsersByRole










Returns all users that are members of the given role ID.










Input : (string)
Result: object|null




id: String
[{

id: Number,

loginName: String,

firstName: String,

lastName: String,

email: String

}]		






Examples


var aAllRoles = Simplifier.Role.getAll();
var oMyRole = Simplifier.Role.getByName("administratorRole");
var aUsersOfRole = Simplifier.Role.getUsersByRole("B119B78BE474FF875A9F6A411C762E1AB298F251D57DA73BE355844B3B3C719C);


 






Simplifier.Role.create










Creates a new role with the given details.










Input : (data: object)
Result: object|null




data: Object


{


name: String,

active: Boolean,

description: String,

assignedUsers: [Number],

permissions:

[{

technicalName: String,

characteristic: String,

value: [String]

}]


}

{


id: String,

roleName: String,

active: Boolean,

description: String,

assignedUsers:

[{

id: Number,

loginName: String,

firstName: String,

lastName: String,

email: String

}],

permissions:

[{

technicalName: String,

name: String,

description: String,

characteristicTechnicalName: String,

characteristicName: String,

characteristicDescription: String,

characteristicValue: [String],

characteristicDisplayType: String

}]


}







 






Simplifier.Role.update




Updates an existing role with the given role data.




Input : (id: string, data: object)
Result: object|null




id: String

data: Object{

name: String,

active: Boolean,

description: String,

assignedUsers: [Number],

permissions:

[{

technicalName: String,

characteristic: String,

value: [String]

}]}		
{


id: String,

roleName: String,

active: Boolean,

description: String,

assignedUsers:

[{

id: Number,

loginName: String,

firstName: String,

lastName: String,

email: String

}],

permissions:

[{

technicalName: String,

name: String,

description: String,

characteristicTechnicalName: String,

characteristicName: String,

characteristicDescription: String,

characteristicValue: [String],

characteristicDisplayType: String

}]


}







 






Simplifier.Role.delete










Deletes the role with the given ID.










Input : (string)
Result: ()




id: String







Examples


var oNewRole = Simplifier.Role.create({name: "NewRole", active: true, description: "this is a new role"});

var oNewRole2 = Simplifier.Role.create({
       name: "NewRole2",
       active: true,
       assignedUsers: [1,2,3],
       permissions: [{
               technicalName: "com.itizzimo.app.MyTestApp", // app has to be existent
               characteristic: "execute",
               value: ["true"]
       }],
       description: "created via Business Object API"});

var oUpdatedRole = Simplifier.Role.update("B119B78BE474FF875A9F6A411C762E1AB298F251D57DA73BE355844B3B3C719C", {name: "MyRole", active: false, description: "updated description"});

Simplifier.Role.delete("B119B78BE474FF875A9F6A411C762E1AB298F251D57DA73BE355844B3B3C719C");




		

	


Permissions

	

		

			
Permissions






Simplifier.Permission.checkPermission










Checks whether the current logged in user has the granted permission characteristic for the provided permission name.










Input : (string, string)
Result: boolean






permissionName: String,

characteristic: String


Indicates if the current logged in user has the specified permission characteristic (true/false)






 






Simplifier.Permission.checkPermissionCharacteristic










Checks whether the current logged in user has the granted permission characteristic value for the provided characteristic and the provided permission name.










Input : (string, string, string)
Result: boolean






permissionName: String,

characteristic: String,

characteristicValue: String


Indicates if the current logged in user has the specified permission characteristic value (true/false)






Examples:


var bHasCharacteristic = Simplifier.Permission.checkPermission("com.itizzimo.Certificates", "edit");
var bHasCharacteristicValue = Simplifier.Permission.checkPermissionCharacteristic("com.itizzimo.Certificates", "edit", "true");




Permission Objects






Technical name of permission
characteristics




com.itizzimo.BusinessObject
admin




com.itizzimo.Certificates
delete

assign

view

edit

download

create

admin		




com.itizzimo.ChangeLog
read

write		




com.itizzimo.ClientBusinessObject
admin




com.itizzimo.Connector
admin




com.itizzimo.DataType
admin




com.itizzimo.DbDesigner
admin




com.itizzimo.ErrorLog
admin




com.itizzimo.Group
read

create

delete

edit

assign		




com.itizzimo.Job
admin




com.itizzimo.Library
admin




com.itizzimo.Marketplace
read

sell

buy		




com.itizzimo.PermissionTemplate
admin




com.itizzimo.Plugin
admin




com.itizzimo.Role
create

assign

edit

read

delete		




com.itizzimo.SendEmail
send




com.itizzimo.ServerSettings
ServerSettings

SecuritySettings

Auth		




com.itizzimo.SystemLibrary
admin




com.itizzimo.SystemMessage
create

delete

update

read		




com.itizzimo.Template
admin




com.itizzimo.TestAllApps
execute




com.itizzimo.TestAllConnectors
execute




com.itizzimo.Transport
import

create

export

approve		




com.itizzimo.UiDesigner
create

edit

delete

view

admin		




com.itizzimo.Uploader
allowUpload




com.itizzimo.User
edit

read

create

readSelf

editSelf

delete		




com.itizzimo.Widget
admin




com.itizzimo.WidgetGroup
admin




com.itizzimo.app.APPNAME
view

execute

delete

edit

releasemeta		




com.itizzimo.businessobject.BUSINESSOBJECTNAME
view

execute

delete

edit		




com.itizzimo.clientbusinessobject.CLIENTBUSINESSOBJECTNAME
view

delete

edit		




com.itizzimo.connector.CONNECTORNAME
view

delete

edit

execute		




com.itizzimo.job.JOBNAME
view

delete

edit		




com.itizzimo.loginmethod.LOGINMETHODNAME
view

delete

edit		




com.itizzimo.plugin.ContentRepo
AccessForeignFile

CreateRepository

PermissionObjectType

MimeMappings

PermissionObjectID		




com.itizzimo.plugin.PdfGeneration
manageTemplates

generatePdf		






		

	


System

	

		

			
System






Simplifier.System.getActiveInstance










Returns the details of the active Simplifier instance.










Input : ()
Result: Object





{


“name”: the technical name of the active instance,

“url”: the url path of the active instance,

“description”:  the description of the active instance,

“type”: the type of the active instance (‘Develop‘/’Quality‘/’Production‘/’Custom‘)

“active”:  flag if the instance is active (true/false)


}







 






Simplifier.System.getInstances










Returns the details of all Simplifier instances that are configured in the Server Environment Settings.










Input : ()
Result: Array(Object)





[{


“name”: the technical name of the instance,

“url”: the url path of the instance,

“description”:  the description of the instance,

“type”: the type of the instance (‘Develop‘/’Quality‘/’Production‘/’Custom‘)

“active”:  flag if the instance is active (true/false)


}]







Examples:


var oActiveInstance = Simplifier.System.getActiveInstance();
var aConfiguredInstances = Simplifier.System.getInstances();


		

	


Template

	

		

			
Plugins






Simplifier.Template.<TemplateFolderName>.<TemplateName>










Renders the given template with the given input parameters and returns it as a string.










Input : (payload?: object)
Result: string






payload: Object – the input parameters of the template


The rendered template with the given input parameter values.






Examples:


var sRenderedTemplate = Simplifier.Template.FeedbackAppTemplates.RequiredRoleCheck_RoleMissing({username: "currentUserName"}).Template;


		

	




		
		
			

				
Related Articles