Filters: Difference between revisions

From RangerMSP Wiki - PSA software for MSPs and IT services providers
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 1: Line 1:
{{customization}}
Filters in RangerMSP allow you to define advanced search rules that can be applied for Accounts, Tickets, Charges, Items, etc. You can define the filter, save it easily and use it later to  filter lists.
<br>
==Create New Filter==
The Filter option is available in each window, in the left-top corner of the window:<br><br>


RangerMSP is very flexible. You can customize reports, rename field labels, create new tabs and new data fields, and manage values for drop-down lists, etc.
[[File:Filter-drop-down-menu.png]]


__TOC__
To create a new filter you can use one of the options:
==Customizing Existing Fields==
Fields in RangerMSP can be customized when needed. You should modify the default settings only when required; the system defaults are usually sufficient.


Fields in RangerMSP can be customized with the following settings:
*'''New''' - create new filter from scratch.
*The Name of the fields as displayed throughout the system where a field name is displayed
*'''New from template''' - use predefined template to create a filter. This will automatically define the fields and values for the search. These settings can be modified once the template is selected
*The field Label and Hint
*The field title on data grids/tables – Column Title
*The default value for new records
*The drop-down list that will be displayed for drop-down selection list fields
*Enabling the field to be updated in batch update (Accounts fields only)
*Enabling lists to be sorted by this field


To modify the field settings, log in to RangerMSP as a user with full privileges, and double-click on the field label. The field's Settings window will open. All modifications will be saved when you confirm before closing the window.


<u>Managing drop-down list values</u><br>You can also manage values for drop down lists throughout the system. For example, you can add values to the Ticket Types (e.g. Hardware, Installation, Software etc.). To add or modify values in the list, select '''[edit list...]''' from the drop down list.
<br>
===New Filter===
To create a new filter:
#Select Filter > New.
#Choose the fields you want to filter by and their values.
#You can add lines where each line is calculated according to the logical term (AND/OR) in the beginning of the line.
#You can use the [[Filters#By_Subject_.28filtering_by_user-defined_fields.29|By Subject]]  and [[Filters#Secondary_Filter_.28filtering_linked_data.29|Secondary Filter]] options. See more details below.
#You can choose to sort the results using the Sort fields at the bottom of the window.
#Click OK to finish.
#Note that in order to save the filter, you should use the Save option. See more details in [[Filters#Saving_Filters|Saving Filters]].<br>
[[File:Filter-new.png]]
<br>
<br>


There are pre-defined fields labeled '''Field''' (e.g. Field1, Field2) which can be customized as you see fit (you can also rename their label to your needs). For example, you can use Charge Field1, modify its label to "Status", and edit the values list to include possible values for the Status of a Charge.  
===New from Template===
Use predefined templates to create a filter. This will automatically define the fields and values for the search. These settings can be modified once the template is selected.


==Adding New Tabs==
Examples for templates:
*Accounts with Assets expiring next month.
*Accounts with expiring Contracts.
*Tickets which are open over 24 hours.
*Open Tickets without any logged charges.
<br>
To create from template:
#Select New from Template
#Choose the filter template you want to apply, and click Next. <br>[[File:Filter-new-from-template.png]]<br>
#In the next step, the [[Filters#New Template|New Template]] window opens, however, there are already predefined fields selected for this filter, as defined in the template. In this window you can modify the search criteria if needed (see [[Filters#New Template|New Template]] ). <br>[[File:Filter-from-template-criteria-window.png]]
<br>
<br>


For instructions on adding new tabs, go to [[Tab Management#Adding_New_Tabs|Tab Management]].
===Saving Filters===
While a new filter is being used without saving yet, the menu looks like this:<br><br>
[[File:Filter-unsaves-drop-down-menu.png]]
<br><br>
The pause and delete options provide a quick way to stop the filter from affecting the list. These options will appear when hovering over the (Unsaved) label. At this stage, you can use the filter, pause it and edit it, however, it will not be saved until you actually save it.
<br><br>
To save the filter for future use:
#From the Filter menu, choose Save
#The Save window opens<br>[[File:Filter-save-window.png]]
#Enter a name for this filter
#Choose whether you want to share this filter with other users
#Click OK to save.
#The filter is now available in the filter drop-down menu.
<br>
<br>


===By Subject (filtering by user-defined fields)===
For entities that have user-defined fields, you can use the "By Subject" tab which allows you to filter according to the user-defined fields. Here you can choose the subject you want to filter by, and this will give you the relevant field list for this subject. A subject is basically a fields-group, which can be defined when adding new fields. For more details about adding your own fields, [[Field_Customization|click here]].
<br>
<br>
===Secondary Filter (filtering linked data)===
The secondary filters allow you to create super-advanced filters on the results, and narrow down the results to exactly what you want to see.
For example, you can filter Charges, and narrow the results by specific ticket type, which reflects the type of problem (i.e. printer, mobile phone, laptop etc.,). This feature is quite powerful and provides great analytic possibilities.
<br>
Other examples:
*Filter Tickets to display only Tickets related to Accounts to which a specific Employee is assigned.
*Filter Charges to display all Charges logged for Block of Time Contracts that belong to Accounts which are assigned to a specific Employee.
*Filter Charges to display only Charges for Completed Tickets that belong to Accounts of the type 'Law Office'.
*Filter Tickets to only display Tickets of VIP Accounts.
*Filter Charges to only show Charges related to Block of Time Contracts.
*Filter Tickets to only show Tickets linked to Assets whose warranty has expired.
*Filter Opportunities to only show Opportunities of Accounts that I am assigned to as the manager.
<br>
To use the secondary filter:
#Create a [[Filters#New_Filter|New filter]]
#Selecting the Secondary Filter Tab.
#The available data sources appear. Each has a Filter button.
#Click Filter for data sources you want to filter and define the filters in the window that opens.
#Click OK.
#The chosen filter now shows (Filter Active)<br>
[[File:Filter-secondary-filter-window.png]]<br>


==Creating New Fields==
<br>
To add new fields to user-defined tabs you can use two options:
# Right-click the tab area and choose Add New Field to Tab.
# Go to Tools > Field Management and from the Field Management Window, click the New icon to add a new field.


You can either add existing fields to be displayed in your tab, or create totally new fields in the database that will be displayed in your tab.
[[File:setup_guide_field_new_window.gif|center]]
When adding a new field (as opposed to an existing field), you should choose the field type from the field types list.
[[File:Tab-management3.png|center]]
Field type can be a simple text or numeric field, or a selection field pointing to objects from your database, such as Account, Document, or when using the Linked Object Type, you can choose between Asset, Ticket, Opportunity or Contract.
You can create as many new tabs as needed and create as many new fields as needed. You can also design the layout of the tab page as best suits your needs.
In any case, it is always recommended to backup your RangerMSP installation before performing any customization!


==Advanced Queries==
When creating a Filter from templates, some of the templates are marked with (*), marking them as  “advanced”. These templates are system-defined templates and use advanced queries on data related to the entity. These queries cannot be defined manually, however, users can define the search criteria in the next window.
For example:<br>
[[File:Filter-new-template-advanced.png]]
<br>


==See Also==
==Non-Expiry Search Options==
When defining filters which are date-time based, such as by Ticket Due Date or Creation Date, etc. you can use non-expiring conditions, which are always relevant to the day you activate the filter.
For example, saved filters that can be used everyday:
*Tickets created yesterday.
*Tickets that are due tomorrow.
*Contracts that expire this week.
*Assets expiring next month.


* [[Tab Management]]
==Renaming Filter==
Once a filter is saved, you can rename it by using a special option.
To rename a filter:
#Choose the filter from the filters list.
#Select Filter > Rename/Share <br>[[File:Filter-rename-menu-option.png]]
#The following window opens:<br>[[File:Filter-rename-window.png]]
#Enter the new name in the Name field.
#Click OK to finish.


[[Category:Customization]]
==Sharing Filter With Other Users==
Filters can be shared so that other users can enjoy the already defined filters.
When saving the filter for the first time, you can also set the sharing options in the new filter window. See [[Filters#Saving_Filters|Saving Filters]] for more details.
To share an existing filter:
#Choose the filter from the filters list.
#Select Filter > Rename/Share <br> [[File:Filter-rename-menu-option.png]]
#The following window opens: <br> [[File:Filter-sharing-window.png]]
#Choose Everyone to share your filter. Note that only users with “Save Filter” privileges can edit the filter. See more details in [[Employee_Privileges|Employee Privileges]].
#Click OK to finish.

Latest revision as of 08:11, 8 July 2020

Filters in RangerMSP allow you to define advanced search rules that can be applied for Accounts, Tickets, Charges, Items, etc. You can define the filter, save it easily and use it later to filter lists.

Create New Filter

The Filter option is available in each window, in the left-top corner of the window:

To create a new filter you can use one of the options:

  • New - create new filter from scratch.
  • New from template - use predefined template to create a filter. This will automatically define the fields and values for the search. These settings can be modified once the template is selected



New Filter

To create a new filter:

  1. Select Filter > New.
  2. Choose the fields you want to filter by and their values.
  3. You can add lines where each line is calculated according to the logical term (AND/OR) in the beginning of the line.
  4. You can use the By Subject and Secondary Filter options. See more details below.
  5. You can choose to sort the results using the Sort fields at the bottom of the window.
  6. Click OK to finish.
  7. Note that in order to save the filter, you should use the Save option. See more details in Saving Filters.



New from Template

Use predefined templates to create a filter. This will automatically define the fields and values for the search. These settings can be modified once the template is selected.

Examples for templates:

  • Accounts with Assets expiring next month.
  • Accounts with expiring Contracts.
  • Tickets which are open over 24 hours.
  • Open Tickets without any logged charges.


To create from template:

  1. Select New from Template
  2. Choose the filter template you want to apply, and click Next.

  3. In the next step, the New Template window opens, however, there are already predefined fields selected for this filter, as defined in the template. In this window you can modify the search criteria if needed (see New Template ).



Saving Filters

While a new filter is being used without saving yet, the menu looks like this:



The pause and delete options provide a quick way to stop the filter from affecting the list. These options will appear when hovering over the (Unsaved) label. At this stage, you can use the filter, pause it and edit it, however, it will not be saved until you actually save it.

To save the filter for future use:

  1. From the Filter menu, choose Save
  2. The Save window opens
  3. Enter a name for this filter
  4. Choose whether you want to share this filter with other users
  5. Click OK to save.
  6. The filter is now available in the filter drop-down menu.



By Subject (filtering by user-defined fields)

For entities that have user-defined fields, you can use the "By Subject" tab which allows you to filter according to the user-defined fields. Here you can choose the subject you want to filter by, and this will give you the relevant field list for this subject. A subject is basically a fields-group, which can be defined when adding new fields. For more details about adding your own fields, click here.

Secondary Filter (filtering linked data)

The secondary filters allow you to create super-advanced filters on the results, and narrow down the results to exactly what you want to see. For example, you can filter Charges, and narrow the results by specific ticket type, which reflects the type of problem (i.e. printer, mobile phone, laptop etc.,). This feature is quite powerful and provides great analytic possibilities.
Other examples:

  • Filter Tickets to display only Tickets related to Accounts to which a specific Employee is assigned.
  • Filter Charges to display all Charges logged for Block of Time Contracts that belong to Accounts which are assigned to a specific Employee.
  • Filter Charges to display only Charges for Completed Tickets that belong to Accounts of the type 'Law Office'.
  • Filter Tickets to only display Tickets of VIP Accounts.
  • Filter Charges to only show Charges related to Block of Time Contracts.
  • Filter Tickets to only show Tickets linked to Assets whose warranty has expired.
  • Filter Opportunities to only show Opportunities of Accounts that I am assigned to as the manager.


To use the secondary filter:

  1. Create a New filter
  2. Selecting the Secondary Filter Tab.
  3. The available data sources appear. Each has a Filter button.
  4. Click Filter for data sources you want to filter and define the filters in the window that opens.
  5. Click OK.
  6. The chosen filter now shows (Filter Active)




Advanced Queries

When creating a Filter from templates, some of the templates are marked with (*), marking them as “advanced”. These templates are system-defined templates and use advanced queries on data related to the entity. These queries cannot be defined manually, however, users can define the search criteria in the next window. For example:

Non-Expiry Search Options

When defining filters which are date-time based, such as by Ticket Due Date or Creation Date, etc. you can use non-expiring conditions, which are always relevant to the day you activate the filter. For example, saved filters that can be used everyday:

  • Tickets created yesterday.
  • Tickets that are due tomorrow.
  • Contracts that expire this week.
  • Assets expiring next month.

Renaming Filter

Once a filter is saved, you can rename it by using a special option. To rename a filter:

  1. Choose the filter from the filters list.
  2. Select Filter > Rename/Share
  3. The following window opens:
  4. Enter the new name in the Name field.
  5. Click OK to finish.

Sharing Filter With Other Users

Filters can be shared so that other users can enjoy the already defined filters. When saving the filter for the first time, you can also set the sharing options in the new filter window. See Saving Filters for more details.

To share an existing filter:

  1. Choose the filter from the filters list.
  2. Select Filter > Rename/Share
  3. The following window opens:
  4. Choose Everyone to share your filter. Note that only users with “Save Filter” privileges can edit the filter. See more details in Employee Privileges.
  5. Click OK to finish.