Descriptions of the Function Modules and Their Parameters

Parameters

Conventions

All input parameters begin with "I" and all output parameters with "E". For structures, an "S" then follows, for tables, a "T". After that, there is an underscore. For example, "ES_FAULT" is an output parameter that is a structure. Output parameters are deleted at the beginning of the function module.

The error parameter "ES_FAULT" and "E_FAULTSTRING" are described in Errors.

Authorizations

The "*_GETDETAIL" function modules for objects with authorizations, for example, "CFX_API_AREA_GETDETAIL", have the output parameters "E_AUTHORIZATION". It specifies the authorization for the current user for the object and can have the following values: The following values are possible:

Value of E_AUTHORIZATION	Meaning
owner	Administration authorization
write	Write authorization
read	Read authorization
no_auth	No authorization

This table is also valid for the table field "IT_AUTHORIZATIONS-AUTHORIZATION" when changing authorizations with "CFX_API_TS_AUTHORIZATION_CHANG" and for "ET_AUTHORIZATIONS- AUTHORIZATION".

Alias Names

Refer to the documentation for the "CFX_API_ALIAS_CREATE" function module. Alias names that belong to a back-end system can be used to give names to objects in the cFolders system with which the objects in the back-end system can be uniquely identified. The function module "CFX_API_ALIAS_BS_SET_VALUE" can be used to set this sort of alias name. Example: A document in the back-end system is called "08-15". It is copied to the cFolders system and there it is called "Wheel 1". In addition, it is given the alias "Name" (parameter: I_ALIAS_NAME) with the value "08-15" (I_ALIAS_VALUE). The namespace "www.companyname.com_department_systemname_client" ("I_BACKEND_SYSTEM") is also entered to avoid conflicts, in case the alias "Name" is also being used by another backend system. You can call the namespace whatever you want. However, to avoid naming conflicts you should choose it in such a way that no other back-end system chooses the same namespace.

Errors

Errors in the environment (for example, no authorization for logging on to the system, function module does not exist, and so on) are returned as exceptions when using the RFC modules and as elements with errors during a SOAP call.

For handling errors in the function modules, all function modules for which errors can arise have the parameters "ES_FAULT" and "E_FAULTSTRING". If no errors occur, these parameters are initial. If an error occurs:

Parameter	Meaning
E_FAULTSTRING	Brief error text for user
ES_FAULT-FAULTCODE	Error code for automatic processing
ES_FAULT-DETAIL_V1	1. Error parameter
ES_FAULT-DETAIL_V2	2. Error parameter
ES_FAULT-DETAIL_V3	3. Error parameter
ES_FAULT-DETAIL_V4	4. Error parameter
ES_FAULT-DETAIL_PARAMETER	Name of the input parameter whose value is wrong
ES_FAULT-DETAIL_ROW	Targets of the input table that contains the incorrect value
ES_FAULT-DETAIL_FIELD	Field of the input structure whose value is incorrect

ES_FAULT-FAULTCODE

The character string "ES_FAULT-FAULTCODE" is defined according to the SOAP standard. It always begins (in the case of an error) with "cFolders".

Followed by:

Field in Error Code	Meaning
Client	Entry data is incorrect, there is no entry data, no authorization, ...: A new call using the same data will again result in an error
Server	Service is not available at the moment, data is temporarily locked, ...: A new call with the same data may be successful
Server_bug	Internal error in the cFolders system. If the error can be reproduced, write a customer message

Field in Error Code

Meaning

Client

Entry data is incorrect, there is no entry data, no authorization, ...:

A new call using the same data will again result in an error

Server

Service is not available at the moment, data is temporarily locked, ...:

A new call with the same data may be successful

Server_bug

Internal error in the cFolders system. If the error can be reproduced, write a customer message

Followed by:

Field in Error Code	Meaning
.SkwfError .FatalError	Internal error in the cFolders system. If the error can be reproduced, write a customer message
.InvalidInput .InvalidInputApi	Input parameters are incorrect
.NoAuthorization.read	No read authorization
.NoAuthorization.write	No write authorization
.NoAuthorization.owner	No administration authorization
.ObjectNotExisting	Object (for example, document) does not exist
.EmailError	E-mail could not be sent
.NotificationError	Error while creating a notification
.License	No license for cFolders
.Folder	Error in folders
.FolderLocking	Folder is locked
.FolderNamespace	Folder of this name already exists
.AliasNamespace	Alias of this name already exists
.CollaborationLocking	Collaboration is locked

Other fields that give a more exact description of the error can follow. They are separated by a full stop (".").

Example: "cFolders:Client.NoAuthorization.write": The user tried to change an object for which he or she has no write authorization.