Beschreibungen der Funktionsbausteine und ihrer Parameter 

Das cFolders-System enthält detaillierte Beschreibungen der einzelnen Funktionsbausteine und ihrer Parameter.

Parameter

Konventionen

Alle Eingabeparameter beginnen mit "I" und alle Ausgabeparameter mit "E". Bei Strukturen folgt dann ein "S", bei Tabellen ein "T". Danach folgt ein Unterstrich. Bei "ES_FAULT" handelt es sich z.B. um einen Ausgabeparameter in Form einer Struktur. Ausgabeparameter werden zu Beginn des Funktionsbausteins gelöscht.

Die Fehlerparameter "ES_FAULT" und "E_FAULTSTRING" werden im Kapitel zu Fehlern beschrieben.

Berechtigungen

Die Funktionsbausteine für Objekte mit Berechtigungen "*_GETDETAIL", z.B. "CFX_API_AREA_GETDETAIL", haben den Ausgabeparameter "E_AUTHORIZATION". Dieser Parameter gibt die Berechtigung für den aktuellen Benutzer des Objekts an. Folgende Werte sind möglich:

Wert für E_AUTHORIZATION	Bedeutung
owner	Administrationsberechtigung
write	Schreibberechtigung
read	Leseberechtigung
no_auth	Keine Berechtigung

Diese Tabelle ist auch für das Tabellenfeld "IT_AUTHORIZATIONS-AUTHORIZATION" relevant, wenn Berechtigungen mit "CFX_API_TS_AUTHORIZATION_CHANG" geändert werden, sowie für "ET_AUTHORIZATIONS- AUTHORIZATION".

Aliasnamen

Nähere Informationen hierzu finden Sie in der Dokumentation für die Funktionsbausteine "CFX_API_ALIAS_CREATE". Aliasnamen, die zu einem Backend-System gehören, können zur Benennung von Objekten im cFolders-System verwendet werden, so dass eine eindeutige Identifizierung von Objekten im Backend-System möglich ist. Der Funktionsbaustein "CFX_API_ALIAS_BS_SET_VALUE" kann zur Einrichtung dieser Art von Aliasnamen verwendet werden. Beispiel: Ein Dokument im Backend-System wird als "08-15" bezeichnet. Dieses Dokument wird in das cFolders-System kopiert und dort als "Wheel 1" bezeichnet. Zusätzlich wird ihm der Alias "Name" (Parameter: I_ALIAS_NAME) mit dem Wert "08-15" (I_ALIAS_VALUE) verliehen. Der Namensraum "www.firmenname.de_Abteilung_Systemname_Mandant" ("I_BACKEND_SYSTEM") wird ebenfalls eingegeben, um Konflikte zu vermeiden, wenn der Alias "Name" auch von einem anderen Backend-System verwendet wird. Sie können den Namespace nach eigenen Wünschen benennen. Um Konflikte bei der Benennung zu vermeiden, empfiehlt es sich jedoch, einen Namen zu verwenden, der von keinem anderen Backend-System verwendet wird.

Fehler

Fehler in der Umgebung (z.B. keine Berechtigung für die Anmeldung im System, Funktionsbaustein nicht vorhanden) werden bei der Verwendung von RFC-Bausteinen als Ausnahmen und im Rahmen eines SOAP-Aufrufs als Fehlerelemente ausgegeben.

Um die Fehlerbehebung innerhalb von Funktionsbausteinen zu ermöglichen, verfügen alle Funktionsbausteine, bei denen Fehler auftreten können, über die Parameter "ES_FAULT" und "E_FAULTSTRING". Treten keine Fehler auf, sind diese Parameter initial. Wenn ein Fehler auftritt, gilt Folgendes:

Parameter	Bedeutung
E_FAULTSTRING	Kurzer Fehlertext für Benutzer
ES_FAULT-FAULTCODE	Fehlercode für automatische Verarbeitung
ES_FAULT-DETAIL_V1	1. Fehlerparameter
ES_FAULT-DETAIL_V2	2. Fehlerparameter
ES_FAULT-DETAIL_V3	3. Fehlerparameter
ES_FAULT-DETAIL_V4	4. Fehlerparameter
ES_FAULT-DETAIL_PARAMETER	Name des Eingabeparameters, dessen Wert fehlerhaft ist
ES_FAULT-DETAIL_ROW	Ziele der Eingabetabelle, die den fehlerhaften Wert enthält
ES_FAULT-DETAIL_FIELD	Feld der Eingabestruktur, dessen Wert fehlerhaft ist

ES_FAULT-FAULTCODE

Die Zeichenfolge "ES_FAULT-FAULTCODE" wird nach dem SOAP-Standard definiert. Im Falle eines Fehlers wird sie immer mit "cFolders" eingeleitet.

Danach folgt:

Feld im Fehlercode	Bedeutung
Client	Eingabedaten sind nicht korrekt, keine Eingabedaten vorhanden, keine Berechtigung vorhanden, ...: Ein neuer Aufruf mit den gleichen Daten führt wieder zu einem Fehler
Server	Dienst ist momentan nicht verfügbar, Daten sind vorübergehend gesperrt, ...: Ein neuer Aufruf mit den gleichen Daten ist möglicherweise erfolgreich
Server_bug	Interner Fehler im cFolders-System; wenn der Fehler reproduziert werden kann, Kundenmeldung schreiben

Danach folgt:

Feld im Fehlercode	Bedeutung
.SkwfError .FatalError	Interner Fehler im cFolders-System; wenn der Fehler reproduziert werden kann, Kundenmeldung schreiben
.InvalidInput .InvalidInputApi	Eingabeparameter sind fehlerhaft
.NoAuthorization.read	Keine Leseberechtigung
.NoAuthorization.write	Keine Schreibberechtigung
.NoAuthorization.owner	Keine Administrationsberechtigung
.ObjectNotExisting	Objekt (z.B. Dokument) nicht vorhanden
.EmailError	E-Mail konnte nicht gesandt werden
.NotificationError	Fehler beim Anlegen einer Meldung
.License	Keine Lizenz für cFolders
.Folder	Fehler in Mappen
.FolderLocking	Mappe gesperrt
.FolderNamespace	Mappe mit diesem Namen bereits vorhanden
.AliasNamespace	Alias mit diesem Namen bereits vorhanden
.CollaborationLocking	Collaboration gesperrt

Andere Felder, die eine exaktere Beschreibung des Fehlers bieten, können folgen. Sie sind durch einen Punkt (".") abgetrennt.

Beispiel: "cFolders:Client.NoAuthorization.write": Ein Benutzer hat versucht ein Objekt zu ändern, für das er keine Schreibberechtigung hat.