Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Look & Feel

Image Removed

Technical Details

Squirro iFrame object properties in WebView

Formatting tab (Visual Properties)

Visual configuration
  • width can be adjusted
  • height cannot be adjusted
  • Scroll icon left and right to navigate through the result list
    • result items will only be displayed in horizontal format
    • vertical item listing is not possible
Visual effects
  • read items will be shown dimmed
  • unread items will be shown solid
Supported tabs
  • Read
    • enables in-iFrame Squirro queries
    • displays query string on dashboard selection impacting iFrame content
  • Sources
    • displays data sources of configured Squirro project
    • HINT: "Add Sources" leads to the mobile dashboard view
  • Settings
    • displays Squirro settings in mobile browser manner
      (do we really need it that way)? 
  • Essentials
    • connects to a broken LinkedIn page (on Squirro-box)

Best practice is to enable the read tab if any tab is wanted!

Configuration Properties

The logical configuration of the iFrame covers "Item Filtering" and "Squirro Settings".

Most configurations can be set hard-coded or via Qlik variables from the load script.  

Squirro Settings tab

Settingexampleexplanation
Project ID
  • variable: vSquirroProjectID
  • value: 7sJQVzBdSECah5_ONGtvllx
  • specifying the Squirro Project ID
Server URL
  • varuable: vSquirroClusterID
  • value: http://my-squirrobox.local
  • specifying Squirro Server ID (cloud or Squirro-in-a-box)
  • it is important to specify the "http://" preceding the IP or name
Login Token
  • variable: vSquirroToken
  • value: 22ce6730d601a705........430718ec4e65d33971f
  • specifying Squirro API access token

 

Item Filtering 

Settingexampleexplanation
Created After
  • variable: $(vCreatedAfter)
  • value: 2010
  • slice Squirro results to after 31.12.2010
Created Before
  • value: $(vCreatedBefore)
  • value: 2014
  • slice Squirro results to before 01.01.2014
Date FormatYYYY
Query
  • variable: $(vQuery)
  • value: $external_id:a11427 OR $external_id:a25659
  • any Squirro query can be put in here
  • typically the query string is put together dynamically
    • the logic of the project at hand determines how the string is put together
    • this is typically defined in the Qlik load script
    • $-Expansion must be used if a dynamic refresh of the Squirro items is expected when the user changes the Qlik selection
  • Internet Explorer forbids that the URL GET string can be longer than 2048 including the characters for the URL
    • make sure the string does not exceed this length
Locationn/a
  • when is that used?
Fingerprintn/a
  • do we actually use that? I've seen it being done dynamically only?
Noise Leveln/a
  • do we actually use that? I've seen it being done dynamically only?

Integration & Configuration

For detailed documentation how the iFrame can be used and configured in different ways via the Qlik LoadScript please

refer to the sample project QlikView "Bugzilla" LoadScript Documentation

Further Information about Squirro iFrame

...

Introduction

Excerpt
This section provides the reference documentation on the Squirro iFrame QlikView extension. The extension allows the iFrame to be integrated into any QlikView dashboard.

Table of Contents

Table of Contents
maxLevel4
outlinetrue
excludeTable of Contents|Introduction

Installation

For installation of this extension please refer to QlikView Extensions Installation which covers installation both on the desktop as well as the QlikView server.

Configuration

The Squirro iFrame extension object is configured by specifying the individual object parameters in the extension object. Note that some parameters are mandatory. The extension object translates the object parameters from QlikView to URL parameters. Find the complete reference documentation on the URL parameters at iFrame.

Item Filtering

Filters are applied on top of the context selection.

See Item Filtering for the complete reference documentation.

Created Before and After

Show only items that were created before or after a given date.

A valid Date is mandatory.

Example

Assuming our dashboard has a Time-Date field. Select the first and last Date for the current selections in QlikView.

Image Added

Date Format

Allows a date format to be specified.

An empty value uses the users locales to parse dates. Specifying a date format makes parsing consistent across systems with different locales.

 TokenOutput
MonthM1 2 ... 11 12
 Mo1st 2nd ... 11th 12th
 MM01 02 ... 11 12
 MMMJan Feb ... Nov Dec
 MMMMJanuary February ... November December
Day of MonthD1 2 ... 30 30
 Do1st 2nd ... 30th 31st
 DD01 02 ... 30 31
Day of YearDDD1 2 ... 364 365
 DDDo1st 2nd ... 364th 365th
 DDDD001 002 ... 364 365
Day of Weekd0 1 ... 5 6
 do0th 1st ... 5th 6th
 dddSun Mon ... Fri Sat
 ddddSunday Monday ... Friday Saturday
Week of Yearw1 2 ... 52 53
 wo1st 2nd ... 52nd 53rd
 ww01 02 ... 52 53
ISO Week of YearW1 2 ... 52 53
 Wo1st 2nd ... 52nd 53rd
 WW01 02 ... 52 53
YearYY70 71 ... 29 30
 YYYY1970 1971 ... 2029 2030
AM/PMAAM PM
 aam pm
HourH0 1 ... 22 23
 HH00 01 ... 22 23
 h1 2 ... 11 12
 hh01 02 ... 11 12
Minutem0 1 ... 58 59
 mm00 01 ... 58 59
Seconds0 1 ... 58 59
 ss00 01 ... 58 59
Fractional SecondS0 1 ... 8 9
 SS0 1 ... 98 99
 SSS0 1 ... 998 999
 ss00 01 ... 58 59
TimezoneZ-07:00 -06:00 ... +06:00 +07:00
 ZZ-0700 -0600 ... +0600 +0700
Unix TimestampX1360013296
Example

Assuming the date is 06/18/2013 the format string is MM/DD/YYYY.

For dashboards with more than one date format. The date can be formatted by QlikView. The QlikView Date function takes the format as second parameter. In the Created Before and After example the Created After expression with the date formatted trough QlikView looks like this:

=Date(Min([Time-Date]), 'MM/DD/YYYY')

Query

Searches with the provided query string in the selected context. The search query is visible to the user and can be modified by the user.

For advanced queries read the Query Syntax documentation.

Example

Assuming the dashboard has a field Industry. Filter the shown items by a single selection in the Industry field.

Image Added

Location

Filter items by Lon, Lat coordinates for a point, circle or rectangle.

Reference documentation

Example

The center of Puerto Rico is located at 18.51,-67.25. Show only items that are in a 10km radius of the center of Puerto Rico.

Image Added

Smart Filter

Preselect a tenant smart filter by its name. Get the name from the Smart Filter UI which is found at https://squirro.com/app/#reader/fingerprints (see Endpoint Mapping for more information).

Image Added

Noise Level

Defines how relevant an item needs to be to show up. It is used in combination with a smart filter.

Allows a floating point number between 0.0 and 1.0.

Formatting & Display

Tab Configuration

Select the tabs that are visible to the user.

Tabs
ValueTabDescription
readReadShow items from the selected project.
infoEssentialsSearch for and display companies. This is recommended if your items are companies.
sourcesSourcesDisplay and manage sources.
settingsSettingsManage social connections and user profile details.

Smart Filter Tags

Restricts the user to choose from the smart filters that match the given tag(s). Allows a string with one or more smart filter tags separated by the pipe character |. Shows all smart filters that match any tag.

Example: 'pharma|patents'

Settings

Project ID

The project identifier is a string that uniquely identifies your project.

To retrieve the project identifier select your project on https://squirro.com/app (see Endpoint Mapping for more information). The URL part after #reader/ is the Project ID. In this example it is OujFXYk8RlKiH7RFd0Zs-Q.

Image Added

Server URL

https://squirro.com or your local instance according to Endpoint Mapping. A new endpoint will be verified and result in an error for unexpected answers.

Example

In the depicted example an invalid Squirro URL has been entered.

Image Added

The URL will not respond as expected and yield an error.

Image Added

Login Token

Allows to specify a token which is used for authentication with the Squirro platform. The token is bound to one Squirro user which will be shared between all users of the QlikView dashboard.

For creating the token see User Token Generation.

Troubleshooting

This section shows how to solve some problems that you may encounter when using the Squirro for QlikView extension.

Navigation to the webpage was canceled

When opening a QlikView file with enabled WebView, sometimes you may see the following error message:

Image Added

This happens when QlikView was not started before opening the file.

To fix this problem, follow this process:

  1. Close QlikView by selecting the File -> Exit menu option.
  2. Open QlikView from the Windows start menu.
  3. Use the File -> Open… menu to find the QlikView file on the disk and open it.

Please contact our support if the problem persists.