Home

 

Files administrative commands

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

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

Command Description
FilesMemberService.syncAllMemberExtIds() Synchronize all user and group information in the Files database with the user directory. For each user or group, this service queries the user server by login name (or names) to retrieve updated information, such as directory ID, display name, and e-mail address.

Files automatically synchronizes the database with the directory directory periodically by directory ID, so running this command is not necessary unless you want to synchronize at a particular time.

Synchronization time varies depending on the number of people in the Files database. On average, it takes eight minutes to update 500 users. For large databases, run this process overnight.

This command does not take any parameters.

FilesMemberService.syncMemberExtIdByEmail(string emailAddr) Synchronize one member's information in the Files database with the user The command is essentially the same as syncAllMemberExtIds(), but applied to a single member, and the user server is queried by the specified e-mail address. Any out-of-sync information is updated.

Files automatically synchronizes the database with the directory periodically by directory ID, so running this command is not necessary unless you want to synchronize using an e-mail address, or you want to synchronize at a particular time rather than waiting for the periodic automatic synchronization.

Parameters:

    emailAddr

    The member's e-mail address as a string.

Example:

    FilesMemberService.syncMemberExtIdByEmail( "jdoe@company.com")

FilesMemberService.syncMemberExtIdByLogin(string loginName) Synchronize one member's information in the Files database with the user The command is essentially the same as syncAllMemberExtIds(), but applied to a single member. Any out-of-sync information is updated.

Files automatically synchronizes the database with the directory periodically by directory ID, so running this command is not necessary unless you want to synchronize using a login name, or you want to synchronize at a particular time rather than waiting for the periodic automatic synchronization.

Parameters:

    loginName

    The member's login name as a string.

Example:

    FilesMemberService.syncMemberExtIdByLogin("John Smith")

FilesMemberService.syncBatchMemberExtIdsByEmail(string emailFile) Synchronize user information in the Files database with the user The users are specified by e-mail address in a text file. The file is specified in the parameter.

The file must contain a list with one valid e-mail address per line. Create the file and save it in a directory that is local to the server where you are running the wsadmin processor.

This command is essentially the same as syncAllMemberExtIds() but applied to a list of members, and the user server is queried by e-mail addresses. Any out-of-sync information is updated.

Files automatically synchronizes the database with the directory periodically by ID, so running this command is not necessary unless you want to synchronize using a login name, or you want to synchronize at a particular time rather than waiting for the periodic automatic synchronization.

Parameters:

    emailFile

    The full path to the text file, as a string.

Example:

    FilesMemberService.syncBatchMemberExtIdsByEmail(".../dirA/dirB/emailFile.txt")

FilesMemberService.syncBatchMemberExtIdsByLogin(string loginFile) Synchronize user information in the Files database with the user The users are specified by login ID, in a text file. The file is specified in the parameter.

The file must contain a list with one valid login ID per line. You must create the file and save it in a directory that is local to the server where you are running the wsadmin processor.

This command is essentially the same as syncAllMemberExtIds() but applied to a list of members, and the user server is queried by login IDs. Any out-of-sync information is updated.

Files automatically synchronizes the database with the directory periodically by directory ID, so running this command is not necessary unless you want to synchronize using a login name, or you want to synchronize at a particular time rather than waiting for the periodic automatic synchronization.

Parameters:

    loginFile

    The full path to the text file, as a string.

Example:

    FilesMemberService.syncBatchMemberExtIdsByLogin("/opt/Files/update.txt")

FilesMemberService.getById(string id) Return information about a user specified by an id. The command only searches the Files database, so it only returns users who have logged in at least once.

Parameters:

    id

    The user ID in the following standard UUID format: 00000000-0000-0000-0000-000000000000.

The following information is returned:

  • id: User ID in the following standard UUID format: 00000000-0000-0000-0000-000000000000.
  • name: User's name in the database as of the date in directoryLastUpdate.
  • email: User's e-mail address.
  • isOrphan: True if the user is in the database, but not the directory
  • createDate: Date the user was added to the database.
  • lastVisit: Date of the user's last log in.
  • directoryLastUpdate: Last time the user's data was synchronized from the directory
  • directoryGroupLastUpdate: Last time this user's group membership was synchronized from the directory
  • communityLastUpdate: Last time this user's Community membership was synchronized.

FilesMemberService.getByExtId(string externalId) Return information about a user specified by an external directory ID. The command only searches the Files database, so it only returns users who have logged in at least once.

Parameters:

    externalId

    A string value matching the user's external directory ID. This can be any parameter in the user directory that you have configured as the directory ID.

The following user information is returned:

  • id: user ID in the following standard UUID format: 00000000-0000-0000-0000-000000000000.
  • name: user's name in the database as of the date in directoryLastUpdate.
  • email: user's e-mail address.
  • isOrphan: true if the user is in the database, but not the directory
  • createDate: date the user was added to the database.
  • lastVisit: date of the user's last log in.
  • directoryLastUpdate: last time the user's data was synchronized from the directory
  • directoryGroupLastUpdate: last time this user's group membership was synchronized from the directory
  • communityLastUpdate: last time this user's Community membership was synchronized.
FilesMemberService.getByEmail(string email) Return information about a user specified by an e-mail address. The command only searches the Files database, so it only returns users who have logged in at least once.

Parameters:

    email

    The e-mail address for the user.

The following user information is returned:

Command Description
FilesLibraryService.getById(string libraryId) Return information about a single library specified by an ID. A library is a set of files owned by a person or community. It includes all versions of the files, but does not include meta-data such as comments. It includes all versions of the files, but does not include meta-data such as comments.

Parameters:

    libraryId

    The library ID in the following standard UUID format: 00000000-0000-0000-0000-000000000000.

The following information is returned:

  • id: library ID in the following standard UUID format: 00000000-0000-0000-0000-000000000000.
  • ownerUserId: user ID of the library owner in the following standard UUID format: 00000000-0000-0000-0000-000000000000.
  • type: type of library, for example, Files Library.
  • label: string of characters used to identify the library in a URL.
  • title: library's title.
  • summary: summary of library information.
  • size: total size of the library binary data.
  • percentUsed: percentage of the maximum allowable size used, according to the library's policy. Zero if not applicable.
  • maximumSize: maximum size (in bytes) the library's policy allows. Zero for unlimited.
  • policyId: ID of the policy that sets a maximum limit (in bytes) on the library's size, in the following standard UUID format: 00000000-0000-0000-0000-000000000000.
  • lastUpdate: last time a significant user-driven update occurred to the meta-data.
  • createDate: library's creation date.
  • externalInstanceId: widget ID if the library is owned by a community.
  • externalContainerId: community ID if the library is owned by a community.
FilesLibraryService.delete(string libraryId) Deletes the library specified by the library ID, including all associated content. A library is a set of files owned by a person or community. It includes all versions of the files, but does not include meta-data such as comments. It includes all versions of the files, but does not include meta-data such as comments.

Parameters:

    libraryID

    The library ID in the following standard UUID format: 00000000-0000-0000-0000-000000000000.
FilesLibraryService.deleteBatch(string filePath) Deletes libraries specified in a text file. The file must contain a list with a single library ID per line in the following standard UUID format: 00000000-0000-0000-0000-000000000000. Create the file and save it in a directory local to the server where you are running the wsadmin processor. A library is a set of files owned by a person or community. It includes all versions of the files, but does not include meta-data such as comments. It includes all versions of the files, but does not include meta-data such as comments.

Parameters:

    filePath

    The full path to the text file, as a string.

FilesLibraryService.assignPolicy(string libraryId, string policyId) Assigns a policy to a library. A library is a set of files owned by a person or community. It includes all versions of the files, but does not include meta-data such as comments. It includes all versions of the files, but does not include meta-data such as comments. A policy sets a maximum size for a library.

Parameters:

    libraryId

    The library ID in the following standard UUID format: 00000000-0000-0000-0000-000000000000.

    policyId

    The policy ID in the following standard UUID format: 00000000-0000-0000-0000-000000000000.

No message is printed if the task succeeds.

FilesLibraryService.assignPolicyBatch(string filePath) Assigns policies to libraries as specified in a text file. The file must contain a list of library-policy ID pairs, one pair per line, values separated by a comma. For example: libraryId, policyId. Extra whitespace is ignored. You must create this text file and save it in a directory local to the server where you are running the wsadmin processor.

A library is a set of files owned by a person or community. It includes all versions of the files, but does not include meta-data such as comments. It includes all versions of the files, but does not include meta-data such as comments. A policy sets a maximum size for a library.

Parameters:

    filePath

    The full path to the text file, as a string.

FilesLibraryService.getPersonalByOwnerId(string ownerId) Return information about the personal library of a specified owner. A personal library is a set of files owned by one person.

Parameters:

    ownerId

    The valid ID of the library owner, as a string.

The following information is returned:

  • id: library ID in the following standard UUID format: 00000000-0000-0000-0000-000000000000.
  • ownerUserId: user ID of the library owner in the following standard UUID format: 00000000-0000-0000-0000-000000000000..
  • type: type of library, for example, Files Library.
  • label: A string of characters used to identify the library in a URL.
  • title: library's title.
  • summary: summary of library information.
  • size: total size of the library binary data.
  • percentUsed: percentage of the maximum allowable size used, according to the library's policy. Zero if not applicable.
  • maximumSize: maximum size (in bytes) the library's policy allows. Zero for unlimited.
  • policyId: ID of the policy that sets a maximum limit (in bytes) on the library's size, in the following standard UUID format: 00000000-0000-0000-0000-000000000000.
  • lastUpdate: last time a significant user-driven update occurred to the meta-data.
  • createDate: library's creation date.
  • externalInstanceId: widget ID if the library is owned by a community.
  • externalContainerId: community ID if the library is owned by a community.

Use FilesMemberService commands to find owner IDs.

FilesLibraryService.browsePersonal(string sortOption, string sortAscending, int pageNumber, int itemsPerPage) Return a list of personal libraries, with information about each library. A personal library is a set of files owned by one person. The list includes libraries whose owners were removed from the user directory. All parameters have default values.

Parameters:

    sortOption

    A string value that specifies how to sort the list. The default value is title, but you can use lastUpdate, size, createDate, or quotaPercentage.

    sortAscending

    A string value that specifies whether the list sorts in ascending alphabetical order. This depends on sortOption. If sortOption is title, then this value is true; if sortOption any other value, then this value is false.

    pageNumber

    The maximum number of pages to display. The default value is 1.

    itemsPerPage

    The maximum number of libraries to list per page. The default value is 20.

The following information is returned:

  • id: The library ID in the following standard UUID format: 00000000-0000-0000-0000-000000000000.
  • ownerUserId: The user ID of the library owner in the following standard UUID format: 00000000-0000-0000-0000-000000000000..
  • type: The type of library, for example, Files Library.
  • label: A string of characters used to identify the library in a URL.
  • title: The library's title.
  • summary: A summary of library information.
  • size: The total size of the library binary data.
  • percentUsed: The percentage of the maximum allowable size used, according to the library's policy. Zero if not applicable.
  • maximumSize: The maximum size (in bytes) the library's policy allows. Zero for unlimited.
  • policyId: The ID of the policy that sets a maximum limit (in bytes) on the library's size, in the following standard UUID format: 00000000-0000-0000-0000-000000000000.
  • lastUpdate: The last time a significant user-driven update occurred to the meta-data.
  • createDate: The library's creation date.
  • externalInstanceId: The widget ID if the library is owned by a community.
  • externalContainerId: The community ID if the library is owned by a community.

FilesLibraryService.browseCommunity(string sortOption, string sortAscending, int pageNumber, int itemsPerPage) Return a list of community libraries, with information about each library. A community library is a set of files owned by a community.

Parameters:

    sortOption

    A string value that specifies how to sort the list. The default value is title, but you can use lastUpdate, size, createDate, or quotaPercentage.

    sortAscending

    A string value that specifies whether the list sorts in ascending alphabetical order. This depends on sortOption. If sortOption is title, then this value is true; if sortOption any other value, then this value is false.

    pageNumber

    The maximum number of pages to display. The default value is 1.

    itemsPerPage

    The maximum number of libraries to list per page. The default value is 20.

The following information is returned:

  • id: The library ID in the following standard UUID format: 00000000-0000-0000-0000-000000000000.
  • ownerUserId: The user ID of the library owner in the following standard UUID format: 00000000-0000-0000-0000-000000000000..
  • type: The type of library, for example, Files Library.
  • label: A string of characters used to identify the library in a URL.
  • title: The library's title.
  • summary: A summary of library information.
  • size: The total size of the library binary data.
  • percentUsed: The percentage of the maximum allowable size used, according to the library's policy. Zero if not applicable.
  • maximumSize: The maximum size (in bytes) the library's policy allows. Zero for unlimited.
  • policyId: The ID of the policy that sets a maximum limit (in bytes) on the library's size, in the following standard UUID format: 00000000-0000-0000-0000-000000000000.
  • lastUpdate: The last time a significant user-driven update occurred to the meta-data.
  • createDate: The library's creation date.
  • externalInstanceId: The widget ID if the library is owned by a community.
  • externalContainerId: The community ID if the library is owned by a community.

FilesLibraryService.browsePersonalOrphan(string sortOption, string sortAscending, int pageNumber, int itemsPerPage) Return a list of personal libraries whose owners were removed from the user directory. A personal library is a set of files owned by one person.

Parameters:

    sortOption

    A string value that specifies how to sort the list. The default value is title, but you can use lastUpdate, size, createDate, or quotaPercentage.

    sortAscending

    A string value that specifies whether the list sorts in ascending alphabetical order. This depends on sortOption. If sortOption is title, then this value is true; if sortOption any other value, then this value is false.

    pageNumber

    The maximum number of pages to display. The default value is 1.

    itemsPerPage

    The maximum number of libraries to list per page. The default value is 20.

The following information is returned:

  • id: The library ID in the following standard UUID format: 00000000-0000-0000-0000-000000000000.
  • ownerUserId: The user ID of the library owner in the following standard UUID format: 00000000-0000-0000-0000-000000000000..
  • type: The type of library, for example, Files Library.
  • label: A string of characters used to identify the library in a URL.
  • title: The library's title.
  • summary: A summary of library information.
  • size: The total size of the library binary data.
  • percentUsed: The percentage of the maximum allowable size used, according to the library's policy. Zero if not applicable.
  • maximumSize: The maximum size (in bytes) the library's policy allows. Zero for unlimited.
  • policyId: The ID of the policy that sets a maximum limit (in bytes) on the library's size, in the following standard UUID format: 00000000-0000-0000-0000-000000000000.
  • lastUpdate: The last time a significant user-driven update occurred to the meta-data.
  • createDate: The library's creation date.
  • externalInstanceId: The widget ID if the library is owned by a community.
  • externalContainerId: The community ID if the library is owned by a community.

FilesLibraryService.getPersonalCount Return the total number of personal libraries.
FilesLibraryService.getCommunityCount Return the total number of Community libraries.
FilesLibraryService.getPersonalOrphanCount Return the total number of personal libraries whose owners were removed from the user directory.
FilesLibraryService.exportSyncedResourceInfo (string fullpathForOutput, string type) Return a report of all of the communities that the Files feature has interacted with. After a system crash you can compare the report to the latest metadata in the Communities database to help synchronize and update any missing data. See the topic Comparing remote application data with the Communities database for more information.

Note that in clusters, when you run the command from the deployment manager the path and file are created on the server running Files. In clusters where multiple nodes are running Files, you are asked choose a server to connect to and run the command on, and then the path and file are created on that server.

Parameters:

    fullPathforOutput

    The full path location where you want the report, and the report filename, as a string in quotes. The report is an XML file. For example:

      "c:/temp/community_output.xml"

The path can only contain forward slashes, for example:

/

type

This is always the string value, "community" (including quotes). An error is returned if this is anything except "community".

Command Description
FilesDataIntegrityService.checkFiles(string extraFileDirectory) Checks the integrity of the binary files in the file system extra files against the meta-data in the database, and prints results to log files in a specified The database is used as the primary source, as during a back up the file system is assumed to have extra data, if there is any.

The task logs a message for every extra file found, or every missing file. Missing files are errors that must be resolved (by finding the files or restoring a backup) before the application can start in a consistent state.

Parameters:

    extraFileDirectory

    A path as a string. This is the location where you want to store files not found in the database. If the does not exist, the command creates it. If the cannot be created, or read or written to, an error is returned.

This information might be useful before restoring database and file system images, to see how closely they match in a test environment. For more information see the topic Checking Files data integrity.


FilesPrintService administrative commands

Command Description
FilesPrintService.saveToFile(string object, string filePath, string append) Prints information returned by other commands to a file.

Parameters:

    object

    A command with parameters that returns a Map or List<Map> java object. You can use any of the following commands:

    • FilesMemberService.getById (returns a Map)
    • FilesMemberService.getByExtId (returns a Map)
    • FilesMemberService.getByEmail (returns a Map)
    • FilesLibraryService.getById (returns a Map)
    • FilesLibraryService.getPersonalByOwnerId (returns a Map)
    • FilesLibraryService.browsePersonal (returns a List<Map>)
    • FilesLibraryService.browseCommunity (returns a List<Map>)
    • FilesLibraryService.browsePersonalOrphan (returns a List<Map>)
    • FilesPolicyService.getById (returns a Map)
    • FilesPolicyService.browse (returns a List<Map>>)
    • FilesMetricsService.browsePersonal (returns a List<Map>)
    • FilesMetricsService.browseCommunity (returns a List<Map>)

    filePath

    A path to a file in which to save the object data. The data is saved in comma-separated value (.csv) format.

    append

    string whose default value is

    "true"

    Change to

    "false"

    to have the command overwrite the existing file instead of appending the data in the existing file.

Example:

    FilesPrintService.saveToFile(FilesLibraryService.browsePersonal("title","true",1,20), "/opt/wsadmin/LibraryMap.csv")


FilesTaskService administrative commands

Command Description
FilesTaskService.pause(string taskId) Pauses a task. In release 2.5 this can only operate on the task that deletes files. That task must be paused during database and file system backup, and then resumed.

Parameters:

    taskId

    The ID of the file deletion task. The ID for that task is:

      com.ibm.quickr.share.platform.task.file.delete

Example:

    FilesTaskService.pause("com.ibm.quickr.share.platform.task.file.delete")

A warning is displayed if the task is already paused. For more information on running this task during data backup, see the topic Backing up data.

FilesTaskService.resume(string taskId) Resumes a task. In release 2.5 this can only operate on the task that deletes files. That task must be paused during database and file system backup, and then resumed.

Parameters:

    taskId

    The ID of the file deletion task. The ID for that task is:

      com.ibm.quickr.share.platform.task.file.delete

Example:

    FilesTaskService.resume("com.ibm.quickr.share.platform.task.file.delete")

A warning is displayed if the task is already active. For more information on running this task during data backup, see the topic Backing up data.

FilesTaskService.execute(string taskId, string executeSynchronously) Executes a task.

Property settings in the files-config.xml configuration properties file specify whether tasks are enabled to run automatically, and how often. This command allows you to run tasks manually, for example if you disabled a task but want to run it occasionally.

Parameters:

    taskId

    The ID of the task. For example, this ID runs the task that synchronizes users between the Files database and the user directory:

      com.ibm.quickr.share.platform.task.directory.user.synch

These are the Files IDs:

  • com.ibm.quickr.share.platform.task.directory.user.synch: Synchronize user information in the Files database with the Lotus Connections user
  • com.ibm.quickr.share.platform.task.directory.group.synch: Synchronize group names in the Files database with the Lotus Connections user
  • com.ibm.quickr.share.platform.task.file.delete: Deletes files marked as pending deletion and older than the number of minutes specified in the file.softDelete.minimumPendingTimeInMins configuration property.
  • com.ibm.quickr.share.platform.task.search.clearDeletionHistory: Removes deleted file records older than the number of days specified in the search.seedlist.maximumIncrementalQuerySpanInDays configuration property.
  • com.ibm.quickr.share.platform.task.statistics.collection: Collects server metrics, which are frequency data that are recorded about the current database state.
  • com.ibm.quickr.share.platform.task.tagging.updateFrequency: Finds the most frequently used tags in public files and updates the public files tag cloud.

See the topic Files configuration properties for information on the configuration properties related to these tasks.

executeSynchronously

Takes the string values true or false. Specifying this value is not required; the default is false. If this value is false, then the task executes asynchronously, meaning if the taskId is valid the command returns immediately and the execution continues in the background. If this value is true, it the command does not return until the task completes.

This example executes the task the deletes files:

    FilesTaskService.execute("com.ibm.quickr.share.platform.task.file.delete")

A warning is displayed if the task is already active.

Command Description
FilesPolicyService.add(string title, long maximumSize) Creates a policy with a specified title and maximum size. Policies set a maximum size limit on libraries.

A library is a set of files owned by a person or community. It includes all versions of the files, but does not include meta-data such as comments.

Parameters:

    title

    The policy title. A required value.

    maximumSize

    The maximum size allowed, in bytes. Must be zero or greater. A value of zero means the size is unlimited.

When a policy is created, an ID is created for it and returned to you. The ID is in the following standard UUID format: 00000000-0000-0000-0000-000000000000. You must provide policy IDs as parameters when running other FilesPolicyService commands.

Policies can be applied to libraries using the FilesLibraryService.assignPolicy or FilesLibraryService.assignPolicyBatch commands.

FilesPolicyService.edit(string policyId, string title, long maximumSize) Edits the title and maximum size of a policy with a specified ID. If the ID is for a default policy, the title is not modified. Policies set a maximum size limit on libraries. A library is a set of files owned by a person or community. It includes all versions of the files, but does not include meta-data such as comments.

Parameters:

    policyID

    The policy ID in the following standard Universally Unique Identifier (UUID) format: 00000000-0000-0000-0000-000000000000.

    title

    The policy title. A required value.

    maximumSize

    The maximum size allowed, in bytes. Must be zero or greater. A value of zero means the size is unlimited.

FilesPolicyService.getById(string id) Return information for a single policy specified by an ID. Policies set a maximum size limit on libraries. A library is a set of files owned by a person or community. It includes all versions of the files, but does not include meta-data such as comments.

Parameters:

    id

    The policy ID in the following standard UUID format: 00000000-0000-0000-0000-000000000000.

The following information is returned:

  • id: the ID
  • title: the policy title
  • maximumSize: the maximum size (in bytes) the library can be, or 0 for unlimited

FilesPolicyService.browse(string sortOption, string sortAscending, int pageNumber, int itemsPerPage) Return a list of policies with ID, title, and maximum size information, as described for the FilesPolicyService.getById(id) command. Policies set a maximum size limit on libraries. A library is a set of files owned by a person or community. It includes all versions of the files, but does not include meta-data such as comments.

Parameters:

    sortOption

    A string value that specifies how to sort the list. The default value is title, but you can also use maximumSize.

    sortAscending

    A string value that specifies whether the list sorts in ascending alphabetical order. This depends on sortOption. If sortOption is title, then this value is true; if sortOption any other value, then this value is false.

    pageNumber

    The number of the page to return. For example, if the itemsPerPage value is 40, and pageNumber value is 2, the command returns items 41 to 80 (page 2) instead of 1 to 40 (page 1).

    itemsPerPage

    The maximum number of policies to list per page. The default value is 20.

FilesPolicyService.getCount Return the total number of policies. Policies set a maximum size limit on libraries. A library is a set of files owned by a person or community. It includes all versions of the files, but does not include meta-data such as comments.
FilesPolicyService.editPersonalDefault(long maximumSize) Sets the maximum size, in bytes, for the personal library default policy. The default policy is applied to all personal libraries that do not otherwise have a policy. It allows you to control library size as a way of controlling the amount of storage space used.

A personal library is a set of files owned by one person. It includes all versions of the files, but does not include meta-data such as comments.

Parameters:

    maximumSize

    A number representing the maximum size allowed, in bytes, for libraries that the default policy is assigned to.

FilesPolicyService.editCommunityDefault(long maximumSize) Sets the maximum size, in bytes, for the community library default policy. The default policy is applied to all community libraries that do not otherwise have a policy. It allows you to control library size as a way of controlling the amount of storage space used.

A community library is a set of files owned by a community. It includes all versions of the files, but does not include meta-data such as comments.

Parameters:

    maximumSize

    A number representing the maximum size allowed, in bytes, for wikis that the default policy is assigned to.

Command Description
FilesMetricsService.browsePersonal(string startDate, string endDate, string filePathWithFilterKeys) Return metrics about files stored in the database. The same metrics are provided for each day in a specified period. Some metrics apply to all libraries, some only apply to personal libraries. A personal library is a set of files owned by one person.

Parameters:

    startDate

    The start date for the period, in YYYY-MM-DD format.

    endDate

    The end date for the period, in YYYY-MM-DD format.

    filePathWithFilterKeys

    The full path to a text file in which each line contains a statistical key. If you specify a file, only metrics listed in the file are returned. If you do not specify a file, all data is returned.

See the topic Files metrics for metrics and their descriptions.

If you do not specify dates, then the command uses the first available day with data for startDate, and the last available day with data for endDate.

FilesMetricsService.browseCommunity(string startDate, string endDate, string filePathWithFilterKeys) Return metrics about files stored in the database. The same metrics are provided for each day in a specified period. Some metrics apply to all libraries, some only apply to community libraries. A community library is a set of files owned by a community.

Parameters:

    startDate

    The start date for the period, in YYYY-MM-DD format.

    endDate

    The end date for the period, in YYYY-MM-DD format.

    filePathWithFilterKeys

    The full path to a text file in which each line contains a statistical key. If you specify a file, only metrics listed in the file are returned. If you do not specify a file, all data is returned.

See the topic Files metrics for metrics and their descriptions.

If you do not specify dates, then the command uses the first available day with data for startDate, and the last available day with data for endDate.

FilesMetricsService.savePersonalToFile(string filePath, string startDate, string endDate, string filePathWithFilterKeys, string append) Return metrics about files stored in the database, and then stores them in a local file. The same metrics are provided for each day in a specified period. Some metrics apply to all libraries, some only apply to personal libraries. A personal library is a set of files owned by one person.

Parameters:

    filePath

    Path to a file in which to store the metrics. metrics are stored in comma-separated value (CSV) format.

    startDate

    The start date for the period, in YYYY-MM-DD format.

    endDate

    The end date for the period, in YYYY-MM-DD format.

    filePathWithFilterKeys

    The full path to a text file in which each line contains a key. If you specify a file, only metrics mapped to keys listed in the file are returned. If you do not specify a file, all data is returned.

    append

    string whose default value is

    "true"

    Change to

    "false"

    to have the command overwrite the existing file instead of appending the data in the existing file.

See the topic Files metrics for metrics and their descriptions.

If you do not specify dates, then the command uses the first available day with data for startDate, and the last available day with data for endDate.

FilesMetricsService.saveCommunityToFile(string filePath, string startDate, string endDate, string filePathWithFilterKeys, string append) Return metrics about files stored in the database, and then stores them in a local file. The same metrics are provided for each day in a specified period. Some metrics apply to all libraries, some only apply to community libraries. A community library is a set of files owned by a community.

Parameters:

    filePath

    Path to a file in which to store the metrics. metrics are stored in comma-separated value (CSV) format.

    startDate

    The start date for the period, in YYYY-MM-DD format.

    endDate

    The end date for the period, in YYYY-MM-DD format.

    filePathWithFilterKeys

    The full path to a text file in which each line contains a key. If you specify a file, only metrics mapped to keys listed in the file are returned. If you do not specify a file, all data is returned.

    append

    string whose default value is

    "true"

    Change to

    "false"

    to have the command overwrite the existing file instead of appending the data in the existing file.

See the topic Files metrics for metrics and their descriptions.

If you do not specify dates, then the command uses the first available day with data for startDate, and the last available day with data for endDate.

FilesMetricsService.getAvailablePersonalRange Return a string array where the first element is the first day data is available and the second element is the last day that data is available for personal libraries. Typically, the current day's data is not available until 12:01 A.M. the following day. A personal library is a set of files owned by one person.

If metrics collection was disabled or did not occur because of some issue, there may be gaps in data available.

FilesMetricsService.getAvailableCommunityRange Return a string array where the first element is the first day data is available and the second element is the last day that data is available for Community libraries. Typically, the current day's data is not available until 12:01 A.M. the following day. A community library is a set of files owned by a community.

If metrics collection was disabled or did not occur because of some issue, there may be gaps in data available.

Command Description
FilesListService.filterBystring(List listOfMaps, string filterKey, string regexstringCriteria) Return items from a specified list that have a specified key matching a specified regular expression. Use this command to filter List<Map> java objects that are returned by any of the browse commands, such as FilesLibraryService.browsePersonal and FilesPolicyService.browse.

A map is a list of key/value pairs, for example the FilesLibraryService.browsePersonal command returns a list of personal libraries. Each library in the list is a map with a set of keys, and each key is paired with a value. Every library has the same set of keys, but unique values. Values contain information about the library, such as its title and creation date.

Parameters:

    listOfMaps

    A list of maps, for example the result of

    FilesLibraryService.browsePersonal(<parameters>)

    filterKey

    A key in each map in the list, whose value is compared against the filter criteria.

    regexstringCriteria

    A regular expression represented as a string to match against the filterKey value. For example, "[0-9]+" to match only >= 1 numbers in a row.

The command returns maps from the listOfMaps whose filterKey is the regexstringCriteria value.

FilesListService.filterByDate(List listOfMaps, string filterKey, expression) Return items from a specified list that have a specified key with a specified date. Use this command to filter List<Map> java objects that are returned by any of the browse commands, such as FilesLibraryService.browsePersonal and FilesPolicyService.browse.

A map is a list of key/value pairs, for example the FilesLibraryService.browsePersonal command returns a list of personal libraries. Each library is a map with a set of keys, and each key is paired with a value. Every library has the same set of keys, but unique values. Values contain information about the library, such as its title and creation date.

Parameters:

    listOfMaps

    A list of maps, for example the result of

    FilesLibraryService.browsePersonal(<parameters>)

    filterKey

    A key in each map in the list, whose value is compared against the filter criteria.

    expression

    A string of the form <operator> <date> where <date> is in yyyy-MM-dd format and <operator> is one of the following: > >= == <= <

The command returns maps from the listOfMaps value whose filterKey value is the expression value. For example, a filterKey value of creatDate and an expression of <= 2009-01-01 filters the map to only include items created before January 1, 2009.

FilesListService.filterByNumber(List listOfMaps, string filterKey, expression) Return items from a specified list that have a specified key with a specified number. Use this command to filter List<Map> java objects that are returned by any of the browse commands, such as FilesLibraryService.browsePersonal and FilesPolicyService.browse.

A map is a list of key/value pairs, for example the FilesLibraryService.browsePersonal command returns a list of personal libraries. Each library is a map with a set of keys, and each key is paired with a value. Every library has the same set of keys, but unique values. Values contain information about the library, such as its title and creation date.

Parameters:

    listOfMaps

    A list of maps, for example the result of

    FilesLibraryService.browsePersonal(<parameters>)

    filterKey

    A key in each map in the list, whose value is compared against the filter criteria.

    expression

    A string of the form <operator> <int> where <int> is an integer and <operator> is one of the following: > >= == <= <

The command returns maps from the listOfMaps value whose filterKey value is the expression value. For example, a filterKey value of percentUsed and an expression value of ==20 filters the map to only include items whose filterKey value is 20.


Running administrative commands

 

Related tasks

Running administrative commands

Comparing remote application data with the Communities database

Checking Files data integrity

Backing up Files data

 

Related reference


Files metrics

Files configuration properties


+

Search Tips   |   Advanced Search