Communities administrative commands 

Use the commands listed to perform administrative tasks for Communities. No file checkout or server restart is needed when using these commands.

The following sections define the commands that you can use when working with Communities. Each section describes the commands for a specific service. The commands are listed in alphabetical order.


CommunitiesListService commands

CommunitiesListService.filterListByApp(List list, String filter)

CommunitiesListService.filterListById(List list, String filter)

CommunitiesListService.filterListByName(List list, String filter)

CommunitiesListService.filterListByType(List list, String filter)


CommunitiesMemberService commands

CommunitiesMemberService.getMemberExtIdByEmail("email")

CommunitiesMemberService.getMemberExtIdByLogin("login")

CommunitiesMemberService.inactivateMemberByEmail("email")

CommunitiesMemberService.inactivateMemberByExtId("externalID")

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

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

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

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

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

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


CommunitiesQEventService commands

CommunitiesQEventService.clearQueuedEventByEventId(String eventId)

CommunitiesQEventService.clearQueuedEventsByRemoteAppDefId(String remoteAppDefId)

CommunitiesQEventService.clearQueuedEventsByResourceId(String resourceType, String resourceId)

CommunitiesQEventService.clearQueuedEventsByResourceType(String resourceType)

CommunitiesQEventService.retryQueuedEventsByRemoteAppDefId(String remoteAppDefId)

CommunitiesQEventService.retryQueuedEventsByResourceId(String resourceType, String resourceId)

CommunitiesQEventService.retryQueuedEventsByResourceType(String resourceType)

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

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

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

CommunitiesQEventService.viewQueuedEventsSummary()


CommunitiesScheduler commands

CommunitiesScheduler.getTaskDetails(String taskName)

CommunitiesScheduler.pauseSchedulingTask(String taskName)

CommunitiesScheduler.resumeSchedulingTask(String taskName)


CommunitiesService commands

CommunitiesService.addAlternateOwner(String directoryUuid, String alternateDirectoryUuid, Boolean removeOriginal)

CommunitiesService.addMembersToCommunityByEmail(String communityName, Integer memberRole, List emailAddresses)

CommunitiesService.addMembersToCommunityByMemberUuid(String communityName, Integer memberRole, List UUID of member)

CommunitiesService.createCommunityWithEmail(String community name, String ownerName, int memberRole, String dsmlFile)

CommunitiesService.createCommunityWithLoginName(String communityName, String ownerName, int memberRole, String dsmlFile)

CommunitiesService.fetchAllComm()

CommunitiesService.fetchCommById(string communityUUID)

CommunitiesService.fetchCommByMemberEmail(String email)

CommunitiesService.fetchCommByMemberUuid(String uuid)

CommunitiesService.fetchCommByName(String name)

CommunitiesService.fetchMember(List list)

CommunitiesService.fetchReference(List list)

CommunitiesService.listComm(List list)

CommunitiesService.listCommToFile(List list, String filename)

CommunitiesService.removeAllMembershipByDirectoryUuid(String directoryUuid)

CommunitiesService.updateCommunityName(String communityName, String newName)

CommunitiesService.updateCommunityDescription(String communityName, String newDescription)

CommunitiesService.removeReferencesByUri(String communityName, List referenceURIs)

CommunitiesService.removeTagsFromCommunity(String communityName, List tagNames)


ManagedAppService commands

ManagedAppService.addLinkProperty(Link link, String key, String value)

ManagedAppService.checkInConfig(String "<app>")

ManagedAppService.checkOutConfig(String "<app>", String "<working directory>", String "<cell name>")

ManagedAppService.configHelp(String "<app>")

ManagedAppService.createLink(List comList, String appName)

ManagedAppService.deleteLink(List linkList)

ManagedAppService.deleteLinkProperty(Link link, String key)

ManagedAppService.fetchAllLink()

ManagedAppService.fetchLinkByApp(String appName)

ManagedAppService.fetchLinkByComm(List comList)

ManagedAppService.fetchLinkByCommApp(List comList, String appName)

ManagedAppService.fetchProperty(List linkList)

ManagedAppService.listApp()

ManagedAppService.listLink(List linkList)

ManagedAppService.listLinkToFile(List linkList, String fileName)

ManagedAppService.showConfig(String "<app>")

ManagedAppService.updateConfig(String "<app>", String "<property>", String "<value>")

ManagedAppService.updateFeedURI(Link link, String URI)

ManagedAppService.updateMainURI(Link link, String URI)


Parent topic

Running Communities administrative commands

Related concepts
Synchronize user data using administrative commands


Related tasks


Running administrative commands

Related reference
Activities administrative commands
Error messages
Communities configuration properties


   

 

});