View source for Analytica Registry Settings

[[Category: Analytica installation and licenses]]

__TOC__

This page lists registry settings used by Analytica 4.2 and later. For registry settings in Analytica 4.1 and earlier, please see [[/4.1|Analytica 4.1 Registry settings]].

Many of these settings are optional, but can be set to control some aspects of Analytica behavior.

''(in progress)''

== HKEY_LOCAL_MACHINE\Software\Lumina Decision System\Analytica\4.0 ==

* '''AbbrevDateFormat''' (REG_SZ): The format used for abbreviated-style date number format.  Usually: d-MMM-yyyy
* '''AddLibraryDir''' (REG_SZ): File path that [[File menu|File]] &rarr; '''Add Library...''' opens to.
* '''Company''' (REG_SZ): Company or organization of the current Analytica license.
* '''ContentBookmark''' (REG_SZ): Name of bookmark in User's Guide for the Table of Contents.
* '''EULA''' (REG_SZ): File containing the End User License Agreement.  This is accessible from the Help menu, license dialogs.
* '''Expirereminddays''' : If your license expires, Analytica can remind you that your license may expire soon.  This settings specifies the number of days prior to expiration that such warnings begin showing.
* '''FunctionListBookmark''' (REG_SZ): Name of the bookmark in the User's Guide for the Function List page.
* '''GdiBatchLimit''' (REG_DWORD): Graphing performance setting.  To be described later.
* '''Home''' (REG_SZ): Directory where Analytica is installed.
* '''IndexBookmark''' (REG_SZ): Name of bookmark in User's Guide for the Alphabetical Index. 
* '''InitialDir''' (REG_SZ): [[CurrentModelDirectory]] when you first start Analytica.
* '''LicenseCode''' (REG_SZ) : An augmented and encrypted version of your Analytica license code.
* '''Licensee''' (REG_SZ) : Name of licensed Analytica user.
* '''OleContainerClsid''' (REG_SZ): The CLSID used to identify Analytica as the application in an OLE link.
* '''OptimizerGuide''' (REG_SZ): Filename of optimizer guide (PDF file).
* '''Preferences.ini''' (REG_SZ): Analytica's start-up preference file (usually Analytica.ini).
* '''Solver.lic''' (REG_SZ): The Frontline solver license file, used by Analytica Optimizer licenses.
* '''SolverHost''' (REG_SZ): When Frontline network licenses are used, contains the name of the license server.
* '''SolverLicType''' (REG_SZ): Type of frontline optimizer solver license (1=stand alone, 2=Network/flex)
* '''Titlebar''' (REG_SZ): The pattern used in the titlebar of the Analytica application.  May have wildcards that are replaced, e.g.:
:<code>%title -- Analytica® %mode%beta -- %filename</code>
displays the title of your model, the edition (mode), whether it is a beta release, and the file name that is loaded.  (to do - list full set of wild cards)
* '''Tutorial''' (REG_SZ): Filename of tutorial PDF guide.
* '''UserGuide''' (REG_SZ): Filename of Analytica user guide (PDF).
* '''WhatsNewBookmark''' (REG_SZ): The acrobat bookmark inside the Analytica User Guide that is used by the "What's new in Analytica 4.0?" link on the help menu.  This link displays only if you have Acrobat exchange installed on your computer.
* '''WhatsNewGuide''' (REG_SZ) : (currently not used) When an Analytica release has a separate "What's New" PDF file, this provides a link to that file.  Currently What's new is inside the User guide.

=== Subfolders ===

==== Plugins ====
A list of plugin DLLs that extend Analytica functionality.   These settings are usually created by the DLL by running: 
:<code>regsvr32 ''plugin.DLL''</code>

Each plugin contains its own subfolder.  Two keys are present:
* '''Autoload''' (REG_SZ): ("True" or "False") Controls whether the plugin DLL is loaded when Analytica starts up.
* '''Filename''' (REG_SZ): A full filepath to the plugin DLL.

In addition, specific DLLs may contain DLL-specific settings.  For example, the ODBC4Analytica DLL, which provides database access for {{Analytica Developer}}, contains these settings:
* '''ConnectionTimeout''' (REG_DWORD): Seconds to wait for a database connection before concluding that the server is not responding.
* '''LoginTimeout''' (REG_DWORD): Seconds to wait for a login authentication to a database server before giving up.

==== SolverEngines ====

Configuration info for third-party solver add-on engines used with Analytica Optimizer (such as Knitro).
Each engine contains its own subfolder.

(to do: describe fields )

== HKEY_CURRENT_USER\Software\Lumina Decision Systems\Analytica ==

Settings in this folder are specific to a particular user.  They only apply when you log into your Windows system with your own login.

Some settings appear in both HKLM and HKCU.  In general, the HKCU settings dominate.

* '''AutosaveMode''' (REG_DWORD): (1 = maintain recovery info, 0 = off )
* '''CustomColor#''' (REG_DWORD): where # ranges from 0 to 15. RGB values for the custom colors defined from the advanced color selector dialog.
* '''InitialDir''' (REG_SZ) : The initial [[CurrentModelDirectory]] when Analytica starts up.  (this supercedes any InitialDir specified in HKLM).
* '''NumRecentFiles''' (REG_DWORD) : Number of recent files to display on the File menu.
* '''Preferences''' (REG_SZ): File path to a user-specific startup preferences file.  See [[Configuring Personalized Defaults]].
* '''SplashMs''' (REG_DWORD): Minimum number of seconds to display the splash screen at start up.
* '''SuppressFileHeaderComment''' (REG_DWORD): If this is non-zero, the comment normally written as the first line of model files is not written when a model or module is saved. The changing timestamp on the comment line confuses some source control systems.  Available in build 4.0.0.57 or later. This is the comment that looks like:
:<code>{ From user jdoe, Model Foxes_and_hares at Wed, Aug 29, 2007 10:56 AM} </code>

=== Subfolders ===

==== Recovery ====

Used by "Maintain Recovery info" to keep track of which model files are being edited, or may have been in the process of being edited when a crash occurred.  Information here includes the path to the file, and the path to the corresponding recovery file.

==== LegalAgreement ====

Keeps track of whether you have agreed to the end-user license agreement.  This setting tells Analytica that you've already agreed to the terms, so it knows not to show you the dialog again.

==See Also==
* [[Analytica Registry Settings/4.1]]
* [[GetRegistryValue]]
* [[Installation and licenses]]
* [[Configuring Personalized Defaults]]