IBM Connections Event Reference - Files
Added by IBM contributorIBM | Edited by IBM contributordeveloperWorks Lotus Team on July 8, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

No abstract provided.
Files Events

Event data is provided using the following conventions. Refer to the Event_SPI_ic50Create 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.

  • The event can be shared for Personal Files (PF) or Community Files (CF). If not specified, the field of an event can be applied for both PF and CF, unless the whole event is only valid for PF or CF.
  • For deleted resources, we do not include content across the product (for example, file attachments) but do include the URLs. However, these may always be 404s.
  • For wsadmin commands, all the modified data is covered in individual events (for example, policy changes are explicitly sent, bulk deletes actually iterate through the deleted items and generate events for them). library.delete/etc. cover that, ...)
  • We do not currently use groupACL for scoping events, as we only target them at individuals or communities.
  • isPublic is changed to scope in IBM® Lotus® Connections 3.
  • When pre-moderation is enabled, media create/update operations will have a different behavior for sending events for associated resources, for example, collection with file added, notification settings for file, etc.
  • When a file is created and pended automatically, events for all associated resources are not sent. When the file is approved, events for all associated resources are sent with the file's create event and approve event.
  • When a file is edited and pended automatically, events for all associated resources are sent.
  • This list does not contain events specific to moderation. For these events see IBM Connections Event Reference - Moderation - Files.

The event data is provided using the following conventions. Refer to the IBM_Connections_4.5_Event_SPI_ic50Create 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.

  • actor: The Person object who triggered the event as the event Actor.
  • container: The container in which the event was triggered.
  • targetingData: The targets that the event is applied to.
  • itemData: Item details for the event.
  • contentData: Content details for the event, such as tags.
  • correlationData: The correlation information that the event may have.
  • notificationData: The email notification data for the event.
  • scope: The scope of the event.
  • attachmentData: Attachment data for the event as binary stream.
  • membershipData: Membership data for any membership events.
  • @propertyName: Property value in the property object.

5.0 improvements:
  • isExternal - If the Item or Correlation Data is Library, Media, Collection, it is true if SharingIntent is external, otherwise is false.

All Files events have the following common event data:

  • eventSource: FILES
Event Name
Field Data
Description
Comments
files.file.share.created(PF)
  • actor:
    scope: Visibility of file
    container: Library
    itemData: File
  • contentData:
    • content: Share summary
    • contentType: Text
  • targetingData:
    • targetPeople: {users shared with, owner if not actor}
  • @file.creator.externalId
  • scopeData.personACL(PF && scope<=NONPUBLIC): {actor, owner, users shared with}
Generated when a file is shared with one or more users.

personACL is set only when file is not public.

Only applies to Personal Files.
files.file.created
  • actor
  • scope: File visibility
  • container: Library
    itemData: File
  • contentData: Media summary
    • contentType: Text
  • AttachmentData: relativeFilePath:
  • tags:
  • targetPeople: {owner not actor}
  • @creator.externalId
  • @versionNumber: Current version number
  • @currentRevisionId: ID of current revision
  • scopeData.personACL(PF && scope<=NONPUBLIC): {actor}
  • relatedCommunity (CF)
Generated when a file is created/uploaded.
files.file.updated
  • actor:
  • scope: File visibility
  • container: Library
  • itemData: File
  • contentData: Revision summary
    • contentType: Text
  • AttachmentData: relativeFilePath:
  • tags
    targetPeople: {owner not actor}
  • followers: Users following the file
  • @creator.externalId
  • @versionNumber: Current version number
  • @currentRevisionId: ID of current revision
  • @contentUpdated: true indicating file content change. false indicating meta-data change.
  • scopeData.personACL (PF && scope<=NONPUBLIC): {owner, actor, followers}
  • relatedCommunity(CF)
Generated when a file is updated.
[3.0] files.file.tag.added
  • actor:
  • scope: File visibility
  • container: Library
  • itemData: File
  • tags
  • targetPeople: {owner not actor}
  • followers: Users following the file
  • @file.creator.externalId
  • @file.versionNumber: Current version number of the file
  • scopeData.personACL (PF && scope<=NONPUBLIC): {owner, actor }
  • relatedCommunity(CF)
Generated when a user adds a tag or set of tags to a file.
files.file.recommend.created
  • actor:
    scope: File visibility
  • container: Library
  • itemData: File
  • targetPeople: {owner not actor}
  • followers: Users following the file
  • @file.creator.externalId
  • @file.versionNumber: Current version number of the file
  • scopeData.personACL (PF && scope<=NONPUBLIC): {owner, actor }
  • relatedCommunity (CF)
Generated when a user recommends a file.
files.file.comment.created
  • actor:
  • scope: File visibility
  • container: Library
  • itemData: Comment
  • contentData: Comment
  • contentType: Text
  • CorrelationData: File
    targetPeople: {owner not actor }
  • followers: Users following the file
  • @file.creator.externalId
  • scopeData.personACL (PF && scope<=NONPUBLIC): {owner, actor, followers}
  • relatedCommunityUUID (CF)
Generated when a comment is added to a file.
files.collection.created
  • actor:
  • scope: Collection visibility
  • container: Collection
  • itemData: Collection
  • contentData: Collection summary
  • contentType: Text
  • targetPeople: {owner not actor}
  • @creator.externalId
  • scopeData.personACL (PF && scope<=NONPUBLIC): {owner}
  • relatedCommunityUUID (CF)
Generated when a collection is created.

containerId is the UUID of the collection.

This occurs when files are shared with a community for the first time, or the community Files widget is added.
files.collection.updated
  • actor:
  • scope: Collection visibility
  • container: Collection
  • itemData: Collection
  • contentData: Collection summary
  • contentType: Text
  • targetPeople: {owner not actor}
  • @creator.externalId
  • scopeData.personACL (PF && scope<=NONPUBLIC): {actor, owner}
  • relatedCommunityUUID (CF)
Generated when a collection is edited.

containerId is the UUID of the collection.

files.collection.membership.updated
  • actor:
  • scope: Collection visibility
  • container: Collection
  • itemData: Collection
  • MembershipData: People Added/Removed; groupsAdded/Removed
  • targetPeople: {owner but actor, affected users}
  • targetGroups: {affected groups}
  • @creator.externalId
  • scopeData.personACL(PF && scope<=NONPUBLIC): {actor, owner, affected users}
  • groupACL(scope<=NONPUBLIC): {affected groups}
Generated when the role for a person, group, community, or pseudo-group is added or updated.

For communities, no event is sent for the owner, as it is a system user.

Pseudo-groups include READER_ROLE and PERSON_ROLE, which indicate what users in the Lotus Connections reader and person roles can do. A public collection will map READER_ROLE to the collection reader role, and PERSON_ROLE may be mapped to the contributor role if all persons can contribute.

files.collection.deleted
  • actor:
    scope: Collection visibility
  • container: Collection
  • itemData: Collection
  • contentData: Collection summary
  • contentType: Text
  • targetPeople: {owner not actor}
  • @creator.externalId
  • relatedCommunityUUID (CF)
Generated when a collection is deleted.
This also occurs when a community is deleted if files have been shared with the community.
files.collection.file.added
  • actor:
  • scope: Collection visibility
  • container: Collection
    itemData: File
  • ContentData: ShareSummary
  • targetPeople: {owner not actor}
  • followers: Users following the collection
  • @file.summary: Summary of file
  • @file.creator.externalId
  • scopeData.personACL(PF && scope<=NONPUBLIC): {actor, owner, followers}
  • relatedCommunity (CF)
Generated when a file is added to a collection.
files.collection.file.updated
  • actor:
  • scope: Collection visibility
  • container: Collection
    itemData: File
  • ContentData: ShareSummary
  • targetPeople: {owner not actor}
  • followers: Users following the collection
  • @file.summary: Summary of file
  • @file.creator.externalId
  • scopeData.personACL(PF && scope<=NONPUBLIC): {actor, owner, followers}
  • relatedCommunity (CF)
Generated when the access changed for the file which is in a collection
Updated in 5.0
files.collection.file.removed
  • actor:
  • scope: Collection visibility
  • container: Collection
    itemData: File
  • targetPeople: {owner not actor}
  • @file.summary: Summary of file
  • @file.creator.externalId
  • scopeData.personACL(PF && scope<=NONPUBLIC): {actor, owner}
  • relatedCommunity (CF)
Generated when a file is removed from a collection.
files.file.version.deleted
  • actor:
  • scope: File visibility
  • container: Library
    itemData: File version
    CorrelationData: File
  • targetPeople: {owner not actor}
  • @versionNumber: Current version
  • scopeData.personACL (PF && scope<=NONPUBLIC): {owner, actor}
  • relatedCommunity(CF)
Generated when one or more versions of a file are deleted.
files.file.version.restored
  • actor:
  • scope: File visibility
  • container: Library
    itemData: File version
    CorrelationData: File
  • targetPeople: {owner not actor}
  • @versionNumber: Current version
  • scopeData.personACL (PF && scope<=NONPUBLIC): {owner, actor}
  • relatedCommunity(CF)
Generated when a version is restored.
files.file.notification.set
  • actor:
  • scope: File visibility
  • container: Library
  • CorrelationData: File
  • targetPeople: {owner but not actor}
  • @subscriber.externalId
  • scopeData.personACL (PF && scope<=NONPUBLIC): {owner, actor}
  • relatedCommunity(CF)
Generated when a notification setting is set for the file.
files.file.notification.unset
  • actor:
  • scope: file visibility
  • container: library
  • CorrelationData: file
  • targetPeople: {owner but not actor}
  • @subscriber.externalId
  • scopeData.personACL (PF && scope<=NONPUBLIC): {owner, actor}
  • relatedCommunity(CF)
Generated when a notification setting is deselected for the file.
files.collection.notification.set
  • actor:
  • scope: Collection visibility
  • container: Collection
  • CorrelationData: Collection
  • targetPeople: {owner but not actor}
  • @subscriber.externalId:
  • scopeData.personACL (PF && scope<=NONPUBLIC): {owner, actor}
  • relatedCommunity (CF)
Generated when a notification setting is set for a collection.
files.collection.notification.unset
  • actor:
  • scope: Collection visibility
  • container: Collection
  • CorrelationData: Collection
  • targetPeople: {owner but not actor}
  • @subscriber.externalId:
  • scopeData.personACL (PF && scope<=NONPUBLIC): {owner, actor}
  • relatedCommunity (CF)
Generated when a notification setting is deselected for a collection.
files.file.comment.updated
  • actor:
  • scope: File visibility
  • container: Library
  • itemData: Comment
  • contentData: Comment
  • contentType: Text
  • CorrelationData: File
    targetPeople: {owner not actor}
  • @file.creator.externalId
  • scopeData.personACL (PF && scope<=NONPUBLIC): {owner, actor}
  • relatedCommunity(CF)
Generated when a comment on a file is edited.
files.file.comment.deleted
  • actor:
  • scope: File visibility
  • container: Library
  • itemData: Comment
  • CorrelationData: File
  • targetPeople: {owner not actor}
  • @file.creator.externalId
  • scopeData.personACL (PF && scope<=NONPUBLIC): {owner, actor}
  • relatedCommunity(CF)
Generated when a comment on a file is deleted.
files.file.deleted
  • actor
  • scope: File visibility
  • container: Library
  • itemData: File
  • container: Library
  • targetPeople: {owner but actor}
  • @creator.externalId
  • @permanentlyDeleted: true/false
  • scopeData.personACL(PF && scope<=NONPUBLIC): {owner, actor}
  • relatedCommunity (CF)
Generated when a file is deleted permanently or moved to the recycle bin.
@permanent.delete is set only when a file is permanently deleted if trash is disabled or otherwise user choose not moving to trash.
files.trash.emptied(PF)
  • actor
  • scope: Library visibility
  • container: Library
  • targetPeople: {library owner but actor}
Generated when trash is emptied.
The trash is per library. This is now only supported by PF.
files.file.purged
  • actor:
  • scope: File visibility
  • container: Library
  • itemData: File
  • targetPeople: {owner but actor}
  • @creator.externalId
  • scopeData.personACL(PF && scope<=NONPUBLIC): {owner, actor}
  • relatedCommunity (CF)
Generated when a file is permanently deleted from the recycle bin.
files.file.undeleted
  • actor
  • scope: File visibility
  • container: Library
  • itemData: File
  • targetPeople: {owner but actor}
  • @creator.externalId
  • @versionNumber: Current version number
  • @currentVersionId: ID of current version
  • scopeData.personACL(PF && scope<=NONPUBLIC): {owner, actor}
  • relatedCommunity (CF)
Generated when a file is restored from the recycle bin.
files.policy.added
  • actor:
  • scope: NONPUBLIC
  • itemData: Policy
  • @maximumSize
Generated when the wsadmin command FilesPolicyService.add() is run.
files.policy.updated
  • actor:
  • scope: NONPUBLIC
  • itemData: Policy
  • @maximumSize
Generated when the wsadmin command FilesPolicyService.edit() is run.

Can cover editing the default policy, for example, when FilesPolicyService.editCommunityDefault() is run.

files.policy.deleted
  • actor:
  • scope: NONPUBLIC
  • itemData: Policy
  • @maximumSize
Generated when an admin deletes a policy.
files.library.created
  • actor:
  • scope: Public (PF) | Community (CF)
  • container: Library
  • itemData: Library
  • contentData: Library summary
  • contentType: Text
  • targetPeople: {owner but actor}
  • @creator.externalId
  • @type:
  • @policy.id
  • @externalInstanceId(CF)
  • relatedCommunityUUID (CF)
Generated when a library is created.
files.library.updated
  • actor:
  • scope: Public (PF) | Community (CF)
  • container: Library
  • itemData: Library
  • contentData: Library summary
  • contentType: Text
  • targetPeople: {owner but actor}
  • @creator.externalId
  • @type:
  • @policy.id
  • @externalInstanceId (CF)
  • relatedCommunityUUID (CF)
Generated when a library is updated.
files.library.deleted
  • actor:
  • scope: Public (PF) | Community (CF)
  • container: Library
  • itemData: Library
  • targetPeople: {owner but actor}
  • @creator.externalId
  • @type:
  • @policy.id
  • @externalInstanceId (CF)
  • relatedCommunityUUID (CF)
Generated when a library is deleted.
files.library.membership.updated (CF)
  • actor
  • scope: Community
  • container: Library
  • itemData: Library
  • targetPeople: {owner but actor, affected users}
  • targetGroup: {affected groups}
  • groupAdded/Removed
  • @creator.externalId
  • relatedCommunityUUID (CF)
Generated when the role for a person, group, community, or pseudo-group is added or updated.

For communities, no event is sent for the owner, as it is a system user.

The pseudo-group READER_ROLE is used to indicate what users in the Lotus Connections reader role can do. A public community will map READER_ROLE to the collection reader role.

This event is not sent for personal files, as the default state of READER_ROLE having the reader role on the library is the only state this is currently possible.

files.additionalfile.created
  • actor:
  • scope: Parent file visibility
  • container: Library
  • itemData: Additional file
  • contentData: Additional file summary
  • contentType: Text
  • targetPeople: {file owner but actor}
  • CorrelationData: File
  • AttachmentData: relativeFilePath
  • scopeData.personACL (PF && scope<=NONPUBLIC): {owner, actor}
    relatedCommunityUUID (CF)
Generated when an additional file is created, which is not currently possible via the user interface.
One event is generated for each additional file, though there is a method for bulk creating. It is the listener's responsibility to aggregate them.
files.additionalfile.updated
  • actor:
  • scope: Parent file visibility
  • container: Library
  • itemData: Additional file
  • contentData: Additional file summary
  • contentType: Text
  • targetPeople: {file owner but actor}
  • CorrelationData: File
  • AttachmentData: relativeFilePath
  • @contentUpdated: true/false
  • scopeData.personACL (PF && scope<=NONPUBLIC): {owner, actor}
    relatedCommunityUUID (CF)
Generated when an additional file is updated, which is not currently possible via the user interface.
One event is generated for each additional file, though there is a method for bulk updating. It is the listener's responsibility to aggregate them.
files.additionalfile.deleted
  • actor:
  • scope: Parent file visibility
  • container: Library
  • itemData: Additional file
  • targetPeople: {file owner but actor}
  • CorrelationData: File
  • scopeData.personACL (PF && scope<=NONPUBLIC): {owner, actor}
    relatedCommunityUUID (CF)
Generated when an additional file is deleted, which is not currently possible via the user interface.
One event is generated for each additional file, though there is a method for bulk deleting. It is the listener's responsibility to aggregate them.
files.file.membership.updated (PF)
  • actor:
  • scope: File visibility
  • container: Library
  • itemData: File
  • MembershipData: People added/removed;
  • targetPeople: {owner but actor, affected users}
  • @creator.externalId
  • scopeData.personACL(PF && scope<=NONPUBLIC): {actor, owner, affected users}
Generated when the permission for a person or pseudo-group is added or updated.

For communities, no event is sent as today there is no per-file permission supported.

The psuedo-group READER_ROLE is used to indicate what users in the Lotus Connections reader role can do. A public file will map READER_ROLE to the reader role.

files.file.tag.deleted
  • actor:
  • scope: File visibility
  • itemData: File
  • container: Library
  • tags
  • targetPeople: {owner not actor}
  • @file.creator.externalId
  • @file.versionNumber: Current version number of the file
  • scopeData.personACL (PF && scope<=NONPUBLIC): {owner, actor }
  • relatedCommunity(CF)
Generated when a file's tag is deleted.
files.file.recommend.deleted
  • actor:
    scope: File visibility
  • containter: Library
    itemData: File
    targetPeople: {owner not actor}
  • @file.creator.externalId
  • @file.versionNumber: Current version number of the file
  • scopeData.personACL (PF && scope<=NONPUBLIC): {owner, actor }
  • relatedCommunity (CF)
Generated when a recommendation is deleted.
files.file.takenInternal(5.0+)
actor:
scope: visibility of file
container: library
item: file
targetPeople: {owner not actor}

@file.creator.externalId

personaACL(PF && scope<=NONPUBLIC): {actor, owner}

@fileSize: the file size of this media

attributes of the ItemDetails:

Tags :the full list of tags associated with media
Number of comments and recommendations
Scope: scope of the media
Last update: lastUpdateDate of the media
author(s): media owner
content: media summary

Generated when file sharing intent changed from external to internal
added in 5.0(Only For SmartCloud)
files.file.comment.notification.mention(5.0+)
actor:
scope: file visibility
container: library
item: comment(including mentioned people)
content: comment
contentType: html
CorrelationData: file(including mentioned people)
targetPeople: {owner not actor }
followers: users following the file

@file.creator.externalId

personACL (PF && scope<=NONPUBLIC): {owner, actor, followers}
relatedCommunityUUID (CF)

@fileSize: the file size of the related media
Scope: scope of the event
Last update: last updateDate of the media
author(s): comment owner
content: comment content

The new attributes of the CorrelationData:

Tags :the full list of tags associated with media
Number of comments and recommendations
Scope: scope of the media
Last update: lastUpdateDate of the media
author(s): media owner

@objectType.id


@objectType.localName

@objectType.localNamespace

added in 5.0
files.command.createthumbnail(5.0+)
actor:
scope: visibility of file
container: library
item: file

LC Future events
files.file.draft.created
  • actorExtID
  • scope: NONPUBLIC
  • itemDataHTMURL: draft url
    itemDataAtomURL: draft url
    scopeData.personACL(PF && scope<=NONPUBLIC): {actor}
  • relatedCommunityUUID (CF)
  • itemDataCorrelationID: parent file UUID
  • itemDataCorrelationName: parent file title
  • itemDataCorrelationHTMLPath: parent file HTML url
  • @creator.externalId(PF)
Generated when a file draft is created.
files.file.draft.updated
  • actorExtID
  • scope: NONPUBLIC
    itemDataHTMURL: draft url
    itemDataAtomURL: draft url
    targetSubjectExtIDs: {owner not actor}
  • scopeData.personACL (PF && scope<=NONPUBLIC): {owner, actor}
  • relatedCommunityUUID (CF)
  • itemDataCorrelationID: parent file UUID
  • itemDataCorrelationName: parent file title
  • itemDataCorrelationHTMLPath: parent file HTML url
  • @creator.externalId (PF)
Generated when a file draft is updated, which includes the change of moderation status.
files.file.draft.deleted
  • actorExtID
  • scope: NONPUBLIC
    ? itemDataHTMURL:
    ? itemDataAtomURL:
  • scopeData.personACL (PF && scope<=NONPUBLIC): {actor, owner}
    targetSubjectExtIDs (PF && scope<=NONPUBLIC): {owner not actor}
  • itemDataCorrelationID: parent file UUID
  • itemDataCorrelationName: parent file title
  • itemDataCorrelationHTMLPath: parent file
  • labelrelatedCommunityUUID (CF)
  • relativeFilePath
  • @creator.externalId
Generated when a file draft is deleted by a user, excluding deletion caused by publishing.
files.file.draft.published
  • actorExtID
  • scope: NONPUBLIC
    ? itemDataHTMURL:
    ? itemDataAtomURL:
  • scopeData.personACL (PF && scope<=NONPUBLIC): {actor, owner, notified user of parent}
    targetSubjectExtIDs (PF && scope<=NONPUBLIC): {owner not actor, notified user of parent}
  • itemDataCorrelationID: parent/created file UUID
  • itemDataCorrelationName: parent/created file title
  • itemDataCorrelationHTMLPath: parent file
  • labelrelatedCommunityUUID (CF)
  • @creator.externalId
Generated when a file draft is published. A file.created or file.updated event will also be fired following this event.

This event is just to indicate that a draft is published.

A draft can be published whether it has a parent file or not.