Administering community queued events

app_server_root\profiles\dm_profile_root\bin

You must start the client from this directory or subsequent commands that you enter will not execute correctly.

execfile("communitiesAdmin.py")

• To retrieve a list of the events currently queued for processing, use the following commands:

  CommunitiesQEventService.viewQueuedEventsSummary()

  Lists a summary of all of the lifecycle replay events that are currently queued for processing.

  CommunitiesQEventService.viewQueuedEventsByResourceType(String resourceType, HashMap lastEvent, int maxRows)

  Lists the queued lifecycle replay events with the specified resource type, where:

  • resourceType is the string "community".
  • lastEvent specifies the last row of the previous batch. This parameter is a HashMap object. To obtain the first batch, specify None.
  • maxRows is the number of rows to be retrieved and viewed with a single command. Use maxRows when there are many rows, 200, for example, to break up both the database reads and the display into batches.

  For example:

  CommunitiesQEventService.viewQueuedEventsByResourceType("community", None, 100)

  This command returns a HashMap that is the last viewed row. When there are no more rows, the value None is returned. This parameter makes it straightforward to loop over all rows a few rows at a time.

  For example, you might use the following Jython code to display all queued events of resourceType community in batches of 10 when there are 200 events:

  lastRow = CommunitiesQEventService.viewQueuedEventsByResourceType
     ("community", None, 10)
     while (lastRow != None)
     lastRow = CommunitiesQEventService.viewQueuedEventsByResourceType
     ("community", lastRow, 10)

  CommunitiesQEventService.viewQueuedEventsByResourceId(String resourceType, String resourceId, HashMap lastEvent, int maxRows)

  Lists the queued lifecycle replay events with the specified resource type and resource ID, where:

  • resourceType is the string "community".
  • resourceId is the communityUuid. This parameter is a string.
  • lastEvent is a HashMap object.
  • maxRows is the number of rows to be retrieved and viewed with a single command. Use maxRows when there are many rows, 200, for example, to break up both the database reads and the display into batches.

  This command returns a HashMap, which is the last viewed row. When there are no more rows, the value None is returned. This parameter makes it straightforward to loop over all rows a few at a time.

  For example:

  CommunitiesQEventService.viewQueuedEventsByResourceId
      ("community", "e952cf0c-a86c-4e26-b1e0-f8bf40a75804", None, 100)

  For example, you might use the following Jython code to display all queued events of resourceType "community" and resourceId b46300c7-7837-4ba3-b26b-3fcf67a75bba, in batches of 10 when there are 200 entries:

  lastRow = CommunitiesQEventService.viewQueuedEventsByResourceId
     ("community", "b46300c7-7837-4ba3-b26b-3fcf67a75bba", None, 10)
  while (lastRow != None)
  lastRow = CommunitiesQEventService.viewQueuedEventsByResourceId
     ("community", "b46300c7-7837-4ba3-b26b-3fcf67a75bba", None, 10)

  CommunitiesQEventService.viewQueuedEventsByRemoteAppDefId(String remoteAppDefId, HashMap lastEvent, int maxRows)

  Lists the queued lifecycle replay events that are associated with the specified remote application ID, where:

  • remoteAppDefId is one of the following: Activities, Blog, IdeationBlog, Files, Forum, Wiki, and StatusUpdates. The application IDs are case-sensitive and must be entered as indicated in this documentation.
  • lastEvent specifies the last row of the previous batch. This parameter is a HashMap object. To obtain the first batch, specify None.
  • maxRows is the number of rows to be retrieved and viewed with a single command. Use maxRows when there are many rows, 200, for example, to break up both the database reads and the display into batches.

  This command returns a HashMap that is the last viewed row. When there are no more rows, the value None is returned. This parameter makes it straightforward to loop over all rows a few at a time.

  For example:

  CommunitiesQEventService.viewQueuedEventsByRemoteAppDefId("Blog", None, 100)

  To display all queued events of remoteAppDefId type Activities in batches of 10, when there are 200 entries, you might code in Jython:

  lastRow = CommunitiesQEventService.viewQueuedEventsByRemoteAppDefId
    ("Activities", None, 10) while (lastRow != None)
  lastRow = CommunitiesQEventService. viewQueuedEventsByRemoteAppDefId
    ("Activities", lastRow, 10)

  CommunitiesQEventService.viewQueuedEventsByRemoteAppDefIdAndEventType(String remoteAppDefId, String eventType, HashMap lastEvent, int maxRows)

  Lists the queued lifecycle replay events that are associated with the specified remote application ID, where:

  • remoteAppDefId is one of the following: Activities, Blog, IdeationBlog, Files, Forum, Wiki, and StatusUpdates. The application IDs are case-sensitive and must be entered as indicated in this documentation.
  • eventType specifies the event type to limit the query to.
  • lastEvent specifies the last row of the previous batch. This parameter is a HashMap object. To obtain the first batch, specify None.
  • maxRows is the number of rows to be retrieved and viewed with a single command. Use maxRows when there are many rows, 200, for example, to break up both the database reads and the display into batches.

  This command returns a HashMap that is the last viewed row for the specified event type. When there are no more rows, the value None is returned. This parameter makes it straightforward to loop over all rows a few at a time.

  For example:

  CommunitiesQEventService.viewQueuedEventsByRemoteAppDefIdAndEventType("Blog", "community.updated", None, 100)

  To display all queued events of remoteAppDefId type Activities in batches of 10, when there are 200 entries, you might code in Jython:

  lastRow = CommunitiesQEventService.viewQueuedEventsByRemoteAppDefIdAndEventType
    ("Activities", "community.updated", None, 10) 
  while (lastRow != None)
  lastRow = CommunitiesQEventService.viewQueuedEventsByRemoteAppDefIdAndEventType
    ("Activities", "community.updated", lastRow, 10)

• Use the following commands to retry events that failed to process. After you run one of these commands, run the CommunitiesQEventService.viewQueuedEventsByResourceType command to make sure that the queue is empty. In some rare cases it might be necessary to run a retryQueuedEvents command multiple times to process and remove all events:

  CommunitiesQEventService.retryQueuedEventsByResourceType(String resourceType)

  Retries queued lifecycle replay events with the specified resource type, where resourceType is a string. The value of resourceType is always "community".

  The return value is either "retry succeed" or 0. 0 indicates failure.

  For example:

  CommunitiesQEventService.retryQueuedEventsByResourceType("community")

  CommunitiesQEventService.retryQueuedEventsByResourceId(String resourceType, String resourceId)

  Retries queued lifecycle replay events with the specified resource type and resource ID, where resourceType and resourceId are both strings.

  The resourceType parameter is always set to "community". The resourceId parameter is a value that can be obtained by using one of the CommunitiesQEventService.viewQueuedEvents commands.

  The return value is either 1 or 0. 1 indicates success; 0 indicates failure.

  For example:

  CommunitiesQEventService.retryQueuedEventsByResourceId("community", 
       "e952cf0c-a86c-4e26-b1e0-f8bf40a75804")

  CommunitiesQEventService.retryQueuedEventsByRemoteAppDefId(String remoteAppDefId)

  Retries queued lifecycle replay events with the specified associated application ID, where remoteAppDefId is one of the following: Activities, Blog, IdeationBlog, Files, Forum, Wiki, and StatusUpdates. The application IDs are case-sensitive and must be entered as indicated in this documentation.

  The return value is either 1 or 0. 1 indicates success; 0 indicates failure.

  For example:

  CommunitiesQEventService.retryQueuedEventsByRemoteAppDefId("Wiki")

• Use the following commands to clear the queue of events that waiting to be processed. For example, if your organization has communities that have activities that are associated with them and you uninstall the Activities application from your deployment, you need to purge Activities events so that they aren't perpetually retried. Use these commands with care.

  CommunitiesQEventService.clearQueuedEventsByResourceType(String resourceType)

  Clears queued lifecycle replay events with the specified resource type, where resourceType is a string. The events are removed from the queue and are not processed.

  The resourceType parameter is always "community".

  The return value is the number of events that were cleared.

  For example:

  CommunitiesQEventService.clearQueuedEventsByResourceType("community")

  CommunitiesQEventService.clearQueuedEventsByResourceId(String resourceType, String resourceId)

  Clears queued lifecycle replay events with the specified resource ID, where resourceType and resourceId are both strings. The events are removed from the queue and are not processed.

  The resourceType parameter is always set to "community". The resourceId parameter is a value that can be obtained by using one of the CommunitiesQEventService.viewQueuedEvents commands.

  The return value is the number of events that were cleared.

  For example:

  CommunitiesQEventService.clearQueuedEventsByResourceId("community", 
       "e952cf0c-a86c-4e26-b1e0-f8bf40a75804")

  CommunitiesQEventService.clearQueuedEventsByRemoteAppDefId(String remoteAppDefId)

  Clears queued lifecycle replay events with the specified associated application ID, where remoteAppDefId is one of the following: Activities, Blog, IdeationBlog, Files, Forum, Wiki, and StatusUpdates. The application IDs are case-sensitive and must be entered as indicated in this documentation.

  The return value is the number of events that were cleared.

  For example:

  CommunitiesQEventService.clearQueuedEventsByRemoteAppDefId("Wiki")

  CommunitiesQEventService.clearQueuedEventByEventId(String eventId)

  Clears queued lifecycle replay events with the specified event ID, where eventId is a string. The events are removed from the queue and are not processed.

  The return value is the number of events that were cleared.

  For example:

  CommunitiesQEventService.clearQueuedEventsByEventId
      ("2d93497d-065a-4022ae25-a4b52598d11a")