Skip to main content

Documents

Sprocket Documents web part enables you to list down documents on a page. You can customize the display parameters as well as manage the source of documents.
When your page is in Edit mode, click the icon, search for "Sprocket Documents", and select the Sprocket Documents web part from the results.

Documents Web Part

Features

  • Connect to any document library from any SharePoint site (cross-site collection)
  • Type ahead results filter
  • No need to configure a SharePoint view, just select the fields you wish to display in the webpart
  • Specify filters
  • Group by meta data field
  • Create filters using query strings and page data
  • Flatten files without folders
  • Show documents within a specific folder
  • Use within 'Full-Content' section

Configurations

After you select the Sprocket Documents web part, click the Configure Web Part button or icon on the menu on the left of the web part to open the Configuration section on the right. In this section, you can perform the following configurations:

  1. On page 1, configure the following in the Display Options section:

    FieldDescription
    Maximum number of itemsEnter the maximum number of items that you want to include on a page.
    Show Command BarClick to enable See All button that directs you to the list of all documents.
    Show FilterClick to enable the filter where you can use keywords to retrieve specific documents.
    Compact ViewClick to turn on the compact list view.
    Show File TypeClick to enable display of file type column as "Type" in the list.
    Show FoldersClick to enable display of folders.
    Open list in new tabEnable to open the list on a new tab, when you click See All button. If this option is disabled, the list will open on the same page.
  2. Click Next to navigate to page 2. On this page, configure the following in the Query Options section.

info

Fields marked with red asterisks (*) are mandatory.

FieldDescription
Site URLClick the drop-down list and select a source site.
Web URLClick the drop-down list and select a source web.
List TitleClick the drop-down list and select a source list.
FolderEnter the name of the folder.
View FieldsSelect the check boxes adjacent to the fields you want to display in the list.
Order ByClick the drop-down list and select a field value based on which you want to order the documents.
Show items in ascending order/Show items in descending orderSelect from one of the options to order the list based on ascending or descending order of the field value selected in Order By field.
Query within foldersEnable to allow querying within folders.
Group ByClick the drop-down list and select a field value based on which you want to group the documents.

Using Filters

Filters enable you to control the document listing. Sprocket offers you the following filter options:

  1. Use Query Strings
    To use the query string, add [PageQueryString:Parameter] to the 'Value' text box of each filter. To use the property bag, add [PropertyBagKey:Key] to the value box of each other. You can also use the current URL with [CurrentPageUrl].

  2. Use Expressions
    To use expressions, click Add Filter button and in the pop-up, select values for Field, Operator, and Values. You can use And/Or conditions to define multiple expressions.

  3. Once all the required updates and configurations are performed, click Republish button to publish the page.

FAQs

1. How do I add documents to display in Sprocket Documents web part?
You can click the Documents tab and use the Upload option or drag and drop the documents.

2. What is the maximum allowed file size of a document?
There is no maximum file size - any document size is allowed as per SharePoint specifications.

3. What are the allowed file types?
All SharePoint-allowed file types are allowed, however currently Excel and PowerPoint templates will open in Display Mode.

4. How can I find a specific item in the list?
You have the option to search for items in the list.