Like what you see? Have a play with our trial version.

Error rendering macro 'rw-search'

null

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »


Configuration Overview

This process involves setting up an analysis job for Signals. These configuration settings will vary based on the nature of the business, available data, and users’ preferences. The ultimate goal here is ensuring that the correct number of the most relevant insights are delivered to the most appropriate users at the earliest available time.


Signals analysis configuration may require adjustment over time in order to optimize the settings, or as the underlying data changes.


How to set up Signals

Signal configuration is done at the View level. Yellowfin will perform its analysis based on the setting details that you provide here; these must include:

  • Analysis group: The nature of the analysis. This could include outlier detection, time period comparison, or changes in trend. Each analysis type is linked to algorithms that allow Yellowfin to look for related patterns in your data.
  • Key Date field: This will become the basis of your time-series data around which changes are detected.
  • Time window: Specify the exact time period which you would like the system to analyze.
  • Schedule: You can take full advantage of the automation aspect of Signals, by setting up a flexible schedule to run them periodically.
  • Metric and dimension fields: You will need to specify the relevant metric and dimension field to analyze.
  • Parameters and thresholds: A set of advanced configurations is provided based on your selected analysis type. This gives users a chance to go deeper into the algorithm’s specifications, such as providing threshold values.
  • Users: You can choose the audience who will receive the Signals, so that only users who need the insights will receive them. In case of a multi-client organization structure, you can limit the Signals to be accessed by specific client orgs.


Instructions

Follow the instructions below to set up an automated Signals analysis job.

You will require the ‘Configuration’ role function to perform these steps. If you want to learn more about the Signals role functionality, refer to this section.


  1. To set up a Signals analysis, open the relevant view in edit mode, or create a clone and update it. 
  2. Navigate to the Prepare page, and click on the automated insights icon.



    You have an option of pre-selecting or changing certain pre-selected Automated Insights parameters or general settings related to Signal. Click here to learn more.

  3. In the new Automated Insights Setup popup, click on the Signals tab. This will show any Signal analysis that have been created. (If you do not see the Signals tab, ensure that you have the correct role functions enabled.)
  4. Click on the +Create New Analysis button to create a new Signals analysis. This initiates a multi-step configuration process to help you set up the automated analysis relevant to you.



    Step 1: Analysis group type

  5. Before beginning, establish the type of analysis that you want the system to perform for you. There are three analysis types to choose from. (Refer to the Signals type section to identify which type of anomaly to detect through one of these analysis types.)



    Analysis GroupDescription
    OutliersThe system detects any anomalies in the data, such as spikes/drops and breakouts during a specific time window. These could include rare events, items or observations that are significantly different from the majority of the data.
    Period comparisonsIdentifies changes in total or average between two time periods; and also identifies any significant new or lost key dimension values.
    Trend changes Identifies changes in trend direction between two time periods; and also any changes in the underlying volatility of the data.
  6. Click on the Next button of the preferred analysis to continue.


    Step 2: Name and description

  7. In the next step, provide the basic details to describe this Signals analysis.



    1. Name: (mandatory field) A unique name will help you to identify it later.
    2. Description: Add a description to explain the intent of this analysis.
  8. Continue to the next step.


    Step 3: Time & schedule


  9. The Time & Schedule step involves highlighting the time periods that you want the system to analyze, along with configuring how frequently this analysis should be executed. Below is a description of each of the settings. (Note: The fields and their purpose differ according to the different analysis types.)



    Field

    Analysis type

    Description

    Example

    Date field

    All

    The Signal analysis must include a date field that gets analyzed by the system. This is required to form a time series.

    You can choose a date field of any granularity (unit).


    Date Granularity

    All

    Specify the granularity (i.e. date unit) of the time series to analyze.

    This value should not be lower than the unit of your selected date field.

    For example, if you have a date field with day, then your granularity must be Day or a higher value (Month, Quarter, etc.)

    Period Configuration

    All

    This selection changes the time window selection fields. Options are:

    • Basic compare: Provides basic options to select time periods.
    • Advanced compare: Brings up advanced options for configuring the time period, that is, Window Size, and Offset.
    • Fixed Range: To select an exact date range. Useful when running one-off Signals analysis.

    Note: For Outlier analysis, only a single time period needs to be specified.


    Basic compare fields

    Compare the last

    All

    Specify the main time period window to be analyzed.

    Analyze the last ‘month’ will simply analyze the previous month.

    With

    Only Period compare and Trend changes

    Specify a secondary time period to be analysed. This time period is compared to the main target period specified above.

    Based on the above example, if this field was set to ‘quarter’, then the previous month will be compared and analyzed with the same month from the last quarter. (So the third month of the last quarter will be compared to the third month of the previous quarter.)

    Advanced compare fields

    Window size

    All

    This advanced configuration specifies the length of the time period to be analyzed. The value of the selected unit will always be 1.

    In case of period compare and trend changes where two time periods are analyzed, both the time periods will be of the same length.

    A window size of 1 month will analyze the last month for Outlier detection; or compare the last month, with the previous month prior to that, for Period comparision or Trend Changes.

    Offset

    Period comparison

    Use this advanced field to specify a time distance between the two time periods.

    A distance of the size specified here is formed from the end of the previous period to the beginning of the current period. An offset of 1 creates two sequential periods.

    Cannot have value of 0 as an offset.

    Say your window size is 3 months (from 1st Jan to 31st Mar 2018), an offset of 11 months, will compare the same 3 months (1st Jan to 31st Mar) of the previous year, i.e. 2017.

    Or if offset is set to 1, compare the last 3 months with previous 3 months.

    Trend changes

    Use this advanced field to specify a time distance between the two time periods.

    A distance of the size specified here is formed from the end of the previous period to the end of the current period. An offset of 1 window size unit creates two sequential periods.

    Cannot have value of 0 as an offset.

    For a window size of 3 months, where the offset is set to 1 year, the last 3 months are compared to 3 months from a year ago.

    Outliers

    Specifies how long ago should the target window size be analyzed.

    Cannot have value of 0 as an offset.

    If window size is 3 weeks, and offset is 5 months, then analyze 3 weeks from 5 months ago.

    Fixed range fields

    Target Period

    All

    Specify a fixed date range to analyze using the date picker


    Compare period

    Only period compare, trend analysis

    If your selected analysis compares two time periods, then specify the other one here. Note that the target period must be after the compare period. Both the periods should be of similar length.


    Schedule fields
    ScheduleAll

    Set a schedule for when and how frequently this analysis job should run.

    Note: For a weekly frequency or higher, use the Advanced Setting link for further specification.

    You can schedule your analysis to automatically run every Monday at noon, for example.
    FrequencyAll

    Depending on the option selected here, you may be required to provide further details.

    Tip: Select 'Once' as the frequency to send out the broadcast as soon as possible.

    For example, if Fortnightly is selected, you will be prompted to select either the first or second week of the fortnight to send in, as well as the day of the week.
    TimezoneAllSometimes you may find you need to set the Time Zone, and local time for delivery. This can be accomplished by clicking the Advanced Settings link.
  10. Continue to the next step to proceed.


    Step 4: Metric & dimensions

  11. In the Metrics & Dimensions step, you can select or unselect the fields in your data, that are important to you. Yellowfin will analyze these fields in order to detect Signals.

    Fields that are also selected for Assisted Insights, will be selected here by default. You can change these, as discusses in the additional setup process below.




    1. Metrics: Choose the numeric fields that will be analyzed, such as age, sales, profit. A default aggregation type must be specified for each metric for it to be analyzed. Choose one of the following aggregation types:
      Note: Choosing the right aggregation type for the metric is important. For example, instead of observing the sum of the Internet speed over time, it would be ideal to look at the average value of this metric. Some metrics will can be summed or averaged. This selection will affect the Signals that are generated.
      • Sum: generates insights based on the sum or total of the selected metric field.
      • Average: generates insights based on the average of the selected metric field.
    2. Dimensions: Select the dimension fields that are relevant to the analysis. The system will look for Signals related to these fields. (Note: Selecting too many may slow down the analysis.)
  12. Proceed to the next step by clicking on the Continue button.


    Step 5: Algorithm parameters

  13. In the Algorithm Parameters step, you can configure advanced Signals settings. These configurations will be specific to the selected analysis type, and the algorithms involved. See below for explanation on these.



    1. Advanced mode toggle: Use this toggle to view additional advanced settings. Descriptions for these are in the tables below, according to their selected analysis group.
    2. Configure sensitivity: Signals are generated when a detected data event exceeds pre-defined threshold. Use this slider to automatically increase or decrease these thresholds. The higher the sensitivity, the more signals will be generated. 
    3. Alternate threshold field: This parameter is specifically used for determining importance of Signals for the user base. When ranking a Signal for importance, the value of an alternate field can be used. This is mandatory for when calculated ratios or average fields are included in your job, and recommended best practice if you are using pre-calculated ratios. If an alternate metric is selected, it will be used to rank all analysis metrics in this job. Leave blank if you want to use the analysis metric to determine the threshold. 

      General advanced parameters:
      These are the general advanced parameters that can be configured for each analysis group. Note that their default values will differ according to the level of the Sensitivity Slider.

      ParameterDescription
      Max Timeline SignalsThe users receive alerts on relevant Signals in their Timeline. This parameter is used to define the maximum number of alerts that will be delivered to their Timeline. If more Signals are generated than this limit, they will be available in the user's Signal list.
      Max Correlated Signals Displayed

      The Signals engine looks at all of your data (in different views and databases) to see if there are data patterns similar to the current time series. This lets you know of possible relationships in your business, even if the matching patterns in data are not from the same data set, not even the same metrics or dimensions. We call this Correlation.

      The correlation lines will appear in the Signal detail page to let you compare and explore these relationships in data. There could be a large number of these lines. Use this to specify the maximum number of the most matching correlated lines that will appear in the Signals UI to be compared with the time series line.

      Min Correlated ThresholdCorrelation between 2 lines is calculated in a range of -1 to 1, where -1 signifies that the lines are moving in opposite directions, and +1 signifies that they’re going in the same direction. However, a value of 0 or very close to it means there’s no correlation. This threshold lets you alter this range for 0, so if the threshold is 0.4, then correlation ranging from -1 to -0.4 and 0.4 to 1 will be detected.
      Analysis Threshold %

      This threshold eliminates Signals that are of low value to the user. Only the total value of time slices that are equal to or greater than the defined % of the total baseline value will be considered important enough to analyse. For example, if your threshold is 2% and your baseline metric is Total Sales for Europe ($100,000) then Sales for Germany ($10,000 or 10% of baseline) or any country above $2000, will be analysed but Sales for Poland ($1,000 or 1% of baseline) or any country below will not. Generally values below 1% are best, with a maximum of 25%.

      Alternate Threshold FieldThis parameter is specifically used for determining the importance of Signals for the user base. When ranking a Signal for importance, the value of an alternate field can be used. This is mandatory for when calculated ratios or average fields are included in your job, and recommended best practice if you are using pre-calculated ratios. If an alternate metric is selected, it will be used to rank all analysis metrics in this job. Leave blank if you want to use the analysis metric to determine the threshold.



      Advanced parameters for Outliers analysis:

      Parameter

      Description

      Example

      Spikes, drops, and breakouts

      This algorithm looks for sudden increases (steps) or decreases (drops) in metric value. If successive Steps or Drops are detected, they are reported as a Prolonged Steps or Prolonged Drops respectively, signifying that there has been a breakout.

      Use this toggle to enable this algorithm and bring up additional configuration options related to it.

      Example of a spike, a lot of extra website visits occurred on a specific day.

      Baseline Period

      The baseline period is the number of date time periods used to create a moving average used in the analysis period. The longer the baseline, the smoother the moving average.

      The baseline period is recommended to be at least 1 seasonality cycle long. However, very long baseline periods will affect how long the signal job needs to run as more data is analysed.


      Baseline Outlier Influence on Moving AverageOutliers in the baseline period can influence the detection of Outliers in the analysis period by affecting the moving average and standard deviations. Use this setting to reduce its impact. A 30% reduction of outlier value is considered reasonable.
      Confidence Range WidthThe confidence interval or range is the value above or below the moving average that is considered normal. Outliers are values that sit outside of the confidence range. Use this setting to specify the range width in standard deviations from the moving average. A higher value makes the range larger, requiring a bigger spike or drop to be recognised as an outlier.This value must be between 2 and 5 with 3 being a reasonable setting.


      Advanced configuration for Period Comparison:

      Parameter

      Description

      Example

      Aggregate value changes

      This algorithm detects changes in sum and average value of a metric from one period to another.

      Use this toggle to enable this algorithm and bring up additional configuration options related to it.

      Eg. Total sales amount has dropped significantly this month compared to last month.

      Sum aggregates

      This algorithm detects changes in the total value of the metric field.

      Use this toggle to enable this algorithm.


      Threshold %

      A change in total must have an absolute percentage greater than this threshold to constitute a signal.

      For example, a  threshold of 10 will result in any sum changes greater than 10% being created as Signals.

      Threshold

      A change in sum must have an absolute value greater than this threshold to constitute a signal.

      Note: Only of the two threshold fields can be used to specify a limit.

      For example, a value of 20 will consider any sum changes greater than 20 as a signal.

      Average aggregates

      This algorithm detects changes in the average of a metric field.

      Use this toggle to enable this algorithm.


      Threshold %

      A change in average must have an absolute percentage greater than this threshold to constitute a signal.

      For example, a  threshold of 10 will result in any average changes greater than 10% being created as Signals.

      Threshold

      A change in average must have an absolute value greater than this threshold to constitute a signal.

      Note: Only of the two threshold fields can be used to specify a limit.

      For example, a value of 20 will classify any average changes greater than 20 as a signal.

      New and lost attributes

      This algorithm detects key dimensions that entered or left the data this period.

      Use this toggle to enable this algorithm and bring up additional configuration options related to it.

      Eg. A customer that bought a lot last month stopped buying this month.

      Minimum significance %

      A new or lost attribute's total series percentage must be greater than this threshold to constitute a signal.

      A minimum significance value of 20% would mean an attribute must make up more than 20% of total data to be detected as a signal.


      Advanced parameters for Trend Changes:

      Parameter

      Description

      Example

      Linear Trend Changes

      This algorithm detects changes in trend line slopes from one period to another, such as trend going from up to down, or growing significantly faster or slower.

      Use this toggle to enable the algorithm, and configure settings related to it.

      PC sales were growing but started to decline last month.

      Threshold %

      A change in trend slope must have an absolute percentage greater than this threshold to constitute a signal.

      For eg, a value of 10 will result in any trend slope change greater than 10% being created as Signals.

      Threshold

      A change in trend slope must have an absolute value greater than this threshold to constitute a signal.

      Note: Only of the two threshold fields can be used to specify a limit.

      For example, a value of 20 will consider any trend slope change value greater than 20 as a signal.

      Flat Trend Gradient Tolerance

      This numerical value will form a range about zero (that is, the same value in -/+ range) and any trends which have a slope falling inside this range will be considered to be flat.

      Values falling out of this range will be considered as having a positive slope (if a positive value), or a negative slope (that is the trend is going down because of a negative value).

      For example, a flat tolerance of 0.01 means that if a trend line slope falls within -0.01 to 0.01 then it will be considered to be flat.

      Volatility changes

      Detect changes in volatility between the compare and target periods. Measures changes in consistency of metric values.

      Use this toggle to enable the algorithm, and configure settings related to it.

      Eg. Daily sales of Blue Shoes was sporadic last month, but has become more regular.

      Threshold %

      A change in volatility must have an absolute percentage greater than this threshold to constitute a signal.

      For example, a  threshold % of 10 will result in any volatility changes greater than 10% to be classified as a Signal.

      Threshold

      A change in volatility must have an absolute value greater than this threshold to constitute a signal.

      Note: Only of the two threshold fields can be used to specify a limit.

      For example, a value of 20 will classify any volatility changes greater than 20 as a signal.


  14. Continue to the next step.


    Step 6: Client Organizations


  15. If you have a multi-client organization setup for your Yellowfin instance, then the additional Client Organizations step can be configured. Here you can choose to limit specific client organizations if you don’t want them included in the analysis (because unless specified, the system includes all the organizations by default).

    If enabled, the engine will only look at client organizations that can access the View this analysis is created in. (Note, however, that users of disabled organizations will still be able to access previously generated Signals, if the client orgs already exist. But if they’re new, they will not be able to access the Signals.)



    1. Enable the main toggle to initiate the client organization limitation functionality. A list of all your client orgs will appear.

    2. Enable the toggle for any client organization that you do want to include the analysis. (Clients with disabled toggles will not be included.)

    3. If you want to exclude all client organizations, leave their toggles disabled.

  16. Continue to the next step.

    Step 7: Users


  17. In the Users step, you can select users who’s related data will be included in the analysis (by default every user’s data will be included in the analysis, but we can choose to include only specific users here).



    1. Enable the toggle to include users in this analysis schedule.
    2. Then search and select these users (or groups).

  18. Once all the configurations are provided, save this analysis job by clicking on the Save and Exit button in the top corner.



  19. The saved Signals analysis job will appear in the list. You can delete a job or copy it to create a new one.



  20. To edit an analysis, click on its name.
  21. Use the Enabled toggle to enable or disable an analysis job. Disabling it would stop it from generating or detecting Signals. 



  22. Click Submit once done.
  23. Publish the view, and exit the view builder.
  24. The Signals analysis will run according to schedule. However, to manually run an analysis, refer to the section below.





Pre-selecting Signals Settings

Before you create a Signals job, there are certain general settings that you an option of setting up. These include pre-selecting the key date field, granularity level, updating the time slider, as well as updating the metric and dimension fields selected for Assisted Insights, as they are taken into account for the Signal analysis. This section covers these additional set-ups.

Define good or bad characteristics

The data fields that the Signal analysis focuses on are the same ones that were selected for Assisted/Automated Insights. (For more information on the Assisted Insights setup, click here.) This includes the characteristics of those fields, that is whether a high value is a good result or a bad one. To change these settings, see the below steps:

  1. Open the Assisted Insights Setup window , and click on the Key Variables tab. 



  2. Fields with the Included checkbox selected are the ones that are analyzed for the Signals analysis. You can change these if you prefer to focus on other fields.

  3. To include any fields in the Signals related charts (that is, charts based on data related to the main time series data, that appears on the final Signal UI for comparison), select their Related checkbox. 



  4. Establish if a high value of the field is a good result or bad. For example, higher sales would be good for the business, but a big number of workplace incidents would be bad. (Fun fact: this is also reflected in the Signals narrative - good results are highlighted as blue, and bad as orange.)


Pre-select time parameters 

You or your administrator can preset default values for the Signals’ time series. These will be merely selected as default values when setting up a new Signals analysis, but can be easily changed by the user, if required. The values you can set here include the default date field, the default granularity, and the time slider’s range.

Click on the General Settings tab in the set up window. Choose options for the three fields defined below. 



  • Primary Date Field: This field will be set as the default for the Signal’s time series chart. (The other two fields will only appear when a date field selection is made here.)

  • Scope of Analysis: Set a default granularity level of the Signals’ time series chart.

  • Max Data Range: This fields maximizes the time window that can be viewed in the Signal’s time series. The range established here effectively gets added to the start of the time slider. For example, if 3 months are specified in this field, the time slider will increase to add 3 months before its default time window.

Note: Any value set for these fields, has to be saved, before they can appear as default values in the Signals analysis.





Manually execute a scheduled Signals analysis

These instructions will allow you to run a Signals analysis task on demand.

 

  1. From the left side menu, expand Administration and click on Schedule Management.



  2. Choose the Signals analysis from the list and click Run Now.
  3. There are other options that you could perform through here.



    1. Edit: Use this option to change the scheduling details of this Signals task, such as, setting up a new schedule time.
    2. Resume: Resume a paused task.
    3. Delete: To delete the Signal analysis analysis.
  4. On running this task, you should receive Signals that the system detects. Signals that are relevant to you, will appear in your Timeline, but to see all the generated Signals, check the Signals list page.

    It’s also possible that a signal analysis detects no changes - this is not an error and is perfectly normal.









  • No labels