Working with Model (Web Application)

A model is an object that consecutively calculates equations to get the output data in the output variables. After finishing the calculation the results are loaded to variables.

In the web application, a model is not displayed as a separate object but is the complex of equations located in the working area.

All operations in the Modeling and Forecasting tool are executed within a model. Name of the current model is shown at the top of the working area.

After the model is saved, child cubes are created within it, which can be used as data sources in the following tools: Dashboards, Analytical Queries (OLAP), and Reports. The set of cubes is equal for all problems. Cube names are created according to the following rule:

For example, Balance of Trade. Output Variables is a cube that contains output variable data for the Balance of Trade model.

To create a model:

Select the New Model item in the Model main menu. The dialog box for saving a model opens.
In the dialog box that opens select the modeling container, in which the model must be created. If the modeling container does not exist, specify the folder, in which it is automatically created.

NOTE. If a modeling container is set in the repository, that is, used by default , the container does not need to be chosen. A model is created in this container by default. If required, another modeling container can be selected or a new one can be created.

Specify the name and the identifier of the created model and press the ENTER key. If the name and identifier are not defined, they are set automatically.

The model is opened for edit. Then create variables and equations.

To open a model:

Select the Open item in the Model main menu. Specify the required model in the dialog box that opens.
In the object navigator select the View context menu item for the model, or View in New Window item, to open the model in the new window.

The model is displayed in the working area.

NOTE. The model cannot be opened in the web application if it is created in the desktop application, and calculation chain of this model contains extended aggregation equation or several equations that use the same variable as an output variable.

To open the model with a special key:

Open the browser.
In the address bar specify the Modeling and Forecasting tool URL in the web application. The tool URL is created as follows: <web application URL>/model.html.
For example: http://biserver/fp_App_v10.x/app/model.html, where http://biserver/fp_App_v10.x/app is the web application URL.
Add the key special parameter to the URL and specify model key. URL format: <tool URL>#key=<model key>. For example: http://biserver/fp_App_v10.x/app/model.html#key=11111, where 11111 is the key of opened model.
Open the formed URL.

The model is displayed in the working area.

If the model with the specified key is not found, the corresponding message appears. The model is searched in the repository, specified in the PP.xml file for the web application in use.

If there are pending changes in the model, its name displayed next to the tool selection menu contains the * character. For example:

To save the model:

Select the Save item in the Model main menu.
Press CTRL+S. The key combination is available if there are no opened dialog boxes in the working area
Click the button next to the Model main menu.

The model is saved.

Select the Save As item in the context menu. The dialog box opens for selecting a storage location of the model copy in the current repository. Specify a new name of object, and, if required, identifier in the dialog box. If identifier is not specified, it is created automatically on saving.

IMPORTANT. Identifier of the saved object must not contain Cyrillic characters and spaces.

The calculation is executed by using buttons on the Calculation ribbon tab. To calculate a model:

Set calculation periods in the Sample Period and Forecasting Period groups.

NOTE. The model is calculated if calculation periods do not overlap borders of periods of modeling container source that contains the model.

If the scenario modeling is applied, in the Scenarios drop-down list select the checkboxes of those scenarios, by which the model is calculated. By default, calculation is executed only by the Fact scenario.

TIP. How to find out whether scenario modeling is used?
Scenario modeling is used if the Use Scenario Modeling checkbox is selected on the Interface tab in the Parameters dialog box.

Click the Calculation Order button and determine order of calculating equations in the model.
Select calculation type. Click the lower part of the Calculate button. The menu opens, in which select the type of model calculation:

Forecasting Problem. Model equations are calculated one by one in each scenario point: first, all equations are calculated by the first scenario point, then all equations are calculated by the second scenario point, and so on.
Optimal Control Problem. It is available if criterion function is set. It consists in finding such values of controlling variables, at which the condition of criterion function value optimization is observed.
Criterion Problem. It is available if trajectory is set for criterion function. It consists in finding such values of controlling variables, at which criterion function value fully corresponds to the set trajectory.

Click the Calculate button.

TIP. Sometimes it is required to set model calculation delay to make it more visual. For details how to do this, see the How to Set up Model Calculation Delay? section.

The model current calculation status and errors or warnings are displayed to the results panel on the Calculation of Model tab. To show the tab, click the Calculation Log button on the View ribbon tab.

For example:

To interrupt model calculation, click the Stop button in the message displayed at model calculation. For example:

The following types of reports are available for the model:

Report on variables. Data of all variables included into the model is presented.
Scenarios comparison report. It is available if scenario modeling is used. Data of all variables is presented allowing to compare data by all scenarios contained in the model.

To get report of the model:

Click the lower part of the Report button on the Calculation ribbon tab.
In the menu that opens select the radio button next to the required report type.

The express report containing data about the model opens in the new window.

Both reports contain the Variables sheet that includes input and output variables as tables for the selected period by all considered scenarios. For example:

The scenarios comparison report also contains the Scenarios Comparison sheet that includes input and output variables presented as a bubble chart. Scenarios are used as observation objects, variables are used as metrics. The characteristic feature of this bubble chart is that movement trajectory is drawn for each bubble. For example:

To rename a model:

Double-click the model name. It is switched into the edit mode.
Change the name. Press the ENTER key or click outside the data view area.

To refresh the model, click the button on the Home tab or View tab of the ribbon. If the model contains unsaved data, it is prompted to save it.

Structuring enables the user to order models and their elements or arrange them according to the particular schema. Structuring does not affect model calculation order.

The following ways of model structuring are available:

Hierarchical. It combines models and their elements into hierarchical structure. A detailed description is given in the Hierarchical Structuring of Model section.
Visual. It combines equations and variables into logical groups.

These ways of structuring can be applied together.

To create a model visual structure, use labels and rectangles. Add them by the Label and the Rectangle buttons on the Home ribbon tab. Labels are created before, and rectangles are created after equations and variables.

The example of visual structure:

The model key is unique and used for single-valued identification of a model within the modeling container.

To get model key:

Open the model.
Go to the browser address bar.

The model key is displayed in the web application URL after the key special parameter. For example: http://biserver/fp_App_v10.x/app/model.html#key=111111, where 111111 is the key of opened model.

NOTE. The option is available only for the Schema view.

To export a model, select the Export > Schema item in the Model main menu and select export format:

PNG file (Line.png).
SVG file (Schema.svg).

The model schema is exported into the file of the specified format to the downloads folder used by the browser.