IBM Connections Event Reference - Connections Content Manager
Added by Joseph Costin | Edited by Joseph Costin on September 2, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

A list of events generated from Connections Content Manager
Connections Content Manager Events < Return to Events Reference

Event data is provided using the following conventions. Refer to the Event_SPI_ic45Create New Article for details about these event data objects, how to retrieve them from the event object, and how to get additional information from these objects themselves.

 

Scope/Visibility

"Normal targeting" below refers to:

  • All followers of the community (if the document is accessible to all the community). This is achieved by conditionally marking the community ID in the targeting list. Such events will show in the recent updates tab in the community.
  • Followers of the person (if the document is public). This is achieved "automatically" by the stream by the generator marking the event as public and correctly noting the actor in the event. FileNet must mark an action as public if and only if it visible to everyone in the system. Such events will also show in the discover tab in the homepage.
  • Followers of the document (for each individual follower that still has access to the doc). This is achieved by individually including each follower who still have access to the item in the targeting list.
  • Note that these access checks apply to the access on the version the action is against. If the action is against a draft, then the community should not be included, since the whole community does not have access to the draft. Similarly the draft should not be marked as "public" even if the document is and individual followers should not be notified about the draft unless they have access to the draft (potentially by being a community owner for instance).
  • Always generate activity stream feed for events on documents filed in a Lifecycle Library (+subfolders) or Linked Library (+subfolders)
         Lifecycle Libraries are CE folder instances of class ClbTeamspace where the community id property of the folder is not null.
         LInked Libraries are CE folder instances of class ClbTeamspace where the community id property of the folder is  null.
    In other words, documents outside of a teamspace, in a normal FileNet folder which is not a descendent of a teamspace, will not send notifications. Documents in a teamspace will generate events.
  • Note also: For a document to be IN a teamspace, some metadata must be set up on the document. Event handlers will handle this for all documents filed in any subfolder of the teamspace, but for documents created prior to the event handlers being installed, the documents will not be properly marked as IN the teamspace. Such document without the proper metadata will not send notifications. This applies to documents created prior to FileNet 5.2 or documents created in FileNet 5.2 prior to the installation of the correct add-ons. A migration tool should be provided to add the correct metadata to existing items. This is similar to the migration tool needed to migration libraries created in prior FileNet versions to teamspaces. This will be tracked on the open issues list as well.

N/A Targeting:

  • This is just for events that are sent and can be read by the Event SPI, but do not appear in the Activity Stream UI under any circumstances.


Notes

{Actor} = Person doing the action

{Object} = Draft or published version most of the time

{Target} = Library name - "...Green Repository", "...managed files" or "...linked library" most of the time.

"Reviewers" = ALL reviewers including the reviewer who initiated the event

actor: The Person object who triggered the event as the event Actor.

eventType: Scenario type in which event is generated

contentData: Content details for the event, such as tags.

 

 

Task
Event Name
Event Data
ECM description Notes
Upload file
ecm_files.add.file.ecm.file.added.to.teamspace
  • actor
  • eventType: EDIT
  • contentData:
    • Object -File Name
    • Target - Library Name
    • Rollup ID - Version Series ID
{Actor} uploaded {Object} to {Target}  
Publish Draft
ecm_files.post.file.ecm.file.checkin
  • actor
  • eventType: EDIT
  • contentData:
    • Object - File Name
    • Target - Library Name
    • Rollup ID - Version Series ID
{Actor} published {Object} to {Target}.  
Create Draft

ecm_files.update.file.ecm.file.checkout

  • actor
  • eventType: EDIT
  • contentData:
    • Object - File Name
    • Target - Library name
    • Rollup ID - Version ID
{Actor} locked {Object} in {Target}.  
Create folder ecm_files.post.folder.ecm.folder.created
  • actor
  • eventType: EDIT
  • contentData:
    • Object - Folder Name
    • Target - Library Name
    • Rollup ID - Folder ID
{Actor} created the folder {Object} in {Target}.  
Edit folder's properties
ecm_files.update.folder.ecm.folder.updated
  • actor
  • eventType: EDIT
  • contentData:
    • Object - Folder Name
    • Target - Library Name
    • Rollup ID - Folder ID
{Actor} edited the folder {Object} in {Target}.  
Create a comment in draft review ecm_files.review.comment.ecm.review.comment.created
  • actor
  • eventType: DRAFT REVIEW
  • contentData:
    • Object - Comment Content
    • Target - File Name
    • Rollup ID - Version ID for draft comments
{Actor} commented on {Target}.  
Update a comment in draft review

ecm_files.update.comment.ecm.review.comment.updated

  • actor
  • eventType: DRAFT REVIEW
  • contentData:
    • Object - File Name
    • Target - Library Name
    • Rollup ID - Version ID for draft comments
{Actor} updated {Object} in {Target}.  
Draft is approved and published

ecm_files.approve.file.ecm.review.document.approved

  • actor
  • eventType: DRAFT REVIEW
  • contentData:
    • Object - none
    • Target - none
    • Rollup ID - Version ID
{Actor} published {Object} to {Target} This event removes the task.requested/required event from all Reviewers Action Required view based on the provided rollup ID
Draft cancelled

ecm_files.cancel.file.ecm.review.document.cancelled

  • actor
  • eventType: DRAFT REVIEW
  • contentData:
    • Object - File name
    • Target - Library name
    • Rollup ID - Version ID
{Actor} cancelled the review request of {Object} in {Target} This event removes the task.requested/required event from all Reviewers Action Required view based on the provided rollup ID
Rejection accepted

ecm_files.post.file.ecm.review.document.rejection_accepted

  • actor
  • eventType: DRAFT REVIEW
  • contentData:
    • Object - File Name
    • Target - Library Name
    • Rollup ID -Version ID
{Actor} cancelled the review request of {Object} in {Target} This event removes the task.requested/required event from all Reviewers Action Required view based on the provided rollup ID
Review requested

ecm_files.share.file.ecm.review.task.requested

  • actor
  • eventType: DRAFT REVIEW
  • contentData:
    • Object - File name
    • Target - n/a
    • Rollup ID - Version ID
{Actor} submitted {Object} in {Target} for review.  
Review required

ecm_files.update.file.ecm.review.task.required

  • actor
  • eventType: DRAFT REVIEW
  • contentData:
    • Object - File Name
    • Target - n/a
    • Rollup ID - Version ID
{Actor} submitted {Object} in {Target} for review.  
Submit a draft for review

ecm_files.share.file.ecm.review.document.submitted

  • actor
  • eventType: DRAFT REVIEW
  • contentData:
    • Object - File name
    • Target - n/a
    • Rollup ID -Version ID
{Actor} submitted {Object} in {Target} for review.  
An individual reviewer approves

ecm_files.approve.file.ecm.review.task.approved

  • actor
  • eventType: DRAFT REVIEW
  • contentData:
    • Object - File Name
    • Target - Library Name
    • Rollup ID - Version ID
{Actor} approved {Object} in {Target}.  
Reviewer vote no longer needed

ecm_files.cancel.file.ecm.review.task.cancelled

  • actor
  • eventType: DRAFT REVIEW
  • contentData:
    • Object - File Name
    • Target - Library ID
    • Rollup ID - Version ID
{Actor} cancelled the review request of {Object} in {Target}.  
An individual reviewer rejects

ecm_files.reject.file.ecm.review.document.rejected

  • actor
  • eventType: DRAFT REVIEW
  • contentData:
    • Object - File Name
    • Target - Library Name
    • Rollup ID - Version ID
{Actor} rejected {Object} in {Target}.  
change vote from reject (to approve)
Not Exposed via SPI
  • actor
  • eventType: DRAFT REVIEW
  • contentData:
    • Object - File Name
    • Target -Library name
    • Rollup ID - Version ID
{Actor} withdrew their review of {Object} in {Target}.  
change vote from approve (to reject)
Not Exposed via SPI
  • actor
  • eventType: DRAFT REVIEW
  • contentData:
    • Object - File Name
    • Target - Library Name
    • Rollup ID - Version ID
{Actor} withdrew their review of {Object} in {Target}.  
Comment on a file

ecm_files.post.comment.ecm.comment.created

  • actor
  • eventType: SOCIAL
  • contentData:
    • Object - Comment Content
    • Target - Document
    • Rollup ID - Version series ID
{Actor} commented on {Target}.  
Update a comment

ecm_files.update.comment.ecm.comment.updated

  • actor
  • eventType: SOCIAL
  • contentData:
    • Object - File Name
    • Target - Document
    • Rollup ID - Version series ID
{Actor} updated {Object} in {Target}  
Tag a file

ecm_files.tag.file.ecm.tag.created

  • actor
  • eventType: SOCIAL
  • contentData:
    • Object - File Name
    • Target -Tag name
    • Rollup ID - Version series ID
{Actor} tagged {Object} with {Target}. Although tag events are sent by FileNet, they are specifically filtered from the stream and from email notifications in Connections.
Like a file

ecm_files.like.file.ecm.recommendation.created

  • actor
  • eventType: SOCIAL
  • contentData:
    • Object - File Name
    • Target - Library name
    • Rollup ID - Version series ID
{Actor} liked {Object} in {Target}.  
Follow a file

ecm_files.follow.file.ecm.follow.created

  • actor
  • eventType: SOCIAL
  • contentData:
    • Object - File Name
    • Target - Library Name
    • Rollup ID - Version Series ID
N/A  
Unfollow a file

ecm_files.unfollow.file.ecm.follow.deleted

  • actor
  • eventType: SOCIAL
  • contentData:
    • Object - File Name
    • Target - Library Name
    • Rollup ID - Version series ID
N/A  
Move to trash - an entire version series is moved to the trash

ecm_files.delete.file.ecm.file.deleted

  • actor
  • eventType: DELETION
  • contentData:
    • Object - File Name
    • Target - Library name
    • Rollup ID - Version series ID
N/A  
Restore from trash - an entire version series is restored from the trash

ecm_files.update.file.ecm.file.restore

  • actor
  • eventType: DELETION
  • contentData:
    • Object - File Name
    • Target - Library name
    • Rollup ID - Version series ID
N/A  
Purge a file from the trash or hard delete

ecm_files.delete.file.ecm.file.purge

  • actor
  • eventType: DELETION
  • contentData:
    • Object - File Name
    • Target - Library name
    • Rollup ID - Version series ID
N/A  
Delete a specific version

ecm_files.delete.file.ecm.version.deleted

  • actor
  • eventType: DELETION
  • contentData:
    • Object - File Name
    • Target - Library name
    • Rollup ID - Version ID
N/A  
Delete a specific comment

ecm_files.delete.comment.ecm.comment.deleted

  • actor
  • eventType: DELETION
  • contentData:
    • Object - File Name
    • Target - Document
    • Rollup ID - Version series ID
N/A  
Delete a tag

ecm_files.delete.tag.ecm.tag.deleted

  • actor
  • eventType: DELETION
  • contentData:
    • Object - Tag
    • Target - Document
    • Rollup ID - Tag ID
N/A  
Unlike a file (remove a recommendation)

ecm_files.unlike.file.ecm.recommendation.deleted

  • actor
  • eventType: DELETION
  • contentData:
    • Object - File
    • Target - Library
    • Rollup ID - Version series ID
N/A  
Delete a folder

ecm_files.delete.folder.ecm.folder.deleted

  • actor
  • eventType: DELETION
  • contentData:
    • Object - FolderName
    • Target - Library name
    • Rollup ID - Folder ID
N/A  
Share a file with you (a user is added to the access control of a document or has their role changed) Not Available
  • actor
  • eventType: SHARING
  • contentData:
    • Object - File
    • Target - Library
    • Rollup ID - Version Series ID
{Actor} shared {Object} in {Target}  
Unshare a file with you Not Available
  • actor
  • eventType: SHARING
  • contentData:
    • Object - File
    • Target - Library
    • Rollup ID - Version series ID
N/A  
Share a folder with you  (a user is added to the access control of a folder or has their role changed) Not Available
  • actor
  • eventType: SHARING
  • contentData:
    • Object - Folder
    • Target - Library
    • Rollup ID - Folder ID
{actor} shared the folder {folder} in  {community} with you.  
Unshare a folder with you Not Available
  • actor
  • eventType: SHARING
  • contentData:
    • Object - Folder
    • Target - Library
    • Rollup ID - Folder ID
N/A  
Download a file ecm_files.access.file.ecm.file.downloaded
  • actor
  • eventType: DOWNLOAD
  • contentData:
    • Object - File
    • Target - n/a
    • Rollup ID - n/a
N/A Download events are not available in the Connections Event SPI when Connections Content Manager uses an existing FileNet deployment.