This page lists some simple examples of when the PRC (Plumtree Remote Client) should be used, and provides links to the associated topics.
To search for objects in portal Administration, see Object Management : Querying Portal Objects and Querying Object Properties. Everything in the portal, except users and documents, is represented by a portal object stored in the Plumtree database. This includes portlets, crawlers, authentication sources, profile sources, remote servers, and data sources.
To search for documents in the portal Knowledge Directory, see Knowledge Directory Operations : Querying Documents.
To search for users in the portal, see User Operations : Querying Users.
To set the security for objects, see Object Management : Managing Security. Security for portal objects is implemented using Access Control Lists (ACLs) that can be applied to folders or individual objects. The ACL defines the access privileges for portal users and groups.
To start a job, see Portal Jobs. (A Job is a collection of related portal operations. Each operation is one task, such as a crawl for documents, an import of users, or one of the system maintenance tasks.)
To create or modify a portlet or portlet template, see Portlet Operations. The IPortlet* interfaces in the PRC are different from the EDK portlet API (com.plumtree.remote.portlet). The interfaces in the portlet API are used to manage communication between a portlet and the portal, while the PRC IPortlet* interfaces provide access to administrative functionality related to the portlet objects stored in the portal.
To create a new group in the portal, or add members to an existing group, see User Operations : Creating Groups and Adding Users. The IUser* interfaces in the PRC provide access to administrative functionality related to users in the portal. To access user settings and user profile information, use the methods in the com.plumtree.remote.util package.
To create a document in the portal Knowledge Directory, see Knowledge Directory Operations : Creating Documents. The documents displayed in the Knowledge Directory are not stored in the portal; the portal database contains only the file properties, including a link to the source file.
To edit the properties for an existing document in the portal Knowledge Directory, see Knowledge Directory Operations : Editing Document Properties. As noted above, you can only modify the file properties stored in the portal using the PRC.
The first step in any implementation of the PRC is initiating a session.