skybow List View Search User Guide

Document created by ChristofN Employee on Jun 30, 2016Last modified by RosarioM on Oct 11, 2016
Version 26Show Document
  • View in full screen mode

Table of Content

 

Getting Started

Overview

skybow List View Search helps you filter your related lists with dynamic configurable search inputs. It allows extending SharePoint views in SharePoint Online (Office 365) or on-premises environment for users to filter the items shown using entered criteria. The criteria that can be filtered by and the query that is used to combine the criteria can be configured without prior programming knowledge by a user with appropriate rights or credentials.

Note: This SharePoint Add-In works only on SharePoint 2013 or higher.

The search inputs are rendered just like columns in normal SharePoint list forms. The following standard column types are supported:

  • Single line of text
  • Multiple lines of text
  • Choice (menu to choose from)
  • Number (1, 1.0, 100)
  • Currency ($, ¥, €)
  • Date and Time
  • Lookup (information already on this site)
  • Yes/No (check box)
  • Person or Group

 

 

Support

For any questions or technical issues, you can contact us. Here are our contact details.

Support skybow

List View Search Documentation

 

 

skybow Foundation

The functionalities of Add-Ins require a higher level of privileges on Office 365 since the Add-Ins that are offered in Microsoft store have some restrictions placed upon them. Therefore the manually installed Add-Ins are permitted to execute the advanced actions.

The skybow Foundation Add-In is one such manually installed Add-In with some functional capabilities that are otherwise not allowed to be executed by us in MS store. This Add-In provides services for all the skybow Add-Ins to work efficiently as well as enhance their feature set. Essentially, instead of implementing the same set of capabilities in each of our Add-Ins, this utility is loaded with shared functionalities that can hence serve all our skybow Add-Ins.

 

 

 

Pre-requisites:

To be able to add this Add-In, you need to have site collection administrator privileges. Also, the scripting capabilities should be turned on in tenant-wide settings. The App Catalog must be modified accordingly to accommodate List View Search which works on-premises with SharePoint 2013 or higher.

 

  1. From your SharePoint environment go to Setting, Site Contents and then Add an App

 

SiteContents.PNG

 

 

2. Then on your left site click on SharePoint Store

 

 

3. And search for the skybow products

 

 

 

4. Select skybow List View Search Add-In from the list.

    The Office Store for skybow List View Search will be displayed.

    Click on Add It

 

 

 

5. In skybow List View Search app click on Request License.

    You will receive the License per e-mail.

 

 

6. After receive the License per e-mail, make the Upload.

 

7. The skybow List View Search app will appear on Lists, Libraries, and other Apps - Site Contents page.

    Click on skybow List View Search app.

 

 

8. The skybow List View Search App Homepage is shown

 

 

 

 

Adding List View Search App Add-In to your SharePoint Online/On-Premises Site

 

1. From any page where you are, go to Settings, Add an app. Will be displayed the Apps that you can add.

 

 

or

 

1. Other way is, searching through the Filter.

 

 

2. And make Trust it

Request License

 

 

1. On Site Contents - Lists, Libraries, and other Apps click on skybow List View Search app.

    The Skybow List View Search App will be displayed

 

2. Select Request License

 

 

 

 

3. Fulfill the skybow License Request

 

4. And will appear a "Thank you message"

 

5. You will receive your License per E-mail

 

Upload license

1. Go to skybow List View Search.

    One way it's, through the Site Contents - Lists, Libraries, and other click on skybow List View Search app.

 

2. On skybow List View Search page click on Upload License

 

 

 

3. Choose the License File to upload

 

4. The List View Search app will be displayed

 

 

Configuring skybow List View Search

 

skybow List View Search App Homepage Overview

 

After adding the List View Search app,  you can locate it on the Site Contents page.

Click on List View Search app for start the configurations.

 

The skybow List View Search App homepage is where you configure List View Search , here you can add it  Views, Pages or Forms.

 

The App page has the following sections:

   1. Instructions & Support - In this section, you can view introduction video, check out documentation or contact support for any queries.

   2. Configure List View Search – In this section, you can configure List View Search to add it to Views, Pages or Forms.

  • Adding to Views from Add-In App Page
  • Adding to Forms from Add-In App Page
  • Adding to Pages from Add-In App Page

 

   3. About This App – In this section, you can view version details and rate this Add-In.

   4. Other Accelerators from skybow – In this section, you can access other SharePoint accelerators from skybow, such as skybow Rich Forms, skybow Tabbed Pages, skybow Action Links and skybow Theme Designer.

 

 

Ways to Add List View Search App Part

 

There are 3 ways in which you can add a List View Search app part to either Views or Forms.

 

1. From the skybow List View Search App page

Specify where to add List View Search app and select the further options depending on it.

On the App page, specify where to add List View Search app and select further options depending on it. For more information, refer to the following sections:

  • Adding to Views from Add-In App Page
  • Adding to Forms from Add-In App Page
  • Adding to Pages from Add-In App Page

 

 

2. Out of the box app part inserting

The App Part can be placed on every possible List View, as well as on any Page or List Form with a List View web part on it:

  • Display Form
  • Edit Form
  • New Form

This is done by using the SharePoint functionality for adding an app part.

Select the List View Search app part to insert it in the page.

From page, go to Settings then Edit a Page.

 

 

editpage.PNG

 

And then on the top of the header page click on Insert - List View Search and Add

 

 

 

And your List View Search will be displayed

 

 

ListViewSearchDisplay.PNG

 

3. Ribbon option on the List View Page

To add List View Search to the current view, select Use View Search option on the List View ribbon.

 

 

 

Adding to Views from Add-In App Homepage

On the List View Search app page, specify where to add List View Search and select further options depending on the form you select.

  • Select the required lists and libraries option, where you want to insert the app part.
  • Select the required form Views
  • Select the required form Web Parts drop down list.
  • Click Insert View Search.

 

contoso.PNG

 

The new skybow List View Search will be displayed.

 

newlist.PNG

 

Adding to Forms from Add-In App Homepage

On the List View Search app page, specify where to add List View Search and select further options depending on the form you select.

  • Select the required lists and libraries option where you want to insert the web part from the Lists and Libraries.
  • Select the required form from the Forms.
  • Select the web part from the Web Parts.
  • Click Insert View Search.

 

forms.PNG

 

The new List View Search will be displayed on the selected form.

 

Adding to Page from Ribbon Option

The Use View Search option on the List ribbon allows you to add app part.

  1. Navigate to any desired page.
  2. Click Settings button and select Edit Page.
  3. Select List > Use View Search.

 

 

 

The new List View Search will be displayed on the selected form.

 

 

Adding to Page from Web Parts Collection

The App Part can be placed on every possible List View, as well as on any Page or List or View with a List View web part on it.

  1. Navigate to any desired page.

  2. Click Settings button and select Edit Page.
  3. On the page, you click Add a Web Part link.

 

 

Or

 

   1. Click Settings button and select Edit Page.

   2. Select Insert > Web Part.

 

  1. Select the web part you want to add from the list.
  2. Click Add.

 

The web part will be added.

 

Configuring in Design Mode

Design Mode Configuration Overview

An administrator of a SharePoint environment can also configure or change the configuration of the List View Search app part. This happens directly on the ASPX page where the List View web part is placed on Edit mode of the page.

Once a list view has been initialized to show the List View Search, the search criteria are rendered above the actual view. By default the Title is the only search criteria field displayed.

When the page is in design mode the following options appear in the UI:

 

 

default.PNG

Note: You cannot edit the web part in this View mode. Design mode should be entered.

To get into design mode, navigate to Settings > Edit Page.

 

edit page.PNG

The web part is in Edit mode now.

 

 

Also observe that when the page is in design mode, there are several options you can configure in the UI:

 

i_1b8ab8620529b3e0_html_a8f42aa8.png- Add Field – Allows you to add additional fields.

i_1b8ab8620529b3e0_html_60384be6.png- Edit Query – Allows you to build queries in Query Editor.

i_1b8ab8620529b3e0_html_1e06ddd8.png- Settings – Allows you to configure additional settings related to List View Search.

 

 

i_1b8ab8620529b3e0_html_a8f42aa8.pngAdding/Removing Field

Pressing on the Insert Field button brings up a popup menu with a list of available and unused fields. Selecting a field will insert this field as a new search input.

 

1. Click Insert Field

A drop down list with all available and unused fields will be displayed.

 

 

2. The new field will be added. In the example, Company field is added.

 

 

3. To remove a field, simply click Delete (X) button in the row of that field.

       The field will be removed.

 

 

Reordering Field

 

You can re-order a field from one location to another. Simply drag and drop the field to the required location.

 

 

In the example above, the Company field is being moved above Last Name field.

 

i_1b8ab8620529b3e0_html_60384be6.pngAdditional Configuration in Query Editor

Query Editor is the best way to configure query used to filter the list view. You can add fields and apply required filter on the field. It has a lot of features and you can also create Any or All group conditions.

1. Edit Query.

The List View Search – Query Editor dialog will be displayed.

 

queryeditor.PNG

2. Grouping All/Any

The Query Editor allows you to add several multiple nested conditions. You can group conditions based on All or Any.

By default, you have one group. You can add multiple and nested groups to add conditions.

  • To add a group, click Add Group (i_1b8ab8620529b3e0_html_1ffb621b.png).

Note: Group will be added based on the level at which you are adding.

 

i_1b8ab8620529b3e0_html_f901812e.png

 

3. Select All or Any from the drop down list.

  • Grouping by All – This implies that each of the conditions must be true in order to execute. In the example, there is a condition for each of the fields such as Last Name, Company. So each of these condition must be true.

 

company-lastname2.PNG

  • Grouping by Any - This implies that any of the conditions must be true in order to execute. In the example, there is a nested condition for Email Address field. So any of these conditions of Email Address must be true in order to execute.

 

notequal.PNG

4. Adding Condition

You can add a custom condition.

After selecting All or Any option from the drop down list, click Save.

 

 

Any.PNG

A new condition row will be added.

  • Select the field on which you wish to apply the condition. In the example, Last Name is selected.

lastname.png

  • In the next field, select the condition  from the list. The available operators are Begins With, Contains, Not Equals, Greater Than, Greater Than or Equals, Less Than, Less Than or Equals, Is Empty and Is Not Empty. In the example, Contains is selected.

 

 

Contains.png

 

 

  • In the next field, select how you want to provide the value for the condition. The available options are Input or Value.

      Input can be a variable filter provided by the user. Value is a fixed filter and user cannot change it.

      Input – When you select this, it automatically shows the field name of the list by default. This is actually the name of the label in the input field. You can enter your own custom name to describe this input field.

 

 

Lastnameinputvalue.png

 

  • Select Input from the list.

 

  • You can set a default input value for the field. To do this, click More Options.

       The More Options dialog will be displayed.

 

 

  • Enter the Default Input Value.

 

  • Click OK.

     The default input value will be set for the field.

  • Select Value from the list.
  • Enter the fixed filter for search in the field.

 

 

 

 

    The condition will be added. In this way, you can add multiple conditions and/or nested conditions within groups.

    In the following example, you can see a exemple of a fixed filter (Value).

 

 

  • Finally, click Save.

       The changes made to the filter conditions will be updated.

       Here is an example of filters added through Query Editor.

 

When changed to active Status isn't possible see any item.

Removing Condition

To remove a condition, click Remove button in the row of that condition.

 

 

The condition will be removed.

 

Reordering Condition

You can reorder a condition from one location to another. Simply drag and drop the condition to the required location.

 

 

i_1b8ab8620529b3e0_html_1e06ddd8.pngConfiguring Settings

The Settings option allows you to configure settings used to filter the list view.

 

  1. Click Settings.

The List View Search – Settings dialog will be displayed.

 

applyautofilter.PNG

 

 

  1. Specify the type of filter to be applied while searching by checking the box in the relevant option. The available options are:
    • Don’t filter before Search is pressed – This doesn’t apply any filter till the Search button is pressed.
    • Apply autofilter – This will apply autofilter so that search results are automatically displayed based on the filters.

 

  3. Click Save.

 

The changes made to settings will be updated.

 

Run Mode

 

In Run mode, you can apply the configured filters and review the search results.

 

1. Navigate to the page/form/view where List View Search web part is added. In this example, we are using a page.

    The web page with List View Search part will be displayed.

 

inactive.PNG

  1. In the above example, we have the list view search for tasks (Company, Job Title Email Address and Status).

       Note: The filters are applied based on the grouping and/or nested conditions used in Query Editor.

 

Type AG.PNG

In the above example, the Company, Type AG is selected. As per the automatic filter setting we configured, the result is automatically filtered and displayed.

Attachments

    Outcomes