Initializing help system before first use

xpressinsight.AppInterface.get_scen_attach

Purpose
Retrieves an attachment from the Insight server for a given scenario, placing it in a location where it can be read by the model.
Synopsis
xpressinsight.AppInterface.get_scen_attach(self, filename: str, scenario_path: str = None, *, destination_filename: str = None) -> None
Arguments
filename 
The filename of the attachment to be retrieved.
scenario_path 
The path of a scenario. A scenario path is the full path to a scenario name starting from the repository root and including the app name. E.g. /myapp/DirA/myscenario If the scenario path is not specified, the attachment is retrieved for the current scenario.
destination_filename 
The local filename to which to write the attachment content; may be an absolute path or relative to the Python working directory. If neither destination not destination_filename are specified, the attachment will be written to a file in the working directory.
destination 
Where to save the attachment content. May be a local filename (in which case this parameter behaves the same as destination_filename) or any file-like object. destination and destination_filename must not both be set.
encoding 
The character encoding to use when destination is of type TextIO. Defaults to utf-8.
Return value

This function may raise the following errors:

  ValueError

if both destination and destination_filename arguments are set.

  AttachNotFoundError

If an attachment with this name cannot be found in the targetted scenario.

  AttachError

If there is some other error fetching the attachment.

Example
Example of copying a scenario attachment called my_attach.dat to the working directory. 
>>> insight.get_scen_attach('my_attach.dat')
... with open('my_attach.dat') as f:
...     pass  # process the file
Getting an attachment for the current scenario. 
>>> insight.get_scen_attach('my_attach.dat', '/myapp/DirA/myscenario')
... with open('my_attach.dat') as f:
...     pass  # process the file
Getting an attachment for a scenario with path /myapp/DirA/myscenario.
Further information
1. The method get_scen_attach 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. 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,
AppInterface.put_scen_attach

Parent Topic App Interface Classes

© 2001-2026 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.