Serverseitige Business-Objekt-API

Funktionsparameter

Die Eingabeparameter der Business-Objekt-Funktion können aus dem vordefinierten Objekt input gelesen werden.

Setze Eigenschaften des Objekts output, um Ausgabeparameter festzulegen.

Beispiel:

// Eingabeparameter lesen
var userId = input.userId

// Daten verarbeiten ...
Simplifier.Log.info("ID=" + userId);

// Ausgabeparameter setzen
output.message = "Done"

Simplifier-API

Um Ihre Geschäftslogik zu implementieren, verwenden Sie die passende API, die vom globalen Simplifier-Objekt bereitgestellt wird:

AI

AI Live-Übersetzung

Simplifier.AI.translate
Übersetzt die angegebenen Daten in die definierte Zielsprache
Eingabe:	Ergebnis: beliebig
sourceLanguage (String) , targetLanguage (Array) , values (String\|Array\|Object) ** * Verwende einen unterstützten 5-stelligen Sprachcode, z.B. de_DE ** Alle enthaltenen String-Werte werden übersetzt. Objektschlüssel werden nicht übersetzt	Gleiche Struktur wie die 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!");

Für die AI Live Translation ist ein Abonnement erforderlich. In unseren FAQ erfahren Sie, wie Sie das Abonnement erwerben, um unseren Simplifier AI Cloud Service nutzen zu können. Preisinformationen finden Sie unter dem AI Translation-Angebot in unserem Makers Club.

Konnektoren

Simplifier.Connector.<ConnectorName>.<CallName>
Führt einen Konnektoraufruf aus. Die Eingabeparameter werden im Eingabeobjekt (Payload) definiert.
Eingabe : (Nutzlast?: Zeichenfolge\|Objekt)	Ergebnis: Objekt
Die Struktur des Eingabeobjekts hängt von den Eingabeparametern ab, die im Connectoraufruf konfiguriert sind	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>
DEPRECATED Führt einen Konnektor aus. Der Aufruf des Konnektors und die Eingabeparameter sind im Eingabeobjekt (Payload) definiert.
Eingabe : (Nutzlast?: Zeichenfolge\|Objekt)	Ergebnis: Objekt
Die Struktur der Eingabeobjekte hängt vom Typ des Konnektors ab (SQL, SOAP usw.) Für SQL gilt z. B. Folgendes: request: String Modus: 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 (Englisch)

Plugins

Simplifier.Plugin.<PluginName>.<SlotName>
Führt einen Slot eines Simplifier Plugins aus.
Eingabe : (Nutzlast?: Zeichenfolge\|Objekt)	Ergebnis: Objekt
payload: Object – die Eingabeparameter, wie sie im Plugin-Slot definiert sind	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 : (Nutzlast?: Zeichenfolge\|Objekt)	Ergebnis: ()
payload: Objekt 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 die Daten auf ein leeres Objekt), attachments?: Array(AttachmentObject) AttachmentObject: Objekt mimeType: String,fileName : String,b64Data ?: String (base64-kodierte PDF-Datei), uploadSession?: String (ID der Upload-Sitzung)

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

Hilfsmittel

Simplifier.Util.encodeBase64
Codiert eine Zeichenfolge in base64.
Eingabe : (Zeichenfolge)	Ergebnis: Zeichenfolge
inputString: die Zeichenfolge, die codiert werden soll	Die codierte Zeichenfolge im Base64-Format

Simplifier.Util.decodeBase64
Dekodiert eine base64-codierte Zeichenfolge.
Eingabe : (Zeichenfolge)	Ergebnis: Zeichenfolge
inputString: der String im Base64-Format	Die decodierte Zeichenkette

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 einen JSON-Code mit Zeichenfolge.
Eingabe : (Zeichenfolge)	Ergebnis: Zeichenfolge
xml: die Zeichenkette im XML-Format	Das stringifizierte JSON

Simplifier.Util.xml2jsonValue
Konvertiert eine Zeichenfolge im XML-Format in ein JSON-Objekt.
Eingabe : (Zeichenfolge)	Ergebnis: Objekt
xml: die Zeichenkette 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 einen JSON-Code mit Strings in einen String im XML-Format.
Eingabe : (Zeichenfolge)	Ergebnis: Zeichenfolge
json: das stringifizierte JSON	Die Zeichenfolge im XML-Format

Simplifier.Util.jsonValue2xml
Konvertiert ein JSON-Objekt in eine Zeichenfolge im XML-Format.
Eingang : (Objekt)	Ergebnis: Zeichenfolge
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

Protokollierung

Simplifier.Log.info
Erstellt einen Protokolleintrag mit der Ebene INFO.
Eingabe : (Zeichenfolge, Zeichenfolge\|Objekt?)	Ergebnis: ()
message: String-Details ?: String\|Gegenstand	–

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

Simplifier.Log.warn
Erstellt einen Protokolleintrag mit der Ebene WARNING.
Eingabe : (Zeichenfolge, Zeichenfolge\|Objekt?)	Ergebnis: ()
message: String-Details ?: String\|Gegenstand	–

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

Simplifier.Log.error
Erstellt einen Protokolleintrag mit der Stufe ERROR.
Eingabe : (Zeichenfolge, Zeichenfolge\|Objekt?)	Ergebnis: ()
message: String-Details ?: String\|Gegenstand	–

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

Simplifier.Log.critical
Erstellt einen Protokolleintrag mit der Stufe CRITICAL.
Eingabe : (Zeichenfolge, Zeichenfolge\|Objekt?)	Ergebnis: ()
message: String-Details ?: String\|Gegenstand	–

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

Simplifier.Log.debug
Erstellt einen Protokolleintrag mit der Ebene DEBUG.
Eingabe : (Zeichenfolge, Zeichenfolge\|Objekt?)	Ergebnis: ()
message: String-Details ?: String\|Gegenstand	–

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

Beispiele:

Diese Beispiele gelten für alle Protokollebenen.

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(Objekt)
–	[{ id: Number, Login: String, firstName: String, lastName: String, E-Mail: 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: (Anzahl)	Ergebnis: object\|null
id: Anzahl	{ id: Number, Login: String, firstName: String, lastName: String, E-Mail: 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.getByName
Ruft den Benutzer mit dem angegebenen Anmeldenamen ab. Ruft auch die Rollen, Gruppen und Attribute des Benutzers ab.
Eingabe: (Zeichenfolge)	Ergebnis: object\|null
loginName: Zeichenfolge	{ id: Number, Login: String, firstName: String, lastName: String, E-Mail: 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.getCurrentUser
Ruft den aktuell angemeldeten Benutzer ab. Ruft auch die Rollen, Gruppen und Attribute des Benutzers ab (das roles-Array ist nur dann in der Antwort vorhanden, wenn der currentUser die Rolle/Rechte zum Lesen der Rollen hat).
Eingabe: ()	Ergebnis: object\|null
–	{ id: Number, Login: String, firstName: String, lastName: String, E-Mail: 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 }] }

Beispiele

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

Erstellen, Aktualisieren und Löschen eines Benutzers

Simplifier.User.create
Erstellt einen neuen Benutzer.
Eingabe: (Daten: Objekt)	Ergebnis: Objekt
data: Objekt { Login: String, firstName: String, lastName: String, E-Mail: 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, E-Mail: 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.createWithActivationMail
Erstellt einen neuen Benutzer und sendet eine E-Mail an den Benutzer, um sein Konto zu aktivieren.
Eingabe: (Objekt)	Ergebnis: ()
data: Objekt { userData: { Login: String, firstName: String, lastName: String, E-Mail: 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, E-Mail: 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, der für die Verwendung dieses BO-Aufrufs zwingend erforderlich ist.

Zusätzlich müssen Sie die registrationUri selbst implementieren (z.B. mit einer App, die den oneTimeHashToken extrahiert). Wenn die registrationUri aufgerufen wird und der Benutzer ein Passwort definiert hat, 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: Zeichenfolge, Daten: Objekt)	Ergebnis: Objekt
loginName: Zeichenfolge Daten: Objekt{ firstName: String, lastName: String, E-Mail: 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, E-Mail: 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: Zeichenfolge\|Zahl, Daten: Objekt)	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: (Anzahl)	Ergebnis: ()
id: Anzahl	–

Simplifier.User.checkLogin
Überprüft, ob sich ein Benutzer mit den angegebenen Anmeldeinformationen anmelden kann.
Eingabe: (Zeichenfolge, Zeichenfolge)	Ergebnis: (boolesch)
login: Zeichenkette password: Zeichenkette	wahr, falsch

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

Zuweisung von Benutzerrollen und Gruppen

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

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

Simplifier.User.assignGroup
Weist die Gruppe mit der angegebenen ID dem Benutzer mit der angegebenen ID/dem angegebenen Anmeldenamen zu.
Eingabe: (Zeichenfolge\|Zahl, Zahl)	Ergebnis: ()
loginOrId: Zeichenfolge\|Nummer – Benutzer-Login-Name oder Benutzer-ID groupId: Nummer	–

Simplifier.User.unassignGroup
Entfernt die angegebene Gruppe aus dem angegebenen Benutzer.
Eingabe: (Zeichenfolge\|Zahl, Zahl)	Ergebnis: ()
loginOrId: Zeichenfolge\|Number – Benutzer-Login-Name oder Benutzer-ID groupId: Zeichenfolge	–

Simplifier.User.getBusinessRoles
Ruft alle Benutzerrollen des aktuell angemeldeten Benutzers ab.
Eingabe: ()	Ergebnis: Array (Objekt)
	[project: Zeichenfolge businessRole: Zeichenfolge]

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

Simplifier.User.checkBusinessRole
Überprüft, ob der aktuell angemeldete Benutzer eine bestimmte Benutzerrolle innerhalb eines bestimmten Projekts hat.
Eingabe: (Zeichenfolge, Zeichenfolge)	Ergebnis: (boolesch)
projectID: string – ID des Projekts roleName: string – Name der Geschäftsrolle	true, false

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

Simplifier.User.unassignBusinessRole
Entfernt die angegebene Benutzerrolle vom angegebenen Benutzer.
Eingabe: (Zeichenfolge, Zeichenfolge, Zeichenfolge)	Ergebnis: ()
loginName: String – Der Anmeldename des Benutzers projectID: String – ID des Projekts roleName: String – Name der Geschäftsrolle

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, die durch den angegebenen loginName/die angegebene ID identifiziert wurden.
Eingabe: (Zeichenfolge\|Zahl)	Ergebnis: Array (Objekt)
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 Kategorie eines Benutzers ab, der durch den angegebenen loginName/die angegebene ID identifiziert wird.
Eingabe: (Zeichenfolge\|Zahl, Zeichenfolge, Zeichenfolge)	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
Legt ein Attribut des Benutzers fest (fügt es hinzu oder aktualisiert es), das durch den angegebenen loginName/die angegebene ID identifiziert wird.
Eingabe: (Zeichenfolge\|Zahl, Zeichenfolge, Zeichenfolge, Zeichenfolge)	Ergebnis: ()
loginOrId: Zeichenfolge – Benutzeranmeldename oder Benutzer-ID name: String – Name des Attributs Kategorie: String – Attribut Kategorie value: String – neuer Wert für das Attribut	–

Simplifier.User.deleteAttribute
Löscht das angegebene Attribut des Benutzers, der durch den angegebenen loginName/die angegebene ID identifiziert wird.
Eingabe: (Zeichenfolge\|Zahl, Zeichenfolge, Zeichenfolge)	Ergebnis: ()
loginOrId: Zeichenfolge\|Nummer – Benutzername oder Benutzer-ID name: String – Name des Attributs Kategorie: String – Attribut Kategorie	–

Beispiele

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

Benutzerkennwort und Aktivierung

Simplifier.User.activateWithOneTimeLink
Legt ein Benutzerkennwort für den bereitgestellten Einmal-Hash fest.
Eingabe: (Zeichenfolge)	Ergebnis: ()
oneTimeHash: String – Der URL-Abfrageparameter, 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 für die Kennwortwiederherstellung und setzt das Kennwort für den bereitgestellten Benutzer zurück, der durch die angegebene ID oder den Anmeldenamen identifiziert wird.
Eingabe: (Zeichenfolge\|Zahl, 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
Legt ein Benutzerkennwort für den bereitgestellten Einmal-Hash fest.
Eingabe: (Zeichenfolge, Zeichenfolge)	Ergebnis: ()
oneTimeHash: String – Der URL-Abfrageparameter, der über resetPasswordWithEmailTemplate generiert wird, um den Link zum Zurücksetzen des Passworts (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: Zahl,Gruppenname : Zeichenfolge,Beschreibung : Zeichenfolge }]

Simplifier.Group.getById
Gibt die Gruppe mit der angegebenen ID zurück. Gibt auch die Benutzer zurück, die dieser Gruppe zugewiesen sind.
Eingabe : (Anzahl)	Ergebnis: object\|null
id: Anzahl	{ 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 : (Zeichenfolge)	Ergebnis: object\|null
groupName: Zeichenfolge	{ 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 : (Anzahl)	Ergebnis: object\|null
ID: Anzahl	[{ id: Nummer,loginName : Zeichenfolge,Vorname : Zeichenfolge,Nachname : Zeichenfolge,email : Zeichenfolge }]

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 : (Daten: Objekt)	Ergebnis: object\|null
Daten: Object { name: String, description: String, assignedUserIDs: [Zahl] }	{ 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: Zahl, Daten: Objekt)	Ergebnis: object\|null
id: Nummer data: Object{ name: String, description: String, assignedUserIDs: [Zahl] }	{ 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 : (Anzahl)	Ergebnis: ()
id: Anzahl

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: Zeichenfolge,roleName : Zeichenfolge,aktiv : Boolescher Wert,Beschreibung : Zeichenfolge }]

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 : (Zeichenfolge)	Ergebnis: object\|null
ID: Zeichenfolge	{ id: Zeichenfolge, roleName: String, aktiv: Boolescher Wert, Beschreibung: Zeichenfolge, assignedUsers: [{ id: Nummer, LoginName: String, Vorname: String, Nachname: Zeichenkette, E-Mail: String }], Genehmigungen: [{ technicalName: Zeichenfolge, name: Zeichenkette, Beschreibung: Zeichenfolge, MerkmalTechnischerName: Zeichenfolge, MerkmalName: String, MerkmalBeschreibung: Zeichenfolge, characteristicValue: [String], characteristicDisplayType: String }] }

Simplifier.Role.getByName
Gibt die Rolle mit dem angegebenen Namen zurück. Gibt außerdem die Benutzer zurück, die dieser Rolle zugewiesen sind, sowie die Berechtigungen, die in dieser Rolle enthalten sind.
Eingabe : (Zeichenfolge)	Ergebnis: object\|null
roleName: Zeichenfolge	{ id: Zeichenfolge, roleName: String, aktiv: Boolescher Wert, Beschreibung: Zeichenfolge, assignedUsers: [{ id: Nummer, LoginName: String, Vorname: String, Nachname: Zeichenkette, E-Mail: String }], Genehmigungen: [{ technicalName: Zeichenfolge, name: Zeichenkette, Beschreibung: Zeichenfolge, MerkmalTechnischerName: Zeichenfolge, MerkmalName: String, MerkmalBeschreibung: Zeichenfolge, characteristicValue: [String], characteristicDisplayType: String }] }

Simplifier.Role.getUsersByRole
Gibt alle Benutzer zurück, die Mitglieder der angegebenen Rollen-ID sind.
Eingabe : (Zeichenfolge)	Ergebnis: object\|null
id: Zeichenfolge	[{ id: Nummer,loginName : Zeichenfolge,Vorname : Zeichenfolge,Nachname : Zeichenfolge,email : Zeichenfolge }]

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 : (Daten: Objekt)	Ergebnis: object\|null
Daten: Object { name: String, active: Boolean, description: String, assignedUsers: [Number], permissions: [{ technicalName: String, characteristic: String, value: [String] }] }	{ id: Zeichenfolge, roleName: String, aktiv: Boolescher Wert, Beschreibung: Zeichenfolge, assignedUsers: [{ id: Nummer, LoginName: String, Vorname: String, Nachname: Zeichenkette, E-Mail: String }], Genehmigungen: [{ technicalName: Zeichenfolge, name: Zeichenkette, Beschreibung: Zeichenfolge, MerkmalTechnischerName: Zeichenfolge, MerkmalName: String, MerkmalBeschreibung: Zeichenfolge, characteristicValue: [String], characteristicDisplayType: String }] }

Simplifier.Role.update
Aktualisiert eine vorhandene Rolle mit den angegebenen Rollendaten.
Eingabe : (ID: Zeichenfolge, Daten: Objekt)	Ergebnis: object\|null
id: String data: Object{ name: String, active: Boolean, description: String, assignedUsers: [Number], permissions: [{ technicalName: String, characteristic: String, value: [String] }]}	{ id: Zeichenfolge, roleName: String, aktiv: Boolescher Wert, Beschreibung: Zeichenfolge, assignedUsers: [{ id: Nummer, LoginName: String, Vorname: String, Nachname: Zeichenkette, E-Mail: String }], Genehmigungen: [{ technicalName: Zeichenfolge, name: Zeichenkette, Beschreibung: Zeichenfolge, MerkmalTechnischerName: Zeichenfolge, MerkmalName: String, MerkmalBeschreibung: Zeichenfolge, characteristicValue: [String], characteristicDisplayType: String }] }

Simplifier.Role.delete
Löscht die Rolle mit der angegebenen ID.
Eingabe : (Zeichenfolge)	Ergebnis: ()
ID: Zeichenfolge

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

Erlaubnisse

Simplifier.Permission.checkPermission
Überprüft, ob der aktuell angemeldete Benutzer über das Berechtigungsmerkmal “Erteilt” für den angegebenen Berechtigungsnamen verfügt.
Eingabe : (Zeichenfolge, Zeichenfolge)	Ergebnis: boolean
permissionName: Zeichenfolge,charakteristisch : Zeichenkette	Gibt an, ob der aktuell angemeldete Benutzer über das angegebene Berechtigungsmerkmal (wahr/falsch) verfügt

Simplifier.Permission.checkPermissionCharacteristic
Überprüft, ob der aktuell angemeldete Benutzer über den gewährten Berechtigungsmerkmalswert für das bereitgestellte Merkmal und den angegebenen Berechtigungsnamen verfügt.
Eingabe : (Zeichenfolge, Zeichenfolge, Zeichenfolge)	Ergebnis: boolean
permissionName: Zeichenfolge,charakteristisch : Zeichenfolge,charakteristischWert : Zeichenkette	Gibt an, ob der aktuell angemeldete Benutzer über den angegebenen Berechtigungsmerkmalswert (true/false) verfügt

Beispiele:

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

Berechtigungs-Objekte

Technischer Name der Berechtigung	Charaktereigenschaften
com.itizzimo.BusinessObject	Administrator
com.itizzimo.Zertifikate	Löschen Zuweisen Ansehen Bearbeiten Herunterladen Erstellen Admin
com.itizzimo.ChangeLog	Lesen Schreiben
com.itizzimo.ClientBusinessObject	Administrator
com.itizzimo.Connector	Administrator
com.itizzimo.DataType	Administrator
com.itizzimo.DbDesigner	Administrator
com.itizzimo.ErrorLog	Administrator
com.itizzimo.Gruppe	Lesen Erstellen Löschen Bearbeiten Zuweisen
com.itizzimo.job	Administrator
com.itizzimo.Bibliothek	Administrator
com.itizzimo.Marktplatz	Lesen Verkaufen Kaufen
com.itizzimo.PermissionTemplate	Administrator
com.itizzimo.Plugin	Administrator
com.itizzimo.Rolle	Erstellen Zuweisen Bearbeiten Lesen Löschen
com.itizzimo.SendEmail	Senden
com.itizzimo.ServerEinstellungen	Server-Einstellungen SecuritySettings-Authentifizierung
com.itizzimo.SystemBibliothek	Administrator
com.itizzimo.SystemNachricht	Anlegen Löschen Aktualisieren Lesen
com.itizzimo.Template	Administrator
com.itizzimo.TestAllApps	ausführen
com.itizzimo.TestAllConnectors	ausführen
com.itizzimo.Transport	importieren erstellen exportieren genehmigen
com.itizzimo.UiDesigner	Erstellen Bearbeiten Löschen Anzeigen Admin
com.itizzimo.Uploader	allowUpload (Hochladen)
com.itizzimo.Benutzer	Bearbeiten Lesen ErstellenLesenSelbst BearbeitenSelbst löschen
com.itizzimo.Widget	Administrator
com.itizzimo.WidgetGroup	Administrator
com.itizzimo.app.APPNAME	anzeigen ausführen löschen bearbeiten freigebenmeta
com.itizzimo.businessobject.BUSINESSOBJECTNAME	Ansicht ausführen löschen bearbeiten
com.itizzimo.clientbusinessobject.CLIENTBUSINESSOBJECTNAME	Ansicht Löschen Bearbeiten
com.itizzimo.connector.CONNECTORNAME	Ansicht Löschen Bearbeiten Ausführen
com.itizzimo.job.JOBNAME	Ansicht Löschen Bearbeiten
com.itizzimo.loginmethode.LOGINMETHODNAME	Ansicht Löschen Bearbeiten
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.
Eingabe : ()	Ergebnis: Objekt
	{ “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 Server-Umgebungseinstellungen konfiguriert sind.
Eingabe : ()	Ergebnis: Array(Objekt)
	[{ “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, wenn die Instanz aktiv ist (true/false) }]

Beispiele:

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

Schablone

Plugins

Simplifier.Template.<TemplateFolderName>.<TemplateName>
Rendert die angegebene Vorlage mit den angegebenen Eingabeparametern und gibt sie als Zeichenfolge zurück.
Eingabe : (Nutzlast?: Objekt)	Ergebnis: Zeichenfolge
payload: Object – die Eingabeparameter des Templates	Die gerenderte Vorlage mit den angegebenen Eingabeparameterwerten.

Beispiele:

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

Variablen, die mit Fragezeichen gekennzeichnet sind, sind optionale Parameter.

Aktueller Release

Funktionsparameter

Beispiel:

Simplifier-API

AI Live-Übersetzung

Beispiele:

Konnektoren

Beispiele:

Beispiel:

Business Objekte

Beispiele:

Beispiele:

Plugins

Beispiele:

E-Mail

Beispiel:

Hilfsmittel

Beispiele:

Beispiele:

Beispiele:

Protokollierung

Beispiele:

Benutzer abrufen

Beispiele

Erstellen, Aktualisieren und Löschen eines Benutzers

Beispiele

Zuweisung von Benutzerrollen und Gruppen

Beispiele

Benutzerattribute

Beispiele

Benutzerkennwort und Aktivierung

Gruppen

Beispiele

Beispiele

Rollen

Beispiele

Beispiele

Erlaubnisse

Beispiele:

Berechtigungs-Objekte

System

Beispiele:

Plugins

Beispiele:

Related Articles