Seeing library information

Home

Seeing library information

Use FilesLibraryService commands to see information about libraries, such as its owner, type, and size. A library is a set of files owned by a person or community and stored in the database.
Open a command window and start the wsadmin command line tool as described in the topic, Starting the wsadmin client.
Start the Files script with the following command:
Stand-alone deployment:
execfile("filesAdmin.py")
Network deployment:
execfile("profile_root/config/bin_lc_admin/ filesAdmin.py")
Run the following commands to return information about libraries:
FilesLibraryService administrative commands
Command Description

FilesLibraryService.getById(String libraryId)

Returns 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 Universally Unique Identifier (UUID) format: 00000000-0000-0000-0000-000000000000. 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.getPersonalByOwnerId(String ownerId)

Returns 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: 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.

Use FilesMemberService commands to find owner ids.

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

Returns 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 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)

Returns 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)

Returns a list of personal libraries whose owners were removed from the user 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

Returns the total number of personal libraries.

FilesLibraryService.getCommunityCount

Returns the total number of Community libraries.

FilesLibraryService.getPersonalOrphanCount

Returns the total number of personal libraries whose owners were removed from the user
FilesLibraryService.exportSyncedResourceInfo (String fullpathForOutput, String type)
Returns 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".
Administer Files

Related tasks

Start the wsadmin client
Comparing remote application data with the Communities database

+
Search Tips | Advanced Search

Command	Description
FilesLibraryService.getById(String libraryId)	Returns 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 Universally Unique Identifier (UUID) format: 00000000-0000-0000-0000-000000000000. 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.getPersonalByOwnerId(String ownerId)	Returns 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: 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. Use FilesMemberService commands to find owner ids.
FilesLibraryService.browsePersonal(String sortOption, String sortAscending, int pageNumber, int itemsPerPage)	Returns 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 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)	Returns 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)	Returns a list of personal libraries whose owners were removed from the user 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	Returns the total number of personal libraries.
FilesLibraryService.getCommunityCount	Returns the total number of Community libraries.
FilesLibraryService.getPersonalOrphanCount	Returns the total number of personal libraries whose owners were removed from the user
FilesLibraryService.exportSyncedResourceInfo (String fullpathForOutput, String type)	Returns 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".