Initializing help system before first use

ins~delarrayelts

Purpose
Create an ins~entityupdate record for removing a multiple elements from an array.
Synopsis
function delarrayelts(entity:text, entriestodel:any):ins~entityupdate
Arguments
entity 
The name of the entity to update
entriestodel 
An array indexed by the same sets as the entity. The values will be ignored but all index tuples present will be removed from the array in the Insight scenario.
Return value
A value that can be passed to ins~updatescendata to delete elements from the array.
Example 
declarations
  SCENARIO_ID='2926e9a1-9568-4116-84ed-2e75190bc651'
  Regions: set of string
  Months: set of integer
  Prices: dynamic array(Regions, Months) of boolean
end-declarations
create(Prices('UK',1))
create(Prices('UK',2))
create(Prices('UK',3))
ins~updatescendata(SCENARIO_ID, [ ins~delarrayelts('Prices', Prices) ] )
if ins~haserror then
  writeln_('Error: ',ins~getlasterror)
end-if
Example of deleting the price entries for the UK region for months 1, 2 and 3.
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~addarrayelts, ins~delarrayelt, ins~updatescendata

Parent Topic Updating Scenario Data

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