Home
Seeing library information
Use the WikisLibraryService commands to see information on Wikis libraries. A library is the pages, attachments, and other data that make up a wiki.
- Open a command window and start the wsadmin command line tool as described in the topic, Starting the wsadmin client.
- Start the Wikis script with the following command:
- Stand-alone deployment:
execfile("wikisAdmin.py")
- Network deployment:
execfile("profile_root/config/bin_lc_admin/ wikisAdmin.py")
- Run the following commands to return information about libraries:
WikisLibraryService administrative commands
Command Description WikisLibraryService.getById(String libraryId)
Returns information about a single library specified by an id. A library is the pages, attachments, and other data that make up a wiki. It includes all wiki page versions, but does not include meta-data such as comments. It includes all wiki page versions, 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, Wikis 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.
WikisLibraryService.browseWiki(String sortOption, String sortAscending, int pageNumber, int itemsPerPage)
Returns a list of all wikis, with information about each wiki. The list includes wikis owned by communities, and wikis whose owners were removed from the user 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 to sort the list in ascending alphabetical order. This depends on the sortOption value. 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 wikis 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, Wikis 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.
WikisLibraryService.getWikiCount
Returns the total number of wikis.
WikisLibraryService.exportSyncedResourceInfo (String fullpathForOutput, String type)
Returns a report of all of the communities that the Wikis 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 Wikis. In clusters where multiple nodes are running Wikis, 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".
Related tasks
Comparing remote application data with the Communities database