From AMI@Work Communities Wiki

Contents 1 Introduction to Basic Collaborative Services (BCS) 2 Create BCS 3 Add BCS 4 Accept BCS 5 Get BCS 6 Delete BCS 7 Edit BCS 8 Decline BCS 9 Start BCS 10 End BCS 11 Recover BCS 12 Execute BCS 13 Send BCS 14 Authenticate BCS 15 Notify BCS 16 Check BCS 17 Replace BCS 18 Reply BCS 19 Invite BCS 20 Un-invite BCS 21 Subscribe BCS 22 Unsubscribe BCS 23 Search BCS 24 Copy BCS 25 Lock BCS 26 Unlock BCS 27 Export BCS 28 Store BCS 29 Enter/Leave 30 Share BCS 31 Set BCS

[edit] Introduction to Basic Collaborative Services (BCS)

This wiki page contains the list of Basic Collaborative Services (BCS) identified as part of the ECOSPACE reference architecture, which correspond to the foundational layer and supported by any CWE that wishes to be ECOSPACE compliant. According to the ECOSPACE reference architecture, a basic service is defined as a simple collaborative task that cannot be further divided into smaller tasks. This atomicity qualifies the Basic Collaborative Services as the smallest building block of the ECOSPACE reference architecture. Another foundational characteristic is that the BCS distil the base common functionality of any CWE, thus they are instantiated in different forms in each platform.

The rationale behind the compilation of a list of basic collaborative services is to validate and promote discussion of whether a service qualifies to be a basic collaborative service and its concrete definition, which will be later supported by a WSDL and the corresponding reference implementation of the service.

Each Basic Collaborative Service can support several operations of different types but with same purpose of functionality e.g. in case of BCS "Create" the aim is to support the creation of any type of resource within CWE systems, irrespective of its complexity, thus one can use the Create BCS for the creation of a new Blog, but also use the same service for the creation of a new Blog login. The concrete execution of the particular semantics of the Create BCS is determined at runtime according to the concrete parameterization of the service (what are the inputs provided).

This wiki page is divided into sections, each corresponding to one of the proposed BCS, which is structured according to the following template:

• Name : the designation of the Purpose
• Signature
• Parameters
• Output
• Usage example
• WSDL file
• List of existing platform functionality supported by the BCS
• Observations

Note: This version is the first working draft and work in progress, therefore we only provide the full description of the few BCS. Detailed description for rest of the BCS here identified will be provided in future versions.

[edit] Create BCS

Name: Create

Signature:

ResourceID Create (platform, technology, operationType, set of pair-value)

Purpose:

Within any CWE system there is always the need to create resources, thus a BCS is Create. However, instead of having a create per each type of resource and each particular nuance of a particular procedure call, careful refactoring was carried out to distil the basic functionality of the Create BCS.

Once a resource is created, the service returns the identity of the resource which can later be used to retrieve the resource from the system.

The service handles the differences in creating resources between different systems.

Parameters:

• Platform. This designates the particular CWE system where the resource should be created, e.g.: CSCW, BC, etc
• Technology. The parameter corresponds to the specific CWE technology, service or tool, such as Blog, Wiki, Blog,
• OperationType. This captures the particular creation process associated to the selected Technology.
• Set of pair-value. This consists of zero or more pair name/value, which the particular creation OperationType is able to unpack and process.

Output:

• resourceID. This is the identifier of the resource, which consists of a GUID thus it is possible to retrieve the resource by querying the appropriate namespace

Usage Example:

• Create (BSCW, Blog, CreateNewBlog, ([Name, Ecospace], [AdminID: Kashif.iqbal]))

WSDL file:

[1]

List of existing platform functionality supported by the BCS:

OperationType Parameters Output Description CreateNewBlog Name: Name of Blog AdminID: ID of 1st author Blog Creates a blog with an unique URL CreateNewBlogLogin UserID: ID of new user User Adds a new author to the blog CreateNewCategory CategoryID : Name of category ParentCategoryID: Name of parent Category -- Adds category to the blog-category list CreateCalendarEntry UserID: ID identifying the user Date Time Duration Message: subject and add. information about the event Participants: List of participants/UserIds (required/optional) NB: notification behaviour EventId Creates a new event CreateNewCMDocument RepID: ID identifying the repository if more than one exists UserID: identifies the user ContextID: ID identifying the context, i.e. folder DocType: Flag specifying the document type DocName: Name of the document Access: Access rights to the document DocID: Id of the newly created document Creates a new document in a certain context (folder) of a repository CreateNewCMFolder RepID: ID identifying the repository if more than one exists UserID: identifies the user ContextID: ID identifying the context, i.e. folder ContextName: Name of the folder Access: Access rights to the folder ContextID: Id of the newly created context (i.e. folder) Creates a new context (folder) in an already existing context (folder) of a repository CreateNewBranch doc:id, forkversion: number Reference to branch Creates a new version-branch based on old version CreateDB SystemID: identifying the database environment the actual database is created in UserID: identifies the user Auth: Authentication data for UserID optional: more flags that define the behaviour and access rights for certain users DBID: Database Id Creates a new database in a certain database system CreateTable SystemID: identifying the database environment the actual database is created in DBID: Database ID UserID: identifies the user Auth: Authentication data for UserID Parameters: describing the relational table (i.e. Name, fields, primary key, etc...) or SQL statement CREATE TABLE... holding these parameters NULL if successful creates a table in a relational database CreateRelationship depends on the relationship CreateView depends highly on the nature of the view CreateDL Title: Title of a New Distribution List Description: Description of a new Distribution List DLID: identifier of the Distribution List Creates of a New DL CreateEmailAccount UserID: ID identifying the user SystemID: ID identifying the email system AccountName: A String containing the name of the EmailAccount Table with several rows containing information for each email account. This information includes at least name and EmailAccountID. This service provides a list of available emailaccounts. This service is mandatory as the EmailAccountID's are necessary for further access to the email accounts CreateEmail FolderID: ID identifying the folder ContentType: String that is either text or html and specifies the type of content that will be provided ContentData: Binary data containing the email content SystemID: ID identifying the email system The EmailID assigned to this newly created email (if successfull) This service creates a new email message inside a specified folder. This Email can later on be delivered using the SendEmail function. CreateForum ResID: resource identifier to which the forum will be associated Title: title for the forum Body: message to start th forum ForumID: identfier of the new forum Creates a new forum associated to a resource. CreateForumEntry ForumID: identifier of the forum in which the new entry will be added Title: title for the entry Body: message of the entry EntryID: identifier of the new entry Creates a new entry in an existent forum createConference ConferenceType: Array of Strings which specifies the type of medium which the conference accepts (chat, video, audio, vnc, whiteboard) ConferenceDescription: A brief description of the conference MaximumDuration: Conference maximum duration in minutes MaximumNumberOfParticipants: Maximum number of participants allowed for a conference ConferenceOwner: String that identifies the owner of the conference who is allowed to change conference configuration. String that identifies the conference univocally in the server Create conference service CreateNewsArticle GroupID: topic identifier to which the Group will be associated Title: Title for the News URL: URL for the News, if any Body: News Body NewsID: identifier of the new News Creates a new News CreateNewsgroup Title: Title for the Group Description: Description for the group Body: Body of the group GroupID: identifier of the new Group Creates a New Group CreatePoll Subject:String, StartDate:Date, EndDate:Date Success CreateSemanticAnnotation resource: type of resource being annotated, i.e. sound, image, video, document etc. boolean Creates a semantic annotation for a resource NewDocumentVersion ID of new document Creates a new document version CreateNewRecording ObjectID, TrackerID RecordID Creates a new recording object at the server. Now all changes to the positions of objects are tracked by the service. CreateNewUser username: unique username password: text password roles: user roles (default-role) userid:String Create a new user CreateVoting VotingObjID Creates a new voting Object CreateWiki WikiID – name of the wiki Creates a new wiki CreateArtefact UserId: user identifier; processId: process identifier; IdActInstance_wf: activity istance identifier; ArtefactName: name of the new artefact; Description: description of the new artefact; IdArtefact: id of the new artefact; Version: version of the new artefact; ArtefactType: type of the new artefact; Url: url where to retrieve the new artefact; Variables: variables of the new artefact; Completion: % of complation of the new artefact Whether the creation was successful Create a new artefact for the specified activity CreateGroup

CreateGroupMember

CreateSubGroup

CreateContextProfile CreateResource

Observations:

None

[edit] Add BCS

Name: Add

Signature:

ResourceID Add (platform, technology, containerID, operationType, set of Input Values for operationType)

Purpose: In CWE platform, adding resources to an existing shared space is a common task that needs to be performed quite often. Add BCS allows an existing resource to be added to an already existing shared space. In case, the resource that needs to be added does not exist, it should be created first using the Create BCS.

Parameters:

• Platform. This designates the particular CWE system where the resource should be added, e.g.: CSCW, BC, etc
• Technology. The parameter corresponds to the specific CWE technology, service or tool, such as Blog, Wiki etc.
• ContainerID: In addition to the platform and technology, containerID is provide to further specify the namespace where resource should be added e.g. a specific shared folder (i.e. folder name or unique identifier) or a blog (i.e. blogURI or unique identifier) etc.
• OperationType. This captures the particular addition process associated to the selected Technology.
• Set of pair-value. This consists of zero or more pair name/value, which the particular addition OperationType is able to unpack and process.

Output:

• If the add operation is successful, the Add BCS returns the ID of the resource which has just been added. In case of failure, an error message will be returned.

Usage example:

E.g. Add (BSCW, Blog, Ecospace, AddBlogEntry, ([UserID, “Kashif.iqbal”], [Headline, “content”], [Text, “Ecospace Review 2008”], [categories, list of CategoryID]))

WSDL file:

List of Operation Types:

OperationType Parameters Output Description AddBlogComment ArticleID: id of the article to comment CommentatorEmail: email address of commentator CommentText:Comment as text Comment Adds comment to article AddBlogEntry UserID: ID of user Headline: the article-headline content: Text of article categories: List of CategoryID Article Adds an article to the blog AddCalendarEventAttendee UserID: ID identifying the user EventID: ID indentifying the event AttendeeID:ID identifying the Attendee Flag: required/optional participant EventID provides functionality to add required and optional attendees to events AddVersion doc:id title:String, creator:User, content:Base64, doc:id Add a new version to this control addMediaForParticipant ConferenceIdentifier: String that identifies the conference in the Server. Participant: String that identifies the participant in the server. Usually a SIP URI Media: String that identifies the new media stream the participant will receive/send. MediaDirection: String that indicates the direction of the media stream to add (in, out, etc.) none Add a media stream to the media set used by participant AddPollQuestion QuestionType:QuestionType, Question:String Success Add a pollquestion AddPredefinedPollAnswer Qestion:String, Answers:List[String] Success Add a new question with custom answers to the poll AddDLMember DLID: identifier of the Distribution List MemberName: Name of a member eMailMember: e-mail of the member userMember: user name of a member passwordMember: Password for a member dataMember: data for a member MemberID: identifier of the Member Creates of a New member AddRightToRole rightID: ID of right roleID: ID of role boolean Adds a new right to a role. (Rights can be for example “read”, “write”, “rate”, “attach note” etc.) AddAnnotationAttribute attributeType: the type of the attribute, i.e. creator of the resource, title, publisher etc attributeValue: the value of the attribute can be either a string or a concept from an ontology boolean Adds a new attribute to a resources semantic annotation AddAnnotationAttributeValue value: a string that contains the new value boolean Adds a new annotation attribute value to a controlled vocabulary from which the values of an annotation attribute are taken AddDocument FolderID Data Name Description Returns ID of new document Adds a document AddFolder FolderID Name Description Returns ID of new folder Creates a new folder AddNote Subject Body Returns ObjectID Creates a new note AddWikiPage PageID – name of the wiki page, AuthorID – name of author, Content – the content of a wikie page Page Adds a new wikipage (name of page, author and content) to the wiki DiscussWikiPage PageID – the related page for the discussion, AuthorID – the ID of the Author, Content – the comment Discussion Page Adds a comment to a wikipage AddGroupMember

AddTaskAttachment

AddTaskParticipant

AddTaskResponsiblePerson

AddItem FolderID Data Name Description Returns ID of new document as String Adds a document AddFolder FolderID Name Description Returns ID of new folder as String Creates a new folder

[edit] Accept BCS

Name: Accept or Confirm

Signature:

Purpose:

In a typical CWE, events or messages are often generated as a result of various collaboration activities taking place within a given CWE. These events or messages can be seen as resources and should be identified using a GUID. The purpose of the Accept BCS is to provide the functionality of accepting or confirming a resource (e.g. an event, a message or task etc) identified by a unique identifier i.e. a GUID.

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description ConfirmCalendarEvent UserID: ID identifying the user EventID: ID indentifying the event Flag: accept/decline/undecided EventID provides functionality to accept or decline an calendar item (e.g. meeting, talk) or leave attendance undecided AcceptDLMessage MessageID: identifier of the Message DLID: identifier of the Distribution List Title: title of the message Body: Body of the message success: boolean Accept Message for a distribution List AcceptTask

[edit] Get BCS

Name: Get

Signature:

Resource Get (flag AuthenticationRequired, UserName, Passowrd, ResourceID or List of ResourceIDs)

Purpose: The purpose of the Get BCS is to retrieve whatever information - in the form of an entity is identified by the resource identifier or a list of resource identifiers. The outcome of the processing of Get request is the resource or list of resources, returned as the response.

Parameters:

• Flag: The flag identifies whether authentication is required or not to get the resource. If true, the Get BCS would expect the user name and password for authentication purposes.
• Username & Password: Username and password of the user registered with a particular CWE. The username and password is used to authenticate the user before allowing access to a particular resource.
• Resource ID: Unique identifier/s (GUID) of the resource/s being asked for in a given namespace.

Output:

• Resource: The output of the Get BCS is the resource itself for which the Get request has been sent.

Usage example:

• Resource Get ([flag, TRUE], [username, kashif.iqbal], [password, abcdef], [resourceID, GUID] )

WSDL file:

List of Operation Types:

OperationType Parameters Output Description GetArticle ArticleID: ID of Blog-article Single Blog-article Shows a single article GetExistingCMDocument RepID: ID identifying the repository if more than one exists UserID: identifies the user DocID: Id specifiying the document DocHandle: Link or handle to the requested document retrieves a document from a repository by providing some means of reference GetLastVersionNumber doc:id version:number Returns the latest version number of a document GetLastVersionContent doc:id content:Base64 Returns the document content of the last document GetVersionMetadata doc:id { changes_comment:String,version:State: int, author:User } Returns metadata of the version GetDLMembers DLID: identifier of the Distribution List List with MemberID’S: (identifiers of the Members of the Distribution List) Get DL Members GetDLProfile DLID: identifier of the Distribution List Title: Title of a New Distribution List Description: Description of a new Distribution List Get DL Profile GetListOfEmailAccounts UserID: ID identifying the user SystemID: ID identifying the email system Table with several rows containing information for each email account. This information includes at least name and EmailAccountID. This service provides a list of available emailaccounts. This service is mandatory as the EmailAccountID's are necessary for further access to the email accounts. GetListOfFoldersInEmailAccount EmailAccountID: ID identifying the emailaccount SystemID: ID identifying the email system Table with several rows containing information for each Folder. This information includes at least name and FolderID. This service provides a list of existing folders inside a specific email account. This service is mandatory as the FolderID's are necessary for further access to the folders. GetListOfEmailsInFolder FolderID: ID identifying the folder SystemID: ID identifying the email system Table with several rows containing information about each email. This information includes at least name, sender, list of receipients and MailID This services provides a list of all emails contained in a specific folder. This service is also mandatory because the mailIDs are needed for further access to the emails. GetEmailContent EmailID: ID identifying the email ContentType: String that is either text or html and specifies the type of content that should be retreived SystemID: ID identifying the email system File containing the email data (ContentData) according to the specified ContentType. This service fetches an email from the email system and provides it's content. getParticipants ConferenceIdentifier: String that identifies the conference in the Server Array of Strings containing the participants of the specified conference Get participants of a conference service getConferenceInfo ConferenceIdentifier: String that identifies the conference in the Server Array of Strings which specifies the type of medium which the conference accepts. Allowed values: chat, video, audio, vnc, whiteboard Conference info service getParticipantInfo ConferenceIdentifier: String that identifies the conference in the Server. Participant: String that identifies the participant in the server. Usually a SIP URI Array of Strings which specifies the type of medium that the specified participant accepts. Allowed values: chat, video, audio, vnc, whiteboard Get information from a participant in a conference service GetRoleRights roleID: ID of role rightSet: a set of rights Gets a list of all rights included in the specified role. GetUserRoles userID: ID of user roleSet: a set of roles Gets a list of all roles which have been assigned to the user. ViewSemanticAnnotation resourceID: the id of the resource, whose semantic annotation will be viewed semanticAnnotationSet: the set of details that comprise the semantic annotation of a resource Shows the semantic annotation details of a resource ViewRDF resourceID: the id of the resource, whose semantic annotation will be viewed in RDF RDF file Extracts the semantic annotation of a resource in RDF format ViewSemanticAnnotation resourceID: the id of the resource, whose semantic annotation will be viewed semanticAnnotationSet: the set of details that comprise the semantic annotation of a resource Shows the semantic annotation details of a resource GetDocument DocumentID Binary Data Gets the contents of a document GetFolderContent FolderID, depth Hierachy of folder Lists the content of a folder GetObjectEvents ObjectID List of EventTypes Returns list with Events Gets a filtered list of events for an object (document or folder) GetObjectNotes ObjectID Note as struct with (subject, body, type, author, date) Gets the note of an object GetUsersHomeID FolderID Gets the calling users home ID GetVersionInfo DocumentID List of versions (with DocumentID for each version) Get version info of object GetMetadataOfObject ObjectID List of Metadata (tags, description) Returns all metadata of an object GetListOfTrackingAgents List of Tracker IDs Returns a list of all trackers that are registered at the system. GetListOfTrackedObjects List of ObjectIDs Returns a list of all objects that are registered at the system. GetObjectsTrackedByTracker TrackerID List of ObjectIDs Returns a list of all objects that are tracked by a tracking agent . GetInformationAboutObject ObjectID Name, Description, Type, Returns all available information about a particular object. GetObjectPosition ObjectID PositionData (in a technology related format) Returns the current position of the object in question. GetCoordinatesModel ObjectID, TrackerID String specifying the type of coordinate system used Returns information about the type of coordinate system that is used to encode the position (e.g. WSG84 (GPS), ETRS89, custom model…). GetPositionAccuracy ObjectID HDOP value if GPS receiver is used for localisation Returns a value indicating the quality of the position calculation.. GetRecordedTrack RecordID List of recorded Positions Returns a list of tracked positions. GetUserData userid: id of the user whose data need to be retrieved hashtable (data name -> data value) Get user data GetVoting VotingObjID Result Gets the result of a voting getOnlineUsers the sesion name the list of online users Ask to the service presence about the list of connected users in a specific session GetWikiPageHistory PageID – name of wiki page List of Pages (containing snapshots of the wikipage history) Provides all versions of a given wiki-page GetActivitiesForProcess userId: user identifier; processId: process identifier Array of Activities Returns all the activities of the process specified in input the specified user is working to GetActivitiesByStatus userId: user identifier; processId: process identifier; status: activity status Array of Activities Returns all the activities of the process specified in input the specified user is working to, which are in the specified status (e.g. suspended, running, etc.) GetActivityStatus userId: user identifier; processId: process identifier; activityIstId: activity istance identifier The status of the activity (string) Returns the status of the specified activity GetApplicationControl Provides a means to use a shared application by a user GetContextProfile GetItem DocumentID Binary Data as Bas64 Gets the contents of a document GetFolderContent FolderID, depth SIOC-Representation as String Lists the content of a folder in SIOC Format

[edit] Delete BCS

Name: Delete or Remove

Signature:

ResourceID Delete (flag AuthenticationRequired, Username, Password, ResourceID or List of ResourceIDs)

Purpose: Delete is the most common operation required by most of the data management systems. Delete BCS allows the deletion of a particular resource or list of resources identified by a unique resource identifier i.e. GUID or list of unique identifiers respectively.

Parameters:

• Flag: The flag identifies whether authentication is required or not to delete the resource. If true, the Delete BCS would expect the user name and password for authentication purposes.
• Username & Password: Username and password of the user registered with a particular CWE. The username and password is used to authenticate the user before allowing access to delete a particular resource.
• Resource ID: Unique identifier/s (GUID) of the resource/s being deleted in a given namespace.

Output:

• If the delete operation is successful, the Delete BCS returns the ID of the resource which has been deleted as a result of the successful execution of the Delete BCS. In case of failure, an error message will be returned.

WSDL file:

An Example Usage:

• resourceID Delete ([flag, TRUE], [username, kashif.iqbal], [password, abcdef], [resourceID, GUID] )

List of Operation Types:

OperationType Parameters Output Description RemoveBlogComment AdminID or UserID: ID that administrates the Blog or owns Blogarticle CommentID: ID of comment success:Boolean Removes a comment for an article RemoveArticle AdminID or UserID: ID that administrates the Blog or owns Blogarticle ArticleID: ID of article success:Boolean Removes article and corresponding comments from a blog RemoveCategory CategoryID : Name of category -- Removes Category from blog list and blog-articles RemoveCalendarEntry UserID: ID identifying the user EventID: ID indentifying the entry NULL removes an entry/event from the calendar RemoveCalendarEventAttendee UserID: ID identifying the user EventID: ID indentifying the event AttendeeID: Id of the to be removed Attendee EventID removes and Attendee from the participants list DeleteExistingCMDocument RepID: ID identifying the repository if more than one exists UserID: identifies the user DocID: Id specifiying the to be deleted document ContextID: ID identifying the context the document was in Deletes an existing document from a certain context in a repository if this right is granted DeleteExistingCMFolder RepID: ID identifying the repository if more than one exists UserID: identifies the user ContextID: Id specifiying the to be deleted Folder (context) ContextID: ID identifying the context (folder) the deleted folder was in Deletes an existing folder from a certain context in a repository if access rights allow this DeletePreviousVersion doc:id success:boolean delete the n-1 version of a document DeleteRecord SystemID: identifying the database environment the actual database is created in DBID: Database ID UserID: identifies the user Auth: Authentication data for UserID Parameters: describing the data that need to be deleted (i.e. rows) or SQL statement DELETE... NULL if successful deletes certain data from a database DeleteTable SystemID: identifying the database environment the actual database is created in DBID: Database ID UserID: identifies the user Auth: Authentication data for UserID Parameters: describing the data that need to be deleted (i.e. tables) or SQL statement DROP TABLE... NULL if successful deletes a table in the database DeleteDB SystemID: identifying the database environment the actual database is created in DBID: Database ID UserID: identifies the user Auth: Authentication data for UserID NULL if successful deletes a database from a database environment DeleteRelationship depends on the relationship DeleteView depends highly on the nature of the view DeleteDL DLID: identifier of the Distribution List success: Boolean (failure if any users associated with the List) Deletes a distribution List RemoveDLMember DLID: identifier of the Distribution List MemberID: identifier of the Member success: boolean Deletes distribution list member DeleteForum ForumID: identifier of the forum to be deleted ForumID: identifier of the deleted Forum. 0 if it cannot be deleted Deletes an existent forum DeleteForumEntry ForumID: identifier of the forum to which the entry belongs to EntryID: identifier of the entry to be deleted EntryID: identifier of the deleted Entry. 0 if it cannot be deleted Deletes an existent entry deleteMediaForParticipant ConferenceIdentifier: String that identifies the conference in the Server. Participant: String that identifies the participant in the server. Usually a SIP URI Media: identifies the media the user is not enabled to use any more. MediaDirection: String that In indicates the direction of the media stream to remove (in, out, etc.) none Remove a media stream from the media set used by participant DeleteNewsArticle NewsID: identifier of the News success: boolean Delete a News Article DeleteNewsgroup GroupID: identifier of the Group success: boolean Delete a Group Article RemovePollQuestion Question:ID Remove question from poll RemoveUserFromRole userID: ID of user roleID: ID of role boolean Removes a role from a user. RemoveRightFromRole rightID: ID of right roleID: ID of role boolean Removes all rights from a role. DeleteRole roleID: ID of the role boolean Deletes the specified role. DeleteRight rightID: ID of the right boolean Deletes the specified right. DeleteUser userID: ID of the user boolean Deletes the specified user. DeleteSemanticAnnotation resourceID: the id of the resource, whose semantic annotation will be deleted boolean Deletes the semantic annotation of a specific resource DeleteAnnotationAttributeValue value: a string that contains the value to be deleted boolean Deletes an annotation attribute value from a controlled vocabulary from which the values of an annotation attribute are taken DeleteNote ObjectID Returns ID of the associated object Deletes a note DeleteObject ObjectID FolderID Returns ID of the folder Deletes an object (document or folder) DeleteUser userid: useridof the user to delete success:Boolean Delete an existing user RemoveWikiPage PageID – name of the Wikipage Success (Boolean) Removes a wikipage from the wiki DeleteGroup

DeleteGroupMember

DeleteSubGroup

RemoveTaskAttachment

RemoveTaskParticipant

RemoveTaskResponsiblePerson

DeleteTask

DeleteContextProfile DeleteResource

DeleteItem ObjectID FolderID Returns ID of the folder as String Deletes an object (document or folder)

[edit] Edit BCS

Name: Edit

Signature:

Purpose:

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description EditBlogEntry ArticleID: id of article, article-headline content: Text of article categories: List of CategoryID -- Changes a blog-article EditCategory CategoryID : Name of category -- Changes category in blog list and blog-articles EditCalendarEntry UserID: ID identifying the user EventID: ID indentifying the event/entry Date Time Duration Message: subject and add. information about the event Participants: List of participants/UserIds (required/optional) NB: notification behaviour EventID edits an existing event RenameCMDocument RepID: ID identifying the repository if more than one exists UserID: identifies the user DocID: ID identifying the document DocName: new name of the document DocID renames a certain document in the repository RepID if access rights sufficient RenameCMFolder RepID: ID identifying the repository if more than one exists UserID: identifies the user ContextID: ID identifying the folder ContextName: new name of the folder ContextID renames a certain folder in the repository RepID if access rights sufficient EditForumEntry ForumID: identifier of the forum to which the entry belongs to EntryID: identifier of the entry to be edited Title: new title for the entry (blank=don't modify) Body: new message of the entry (blank=don't modify) EntryID: identifier of the edited Entry. 0 if it cannt be edited Edits an entry of a forum changeConferenceMode ConferenceIdentifier: String that identify the conference in the Server. ConferenceMode: String containing the new conference mode. Participants: Array of Strings that contains participant identifiers for the configuration of the specified mode. Array of String which specifies: first, the new mode configured for the conference, and then, the participants that compose the specific mode Change the conference mode ModifyNewsArticle NewsID: identifier of the News GroupID: topic identifier to which the Group will be associated Title: Title for the News URL: URL for the News, if any Body: News Body success: boolean Modify News Article EditPollQuestion QuestionType:QuestionType, Question:String Success Change the Pollquestion ModifiySemanticAnnotation resourceID: the id of the resource, whose semantic annotation will be modified boolean Modifies the semantic annotation of a specific resou ModifyAnnotationAttribute attributeType: the type of the attribute attributeValue: the new value of the attribute boolean Modifies the value of an attribute of a resources semantic annotation RenameObject ObjectID Name New name Renames an existing object EditUserData first name: first name of the user surname: surname of the user e-mail: e-mail address of the user openid: openid of the user address: user's address telephone: user's phone number fax: user's fax number note: user notes roles: user roles success:Boolean Edit an already existing user's data EditVoting VotingObjID ListOfChoices VotingParams SetOfVoters None Edits a voting by changing the list of choices to be vote. Also the voting parameters (like voting period) and the set of voters can be set. EditWikiPage PageID – name of the wiki page, AuthorID – name of author, Content – the content of a wikie page Page Edits a wikipage ModifyContextProfile RenameItem ObjectID, name Renames an existing object

ModifyResource

[edit] Decline BCS

Name: Decline or Reject

Signature:

Purpose:

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description DeclineCalendarEvent UserID: ID identifying the user EventID: ID indentifying the event Flag: accept/decline/undecided EventID provides functionality to accept or decline an calendar item (e.g. meeting, talk) or leave attendance undecided (similar to ConfirmCalendarEvent)

RejectDLMessage DLID: identifier of the Distribution List MessageID: identifier of the Message flagReject: boolean Rejects Message (a case of moderate) RejectTask

[edit] Start BCS

Name: Start

Signature:

Purpose:

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description StartVersioning title:String, creator:User, content:Base64, doc:id Initializes the versioning of document StartRecording RecordID True if successfull Starts the recording session. CallContact StartTask

[edit] End BCS

Name: End

Signature:

Purpose:

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description endConference ConferenceIdentifier: String that identifies the conference in the Server Boolean that specifies if the conference has been closed successfully End conference service StopRecording RecordID True if successfull Stops the current recording session. TerminateCall CancelTask FinishTask

[edit] Recover BCS

Name: Recover

Signature:

Purpose:

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description RecoverPreviousVersion doc:id, version:number success:boolean restore the given version-number of a document, to the latest version

[edit] Execute BCS

Name: Execute

Signature:

Purpose:

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description PerformSQLQuery SystemID: identifying the database environment the actual database is created in DBID: Database ID UserID: identifies the user Auth: Authentication data for UserID SQLQuery: String with a certain SQL statement list of results or cursor executes an sql statement on a given database

[edit] Send BCS

Name: Send

Signature:

Purpose:

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description SendEmail EmailID: ID identifying the email List of UserIDs: IDs specifying the receipients. This list can either contain UserIDs (if the receipient is member of the community) or email addresses SystemID: ID specifying the email system ID of the email that has just been sent (if succesfull) This service provides functionality to deliver an email message to several receipients. sendFigure the figure, the user who modified it none send an event to those components interested, indicating the properties of the figure that has been modified and the action performed as well as the user who did this operation sendImage send bytecodes of a image none send the representation of an images (for example an array with bytecodes) to the others collaborators. SendChatMessage SendIMMessage

[edit] Authenticate BCS

Name: Authenticate

Signature:

Purpose:

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description ProvideCredentialsForMailbox EmailAccountID: IF identifying the emailaccount Username: Username needed to access the mail server Password: Password needed to access the mail server SystemID: ID identifying the email system Null if succesfull (otherwise errormessage) This Service is needed to provide credentials for accessing the mail server for a specific emailaccount.

[edit] Notify BCS

Name: Notify

Signature:

Purpose: (from the sender by subscription)

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description PushNotificationEvents CreatePoll Subject:String, StartDate:Date, EndDate:Date Success

[edit] Check BCS

Name: Check

Signature:

Purpose: (from the recipient without subscription)

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description CheckForNewEmails EmailAccountID: ID identifying the emailaccount SystemID: ID identifying the email system A list containing the EmailIDs for each new email. This list is empty if there are no new emails This service triggers the email system to check for new messages for a specific mailbox. PollForNotificationEvents Returns a list of events that occured since the last call to PollForNotificationEvents of which the client has not yet received notification. Clients may choose to receive notification of all events, or provide a list of event types which will be used to filter the events returned. CheckResourceAvailability

[edit] Replace BCS

Name: Replace

Signature:

Purpose:

Parameters: replace or move

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description MoveForum ForumID: identifier of the forum to which the entry belongs to EntryID: identifier of the entry to be moved DstForumID: identifier of the estiantion forum EntryID: identifier of the entry in the new forum Moves an entry from on forum to another ReplaceDocument DocumentID Data DocumentID Replaces a document ReplaceItem DocumentID Data DocumentID as String Replaces a document

[edit] Reply BCS

Name: Reply

Signature:

Purpose:

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description ReplyToForumEntry ForumID: identifier of the forum to which the entry belongs to EntryID: identifier of the entry to be moved Title: title for the entry Body: message of the entry EntryID: identifier of the created entry Craetes a new entry as reply to an existent entry ReplyToNewsArticle NewsID: identifier of the News Title: Title for the Reply Body: Reply Body ReplyID: identifier of the new Replay NewsID: identifier of the News Creates a News Replay AnswerPollQuestion PollId:Id, QuestionId:id,Answer:String/Selection Success Answer a qustion in a poll

[edit] Invite BCS

Name: Invite

Signature:

Purpose:

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description inviteParticipant ConferenceIdentifier: String that identifies the conference in the Server Participant: String that identifies the participant in the server. Usually a SIP URI Boolean that informs if the specified participant has been invited successfully to the conference Invite participant to a conference service InviteContact InviteParticipantToChat

[edit] Un-invite BCS

Name: Un-invite

Signature:

Purpose: (Disconnect, Drop, Delete a user, …)

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description disconnectParticipant ConferenceIdentifier: String that identifies the conference in the Server. Participant: String that identifies the participant in the server. Usually a SIP URI Boolean that informs if the specified participant has been disconnected successfully from the conference Disconnect participant from conference service

[edit] Subscribe BCS

Name: Subscribe

Signature:

Purpose:

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description RegisterNotificationEvent Registers an event for which other clients may require notification. The details of the event will be delivered to clients that have registered an interested in that event type when notification events are pushed, or they will receive such notification when they next poll for events. RegisterNotificationInterest Registers a client's interest in receiving notification messages for events of a given type. A client may register for multiple event types. When notification is no longer required, the client should unregister their interest using DeRegisterNotificationInterest.

RegisterAuthor AuthorID – name of author Creates a new author SubscribeToPage PageID – the wikipage, AuthorID – the id of the subscriber Listing about changes Informs a user about changes related to a wiki-page

[edit] Unsubscribe BCS

Name: Unsubscribe

Signature:

Purpose:

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

DeRegisterNotificationEvent Unregisters an event. Clients who have not already received notification of this event will not be notified of the unregistered event. DeRegisterNotificationInterest Unregisters a client's interest in a set of event types, or all event types if no set is supplied. The client will no longer receive notification of the specified types of events.

[edit] Search BCS

Name: Search

Signature:

Purpose: Find (as a combination of get-filter-retrieve)

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description Search ObjectID (e.g. folder) type, pattern List of objects (name, id) Returns all objects which are related to the search FindWikiPage PageID – name of wiki page OR, Keywords – list of keywords List of Pages Searches for a wiki-page FindChatParticipant FindChatPartner

[edit] Copy BCS

Name: Copy

Signature:

Purpose: (create an instance of something that exists)

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description CopyObject ObjectID FolderID NewObjectName Returns ID of new object Copies (and renames) objects between containers

[edit] Lock BCS

Name: Lock

Signature:

Purpose: Book Resource

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description CheckOut DocumentID DocumentID Locks a document BookResource

[edit] Unlock BCS

Name: Unlock

Signature:

Purpose:

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types: OperationType Parameters Output Description CheckIn DocumentID DocumentID Unlocks a document

[edit] Export BCS

Name: Export

Signature:

Purpose: (transforming)

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description ExportContentToRSS Content: content information to be exported RSS document Export the contain into RSS document format ExportContentToRDF Content: content information to be exported RDF document Export the contain into RDF document format ExportContentToOWL Content: content information to be exported OWL document Export the contain into OWL document format RenderWikiMarkup Content – content with wiki-markup Page as XHTML Translates the wiki markup into other formats

[edit] Store BCS

Name:

Signature:

Purpose: Save

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description saveWorkArea a list of all the elements in the whiteboard, the format in which this informatin should be save (JPEG, GIF, XML...) confirmation of the succesful or not of this operation Note: this operation can be performed in two ways: one in the local computer of the user and other in a shared place. Save the results of the drawing area, according to a given format AttachFile PageID – the name of the page, AuthorID – the id of the author, File – File as bytestream Attaches a file to a wikipage

SaveChat

[edit] Enter/Leave

Name:

Signature:

Purpose:

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

EnterChatRoom LeaveChatRoom

[edit] Share BCS

Name:

Signature:

Purpose:

Parameters:

Output:

Usage example:

WSDL file:

Share Application

[edit] Set BCS

Name:

Signature:

Purpose:

Parameters:

Output:

Usage example:

WSDL file:

List of Operation Types:

OperationType Parameters Output Description SetVersionMetatdata doc:id, changes_comment:String, version:State: int, author:User void Set the metadata for the version SetPrimaryKey SystemID: identifying the database environment the actual database is created in DBID: Database ID UserID: identifies the user Auth: Authentication data for UserID Parameters: describing the primary key field or SQL statement ALTER TABLE... SetDLAccessRights DLID: identifier of the Distribution List MemberID: identifier of the Member flagActive: boolean Set access rights for a member for a distribution list SetDLFilter DLID: identifier of the Distribution List MemberID: identifier of the Member dateStart: start date of the filter dateEnd: End Data of the filter FilterID: identifier of the Filter MemberID: identifier of the Member FlagDistributed: Flag of distribution to a member Set Filter of a DL SetDLProfile DLID: identifier of the Distribution List Title: Title of a New Distribution List Description: Description of a new Distribution List Set DL Profile SetRoleRights roleID: ID of role rightSet: a set of rights boolean Sets the role rights. SetUserRoles userID: ID of user roleSet: a set of roles boolean Sets the user roles. SetObjectPosition ObjectID, TrackerID, PositionData True if successful Tracking agents specify the position of objects here. SetCoordinatesModel ObjectID, TrackerID, string specifying the coordinate model True if successful .Sets the type of coordinate system that is used to encode the position (e.g. WSG84 (GPS), ETRS89, custom model…). SetActivityRunning userId: user identifier; processId: process identifier; activityIstId: activity istance identifier Whether the setting was successful Set the status of the specified activity to "running" SetActivitySuspended userId: user identifier; processId: process identifier; activityIstId: activity istance identifier Whether the setting was successful Set the status of the specified activity to "suspended" SetActivityCompleted userId: user identifier; processId: process identifier; activityIstId: activity istance identifier; forcing: whether to force the activity completion Whether the setting was successful Set or force the status of the specified activity to "completed" SetArtefactCompleted UserId: user identifier; processId: process identifier; IdActInstance_wf: activity istance identifier; ArtefactName: name of the new artefact; Description: description of the new artefact; IdArtefact: id of the old artefact; Version: version of the old artefact; IdArtefactNew: id of the new artefact; VersionNew: version of the new artefact; ArtefactType: type of the new artefact; Url: url where to retrieve the new artefact; Variables: variables of the new artefact; Completion: % of complation of the new artefact Whether the setting was successful Set an artefact as "completed" SetResourceProperties