Files administrative commands 

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

The following sections define administrative commands you can use when working with Files. Each section describes the commands for a specific service.

Many commands ask for IDs as input parameters, such as library IDs, user IDs, policy IDs, and file IDs. You can use commands that take parameters you do know to return data including the ID you are looking for. For example, run FilesMemberService.getByEmail(string email) providing a user's email address and among the data returned is the user's ID. You can also find IDs using feeds. See the Lotus Connections API documentation for information on getting ID information using feeds.


FilesConfigService

FilesConfigService.checkOutConfig("<working_directory>", "<cell_name>")

FilesConfigService.showConfig()

FilesConfigService.updateConfig("<quick_config_property>", "<new_value>")

FilesConfigService.checkInConfig()


FilesMemberService

FilesMemberService.getById(string userId)

FilesMemberService.getByExtId(string externalId)

FilesMemberService.getByEmail(string email)

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

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

FilesMemberService.inactivateMemberByEmail("email")

FilesMemberService.inactivateMemberByExtId("externalID")

FilesMemberService.getMemberExtIdByEmail("email")

FilesMemberService.getMemberExtIdByLogin("login")

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

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

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

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


FilesLibraryService

FilesLibraryService.getById(string libraryId)

FilesLibraryService.delete(string libraryId)

FilesLibraryService.deleteBatch(string filePath)

FilesLibraryService.assignPolicy(string libraryId, string policyId)

FilesLibraryService.assignPolicyBatch(string filePath)

FilesLibraryService.getPersonalByOwnerId(string ownerUserId)

FilesLibraryService.browsePersonal(string sortOption, string sortAscending, int pageNumber, int itemsPerPage)

FilesLibraryService.browseCommunity(string sortOption, string sortAscending, int pageNumber, int itemsPerPage)

FilesLibraryService.browsePersonalOrphan(string sortOption, string sortAscending, int pageNumber, int itemsPerPage)

FilesLibraryService.getPersonalCount()

FilesLibraryService.getCommunityCount()

FilesLibraryService.getPersonalOrphanCount()

FilesLibraryService.exportSyncedResourceInfo(string fullpathForOutput, string type)


FilesDataIntegrityService

FilesDataIntegrityService.checkFiles(string extraFileDirectory)

FilesDataIntegrityService.syncAllCommunityShares()


FilesPrintService

FilesPrintService.saveToFile(string object, string filePath, string append)


FilesScheduler

FilesScheduler.pauseSchedulingTask(string taskName)

FilesScheduler.resumeSchedulingTask(string taskName)

FilesScheduler.forceTaskExecution(string taskName, string executeSynchronously)

FilesScheduler.getTaskDetails(string taskName)


FilesPolicyService

FilesPolicyService.add(string title, long maximumSize)

FilesPolicyService.edit(string policyId, string title, long maximumSize)

FilesPolicyService.getById(string policyId)

FilesPolicyService.browse(string sortOption, string sortAscending, int pageNumber, int itemsPerPage)

FilesPolicyService.getCount()

FilesPolicyService.editPersonalDefault(long maximumSize)

FilesPolicyService.editCommunityDefault(long maximumSize)

FilesPolicyService.delete(string policyId)


FilesMetricsService

FilesMetricsService.browsePersonal(string startDate, string endDate, string filePathWithFilterKeys)

FilesMetricsService.browseCommunity(string startDate, string endDate, string filePathWithFilterKeys)

FilesMetricsService.savePersonalToFile(string filePath, string startDate, string endDate, string filePathWithFilterKeys, string append)

FilesMetricsService.saveCommunityToFile(string filePath, string startDate, string endDate, string filePathWithFilterKeys, string append)

FilesMetricsService.getAvailablePersonalRange()

FilesMetricsService.getAvailableCommunityRange()


FilesUtilityService

FilesUtilService.filterListByString(List listOfMaps, string filterKey, string regexstringCriteria)

FilesUtilService.filterListByDate(list listOfMaps, string filterKey, expression)

FilesUtilService.filterListByNumber(List listOfMaps, string filterKey, expression)

FilesUtilService.getFileById(string fileID)


FilesObjectTypeService

Use these commands to import and export custom Content Management Interoperability Services (CMIS) object types, and delete or browse imported CMIS object types. See Work with CMIS API object types for details.

FilesObjectTypeService.importType("filePath")

FilesObjectTypeService.exportType("filePath", "Id")

FilesObjectTypeService.deleteType("Id")

FilesObjectTypeService.browseTypes()


Parent topic

Running Files administrative commands

Related concepts
Synchronize user data using administrative commands
IBM Connections APIs


Related tasks


Running administrative commands
Comparing remote application data with the Communities database
Checking Files data integrity
Backing up Files data
Importing statistics and metrics into a spreadsheet

Related reference
Files metrics
Files configuration properties


   

 

Submitted by Pam Gilday on Jan 19, 2012 12:52:34 PM

Re: Files administrative commands

});