| Note |
|---|
On this page (-tree) we will gather guides and best practices how to operate the segmentation editor as well as how to define segmentations |
Segmentations
| Note |
|---|
|
The Segmentation Editor
Overview of the Segmentation Editor
| Note |
|---|
|
Training videos
...
Prio
...
Status
...
Name of Video
...
Script
...
Voiceover
...
Video
...
| Status | ||
|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
Basics
...
Find the UI in the menu
Search for an existing segmentation and view it
Create a new segmentation, select a source segmentation (e.g. ratings) and define the translation for language
en
...
The Segmentation editor is located in the menu under “Segmentations”.
You can search for a specific segmentation using the search box.
To view it, simply click on the row in the search results.
To create a new segmentation, click on the plus on the right side above the table.
Select a source segmentation, give it a name and add a translation to it.
Hit “save” to complete.
Congratulations! That concludes the basics of the Segmentation Editor.
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
Grouping of segments
...
Open a newly create (empty) segmentation
Note that the source segmentation is ratings
Create a first segment named “A” and
give it a default translation of A
select all source segments that match (AAA, AA, A)
Create a second segment named B
Create a third segment named HY
give it a translation en as “High Yield”
select segments C, D, E
Define the rest segment as “Others”, set “Include unmapped segments…”
No ordering or selection needed
| Note |
|---|
Potential problem is that in our sample / demo solution there are many (base) segmentations named “csamXYZ” that should not be shown in a public video… |
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
Define the ordering of segments
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
Define the selection of segments
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
Segmentations
Segmentations are used to generate the optimal structure for a visualisation (e.g. table or chart) by defining how data will be aggregated. Segmentations are a part of the reporting business logic (see Business Logic (Concepts Guide)).
This page describes the features of a segmentation. See also Best practices to use Segmentation for a more in depth discussion about how to use segmentations.
Types of segmentations
Type | Description | |
|---|---|---|
Base Segmentation | Base segmentations like currency, country, asset class are typically delivered by the source systems (e.g. a portfolio management system) and are described by a source API
| |
Derived Segmentations | In reporting we typically don’t want to list all currencies invested but a rather more optimised break down to populate a table or chart., e.g. CHF, USD + next 3 largest currencies + a rest segment (aggregating all other currencies). Derived segmentations allow features like grouping, ordering, selection of segments on top of base segmentations or even other derived segmentations.
|
The Segmentation Editor
To create or modify a derived segmentation, the Segmentation Editor can be used. The UI is organised into the following sections:
Listing of segmentations | The list of segmentations allows to
|  |
Header and Settings |
|  |
Segments (Grouping) |
rule language
|  |
Segments | rule language | Alternatively to an include list, a segment can be defined by a  Supported syntax for filterPredicate:
|
Rest Segment |
|  |
Ordeing |
|  |
Selection |
|  |