anyLogistix anyLogistix
Expand
Font size

Scenario Template

A scenario template is an empty MS Excel file with proper anyLogistix naming and formatting. The exported scenario will contain all the scenario's data.

To create a scenario template

  1. Create a new scenario in anyLogistix.
  2. Optionally you may add records to the data tables of the new scenario that will serve as examples of data values.
  3. Export the created scenario to a new MS Excel file. The file will contain the worksheets corresponding to the anyLogistix data tables as well as examples of the inserted data values.

    Empty tables and default data are not exported unless the Export empty and default data option is enabled in the export dialog.

You can now fill the exported file with your own data to later import it to anyLogistix as a new scenario.

Template contents

The template comprises the following types of sheets:

Empty tables and default data are not exported unless the Export empty and default data option is enabled in the export dialog.

  • Agenda - the list of all sheets this file contains.
  • Scenario settings - the basic scenario settings.
  • Experiments and their settings:
    • Experiments - the parameters of all the experiments of this scenario type.
    • Experiment Statistics Settings - the parameters of all the statistics of this scenario type.
    • Experiment Dashboards - the parameters of all the statistics that are present on the dashboards of all experiments of this scenario type.
    • Experiment Processors - all the processors (and their parameters) of all the experiments of this scenario type.
    • Variations - the Variable parameters defined in the Variation experiment settings.
  • Project units - the measurements units of the project, in which this scenario was created.
  • Project Unit Conversions - the conversion rules of the Project units.
  • Icons - the set of all icons (default and custom) that are used in this scenario.
  • Tables - one sheet per table, but there are cases when several sheets hold data from one table.

Data organization

Scenario's content is distributed over the sheets in a comprehensible form, where each value occupies its own cell. However several cells may also be allotted in the template sheet to describe the value of initially one cell.
Below you can see a simple example of the Products table:

  • In the exported sheet, which also has the ID column:

  • In the anyLogistix table:

IDs in the MS Excel file

Additionally to the data that you see in anylogistix tables, the exported file has the ID column, which is initially present in the scenario but is not visible in the user interface. This identifier serves to keep track of (link to/reference) the object regardless of its editable name.

You may change IDs while working with the exported scenario, but make sure that:

  • The new ID does not duplicate the name of the existing ID.
  • The existing ID that you are renaming is renamed in all of its instances.

There can't be two different objects with the same ID.

ID references

You may find the same IDs in various sheets of the MS Excel file. Those are not duplicates, but references to the object/record that has this ID. This is possible:

  • Within the same sheet.
    Below you can see the data from the Groups Customers sheet, which is basically a list of customers from the Customer group. We can tell that by looking at the Groups ID column.

  • Throughout different sheets that contain data referencing object from other sheet.
    In our case that would be the ID of the Customers group in the Groups sheet, which contains all groups from the scenario. Here we have the actual object, to which the items from the Groups Customers sheet are referring to. This is how you can have the same ID in various sheets, but all of those IDs belong to one and the same object. You can't have e.g. 2 different groups with the same ID.

Several sheets holding data from one anylogistix table

By default data of a table is stored within 1 sheet that has the name of this table. However, you might find several sheets with data belonging to one table.

This happens if:

  • A table contains more than 1 000 000 records. In this case the exported file will have two sheets for this table. The Agenda sheet will be updated accordingly.
  • A table contains a list(s) defined via multiples election drop-down menu. Such lists are stored in a separate sheet.

Complicated values divided into several cells

A table may have a value defined with an expression or a more complex parameter setting that is exported into several cells to make its further editing much easier.

The example below shows that one cell of the Policy Parameters column in the anylogistix Inventory table occupies 4 cells in the Inventory sheet of the exported template.

Working with the template

If you're working with the exported scenario, editing data is much easier, since you can see the way data is stored and can add new data in a similar. But if you're working with a blank scenario template, then plotting it with data might be a bit tricky.

We recommend that you should export scenario with data similar to what you're planning to insert into the template to have a better understanding of how it should be formatted.

While editing the template file, you can:

  • Use expressions in the table cells. This can be any type of a function/expression that an MS Excel file understands.

    Functions may slow down the importing process.

  • Add a description or a comment in any required form to the right of the last table column.
    It is prohibited to add data:
    • Below the last table record. It will inevitably result in import errors.
    • To the sheets: Scenario settings, Experiments, Experiment Statistics Settings, Experiment Dashboards, Experiment Processors, Icons.

To edit scenario template

  1. Open the exported scenario file.
    You will see the Agenda sheet, listing the sheets this file contains.

  2. Click the link in the Sheet Name column to navigate to the exported data of the required table, e.g. Products.
    As you can see, the table currently contains the default product only.

  3. Create a new product by filling the cells of line 3. You may do this in either of the following ways:
    • Copy and paste the default product's data (and adjust it to avoid having two identical IDs/products) or
    • Manually define the new data in the cells of the next line (third line in our case).

    Make sure that the IDs differ. There should not be two identical IDs.

  4. Save the changes and import the updated scenario to anyLogistix.
    The Products table now has 2 records.

How can we improve this article?