Application - onion.net Data source
The application functions extend the core functions of the onion.net Render Engine. They enable write access to the data stock for anonymous users. This means for example that contact requests, newsletter registrations or guest book entries can be saved in the system.
“Anonymous user” means that the person who initiates the actions is either not logged on in the system or has no user in the system. In order to write a guest book entry or register for a newsletter, no prior user registration should ultimately be necessary. However, there does have to be such an “anonymous” user in the onion.net Editor to perform the appropriate actions.
This user is configured in the “web.config” file of the preview. There is already a commented-out section there:
<!--application username="webapplication" password="TODO" /-->
Replace the password “TODO” with the password of your web application user and comment-in the section. Make sure that this user only has the authorizations he really needs. He should not be a user manager for example if this is not absolutely necessary. For all functions which have an influence on the user administration however, the web application user must also be the user administrator.
The following list provides an overview of the application functions. Click on the name of a function to find out more about its use.
Name | Parameter | Return type | Description |
---|---|---|---|
addGroupInclude | groupReference:xlink includeReference:xlink |
boolean | Adds a group (groupReference) below another group (includeReference). |
checkIn | target:xlink [force:boolean] |
boolean | Returns a checked-out element. |
checkOut | target:xlink | boolean | The specified element borrows to the announced user out. |
clearRight | groupReference:xlink target:xlink |
boolean | Removes an object right from the group. |
createBinary | filename:string mimeType:string |
string | Writes a binary data object on the basis of a physical file or a link to a binary method in onion.net and returns the ReferenceIdentifier as the result. |
createGroup | groupName:string | xlink | Creates a new group in the user administration. |
createObject | parent:xlink name:string content:nodeset [autoCheckIn:boolean] |
string | Adds new datasets to the content. |
createSettings | userReference:xlink schemaLocation:string content:nodeset instance:string |
xlink | Produces a document in the user profile for a user. |
createUser | username:string password:string [role:string] |
xlink | Creates a new user in the user administration. |
deleteGroup | groupReference:xlink | xlink | Deletes a group from the user administration. |
deleteObject | target:xlink [recursive:boolean] |
boolean | Deletes elements from the structure. |
deleteUser | userReference:xlink | boolean | Deletes the specified user from the user administration. |
joinGroup | userReference:xlink groupReference:xlink |
boolean | Adds a user to the specified group. |
leaveGroup | userReference:xlink groupReference:xlink |
boolean | Removes the specified user from the specified group. |
lookupObject | parent:string name:string |
string | Makes it possible to search for direct children. |
memberOf | userReference:xlink, groupReference:string | boolean | Checks whether a user is member of a group. |
moveObject | target:xlink newParent:string |
boolean | Enables existing objects to be moved in the structure. |
removeGroupInclude | groupReference:xlink includeReference:xlink |
boolean | Removes the included group. |
renameObject | target:xlink newName:string |
boolean | Makes it possible to rename elements. |
search | query:xml [returnFrom:int] [returnTo:int] |
xml | Executes a personalised search query against the data stock. |
setDisplayName | userReference:xlink name:string |
void | Sets the display name for a user. |
setObjectPosition | target:xlink position:int |
boolean | Changes the position of elements in their own hierarchy level. |
undoCheckOut | target:xlink | boolean | Discards the changes to the checked-out object and returns it. |
updateObject | target:xlink newContent:nodeset |
boolean | Saves changes to an existing object. |
updatePassword | userReference:xlink newPassword:string [oldPassword:string] |
boolean | Sets the password of a user. |
updateUsername | userReference:string, username:string | string | Sets the username für a user. |