Oracle® Collaboration Suite Workspaces Application Developer's Guide 10g Release 1 (10.1.1) Part Number B16234-02 |
|
|
View PDF |
The Oracle Workspaces user interface uses an MVC (Model-View-Controller) design pattern for displaying its UI pages. This chapter describes the URLs that are exposed and the unique and persistent parameters used to access specific pages in the UI.
This section describes end-user Oracle Workspaces URLs, including the following views and functions in Oracle Workspaces:
Overview Page
Browse Library, Meetings, Tasks, Discussions, Announcements, Views, Members
Create New Meeting, New Task, Announcement, View
Using these URLs require that a developer use the Java SDK to access workspace UIDs and IDs of objects (resources) within a workspace. The CwUID class in the Java SDK can represent the UID of an object in a workspace as a string with following format:
<workspaceId>#<resourceId>#<resourceItemId>
Note:
Once you have retrieved a CwUID string with the Java API, you must escape some of its characters before using it in an Oracle Workspace URL. See "Creating Oracle Workspace URLs" for more information about retrieving CwUid strings with the Java API and using them in these URLs.In the following table, <fileUID>, <folderUID>, <meetingUID>, <taskUID>, <announcementUID>, <forumUID>, <threadUID>, and <viewUID> are the string representations of the CwUid of the corresponding object. See the CwUid class in Oracle Collaboration Suite Workspaces Java API Reference Javadoc for methods to retrieve this information.
Table 5-1 Oracle Workspace URLs
UI View | URI <host:port/workspaces/URI> | Parameter Formats |
---|---|---|
My Workspaces |
/cwHomeAction.do?event=<event> |
<event>
|
Workspace Overview Page |
/workspaceAction.do? event=goHome&workspaceUid=<workspaceUID> |
|
Workspace Properties |
/workspaceAction.do? event=showProperties &workspaceUid=<workspaceUID> |
|
Workspace Services |
/workspaceAction.do? event=showResources &workspaceUid=<workspaceUID> |
|
Library Overview |
/filesAction.do?event=filesFolderList &workspaceUid=<workspaceUID> |
|
Folder |
/filesAction.do? event=filesFolderList &uid=<folderUID> |
|
File Properties |
/filesAction.do?event=filesFolderPropsForm &uid=<fileUID> |
|
File Links |
/filesAction.do? event=filesFolderPropsFormLinks &uid=<fileUID> |
|
Meetings Overview |
/calendarAction.do? event=meetingsView &workspaceUid=<workspaceUID>&date=<date>&viewType=<viewType>&meetingsScope=<meetingScope> |
<date>: Format yyyy/mm/dd <viewType>:
<meetingScope>:
|
Create New Meeting |
/calendarAction.do? event=meetingCreateForm &workspaceUid=<workspaceUID>&date=<date>&timeHour=<timeHour> |
<date>: Format yyyy/mm/dd <timeHour>: Format hh |
Meeting Properties |
/calendarAction.do? event=meetingModifyForm &workspaceUid=<workspaceUID>&eventUid=<meetingUID> |
|
Tasks Overview |
/calendarAction.do? event=tasksView &workspaceUid=<workspaceUID>&taskType=<taskType>&tasksScope=<taskScope>&event=sort &source=tasksViewTable &value=<value>&state= |
<taskType>:
<taskScope>:
<taskScope>:
<value>:
|
New Task |
/calendarAction.do? event=taskCreateFormNew &workspaceUid=<workspaceUID>&date=<date> |
<date>: Format yyyy/mm/dd |
Edit Task |
/calendarAction.do? event=taskModifyForm &workspaceUid=<workspaceUID>&taskUid=<taskUID> |
|
Announcements |
/workspaceAction.do? event=showAnnouncements &workspaceUid=<workspaceUID> |
|
New Announcement |
/workspaceAction.do? event=addAnnouncementForm &workspaceUid=<workspaceUID> |
|
View Announcement |
/workspaceAction.do? event=viewAnnouncement &uid=<announcementUID> |
|
Discussions |
/discussionAction.do? event=goHome &workspaceUid=<workspaceUID> |
|
A Forum |
/discussionAction.do? event=oracle.discussions.ui.event.board.browse &oracle.discussions.ui.fid=<forumUID> |
|
Browse Topic |
/discussionAction.do? event=oracle.discussions.ui.event.thread.browse_message <messageView>&oracle.discussions.ui.fid=<forumUID>&oracle.discussions.ui.tid=<threadUID> |
|
Inbox |
/emailAction.do? event=goHome &workspaceUid=<workspaceUID> |
|
Views |
/viewAction.do? event=eventViewListViews&workspaceUid=<workspaceUID> |
|
New View |
/viewAction.do?event=eventViewCreateViewForm &workspaceUid=<workspaceUID> |
|
A View |
/viewAction.do? event=eventViewGetContents &uid=<viewUID> |
|
Members |
/workspaceAction.do? event=showPeople&workspaceUid=<workspaceUID> |
|
Add Members |
/workspaceAction.do? event=addMembersForm &workspaceUid=<workspaceUID> |
|
Logout |
/cwHomeAction.do?event=logout |
|
Once you have retrieved a CwUID string with the Java API, you must escape some of its characters before using it in an Oracle Workspace URL. For example, you must escape the #
character to %23
before using it in a URL.
For example, suppose that the CwUID for a Library Folder is the following string:
FFA70A6283EC980BE030018A19B8665A#9#2613#7775486
In a URL, this CwUID would be represented as follows:
http://<host>/workspaces/filesAction.do? event=filesFolderList &uid=FFA70A6283EC980BE030018A19B8665A%239%232613%237775486
The following Java method getWorkspaceFolder takes a Workspace as an argument and outputs to System.out the URLs to access the Workspace's Library overview and its Folders:
private void getWorkspaceFolder(CwWorkspace workspace) throws CwException { CwFolder wFolder = getFilesResource(workspace).getWorkspaceFolder(); if (wFolder != null) { CwFilesResourceItem[] contents = wFolder.listContents(); String libraryUrl = "/workspaces/filesAction.do?event=filesFolderList&workspaceUid=" + escapeURL(workspace.getUid().toString()); System.out.println("Library URL: " + libraryURL); for (int i=0; i<contents.length; i++) { CwFilesResourceItem item = contents[i]; CwResourceItemProperties props = item.getProperties(); CwUid itemId = props.getUid(); boolean isFolder = (itemId.getEntityType() == CwEntityType.FILES_FOLDER); if (isFolder) { String itemName = props.getName(); System.out.println("Folder Name: "+itemName); String folderUrl = "/workspaces/filesAction.do" + "?event=filesFolderList" + "&uid=" + escapeURL(item.getUid().toString()); System.out.println("Folder URL: "+folderUrl); } } } } private String escapeURL(String url) { if (url == null) return null; url = url.replaceAll("\\x25", "%25"); // replaces % url = url.replaceAll("\\x23", "%23"); // replaces # url = url.replaceAll("\\x2B", "%2B"); // replaces + url = url.replaceAll("\\x2F", "%2F"); // replaces / return url; }
This section describes application administration URLs, which includes the following functions:
Oracle Workspaces Application Management (Properties, Roles, List of Workspaces that Require Recovery, Re-Ownership)
Template Management
Proxy as Admin to any Workspace
Table 5-2 Oracle Workspaces Application Administration URLs
UI View | URI <host:port/workspaces/URI> | Parameter Formats |
---|---|---|
Application Properties |
/cwHomeAction.do?event=appPropsList |
|
Application Role Management |
/cwHomeAction.do?event=appRolesHome |
|
Workspaces that Need Recovery |
/cwHomeAction.do?event=showRecoveryInfo |
|
Unowned Workspaces |
/cwHomeAction.do?event=showOrphanedWorkspaces |
|
All Workspaces |
/cwHomeAction.do?event=listAllWorkspaces |
|
Access Workspace as Application Administrator |
/workspaceAction.do? event=adminEnterWorkspace &sysAdminMode=y&workspaceUid= |
|
Templates |
/templatesAction.do?event=goHome |
|
View a Template |
/templatesAction.do? event=previewTemplate &explorerMode=0 &wsCreationWzMode=FALSE &templateID=<Template_Name> |
|
View XML of a Template |
/templatesAction.do? event=downloadTemplate &templateID=<Template_Name> |
|
View XSD |
/templatesAction.do?event=getTemplateSchema |
|
Upload New Template |
/templatesAction.do?event=uploadTemplateForm |
|
System Services (Resources) |
/cwHomeAction.do?event=showResourceTypeStatus |
|