Package: xpressinsight
FICO®Xpress Insight Python PackageThe 'xpressinsight' Python package can be used to develop Python®based web applications for Xpress Insight.DocumentationFICO Xpress Insight 4 Python Package Reference ManualFICO Xpress Insight 4 Developers Guide For PythonFICO Xpress Insight 5 Python Package Reference ManualFICO Xpress Insight 5 Developers Guide For PythonRelease Notesv 1.9.0 (Insight 5.9.0)New functionAppBase.initialize_entitiesfor initializing selected app entities to their default values.Add support for calling app interface & other standard functions from multiple threads.Theattach_statusproperty now holds the status of the last attachment operation invoked from the current thread;
previously it referred to the last attachment operation from any thread.Theattach_statusproperty is no longer read-only.The internal work folder is now calledxpressinsightinstead ofinsight.The following changes only affect test mode:The execution mode work folder is now a sub-folderwork_dirwithin the application folder.Thexpressinsightwork folder is now created as a sub-folder of the execution mode work folder.Resolved issues when attachment filenames end.properties.v 1.8.0 (Insight 5.8.0)New functionget_scenario_dataallows reading entities from other apps and scenarios.Introducexi.types.Columnclass which can be used in place ofxi.Columnin app definitions. There is currently no
plan to removexi.Column.Attempt to capture entity data after an execution mode that ended abnormally (exception raised orsys.exitcalled).v 1.7.1 (Insight 5.7.0)New functionget_solution_databasereturns the location and credentials of the DMP solution's database.Enabled functionsget_app_attach,get_scen_attachandput_scen_attachto write/read the attachment to/from a
folder other than the work directory or a local filename different from attachment name.Enabled functionsget_attach_by_tag,get_attachs_by_tagandget_attach_filenames_by_tagto write the
attachments to a folder other than the work directory.Fixed an issue with theInsightDmpContext.solution_token_expiry_timevalue in non-UTC timezones.Removed support for Python 3.7. This version supports only Python 3.8 - 3.11.v 1.6.0 (Insight 5.6.0)Resolved an error when a script declares multiple app classes with a shared superclass.Added attributedefaultto thexi.Columnclass.Use of the old syntax for annotating entities (e.g.xi.Scalarinstead ofxi.types.Scalar) will cause a warning
message when the app is built or executed in Python 3.11. This syntax has been deprecated and will not be usable
at all in Python 3.12+.New functionget_insight_contextreturns information about the Insight server and the DMP solution.Python 3.11 support.Pandas 2.0 support.v 1.5.0 (Insight 5.5.0)Allow an Index entity to be referenced multiple times within a single Series or DataFrame -
e.g.Distance: xi.types.Series(index=['City', 'City'], dtype=xi.real).Supportmultiprocessingpackage.v 1.4.1 (Insight 4.59.6)Resolve issue building apps with Xpress 9.2 and apprunner 1.4.Update dependencies to require Pandas v1 with xpressinsight 1.4.v 1.4.0 (Insight 5.4.0 and 4.59.2)New syntax for annotating entities,xi.types.Scalar/Param/Index/Series/DataFrameinstead
ofxi.Scalar/Param/Index/Series/DataFrame.The new syntax is compatible with forward annotations (from __future__ import annotations).The old syntax will continue to work in Python 3.7-3.10 but will not be usable in Python 3.11+,
so we recommend existing apps are migrated from the old to the new syntax.When the new syntax is used, entities may also be declared in a parent class of the Insight
application class.v 1.3.0 (Insight 5.3.0 and 4.59.0)Support for Insight 5 custom progress notifications:Added functionssend_progress_update,get_messagesandput_messagesto Insight application interface
(AppInterface).Added thesend_progressattribute theExecMode,ExecModeLoad, andExecModeRundecorators.Added theupdate_progressattribute to the entity type annotations.RHEL 8 support.Python 3.10 supportAt time of writing the ‘default’ Anaconda channel does not have all the dependencies required by thexpressinsightpackage for this Python version.  We recommend conda users to stick with Python 3.9, or use a
different distribution of Python 3.10 until this is resolved.Fixed an issue that caused a failure if the path to the temporary directory contained a space.v 1.2.3 (Insight 5.2.1 and 4.58.0)Added thethreadsattribute to theExecMode,ExecModeLoad, andExecModeRundecorators.v 1.2.2Fixed an issue that could cause a type check exception when the user created
empty (null) fields in a DataFrame column in the Insight UI.v 1.2.1Added test mode functionsadd_item_infoandclear_item_infosto Insight application interface.Added functionscenario_parent_pathto Insight application interface.AddedRepositoryPathclass for building and parsing of repository paths.v 1.2.0Added scenario types property (scen_types) to application configuration (AppConfig).Added repository functionsget_item_infoandget_item_infosto Insight application interface (AppInterface).v 1.1.3Performance improvements.Python 3.9 support.v 1.1.2Fixed an exception that could occur when an empty MultiIndex DataFrame has been assigned to an Insight entity.Updated documentation describing how to set up Anaconda.v 1.1.1Improve error message when Insight cannot start Python because of security restrictions.Update documentation and update VDL version number in examples.v 1.1.0Additional factory functioncreate_appinitializes and configures standard test environment.Some performance issues with executing a Python based scenario have been addressed.Maximum length of a string in an Index, Series, or DataFrame has been changed from 1,000,000 bytes to 250,000 characters.Default name of the temporary Insight working directory has been changed from "insight" to "work_dir/insight".v 1.0.2The functionsupdateandreset_progresshave been added to the Insight Python interface.Changed Python standard output to unbuffered mode to improve responsiveness of output messages.LicensingThe Xpress software is governed by theXpress Shrinkwrap License Agreement.
When downloading or using the package, you accept the license terms. After installation, a copy of the Xpress Shrinkwrap
License will be stored in theLICENSE.txtfile in thesite-packages/xpressinsight-*.dist-infodirectory.
In Anaconda, a copy of the license file will be stored in thepkgs/xpressinsight-*/info/licensesdirectory."Python" is a registered trademark of the Python Software Foundation.
"FICO" is a registered trademark of Fair Isaac Corporation in the United States
and may be a registered trademark of Fair Isaac Corporation in other countries.
Other product and company names herein may be trademarks of their respective owners.© Copyright 2012-2024 Fair Isaac Corporation. All rights reserved.