Initializing help system before first use

insightgetscenattach

Purpose
Retrieves an attachment from the Insight server for a given scenario, placing it in the Mosel working directory where it can be read by the model.
Synopsis
procedure insightgetscenattach(attachname:text)
procedure insightgetscenattach(attachname:text, scenariopath:text)
procedure insightgetscenattach(attachname:text, filename:text, scenariopath:text)
Arguments
attachname 
The name of the attachment to be retrieved.
filename 
The local file to which to write the attachment data. If not specified, attachment name will be used.
scenariopath 
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/FolderA/FolderB/myscenario. If the scenario path is not specified, or an empty string, the attachment is retrieved for the current scenario.
Example
Example of copying a scenario attachment called myattach.dat 
insightgetscenattach('myattach.dat')
if insightattachstatus=INSIGHT_ATTACH_OK then
  writeln('Initialize data structures from myattach.dat')
  ! Add data initialization code here
else
  writeln("Error retrieving attachment")
end-if
Getting an attachment for the current scenario and copying to the work directory 
public declarations
  attachmentcontent: text
end-declarations
insightgetscenattach('myattach.dat', 'text:attachmentcontent', '')
if insightattachstatus=INSIGHT_ATTACH_OK then
  writeln('Initialize data structures from myattach.dat')
  ! Add data initialization code here
else
  writeln("Error retrieving attachment")
end-if
Getting an attachment for the current scenario and copying it into a Mosel variable 
insightgetscenattach('myattach.dat', '/myapp/FolderA/FolderB/myscenario')
if insightattachstatus=INSIGHT_ATTACH_OK then
  writeln('Initialize data structures from myattach.dat')
  ! Add data initialization code here
else
  writeln("Error retrieving attachment")
end-if
Getting an attachment for a scenario with path /myapp/FolderA/FolderB/myscenario and copying to the work directory
Further information
1. If the file already exists, it will be overwritten.
2. filename can be a file in the work directory, or include a directory path, or an extended Mosel filename such as 'text:varname' or 'zlib.gzip:filename.txt'.
3. If filename includes a directory path, the directory being written into must already exist.
4. Check the attachment status code using insightattachstatus to determine whether the attachment was successfully fetched.
5. Attempting to access attachments when the model is not being run through Xpress Insight will cause the model to abort with an error, except when test mode has been activated by setting insight_testmode.
Related topics
insightattachstatus insightputscenattach

Parent Topic Subroutines

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