The People Connections service provides social networking tools for use in enhancing connection and communication within a project team and throughout an enterprise. It does this through a set of features that include:
Activity Stream for viewing user activities generated through application or social networking actions.
Connections for connecting to other application users to share information, comment on performance, exchange messages, and track activity
Feedback for giving ad hoc performance feedback to other users
Message Board for posting messages to other users
Profile for entering personal contact information and viewing the contact information of other users
Publisher for publishing status messages and posting files and links
This chapter explains how to integrate the People Connections service with a WebCenter Portal application and provides information about the REST APIs available for use in connecting to the People Connections service from outside the application framework.
This chapter includes the following sections:
Section 35.1, "Introduction to the People Connections Service"
Section 35.2, "Basic Configuration for the People Connections Service"
Section 35.3, "Advanced Information for the People Connections Service"
Section 35.5, "Troubleshooting the People Connections Service"
The People Connections service provides social networking tools for creating, interacting with, and tracking the activities of one's connections. Its features enable users to manage their personal profiles, access the profiles of other users, provide ad hoc feedback, post messages, track activities, and connect with others.
In a production environment, an enterprise can leverage its back-end identity store as a means of providing People Connections with a population of potential connections. In a development environment, developers can add test-users to the jazn-data.xml
file.
See Also:
For information about connecting to a back-end (LDAP) identity store for the production version of your application, see the chapter, "Managing Security," in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter. For information about creating test users injazn-data.xml
, see Section 23.2.2, "How to Define Roles and Grant Privileges in the jazn-data.xml File."This section provides an overview of the People Connections service. It includes the following subsections:
Section 35.1.1, "Understanding the People Connections Service"
Section 35.1.2, "Requirements for the People Connections Service"
The features of the People Connections service fall into five categories. Each category includes a set of task flows that expose People Connections features to your end users. The section introduces these categories. It includes the following subsections:
See Also:
For information about the People Connections service at runtime, see Part VIII, "Organizing Your Collaborative and Social Networking Environment," in the Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces.For information about People Connections task flows, see Section 35.1.1, "Understanding the People Connections Service."
The Activity Stream feature tracks the application activities of a user's connections. Table 35-1 lists the types of activities that may be tracked by the Activity Stream.
Table 35-1 Activities Tracked by Activity Stream
Service | Tracked Activities |
---|---|
Announcements |
|
Blogs |
|
Connections |
|
Discussions |
|
Documents |
|
Events |
|
Feedback |
|
Lists |
|
Message Board |
|
Pages |
The following activities are tracked when they are performed within the service framework scope (for example, if a user creates pages under
|
Profiles |
|
Tagging |
|
Activity Stream compares somewhat to the Recent Activities service, which also tracks and reports on application activities (for more information, see Section 45, "Integrating the Recent Activities Service"). Both track the application activities of integrated services, though Activity Stream tracks a broader range of services. For example, Recent Activities tracks the Documents (including wikis and blogs), Announcements, Discussions, and Page services. Activity Stream tracks these services as well as People Connections. Recent Activities tracks activities no matter who performs the action. Activity Stream tracks activities performed by a user's connections and includes information about who performed the activity. Recent Activities does not include names.
The basic difference between these two services can be summarized as follows: Recent Activities provides an overview of what is happening in an application. Activity Stream provides an overview of what is happening with a user's connections.
The Publisher task flow works in concert with Activity Stream to provide content in the form of user messages. Such messages may include attachments, such as a file or a link. A message posted through the Publisher task flow is published to the Activity Streams of the user who entered it and that user's connections.
Two Activity Stream task flows are available through the Resource Palette:
Activity Stream—Provides users with the main view of the most recent activities of their connections (Figure 35-1).
Activity Stream - Quick View—Provides users with a truncated view of streamed activities, where only the most recent of their connections' activities are shown. Users who want to see all activities can click a More link to navigate to the main view (Activity Stream) of the task flow (Figure 35-2).
Figure 35-2 Activity Stream - Quick View Task Flow
See Also:
For information about Activity Stream task flows at runtime, see the section, "Working with Activity Stream Task Flows," in the Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces.Connections provides users with a means of managing their own connections and viewing the connections of others. Use Connections to collect business friends and contacts into one or more smaller social groups. Use connections lists to manage the display of your connections.
Three Connections task flows are available through the Resource Palette:
Connections—Provides users with a means of viewing and managing their connections, creating connections lists, and sending and responding to invitations to connect (Figure 35-3).
Connections - Card—Provides a choice of the following views:
vcard
displays a connection's photo, job title, and status message.
iconic
displays a connection's photo and user name.
list
displays connections in a list, with each list row showing the profile photo, user name, job title, and an Add to List button.
tiled
renders the connection's personal Profile photo and shows the user name and job title beside the photo.
Tip:
In all views, the name links to a summary view of the user's Profile.Select one of these views through task flow bindings (for more information, see Section 35.3.2, "Customizing People Connections Task Flows Using Task Flow Binding Parameters") (Figure 35-4).
Connections - Quick View—Provides users with a view of their connections' uploaded profile photos and a link to a summary view of their Profiles (Figure 35-5).
Figure 35-5 Connections - Quick View Task Flow
See Also:
For information about Connections task flows at runtime, see the section, "Setting Up Your Social Network," in the Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces.Feedback provides users with a means of viewing, posting, and managing feedback. By default, users can view feedback in their own Feedback views. Users can view and post feedback in other users' Feedback views.
Two Feedback task flows are available through the Resource Palette:
Feedback—Provides users with the main view of the Feedback task flow. The main view contains controls for viewing, posting, sorting, and filtering Feedback—both given and received—and for hiding received Feedback (Figure 35-6).
Feedback - Quick View—Provides users with a truncated view of the Feedback task flow, where only the most recent posts are shown. When there are more posts than can be displayed in the initial view, users can click a More link to navigate to the main view of the Feedback task flow. When user A
accesses user B
's view of Feedback - Quick View, user A
additionally sees an Add Feedback option (Figure 35-7).
Figure 35-7 Feedback - Quick View Task Flow
See Also:
For information about Feedback task flows at runtime, see the section, "Working with Feedback Task Flows," in the Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces.Message Board provides a means of viewing and posting messages and attachments to Message Boards and Activity Streams.
Two Message Board task flows are available through the Resource Palette:
Message Board—Message Board provides users with the main view of Message Board messages and a means of adding, viewing, updating, hiding, deleting, and managing your view of messages, and for marking messages as private and sharing private messages (Figure 35-8).
Message Board - Quick View—Provides users with a truncated view of Message Board messages and a means of adding, viewing, updating, hiding, and deleting messages, and for marking messages as private and sharing private messages. Users can click a More link to navigate to the Detailed View (Figure 35-9).
Figure 35-9 Message Board - Quick View Task Flow
See Also:
For information about Message Board task flows at runtime, see the section, "Working with Message Board Task Flows" in the Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces.Profile provides users with a variety of views into their own and other users' personal profile information. Such information can include a user's email address, phone number, office location, department, manager, direct reports, and so on. Profile takes the bulk of its information from the back-end identity store that provides your WebCenter application with its users. Additionally, Profile may offer opportunities for altering some of this information and for providing additional data not included in the identity store.
Three Profile task flow are available through the Resource Palette:
Profile—Exposes a user's profile details, such as a user's email address, phone number, office location, department, manager, direct reports, and so on. It also exposes any personal image a user may have provided and the user's personal status message (Figure 35-10).
Profile - Snapshot—Exposes any personal image a user may have uploaded and provides a means of publishing messages, files, and links to a selected audience (Figure 35-11).
Note:
To enable users to upload anything to your ADF-based application at runtime, the page on which you have placed the upload task flow must have theusesUpload
attribute set on the form. Additionally, for profile images, you must set the task flow binding parameter photoUploadAllowed
to true
. For more information, see the Note at the end of Section 35.2.2, "How to Add People Connections Task Flows to a Page," and see Section 35.3.2.2, "People Connections Task Flow Binding Parameters."Profile Gallery—Provides a summary view of each People Connections task flow. For example, it includes Activity Stream - Quick View, Connections - Quick View, and so on (Figure 35-12).
See Also:
For information about Profile task flows at runtime, see the section, "Viewing and Editing Personal Profiles" in the Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces.The Publisher task flow works in concert with Activity Stream. Users enter content into Publisher, which is then published to the Activity Stream of the user who posted it as well as to the Activity Streams of that user's connections (Figure 35-13).
See Also:
For information about the Publisher task flow at runtime, see the section, "Sharing Items, Files, and URLs Through the Publisher Task Flow" in the Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces.For a successful integration of People Connections with your WebCenter Portal application, ensure that the following steps have been taken:
Create a WebCenter application (for more information, see Section 5.2, "Creating a WebCenter Portal Application and Adding Pages").
Set up the WebCenter schema, and create a database connection to it (for more information, see Chapter 7, "Preparing Your Application for Oracle WebCenter Services").
Create a JSF (.jspx
) page (for more information, see Section 5.2.2, "Adding Pages to the Portal").
Secure your application and create some test users (for more information, see Chapter 63, "Securing Your WebCenter Portal Application," and Section 23.2.2, "How to Define Roles and Grant Privileges in the jazn-data.xml File").
Drag and drop a People Connections task flow onto your page (for more information, see Section 35.2.2, "How to Add People Connections Task Flows to a Page").
Provide required values for task flow bindings (for more information, see Section 35.3.2.2, "People Connections Task Flow Binding Parameters").
Run the page.
When required, provide the user name and password of a test user you created at Step 4.
This section describes steps required for adding the People Connections service to your application. It includes the following subsections:
Section 35.2.1, "How to Set Up a Database Connection for the People Connections Service"
Section 35.2.2, "How to Add People Connections Task Flows to a Page"
Section 35.2.3, "Setting Security for the People Connections Service"
For information about setting up a database connection in support of Oracle WebCenter Services, see Section 7.2.2, "Setting Up a Database Connection."
The section describes how to add a People Connections task flow to an application page. The steps provided here are largely the same for all People Connections task flows. Differences are noted.
To add People Connections task flows to your WebCenter application:
Prepare your application as described in Section 35.1.2, "Requirements for the People Connections Service."
Open the page on which to add a People Connections task flow.
In the Resource Palette, open My Catalogs, then WebCenter Services Catalog, then the Task Flows folder.
Drag and drop a task flow (for example, Connections - Quick View) onto the JSF (.jspx
) page.
Select Region from the resulting context menu.
It may ask whether you want to add the People Connections library to the project. Confirm by clicking Add Library.
In the Edit Task Flow Binding dialog, specify parameter values for the task flow.
For example, for Connections - Quick View, the parameter userid
represents the name of the current user at runtime. You can specify an EL expression for the parameter that will evaluate to the currently logged-in user. For example, for userid
, enter #{securityContext.userName}
. For more information, see Section 35.3.2.2, "People Connections Task Flow Binding Parameters."
Click OK.
The task flow is added to the page, and the ViewController project's libraries are configured to run the task flow.
Save and run your page to the browser.
Note:
To enable users to upload anything to your ADF-based application at runtime, the page on which you have placed the task flow must have theusesUpload
attribute set on the form. For example, to enable the upload of a document to the document library or a photo to a profile, add the following to the relevant page:
<af:form usesUpload="true">
…
<af:region value="#{bindings.profile1.regionModel}"/>
…
</af:form>
Additionally, to enable the upload of a profile snapshot, the task flow binding parameter photoUploadAllowed
must be set to true
. For more information, see Section 35.3.2.2, "People Connections Task Flow Binding Parameters."
Because People Connections features are centered around users, application security must be set up for successful use of the service. Ideally, test users are also in place to enable you to interact in a meaningful way with each feature. Each feature in the People Connections service can be secured separately.
ADF security is configured by default when you create your application using the WebCenter Portal Application template. For details about how to implement a basic security solution for your WebCenter Portal application, see Section 63.3, "Configuring ADF Security."
To create test users, follow the steps outlined in Section 23.2.2, "How to Define Roles and Grant Privileges in the jazn-data.xml File."
Once you have added test users, you can add additional user attributes, such as business_email
, title
, or department
:
Open the jazn-data.xml
file.
Tip:
You will find thejazn-data.xml
file in the Application Resources panel in the META-INF folder under Descriptors.Select the tab for Source at the bottom of the main content area.
Inside the <user>
node for a selected user, insert the following:
<property name="[property-name]" value="[property-value]"/>
For example, to add business_email
as monty@domain.com
for the user monty
, add:
<user>
<name>monty</name>
<display-name>monty</display-name>
<credentials>{903}EfEepsY6I/TrKthpcmjJIsrlP36Ysr/j</credentials>
<property name="business_email" value="monty@domain.com"/>
</user>
This section describes advanced features available with the People Connections service. It includes the following subsections:
Section 35.3.1, "Establishing Site-Level Settings for People Connections Features"
Section 35.3.2, "Customizing People Connections Task Flows Using Task Flow Binding Parameters"
Section 35.3.4, "Using People Connections Service Java APIs"
Section 35.3.5, "Using the People Connections Service REST APIs"
See Also:
People Connections has a number of associated Expression Language Expressions (ELs) that you can use in place of constant values. For more information, see Appendix G, "Expression Language Expressions."Two scripts are available to configure and revise People Connections site-level settings:
RCUHOME/rcu/integration/webcenter/sql/oracle/settings-insert.sql
RCUHOME/rcu/integration/webcenter/sql/oracle/settings-update.sql
The variable RCUHOME
refers to your install location of the Resource Creation Utility (RCU). The RCU may be used in setting up the WebCenter schema and is packaged with the Oracle JDeveloper ship home. RCUHOME
is the root folder where the RCU is installed.
This section describes the scripts and provides information about the types of settings they control. It includes the following subsections:
Section 35.3.1.1, "Understanding the People Connections Site-Level Setting Scripts"
Section 35.3.1.2, "Supported Site-Level Settings for People Connections Features"
Section 35.3.1.3, "Example: Configuring Connections to Accept Invitations Automatically"
All site-level settings for People Connections features are stored in the WebCenter schema table WC_PPL_COMMON_SETTING
. Out-of-the-box, this table does not contain any setting values. In the absence of values, the application assumes default values. To change the value of any setting, the setting must first be inserted into this table and then updated with the desired value. Two SQL scripts enable you to perform these steps in their proper sequence.
This section describes how to prepare and run the People Connections site-level settings scripts. It includes the following subsections:
Section 35.3.1.1.1, "Preparing and Running settings-insert.sql"
Section 35.3.1.1.2, "Preparing and Running settings-update.sql"
Before you can change People Connections site-level settings, you must run the settings-insert.sql
script once. The script has INSERT
statements for all supported settings. All INSERT
statements are commented out by default. Before you run the script, you must prepare it by uncommenting all the settings you plan to change.
See Also:
For an example of thesettings-insert.sql
script in action, see Section 35.3.1.3, "Example: Configuring Connections to Accept Invitations Automatically."To prepare and run the settings-insert.sql
script:
Open the script in an editor.
For the settings you plan to change, uncomment the corresponding INSERT
statement.
Tip:
To uncomment anINSERT
statement, remove the leading double dash (--) on the lines the statement spans.Once you have uncommented all the INSERT
statements for the settings of interest, save and run the script.
The uncommented settings are populated with default values.
Note:
You can run thesettings-insert.sql
script only once for a given set of settings on a given schema. If you must run it more than once—for example, if you must update a different set of settings—then the previously uncommented INSERT
statements must be commented before you can run the script again. Otherwise, a SQL error is thrown during the re-execution of the INSERT
statement.To change People Connections site-level settings, you must run the settings-update.sql
script after you run settings-insert.sql
once. The settings-update.sql
script has UPDATE
statements for all supported settings. All UPDATE
statements are commented out by default.
You can run the settings-update.sql
script as many times as required for a given set of settings on a given schema, provided you have run settings-insert.sql
once for those settings.
See Also:
For an example of thesettings-update.sql
script in action, see Section 35.3.1.3, "Example: Configuring Connections to Accept Invitations Automatically."To prepare and run the settings-update.sql
script:
Open the script in an editor.
For the settings you plan to change, uncomment the corresponding UPDATE
statement.
Tip:
To uncomment anINSERT
statement, remove the leading double dash (--) on the lines the statement spans.For each uncommented statement, change the value of the SETTING_KEY
column to the desired value.
For information about settings and values, see Section 35.3.1.2, "Supported Site-Level Settings for People Connections Features."
Once you have revised all UPDATE
statements of interest, save and run the script.
The table WC_PPL_COMMON_SETTING
is updated with the revised values.
If your WebCenter Portal application is running, restart it for the changes to take effect.
This section lists and describes the supported site-level application settings for the People Connections service. It includes the following subsections:
Table 35-2 lists and describes the site-level settings for the People Connections service Activity Stream feature.
The service ID for Activity Stream is oracle.webcenter.activitystreaming
. For a list of service IDs, see Table 35-3.
Table 35-2 Site-Level Settings for Activity Stream
Setting Key | Description | Valid Site-Level Values |
---|---|---|
|
For determining who can view a user's Activity Stream |
|
|
For indicating whether individual users can override in their own application views the application-level setting for who can view their Activity Stream This setting is honored only when the application exposes the override control in a user preferences screen. |
|
|
For specifying the users for which to show personal space activities in a user's Activity Stream Users can override this setting on a task flow instance. |
|
|
For specifying the Spaces for which to show activities in a user's Activity Stream Users can override this setting on a task flow instance. |
|
|
For indicating whether to show activities published by the WebCenter service For example: servicePublishedSettings[oracle.webcenter.community] Users can override this setting on a task flow instance. |
|
Service | ID |
---|---|
Activity Graph |
oracle.webcenter.activitygraph |
Announcements |
oracle.webcenter.collab.announcement |
Discussions |
oracle.webcenter.collab.forum |
Documents and Wikis |
oracle.webcenter.doclib |
Events |
oracle.webcenter.collab.calendar.community |
Instant Messaging and Presence (IMP) |
oracle.webcenter.collab.rtc |
Links |
oracle.webcenter.relationship |
Lists |
oracle.webcenter.list |
|
oracle.webcenter.collab.mail |
Notifications |
oracle.webcenter.notification |
Page |
oracle.webcenter.page |
People Connections: Activity Stream |
oracle.webcenter.activitystreaming |
People Connections: Connections |
oracle.webcenter.peopleconnections.connections |
People Connections: Feedback |
oracle.webcenter.peopleconnections.kudos |
People Connections: Message Board |
oracle.webcenter.peopleconnections.wall |
People Connections: Profile |
oracle.webcenter.peopleconnections.profile |
Polls |
oracle.webcenter.collab.survey |
Recent Activities |
oracle.webcenter.recentactivity |
RSS |
oracle.webcenter.rss |
Search |
oracle.webcenter.search |
Tags |
oracle.webcenter.tagging |
Blogs |
oracle.webcenter.blog |
Worklist |
oracle.webcenter.worklist |
Table 35-4 lists and describes the site-level settings for the People Connections service Connections feature.
The service ID for Connections is oracle.webcenter.peopleconnections.connections
. For a list of service IDs, see Table 35-3.
Table 35-4 Site-Level Settings for Connections
Setting Key | Description | Valid Site-Level Values |
---|---|---|
|
For specifying that connection invitations are accepted automatically by default Individual users can override this application-level setting in their own view, provided the application exposes the override control in a user preferences screen. |
|
|
For specifying who can view a user's Connections |
|
|
For indicating whether individual users can override in their own application views the application-level setting for who can view their Connections This setting is honored only when the application exposes the override control in a user preferences screen. |
|
Table 35-5 lists and describes the site-level settings for the People Connections service Feedback feature.
The service ID for Feedback is oracle.webcenter.peopleconnections.kudos
. For a list of service IDs, see Table 35-3.
Table 35-5 Site-Level Settings for Feedback
Setting Key | Description | Valid Site-Level Values |
---|---|---|
|
For specifying who can view a user's received Feedback |
|
|
For indicating whether individual users can override in their own application views the application-level setting for who can view their received Feedback This setting is honored only when the application exposes the override control in a user preferences screen. |
|
|
For specifying who can give Feedback to a user |
|
|
For indicating whether individual users can override in their own application views the application-level setting for who can give them Feedback This setting is honored only when the application exposes the override control in a user preferences screen. |
|
|
For specifying the number of Feedback entries to show in a Feedback - Quick View task flow |
Positive integers |
|
For indicating whether individual users can override in their own application views the application-level setting for the number of entries to show in a Feedback - Quick View task flow This setting is honored only when the application exposes the override control in a user preferences screen. |
|
|
For indicating whether users are allowed to delete the Feedback they leave for other users |
|
Table 35-6 lists and describes the site-level settings for the People Connections service Message Board feature.
The service ID for Message Board is oracle.webcenter.peopleconnections.wall
. For a list of service IDs, see Table 35-6.
Table 35-6 Site-Level Settings For Message Board
Setting Key | Description | Valid Site-Level Values |
---|---|---|
|
For specifying who can view a user's Message Board |
|
|
For indicating whether individual users can override in their own application views the application-level setting for who can view their Message Board This setting is honored only when the application exposes the override control in a user preferences screen. |
|
|
For specifying who can post to a user's Message Board |
|
|
For indicating whether individual users can override in their own application views the application-level setting for who can post to their Message Board This setting is honored only when the application exposes the override control in a user preferences screen. |
|
|
For specifying the number of messages to show in a Message Board - Quick View task flow |
Positive integer |
|
For indicating whether individual users can override in their own application views the application-level setting for the number of messages to show in a Message Board - Quick View task flow This setting is honored only when the application exposes the override control in a user preferences screen. |
|
|
For indicating whether users are allowed to edit the messages they post on other users' Message Boards |
|
|
For indicating whether users are allowed to delete messages they post on other users' Message Boards |
|
Table 35-7 lists and describes the site-level settings for the People Connections service Profile feature.
The service ID for Profile is oracle.webcenter.peopleconnections.profile
. For a list of service IDs, see Table 35-3.
Table 35-7 Site-Level Settings for Profile
Setting Key | Description | Valid Site-Level Values |
---|---|---|
|
For indicating whether profile updates, such as uploading a photo, updating personal status, changing profile attributes, should result in activities getting published in Activity Stream |
|
|
For specifying who can view a user's Profile Gallery |
|
|
For indicating whether individual users can override in their own views the application-level setting for who can view their Profile Gallery This setting is honored only when the application exposes the override control in a user preferences screen. |
|
|
For specifying who can view the Profile section identified by For example: general-profile-settings.view.name.personalInfo.access-control-level For more information, see Table 35-8, "Profile Section Names". |
Note: |
|
For indicating whether individual users can override in their own application views the application-level setting for who can view the Profile section identified by This setting is honored only when the application exposes the override control in a user preferences screen. For more information, see Table 35-8, "Profile Section Names". |
|
|
For indicating whether users are allowed to edit the Profile section identified by For example: general-profile-settings.view.name.personalInfo.allow-user-edit For more information, see Table 35-8, "Profile Section Names". |
|
|
For indicating whether users are allowed to update the field identified by For example: ootb-view-edit-settings.view.name.personalInfo.homePhone.allow-edit For more information, see Table 35-8, "Profile Section Names" and Table 35-9, "Profile Field Names". |
|
Table 35-8 Profile Section Names
Section Name | Description |
---|---|
|
Profile summary These details are discoverable in an application search. |
|
Employee detail |
|
Business contact information |
|
Personal information |
Table 35-9 Profile Field Names
Field Name | Description |
---|---|
|
Business email address |
|
User display name |
|
Office department |
|
Job title |
|
Business phone number |
|
Time zone |
|
User photo |
|
Personal status message |
|
About me |
|
Employee type |
|
Employee number |
|
User's preferred language |
|
Employee's organization |
|
Employee's expertise |
|
Fax number |
|
Mobile/cell phone number |
|
Page number |
|
Office address: street |
|
Office address: city |
|
Office address: state |
|
Office address: P.O. box |
|
Office address: ZIP/PIN/P.O. code |
|
Office address: country |
|
Home address |
|
Home phone number |
|
Date of birth |
|
Maiden name/surname before marriage |
|
Date of hire |
By default, when users send invitations to connect, recipients must explicitly accept them. Through site-level settings, the application administrator can configure the application to accept invitations automatically. This setting is identified by the key, autoAcceptInvitations
, and the service ID, oracle.webcenter.peopleconnections.connections
. To change the setting, the administrator performs the following steps:
Open the settings-insert.sql
script and uncomment the following lines:
-- INSERT INTO WC_PPL_COMMON_SETTING (ID, APPLICATION_ID, SCOPE_ID, SERVICE_ID, USER_ID, TASKFLOW_INST_ID, SETTING_KEY, SETTING_VALUE) -- VALUES ('768e5d1f-a73d-41b4-819d-74be081e1de1', 'webcenter', 'defaultScope', 'oracle.webcenter.peopleconnections.connections', 'SYSTEM', 'SITE', 'autoAcceptInvitations', '-') -- ;
After modification, the lines appear as follows:
INSERT INTO WC_PPL_COMMON_SETTING (ID, APPLICATION_ID, SCOPE_ID, SERVICE_ID, USER_ID, TASKFLOW_INST_ID, SETTING_KEY, SETTING_VALUE) VALUES ('768e5d1f-a73d-41b4-819d-74be081e1de1', 'webcenter', 'defaultScope', 'oracle.webcenter.peopleconnections.connections', 'SYSTEM', 'SITE', 'autoAcceptInvitations', '-') ;
Save and run the script.
Open the settings-update.sql
script and uncomment the following lines:
-- UPDATE WC_PPL_COMMON_SETTING SET SETTING_VALUE='-' -- WHERE APPLICATION_ID='webcenter' AND SCOPE_ID='defaultScope' AND USER_ID='SYSTEM' AND TASKFLOW_INST_ID='SITE' -- AND SERVICE_ID='oracle.webcenter.peopleconnections.connections' AND SETTING_KEY='autoAcceptInvitations' -- ;
After the modification, the lines appear as follows:
UPDATE WC_PPL_COMMON_SETTING SET SETTING_VALUE='-' WHERE APPLICATION_ID='webcenter' AND SCOPE_ID='defaultScope' AND USER_ID='SYSTEM' AND TASKFLOW_INST_ID='SITE' AND SERVICE_ID='oracle.webcenter.peopleconnections.connections' AND SETTING_KEY='autoAcceptInvitations' ;
Change the value of SETTING_VALUE
to a plus sign (+
).
After modification, the lines appear as follows:
UPDATE WC_PPL_COMMON_SETTING SET SETTING_VALUE='+' WHERE APPLICATION_ID='webcenter' AND SCOPE_ID='defaultScope' AND USER_ID='SYSTEM' AND TASKFLOW_INST_ID='SITE' AND SERVICE_ID='oracle.webcenter.peopleconnections.connections' AND SETTING_KEY='autoAcceptInvitations' ;
Save and run the script.
If your WebCenter Portal application is running, restart the application.
After you restart, the setting takes effect. In this example, when a user invites another user to connect, the connection is created automatically.
See Also:
For lists and descriptions of People Connections site-level settings, see Section 35.3.1.2, "Supported Site-Level Settings for People Connections Features."Each People Connections task flow has a set of required and optional task flow binding parameters. These provide a means of capturing information that is useful to the task flow's successful function. For example, all People Connections task flows provide a binding parameter for capturing the ID of the current runtime user. This value (typically #{securityContext.userName}
) enables the task flow to return People Connections data that is relevant to the current user.
In addition to providing required values for successful task flow rendering, you can use task flow binding parameters to customize the appearance and behavior of a task flow instance. For example, you can use parameter values to determine whether headers and footers are rendered, the number of rows and columns of information to show, whether to apply a filter to returned data, and the like.
You can provide task flow binding parameter values when you drag and drop a task flow onto an application page. Doing so opens the Task Flow Bindings dialog (for more information, see Section 35.2.2, "How to Add People Connections Task Flows to a Page"). You can also adjust task flow binding parameter values after you have placed a task flow on a page.
This section describes how to revise task flow parameter values at design time and provides a table that lists and describes the binding parameters associated with People Connections task flows. It includes the following sections:
Section 35.3.2.1, "How to Revise People Connections Task Flow Binding Parameters"
Section 35.3.2.2, "People Connections Task Flow Binding Parameters"
Section 35.3.2.3, "What You Should Know About the Activity Stream Advanced Query Option"
After you have added a task flow to a page, you may want to customize the instance by revising its binding parameter values. This section describes how to access the Edit Task Flow Binding dialog and change binding parameter values.
To access the Edit Task Flow Binding dialog:
Open the application page and set the view to bindings by clicking the Bindings tab at the bottom of the page.
Under Executables, double-click the task flow for which to revise task flow binding parameters (Figure 35-14) to open the Edit Task Flow Binding dialog (Figure 35-15).
Tip:
Task flow names under Executables differ from names in design view. For example, Message Board task flows are instead referred to as wall, and Feedback task flows are instead referred to as kudos.Figure 35-14 Bindings View of an Application Page
Figure 35-15 Edit Task Flow Binding Dialog
Revise binding parameter values (for more information, see Section 35.3.2.2, "People Connections Task Flow Binding Parameters").
Click OK to save your changes and exit the dialog.
Save and run your page to see the results.
Table 35-10 lists and describes task flow binding parameters applicable to the People Connections service.
Table 35-10 People Connections Service Task Flow Binding Parameters
Parameter | Description |
---|---|
A means of enforcing the follow logic when querying Activity Stream
This parameter (for Fusion application business objects) is used in conjunction with the This parameter is associated with the Activity Stream task flow. |
|
A means of using the object extension handler to process Fusion application business objects
When you enter This parameter is associated with the following task flows:
|
|
A comma separated list of objects for which to show activities Enter objects in the format This parameter is associated with the Activity Stream task flow. |
|
A means of enforcing a security check on a Fusion application business object
The security check is performed by the resource authorizer that is implemented by the Fusion application. If a user has no permission on a business object, the activities related to that business object are filtered out. This parameter is associated with the Activity Stream task flow. This parameter is associated with the following task flows:
|
|
A field for specifying a custom query to filter streamed items For more information, see Section 35.3.2.3, "What You Should Know About the Activity Stream Advanced Query Option." This parameter is associated with the Activity Stream task flow. |
|
The name of a connections list This parameter is associated with the task flow Connections - Card. |
|
The view to display by default Valid values include:
When users access the task flow instance, the view specified here is the first one they see. All selections, except This parameter is associated with the Connections task flow. |
|
The maximum number of connections to show in the task flow For example, enter The value entered for this parameter is honored only when values for This parameter is associated with the following task flows:
|
|
The number of columns to show in the task flow For example, in a Connections - Card task flow that shows six connections, a value of This parameter is associated with the following task flows:
|
|
The number of rows to show in the task flow For example, in a Connections - Card task flow that shows six connections and a value of See also This parameter is associated with the following task flows:
|
|
The default layout style for the task flow Enter one of the following:
In all layouts, the name links to a summary view of the user's Profile. This parameter is associated with the task flow Connections - Card. |
|
A means of showing or hiding the Remove action on the task flow Enter This parameter is associated with the task flow Connections - Card. |
|
The connections sort order Enter This parameter is associated with the task flow Connections - Card. |
|
The number of items to show in the task flow For example, enter This parameter appears in the component properties for the following task flows:
|
|
The number of characters to show for each feedback message Messages exceeding the specified value are truncated, and an ellipse (…) is appended to the end. This parameter is associated with the task flow Feedback - Quick View. |
|
A means of enabling an edit mode on a Profile task flow instance Enter This parameter is associated with the Profile task flow. |
|
A means of showing or omitting detailed information about the object in the current context (that is, in a popup or other contextual instrument)
When this parameter is true and the This parameter is associated with the Activity Stream task flow. |
|
A filter against task flow content For example, enter This parameter is associated with the task flow Connections - Card. |
|
The start date of a date range within which to show feedback messages Enter dates in the format See also This parameter is associated with the following task flows:
|
|
A means of hiding the actions normally associated with a Feedback or Message Board entry, such as Edit, Private, Hide, and Delete
This parameter appears in the component properties for the following task flows:
|
|
Specifies whether the Attach: File|Link option is shown or hidden
This parameter is associated with the Publisher task flow. |
|
A means of showing or hiding the Comments feature on streamed activities Enter This parameter is associated with the Activity Stream task flow |
|
A means of hiding the personalization option on the task flow instance This parameter is associated with the following task flows:
|
|
A means of showing or hiding the Publisher task flow's document uploader Enter This parameter is associated with the Publisher task flow. |
|
A means of showing or hiding the task flow footer The task flow footer contains the More link that appears at the bottom of a task flow when there are more items to show than can be accommodated in the current view. Hiding the footer hides the More link. Hiding the footer does not affect Previous and Next links that may also appear at the bottom of a task flow. Enter This parameter is associated with the following task flows:
|
|
A means of showing or hiding feedback given to a user Enter true to allow the rendering of given feedback. Enter false to prohibit it. This parameter is associated with the following task flows:
|
|
A means of showing or hiding the task flow header Enter This parameter is associated with the following task flows:
|
|
A means of allowing or omitting an inline preview of files attached to streamed activities Enter This parameter is associated with the Activity Stream task flow. |
|
A means of showing or hiding the Like link on a streamed activity Enter true to hide the Like link. Enter false to show it. This parameter is associated with the Activity Stream task flow |
|
A means of showing or hiding the message entry field and the upload file and URL controls (the Publisher)
This parameter is associated with the following task flows:
|
|
Specifies whether the Share something with option is shown or hidden
This parameter is associated with the Publisher task flow. |
|
Specifies the resource bundle class and message key for hint text Use the format This parameter is associated with the Publisher task flow. |
|
The display size of the profile photo Enter one of the following values:
This parameter is associated with the Profile - Snapshot task flow. |
|
A means of dedicating the task flow instance to updating the current user's Profile status message Enter This parameter is associated with the Publisher task flow. |
|
Specifies whether the text box remains active after a user clicks the Publish button
This parameter is associated with the Publisher task flow. |
|
The number of rows to show when the Connections task flow instance is set to list view This parameter is associated with the Connections task flow. |
|
The ID of an object to associate with a published message This parameter is associated with the Publisher task flow. |
|
The type of an object to associate with a published message This parameter is associated with the Publisher task flow. |
|
A means of showing or omitting organization breadcrumbs on a user profile that renders a management chain that is linked to each member up the chain Enter This parameter is associated with the Profile - Snapshot task flow. |
|
The number of items to stream in a given task flow instance This parameter is associated with the following task flows:
|
|
The form of pagination to use on a multipage stream
This parameter is associated with the Activity Stream task flow. |
|
A means of allowing a photo upload from the profile screen Enter This parameter is associated with the task flow Profile - Snapshot. |
|
A means of showing or omitting an Edit link on a Profile - Snapshot task flow Enter This parameter is associated with the Profile - Snapshot task flow. |
|
A means of launching a user Profile when the user name is clicked Enter This parameter is associated with the task flow Connections - Card |
|
A means of streaming activities only from user profiles
This parameter is associated with the Activity Stream task flow. |
|
ID of the user from whom to stream activity This parameter is associated with the Activity Steam - Quick View task flow. |
|
The current user ID Enter This parameter is associated with the following task flows:
|
|
The ID of the scope to which to publish This property value assists in generating a link for use in navigating to the published object. It is not necessary to provide a value, unless you plan to do so using an EL expression. For information about EL expressions, seeAppendix G, "Expression Language Expressions." This parameter is associated with the Publisher task flow. |
|
A means of enabling or disabling section-by-section edit capability on the task flow
This parameter is associated with the Profile task flow. |
|
A field for entering a comma-separated list of names of services from which to stream activities Use this parameter to limit the display of streamed activities to only those associated with the specified service or services. Enter one or more service IDs, for example: oracle.webcenter.collab.announcement, oracle.webcenter.collab.forum For a list of valid service ID, see Table G-7, "Service IDs". Note that all listed service IDs cannot be used because all services do not stream items to the Activity Stream. For example, the RSS service does not stream any activities. This parameter is associated with the Activity Stream task flow. |
|
The service ID of the service to which the object associated with a published message belongs For a list of service IDs, see Table G-7, "Service IDs". This parameter is associated with the Publisher task flow. |
|
The Space to which to publish messages If your application does not support Spaces, do not provide a value for this parameter. This parameter is associated with the following task flows:
|
|
A comma-separated list of names or GUIDs of Spaces from which to stream activities Use this parameter to limit the display of streamed activities to only those associated with the specified Space or Spaces. If your application does not support Spaces, do not provide a value for this parameter. This parameter is associated with the Activity Stream task flow. |
|
A boolean value representing whether a control is available on the task flow for updating a profile status message Enter either This parameter appears in the component properties for the Profile - Snapshot task flow. |
|
The end date of a date range within which to show feedback messages Enter dates in the format See also This parameter is associated with the following task flows:
|
|
A means of limiting the Publisher task flow to its document upload feature Enter #{true} to limit the Publisher task flow to be only a document uploader. Enter This parameter is associated with the Publisher task flow. |
|
The current user ID Enter This parameter is associated with the following task flows:
|
|
The name of the user to whom to publish messages This value is supplied by default. We recommend that you do not change the default value, This parameter is associated with the Publisher task flow. |
|
The user name of the person who provided the object the current user is sharing For example, John is sharing a document with everyone that Jane originally shared with him. In this case, Jane is the via user. This parameter is associated with the Publisher task flow. |
Use Advanced Query
to create filters against streamed activities in an Activity Stream task flow. Create filters for user names, service IDs, and object details, such as a document's display name. You can use SQL syntax for parameter values. Additionally you can place EL expressions within the SQL.
You can construct queries against specific database objects, which are represented by aliases that are prefixed to the inquiry. Table 35-11 lists and describes the types of database objects against which you can construct a query and provides their alias prefixes.
See Also:
In many cases, you can use EL expressions to obtain the value you require for the supported fields and columns listed in Table 35-11. For more information, see Appendix G, "Expression Language Expressions."Table 35-11 Supported Database Objects for Constructing a SQL WHERE Clause
Database Object | Alias Prefix | Supported Fields/Columns |
---|---|---|
ACTIVITY |
AE |
|
ACTIVITY (ACTOR) |
AD |
|
ACTIVITY (OBJECT) |
OD |
|
Table 35-12 Activity Type Names for Advanced Query
Service | Activity Type Name |
---|---|
Events |
|
Announcements |
|
Discussions |
|
Tags |
|
Lists |
|
Page |
|
Documents |
|
People Connections (Profile) |
|
People Connections (Message Board) |
|
People Connections (Connections) |
|
People Connections (Feedback) |
|
The SQL string that is passed as the advanced query parameter complies with SQL standards. That is, it supports SQL constructs, such as AND
, OR
, IN
, and the like. Note, however, that it does not support INSERT
, UPDATE
, DELETE
, SELECT
, JOIN
constructs. The syntax of the advanced query must contain only the WHERE
clause portion of a SQL query. Because SELECT
is not supported, the WHERE
clause cannot have nested queries or subqueries.
The Advanced Query
parameter also supports EL expressions, which can be embedded in the WHERE
clause or used to generate the whole WHERE
clause.
All the literals in the query must be escaped by prepending a backward slash (\), otherwise such characters generate syntax errors (see Table 35-13 for examples).
Note that the advanced query WHERE
clause is always AND
'ed to the internal query that is generated by Activity Stream based on the current user, Space membership, connection list, and the like. This is to prevent a user from viewing activities to which he or she does not have access.
Table 35-13 lists examples of advanced queries.
Table 35-13 Examples of Advanced Queries for Use with Activity Stream
Use Case | Query Syntax |
---|---|
Stream only document creation activities. |
|
Stream activities only from an object or current Space. |
|
Stream activities only about wikis created by the current user. |
|
Stream activities for documents and discussions, but only create activities or all activities for the current user. |
|
The People Connections service provides data controls that enables you to create your own visualization of the People Connections functionality. This section provides an overview of the following data controls and lists and describes their supported methods, attributes, and classes:
People Connections Management Data Control
Profile Data Control
This section includes the following subsections:
Add a data control to your project by right-clicking it in the Resource Palette and selecting Add to Project from the resulting context menu. Once added, you can browse the data control's methods and attributes by expanding it in the Data Controls panel in the Application Navigator.
Add a data control to an application page by dragging it onto the page from the Data Controls panel. Once placed, a context menu opens with options for selecting the type of component to which to bind the data, such as a button or a text box.
See Also:
For information about using data controls in a WebCenter Portal application, see Section 7.1.3, "Using WebCenter Data Controls."The People Connections Management Data Control provides methods for adding and managing connections and connections lists. The primary methods exposed include:
getNumberOfConnections(String userid, String connectionListName, String filterPattern)
inviteUserForConnection(String userid, String invitationMessage, Collection connectionListNames)
removeConnection(String userid, boolean fromListOnly, String listName)
searchUsers(String filterPattern, int startIndex, int fetchSize)
updateConnectionListsMembership(String member, Collection addListIds, Collection removeListIds)
The subsections in this section list and describe the methods associated with the People Connections Management Data Control.
A collection of details about connections lists, including the list ID, name, localized name, number of members, whether or not the list is modifiable, and member user IDs. Table 35-14 lists and describes the attributes associated with this method.
Table 35-14 Attributes of the Method connectionLists
Attribute | Description |
---|---|
|
The connections lists IDs |
|
The names of connections lists |
|
The localized names of connections lists |
|
The number of members on each named connections list |
|
Information about whether a named connections list can be modified |
|
The user IDs of members on each named connections list |
The number of connections contained in each connections group.
A collection of details about a received invitation to connect, including when the invitation was sent and received, the invitation's GUID, the invitation message, and the user IDs of the user who sent the invitation and who received it. Table 35-15 lists and describes the attributes associated with this method.
Table 35-15 Attributes of the Method receivedInvitations
Attribute | Description |
---|---|
|
The date the invitation was received according to the recipient's time stamp |
|
The date the inviation was sent according to the sender's time stamp. |
|
The GUID of the received invitation |
|
The invitation message |
|
The user ID of the person who received the invitation |
|
The user ID of the person who sent the invitation |
|
The date the invitation was sent according to the system time stamp |
A collection of details about a sent invitation to connect, including when the invitation was sent and received, the invitation's GUID, the invitation message, and the user IDs of the user who sent the invitation and who received it. lists and describes the attributes associated with this method. Table 35-16 lists and describes the attributes associated with this method.
Table 35-16 Attributes of the Method sentInvitations
Attribute | Description |
---|---|
|
The date the invitation was received according to the recipient's time stamp |
|
The date the inviation was sent according to the sender's time stamp |
|
The unique GUID of the received invitation |
|
The invitation message |
|
The user ID of the person who received the invitation |
|
The user ID of the person who sent the invitation |
|
The date the invitation was sent according to the system time stamp |
A method for accepting invitations to connect. Table 35-17 lists and describes the parameters associated with this method.
A method for adding identified users to a named connections list. Table 35-18 lists and describes the parameters associated with this method.
A method for creating a connections list. Table 35-19 lists and describes the parameters associated with this method.
A method for declining an invitation to connect. Table 35-20 lists and describes the parameters associated with this method.
Method for deleting a connections list. Table 35-21 lists and describes the parameters associated with this method.
Returns an object that represents a Connections List. This object provides details about a connections list acquired for the given connection list name. Table 35-22 lists and describes the parameters associated with this method. Table 35-23lists and describes the attributes associated with this method.
Table 35-22 Parameters of the Method getConnectionList
Parameter | Description |
---|---|
connectionListName |
The name of the connections list for which to return the following attributes (see Table 35-23):
|
Table 35-23 Attributes of the Method getConnectionList
Attribute | Description |
---|---|
|
The unique GUID of the connections list to return |
|
The name of the connections list to return |
|
The localized name of the connections list to return |
|
The number of members on the connections list to return |
|
An indicator of whether the returned connections list can be modified |
|
The user IDs of the members of a returned connections list |
Returns the Connection
object, which provides details about the connection, including the connection's user ID, the connections lists on which the connection is a member, and details from a connection's profile. Table 35-24 lists and describes the parameters associated with this method. Table 35-25 lists and describes the attributes associated with this method.
Table 35-24 Parameters of the Method getConnections
Parameter | Description |
---|---|
|
The user ID for each returned connection |
|
The name of the connection list from which to obtain connections |
|
A filter to use against returned connections, such as "co," which returns |
|
The order by which to sort connections Enter |
|
The point from which to start fetching results This is used for pagination. For example, the search can return 50 matching records, and only 10 are needed, starting from 1. Set |
|
The number of results to return (see |
Returns the number of users (int
) connected to the identified user. Table 35-26 lists and describes the parameters associated with this method.
Table 35-26 Parameters of the Method getNumberOfConnections
Parameter | Description |
---|---|
|
The user ID for whom to return the number of connections |
|
The name of the connection list from which to obtain a count |
|
A filter to use against returned connections, such as "co," which returns |
Specifies that the invitation with the specified ID should be ignored. Table 35-28 lists and describes the parameters associated with this method.
A means of inviting the user with the specified user ID to connect. Includes the invitation message, such as, "I would like you to be my connection." Also includes one or more connection list names to which to add the invitee once the invitation is accepted. Table 35-29 lists and describes the parameters associated with this method.
Returns true or false (boolean
) as to whether the named connections list can be modified. Table 35-30 lists and describes the parameters associated with this method. Table 35-31 lists and describes the attributes associated with this method.
Returns true or false (boolean) as to whether the identified user is a member of a connections list that cannot be modified. Table 35-32 lists and describes the parameters associated with this method.
A method for removing the identified connection either as a connection or from a connections list. Table 35-33 lists and describes the parameters associated with this method.
Table 35-33 Parameters of the Method removeConnection
Parameter | Description |
---|---|
|
The user name of the connection to remove from the specified list |
|
A flag (true or false) indicating whether to remove the user as a connection or remove the user only from the specified connections list |
|
The name of the connections list from which to remove the specified user |
Returns the object Users
, which is a collection of details about returned users, including the user's relational attributes, GUID, and profile details. Table 35-34 lists and describes the parameters associated with this method. Table 35-35 lists and describes the attributes associated with this method.
Table 35-34 Parameters of the Method searchUsers
Parameter | Description |
---|---|
|
A filter to use against returned search terms, such as "co," which returns |
|
The point from which to start fetching results This is used for pagination. For example, the search can return 50 matching records, and only 10 are needed, starting from 1. Set |
|
The number of results to return (see |
Provides a means of updating an identified connection's list membership by adding the connection to identified connections lists and removing the connection from identified connections lists. Table 35-36 lists and describes the parameters associated with this method.
Table 35-36 Parameters of the updateConnectionListsMembership Method
Parameter | Description |
---|---|
|
The user name of the member whose connections list membership to manage |
|
The names of the connections lists to which to add the identified user |
|
The names of the connections lists from which to remove the identified user |
The Profile Data Control provides methods for returning and updating Profile details.
The subsections in this section list and describe the methods associated with the Profile Data Control.
A method for returning the WCUserProfile
object, which is a collection of user Profile details. Table 35-37 lists and describes the parameters associated with this method.
Table 35-37 Parameters for the getProfile Method
Parameter | Description |
---|---|
|
The ID of the user for whom to return Profile details |
Tip:
To see the attributes associated with theWCUserProfile
object, expand the WCUserProfile
node under the getProfile
method on the Data Controls panel in the Application Navigator.A method for updating the WCUserProfile
object, which is a collection of user Profile details. Table 35-38 lists and describes the parameters associated with this method.
The People Connections service has associated Java APIs that you can use to work with service features. Look in Oracle Fusion Middleware Java API Reference for Oracle WebCenter for details about the following packages:
oracle.webcenter.peopleconnections.connections
oracle.webcenter.peopleconnections.wall
oracle.webcenter.activitystreaming
Oracle WebCenter provides REST APIs to support the People Connections service. You can use the People Connections service REST APIs to perform the following actions:
View a stream of your connections' activities in an activity stream
Browse a profile or connections list
Update profile status messages
Create and delete connection lists
Add and remove members from connection lists
Create, read, and delete messages
Read and delete feedback
See Also:
REST APIs are not configured to work out of the box. Before you can use REST APIs, you must take the configuration steps outlined in the following section: Chapter 51, "Before You Begin: Performing Required Configurations."This section describes the REST APIs associated with the People Connections service. It includes the following subsections:
See Also:
For an introduction to the REST APIs, see Chapter 51, "Using Oracle WebCenter REST APIs."Use the Activity Stream REST APIs to browse user application activities in an activity stream. This section provides information about the REST APIs to use to perform this action. It includes the following subsections:
Section 35.3.5.1.2, "Activity Stream Resource Type Taxonomy"
Section 35.3.5.1.3, "Activity Stream Security Considerations"
Note:
Because REST APIs can be configured in many different ways, it's possible that not all of a user's activities will be returned. Not all settings that are configured in a WebCenter Portal application user interface will carry over to the REST APIs.Each REST service has a link element within the Resource Index that provides the entry point for that service. For the People Connections service, each feature has its own link element. For example, to find the entry point for the Activity Stream feature of the People Connections service, find the link elements with a resourceType
of:
urn:oracle:webcenter:activities:stream
The corresponding href
or template
element provides the URI entry point, which retrieves application activities for the current user from the Activity Stream. The client sends HTTP requests to this entry point to work with the Activity Stream feature of the People Connections service.
See Also:
For more information about the Resource Index, see Section 51.6.1, "The Resource Index."For more information about resource types, see Section 51.6.2.1, "Resource Type."
When the client has identified the entry point, it can then navigate through the resource type taxonomy to perform the required operations. For more information about the individual resource types, see the appropriate section in Section 35.3.5.1.4, "Activity Stream Resource Types."
The resource type taxonomy for the Activity Stream feature of the People Connections service is:
urn:oracle:webcenter:activities:stream urn:oracle:webcenter:activities:activity
You must be logged in to the REST service to access any of the People Connections REST APIs. After that, the underlying service handles permission checking and the like.
See Also:
For general security considerations, see Section 51.9, "Security Considerations for WebCenter REST APIs."This section provides you with all the information you need to know about each resource type. It includes the following subsections:
urn:oracle:webcenter:activities:stream
The stream
response contains URIs for use in retrieving activities from the Activity Stream.
You can retrieve the activities from a user's stream or activities from a user's connections' streams. To have even greater control over which activities to retrieve, use the activity stream query filter. With the query filter, you can:
Specify the user to query
Include the user's connections' activities in the results
Include activities from group spaces and/or personal spaces in the results
Restrict the results to activities from specific services
The options available to you depend on the path you take to get to the stream
resource and the rel
of the link that you use. For example, the activity stream query filter is available only from links with a rel
attribute of urn:oracle:webcenter:activities:stream
. If you access the activity stream query filter from the person
resource, the personGuid
parameter is prefilled.
Table 35-39 shows the activities returned depending on the rel
element of the link.
Table 35-39 Activities Returned by stream
rel | Returns |
---|---|
|
Activities from the user's stream ( |
|
Activities from the user's connections' streams ( |
|
Activities determined by the activity stream query filter |
|
Activities from the group space's activity stream |
|
Activities from the group space's activity list |
Footnote 1 GUID
can be any valid user GUID or @me
.
This section shows how the client can navigate through the hypermedia to access this resource:
resourceIndex stream (rel="urn:oracle:webcenter:activities:stream:person" or "urn:oracle:webcenter:activities:stream")
resourceIndex person stream (rel="urn:oracle:webcenter:activities:stream:person" or "urn:oracle:webcenter:activities:stream:connections" or "urn:oracle:webcenter:activities:stream")
resourceIndex person list stream
resourceIndex space stream
stream activity param stream (rel="urn:oracle:webcenter:activities:stream:space")
personReference stream
The following method is supported by the stream
resource:
GET
request—Parameters:
startIndex
, itemsPerPage
See Also:
For information about REST API parameters, such asstartIndex
and itemsPerPage
, see "Common Request Query Parameters".The following additional parameters are available for the query filter URI:
data
– Returns specified data only (for more information, see "Common Request Query Parameters"). For the stream resource, if you specify the constant 'data'
as the data parameter, all of the basic information about the resource is returned except "comments" and "likes" summaries. If you want to return comments or likes, specify the data
parameter value 'commentsSummary'
or 'likesSummary'
.
Note:
You can specify multiple data values as a comma separated list. For example,data=commentsSummary, likesSummary
.personGuid
—(Required) Retrieves activities from the stream for the specified user. Valid values: any valid user GUID or @me
.
serviceIds
—Retrieves activities only for the specified services. Valid values: An asterisk (*) returns all services. If null or empty, uses the user preference settings for service filters (from the settings link in the top bar).
personal
—Includes activities from the specified user's personal space. Valid values: true
or false
. Default value: false
.
connections
—Includes activities from the streams of the specified user's connections. Valid values: true
or false
. Default value: false
.
groupSpaces
—Includes activities from all group spaces of which the specified user is a member. Valid values: true
or false
. Default value: false
.
connectionListIds
– A comma separated list of connection list names that specifies for which connection lists to show activities.
groupSpaceGuids
– A comma separated list of group space GUIDs for which to show activities.
userGroupSpaceActivities
– Specifies whether or not to show the user's activities in their group spaces. Valid values: true
or false
. Default value: false
.
followedObjects
– Specifies whether or not to show all activities for followed objects that both the current user and the specified user follow. Valid values: true
or false
. Default value: false
.
followedObjectsUserActivities
– Specifies whether or not to show the specified user's activities for followed objects that both the current user and the specified user follow. Valid values: true
or false
. Default value: false
.
For example, the following URI returns activities from the current user's activity stream, for all services. It returns activities from the user's personal space and from the streams of the user's connections:
http://host:port/rest/api/activites?personal=true&connections=true&personGuid=@me&token=token
The following URI returns only the user's personal profile and connections activities:
http://host:port/rest/api/activities?serviceIds=oracle.webcenter.peopleconn ections.profile,oracle.webcenter.peopleconnections.connections&personal= true&personGuid=@me&token=token
response—Body: 0 or more activities
Note:
Because thestream
resource includes activity items, the response may also return resource links from the activity type.Resource Types Linked to From stream
Table 35-40 lists the resource types that the client can link to from the stream
resource.
Table 35-40 Related Resource Types for stream
rel | resourceType |
---|---|
self urn:oracle:webcenter:activities:stream:person |
urn:oracle:webcenter:activities:stream |
urn:oracle:webcenter:activities:activity
The activity
response contains the data for activities and URIs for use in retrieving all the data you need from an activity that is included in an Activity Stream.
This section shows how the client can navigate through the hypermedia to access the activity
resource:
resourceIndex stream activity
resourceIndex person stream activity
resourceIndex space stream activity
Supported Methods for activity
No methods are supported for activity
. Activities are currently available only from the stream
resource type.
Read-only Elements for activity
Table 35-41 lists the read-only elements for the activity
resource.
Note:
The activity will also return a link to an activity icon in the links section of the response, if an icon is available. See urn:oracle:webcenter:activities:activity:icon.Table 35-41 Read-Only Elements for activity
Element | Type | Description |
---|---|---|
|
String |
Activity type Unique within the service. For example the Discussions service can return the |
|
String |
If you specify |
|
Date (String)Foot 1 |
Date the activity was created |
|
String |
The description of the activity |
|
String |
Detail information for the activity For example, this might return the contents of a message, the file name of a document, and the like. Similar to |
|
String |
Detail information for the activity Similar to |
|
String |
A pre-formatted, internationalized description. |
|
String |
A pre-formatted, internationalized message (does not include template information). |
|
Information about the group space in which the activity was performed Note: This reference is not present for activities that did not happen in a group space (for example, activities that happened in a personal space). Also, creation of a group space happens in a personal space, so that activity does not have this element either. |
|
|
String |
Unique ID of the message |
|
true or false |
Indicates whether or not this activity is a summary of other activities. |
|
String |
If you specify |
|
String |
Localized string for this activity This may contain replacement strings within curly braces ({}). |
|
PRIVATE SHARED PUBLIC |
Permission level of this activity |
|
String |
Scope of the activity This might return a group space, a personal space, and the like. For example, for a group space, it returns a string similar to the following: s8bba98ff_4cbb_40b8_beee_296c916a23ed |
|
String |
Unique ID of the service that created the activity Note: For a list of WebCenter service IDs, see Table 35-3, "Service IDs". |
|
Param |
String replacement parameters for users and objects referenced in the message of this activity. |
Footnote 1 Data types, such as DATE
and BOOLEAN
, are stored in the API as STRING
. The DATE
data type returns a Java standard date format, for example, 2009-08-21T14:43:11.0013-0700
, with 0700
representing the time zone.
Note:
The activity object can also contain the following link objects, if supported:commentsList
, commentSummary
, likesList
, and likesSummary
. These links return data about their respective objects. For instance, the commentsSummary
link returns the comments count and a list of recent comments.urn:oracle:webcenter:activities:activity:icon
Use this resource type to get the icon of the activity, if available (GET
).
Navigation Paths to activities:activity:icon
This section shows how the client can navigate through the hypermedia to access this resource:
resourceindex activities activity icon
The following methods are supported by this resource:
GET
– Returns the icon used for the named activity.
Resource Types Linked to from icon
Table 35-42 lists the resource types that the client can link to from this resource.
Use the Connections and Profile REST APIs to browse a profile or a connections list, manage connections lists, add or remove connections, send invitations to connect, and update a profile status message.
This section provides information about the REST APIs to use to perform these actions. It includes the following subsections:
Section 35.3.5.2.2, "Connections and Profile Resource Type Taxonomy"
Section 35.3.5.2.3, "Connections and Profile Security Considerations"
Section 35.3.5.2.4, "Connections and Profile Resource Types"
Each REST service has a link element within the Resource Index that provides the entry point for that service. For the People Connections service, each feature has its own link element. For example, to find the entry points for Connections and Profile features of the People Connections service, find the link elements with a resourceType
of:
urn:oracle:webcenter:people
(returns the current user profile)
urn:oracle:webcenter:people:person
(enables you to query for a user)
urn:oracle:webcenter:people:invitations
(returns invitations sent or received by the current user)
Note:
Thepeople:person
and people:invitations
resource types have a template
but not an href
.The corresponding href
or template
element provides the URI entry point, which returns a list of people (people
) or an individual user (people:person
). The client sends HTTP requests to this entry point to work with the Connections and Profile features of the People Connections service.
See Also:
For more information about the Resource Index, see Section 51.6.1, "The Resource Index."For more information about resource types, see Section 51.6.2.1, "Resource Type."
When the client has identified the entry point, it can then navigate through the resource type taxonomy to perform the required operations. For more information about the individual resource types, see the appropriate section in Section 35.3.5.2.4, "Connections and Profile Resource Types."
The resource type taxonomy for the Connections and Profile features in the People Connections service is:
urn:oracle:webcenter:people urn:oracle:webcenter:people:person urn:oracle:webcenter:people:icon urn:oracle:webcenter:people:person:list urn:oracle:webcenter:people:person:listNames urn:oracle:webcenter:people:person:listName urn:oracle:webcenter:people:person:list:member urn:oracle:webcenter:people:person:status urn:oracle:webcenter:people:invitations urn:oracle:webcenter:people:invitation
You must be logged in to the REST service to access any of the People Connections REST APIs. After that, the underlying service handles permission checking and the like.
See Also:
For general security considerations, see Section 51.9, "Security Considerations for WebCenter REST APIs."This section provides you with all the information you need to know about each resource type. It includes the following subsections:
The people
response contains URIs for use in retrieving the profile of one or more users.
This section shows how the client can navigate through the hypermedia to access the people
resource:
resourceIndex people
The following method is supported by the people
resource:
GET
request—Parameters:
startIndex
– See "Common Request Query Parameters."
itemsPerPage
– See "Common Request Query Parameters."
projection
– See "Common Request Query Parameters."
data
– A standard set that returns all the standard data for the response, but does not include status
, manager
, reportees
, or photos
. If both the projection
and data
query string parameters are present, the data
parameter will be used to determine which data to return. If you specify the constant 'data'
as the data
parameter, all the basic information will be returned for the resource.
The data
parameter can also take any of the following values comma-separated values to return the corresponding data: guid
, id
, displayName
, birthday
, language
, timeZone
, name
, addresses
, organizations
, workEmail
, phoneNumbers
, manager
, reportees
, photos
, and/or status
.
Note:
Thedata
parameter can also take a predefined set parameter like basic
. For example, if you specify data=basic
, it is the equivalent of specifying data=guid, id, displayName
. You can also specify additional parameters as needed. For example, you could specify data=basic,birthday
.links
– A standard set that returns all the standard links for the response, but does not include status
, manager
, reportees
, or photos
. For more information, see "Common Request Query Parameters". If both the projection
and links
query string parameters are present, the links
parameter will be used to determine which links to return. If you specify the constant 'links'
as the links
parameter, all the basic information will be returned for the resource.
The links parameter also takes zero or more of the following comma-separated parameter: person
, profile
, icon
, status
, messageBoard
, activities
, personActivities
, connectionActivities
, connections
, listNames
, invitation
, givenFeedback
, receivedFeedback
, userGivenFeedback
, manager
, reportees
, and/or member
.
Note:
Thelinks
parameter can also take a predefined set parameter like basic
. For example, if you specify data=basic
, it is the equivalent of specifying data=guid, id, displayName
. You can also specify additional parameters as needed. For example, you could specify data=basic,birthday
.basic
– A standard set that returns the basic information for the profile and includes guid
, id
, and displayName
.
response—Body: 1 or more person
The following links are is supported by the people
resource. Note that links that are not currently available will not be returned even if they are specified in the links
parameter.
basic
– A standard set that returns the basic information for the profile and includes person
, profile
, and icon
.
data
– A standard set that returns all the basic links for the response plus the connections list, status, and activity stream template.
activitiesSet
– Includes activities
, personActivities
, and connectionActivities
.
connectionsSet
– Includes connections
, listNames
, and invitation
.
feedbackSet
– Includes givenFeedback
, receivedFeedback
, and userGivenFeedback
.
person
, profile
, icon
, status
, messageBoard
, activities
, personActivities
, connectionActivities
, connections
, listNames
, invitation
, givenFeedback
, receivedFeedback
, userGivenFeedback
, manager
, reportees
, member
Resource Types Linked to from people
Table 35-43 lists the resource types that the client can link to from the people
resource.
urn:oracle:webcenter:people:icon
Use this resource type to get the icon used for the named profile (GET
).
Navigation Paths to space:icon
This section shows how the client can navigate through the hypermedia to access this resource:
resourceindex people icon
The following methods are supported by this resource:
GET
– Returns the icon used for the named profile.
Note:
This resource includes a template that lets you choose the size of the profile icon to use. Thesize
template parameter can be set to small
, medium
, or large
.Resource Types Linked to from icon
Table 35-44 lists the resource types that the client can link to from this resource.
Table 35-44 Related Resource Types for urn:oracle:webcenter:spaces:roles
rel | resourceType |
---|---|
self |
|
urn:oracle:webcenter:parent |
urn:oracle:webcenter:people:person
The person
response contains profile data and the URIs for use in retrieving a user profile.
This section shows how the client can navigate through the hypermedia to access the person
resource:
resourceIndex people
resourceIndex people person
resourceIndex person
author person
resourceIndex activities:stream person
The following method is supported by the person
resource:
GET
request—Parameters: q
To retrieve a specified person, the format of q
is:
q=[loginid:equals:username] Or q=[guid:equals:guid] Or q=[email:equals:email]
Note:
The parameterq
is only on the resourceIndex
template for person
.response—Body: message
Table 35-45 lists the read-only elements for the person
resource.
Note:
The elements present in aperson
response depend on how the user repository is configured and the elements it supports. Additionally, several of the pieces of data represented in Table 35-45, such as address
, emails
, photos
, phoneNumbers
, and organization
, can have multiple instances.Table 35-45 Read-Only Elements for person
Element | Type | Description | Projection |
---|---|---|---|
|
String |
Unique GUID of the person |
Summary, Detailed |
|
String |
Unique login ID of the person (that is, the user name, for example, pat_coi) |
Summary, Detailed |
|
String |
Display name of the person (the user's name, for example, Pat Coi). This may have the same value as |
Summary, Detailed |
|
Date (String)Foot 1 |
Birth date of the person |
Summary, Detailed |
|
Boolean (String)Footref 1 |
Whether or not this person is connected to the current user |
Detailed |
|
String |
Preferred language of the person |
Summary, Detailed |
|
String |
Time zone of the person |
Summary, Detailed |
|
|
Name information for the person
|
Summary, Detailed |
|
|
Address information for the person address is a portable contact type. For more information, see Section 51.11.2.2, "address Portable Contact Type." |
Summary, Detailed |
|
|
Emails for the person
|
Summary, Detailed |
|
|
Profile photos for the person
|
Summary, Detailed |
|
|
Phone numbers for the person
|
Summary, Detailed |
|
|
Organization information for the person organization is a portable contact type. For more information, see Section 51.11.2.3, "organization Portable Contact Type." |
Summary, Detailed |
|
Manager of this person |
Summary, Detailed |
|
|
Direct reports of this person |
Summary, Detailed |
|
|
Person's profile status message |
Detailed |
Footnote 1 Data types, such as DATE
and BOOLEAN
, are stored in the API as STRING
.
Resource Types Linked to from person
Table 35-46 lists the resource types that the client can link to from the person
resource.
Table 35-46 Related Resource Types for person
rel | resourceType |
---|---|
self |
urn:oracle:webcenter:people:person |
alternate |
urn:oracle:webcenter:spaces:profile (HTML) |
urn:oracle:webcenter:people:person:list:connections |
|
urn:oracle:webcenter:activities:stream:person |
|
urn:oracle:webcenter:activities:stream:connections |
|
urn:oracle:webcenter:activities:stream |
|
urn:oracle:webcenter:feedback:all-given |
|
urn:oracle:webcenter:feedback:all-received |
urn:oracle:webcenter:people:person:list
The list
response contains URIs for use in retrieving all the profiles on a connections list (GET
), inviting a user to be a connection or adding a connection to a connections list (POST
), and removing a connections list (DELETE
).
This section shows how the client can navigate through the hypermedia to access the list
resource:
resourceIndex person listNames list
resourceIndex person list (rel="urn:oracle:webcenter:people:person:list:connections")
The following methods are supported by the list
resource:
GET
request—Parameters: startIndex
, itemsPerPage
, projection
See Also:
For information about REST API parameters, such asstartIndex
and itemsPerPage
, see "Common Request Query Parameters".response—Body: 0 or more listName
items
POST
request—Body: member
response—Body: member
See Also:
For information aboutmember
in the request and response elements, see "urn:oracle:webcenter:people:person:list:member".DELETE
request
Resource Types Linked to from list
Table 35-47 lists the resource types that the client can link to from the list
resource.
Table 35-47 Related Resource Types for list
rel | resourceType |
---|---|
self urn:oracle:webcenter:people:person:listFoot 1 |
urn:oracle:webcenter:people:person:list |
urn:oracle:webcenter:activities:stream |
Footnote 1 self
rel
currently includes "urn:oracle:webcenter:people:person:list:list
" instead of the correct "urn:oracle:webcenter:people:person:list
". For the @connections
default list, it currently includes "urn:oracle:webcenter:people:person:list:connections
".
urn:oracle:webcenter:people:person:listNames
The listNames
response contains URIs for use in retrieving the names of existing connections lists (GET
) and to creating connections lists (POST
).
This section shows how the client can navigate through the hypermedia to access the listNames
resource:
resourceIndex person listNames
Supported Methods for listNames
The following methods are supported by the listNames
resource:
GET
request
response: Body: 0 or more listName
items
Note:
@connections
is a user's default connections. It behaves like a connections list, but it is not included in the results of listNames
.POST
request—Body: listName
response—Body: listName
Resource Types Linked to from listNames
Table 35-48 lists the resource types that the client can link to from the listNames
resource.
urn:oracle:webcenter:people:person:listName
The listName
response contains the names of connections lists and URIs for use in accessing the connections lists.
This section shows how the client can navigate through the hypermedia to access the listName
resource:
resourceIndex person listNames listName
Writable Elements for listName
Table 35-49 lists the writable elements for the listName
resource.
Table 35-49 Writable Elements for listName
Element | Type | Required | Constraints | Description |
---|---|---|---|---|
|
String |
Yes |
1 or more characters |
A single list name |
Resource Types Linked to from listName
Table 35-50 lists the resource types that the client can link to from the listName
resource.
Table 35-50 Related Resource Types for listName
rel | resourceType |
---|---|
self urn:oracle:webcenter:people:person:list |
|
urn:oracle:webcenter:activities:stream:list |
urn:oracle:webcenter:people:person:list:member
The member
response contains URIs for use in deleting a connection from a connections list or removing a connection from the default connections list.
This section shows how the client can navigate through the hypermedia to access the member
resource:
resourceIndex person list member
The following method is supported by the member
resource:
DELETE
request
Table 35-51 lists the writable elements for the member
resource. Writable elements for member
are used when you add a connection to a list or invite a user to be a connection. The member
resource itself is for deleting connections, and does not use writable elements.
Table 35-51 Writable Elements for member
Element | Type | Required | Constraints | Description |
---|---|---|---|---|
|
String |
Yes |
1 or more characters |
GUID of the user |
|
String |
No |
0 or more characters |
Invitation message Use this only when inviting users to be connections (that is POSTing to the |
urn:oracle:webcenter:people:person:status
The status
response contains URIs for use in retrieving (GET
) and updating (PUT
) the profile status message of a specified user.
This section shows how the client can navigate through the hypermedia to access the status
resource:
resourceIndex people person status
The following methods are supported by the status
resource:
GET
request
response—Body: status
PUT
request—Body: status
response—Body: status
Table 35-52 lists the writable elements for the status
resource.
Table 35-52 Writable Elements for status
Element | Type | Required | Constraints | Description |
---|---|---|---|---|
|
String |
Yes |
1 or more characters |
Content of status message |
Resource Types Linked to from status
Table 35-53 lists the resource types that the client can link to from the status
resource.
Table 35-53 Related Resource Types for status
rel | resourceType |
---|---|
self |
urn:oracle:webcenter:people:person:status |
urn:oracle:webcenter:people:invitations
The invitations
response contains URIs for use in retrieving invitations (GET
). You can also send an invitation (POST
) to another user.
Navigation Paths to invitations
This section shows how the client can navigate through the hypermedia to access the invitations
resource:
resourceIndex invitations
If you are not already connected to a user, you can also navigate to the invitations resource from that user's profile in order to invite them to connect. This path is only used for POSTing.
resourceIndex person invitations
Supported Methods for invitations
The following methods are supported by the invitations
resource:
GET
Request—Parameters: q
To retrieve invitations sent to the current user, the format of q
is:
q=[invitee:equals:@me]
To retrieve invitations sent from the current user, the format of q
is:
q=[invitor:equals:@me]
Response—Body: 1 or more invitations
POST
Request—Body: invitation
Response—Body: invitation
Writable Elements for invitations
Table 35-54 lists the writable elements for the invitations
resource.
Table 35-54 Writable Elements for invitations
Element | Type | Required | Constraints | Description |
---|---|---|---|---|
|
String |
No |
1 or more characters |
Message attached to the invitation |
Resource Types Linked to from invitations
Table 35-55 lists the resource types that the client can link to from the invitations
resource:
urn:oracle:webcenter:people:invitation
The invitation
response contains URIs for use in deleting (DELETE
) invitations you have sent, or deleting (DELETE
) or updating (PUT
) invitations you have received.
Navigation Paths to invitation
This section shows how the client can navigate through the hypermedia to access the invitation
resource:
resourceIndex invitations invitation
Supported Methods for invitation
The following methods are supported by the invitation
resource:
PUT
Request—Body: invitation
Response—Body: invitation
DELETE
Request
Writable Elements for invitation
Table 35-56 lists the writable elements for the invitation
resource.
Table 35-56 Writable Elements for invitation
Element | Type | Required | Constraints | Description |
---|---|---|---|---|
|
String |
Yes (PUT) |
ACCEPTED IGNORED |
The status of the invitation. Note: When you accept or ignore an invitation, it is removed from your list of invitations. |
Read-only Elements for invitation
Table 35-57 lists the read-only elements for the invitation
resource.
Table 35-57 Read-only Elements for invitation
Element | Type | Description |
---|---|---|
|
String |
Unique ID of the invitation |
|
User to whom the invitation is sent |
|
|
User from whom the invitation is sent |
|
|
Date (String)Foot 1 |
Date the invitation was sent |
Footnote 1 Data types, such as DATE
and BOOLEAN
, are stored in the API as STRING
.
Resource Types Linked to from invitation
Table 35-58 lists the resource types that the client can link to from the invitation
response.
Use the Feedback REST APIs to read and delete feedback. This section provides information about the REST APIs to use to perform these actions. It includes the following subsections:
Each REST service has a link element within the Resource Index that provides the entry point for that service. For the People Connections service, each feature has its own link
element. To find the entry points for the Feedback feature of the People Connections service, find the link
elements with a resourceType
of:
urn:oracle:webcenter:feedback
The corresponding href
or template
element provides the URI entry point, which returns all received feedback for the current user. The client sends HTTP requests to this entry point to work with the Feedback feature of the People Connections service.
See Also:
For more information about the Resource Index, see Section 51.6.1, "The Resource Index."For more information about resource types, see Section 51.6.2.1, "Resource Type."
When the client has identified the entry point, it can then navigate through the resource type taxonomy to perform the required operations. For more information about the individual resource types, see the appropriate section in Section 35.3.5.3.4, "Feedback Resource Types."
the resource type taxonomy for the Feedback feature of the People Connections service is:
urn:oracle:webcenter:feedback urn:oracle:webcenter:feedback:message
You must be logged in to the REST service to access any of the People Connections REST APIs. After that, the underlying service handles permission checking and the like.
See Also:
For general security considerations, see Section 51.9, "Security Considerations for WebCenter REST APIs."This section provides you with all the information you need to know about each resource type. It includes the following subsections:
The feedback
response contains URIs for use in reading Feedback messages.
This section shows how the client can navigate through the hypermedia to access the feedback
resource:
resourceIndex feedback
resourceIndex person feedback
Supported Methods for feedback
The following methods are supported by the feedback
resource:
GET
request—Parameters: startIndex
, itemsPerPage
See Also:
For information about REST API parameters, such asstartIndex
and itemsPerPage
, see "Common Request Query Parameters".response—Body: message
Read-only Elements for feedback
Table 35-41 lists the read-only elements for the feedback
resource.
Table 35-59 Read-Only Elements for feedback
Element | Type | Description |
---|---|---|
|
A person reference to the user who received the feedback |
Resource Types Linked to from feedback
Table 35-60 lists the resource types that the client can link to from the feedback
resource.
Table 35-60 Related Resource Types for feedback
rel | resourceType |
---|---|
self urn:oracle:webcenter:feedback:all-received |
urn:oracle:webcenter:feedback |
self urn:oracle:webcenter:feedback:all-given |
urn:oracle:webcenter:feedback |
urn:oracle:webcenter:feedback:message
The message
response contains the feedback message data and URIs for use in deleting a Feedback message.
This section shows how the client can navigate through the hypermedia to access the message
resource:
resourceIndex feedback message
resourceIndex person feedback message
Supported Methods from message
The following method is supported by the message
resource:
DELETE
request
Read-only Elements for message
Table 35-61 lists the read-only elements for the message
resource.
Table 35-61 Read-only Elements for message
Element | Type | Description |
---|---|---|
|
String |
Message content |
|
String |
Unique ID of the message |
|
User who created the message |
|
|
Date (String)Foot 1 |
Date the message was created |
Footnote 1 Data types, such as DATE
and BOOLEAN
, are stored in the API as STRING
.
Resource Types Linked to from feedback
Table 35-60 lists the resource types that the client can link to from the feedback
resource.
Use the Message Board REST APIs to post, read, and delete messages to a user's or a group space's message board.
This section provides information about the REST APIs to use to perform these actions. It includes the following subsections:
Each REST service has a link
element within the Resource Index that provides the entry point for that service. For the People Connections service, each feature has its own link
element. To find the entry points for the Message Board feature of the People Connections service, find the link
elements with a resourceType
of:
urn:oracle:webcenter:messageBoard
Note:
As well as an entry point from the Resource Index, to navigate to an individual user's message board, the Message Board feature also has an entry point from a group space response for the group space's message board.The corresponding href
or template
element provides the URI entry point, which returns the Message Board for the current user. The client sends HTTP requests to this entry point to work with the Message Board feature of the People Connections service.
See Also:
For more information about the Resource Index, see Section 51.6.1, "The Resource Index."For more information about resource types, see Section 51.6.2.1, "Resource Type."
When the client has identified the entry point, it can then navigate through the resource type taxonomy to perform the required operations. For more information about the individual resource types, see the appropriate section in Section 35.3.5.4.4, "Message Board Resource Types."
The resource type taxonomy for the Message Board feature of the People Connections service is:
urn:oracle:webcenter:messageBoard urn:oracle:webcenter:messageBoard:message
You must be logged in to the REST service to access any of the People Connections REST APIs. After that, the underlying service handles permission checking and the like.
See Also:
For general security considerations, see Section 51.9, "Security Considerations for WebCenter REST APIs."This section provides you with all the information you need to know about each resource type. It includes the following subsections:
urn:oracle:webcenter:messageBoard
The messageBoard
response contains URIs for use in reading (GET
) and posting (POST
) group space and individual user Message Board messages.
Navigation Paths to messageBoard
This section shows how the client can navigate through the hypermedia to access the messageBoard
resource:
resourceIndex messageBoard
resourceIndex person messageBoard resourceIndex spaces space messageBoard
Supported Methods for messageBoard
The following methods are supported by the messageBoard
resource:
GET
request—Parameters: startIndex
, itemsPerPage
See Also:
For information about REST API parameters, such asstartIndex
and itemsPerPage
, see "Common Request Query Parameters".response—Body: message
Note:
The RESTGET
command for reading (retrieving) messages retrieves all shown messages. Messages that are hidden through the application user interface are not retrieved. For information about hiding and showing messages, see "Working with Message Board Task Flows," in the Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces.POST
request—Body: message
The POST for messages supports including a link URL in the message.
See Also:
For information about message, see "urn:oracle:webcenter:messageBoard:message".Read-only Elements for messageBoard
Table 35-66 lists the read-only elements for the messageBoard
resource.
Table 35-63 Read-only Elements for message
Element | Type | Description |
---|---|---|
|
String |
Contains link data if the message has a link. |
|
String |
Contains link data for messages with links: |
Resource Types Linked to from messageBoard
Table 35-64 lists the resource types that the client can link to from the messageBoard
resource.
Table 35-64 Related Resource Types for messageBoard
rel | resourceType |
---|---|
self |
urn:oracle:webcenter:messageBoard |
urn:oracle:webcenter:messageBoard:message
The message
response contains the Message Board message data and URIs for use in reading (GET
), revising (PUT
), and deleting (DELETE
) a group space or individual user Message Board message.
This section shows how the client can navigate through the hypermedia to access the message
resource:
resourceIndex messageBoard message
resourceIndex person messageBoard message resourceIndex spaces space messageBoard message
The following methods are supported by the message
resource:
GET
request
response—Body: message
PUT
request—Body: message
response—Body: message
DELETE
request
Table 35-65 lists the writable elements for the message
resource.
Table 35-65 Writable Elements for message
Element | Type | Required | Constraints | Description |
---|---|---|---|---|
|
String |
Yes |
1 or more characters |
message content |
Read-only Elements for message
Table 35-66 lists the read-only elements for the message
resource.
Table 35-66 Read-only Elements for message
Element | Type | Description |
---|---|---|
|
String |
Unique ID of the message |
|
User who created the message |
|
|
Date (String)Foot 1 |
Date the message was created |
Footnote 1 Data types, such as DATE
and BOOLEAN
, are stored in the API as STRING
.
Resource Types Linked to from message
Table 35-67 lists the resource types that the client can link to from the message
resource.
This section illustrates how to invite another user to join your connections list using the People Connections Service REST API. After the invitation is made, the invitee is given the option to accept or not. This example also illustrates how to delete an invitation.
The first step, as always with the REST APIs, is to retrieve the resource index:
GET http://<host:port>/rest/api/resourceIndex
Next, find the person to whom you want to connect. To do this:
In the resource index listing, scan for the link with the following resource type:
urn:oracle:webcenter:people:person
Execute a search for the user who you wish to invite. In this example, the user is named Monty.
GET http://<host:port>/rest/api/people?q=loginid:equals:monty&utoken=ASDF
Locate Monty's GUID in the response, as shown in Figure 35-16.
Save the GUID so that you can use it to connect to the user.
Now that you have the invitee's GUID, you must find the resource to which you would like to add him. In this case, you want to add him to your own connections
list.
To find your connections
list, first, scan the People Connections documentation (this chapter) for "connections
." You will discover in Table 35-46, "Related Resource Types for person" that connections
are linked to from the person
resource. For convenience, this table is shown in Figure 35-17.
Figure 35-17 Finding the connections Link
Now that you know that connections
are linked to from the person
resource, you need to find the person
resource. As the URN indicates, you get to the person
resource from the people
resource, as described in the following steps.
Return to the resource index (or use a cached version of the resourceIndex
from your previous visit):
GET http://<host:port>/rest/api/resourceIndex
Scan for the people
resource, and you will find:
urn:oracle:webcenter:people
Use the link in the people
resource to access your lists:
GET http://<host:port>/rest/api/people/@me/lists/@self?utoken=ASDF
Scan the returned links for the resourceType
and rel
listed in Table 35-46:
resourceType="urn:oracle:webcenter:people:person:list rel="urn:oracle:webcenter:people:person:list:connections
Make the invitation by using the URI to your connections
list to execute a POST
:
POST http://<host:port>/rest/api/people/@me/lists/@connections?utoken=ASDF Headers -- Accept:application/json, Content-Type:application/json Body -- {"message":"Monty, do you want to join my connections list?","guid":"1AE5AF102E2611E09F062B573E287934"}
Now, if you log in to Monty's account and you can see the invitation has been added, as shown in Figure 35-18.
Figure 35-18 Activity Stream Showing Invitation
After you initiate an invitation, you can view the invitation from your account by specifying invitor:equals:@me
. For example:
GET http://<host:port>/rest/api/people/invitations?q=invitor:equals:@me&utoken=ASDF
Each invitation element listed in the response contains a link that supports the DELETE operation and that looks something like this:
<links>
<link resourceType="urn:oracle:webcenter:people:invitation"
rel="self"
href="http://host_name:port_name/rest/api/people/invitations/e9073cdb-56ab-423d-8b1f-1220c802bdd4?utoken=FN0SEFwX42OCntwtx9a1dSbhqocO_w**" capabilities="urn:oracle:webcenter:delete"/>
</links>
The invitee can also delete an invitation from his or her own account. The invitee can get a list of his or her invitations by specifying:
GET http://<host:port>/rest/api/people/invitations?q=invitee:equals:@me&utoken=ASDF
Note that the response from a DELETE is simply a status code of 204.
This section provides information to assist you in troubleshooting problems you may encounter while using the People Connections service.
People Connections task flows take up the full browser, even when empty
This problem may arise if you are using Internet Explorer, version 8 (IE8). In IE8, go to Tools, Compatibility View Settings. In the Compatibility View Settings dialog, clear the following check boxes:
Display intranet sites in Compatibility View
Display all websites in Compatibility View
New Profile Image is Not Shown
Changes to a Profile image may not be rendered immediately due to a stale WebCenter Database cache. Clicking the Refresh icon under the stale image will cause the image to update.