Initializing help system before first use

insightlistscenattachbytag

insightlistscenattachbytag

Purpose
Retrieves a list of all the files attached to a scenario with the given tag.
Synopsis
function insightlistscenattachbytag(tag:text):list of insightattachment
function insightlistscenattachbytag(tag:text, scenariopath:text):list of insightattachment
Arguments
tag 
The tag to search for
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, the attachment is retrieved for the current scenario
Return value
A list of the scenario attachments
Example
Example of fetching information about all attachments on a scenario with the tag tag1 into a list called myattachments 
declarations
   myattachments: list of insightattachment
end-declarations
myattachments := insightlistscenattachbytag('mytag1')
if insightattachstatus=INSIGHT_ATTACH_OK then
   writeln("Attachments: ", myattachments)
else
   writeln("Error listing attachments")
end-if
Getting the list of attachments for the current scenario with the given tag. 
declarations
   myattachments: list of insightattachment
end-declarations
myattachments := insightlistscenattachbytag('mytag1', '/myapp/FolderA/FolderB/myscenario')
if insightattachstatus=INSIGHT_ATTACH_OK then
   writeln("Attachments: ", myattachments)
else
   writeln("Error listing attachments")
end-if
Getting the list of attachments with the given tag for a scenario with path /myapp/FolderA/FolderB/myscenario.
Further information
1. Check the attachment status code using insightattachstatus to determine whether the attachments list was successfully retrieved.
2. Attempting to access attachments when the model is not being run through Xpress Insight will cause the model to abort with an error.
Related topics
insightattachstatus insightgetscenattach insightlistscenattach

Parent Topic Subroutines

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