Initializing help system before first use

ins~setscalar

Purpose
Create an ins~entityupdate record for updating a scalar entity.
Synopsis
function setscalar(entity:text, value:any):ins~entityupdate
Arguments
entity 
The name of the entity to update
value 
The new value for the scalar. Should be a single value of a compatible type to the Insight entity.
Return value
A value that can be passed to ins~updatescendata to update the entity.
Example 
declarations
  SCENARIO_ID='2926e9a1-9568-4116-84ed-2e75190bc651'
end-declarations
ins~updatescendata(SCENARIO_ID, [ ins~setscalar('maxProfit', 99.1) ] )
if ins~haserror then
  writeln_('Error: ',ins~getlasterror)
end-if
Example of updating a scalar value.
Further information
This function cannot fail; invalid parameter values will only cause an error when the returned value is passed to ins~updatescendata.
Related topics
ins~setscalars, ins~updatescendata

Parent Topic Updating 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.