Initializing help system before first use

xpressinsight.AppInterface.get_attach_by_tag

Purpose

Gets Insight attachments by tag

Searches the scenario and the containing app for an attachment or attachments with the given tag, and retrieves them from the Insight server, placing them in a local directory directory where they can be read by the model. If any scenario attachments with the given tag are found, these are retrieved without searching the app. If no scenario attachments with the given tag are found, then the search continues at the app level.


Synopsis
xpressinsight.AppInterface.get_attach_by_tag(self, tag: str, *, destination_directory: str = None) -> Optional[Attachment]
Arguments
tag 
The tag to search for
destination_directory 
The directory into which to copy the attachment, which must exist or a FileNotFoundError will be raised. If not specified, the attachment will be copied into the Python working directory.
Return value

An attachment object which will be populated with the details of the attachment that was retrieved.

This function may raise the following errors:

  AttachNotFoundError

If the no attachment was not found with the given tag

  SeveralAttachFoundError

If more than one attachment was found with the given tag

  AttachError

If there is some other error querying the attachments

Example
Example of searching for and retrieving an attachment with the tag tag1 
>>> attachment = insight.get_attach_by_tag('mytag1')
... with open(attachment.filename) as f:
...     pass  # process the file
Further information
1. The method get_attach_by_tag 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.get_app_attach,
AppInterface.get_scen_attach,
AppInterface.list_app_attach,
AppInterface.list_scen_attach,
Attachment

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.