Skip Headers
Oracle® Fusion Middleware Developer's Guide for Oracle WebCenter
11g Release 1 (11.1.1.4.0)

Part Number E10148-12
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

35 Integrating the People Connections Service

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:

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:

35.1 Introduction to 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 in jazn-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:

35.1.1 Understanding 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."

35.1.1.1 Activity Stream

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

  • Create announcement

  • Edit announcement

Blogs

  • Create blog

  • Update blog

Connections

  • Invitations to connect

  • People are connected

Discussions

  • Create forum

  • Create topic

  • Reply to topic

Documents

  • Create document

  • Edit document

  • Add tag

  • Remove tag

Events

  • Create an event

  • Edit an event

Feedback

  • Feedback left

  • Feedback received

Lists

  • Create a list

  • Add a row to a list

  • Edit a list row

Message Board

  • Message left

  • Message received

Pages

The following activities are tracked when they are performed within the service framework scope (for example, if a user creates pages under /myapp/mypages/, the page operations are not tracked):

  • Create page

  • Edit page

  • Delete page

  • Add tag

Profiles

  • Photo updated

  • Profile updated

  • Personal status note updated

Tagging

  • Add tag

  • Remove tag


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:

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.

35.1.1.2 Connections

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:

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.

35.1.1.3 Feedback

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).

    Figure 35-6 Feedback Task Flow

    Feedback task flow
    Description of "Figure 35-6 Feedback Task Flow"

  • 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

    Feedback - Quick View task flow
    Description of "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.

35.1.1.4 Message Board

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).

    Figure 35-8 Message Board Task Flow

    Message Board task flow
    Description of "Figure 35-8 Message Board Task Flow"

  • 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

    Message Board - Quick View task flow
    Description of "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.

35.1.1.5 Profile

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).

    Figure 35-10 Profile Task Flow

    Profile task flow
  • 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).

    Figure 35-11 Profile - Snapshot Task Flow

    Profile - Snapshot task flow

    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 the usesUpload 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).

    Figure 35-12 Profile Gallery Task Flow

    Profile Gallery task flow
    Description of "Figure 35-12 Profile Gallery Task Flow"

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.

35.1.1.6 The Publisher Task Flow

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).

Figure 35-13 Publisher Task Flow

Publisher task flow
Description of "Figure 35-13 Publisher Task Flow"

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.

35.1.2 Requirements for the People Connections Service

For a successful integration of People Connections with your WebCenter Portal application, ensure that the following steps have been taken:

  1. Create a WebCenter application (for more information, see Section 5.2, "Creating a WebCenter Portal Application and Adding Pages").

  2. 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").

  3. Create a JSF (.jspx) page (for more information, see Section 5.2.2, "Adding Pages to the Portal").

  4. 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").

  5. 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").

  6. Provide required values for task flow bindings (for more information, see Section 35.3.2.2, "People Connections Task Flow Binding Parameters").

  7. Run the page.

  8. When required, provide the user name and password of a test user you created at Step 4.

35.2 Basic Configuration for the People Connections Service

This section describes steps required for adding the People Connections service to your application. It includes the following subsections:

35.2.1 How to Set Up a Database Connection 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."

35.2.2 How to Add People Connections Task Flows to a Page

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:

  1. Prepare your application as described in Section 35.1.2, "Requirements for the People Connections Service."

  2. Open the page on which to add a People Connections task flow.

  3. In the Resource Palette, open My Catalogs, then WebCenter Services Catalog, then the Task Flows folder.

  4. Drag and drop a task flow (for example, Connections - Quick View) onto the JSF (.jspx) page.

  5. 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.

  6. 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."

  7. Click OK.

    The task flow is added to the page, and the ViewController project's libraries are configured to run the task flow.

  8. 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 the usesUpload 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."

35.2.3 Setting Security for the People Connections Service

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:

    1. Open the jazn-data.xml file.

      Tip:

      You will find the jazn-data.xml file in the Application Resources panel in the META-INF folder under Descriptors.
    2. Select the tab for Source at the bottom of the main content area.

    3. 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>
      

35.3 Advanced Information for the People Connections Service

This section describes advanced features available with the People Connections service. It includes the following subsections:

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."

35.3.1 Establishing Site-Level Settings for People Connections Features

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:

35.3.1.1 Understanding the People Connections Site-Level Setting Scripts

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:

35.3.1.1.1 Preparing and Running settings-insert.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 the settings-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:

  1. Open the script in an editor.

  2. For the settings you plan to change, uncomment the corresponding INSERT statement.

    Tip:

    To uncomment an INSERT statement, remove the leading double dash (--) on the lines the statement spans.
  3. 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 the settings-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.
35.3.1.1.2 Preparing and Running settings-update.sql

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 the settings-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:

  1. Open the script in an editor.

  2. For the settings you plan to change, uncomment the corresponding UPDATE statement.

    Tip:

    To uncomment an INSERT statement, remove the leading double dash (--) on the lines the statement spans.
  3. 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."

  4. 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.

  5. If your WebCenter Portal application is running, restart it for the changes to take effect.

35.3.1.2 Supported Site-Level Settings for People Connections Features

This section lists and describes the supported site-level application settings for the People Connections service. It includes the following subsections:

35.3.1.2.1 Activity Stream Site-Level Settings

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

accesscontrol.value.accessControlLevel

For determining who can view a user's Activity Stream

SELF, CONNECTIONS, USERS (that is, authenticated users), PUBLIC

accesscontrol.endUserConfigurable

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.

+, -

+=TRUE

-=FALSE

connectionsActivities.value

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.

NONE, ALL

NONE=No Personal Space activities are shown.

ALL=Personal Space activities of all the user's connections are shown.

groupSpaceActivities.value

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.

GSNONE, GSALL

GSNONE=No Space activities are shown

GSALL=Activities are shown for all of the Spaces of which the user is a member and on which the user has view access.

servicePublishedSettings[serviceId]

For indicating whether to show activities published by the WebCenter service serviceId in a user's Activity StreamA serviceId is the WebCenter service ID of any service that publishes activities. For a list of service IDs, see Table 35-3.

For example:

servicePublishedSettings[oracle.webcenter.community]

Users can override this setting on a task flow instance.

+, -

+=TRUE

-=FALSE


Table 35-3 Service IDs

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

Mail

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


35.3.1.2.2 Connections Site-Level Settings

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

autoAcceptInvitations

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.

+, -

+=TRUE

-=FALSE

connectionsVisibility.accessControlSettings.accessControlLevel

For specifying who can view a user's Connections

SELF, CONNECTIONS, USERS (that is, authenticated users), PUBLIC

connectionsVisibility.personalizable

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.

+, -

+=TRUE

-=FALSE


35.3.1.2.3 Feedback Site-Level Settings

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

visibility.accessControlSettings.accessControlLevel

For specifying who can view a user's received Feedback

SELF, CONNECTIONS, USERS (that is, authenticated users), PUBLIC

visibility.endUserConfigurable

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.

+, -

+=TRUE

-=FALSE

addControl.accessControlSettings.accessControlLevel

For specifying who can give Feedback to a user

SELF, CONNECTIONS, USERS (that is, authenticated users), PUBLIC

addControl.endUserConfigurable

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.

+, -

+=TRUE

-=FALSE

miniViewRowCount.value

For specifying the number of Feedback entries to show in a Feedback - Quick View task flow

Positive integers

miniViewRowCount.endUserConfigurable

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.

+, -

+=TRUE

-=FALSE

postedUserActions.delete

For indicating whether users are allowed to delete the Feedback they leave for other users

+, -

+=TRUE

-=FALSE


35.3.1.2.4 Message Board Site-Level Settings

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

visibility.accessControlSettings.accessControlLevel

For specifying who can view a user's Message Board

SELF, CONNECTIONS, USERS (that is, authenticated users), PUBLIC

visibility.endUserConfigurable

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.

+, -

+=TRUE

-=FALSE

addControl.accessControlSettings.accessControlLevel

For specifying who can post to a user's Message Board

SELF, CONNECTIONS, USERS (that is, authenticated users), PUBLIC

addControl.endUserConfigurable

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.

+, -

+=TRUE

-=FALSE

miniViewRowCount.value

For specifying the number of messages to show in a Message Board - Quick View task flow

Positive integer

miniViewRowCount.endUserConfigurable

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.

+, -

+=TRUE

-=FALSE

postedUserActions.edit

For indicating whether users are allowed to edit the messages they post on other users' Message Boards

+, -

+=TRUE

-=FALSE

postedUserActions.delete

For indicating whether users are allowed to delete messages they post on other users' Message Boards

+, -

+=TRUE

-=FALSE


35.3.1.2.5 Profile Site-Level Settings

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

general-profile-settings.logActivity

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

true, false

general-profile-settings.prersonalWebVisibility

For specifying who can view a user's Profile Gallery

SELF, CONNECTIONS, USERS (that is, authenticated users), PUBLIC

general-profile-settings.pwVisibilityPersonalizable

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.

true, false

general-profile-settings.view.name.profileSectionName.access-control-level

For specifying who can view the Profile section identified by profileSectionName.

For example:

general-profile-settings.view.name.personalInfo.access-control-level

For more information, see Table 35-8, "Profile Section Names".

SELF, USERS (that is, authenticated users), PUBLIC

Note: CONNECTIONS is not a valid value for this setting.

general-profile-settings.view.name.profileSectionName.allow-personalize-visibility

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 profileSectionName on their profile

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".

true, false

general-profile-settings.view.name.profileSectionName.allow-user-edit

For indicating whether users are allowed to edit the Profile section identified by profileSectionName on their own Profiles.

For example:

general-profile-settings.view.name.personalInfo.allow-user-edit

For more information, see Table 35-8, "Profile Section Names".

true, false

ootb-view-edit-settings.view.name.profileSectionName.profileFieldName.allow-edit

For indicating whether users are allowed to update the field identified by profileFieldName when they edit the Profile section identified by profileSectionName on their own profile.

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".

true, false


Table 35-8 Profile Section Names

Section Name Description

basic

Profile summary

These details are discoverable in an application search.

employee

Employee detail

businessContact

Business contact information

personalInfo

Personal information


Table 35-9 Profile Field Names

Field Name Description

email

Business email address

displayName

User display name

Dept

Office department

title

Job title

phone

Business phone number

timeZone

Time zone

photo

User photo

persStatNote

Personal status message

description

About me

empType

Employee type

empNo

Employee number

prefLang

User's preferred language

organization

Employee's organization

expertise

Employee's expertise

fax

Fax number

mobile

Mobile/cell phone number

pager

Page number

street

Office address: street

city

Office address: city

state

Office address: state

poBox

Office address: P.O. box

poCode

Office address: ZIP/PIN/P.O. code

country

Office address: country

homeAdd

Home address

homePhone

Home phone number

dob

Date of birth

maidenName

Maiden name/surname before marriage

doh

Date of hire


35.3.1.3 Example: Configuring Connections to Accept Invitations Automatically

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:

  1. 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', '-')
     ;
    
  2. Save and run the script.

  3. 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'
        ;
    
  4. 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'
        ;
    
  5. Save and run the script.

  6. 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."

35.3.2 Customizing People Connections Task Flows Using Task Flow Binding Parameters

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:

35.3.2.1 How to Revise People Connections Task Flow Binding Parameters

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:

  1. Open the application page and set the view to bindings by clicking the Bindings tab at the bottom of the page.

  2. 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

    Bindings view of an application page
    Description of "Figure 35-14 Bindings View of an Application Page"

    Figure 35-15 Edit Task Flow Binding Dialog

    Edit Task Flow Binding dialog
    Description of "Figure 35-15 Edit Task Flow Binding Dialog"

  3. Revise binding parameter values (for more information, see Section 35.3.2.2, "People Connections Task Flow Binding Parameters").

  4. Click OK to save your changes and exit the dialog.

  5. Save and run your page to see the results.

35.3.2.2 People Connections Task Flow Binding Parameters

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

__followEnforced

A means of enforcing the follow logic when querying Activity Stream

  • Enter #{true} to establish that the user must follow the business object to access streamed activities, even when the object's activities are queried in an advance query clause. The default is true.

  • Enter #{false} to omit this requirement. The activities streamed for Fusion business objects are returned as far as required by the advanced query, no matter whether the user follows the objects.

This parameter (for Fusion application business objects) is used in conjunction with the advancedQuery parameter.

This parameter is associated with the Activity Stream task flow.

__objectExtHandlerEnabled

A means of using the object extension handler to process Fusion application business objects

  • Enter #{true} to use the object extension handler to process business objects.

  • Enter #{false} to omit using the object extension handler. False is the default.

When you enter #{true}, then, before querying activities for the business objects, the Activity Stream uses the object extension handler to process the business objects. The handler checks whether the user has permission to access the business object. If the user does not have permission, the object is removed from the list, and, none activities are retrieved from this object.

This parameter is associated with the following task flows:

  • Activity Stream

  • Activity Stream - Quick View

__objects

A comma separated list of objects for which to show activities

Enter objects in the format object-id;object-type;service-id. Typically used only for followed objects.

This parameter is associated with the Activity Stream task flow.

__objectSecured

A means of enforcing a security check on a Fusion application business object

  • Enter #{true} to enforce the security check.

  • Enter #{false} to omit the security check. False is the default.

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:

  • Activity Stream

  • Activity Stream - Quick View

advancedQuery

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.

connectionListName

The name of a connections list

This parameter is associated with the task flow Connections - Card.

currentView

The view to display by default

Valid values include:

  • connections—(the default value) a list of connections

  • receivedInvitations—a list of connections invitations you received

  • sentInvitations—a list of connections invitations you sent

  • people—a search field for finding people with whom to connect

When users access the task flow instance, the view specified here is the first one they see. All selections, except people, provide controls for navigating to the application default view (connections). Selecting people provides search and select controls for inviting other users to connect.

This parameter is associated with the Connections task flow.

display_maxConnections

The maximum number of connections to show in the task flow

For example, enter 5 to specify that a maximum of five connections can appear in the task flow. A More link appears at the bottom of the task flow when there are more connections than the specified number of connections. Users click More to open the main view of the task flow where all connections are show.

The value entered for this parameter is honored only when values for display_numberOfRows and display_numberOfColumns have not both been specified. If values for both of these parameters have been specified, then Previous and Next links appear when there are more connections than can fit into the specified numbers of rows and columns.

This parameter is associated with the following task flows:

  • Connections - Card

  • Connections - Quick View

display_numberOfColumns

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 2 means those connections are shown in two columns with three rows (see also display_numberOfRows and display_maxConnections).

This parameter is associated with the following task flows:

  • Connections - Card

  • Connections - Quick View

display_numberOfRows

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 2 for display_numberOfColumns, a value of 2 for this parameter means connections are shown in two columns with two rows. That is, four connections are shown. A More link appears at the bottom of the task flow when there are more connections than can be fit in the specified number of columns and rows. Users click More to open the main view of the task flow where all connections are shown.

See also display_maxConnections.

This parameter is associated with the following task flows:

  • Connections - Card

  • Connections - Quick View

display_profileFormat

The default layout style for the task flow

Enter one of the following:

  • vcard—displays a connection's photo 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 (linked to a summary profile view), mail address, job title, status message, and actions icons and links.

  • tiled—renders the connection's personal Profile photo and shows the user name and job title beside the photo.

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.

display_removalAllowed

A means of showing or hiding the Remove action on the task flow

Enter true to show the Remove action. Enter false to hide the Remove action. The default value (true) is applied if the input is invalid.

This parameter is associated with the task flow Connections - Card.

display_sortedBy

The connections sort order

Enter LAST_ACTIVITY_TIME to sort connections in descending date/time order. Leave this field blank to sort connections alphabetically by name.

This parameter is associated with the task flow Connections - Card.

displayCount

The number of items to show in the task flow

For example, enter 5 to specify that a maximum of five items can appear in the task flow. In quick views, a More link appears at the bottom of the task flow when there are more items than the specified number of items. Users click More to open the main view of the task flow where all items are accessible. In main views, Previous and Next links are shown. Users click these to page through entries.

This parameter appears in the component properties for the following task flows:

  • Feedback

  • Feedback - Quick View

  • Message Board

  • Message Board - Quick View

displayMessageSize

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.

editMode

A means of enabling an edit mode on a Profile task flow instance

Enter #{true} to enable an edit mode. Enter #{false} to disable it.

This parameter is associated with the Profile task flow.

enableContextInfo

A means of showing or omitting detailed information about the object in the current context (that is, in a popup or other contextual instrument)

  • Enter #{true} to enable Activity Stream to display the af:contextInfo component (a small, red dot). Users can click this dot to view object detail information.

  • Enter #{false} to omit object detail information.

When this parameter is true and the contextInfoTaskflowId in the service definition is defined, the activity from the service displays the af:contextInfo. Otherwise, no context information is shown.

This parameter is associated with the Activity Stream task flow.

filterPattern

A filter against task flow content

For example, enter pat to show only those connections named pat (including patrick or sripathy).

This parameter is associated with the task flow Connections - Card.

fromDate

The start date of a date range within which to show feedback messages

Enter dates in the format YYYY-MM-DD.

See also toDate.

This parameter is associated with the following task flows:

  • Feedback

  • Feedback - Quick View

  • Message Board

hideActions

A means of hiding the actions normally associated with a Feedback or Message Board entry, such as Edit, Private, Hide, and Delete

  • Enter #{true} to hide actions associated with a Feedback or Message Board entry.

  • Enter #{false} to show such actions. When no value is entered, false is the default.

This parameter appears in the component properties for the following task flows:

  • Feedback – Quick View

  • Message Board – Quick View

hideAttach

Specifies whether the Attach: File|Link option is shown or hidden

  • Check for #{true} to hide the Attach: File|Link option.

  • Clear for #{false} to show the Attach: File|Link option.

This parameter is associated with the Publisher task flow.

hideComments

A means of showing or hiding the Comments feature on streamed activities

Enter true to hide the Comments feature. Enter false to show it.

This parameter is associated with the Activity Stream task flow

hideConfigure

A means of hiding the personalization option on the task flow instance

This parameter is associated with the following task flows:

  • Activity Stream

  • Activity Stream - Quick View

hideDocumentUploader

A means of showing or hiding the Publisher task flow's document uploader

Enter #{true} to hide the Publisher task flow's document uploader. Enter #{false} to show it.

This parameter is associated with the Publisher task flow.

hideFooter

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 true to hide the footer. Enter false (default) to show the footer.

This parameter is associated with the following task flows:

  • Activity Stream - Quick View

  • Connections - Card

  • Connections - Quick View

  • Feedback - Quick View

  • Message Board - Quick View

hideGiven

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:

  • Feedback

  • Feedback - Quick View

hideHeader

A means of showing or hiding the task flow header

Enter true to hide the task flow header. Enter false (default) to show the task flow header.

This parameter is associated with the following task flows:

  • Activity Stream - Quick View

  • Connections - Quick View

  • Feedback

  • Feedback - Quick View

  • Message Board

  • Message Board - Quick View

hideInlinePreview

A means of allowing or omitting an inline preview of files attached to streamed activities

Enter true to omit a file preview. Enter false to show it.

This parameter is associated with the Activity Stream task flow.

hideLike

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

hidePublisher

A means of showing or hiding the message entry field and the upload file and URL controls (the Publisher)

  • Enter #{true} to disable the display of the message entry field in a given task flow instance.

  • Enter #{false} to allow the display of the message entry field in a given task flow instance.

This parameter is associated with the following task flows:

  • Message Board

  • Message Board - Quick View

hideScopePicker

Specifies whether the Share something with option is shown or hidden

  • Check for #{true} to hide the Share something with option.

  • Clear for #{false} to show the Share something with option.

This parameter is associated with the Publisher task flow.

hintsTextKey

Specifies the resource bundle class and message key for hint text

Use the format key[,RBClass]. __EMPTY__ as the predefined key for no hint text. This is the default value.

This parameter is associated with the Publisher task flow.

imageSize

The display size of the profile photo

Enter one of the following values:

  • ORIGINAL

  • LARGE

  • MEDIUM

  • SMALL

This parameter is associated with the Profile - Snapshot task flow.

isUpdateStatus

A means of dedicating the task flow instance to updating the current user's Profile status message

Enter #{true} to devote the task flow instance to updating user status messages. Enter #{false} to omit publishing messages to the current user's Profile status message.

This parameter is associated with the Publisher task flow.

keepOpenAfterPublish

Specifies whether the text box remains active after a user clicks the Publish button

  • Enter #{true} to keep the text box open after a message is published.

  • Enter #{false} to close the text box after a message is published.

This parameter is associated with the Publisher task flow.

numberOfRows_list

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.

objectId

The ID of an object to associate with a published message

This parameter is associated with the Publisher task flow.

objectType

The type of an object to associate with a published message

This parameter is associated with the Publisher task flow.

orgBreadCrumbsShown

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 #{true} to show organizational breadcrumbs. Enter #{false} to omit them.

This parameter is associated with the Profile - Snapshot task flow.

pageSize

The number of items to stream in a given task flow instance

This parameter is associated with the following task flows:

  • Activity Stream

  • Activity Stream - Quick View

pagination

The form of pagination to use on a multipage stream

  • Enter #{true} to show Previous and Next links.

  • Enter #{false} hide to omit Previous and Next links. Instead, a more link is rendered, enabling users to navigate to a fuller view of the task flow where all streamed activities are shown.

This parameter is associated with the Activity Stream task flow.

photoUploadAllowed

A means of allowing a photo upload from the profile screen

Enter true (default) to allow users to upload a photo to their profile. Enter false to prevent users from uploading a photo.

This parameter is associated with the task flow Profile - Snapshot.

profileEditLinkShown

A means of showing or omitting an Edit link on a Profile - Snapshot task flow

Enter #{true} to show the Edit link. Enter #{false} to hide it.

This parameter is associated with the Profile - Snapshot task flow.

profileLaunchedOnSelection

A means of launching a user Profile when the user name is clicked

Enter true to launch a user Profile when the user name is clicked. Enter false to prevent launching a user Profile

This parameter is associated with the task flow Connections - Card

profileOnly

A means of streaming activities only from user profiles

  • Enter true to stream only those activities associated with user profiles.

  • Enter false to stream other types of activities along with those associated with user profiles.

This parameter is associated with the Activity Stream task flow.

profileUserId

ID of the user from whom to stream activity

This parameter is associated with the Activity Steam - Quick View task flow.

resourceId

The current user ID

Enter #{securityContext.userName} to return the current user.

This parameter is associated with the following task flows:

  • Activity Stream

  • Connections

  • Feedback

  • Message Board

  • Profile

  • Profile Gallery

scopeId

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.

sectionWiseEditEnabled

A means of enabling or disabling section-by-section edit capability on the task flow

  • Enter #{true} to enable section-by-section editing. An Edit control is shown on each editable Profile section.

  • Enter #{false} to disable section-by-section editing.

This parameter is associated with the Profile task flow.

serviceCategories

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.

serviceId

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.

spaceName

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:

  • Message Board

  • Message Board - Quick View

  • Publisher

spaces

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.

statusUpdateAllowed

A boolean value representing whether a control is available on the task flow for updating a profile status message

Enter either true or false.

This parameter appears in the component properties for the Profile - Snapshot task flow.

toDate

The end date of a date range within which to show feedback messages

Enter dates in the format YYYY-MM-DD.

See also fromDate.

This parameter is associated with the following task flows:

  • Feedback

  • Feedback - Quick View

  • Message Board

uploadDocumentOnly

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 #{false} to expose all Publisher features.

This parameter is associated with the Publisher task flow.

userId

The current user ID

Enter #{securityContext.userName} to return the current user.

This parameter is associated with the following task flows:

  • Connections - Card

  • Connections - Quick View

  • Feedback - Quick View

  • Message Board - Quick View

  • Profile - Snapshot

userName

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, #{o_w_w_i_v_b_resourceViewerBean.username}.

This parameter is associated with the Publisher task flow.

viaUser

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.


35.3.2.3 What You Should Know About the Activity Stream Advanced Query Option

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

  • SCOPE_ID—The GUID of the scope (you can use an EL to return this value, for example, #{serviceCtx.scope.GUID}).

  • SERVICE_ID—The service ID of the service to track. See Table G-7 for a list of service IDs.

  • ACTIVITY_TIME—The time the activity occurs.

    Use the datetime format that is supported in the SQL or target database. You can also use Oracle database SQL constructs, such as to_date().

  • ACTIVITY_TYPE—The type of activity to track

    For a list of valid activity type names, see Table 35-12.

ACTIVITY (ACTOR)

AD

ACTOR_NAME—The user name of the person performing the activity.

ACTIVITY (OBJECT)

OD

  • SERVICE_ID—The service ID of the service from which the tracked object issues. See Table G-7 for a list of service IDs.

  • OBJECT_ID—The GUID of the object.

  • DISPLAY_NAME—The object display name.

  • OBJECT_TYPE—The object type.

    Object type names for use with Advanced Query include:

    • event

    • announcement

    • forum

    • topic

    • bookmark

    • list

    • page

    • blog

    • document

    • wiki


Table 35-12 Activity Type Names for Advanced Query

Service Activity Type Name

Events

  • createEvent

  • updateEvent

Announcements

  • createAnnouncement

  • updateAnnouncement

Discussions

  • createForum

  • createTopic

  • replyTopic

Tags

  • updateBookmark

Lists

  • createList

  • editList

Page

  • createPage

  • editPage

Documents

  • create-blog

  • update-blog

  • create-document

  • create-wiki

  • update-document

  • update-wiki

People Connections (Profile)

  • updateStatus

  • updateProfile

  • updatePhoto

People Connections (Message Board)

  • postScope

  • postself

  • post

  • sharescope

  • shareself

  • share

  • shareobjectscope

  • shareobjectself

  • shareobject

  • updatescope

  • updateself

  • update

People Connections (Connections)

  • connect

  • inviteForConnection

People Connections (Feedback)

  • post


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.

AE.SERVICE_ID = \'oracle.webcenter.doclib\'

Stream activities only from an object or current Space.

OD.OBJECT_ID = \'objectA\' OR AE.SCOPE_ID = \'#{serviceCtx.scope.GUID}\'

Stream activities only about wikis created by the current user.

OD.OBJECT_TYPE = \'Wiki\' AND AD.ACTOR_NAME = \'#{securityContext.userName}\'

Stream activities for documents and discussions, but only create activities or all activities for the current user.

(AE.SERVICE_ID IN (\'oracle.webcenter.doclib\', \'oracle.webcenter.collab.forum\') AND AE.ACTIVITY_TYPE IN (\'createDocument\', \'createTopic\')) OR AD.ACTOR_NAME = \'#{securityContext.userName}\'


35.3.3 Using People Connections Data Controls

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:

35.3.3.1 Adding a Data Control to Your Project

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."

35.3.3.2 Working with People Connections Management Data Control

The People Connections Management Data Control provides methods for adding and managing connections and connections lists. The primary methods exposed include:

The subsections in this section list and describe the methods associated with the People Connections Management Data Control.

35.3.3.2.1 connectionLists

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

id

The connections lists IDs

listName

The names of connections lists

localizedName

The localized names of connections lists

memberCount

The number of members on each named connections list

modifiable

Information about whether a named connections list can be modified

memberUserIds

The user IDs of members on each named connections list


35.3.3.2.2 groupedPeopleCounts

The number of connections contained in each connections group.

35.3.3.2.3 receivedInvitations

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

dateFormattedAsReceived

The date the invitation was received according to the recipient's time stamp

dateFormattedAsSent

The date the inviation was sent according to the sender's time stamp.

id

The GUID of the received invitation

invitationMessage

The invitation message

inviteeUserid

The user ID of the person who received the invitation

invitorUserid

The user ID of the person who sent the invitation

sentDate

The date the invitation was sent according to the system time stamp


35.3.3.2.4 sentInvitations

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

dateFormattedAsReceived

The date the invitation was received according to the recipient's time stamp

dateFormattedAsSent

The date the inviation was sent according to the sender's time stamp

id

The unique GUID of the received invitation

invitationMessage

The invitation message

inviteeUserid

The user ID of the person who received the invitation

invitorUserid

The user ID of the person who sent the invitation

sentDate

The date the invitation was sent according to the system time stamp


35.3.3.2.5 acceptInvitation(String invitationId)

A method for accepting invitations to connect. Table 35-17 lists and describes the parameters associated with this method.

Table 35-17 Parameters of the Method acceptInvitations

Parameter Description

invitationId

The GUID of the invitation to connect to be accepted


35.3.3.2.6 addConnectionsToList(List userids, String listName)

A method for adding identified users to a named connections list. Table 35-18 lists and describes the parameters associated with this method.

Table 35-18 Parameters of the Method addConnectionsToList

Parameter Description

userids

The user names of the users to add to the named connections list

listName

The name of the connections list to which to add identified users


35.3.3.2.7 createConnectionList(String listName)

A method for creating a connections list. Table 35-19 lists and describes the parameters associated with this method.

Table 35-19 Parameters ofthe Method createConnectionList

Parameter Description

listName

The name to give the new connections list


35.3.3.2.8 declineInvitation(String invitationId)

A method for declining an invitation to connect. Table 35-20 lists and describes the parameters associated with this method.

Table 35-20 Parameters of the Method declineInvitation

Parameter Description

invitationId

The unique GUID of the declined invitation


35.3.3.2.9 dropConnectionList(String listName)

Method for deleting a connections list. Table 35-21 lists and describes the parameters associated with this method.

Table 35-21 Parameters of the Method dropConnectionList

Parameter Description

listName

The name of the connections list to delete


35.3.3.2.10 getConnectionList(String connectionListName)

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):

  • id

  • listName

  • localizedName

  • memberCount

  • modifiable

  • memberUserIds


Table 35-23 Attributes of the Method getConnectionList

Attribute Description

id

The unique GUID of the connections list to return

listName

The name of the connections list to return

localizedName

The localized name of the connections list to return

memberCount

The number of members on the connections list to return

modifiable

An indicator of whether the returned connections list can be modified

memberUserIds

The user IDs of the members of a returned connections list


35.3.3.2.11 getConnections(String userid, String connectionListName, String filterPattern, String sortBy, int startIndex, int fetchSize)

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

userid

The user ID for each returned connection

connectionListName

The name of the connection list from which to obtain connections

filterPattern

A filter to use against returned connections, such as "co," which returns condoleezza as well as nicole

sortBy

The order by which to sort connections

Enter LAST_ACTIVITY_TIME to sort connections in descending date/time order. Leave blank to sort alphabetically by name.

startIndex

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 startIndex to 1 and fetchSize to 10.

fetchSize

The number of results to return (see startIndex)


Table 35-25 Attributes of the Method getConnections

Attribute Description

connecteeUserId

The user ID of a connection

connectionListsMembershipList

The names of connections lists of which the connection is a member

connecteeUserProfile

The connectee's Profile details


35.3.3.2.12 getNumberOfConnections(String userid, String connectionListName, String filterPattern)

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

userid

The user ID for whom to return the number of connections

connectionListName

The name of the connection list from which to obtain a count

filterPattern

A filter to use against returned connections, such as "co," which returns condoleezza as well as nicole


Table 35-27 Attributes of the Method getNumberOfConnections

Attribute Description

Int

The number of connections to return


35.3.3.2.13 ignoreInvitation(String invitationId)

Specifies that the invitation with the specified ID should be ignored. Table 35-28 lists and describes the parameters associated with this method.

Table 35-28 Parameters of the Method ignoreInvitation

Parameter Description

invitationId

The GUID of the connection invitation to ignore


35.3.3.2.14 inviteUserForConnection(String userid, String invitationMessage, Collection connectionListNames)

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.

Table 35-29 Parameters of the Method inviteUserForConnection

Parameter Description

userid

User ID of the invitee

invitationMessage

Connection message, such as, "Let's connect!"

connectionListNames

The names of the connecitons lists to add the invitee to once the invitation is accepted


35.3.3.2.15 isConnectionListModifiable(String listName)

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.

Table 35-30 Parameters of the Method isConnectionListModifiable

Parameter Description

listName

The name of the connections list for which to determine whether it can be modified


Table 35-31 Attributes of the MethodisConnecitonListModifiable

Attribute Description

boolean

True or false, depending on whether the named connections list can be modified


35.3.3.2.16 isConnectionPartOfUnmodifiableList(String connecteeGuid)

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.

Table 35-32 Parameters of the Method isConnectionPartOfUnmodifiableList

Parameter Description

connecteeGuid

The GUID of the connection for whom to determine whether this connection is a member of a connections list that cannot be modified


35.3.3.2.17 removeConnection(String userid, boolean fromListOnly, String listName)

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

userid

The user name of the connection to remove from the specified list

fromListsOnly

A flag (true or false) indicating whether to remove the user as a connection or remove the user only from the specified connections list

listName

The name of the connections list from which to remove the specified user


35.3.3.2.18 searchUsers(String filterPattern, int startIndex, int fetchSize)

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

filterPattern

A filter to use against returned search terms, such as "co," which returns condoleezza as well as nicole

startIndex

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 startIndex to 1 and fetchSize to 10.

fetchSize

The number of results to return (see startIndex)


Table 35-35 Attributes of the Method searchUsers

Attribute Description

relationalAttributes

userGuid

The user's unique GUID

userProfile

The user's Profile details


35.3.3.2.19 updateConnectionListsMembership(String member, Collection addListIds, Collection removeListIds)

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

member

The user name of the member whose connections list membership to manage

addListIds

The names of the connections lists to which to add the identified user

removeListIds

The names of the connections lists from which to remove the identified user


35.3.3.3 Working with Profile Data Control

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.

35.3.3.3.1 Method: getProfile(String userId)

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

userID

The ID of the user for whom to return Profile details


Tip:

To see the attributes associated with the WCUserProfile object, expand the WCUserProfile node under the getProfile method on the Data Controls panel in the Application Navigator.
35.3.3.3.2 Method: getProfileForUpdate(String userId)

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.

Table 35-38 Parameters for the getProfileForUpdate Method

Parameter Description

userID

The ID of the user for whom to update Profile details


Tip:

To see the attributes associated with the WCUserProfile object, expand the WCUserProfile node under the getProfileForUpdate method on the Data Controls panel in the Application Navigator.

35.3.4 Using People Connections Service Java APIs

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

35.3.5 Using the People Connections Service REST APIs

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."

35.3.5.1 Activity Stream 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:

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.
35.3.5.1.1 Activity Stream Entry Point

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."

35.3.5.1.2 Activity Stream Resource Type Taxonomy

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
35.3.5.1.3 Activity Stream Security Considerations

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."
35.3.5.1.4 Activity Stream Resource Types

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

urn:oracle:webcenter:activities:stream:person

Activities from the user's stream (GUID/@self)Foot 1 

urn:oracle:webcenter:activities:stream:connections

Activities from the user's connections' streams (GUID/@connections)Footref 1

urn:oracle:webcenter:activities:stream

Activities determined by the activity stream query filter

urn:oracle:webcenter:activities:stream:space

Activities from the group space's activity stream

urn:oracle:webcenter:activities:stream:list

Activities from the group space's activity list


Footnote 1 GUID can be any valid user GUID or @me.

Navigation Paths to stream

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

Supported Methods for stream

The following method is supported by the stream resource:

  • GET

    • requestParameters:

      • startIndex, itemsPerPage

      See Also:

      For information about REST API parameters, such as startIndex 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
      
    • responseBody: 0 or more activities

      Note:

      Because the stream 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


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.

Navigation Paths to activity

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.

See Also:

For information about projection, see "Common Request Query Parameters".

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

activityType

String

Activity type

Unique within the service. For example the Discussions service can return the activityType createForum.

commentsCount

String

If you specify commentsSummary in the data parameter, then the commentsCount parameter will be returned.

createdDate

Date (String)Foot 1 

Date the activity was created

description

String

The description of the activity

detail

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 detailURL. Both, either, or neither can be used.

detailURL

String

Detail information for the activity

Similar to detail. Both, either, or neither can be used.

displayDescription

String

A pre-formatted, internationalized description.

displayMessage

String

A pre-formatted, internationalized message (does not include template information).

groupSpace

groupSpaceReference

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.

id

String

Unique ID of the message

isSummary

true or false

Indicates whether or not this activity is a summary of other activities.

likesCount

String

If you specify likesSummary in the data parameter, then the likesCount parameter will be returned.

message

String

Localized string for this activity

This may contain replacement strings within curly braces ({}).

permission

PRIVATE

SHARED

PUBLIC

Permission level of this activity

scope

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

serviceId

String

Unique ID of the service that created the activity

Note: For a list of WebCenter service IDs, see Table 35-3, "Service IDs".

templateParams

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

Supported Methods for 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.

Table 35-42 Related Resource Types for urn:oracle:webcenter:spaces:roles

rel resourceType

self

Navigation Paths to activities:activity:icon

urn:oracle:webcenter:parent

urn:oracle:webcenter:activities:activity


35.3.5.2 Connections and Profile REST APIs

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:

35.3.5.2.1 Connections and Profile Entry Point

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:

The people: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."

35.3.5.2.2 Connections and Profile Resource Type Taxonomy

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
35.3.5.2.3 Connections and Profile Security Considerations

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."
35.3.5.2.4 Connections and Profile Resource Types

This section provides you with all the information you need to know about each resource type. It includes the following subsections:

urn:oracle:webcenter:people

The people response contains URIs for use in retrieving the profile of one or more users.

Navigation Paths to people

This section shows how the client can navigate through the hypermedia to access the people resource:

resourceIndex
   people

Supported Methods for people

The following method is supported by the people resource:

  • GET

    • requestParameters:

      • 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:

        The data 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:

        The links 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.

    • responseBody: 1 or more person

Supported Links for people

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.

Table 35-43 Related Resource Types for people

rel resourceType

self

urn:oracle:webcenter:people:person


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

Supported Methods for 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. The size 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:people:icon

urn:oracle:webcenter:parent

urn:oracle:webcenter:people


urn:oracle:webcenter:people:person

The person response contains profile data and the URIs for use in retrieving a user profile.

Navigation Paths to person

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

Supported Methods for person

The following method is supported by the person resource:

  • GET

    • requestParameters: 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 parameter q is only on the resourceIndex template for person.
    • responseBody: message

      See Also:

      For information about the response message, see "Read-only Elements for person".

Read-only Elements for person

Table 35-45 lists the read-only elements for the person resource.

Note:

The elements present in a person 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.

See Also:

For information about projection, see "Common Request Query Parameters".

Table 35-45 Read-Only Elements for person

Element Type Description Projection

guid

String

Unique GUID of the person

Summary, Detailed

id

String

Unique login ID of the person (that is, the user name, for example, pat_coi)

Summary, Detailed

displayName

String

Display name of the person (the user's name, for example, Pat Coi). This may have the same value as id, depending on the repository configuration.

Summary, Detailed

birthday

Date (String)Foot 1 

Birth date of the person

Summary, Detailed

connected

Boolean (String)Footref 1

Whether or not this person is connected to the current user

Detailed

language

String

Preferred language of the person

Summary, Detailed

timeZone

String

Time zone of the person

Summary, Detailed

name

name

Name information for the person

name is a portable contact type. For more information, see Section 51.11.2.1, "name Portable Contact Type."

Summary, Detailed

address

address

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

value

Emails for the person

emails is derived from the value portable contact type. For more information, see Section 51.11.2.4, "value Portable Contact Type."

Summary, Detailed

photos

value

Profile photos for the person

photos is derived from the value portable contact type. For more information, see Section 51.11.2.4, "value Portable Contact Type."

Summary, Detailed

phoneNumbers

value

Phone numbers for the person

phoneNumber is derived from the value portable contact type. For more information, see Section 51.11.2.4, "value Portable Contact Type."

Summary, Detailed

organization

organization

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

personReference

Manager of this person

Summary, Detailed

reportees

personReference

Direct reports of this person

Summary, Detailed

status

urn:oracle:webcenter:people:person:status

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:people:person:list

 

urn:oracle:webcenter:people:person:listNames

 

urn:oracle:webcenter:people:person:status

urn:oracle:webcenter:activities:stream:person

urn:oracle:webcenter:activities:stream

urn:oracle:webcenter:activities:stream:connections

urn:oracle:webcenter:activities:stream

urn:oracle:webcenter:activities:stream

urn:oracle:webcenter:activities:stream

 

urn:oracle:webcenter:messageBoard

urn:oracle:webcenter:feedback:all-given

urn:oracle:webcenter:feedback

urn:oracle:webcenter:feedback:all-received

urn:oracle:webcenter:feedback


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).

Navigation Paths to list

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")

Supported Methods for list

The following methods are supported by the list resource:

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

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).

Navigation Paths to listNames

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

    • requestBody: listName

    • responseBody: listName

See Also:

For information about listName, see "urn:oracle:webcenter:people:person:listName".

Resource Types Linked to from listNames

Table 35-48 lists the resource types that the client can link to from the listNames resource.

Table 35-48 Related Resource Types for listNames

rel resourceType

self

urn:oracle:webcenter:people:person:listNames


urn:oracle:webcenter:people:person:listName

The listName response contains the names of connections lists and URIs for use in accessing the connections lists.

Navigation Paths to listName

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

name

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:people:person:list

urn:oracle:webcenter:activities:stream:list

urn:oracle:webcenter:activities:stream


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.

Navigation Paths to member

This section shows how the client can navigate through the hypermedia to access the member resource:

resourceIndex
   person
      list
         member

Supported Methods for member

The following method is supported by the member resource:

  • DELETE

    • request

Writable Elements for member

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

guid

String

Yes

1 or more characters

GUID of the user

message

String

No

0 or more characters

Invitation message

Use this only when inviting users to be connections (that is POSTing to the @connections list, not to user-created connections lists).


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.

Navigation Paths to status

This section shows how the client can navigate through the hypermedia to access the status resource:

resourceIndex
   people
      person
         status

Supported Methods for status

The following methods are supported by the status resource:

  • GET

    • request

    • responseBody: status

  • PUT

    • requestBody: status

    • responseBody: status

Writable Elements for status

Table 35-52 lists the writable elements for the status resource.

Table 35-52 Writable Elements for status

Element Type Required Constraints Description

note

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

message

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:

Table 35-55 Related Resource Types for invitations

rel resourceType

self

urn:oracle:webcenter:people:invitation


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

status

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

id

String

Unique ID of the invitation

invitee

personReference

User to whom the invitation is sent

invitor

personReference

User from whom the invitation is sent

sentDate

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.

Table 35-58 Related Resource Types for invitations

rel resourceType

self

urn:oracle:webcenter:people:invitation


35.3.5.3 Feedback REST APIs

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:

35.3.5.3.1 Feedback Entry Point

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."

35.3.5.3.2 Feedback Resource Type Taxonomy

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
35.3.5.3.3 Feedback Security Considerations

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."
35.3.5.3.4 Feedback Resource Types

This section provides you with all the information you need to know about each resource type. It includes the following subsections:

urn:oracle:webcenter:feedback

The feedback response contains URIs for use in reading Feedback messages.

Navigation Paths to feedback

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:

Read-only Elements for feedback

Table 35-41 lists the read-only elements for the feedback resource.

See Also:

For information about projection, see "Common Request Query Parameters".

Table 35-59 Read-Only Elements for feedback

Element Type Description

receivedUser

personReference

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


urn:oracle:webcenter:feedback:message

The message response contains the feedback message data and URIs for use in deleting a Feedback message.

Navigation Paths to 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

body

String

Message content

id

String

Unique ID of the message

author

personReference

User who created the message

created

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.

Table 35-62 Related Resource Types for message

rel resourceType

self

urn:oracle:webcenter:feedback:message


35.3.5.4 Message Board REST APIs

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:

35.3.5.4.1 Message Board Entry Point

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."

35.3.5.4.2 Message Board Resource Type Taxonomy

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
35.3.5.4.3 Message Board Security Considerations

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."
35.3.5.4.4 Message Board Resource Types

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:

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

messageType

String

Contains link data if the message has a link.

link

String

Contains link data for messages with links: name, url, icon, description, mimeType, objectId, objectType, serviceId.


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


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.

Navigation Paths to 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

Supported Methods for message

The following methods are supported by the message resource:

  • GET

    • request

    • responseBody: message

  • PUT

    • requestBody: message

    • responseBody: message

  • DELETE

    • request

Writable Elements for message

Table 35-65 lists the writable elements for the message resource.

Table 35-65 Writable Elements for message

Element Type Required Constraints Description

body

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

id

String

Unique ID of the message

author

personReference

User who created the message

created

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.

Table 35-67 Related Resource Types for message

rel resourceType

self

urn:oracle:webcenter:messageBoard:message


35.4 Creating an Invitation

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.

35.4.1 Creating an Invitation

  1. The first step, as always with the REST APIs, is to retrieve the resource index:

    GET http://<host:port>/rest/api/resourceIndex
    
  2. Next, find the person to whom you want to connect. To do this:

    1. In the resource index listing, scan for the link with the following resource type:

      urn:oracle:webcenter:people:person
      
    2. 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
      
    3. Locate Monty's GUID in the response, as shown in Figure 35-16.

      Figure 35-16 Response With User's GUID

      Description of Figure 35-16 follows
      Description of "Figure 35-16 Response With User's GUID"

    4. Save the GUID so that you can use it to connect to the user.

  3. 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

    Description of Figure 35-17 follows
    Description of "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.

  4. Return to the resource index (or use a cached version of the resourceIndex from your previous visit):

    GET http://<host:port>/rest/api/resourceIndex
    
  5. Scan for the people resource, and you will find:

    urn:oracle:webcenter:people
    
  6. Use the link in the people resource to access your lists:

    GET http://<host:port>/rest/api/people/@me/lists/@self?utoken=ASDF
    
  7. 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
    
  8. 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"}
    
  9. 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

    Description of Figure 35-18 follows
    Description of "Figure 35-18 Activity Stream Showing Invitation"

35.4.2 Deleting an 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.

35.5 Troubleshooting the People Connections Service

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:

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.