Update Relational Browsing screenshots

sirensolutions · Mar 21, 2018 · 583d0f5 · 583d0f5
1 parent 7fea02e
commit 583d0f5
Show file tree

Hide file tree

Showing 20 changed files with 30 additions and 21 deletions.
diff --git a/docs/dashboard.asciidoc b/docs/dashboard.asciidoc
@@ -169,7 +169,7 @@ is stored in Elasticsearch. A formatted export contains the results of any appli
 [[changing-the-visualization]]
 == Changing the Visualization
 
-Click the _Edit_ button image:images/EditVis.png[Pencil button] at the top right of a container to open the
+Click the _Edit_ button image:images/visualization/edit-vis-pencil.png[Pencil button] at the top right of a container to open the
 visualization in the <<visualize,Visualize>> page.
 
 [float]

diff --git a/docs/dashboard/filter_pinning.asciidoc b/docs/dashboard/filter_pinning.asciidoc
@@ -28,12 +28,21 @@ filter, displaying only elements that _don't_ match, toggle the filter. Exclusio
 
 Remove Filter image:images/filter/filter-delete.png[]:: Click this icon to remove a filter entirely.
 Custom Filter image:images/filter/filter-custom.png[]:: Click this icon to display a text field where you can customize the JSON
-representation of the filter and specify an alias to use for the filter name:
-+
-image::images/filter/filter-custom-json.png[]
-+
+representation of the filter and specify an alias to use for the filter name, for example, to filter the data to just the companies based in London:
+
+image::images/relational_filter/london-companies-example-filter.png["London Companies Filter Example", align="center"]
+
+Adding the `London Companies` label to the filter displays that label on the filter bar:
+
+image::images/relational_filter/london-companies-filter-bar-with-label.png["London Companies Filter Bar", align="center"]
+
+Omitting the label displays the filter query in the filter bar:
+
+image::images/relational_filter/london-companies-filter-bar.png["London Companies Filter Bar", align="center"]
+
 You can use a JSON filter representation to implement predicate logic, with `should` for OR, `must` for AND, and `must_not`
 for NOT:
+
 +
 .OR Example
 ==========
@@ -100,5 +109,7 @@ for NOT:
 ==========
 Click the *Done* button to update the filter with your changes.
 
+NOTE: See {elastic-ref}/query-dsl.html[Query DSL documentation] for more information on the possibilities.
+
 To apply any of the filter actions to all the filters currently in place, click the image:images/filter/filter-actions.png[]
 *Global Filter Actions* button and select an action.
diff --git a/docs/images/dashboard/edit-button.png b/docs/images/dashboard/edit-button.png
diff --git a/docs/images/relational_filter/add-a-filter-button.png b/docs/images/relational_filter/add-a-filter-button.png
diff --git a/docs/images/relational_filter/example_1.png b/docs/images/relational_filter/example_1.png
diff --git a/docs/images/relational_filter/example_2.png b/docs/images/relational_filter/example_2.png
diff --git a/docs/images/relational_filter/example_3.png b/docs/images/relational_filter/example_3.png
diff --git a/docs/images/relational_filter/example_4.png b/docs/images/relational_filter/example_4.png
diff --git a/docs/images/relational_filter/london-companies-example-filter.png b/docs/images/relational_filter/london-companies-example-filter.png
diff --git a/docs/images/relational_filter/london-companies-filter-bar-with-label.png b/docs/images/relational_filter/london-companies-filter-bar-with-label.png
diff --git a/docs/images/relational_filter/london-companies-filter-bar.png b/docs/images/relational_filter/london-companies-filter-bar.png
diff --git a/docs/images/relational_filter/relational_filter_companies_source.png b/docs/images/relational_filter/relational_filter_companies_source.png
diff --git a/docs/images/relational_filter/relational_filter_companies_target.png b/docs/images/relational_filter/relational_filter_companies_target.png
diff --git a/docs/images/relational_filter/relational_filter_config.png b/docs/images/relational_filter/relational_filter_config.png
diff --git a/docs/images/relational_filter/spy.png b/docs/images/relational_filter/spy.png
diff --git a/docs/images/relational_filter/spy_debug.png b/docs/images/relational_filter/spy_debug.png
diff --git a/docs/images/relational_filter/spy_filterjoin.png b/docs/images/relational_filter/spy_filterjoin.png
diff --git a/docs/images/EditVis.png → .../images/visualization/edit-vis-pencil.png b/docs/images/EditVis.png → .../images/visualization/edit-vis-pencil.png
diff --git a/docs/management/relations.asciidoc b/docs/management/relations.asciidoc
@@ -31,7 +31,7 @@ image::images/relations_settings/indices_settings.png["Graph of Index Patterns",
 [float]
 [[kibi-join-limit]]
 ==== Join Limit
-Clicking the image:images/EditVis.png["Edit pencil"] opens the advanced setting for each relation 
+Clicking the image:images/visualization/edit-vis-pencil.png["Edit pencil"] opens the advanced setting for each relation 
 where you can set the maximum number of unique values returned from the related index pattern for that relation. 
 
 As a semi-join, these documents will be filtered based on the presence of a *non-empty* value for the `join` field

diff --git a/docs/relational_filter.asciidoc b/docs/relational_filter.asciidoc
@@ -23,23 +23,26 @@ Both indices are <<kibi-settings-relations,configured>> so that they are joined
 
 In the _Articles_ dashboard, the relational filter visualization is displayed as a button which indicates the number of documents in the _Companies_ dashboard that are mentioned in the articles of the current dashboard.
 
-The screenshot below shows the button for the relation described in the example; there are 18011 companies mentioned in the 602,000 articles currently displayed:
+The screenshot below shows the button for the relation described in the example; there are 18508 companies mentioned in the 646,896 articles currently displayed:
 
-image::images/relational_filter/relational_filter_companies_source.png["Relational filter button on the Articles dashboard",align="center", width="400"]
+image::images/relational_filter/relational_filter_companies_source.png["Relational filter button on the Articles dashboard",align="center", width="600"]
 
-Clicking on the button will switch you to the _Companies_ dashboard and display the 18011 companies; the relational filter is displayed in the filter bar, as displayed below:
+Clicking on the button will switch you to the _Companies_ dashboard and display the 18508 companies; the relational filter is displayed in the filter bar, as displayed below:
 
-image::images/relational_filter/relational_filter_companies_target.png["Relational filter on the Companies dashboard",align="center", width="400"]
+image::images/relational_filter/relational_filter_companies_target.png["Relational filter on the Companies dashboard",align="center", width="600"]
 
-The relational filter visualization requires the {federate-website}[Siren Federate plugin {federate-version}]
+NOTE: The relational filter visualization requires the {federate-website}[Siren Federate plugin {federate-version}]
 for Elasticsearch.
 
 [float]
 [[relational_filter_config]]
 === Configuration
 
-Click on the _Add filter_ button to create a new filter in the visualization;
-the filter is defined by the following parameters:
+To edit the Relational Filter configuration, click the image:images/dashboard/edit-button.png["Dashboard Edit Button"] on the Dashboard top navigation bar.
+
+Then click the image:images/visualization/edit-vis-pencil.png["Visualization Edit Button"] on the Relational Filter visualization.
+
+The filter is defined by the following parameters:
 
 * _Button label_: the label of the button that will be displayed inside the visualization, e.g. `Companies -->`.
 * _Custom filter label_: the label of the filter that will be displayed in the filter bar, which by default is `... related to ($COUNT) from $DASHBOARD.`. Several variables are available for customizing the label:
@@ -100,7 +103,7 @@ information about the raw data replace the visualization, as in this example:
 
 image::images/relational_filter/spy.png["Spy panel of the relational filter visualization",align="center"]
 
-This panel provides two kinds data: information about the query behind the relational filter in the `Multi Search` tab, and details about the visualization object in the `Debug` tab.
+This panel provides two kinds of data: information about the query behind the relational filter in the `Multi Search` tab, and details about the visualization object in the `Debug` tab.
 
 [float]
 ==== Multi Search
@@ -116,11 +119,6 @@ On the top, the time reported in `Multi search request duration` informs on how
 
 For a particular relational filter, you can get additional information about the query that got executed.
 
-.Filterjoin
-This displays a table that provides several statistics about each join.
-
-image::images/relational_filter/spy_filterjoin.png["Details about the filterjoin query",align="center"]
-
 .Raw Request
 The filterjoin query as sent by {kibi-name}. This uses the internal API for defining the join.
 
@@ -138,8 +136,8 @@ The Debug tab presents the JSON object that {kibi-name} uses for this relational
 image::images/relational_filter/spy_debug.png["Debug spy panel of the relational filter visualization",align="center"]
 
 [float]
-==== Join Limit
-The number of unique values returned from the `source` of the relation is limited by the `kibi:joinLimit` Advanced Setting in the management section.
+==== Join Task Limit
+The number of unique values returned from the `source` of the relation is limited by the `kibi:joinTaskTimeout` Advanced Setting in the management section.
 These `source` values are then used to filter the documents on the `destination`. In general, the `destination` is the current dashboard.