Initializing help system before first use

xpressinsight.AppInterface.set_scen_attach_hidden

Purpose
Mark an existing scenario attachment as hidden or visible in the Xpress Insight UI.
Synopsis
xpressinsight.AppInterface.set_scen_attach_hidden(self, filename: str, hidden: bool) -> None
Arguments
filename 
The filename of the scenario attachment to hide or show.
hidden 
If True, the attachment will be hidden in the Xpress Insight UI; if False, it will be visible.
Return value

This function may raise the following errors:

  AttachNotFoundError

If the specified attachment was not found on the scenario.

  AttachError

If there is some other error updating the 'hidden' flag.

Example
Example of hiding of a scenario attachment my_attach.dat 
>>> insight.set_scen_attach_hidden('my_attach.dat', True)
Further information
1. The method set_scen_attach_hidden is part of the class xpressinsight.AppInterface.
2. To maintain backwards compatibility, attachment operations will only raise exceptions on error if the raise_attach_exceptions attribute of either the AppConfig or AppInterface class is set to True. When this is not the case, after every call to this method you should check the value of insight.attach_status to see if your request succeeded.
3. The attachment will not be updated on the Insight server until the scenario completes.
4. Attempting to access attachments outside an Xpress Insight scenario will access local files that have been supplied to this class.
Related topics
AppInterface.attach_status

Parent Topic App Interface Classes

© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.