+

Search Tips   |   Advanced Search

Activities administrative commands


ActivitiesMemberService


ActivitiesMemberService.fetchCommunitiesByName (java.lang.String name)

Return a list of communities with names that begin with the specified string. Returns java.util.Vector object; each object in the vector is a java.util.Hashtable object describing one community.

name The name of a community. We can provide the first word or words, and any communities with names that begin with that word or words is returned. For example, "Sales community".

This command was added in version 2.5.


ActivitiesMemberService.fetchMemberByEmail(java.lang.String mail)

Fetch member matching the supplied email address. Returns java.util.Hashtable object describing the member.

mail A member's email address specified as a String value. For example, "paul_smith@myco.com".


ActivitiesMemberService.fetchMemberById(java.lang.String id)

Fetch member matching the supplied Activities ID. The member can be either an individual user or a group. Returned value is a java.util.Hashtable object describing the member.

id The member's unique ID as issued by the Activities application. String For example, "ACF1093191092345B4DB336C9B5BF9".


ActivitiesMemberService.fetchMemberByLogin(java.lang.String name)

Fetch member whose login name is an exact match of the supplied login name. Returned value is a java.util.Hashtable object describing the member. This command does not return groups.

name The login name specified as a String value. For example, "Paul Smith".


ActivitiesMemberService.fetchMemberByName(java.lang.String name)

Fetch member whose name is an exact match of the supplied name. This command returns both users and groups. Returned value is a java.util.Hashtable object describing the member.

name The member or group name specified as a String value. For example, "Paul Smith".


ActivitiesMemberService.fetchMembers(java.lang.String filter)

Return a set of members whose names match the string we specify. Each member can be either an individual user or a group. The set is returned as a java.util.Vector object. Each object in the vector is a java.util.Hashtable object describing one member.

filter Search query string; indicate a wildcard using an asterisk (*). The string is case insensitive.

For example, the following command returns any user or group whose name ends with "Smith":


ActivitiesMemberService.getMemberExtIdByEmail("email")



ActivitiesMemberService.getMemberExtIdByLogin("login")



ActivitiesMemberService.inactivateMemberByEmail("email")



ActivitiesMemberService.inactivateMemberByExtId("externalID")



ActivitiesMemberService.syncAllMembersByExtId({"updateOnEmailLoginMatch": ["true" | "false"] } )



ActivitiesMemberService.syncAllMemberExtIds()

This command was deprecated in version 3. See Sync user data with administrative commands for information about the new and updated synchronization commands we can use instead.


ActivitiesMemberService.syncBatchMemberExtIdsByEmail("emailFile" [, {"allowInactivate" : ["true" | "false"] } ])



ActivitiesMemberService.syncBatchMemberExtIdsByLogin("loginFile" [, {"allowInactivate" : ["true" | "false"] } ])



ActivitiesMemberService.syncMemberByExtId("currentExternalId" [, { "newExtId" : "id-string", [ { "allowExtIdSwap" : ["true" | "false"] ] } ])



ActivitiesMemberService.syncMemberExtIdByEmail("email" [, {"allowInactivate" : ["true" | "false"] } ])



ActivitiesMemberService.syncMemberExtIdByLogin("name" [, {"allowInactivate" : ["true" | "false"] } ])



ActivityService

ActivityService.deleteActivities (java.util.Vector activities)

Move the specified activities to the Trash view. Activities in the Trash view can be restored as long as they are restored before the trash is emptied. Return a java.util.Vector. Each object in the vector is a java.util.Hashtable describing one activity that could not be deleted. A returned empty vector indicates complete success.

activities Vector of hash tables describing the activities to be deleted. For example, joesactivities.


ActivityService.exportSyncedResourceInfo (filePath,eventType)

List all of the community activities and identify associated communities. The file is saved to the directory path specified.

filePath String that specifies the full directory path to store the file returned by the command. Include the file name in the file path and use forward slashes. For example: "/tmp/activity_output.xml"
eventType Type of synchronization events to report about. Only supported value is community. Specify as a singular community and in lowercase.


temp/activity_output.xml","community"

ActivityService.fetchActivities() Fetch a list of all the activities, except those in the Trash view.

Return a java.util.Vector object. Each object in the vector is a java.util.Hashtable object describing one activity.


ActivityService.fetchActivitiesByCommunityExId (java.lang.String communityUUID)

Fetch a list of the community activities associated with a specific community. Return a java.util.Vector. Each object in the vector is a java.util.Hashtable describing a community activity.

communityUUID The unique ID of the community. For example, "f29b4e8e-6fad-44f4-9fca-58c46f29c38d". To find out the unique ID of a community, use ActivitiesMemberService.fetchCommunitiesByName to retrieve the community of interest, and then get the value of the externalId key of that community from the hashtable.

This command was added in version 2.5.


ActivityService.fetchActivitiesByDate(java.lang.String dateType, java.lang.String beginTime, java.lang.String endTime, java.lang.String lastUUID)

Fetch a list of activities created or modified between a date range. The maximum number of activities in the returned list is 50. To obtain all of the activities that match the criteria if the number is greater than 50, call this method in a loop providing the UUID of the 50th activity from the previous list as the lastUUID parameter. Return a java.util.Vector object. Each object in the vector is a java.util.Hashtable object describing one activity.

dateType Date field of interest. Options are created and modified.
beginTime Start timestamp of the range, using a yyyy.mm.dd format.
endTime Finish timestamp of the range, using a yyyy.mm.dd format.
lastUUID Unique ID of the last activity retrieved from a previous call of this command. Specify empty double quotes if you expect less than 50 activities in the response, or if we are running this command for the first time.

For example, the following command gets the first set of 50 activities created from 1 Mach 2008 through 31 March 2008:


created","2008.03.01","2008.03.31","")

This command does not return activity templates created during the specified date range. This command does include in the activities that it returns any activities present in the Trash view created during the specified date range. ActivityService.fetchActivityById(java.lang.String activityId) Fetch the activity identified by the given universal identifier. Return a java.util.Hashtable object describing the activity.

activityId Unique identifier of the activity. For example, "3F9G09219392F4733F40F82A4E8D5F000083".


ActivityService.fetchActivitiesByMember(java.util.Hashtable member)

Fetch a list of activities to which the specified member has access, except those in the Trash view. This command does not return community activities. Return a java.util.Vector object; each object in the vector is a java.util.Hashtable object describing one activity. It does not provide any results if the specified member is a group or a community.

member java.util.Hashtable object representing the member returned from the MemberService object. For example, jane.


ActivityService.fetchActivitiesByOwner(java.util.Hashtable member)

Fetch a list of activities that are owned by the specified member, except those in the Trash view. This command does not return community activities either. Return a java.util.Vector object. Each object in the vector is a java.util.Hashtable object describing one activity.

member java.util.Hashtable object representing the owner returned from the MemberService object. For example, paul_smith.


ActivityService.fetchActivitiesCreatedByMember(java.util.Hashtable member)

Fetch a list of activities created by the specified member, except those in the Trash view. This command does not return community activities. Return a java.util.Vector object; each object in the vector is a java.util.Hashtable object describing one activity.

member java.util.Hashtable object representing the member returned from the MemberService object. For example, paul_smith.


ActivityService.fetchCompletedActivities()

Fetch a list of all completed activities in the service, which are activities that have been marked complete and are displayed in the Completed view. Completed activities are not included in the Trash view; it is not until a completed activity is deleted that it is moved to the Trash view.

Return a java.util.Vector object. Each object in the vector is a java.util.Hashtable object describing one activity.


ActivityService.fetchDeletedActivities()

Fetch a list of all deleted activities in the service. These are activities currently in the Trash view.

Returns a java.util.Vector object. Each object in the vector is a java.util.Hashtable> object describing one activity.


AccessControlService

We cannot use the AccessControlService commands to fetch, set, or delete access to community activities. See Communities administrative commands for information about the command we can use to add a person to a community.


AccessControlService.deleteAccess(java.util.Vector activities, java.util.Vector members)

Removes access privileges to the specified activities for the specified members. Return a java.util.Vector object. Each object in the vector is a java.util.Hashtable object describing one activity whose access could not be deleted. A returned empty vector indicates success.

activities Vector of hash tables representing the activities whose access will be modified. For example, joesactivities.
members Vector of hash tables representing the members returned from the MemberService object.


AccessControlService.fetchAccess(java.util.Hashtable activity)

Fetch a list of all of the members that have access to the specified activity. Return a java.util.Vector object. Each object in the vector is a java.util.Hashtable object describing one entry, either a user or group, in the access list. The elements returned in the Hashable are:

  • displayName
  • email: Return for members only, not groups.
  • externalId
  • loginNames: Return for members only, not groups.
  • memberId
  • memberType
  • role
  • staticProfile

activity Hash table representing the activity.

The following code is an example of what is returned by this command:

[{memberId=675G09219107D9BB025252223E2BC9000001, displayName=Amy Jones, loginNames=[Amy Jones, ajones@acme.com], staticProfile=false, externalId=3AB586F4-A4D2-43C8-92DB-2DC3B2291803, email=ajones@acme.com, memberType=person, role=owner}, {memberId=D76G0921910768409A3F871F14596C000088, displayName=Amy Jacobs, loginNames=[Amy Jacobs, ajacobs@acme.com], staticProfile=false, externalId=DE1D832B-1024-43B1-A12C-F1B643C2B6A2, email=ajacobs@acme.com, memberType=person, role=reader}, {memberId=812G09219107D9BB025252223E2BC900000A, displayName=ajonesgroup, staticProfile=false, externalId=41565591-1A33-4F9B-88D9-335D96BFB3B2, memberType=group, role=reader}]


AccessControlService.setMembersAccess(java.util.Vector activities, java.util.Vector members)

Set the specified members as members with author access to the specified activities. Return a java.util.Vector object. Each object in the vector is a java.util.Hashtable object describing one activity whose access could not be modified. A returned empty vector indicates success.

activities Vector of hash tables representing the activities whose access will be modified.
members Vector of hash tables representing the members returned from the MemberService object.

In 2.5, this command named changed from setMemberAccess to setMembersAccess.


AccessControlService.setOwnerAccess(java.util.Vector activities, java.util.Hashtable owner)

Set the specified member as an owner of the specified activities. Return a java.util.Vector object. Each object in the vector is a java.util.Hashtable object describing one activity whose access could not be modified. A returned empty vector indicates success.

activities Vector of hash tables representing the activities whose access will be modified.
owner Hash table representing the member returned from the MemberService object.


AccessControlService.setOwnersAccess(java.util.Vector activities, java.util.Vector owners)

Set the specified members as owners of the specified activities. Return a java.util.Vector object. Each object in the vector is a java.util.Hashtable object describing one activity whose access could not be modified. A returned empty vector indicates success.

activities Vector of hash tables representing the activities whose access will be modified.
owners Vector of hash tables representing the members to whom to give owner access.

This command was added in version 2.5.


AccessControlService.setReadersAccess(java.util.Vector activities, java.util.Vector members)

Set the specified members as readers of the specified activities. Return a java.util.Vector object. Each object in the vector is a java.util.Hashtable object describing one activity whose access could not be modified. A returned empty vector indicates success.

activities Vector of hash tables representing the activities whose access will be modified.
members Vector of hash tables representing the members returned from the MemberService object.

In 2.5, this command named changed from setReaderAccess to setReadersAccess.


AccessControlService.syncAllCommunityShares()

Update the Activities data store to reflect changes made to the name or access level of a community. If the community no longer exists, the membership of the activity is updated to remove the community. This command was added in version 3.


ActivitiesConfigService

ActivitiesConfigService.checkOutConfig("/tmp", "cell_name")

Checks Activities configuration files out to temporary directory.

/tmp Temporary working directory to which configuration files are copied. When we specify a path to the working directory on a system running Windows, use a forward slash for the directory. For example: "/tmp".

AIX and Linux: The working directory must grant write permissions or the command will not run successfully.

cell_name Name of the WAS cell hosting the Lotus Connections application. To get cell name:

For example:

    ActivitiesConfigService.checkOutConfig("/tmp", "CommServerNode01Cell")


ActivitiesConfigService.showConfig()

Display current configuration settings. Check out configuration files with ActivitiesConfigService.checkOutConfig before running ActivitiesConfigService.showConfig.


ActivitiesConfigService.updateConfig("property_name", "new_value")

Update configuration properties.

property_name

See Activities configuration properties for configuration properties and descriptions.

new_value The new value for the property. Acceptable values for properties can be restricted, for example to either true or false. See Activities configuration properties for configuration properties and descriptions.


ActivitiesConfigService.checkInConfig()

Check in Activities configuration files.


ActivitiesScheduler

ActivitiesScheduler.getTaskDetails(java.lang.String taskName)

Fetch the list attributes of the named task. Return a java.util.Hashtable object containing the attributes.

taskName Name of the task specified as a String value. For example:

  • "30MinStats"

  • "ActivityAutoCompleteJob"
  • "DailyStats"
  • "DatabaseRuntimeStats"
  • "TrashAutoPurgeJob"
  • "EventLogPurgeJob"


ActivitiesScheduler.pauseSchedulingTask(java.lang.String taskName)

Suspend scheduling of a task. Has no effect on currently running tasks. Return a 1 to indicate the task has been paused. Paused tasks remain paused until you explicitly resume them, even if the server is stopped and restarted.

taskName Name of the task specified as a String value. For example:

  • "30MinStats"
  • "ActivityAutoCompleteJob"
  • "DailyStats"
  • "DatabaseRuntimeStats"
  • "TrashAutoPurgeJob"
  • "EventLogPurgeJob"


ActivitiesScheduler.resumeSchedulingTask(java.lang.String taskName)

Resume the start of a paused task. Return a 1 to indicate the task has been resumed.

taskName Name of the task specified as a String value. For example:

  • "30MinStats"
  • "ActivityAutoCompleteJob"
  • "DailyStats"
  • "DatabaseRuntimeStats"
  • "TrashAutoPurgeJob"
  • "EventLogPurgeJob"


ArchiveService

ArchiveService.createActivities(java.lang.String directory, java.util.Vector activities)

Create new activities from the previously exported activities specified by the vector. If an activity being imported with this command already exists, a second activity is created. Return a java.util.Vector object. Each object in the vector is a java.util.Hashtable object describing one activity that could not be created. A returned empty Vector indicates success.

directory Directory on the file system from which to import the activities. For example, "C:/AllExports".
activities Vector of hash tables. Each hash table describes an Activity to be created. For example, allexports.


ArchiveService.deleteActivities(java.lang.String directory, java.util.Vector activities)

Delete the previously exported activities specified by the vector from the specified directory. Use this command to delete activities from the archive repository, not from the Activities server or database. Return a java.util.Vector object. Each object in the vector is a java.util.Hashtable object describing one activity that could not be deleted. A returned empty vector indicates success.

directory Archive directory on the file system from which to delete the activities. For example, "C:/AllExports".
activities Vector of hash tables. Each hash table describes an activity to be deleted. For example, janesactivities.


ArchiveService.exportActivities(java.lang.String directory, java.util.Vector activities)

Exports the activities specified by the Vector into the specified directory; this method will overwrite an activity if it already exists in the specified directory. Return a java.util.Vector object. Each object in the vector is a java.util.Hashtable object describing one activity that could not be exported. A returned empty Vector indicates success.

directory Directory on the file system to which to export the activities. For example, "/tmp/zips".
activities Vector of hash tables. Each hash table describes an activity to be exported. For example, activities.


ArchiveService.fetchActivities(java.lang.String directory)

Fetch a list of all archived activities in the specified directory. Return a java.util.Vector object. Each object in the vector is a java.util.Hashtable object describing an archived activity in the directory.

directory Directory on the file system containing the archived activities. For example, "C:/AllExports".


ArchiveService.fetchActivitiesByMember(java.lang.String directory , java.util.Hashtable member)

Fetch a list of all archived activities in the specified directory to which the specified member has access. Return a java.util.Vector object. Each object in the vector is a java.util.Hashtable object describing an archived activity in the directory. This command does not return community activities.

directory Directory on the file system containing the archived activities. For example, "C:/AllExports".
member Hash table representing the members returned from the MemberService object. For example, paul_smith.

Do not use this command to fetch activities that were exported from a different deployment of Connections. Uses the member ID to find the activities, and member IDs are not persisted across different deployments. Only use this command to collect activities when we are importing the activities to the same server from which they were exported. If we are importing the activities to a different server, use the ArchiveService.fetchActivities(directory) command instead.


ArchiveService.fetchActivitiesByOwner(java.lang.String directory , java.util.Hashtable member)

Fetch a list of all archived activities in the specified directory that are owned by the specified member. Return a java.util.Vector object. Each object in the vector is a java.util.Hashtable objects describing an archived activity in the directory. This command does not return community activities.

directory Directory on the file system containing the archived activities. For example, "C:/AllExports".
member Hash table representing the owners of archived activities returned from the MemberService object. For example, paul_smith.

Do not use this command to fetch activities that were exported from a different deployment of Connections. This commands uses the member ID to find the activities, and member IDs are not persisted across different deployments. Only use this command to collect activities when we are importing the activities to the same server from which they were exported. If we are importing the activities to a different server, use the ArchiveService.fetchActivities(directory) command instead.


ArchiveService.fetchActivitiesCreatedByMember(java.lang.String directory, java.util.Hashtable member)

Fetch list of all archived activities in the specified directory created by the specified member. Return a java.util.Vector object. Each object in the vector is a java.util.Hashtable object describing an archived activity in the directory. This command does not return community activities.

directory Directory on the file system containing the archived activities. For example, "C:/AllExports".
member Hash table representing the member who created the archived activities returned from the MemberService object. For example, jane.

Do not use this command to fetch activities that were exported from a different deployment of Connections. This commands uses the member ID to find the activities, and member IDs are not persisted across different deployments. Only use this command to collect activities when we are importing the activities to the same server from which they were exported. If we are importing the activities to a different server, use the ArchiveService.fetchActivities(directory) command instead.


ArchiveService.importActivities(java.lang.String directory, java.util.Vector activities)

Imports the activities specified by the Vector whose archives are located in the specified directory into the Activities application. This method overwrites an activity if it already exists. Return a java.util.Vector object. Each object in the vector is a java.util.Hashtable> object describing one activity that could not be imported. A returned empty Vector indicates success.

directory Directory on the file system from which to import the activities. For example, "c:/temp/zips".
activities Vector of hash tables. Each hash table describes an activity to be imported. For example, activitiesToImport.


ListService

ListService.filterActivitiesByName(inList, toMatch)

Represents a script that can be used to filter or narrow down a list of activities matching certain criteria. This script is useful for locating a subset of activities that can then be used as input for a subsequent command. A typical example is creating a list of activities for export. Return a list of activities whose Title field matches the pattern criteria.

inList Previously fetched list of activities.
toMatch Java regular expression pattern representing match criteria. This pattern is used to search the title of the activity. The pattern must match the full name and is case sensitive. We can use the following keys:

  • Period (.) matches any character.
  • Plus sign (+) matches one or more instances of the previous character. For example, .+ matches all sequences of one or more characters.
  • Asterisk (*) matches zero or more instances of the previous character. For example, * matches all sequences of characters.
  • [chars] matches any one character within the brackets ([]). For example, [Gg] matches either an uppercase or lowercase G.
  • [A-Z] matches a range of characters.

Example: 

execfile("activitiesAdmin.py")


# Fetch all activities and save # to variable named "all"

all=ActivityService.fetchActivities()

# From the list of all activities, # Extract activities whose name 
# begins with "Sales"

sales=ListService.filterActivitiesByName(all,"Sales.*")

# Activities in "all" that begin 
# with "Sales" are saved in the 
# variable named "sales". The 
# variable "sales" can be used as 
# input for other commands, such 
# as the command to export 
# activities. The following command # will export all the activities 
# whose name begins with "Sales" to # the /opt/foo folder.

ArchiveService.exportActivities(
 "/opt/foo", "Sales.*")


StatisticsService

StatisticsService.fetchStatistic(java.lang.String key)

Fetch a server statistics. The list of available statistics for the server can be found at:

    http://yourservername.company.com/activities/service/html/serverstats

Use any of the statistics listed in this table as input to this command. The statistics listed as Stop Watch Statistics are similar to parent statistics and, when we use one of them as the key, it returns a hash table containing statistics for invocations, total, minimum, maximum, and average.

key Name of the statistic to be returned specified as a String value.

Return a java.lang.Integer or java.util.Hashtable object containing statistic data defined using the following keys:

invocations Number of times the function has been invoked.
total Total amount of time consumed by this operation.
minimum Minimum amount of time that a single invocation lasted.
maximum Maximum amount of time that a single invocation lasted.
average Average amount of time that a single invocation lasted.


TrashCollectionService

TrashCollectionService.fetchTrash()

Fetch objects currently in the Trash view. Returns a java.util.Vector object containing a set of hash tables. Each hash table describes an object in the trash.


TrashCollectionService.purgeTrash(java.util.Vector trashVector)

Objects in the trashVector parameter are permanently removed from the Activities application. Returns java.util.Vector of java.util.Hashtables object. Each hash table describes an object in the trash that could not be purged.

trashVector A vector of hash tables. Each hash table describes an object in the trash to be purged, obtained using...

    TrashCollectionService.fetchTrash


TrashCollectionService.undeleteTrash(java.util.Vector trashVector)

Restores previously deleted objects from the Trash view. Returns a java.util.Vector object containing java.util.Hashtable objectss; each Hashtable describes an object in the trash that could not be restored from the trash.

trashVector A vector of hash tables. Each hash table describes an object in the trash to be restored (obtained using the TrashCollectionService.fetchTrash command).


Parent topic:
Run Activities administrative commands


Related:
Synchronize changes users have made to their profiles
Compare remote application data with the Communities database
Fetch a list of activities