.. raw:: html

    <style> .red {color:red} </style>

.. role:: red

==================
Multiple Scenarios
==================

We have seen how to :doc:`setup the parameters of one scenario <scenario>` in the project, defining the constraints for the route optimization calculation.

However, the users normally create multiple scenarios with different parameters to compare the results of different criteria or different start/end points.

.. note::
  Users with an administrator or editor :doc:`rol <userFunctions>` can define new scenarios or modify their existing ones. However, *viewer* users can only access shared scenarios. They can't create new ones or modify any of them.


Scenarios and Projects
======================

Each scenario in the project contains an assignation of resistances to the project layers and weights for the categories where layers are grouped. In addition, the scenario contains other settings like key points, cost calculation factors, etc.

A project may contain *multiple scenarios*, each of them with different settings, but only one of them is the **active scenario**. Changes applied to layer resistances, category weights and other settings, as well as the :doc:`result calculations <process>` and :doc:`analysis charts <analyze>`, all operate on the active scenario.

.. image:: ./images/scenarioAndProject.jpg
   :align: center
   :width: 90%

Because it may be interesting to keep scenario settings to be reused in multiple projects sharing the same layers and categories (for instance, projects for different areas in the same country), scenarios can be stored or copied to be :ref:`reused <share_scenarios>`.

.. note::
   Scenarios are independent and private to each user, unless they are :ref:`copied or shared <share_scenarios>`.


Managing Scenarios
==================

.. _create_scenario:

Create New Scenario
*******************

Except in the case of viewer users, there is always one default scenario in the project.

However, if we are a viewer user or we want to try multiple scenarios with different settings, we need to explicitly add more scenarios to our project.

.. raw:: html

   <div style="text-align:center">
   <iframe width="560" height="315" src="https://www.youtube.com/embed/bZ9X9Q9JsSY?start=301" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
   </div>

A new scenario can be created or imported by using the *Scenario/New Scenario* menu option.

.. image:: ./images/scenarioNew.jpg
   :align: center
   :width: 25%

It can also be created by using the corresponding button in the Right Panel header.

.. image:: ./images/scenarioNew2.jpg
   :align: center
   :width: 40%

In either case, the Add Scenario dialog will popup.

This dialog offers three ways to add a new scenario to the project:

* By copying settings from the active scenario:

  .. image:: ./images/scenarioDescription.jpg
     :align: center
     :width: 75%

|

.. _create_shared_scenario:

* By selecting one or more :ref:`shared scenarios <define_shared_scenario>` defined by other users for this project:

  This is the only option available to viewer users. Shared scenarios can not be modified (except for their owner), but are useful to present results prepared by someone else.

  .. image:: ./images/scenarioSharedAdd.jpg
     :align: center
     :width: 75%

|

  Shared scenarios added to the project are indicated by a special "team" **icon** and the name of the owner between parenthesis:

  .. image:: ./images/scenarioSharedIcons.jpg
     :align: center
     :width: 25%

* By importing a saved :ref:`scenario file <scenario_CSV>`:

  .. image:: ./images/scenarioImportFile.jpg
     :align: center
     :width: 75%

|

.. note::
   *The new scenario will become the new active escenario.*


Select the Active Scenario
**************************

As mentioned, any changes in the layer resistance assignation, category weights and other settings, or the result calculations, operate on the active scenario, which is highlighted in the Scenario Selector and also in the Results section of the Right Panel with a different color.

To change the active scenario, the user can pick it directly in the Scenario Selector:

.. image:: ./images/scenarioSelect.jpg
   :align: center
   :width: 50%

Or use the *Scenario/Select Scenario* menu option:

.. image:: ./images/scenarioSelectMenu.jpg
   :align: center
   :width: 25%

And pick the scenario from the following dialog:

.. image:: ./images/scenarioSelectDlg.jpg
   :align: center
   :width: 50%

Rename scenario
***************

To change the name of a scenario, double click on it and type the new name, finishing with the Enter key.

.. image:: ./images/scenarioName.jpg
   :width: 25%
   :align: center


Delete Scenario
***************

Scenarios can be removed from the project if we discard them as a viable option or have no more use for them.

The removal can be invoked from the top menu:

.. image:: ./images/scenarioDeleteMenu.jpg
   :align: center
   :width: 25%

In both cases, a dialog will appear to select which scenario to remove from the project:

.. image:: ./images/scenarioDeleteDlg.jpg
   :align: center
   :width: 50%

Direct removal is possible by clicking on the trash icon in the Scenario Selector:

.. image:: ./images/scenarioDeleteSelector.jpg
   :align: center
   :width: 40%

In both cases, a confirmation dialog will pop up:

.. image:: ./images/scenarioDeleteConfirm.jpg
   :align: center
   :width: 60%

.. note::
   *As with other delete operations in Pathfinder, scenario removal cannot be undone. The Results associated to the deleted scenario will be removed permanently.*

.. _share_scenarios:

Reusing and Sharing Scenarios
=============================

Because users and organizations invest time and effort in defining the scenario parameters (resistances, costs), it makes sense to reuse them as much as possible in different projects and scenarios belonging to different users.

Another reason for sharing scenarios is to allow other users to see our results without the need to recalculate them in their own scenarios, for instance, for public discussion purposes. Viewer users can only access shared scenarios created by other users, and will not be able to modify them.

There are three options to share scenarios, which we detail below:

* Save them in the *Scenario Catalog*, so they are visible to all users of the company, who can import them from the catalog.

  .. note::
    This method can be used to share scenario settings in the same project and *among different projects*, as long as the projects have layers created from the same base datasets and use the same ring settings. Otherwise, the results of importing the scenario from the catalog might not be correct.

* Save them to *Scenario Files* which can be imported later.

  .. note::
    This method is meant to be used as a backup for scenario settings, or to share scenario settings among different users of the same project.

* Mark the scenario as *shared* in a project so other users can open it and display the results, but not change it.

  .. note::
    This method also works only in the same project.


.. _scenario_catalog:

Scenario Catalog
****************

In some cases it may be convenient to *reuse the same scenario in different projects*. For instance, if our company operates in different areas of the same country, using the same base datasets and constraints, it's a good idea to save the scenario settings to be assigned later to other projects.

It is common that different public organizations have their own route analysis methodology and constraint preferences. In that case, it is convenient to store specific scenarios for each one to reuse in multiple projects.

The active scenario can be **saved** from the corresponding Scenario header button:

.. image:: ./images/scenarioCatalogSave.jpg
   :align: center
   :width: 40%

And give it a name in the catalog:

.. image:: ./images/scenarioCatalogSavePick.jpg
   :align: center
   :width: 50%

Another button in the Scenario header allows us to **load** a scenario from the catalog.

.. note::
   *Beware that the current scenario values and settings will be overwritten in this operation. Create a new scenario or save the settings in the catalog or as an external file if you need to preserve them*.

.. image:: ./images/scenarioCatalogLoad.jpg
   :align: center
   :width: 40%

|

.. image:: ./images/scenarioCatalogPick.jpg
   :align: center
   :width: 50%

After loading the new scenario, a dialog will confirm which settings could be applied successfully to the project. *It is possible that some layers, categories or settings were not applied (e.g. resistances for layers which do not exist in the current project)*:

.. image:: ./images/scenarioCatalogLoadConfirm.jpg
   :align: center
   :width: 60%

It is not required for the current project to have the same layers/categories than the scenario we load from the catalog. Those layers/categories which exist in both the project and the scenario will be assigned the saved values.

.. note::
   *The Scenario Catalog is shared with all members of your company.*

.. _scenario_CSV: 

Importing and Exporting Scenarios
*********************************

Another way to share and backup scenario settings is by using the file export and import options of Pathfinder.

This feature is more limited than the Scenario Catalog, because it is used only to **backup or share scenarios of a specific project**. It can be used to *store safety copies* of our user scenario parameters (in case we modify something and we want to revert to a previous state) or to *share a scenario with other company user working in the same project*.

To **export** the active scenario settings, use the top menu option:

.. image:: ./images/scenarioExport.jpg
   :align: center
   :width: 25%

A *JSON text file* will be downloaded, and it can easily be viewed in text editors:

.. image:: ./images/scenarioCSV.jpg
   :align: center
   :width: 60%

Scenarios can be **imported** from files in the same format:

.. image:: ./images/scenarioImport.jpg
   :align: center
   :width: 25%

|

.. image:: ./images/scenarioImportDlg.jpg
   :align: center
   :width: 50%

A message will report when the importing is completed. 

.. image:: ./images/scenarioImportConfirm.jpg
   :align: center
   :width: 40%

.. note::
   *Unlike loading scenarios from the catalog, loading a scenario from the external file requires the same project configuration. The layers and categories in the project must be the same as when the file was saved, including the ring configuration of layers.*

.. note::
   *Same as when loading a scenario from the catalog, importing it from a file will not create a new scenario, but overwrite the active one.*

As described above, we can also import directly a saved scenario file when we :ref:`create a new scenario <create_scenario>`.


.. _define_shared_scenario: 

Defining Shared Scenarios
*************************

By default, scenarios are private. All users of a project share the same layers (with their filters and rings), but they have different scenarios with their own resistance values, scenario settings and results.

If we want to provide view-only access to one scenario, so other users of the same project (assuming they have permission to access the project) can see its parameters and results (without being able to modify them) we just need to set a special flag in the :ref:`scenario settings <scenario_settings>` to change its type to *shared*:

.. image:: ./images/shareScenario1.jpg
  :align: center
  :width: 40%

Notice that, when we do this, the icon at the left of the scenario name changes from a "lock" (private) to a "team" (shared).

After doing this, other users can :ref:`add this shared scenario <create_scenario>` when they open the same project.

.. note::
   Comments may only be visible to other members of your organization if their scenario is shared.


.. include:: footer.rst