Initializing help system before first use

ins~getscendata

Purpose
Atomically fetch the values of one or more entities from an Insight scenario into Mosel variables.
Synopsis
procedure getscendata(scenid:text, entities:list of ins~entityfetch)
Arguments
scenid 
ID of the Insight scenario.
entities 
List of ins~entityfetch values describing the entities to fetch and the local variables to fetch them to.
Example 
declarations
  SCENARIO_ID='2926e9a1-9568-4116-84ed-2e75190bc651'
  Regions: set of string
  Months: set of integer
  Prices: dynamic array(Regions, Months) of real
  maxProfit: real
end-declarations
ins~getscendata(SCENARIO_ID, [ ins~getscalar('maxProfit', ->maxProfit),
    ins~getarray('Prices', Prices) ] )
if ins~haserror then
  writeln_('Error: ',ins~getlasterror)
else
  writeln('Maximum profit: ', maxProfit)
  forall (region in Regions, month in Months |
      exists(Prices(region,month))) do
    writeln('Price in ', region, ' for month #', month, ': ',
        Prices(region,month))
  end-do
end-if
Example of fetching multiple entities in a single call.
Further information
1. It is recommended to create an ins~entityfetch for each entity you want, then make a single call to ins~getscendata. Not only is this more efficient than making a separate call for each entity, but it ensures that the scenario data you read is consistant (ie scenario was not edited between entity fetches).
2. If scenario ID was not found, an error was encountered or there is an issue communicating with the Insight server, the error flag will be set and ins~haserror will return true.
Related topics
ins~getscalar, ins~getscalars, ins~getset, ins~getarrayelt, ins~getarray, ins~getscendata

Parent Topic Reading Scenario Data

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