Getting Started with Analytics

Once you have run a model, you can visualize your results using the Analytics module. A dashboard in the Analytics module is a collection of visualizations. Visualizations can take on many forms, such as charts, tables or maps.

Accessing the Analytics Module

To access the Analytics module:

1. Click on the hamburger icon to open the Modules drop-down list.
2. Click on Analytics in the list which will open the Analytics module.

Once in the Analytics module, the left-hand side panel looks as follows:

1. There is a set of default dashboards included in every new Cosmic Frog model. We will see some examples of these next. Their names indicate the technology they apply to:
   
   1. "Optimization..." dashboards are specific for Neo (network optimization) solves.
   2. "Greenfield..." dashboards are specific to Triad (Greenfield) solves.
   3. "CTS..." dashboards are cost to serve dashboards specific for Neo solves.
   4. The "Sensitivity at Scale" dashboard analyzes outputs of scenarios run using the Sensitivity at Scale Scenarios option in Cosmic Frog, which can use any of the technologies.
   5. "Transportation..." dashboards are specific for Hopper (transportation optimization) solves.
2. At the top there is an Analytics drop-down menu which we will see the details of a little further below.
3. To quickly find the dashboard of interest, users can use the search textbox. Dashboards with the typed search text in their name will be filtered out.
4. The dashboards can be sorted either by Default, which is the order in which they were added, or by Name. The latter sorts them alphabetically in ascending order (A to Z) and when clicked again the sort is reversed (Z to A).
5. This left-hand side panel can be collapsed by clicking on the double caret icon. Clicking the icon while collapsed will expand the panel.

Default Dashboards

When opening a dashboard it is shown in the central part of Cosmic Frog. This is the default Optimization Scenario Comparison dashboard shown for the Global Supply Chain Strategy model, which highlights some common analytics and metrics:

Many dashboards are designed to be interacted with through a set of filters, like for example the Optimization Transportation Flows one (also shown for the Global Supply Chain Strategy model):

In the screenshot directly above, the dashboard is shown for all products in the model, which includes raw materials and finished goods. Filtering for just the finished goods changes the shown chart on this dashboard as follows:

We can hover over visualization elements to get more information, which will be shown in a tooltip. Here, we show the information for one of the facilities, Princeton Factory, in a chart named Facility Geographic Risk Metrics, which is part of the Optimization Facility Risk Summary dashboard. This is again in the Global Supply Chain Strategy model:

Analytics (Context) Menu

The Analytics drop-down menu at the top of the module contains the following options:

1. New Dashboard - creates a new empty dashboard where users can add and configure their own visualizations.
2. Duplicate - makes a copy of the currently selected dashboard. Users can for example use a copy as a starting point for their own modifications and additions.
3. Rename - change the name of a dashboard.
4. Copy Name - copies the name of the dashboard to the Clipboard.
5. Delete - removes the dashboard; users will be prompted to confirm the removal.

The context menu that comes up when right-clicking on a dashboard in the list has all the same options, except for the New Dashboard one:

Creating a New Dashboard

After you click on New Dashboard in the Analytics menu, the central part of Cosmic Frog will look as follows:

1. First, give the dashboard a name.
2. Optionally, add a description for the dashboard, which will be shown underneath the name in smaller font.
3. To add a visualization, e.g. a graph, chart, table, etc., click on the + Visualization button.
4. You can also add a textbox by clicking on the caret icon here to bring up the Text Box option.
5. Use the buttons at the bottom right to expand or maximize this form.
6. To close this form without creating a new dashboard, click on the cross icon at the top right.

Creating a New Visualization

Choosing the Data Source

After clicking on the + Visualization button, first we need to choose the source data we will use for the visualization:

1. The database ID of the model we are working in is displayed, this is just for the user's information.
2. Data for visualizations can be pulled from the tables and views and present in the model database; functions can be used too to pre-process data used. We will use a table here.
3. In the Search textbox type part of the table, view, or function name to quickly find it.
4. Select the table you want to use by clicking on it. We have chosen the optimization facility summary, a Neo output table.
5. A preview of the data in the table can be brought up by clicking on the magnifying class icon.
6. Once a table, view or function has been selected, click on Select Data to continue to the next step.

Configuring Chart Data

The form now looks similar to the following screenshot, where on the left-hand side the visualization can be configured and on the right-hand side the chart will be shown as it is being built:

1. At the top left, users can swap between configuring the data for the visualization and the visualization settings. First, we will stay in the Data section.
2. The name of the table or view we are using to build the visualization is repeated here. Click on the icon with the 3 vertical dots on the right to bring up the option to refresh the data to ensure we are working with and previewing the latest.
3. You can bring up all options for the visualization type by clicking on the caret icon. We are using a column chart.
4. The list of fields available in our data source is here on the left:
   
   1. The list can be filtered down by typing into the search textbox to only show fields containing the search text in their field name.
   2. Additional fields can be added; these can be calculated fields using 1 or more fields in the chosen data source or field(s) from another table or view within the same model database can be brought in.
5. To configure the visualization, drag fields from the list on the left to the different areas here; these can differ based on the chart type chosen.
   
   1. Labels refer to the labels on the visualization axes and consequently the groups by which you want to aggregate your values.
   2. Values represent the data you want to be presented in the visualization. Typically, values are aggregated representations of your data (e.g. sum, average, etc.).​​
   3. Categories allow for additional grouping.
   4. Fixed Lines lets users add a field that will be drawn as a superimposed line on the chart, independent of the other values displayed. The line represents an aggregated value (summed, averaged, etc.) over all data shown in the graph.
   5. Filters allow users to adjust inclusion and exclusion criteria while viewing the chart.
6. In the area on the right the chart will become visible as it is being built.

After dragging the fields we want on top of the Label, Values, and Category areas, our visualization configuration area looks as follows:

1. We are using Scenario Name as the Label, the summed Total Outbound Quantity as the Values, and Facility Name as the Category. This was configured by dragging and dropping the fields from the list on the left (not shown) on top of the desired area.
2. We can see what the chart will look like on the right-hand side.
3. Clicking on an added field here will bring up a Field Settings form where display names, aggregation, etc. can be adjusted. We will see this in the next screenshot.
4. Instead of dragging fields on top of the Values box(es), users can also opt to calculate the values to be used in the chart. Click on the F(x) button to bring up the Calculated Fields form.

Configuring Individual Fields

Clicking on a field in any of the configuration areas (bullet 3 above) brings up the Field Settings form:

1. The displayed name of the field is shown and can be edited here by clicking on the pencil icon.
2. For numerical fields, field settings can be specified for three different categories: General, Formatting, and Conditional Formatting. Click on the area you want to review/adjust to see all options. For fields with other data types the options change here accordingly.
3. Once happy with the field settings, click on Update Field to persist any changes made.

The following screenshot shows an example of using conditional formatting in a grid visualization, where the background color for values less than 2M is orange and over 2M green:

Visualization Editing Options

While the chart is being configured, its current state is shown on the right-hand side where several additional settings and options are available to the user:

1. Give the chart a title. By default it is set to the data source name.
2. Optionally, add a description for the chart.
3. One or multiple filters can be added to show a subset of the data in the chart. Note that filters can be added to the dashboard as well, which are applied to all visualizations on the dashboard. Using dashboard-level filters is preferred when wanting to sync multiple visualizations on the same dashboard.
4. Options from left to right are:
   
   1. Statistical Functions - these include: time series forecast, linear regression, and detect outliers.
   2. View Data - clicking on this shows the visualization's underlying data in grid format. Clicking on it again will return to the chart view.
   3. Undo - revert the last change.
   4. Redo - make the last change again.
   5. Cancel - close the visualization without saving changes.
   6. Save - save all changes and close the visualization editor.

Configuring Visualization Settings

The chart configuration options available to the user under the Settings tab are shown in the next 2 screenshots; these specify what is shown on the chart and the formatting of the different chart items:

‍

Dashboard Editing Options

Once you are happy with the visualization, click on the Save checkmark icon to save it and close the editor for this visualization. This will bring you back to the dashboard:

1. You can drag the blue points in the middle of the right and lower edges and the bottom right corner to resize the added visualization.
2. To go back to editing the visualization, click on the pencil icon.
3. More options are available under the icon with 3 vertical dots:
   
   1. Edit - this is the same as using the pencil icon under the previous button and will open the visualization editor again.
   2. Copy - copies the visualization and its configuration to the clipboard. It can now be pasted into the same dashboard or another using a dashboard-level option (under the icon with 3 vertical dots, see bullet 4 below).
   3. Duplicates - creates a copy of the visualization in the same dashboard.
   4. Rename - change the name of the visualization.
   5. Delete - remove the visualization. Note that the user will not be prompted to confirm this before the visualization is deleted.
4. At the top dashboard-level editing options become available once at least 1 visualization has been added. These are from left to right:
   
   1. Undo - revert the most recent change to the dashboard.
   2. Redo - perform the last change again.
   3. + Visualization - add another visualization or text box to the dasshboard.
   4. Options under the icon with 3 vertical dots are:
      
      1. Refresh - load all underlying data for the visualizations to ensure the latest is being used.
      2. Paste - if a visualization has been copied, it can be pasted into a dashboard (the same one or a different one) using this option.
      3. Auto layout - a toggle that can be turned on where the visualizations on the dashboard will be automatically sized and fitted together.
      4. Export - export the dashboard. Format options are: image, PowerPoint, PDF, and Excel.
   5. Cancel - stop editing the dashboard and do not save changes since the last time the dashboard was saved.
   6. Save - save all changes and stop editing the dashboard.
5. Add one or multiple dashboard-level filters which can selectively apply to all or a subset of the visualizations included in the dashboard simultaneously. You can choose either a Dashboard or Date filter; see the next 2 screenshots.

Adding Dashboard Filters

When you choose a Dashboard Filter, you are first prompted to choose your data source (a table, view or function) in the same way as selecting the source data for a visualization. After selecting your source, the Dashboard Filter form is shown:

1. We have chosen the same optimization facility summary table as our source for filtering the visualizations on the dashboard.
2. You can edit the name of the filter by clicking on the pencil icon. By default it has the same name as the selected Displayed Field, see next bullet.
3. From the drop-down, select the Field will the connected visualization(s) will be filtered by.
4. If the Display Field should be different from the Field (previous bullet), select it here from the drop-down.
5. Update any Settings for Selection, Data Filters, Read Only Filter, and Hidden as desired.
6. For each individual visualization on the dashboard, click on the Connect button or anywhere inside its card if you want the filter to apply to it. Here, the visualization on the left ("DC throughput...") has been connected to the filter already, whereas the one on the right ("Facility Costs...") has not been connected yet.
7. Click on the Create Filter button to add the configured filter to the dashboard.
8. If you want to cancel out of creating the filter, click on the cross icon at the right top of the form.

Creating a Date Filter works as follows:

1. Optionally, give the filter a name.
2. In the Date Filter drop-down list, choose the date range to filter the connected visualization(s) by.
3. Configure if the filter should be read only and/or hidden.
4. Click on the Connect button or anywhere inside the card of the visualization(s) you want this filter to apply to.
5. Click on the Create Filter button to add the configured filter to the dashboard.
6. If you want to cancel out of creating the filter, click on the cross icon at the right top of the form.

Note that after a Date Filter has been added to the dashboard, users can still switch between different timeframes when using the filter; this is not fixed at the time of Date Filter configuration.

After a filter has been created, it is accessible in the top part of the dashboard, underneath the dashboard's description. Here we have added a filter for scenario name:

1. Click on the caret to use the filter.
2. Use the checkboxes to enable/disable all or individual scenarios.
3. Click on the Apply button for the filter to take effect.

Editing Dashboards

​We can customize existing dashboards to fit our needs. Click on the icon with 3 vertical dots to bring up the options to Edit, Refresh, and Export (Image, PowerPoint, PDF, or Excel) the current dashboard. If previously a visualization was copied to the Clipboard, a Paste option will be available here too:

Please see the sections above on adding and configuring visualizations and dashboards which apply here in the same way.

Tips & Tricks

If bars are not showing in a chart this is likely due to the first column having no value or its value being 0. To resolve:

1. For charts where multiple fields are used in the Values area: reorder these, so that the first field results in a non-0 value for the first column in the chart. See also first screenshot below.
2. For charts where 1 field is used in the Values area: apply a sort to the Category. See also second screenshot below.

1. Since there is only 1 field used here for Values, re-ordering fields in case no bars are showing in the chart is not an option.
2. Instead, we can sort the Category field. Click on it to open the Field Settings form.
3. The Field Settings form for StopSite (used as the Category) has been opened. Here:
   
   1. Change the Sorting from None to either Ascending or Descending.
   2. Choose the field to Sort By; often sorting by the same field as the Label field makes sense, which is done here (routename).
4. Click on Update Field to persist the sort changes.

As always, please reach out to our Support team at support@optilogic.com in case of any questions or feedback.