Initializing help system before first use

insightcapture

Purpose
This procedure sets which entities will be saved back to the Xpress Insight scenario at the end of the execution mode.
Synopsis
procedure insightcapture(entities:set of string)
procedure insightcapture(entities:list of string)
Argument
entities 
Set or list of the names of entities to capture. Any entities not in this list will not be saved back to the Xpress Insight scenario, except for index sets of array entities in the list.
Example 
 procedure solvemodel1
  writeln('Constructing and solving model 1')
 end-procedure

 !@insight.execmodes.RUN
 public procedure dorun
  ! Scenario is being 'run' through Xpress Insight
  ! Populate with Insight scenario data and solve model 1
  insightpopulate
  solvemodel1
  ! Capture just the entities updated by model 1
  insightcapture(['profit1', 'factories'])
 end-procedure
Example of calling insightcapture to capture a subset of entities.
Further information
1. If insightcapture is not called, the values of all result and updateable input entities will be captured when the model ends.
2. When passing the name of an array entity, its index set entities will be implicitly added to the list.
3. Other than this, entities not in the supplied list will not be captured.
4. If passed names that are not recognized as either result entities, or updateable input entities, the model will abort with an error.
5. Cannot be called from the LOAD execution mode, or any execution mode with clearinput true. The model will abort with an error if insightcapture is called in these cases.
6. When the model is executed outside of an Insight scenario, or within test mode, this procedure does nothing.
7. Updateable input entities passed to this procedure will be captured regardless of the value of the insight_capture_inputs parameter.
8. This procedure controls which entities will be captured but their values are not captured until the end of the model. Call insightresultsready if you need to initiate an early capture.
Related topics
insightpopulate insightresultsready insight_capture_inputs

Parent Topic Subroutines

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