Collaboration Selector Documentation
This document is for internal use and is not supported. The purpose is to describe the various Collaboration selectors and the parameters. All selectosr share a common base URI of /do/selector/X, where X is the name of the selector as noted in the table below.
| <common parameters > | These are parameters are common to ALL selectors. |
| user | Multiple users. |
| userrole | Multiple users and roles. |
| usergrouprole | Multiple users, groups and roles. |
| usersingle | Single user. |
| task | Single (dependent) task |
| tasklist | Multiple task lists. |
| discussion | Multiple discussions. |
| singlediscussion | Single discussion |
| project | Single project |
| projectmulti | Multiple projects |
| projectfolder | Select a single project folder |
| folder | Select a single document folder. |
| foldercrawler | Select a single document folder (adds additional check to only display folders which are crawler accessible) |
| file | Select multiple documents. |
| communityRole | Single "community role" selector for a specific community. |
common parameters
The following parameters are available to all selectors.
| Param | Req'd | Type | Description |
| selectorCallback | yes | String | The name of the javascript function that the selector framework will call when the user clicks finish in the selector. The parameters passed to the callback function are: function callback(ids, names) ids = array of id values for all selected objects |
| projID | yes* | int | The project id for the selector. |
| selectedIDs | no | String | An array of integer ids that coresponds to items that should be shows as already "selected" in the selector. |
| access | no | int | Specifies the security access level (e.g. AccessLevel.EDIT) required to make an object in the selector "available" for selection |
| disableSelectedNodes | no | boolean | If set to true, the 'selectedIDs' list is set to selected AND disabled in the selector (this prevents the user from unselecting already selected items in the selector). |
user userrole usergrouprole usersingle
Various forms of the user picker for users, groups and/or roles.
| Param | Req'd | Type | Description |
| searchMode | yes* | boolean | This is more of an internal parameter and specifies whether the user picker is in "search" mode or not. *Although not strictly required, this should always be set explicitly to false to avoid problems of accidentally starting in search mode. |
| hiddenIDs | no | String | A comma separated list of users ids. User ids in the list will NOT be shown at all in the user selector. |
task
Selection of a single task (currently this is specific to selecting dependent tasks).
tasklist
Selection of multiple task lists.
discussion singlediscussion
Selection of multiple or single discussions.
project projectmulti projectfolder
Selection of a single or multiple projects or a single project folder.
| Param | Req'd | Type | Description |
| personalProjUserID | no | int | This will add the user's personal project as a selection in the project selector as well. The user's portal user id must be specified. |
| filterIllegalTokens | no | boolean | If set to true, projects that have illegal characters in them (i.e. cause problems with WebFolders) will not be displayed. |
| includeNormalFolder | no | boolean | This applies to project folders. When set to true, this will enable all project folder types of type ProjectFolderType.NORMAL. |
| funcArea | no | int | If this value is set to one of the following values from IProject, if the functional area specified is NOT enabled for the project it will be disabled in the selector. IProject.PROJECT_AREA_CALENDAR (2) IProject.PROJECT_AREA_TASK_LISTS (3) IProject.PROJECT_AREA_DOCUMENTS (4) IProject. PROJECT_AREA_DISCUSSIONS (5) |
folder crawlerfolder file
Document selectors for doc folders, documents.
| Param | Req'd | Type | Description |
| hiddenIDs | no | String | A comma separated list of document folder OR file ids. Folder and files in this list will be shown as "disabled" (not selectable). |
| disableModFolders | no | boolean | If set to true (default is false), moderated folders will be disabled in the folder selector. |
communityRole
Community role selector (used in the role settings page).
| Param | Req'd | Type | Description |
| communityID | yes | int | The single community ID to use for display the community name/roles. |