Settings#

Overview#

Settings is the section within Finplicity where users can customize various parameters. Within this section, there are two distinct types of settings available for adjustment.

The first type is Project Settings, which specifically pertain to the currently opened project. These settings encompass aspects such as task workflows, optimization parameters, spreadsheet read and write configurations, and forecasting preferences. Users have the flexibility to modify project settings according to the requirements of individual projects.

The second type is Device Settings, which are applicable to the current device being used. These settings govern options such as the frequency of Finplicity updates checks and related configurations.

Project Settings#

Open Finplicity > Settings > Project Settings to adjust project settings.

Task-Workflows#

In the tab, users can control the task workflow settings when you use repeat while true feature.

  • Maximum workflow iteration: the maximum number of iterations for the workflow to be executed when the “repeat while true” option is enabled.

  • Warn user if maximum iteration reached: display a popup warning message if the maximum workflow iteration is reached, when set to True.

Optimization#

In the tab, users can control the optimization tolerance. Optimization uses tolerance values to determine whether the optimum is close enough, so a smaller tolerance value leads to a better accuracy but also a slower solving speed.

  • Objective function tolerance: the tolerance in objective function.

  • Variables tolerance: the tolerance in variables.

  • Maximum iteration: the maximum number of iterations for optimize function evaluations.

  • Warn user if maximum iteration reached: display a popup warning message if the maximum optimize iteration is reached, when set to True.

Spreadsheet Write Rules#

In the tab, users can control the Excel worksheet read and write rules when using Finplicity.

  • Single cell write: auto-expand clearing: expand the clear on single cell table write, when set to True. Otherwise, only the single cell will be cleared.

  • Single cell write: clear formatting: clear format on single cell table write, when set to True. Otherwise, only the content will be cleared.

  • Block write: clear formatting: clear format on write block, when set to True. Otherwise, only the content will be cleared.

Forecast#

In the tab, users can control the forecast form settings.

  • If time-series automated model building is selected, warn user of potentially long computational time: display a popup warning message if VAR auto-model building will take long time, when set to True.

Device Settings#

Open Finplicity > Settings > Device Settings to adjust device settings.

Toolbox Checking#

In the tab, users can control the checking behaviors of Finplicity.

  • Enable close warnings for basic forms: display a popup warning message if you close an unsaved basic form, when set to True.

  • Automatically check for updates: Finplicity update check period days.

Project Discovery#

In the tab, users can configure Project Discovery in Finplicity.

  • Project Discovery default filter: filter public projects by their names.

AI#

In the tab, users can configure AI-related settings in Finplicity.

  • AI vendor: the provider of the AI model.

  • AI model: the model of AI.

  • AI API key: the API key to access the AI model.

Learn more about AI settings

FAQ#

  • What does Reset: Draft button do ?

When this button is clicked, all the project settings will be reset as default for draft mode as following :

  • Maximum workflow iteration: 100

  • Warn user if maximum iteration reached: True

  • Objective function tolerance: 0.0001

  • Variables tolerance: 0.0001

  • Maximum iteration: 250

  • Warn user if maximum iteration reached: True

  • Single cell write: True

  • Single cell write: True

  • Block write: clear table formatting: True

  • If time-series automated model building is selected, warn user of potentially long computational time: True

  • What does Reset: Production button do ?

When this button is clicked, all the project settings will be reset as default for production mode as following :

  • Maximum workflow iteration: 200

  • Warn user if maximum iteration reached: True

  • Objective function tolerance: 0.000001

  • Variables tolerance: 0.000001

  • Maximum iteration: 500

  • Warn user if maximum iteration reached: True

  • Single cell write: True

  • Single cell write: True

  • Block write: clear table formatting: False

  • If time-series automated model building is selected, warn user of potentially long computational time: False