Communities and community members profiles | HCL Digital Experience
These profiles provide access to HCL Connections community and community members feed data.
Communities profile
The communities profile
provides access to HCL Connections communities
feed data. It declares the following attribute names:
- Author's email address
- authorEmail
- This attribute references the email address of the author of the social object.
- Author's ID
- authorID
- This attribute references the internal ID of the author of the social object. It represents the author ID from the HCL Connections server where the social object is stored.
- Author's image URL
- authorImageLink
- This attribute specifies the link to the profile image of the author of the social object. The HCL Connections server that provides the social object also stores the profile image of the author. This attribute contains a URL where you can download the image either directly from HCL Connections or by using the Ajax proxy of the portal. For more information about this attribute, read Configuring globally how social object data is served. This attribute is computed by the social rendering Digital Data Connector (DDC) for HCL Portal plug-in.
- Author's name
- authorName
- You can use this attribute to include the name of the author of the social object in the design of a social list.
- Author's object ID
- authorObjectID
- This attribute references the serialized object ID of the author
of the social object. In contrast to the
authorID
attribute, theauthorObjectID
attribute represents an ID that is used by HCL Portal rather than by HCL Connections. This attribute is computed by the social rendering Digital Data Connector plug-in. - Author's UID
- authorUID
- This attribute specifies the value of the UID attribute of the author of the social object. This value reflects the UID user attribute as defined by the user repository of the portal. This attribute is computed by the social rendering Digital Data Connector plug-in.
- Body HTML
- body HTML
- The HTML content of this item.
- Body plain
- body plain
- The plain content of this item.
- Body content type
- bodyContentType
- This attribute specifies the content type identifier for the body attribute of this item.
- Community image URL
- communityImageLink
- This attribute specifies the URL to the image of this community. This attribute is computed by the social rendering Digital Data Connector plug-in.
- Community UUID
- communityUUID
- This attribute specifies the UUID of this community.
- Feed entry
- entry
- The original feed entry of this item.
- ID
- id
- The unique identifier for this item.
- Is moderated
- isModerated
- If this community is a moderated community, this attribute returns
the string
true
. Otherwise, it returnsfalse
. - Is post-moderated
- isPostModerated
- If the
post-moderation
feature was enabled for this community, this attribute returns the stringtrue
. Otherwise, it returnsfalse
. - Is pre-moderated
- isPreModerated
- If the
pre-moderation
feature was enabled for this community, this attribute returns the stringtrue
. Otherwise, it returnsfalse
. - Is public
- isPublic
- If this community is a public community, this attribute returns
the string
true
. Otherwise, it returnsfalse
. - Is restricted
- isRestricted
- If this community is a restricted (invite-only) community, this
attribute returns the string
true
. Otherwise, it returnsfalse
. - View URL
- link
- This attribute specifies the URL that points to the details view of this community. This attribute is computed by the social rendering Digital Data Connector plug-in.
- Number of members
- numberOfMembers
- This attribute specifies the number of members of this community.
- Author's portal image URL
- portalAuthorImageLink
- This attribute specifies the link to the profile image of the author of the social object. The HCL Connections server that provides the social object also stores the profile image of the author. This attribute contains a URL where you can download the image from HCL Connections by using the Ajax proxy of the portal. This attribute is computed by the social rendering Digital Data Connector plug-in.
- Author's portal URL
- portalAuthorLink
- This attribute specifies the link for rendering the details view of the author of this item in the context of the portal. This attribute is computed by the social rendering Digital Data Connector plug-in.
- Portal community image URL
- portalCommunityImageLink
- This attribute specifies the HCL Portal URL to the image of this community. This attribute is computed by the social rendering Digital Data Connector plug-in.
- Portal view URL
- portalLink
- This attribute specifies the HCL Portal URL that points to the details view of this community. This attribute is computed by the social rendering Digital Data Connector plug-in.
- Published date
- published
- This attribute indicates the time when the social object was published. To display the date in the format of your choice, you can use all date format options that Web Content Manager provides.
- Raw activity stream URL
- rawActivityStreamLink
- This attribute specifies the HCL Connections URL of the subcommunities feed of this community.
- Author's raw Atom entry URL
- rawAuthorEntryLink
- Link to the Atom entry that represents the author of this item. This URL directly addresses the HCL Connections server. This attribute is computed by the social rendering Digital Data Connector plug-in.
- Author's raw image URL
- rawAuthorImageLink
- This attribute specifies the link to the profile image of the author of the social object. The HCL Connections server that provides the social object also stores the profile image of the author. This attribute contains a URL for downloading the image directly from HCL Connections. This attribute is computed by the social rendering Digital Data Connector plug-in.
- Raw bookmarks URL
- rawBookmarksLink
- This attribute specifies the HCL Connections URL of the bookmarks feed of this community.
- Raw community image URL
- rawCommunityImageLink
- This attribute specifies the HCL Connections URL to the image of this community. This attribute is computed by the social rendering Digital Data Connector plug-in.
- Raw Atom entry URL
- rawEntryLink
- This attribute specifies the HCL Connections URL of the Atom entry that represents this community.
- Raw feeds URL
- rawFeedsLink
- This attribute specifies the HCL Connections URL of the feeds feed of this community.
- Raw forum topics URL
- rawForumTopicsLink
- This attribute specifies the HCL Connections URL of the forum topics feed of this community.
- Raw invites URL
- rawInvitesLink
- This attribute specifies the HCL Connections URL of the invitations feed of this community.
- Raw view URL
- rawLink
- This attribute specifies the URL of the details view of this community on the HCL Connections server.
- Raw members URL
- rawMembersLink
- This attribute specifies the HCL Connections URL of the members feed of this community.
- Raw parent community URL
- rawParentCommunityLink
- This attribute specifies the HCL Connections URL of the parent communities feed of this community.
- Raw subcommunities URL
- rawSubCommunitiesLink
- This attribute specifies the HCL Connections URL of the subcommunities feed of this community.
- Summary
- summary
- This attribute specifies the summary description of this community.
- Tags
- tags
- This attribute specifies the tags that are associated with this item.
- Title
- title
- The title of this item.
- Updated date
- updated
- This attribute indicates the time of the last update of the social object. To display the date in the format of your choice, you can use all date format options that Web Content Manager provides.
- User is Member
- userIsMember
- If the current user is a member of the current community, this
attribute returns the string
true
. Otherwise, it returnsfalse
. This attribute is computed by the social rendering Digital Data Connector plug-in. - User membership edit URL
- userMembershipEditLink
- This attribute specifies the URL to the editable resource that represents the membership relation between the currently logged in user and the current community.
- User Membership URL
- userMembershipLink
- This attribute specifies the URL to the resource that represents the membership relation between the currently logged in user and the current community. This attribute is computed by the social rendering Digital Data Connector plug-in.
- User Membership Role
- userMembershipRole
- This link specifies the membership role of the currently logged in user in the current community.
- Updated date
- updated
- This list property indicates the time of the last update of the list that is represented by the feed at hand. To display the date in the format of your choice, you can use all date format options that Web Content Manager provides.
- Raw URL to this feed
- selfLink
- This list property specifies the link to this feed.
- Feed title
- title
- This list property specifies the link to this feed.
- Total Number of Items
- totalNumberOfItems
- This list property specifies the total number of items that were found for this search.
- Requested Number of Items
- requestedNumberOfItems
- This list property specifies the requested number of items for this search.
- Start Index
- startIndex
- This list property specifies the start index for the paged list of items.
- Raw first URL
- rawFirstLink
- This list property specifies the HCL Connections URL of the first page of items that were found for this search.
- Raw next URL
- rawNextLink
- This list property specifies the HCL Connections URL of the next page of items that were found for this search.
- Raw previous URL
- rawPreviousLink
- This list property specifies the HCL Connections URL of the previous page of items that were found for this search.
- Raw last URL
- rawLastLink
- This list property specifies the HCL Connections URL of the last page of items that are found for this search.
- Is truncated
- isTruncated
- If the list that represents a search result is truncated, this
list property returns the string
true
. Otherwise, it returnsfalse
.
Community members profile
The communities
members profile provides access to HCL Connections communities
members feed data. It declares the following attribute names:
- Body HTML
- body HTML
- The HTML content of this item.
- Body plain
- body plain
- The plain content of this item.
- Body content type
- bodyContentType
- This attribute specifies the content type identifier for the body attribute of this item.
- ID
- id
- ID
- Member is active
- memberActive
- This attribute indicates whether this community member is currently available.
- Member's email
- memberEmail
- This attribute specifies the email address of this community member.
- Member's ID
- memberID
- This attribute specifies the internal ID of this community member.
- Member's image URL
- memberImageLink
- This attribute specifies the URL of the profile image of this community member. This attribute is computed by the social rendering Digital Data Connector plug-in.
- Member's name
- memberName
- This attribute specifies the name of this community member.
- Member's role
- memberRole
- This attribute specifies the role of the community member.
- Member's type
- memberType
- This attribute specifies the type of the community member, for example, whether the member is a person or a group.
- Portal view URL
- portalLink
- This attribute specifies the HCL Portal URL that points to the details view of this community member. This attribute is computed by the social rendering Digital Data Connector plug-in.
- Portal member's image URL
- portalMemberImageLink
- This attribute specifies the HCL Portal URL of the profile image of this community member. This attribute is computed by the social rendering Digital Data Connector plug-in.
- Published date
- published
- This attribute indicates the time at which this community member record was created. To display the date in the format of your choice, you can use all date format options that Web Content Manager provides.
- Raw Atom entry URL
- rawEntryLink
- This attribute specifies the HCL Connections URL of the Atom entry that represents this community member.
- Raw member's image URL
- rawMemberImageLink
- This attribute specifies the HCL Connections URL of the profile image of this community member. This attribute is computed by the social rendering Digital Data Connector plug-in.
- Raw profile URL
- rawProfileLink
- This attribute specifies the HCL Connections URL of the user profile Atom entry that represents this community member.
- Raw VCard URL
- rawVCardLink
- This attribute specifies the HCL Connections URL of the VCard resource of this community member.
- Summary
- summary
- This attribute specifies the summary information for this community member.
- Title
- title
- Title
- Updated date
- updated
- This attribute indicates the most recent time at which this community record was updated. To display the date in the format of your choice, you can use all date format options that Web Content Manager provides.
- Updated date
- updated
- This list property indicates the time of the last update of the list represented by the feed at hand. To display the date in the format of your choice, you can use all date format options that Web Content Manager provides.
- Raw URL to this feed
- selfLink
- This list property specifies the link to this feed.
- Feed title
- title
- This list property specifies the link to this feed.
- Total Number of Items
- totalNumberOfItems
- This list property specifies the total number of items that were found for this search.
- Requested Number of Items
- requestedNumberOfItems
- This list property specifies the requested number of items for this search.
- Start Index
- startIndex
- This list property specifies the start index for the paged list of items.
- Raw first URL
- rawFirstLink
- This list property specifies the HCL Connections URL of the first page of items that were found for this search.
- Raw next URL
- rawNextLink
- This list property specifies the HCL Connections URL of the next page of items that were found for this search.
- Raw previous URL
- rawPreviousLink
- This list property specifies the HCL Connections URL of the previous page of items that were found for this search.
- Raw last URL
- rawLastLink
- This list property specifies the HCL Connections URL of the last page of items found for this search.
- Is truncated
- isTruncated
- If the list that represents a search result is truncated, this
list property returns the string
true
. Otherwise, it returnsfalse
.