Serverseitige Business Objekt API

Sie können auf alle Methoden wie Logging, Utils/Tools, E-Mail, Konnektoren, Business Objekte, Plugins, Benutzer, Berechtigungen, Gruppen und Rollen von Simplifier zugreifen, indem Sie das Simplifier-Objekt verwenden.

Mit Fragezeichen gekennzeichnete Variablen sind optionale Parameter.

KI

KI-Live-Übersetzung

Simplifier.AI.translate
Übersetzt die angegebenen Daten in die definierte Zielsprache
Eingabe:	Ergebnis: beliebig
sourceLanguage (String) , targetLanguage (Array) , values (String\|Array\|Object) ** * Verwenden Sie einen unterstützten 5-Buchstaben-Sprachcode, z. B. de_DE ** Alle enthaltenen Zeichenfolgenwerte werden übersetzt. Objektschlüssel werden nicht übersetzt	Gleiche Struktur wie Eingabewerte

Beispiele:

var oData = Simplifier.AI.translate("de_DE", ["en_US"], "Hello World!");

var oData = Simplifier.AI.translate("de_DE", ["en_US"], ["Hello", "World!"]);

var oData = Simplifier.AI.translate("de_DE", ["en_US"], {"greeting":"Hello", "name":"World!");

Konnektoren

Simplifier.Connector.<ConnectorName>.<CallName>
Führt einen Konnektoraufruf aus. Die Eingabeparameter sind im Eingabeobjekt (Payload) definiert.
Eingabe: (Payload?: string\|object)	Ergebnis: object
Die Struktur des Eingabeobjekts hängt von den im Konnektoraufruf konfigurierten Eingabeparametern ab	Das Ergebnisobjekt des definierten Konnektoraufrufs, wie in den Ausgabeparametern definiert.

Beispiele:

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

Simplifier.Connector.<ConnectorName>
VERALTET Führt einen Konnektor aus. Der Konnektoraufruf und die Eingabeparameter sind im Eingabeobjekt (Payload) definiert.
Eingabe: (Payload?: string\|object)	Ergebnis: object
Die Struktur des Eingabeobjekts hängt vom Connector-Typ ab (SQL, SOAP usw.) Zum Beispiel für SQL: request: String mode: String	Das Ergebnisobjekt des definierten Konnektoraufrufs.

Beispiel:

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

Business Objekte

Simplifier.BusinessObject.<BusinessObjectName>.<FunctionName>
Führt eine serverseitige Business Objekt Funktion aus.
Eingabe: (Payload?: string\|object, parametrized?: boolean = true)	Ergebnis: object
Payload: Object – die Eingabeparameter, wie in der Business Objekt Funktion definiert. Wenn die Funktion keine Eingabeparameter hat, kann die Payload entweder ein leeres Objekt sein oder weggelassen werden parametrized: Boolean? (Standard: true)	Das Ergebnisobjekt der Business Objekt Funktion, wie in den Ausgabeparametern definiert.

Beispiele:

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

Simplifier.CurrentBusinessObject.<FunctionName>
Führt eine serverseitige Business Objekt Funktion aus, die im aktuell verwendeten serverseitigen Business Objekt enthalten ist.
Eingabe: (Payload?: string\|object, parametrized?: boolean = true)	Ergebnis: object
Payload: Object – die Eingabeparameter, wie in der Business Objekt Funktion definiert. Wenn die Funktion keine Eingabeparameter hat, kann die Payload entweder ein leeres Objekt sein oder weggelassen werden parametrized: Boolean? (Standard: true)	Das Ergebnisobjekt der Business Objekt Funktion, wie in den Ausgabeparametern definiert.

Beispiele:

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

Plugin

Plugins

Simplifier.Plugin.<PluginName>.<SlotName>
Führt einen Slot eines Simplifier-Plugins aus.
Eingabe: (Payload?: string\|object)	Ergebnis: object
Payload: Object – die Eingabeparameter, wie im Plugin-Slot definiert	Das Ergebnisobjekt des ausgeführten Plugin-Slots.

Beispiele:

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

E-Mail

Simplifier.Email.sendTemplateMail
Sendet eine E-Mail basierend auf einer Vorlage.
Eingabe: (Payload?: string\|object)	Ergebnis: ()
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 (Eingabeparameter der E-Mail-Vorlage. Wenn die Vorlage keine Eingabeparameter hat, setzen Sie data auf ein leeres Objekt), attachments?: Array(AttachmentObject) AttachmentObject: Object mimeType: String, fileName: String, b64Data?: String (Base64-kodierte PDF-Datei), uploadSession?: String (ID der Upload-Session)

Beispiel:

Simplifier.Email.sendTemplateMail({  
templateNamespace: "MyNamespace", // Ordner der Vorlage
templateName: "MyTemplate", // Vorlagen-ID
emailCharset: "UTF-8", // Zeichensatz
emailMime: "text/html", // html MIME-Type  
sender: "sender@test.de", // Absender E-Mail
receiver: "test@test.de", // Empfänger E-Mail
receiverCC: ["cc@test.de"], // Liste der Carbon Copy E-Mail(s)
receiverBCC: ["bcc@test.de"], // Liste der Blind Carbon Copy E-Mail(s)
replyTo: ["test@test.de"], // Liste der Reply-To E-Mail(s)
subject: "My Mail", // Betreff
data: {"Var1": "Replacement1"}, // Eingabeparameter für Vorlage
attachments: [
// Anhänge können direkt über Base64-kodierten String gesendet werden
  {
  mimeType: "application/pdf",
  fileName: "test.pdf",
  b64Data: "base64EncodedPdfFile"
  },  
// oder eine Simplifier Business App Upload-Session-ID
  {
  mimeType: "image/jpeg",
  fileName: "test.jpg",
  uploadSession: "upload-session-id"
  }
  ]
});

Util

Utils

Simplifier.Util.encodeBase64
Kodiert eine Zeichenfolge in Base64.
Eingabe: (string)	Ergebnis: string
inputString: die zu kodierende Zeichenfolge	Die kodierte Zeichenfolge im Base64-Format

Simplifier.Util.decodeBase64
Dekodiert eine Base64-kodierte Zeichenfolge.
Eingabe: (string)	Ergebnis: string
inputString: die Zeichenfolge im Base64-Format	Die dekodierte Zeichenfolge

Beispiele:

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

Simplifier.Util.xml2json
Konvertiert eine Zeichenfolge im XML-Format in ein Stringified JSON.
Eingabe: (string)	Ergebnis: string
xml: die Zeichenfolge im XML-Format	Das Stringified JSON

Simplifier.Util.xml2jsonValue
Konvertiert eine Zeichenfolge im XML-Format in ein JSON-Objekt.
Eingabe: (string)	Ergebnis: object
xml: die Zeichenfolge im XML-Format	Das JSON-Objekt

Beispiele:

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

Simplifier.Util.json2xml
Konvertiert ein Stringified JSON in eine Zeichenfolge im XML-Format.
Eingabe: (string)	Ergebnis: string
json: das Stringified JSON	Die Zeichenfolge im XML-Format

Simplifier.Util.jsonValue2xml
Konvertiert ein JSON-Objekt in eine Zeichenfolge im XML-Format.
Eingabe: (object)	Ergebnis: string
json: das JSON-Objekt	Die Zeichenfolge im XML-Format

Beispiele:

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

Log

Logging

Simplifier.Log.info
Erstellt einen Logeintrag mit Level INFO.
Eingabe: (string, string\|object?)	Ergebnis: ()
message: String details?: String\|Object	–

Simplifier.Log.info(message: string, details: string|object): void

Simplifier.Log.warn
Erstellt einen Logeintrag mit Level WARNING.
Eingabe: (string, string\|object?)	Ergebnis: ()
message: String details?: String\|Object	–

Simplifier.Log.warn(message: string, details: string|object): void

Simplifier.Log.error
Erstellt einen Logeintrag mit Level ERROR.
Eingabe: (string, string\|object?)	Ergebnis: ()
message: String details?: String\|Object	–

Simplifier.Log.error(message: string, details: string|object): void

Simplifier.Log.critical
Erstellt einen Logeintrag mit Level CRITICAL.
Eingabe: (string, string\|object?)	Ergebnis: ()
message: String details?: String\|Object	–

Simplifier.Log.critical(message: string, details: string|object): void

Simplifier.Log.debug
Erstellt einen Logeintrag mit Level DEBUG.
Eingabe: (string, string\|object?)	Ergebnis: ()
message: String details?: String\|Object	–

Simplifier.Log.debug(message: string, details: string|object): void

Beispiele:

Diese Beispiele gelten für alle Log-Level.

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);

Benutzer

Benutzer abrufen

Simplifier.User.getAll
Ruft alle Benutzer der aktuellen Simplifier-Instanz ab.
Eingabe: ()	Ergebnis: 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
Ruft den Benutzer mit der angegebenen ID ab. Ruft auch die Rollen, Gruppen und Attribute des Benutzers ab.
Eingabe: (number)	Ergebnis: 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
Ruft den Benutzer mit dem angegebenen Anmeldenamen ab. Ruft auch die Rollen, Gruppen und Attribute des Benutzers ab.
Eingabe: (string)	Ergebnis: 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
Ruft den aktuell angemeldeten Benutzer ab. Ruft auch die Rollen, Gruppen und Attribute des Benutzers ab. (Das Rollen-Array ist nur in der Antwort vorhanden, wenn der aktuelle Benutzer die Rolle/das Recht zum Lesen der Rollen hat.)
Eingabe: ()	Ergebnis: 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 }], Gruppen: [{ id: Number, name: String, description: String }] }

Beispiele

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

Benutzer erstellen, aktualisieren und löschen

Simplifier.User.create
Erstellt einen neuen Benutzer.
Eingabe: (Daten: Objekt)	Ergebnis: Objekt
Daten: Objekt { 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 }], Rollen: [{ id: String, name: String, description: String, active: Boolean }], Gruppen: [{ id: Number, name: String, description: String }] }

Simplifier.User.createWithActivationMail
Erstellt einen neuen Benutzer und sendet eine E-Mail, damit der Benutzer sein Konto aktivieren kann.
Eingabe: (Objekt)	Ergebnis: ()
Daten: Objekt { 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 - die URL der Simplifier-App, in der der Benutzer sein Passwort festlegen kann, 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, Attribute: [{ name: String, category: String, value: String, description: String }], Rollen: [{ id: String, name: String, description: String, active: Boolean }], Gruppen: [{ id: Number, name: String, description: String }] }

Mit diesem Aufruf können Sie Ihre eigene (oder eine andere pro Benutzergruppe) registrationUrl übergeben. Diese registrationUrl wird dem Platzhalter {{link}} Ihrer benutzerdefinierten E-Mail-Vorlage vorangestellt, die für die Arbeit mit diesem BO-Aufruf obligatorisch ist.

Zusätzlich müssen Sie die registrationUri selbst implementieren (z. B. mit einer App, die das OneTimeHashToken extrahiert). Wenn die registrationUri aufgerufen wird und ein Passwort vom Benutzer festgelegt wurde, müssen Sie Simplifier.User.activateWithOneTimeLink aufrufen, um die Aktivierung des Benutzers abzuschließen.

Simplifier.User.update
Aktualisiert den Benutzer, der durch den zugewiesenen Anmeldenamen identifiziert wird.
Eingabe: (loginName: string, data: object)	Ergebnis: Objekt
loginName: String Daten: Objekt{ 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, Attribute: [{ name: String, category: String, value: String, description: String }], Rollen: [{ id: String, name: String, description: String, active: Boolean }], Gruppen: [{ id: Number, name: String, description: String }] }

Simplifier.User.updateImage
Aktualisiert das Profilbild des Benutzers.
Eingabe: (loginOrId: string\|number, data: object)	Ergebnis: ()
loginOrId: String\|Number - die Benutzer-ID oder der Anmeldename Daten: Objekt - die Bilddaten { uploadId: String - die Sitzungs-ID des hochgeladenen Bildes, mimeType: String }

Simplifier.User.delete
Löscht einen Benutzer, der durch die angegebene ID identifiziert wird.
Eingabe: (number)	Ergebnis: ()
id: Number	–

Simplifier.User.checkLogin
Prüft, ob sich ein Benutzer mit den angegebenen Anmeldeinformationen anmelden kann.
Eingabe: (string, string)	Ergebnis: (boolean)
login: String password: String	true, false

Zulässige Sprachcodes für preferredLanguage sind:

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

Beispiele

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" , // die URL der Simplifier-App, in der der Benutzer das neue Passwort festlegen kann
  subject: "Set your password now!",
  emailMime: "text/html",
  emailCharset: "UTF-8"
  }
  });

Benutzerrollen- und Gruppenzuweisung

Simplifier.User.assignRole
Weist dem Benutzer mit der angegebenen ID/dem angegebenen Anmeldenamen die Rolle mit der angegebenen ID zu.
Eingabe: (string\|number, string)	Ergebnis: ()
loginOrId: String\|Number – Benutzeranmeldename oder Benutzer-ID roleId: String	–

Simplifier.User.unassignRole
Entfernt die angegebene Rolle vom angegebenen Benutzer.
Eingabe: (string\|number, string)	Ergebnis: ()
loginOrId: String\|Number – Benutzeranmeldename oder Benutzer-ID roleId: String	–

Simplifier.User.assignGroup
Weist dem Benutzer mit der angegebenen ID/dem angegebenen Anmeldenamen die Gruppe mit der angegebenen ID zu.
Eingabe: (string\|number, number)	Ergebnis: ()
loginOrId: String\|Number – Benutzeranmeldename oder Benutzer-ID groupId: Number	–

Simplifier.User.unassignGroup
Entfernt die angegebene Gruppe vom angegebenen Benutzer.
Eingabe: (string\|number, number)	Ergebnis: ()
loginOrId: String\|Number – Benutzeranmeldename oder Benutzer-ID groupId: String	–

Simplifier.User.getBusinessRoles
Ruft alle Business Roles des aktuell angemeldeten Benutzers ab.
Eingabe: ()	Ergebnis: Array (object)
	[project: String businessRole: String]

Simplifier.User.getBusinessRolesInProject
Ruft alle Business Roles des aktuell angemeldeten Benutzers innerhalb eines bestimmten Projekts ab.
Eingabe: (string)	Ergebnis: Array (string)
projectID: String – ID des Projekts	[“roleName1”, “roleName2]

Simplifier.User.checkBusinessRole
Prüft, ob der aktuell angemeldete Benutzer eine bestimmte Business Role innerhalb eines bestimmten Projekts hat.
Eingabe: (string, string)	Ergebnis: (boolean)
projectID: string – ID des Projekts roleName: string – Name der Business Role	true, false

Simplifier.User.assignBusinessRole
Weist dem Benutzer, der durch den angegebenen Anmeldenamen identifiziert wird, die Business Role mit dem angegebenen Namen und Projekt zu.
Eingabe: (string, string, string)	Ergebnis: ()
loginName: String – Der Anmeldename des Benutzers projectID: String – ID des Projekts roleName: String – Name der Business Role

Simplifier.User.unassignBusinessRole
Entfernt die angegebene Business Role vom angegebenen Benutzer.
Eingabe: (string, string, string)	Ergebnis: ()
loginName: String – Der Anmeldename des Benutzers projectID: String – ID des Projekts roleName: String – Name der Business Role

Beispiele

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

Benutzerattribute

Simplifier.User.getAttributes
Ruft alle Attribute des Benutzers ab, der durch den angegebenen LoginName/ID identifiziert wird.
Eingabe: (string\|number)	Ergebnis: Array (object)
loginOrId: String – Benutzeranmeldename oder Benutzer-ID	[{ name: String, category: String, value: String, description: String }]

Simplifier.User.getAttribute
Ruft das Attribut mit dem angegebenen Namen und der angegebenen Kategorie eines Benutzers ab, der durch den angegebenen LoginName/ID identifiziert wird.
Eingabe: (string\|number, string, string)	Ergebnis: (object \| null)
loginOrId: String\|Number – Benutzeranmeldename oder Benutzer-ID name: String – Name des Attributs category: String – Attributkategorie	{ name: String, category: String, value: String, description: String }

Simplifier.User.setAttribute
Setzt (fügt hinzu oder aktualisiert) ein Attribut des Benutzers, der durch den angegebenen LoginName/ID identifiziert wird.
Eingabe: (string\|number, string, string, string)	Ergebnis: ()
loginOrId: String – Benutzer-Loginname oder Benutzer-ID name: String – Name des Attributs category: String – Attributkategorie value: String – neuer Wert für das Attribut	–

Simplifier.User.deleteAttribute
Löscht das angegebene Attribut des Benutzers, der durch den angegebenen Login-Namen/ID identifiziert wird.
Input: (string\|number, string, string)	Result: ()
loginOrId: String\|Number – Benutzer-Loginname oder Benutzer-ID name: String – Name des Attributs category: String – Attributkategorie	–

Beispiele

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

Benutzerpasswort und Aktivierung

Simplifier.User.activateWithOneTimeLink
Setzt ein Benutzerpasswort für den bereitgestellten One-Time-Hash.
Eingabe: (String)	Ergebnis: ()
oneTimeHash: String – Der URL-Query-Parameter, der über resetPasswordWithEmailTemplate generiert wird, um den Passwort-Reset-Link (resetURI) zu validieren newPassword: String – neues Passwort	–

Simplifier.User.resendActivationMail
Sendet die Aktivierungs-E-Mail erneut an den angegebenen Benutzer.
Eingabe: (Objekt)	Ergebnis: ()
data: Objekt { Login: String, E-Mail: String, emailConfig: { templateNamespace: String, templateName: String, registrationUri: String - die URL der Simplifier-App, in der der Benutzer sein Passwort festlegen kann, subject: String?, emailMime: String = "text/html", emailCharset: String = "UTF-8", additionalData: Object? } }	–

Simplifier.User.resetPasswordWithEmailTemplate
Sendet eine E-Mail mit einer Vorlage zur Wiederherstellung des Passworts und setzt das Passwort für den bereitgestellten Benutzer zurück, der durch die angegebene ID oder den Anmeldenamen identifiziert wird.
Eingabe: (String\|Number, Objekt)	Ergebnis: ()
loginOrId: String\|Number - ID oder Anmeldename des Benutzers emailData : Objekt { templateNamespace: String, templateName: String, resetURI: String - die URL der Simplifier-App, in der der Benutzer das neue Passwort festlegen kann, subject: String?, emailMime: String = "text/html", emailCharset: String = "UTF-8", additionalData: Object? }	–

Simplifier.User.setPassword
Setzt ein Benutzerpasswort für den bereitgestellten One-Time-Hash.
Eingabe: (String, String)	Ergebnis: ()
oneTimeHash: String – Der URL-Query-Parameter, der über resetPasswordWithEmailTemplate generiert wird, um den Passwort-Reset-Link (resetURI) zu validieren newPassword: String – neues Passwort	–

Gruppe

Gruppen

Simplifier.Group.getAll
Gibt alle Gruppen der aktuellen Simplifier-Instanz zurück.
Eingabe : ()	Ergebnis: Array[object]
–	[{ id: Number, groupName: String, description: String }]

Simplifier.Group.getById
Gibt die Gruppe mit der angegebenen ID zurück. Gibt auch die Benutzer zurück, die dieser Gruppe zugewiesen sind.
Eingabe : (Number)	Ergebnis: Objekt\|Null
id: Number	{ id: Number, groupName: String, description: String, assignedUsers: [{ id: Number, loginName: String, firstName: String, lastName: String, email: String }] }

Simplifier.Group.getByName
Gibt die Gruppe mit dem angegebenen Namen zurück. Gibt auch die Benutzer zurück, die dieser Gruppe zugewiesen sind.
Eingabe : (String)	Ergebnis: Objekt\|Null
groupName: String	{ id: Number, groupName: String, description: String, assignedUsers: [{ id: Number, loginName: String, firstName: String, lastName: String, email: String }] }

Simplifier.Group.getUsersByGroup
Gibt alle Benutzer zurück, die Mitglieder der angegebenen Gruppen-ID sind.
Eingabe : (Number)	Ergebnis: Objekt\|Null
id: Number	[{ id: Number, loginName: String, firstName: String, lastName: String, email: String }]

Beispiele

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

Simplifier.Group.create
Erstellt eine neue Gruppe mit den angegebenen Details.
Eingabe : (data: Objekt)	Ergebnis: Objekt\|Null
data: Objekt { 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
Aktualisiert eine vorhandene Gruppe mit den angegebenen Gruppendaten.
Eingabe : (id: Number, data: Objekt)	Ergebnis: Objekt\|Null
id: Number data: Objekt{ 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
Löscht die Gruppe mit der angegebenen ID.
Eingabe : (Number)	Ergebnis: ()
id: Number

Beispiele

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);

Rolle

Rollen

Simplifier.Role.getAll
Gibt alle Rollen der aktuellen Simplifier-Instanz zurück.
Eingabe : ()	Ergebnis: Array[object]
–	[{ id: String, roleName: String, active: Boolean, description: String }]

Simplifier.Role.getById
Gibt die Rolle mit der angegebenen ID zurück. Gibt auch die Benutzer zurück, die dieser Rolle zugewiesen sind, sowie die Berechtigungen, die in dieser Rolle enthalten sind.
Eingabe : (String)	Ergebnis: Objekt\|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
Gibt die Rolle mit dem angegebenen Namen zurück. Gibt auch die Benutzer zurück, die dieser Rolle zugewiesen sind, sowie die Berechtigungen, die in dieser Rolle enthalten sind.
Eingabe : (String)	Ergebnis: Objekt\|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
Gibt alle Benutzer zurück, die Mitglieder der angegebenen Rollen-ID sind.
Eingabe : (String)	Ergebnis: Objekt\|Null
id: String	[{ id: Number, loginName: String, firstName: String, lastName: String, email: String }]

Beispiele

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

Simplifier.Role.create
Erstellt eine neue Rolle mit den angegebenen Details.
Eingabe : (data: Objekt)	Ergebnis: Objekt\|Null
data: Objekt { 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
Aktualisiert eine vorhandene Rolle mit den angegebenen Rollendaten.
Eingabe : (id: String, data: Objekt)	Ergebnis: Objekt\|Null
id: String data: Objekt{ 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
Löscht die Rolle mit der angegebenen ID.
Eingabe : (String)	Ergebnis: ()
id: String

Beispiele

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");

Berechtigungen

Simplifier.Permission.checkPermission
Prüft, ob der aktuell angemeldete Benutzer die gewährte Berechtigungscharakteristik für den angegebenen Berechtigungsnamen besitzt.
Eingabe : (String, String)	Ergebnis: Boolean
permissionName: String, characteristic: String	Gibt an, ob der aktuell angemeldete Benutzer die angegebene Berechtigungscharakteristik besitzt (true/false)

Simplifier.Permission.checkPermissionCharacteristic
Prüft, ob der aktuell angemeldete Benutzer den gewährten Berechtigungscharakteristikwert für die angegebene Charakteristik und den angegebenen Berechtigungsnamen besitzt.
Eingabe : (String, String, String)	Ergebnis: Boolean
permissionName: String, characteristic: String, characteristicValue: String	Gibt an, ob der aktuell angemeldete Benutzer den angegebenen Berechtigungscharakteristikwert besitzt (true/false)

Beispiele:

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

Berechtigungsobjekte

Technischer Name der Berechtigung	Merkmale
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

Simplifier.System.getActiveInstance
Gibt die Details der aktiven Simplifier-Instanz zurück.
Input : ()	Result: Object
	{ “name”: der technische Name der aktiven Instanz, “url”: der URL-Pfad der aktiven Instanz, “description”: die Beschreibung der aktiven Instanz, “type”: der Typ der aktiven Instanz (‘Develop‘/’Quality‘/’Production‘/’Custom‘) “active”: Flag, ob die Instanz aktiv ist (true/false) }

Simplifier.System.getInstances
Gibt die Details aller Simplifier-Instanzen zurück, die in den Servereinstellungen konfiguriert sind.
Input : ()	Result: Array(Object)
	[{ “name”: der technische Name der Instanz, “url”: der URL-Pfad der Instanz, “description”: die Beschreibung der Instanz, “type”: der Typ der Instanz (‘Develop‘/’Quality‘/’Production‘/’Custom‘) “active”: Flag, ob die Instanz aktiv ist (true/false) }]

Beispiele:

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

Template

Plugins

Simplifier.Template.<TemplateFolderName>.<TemplateName>
Rendert die angegebene Vorlage mit den angegebenen Eingabeparametern und gibt sie als Zeichenfolge zurück.
Input : (payload?: object)	Result: string
payload: Object – die Eingabeparameter der Vorlage	Die gerenderte Vorlage mit den angegebenen Eingabeparameterwerten.

Beispiele:

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

Die KI-Live-Übersetzung erfordert ein Abonnement. In unseren FAQ erfahren Sie, wie Sie das Abonnement erwerben können, um unseren Simplifier AI Cloud-Service nutzen zu können. Preisinformationen finden Sie im KI-Übersetzungsangebot in unserem Makers Club.

Aktueller Release

KI-Live-Übersetzung

Beispiele:

Konnektoren

Beispiele:

Beispiel:

Business Objekte

Beispiele:

Beispiele:

Plugins

Beispiele:

E-Mail

Beispiel:

Utils

Beispiele:

Beispiele:

Beispiele:

Logging

Beispiele:

Benutzer abrufen

Beispiele

Benutzer erstellen, aktualisieren und löschen

Beispiele

Benutzerrollen- und Gruppenzuweisung

Beispiele

Benutzerattribute

Beispiele

Benutzerpasswort und Aktivierung

Gruppen

Beispiele

Beispiele

Rollen

Beispiele

Beispiele

Berechtigungen

Beispiele:

Berechtigungsobjekte

System

Beispiele:

Plugins

Beispiele:

Related Articles