Initializing help system before first use

JS API and VDL Objects

The information in this topic includes summary data and execution status for JS API and VDL Objects.

Summary Data and Execution Status

The ScenarioSummaryData object contains information that is available at the beginning or after the job execution. It is not updating during execution. For information concerning execution the ScenarioExecutionStatus object is mostly used.

View developers can query the execution mode in order to apply conditional logic on the view. 
=scenario.summaryData.executionMode.name
It is possible to discover which execution modes can send progress. 
=scenario.executionStatus.executionMode.sendsProgress
It is possible to implement conditional logic based on execution state, to render a view differently depending on whether scenarios are executing or not. 
<vdl-section vdl-if = "=scenario.executionStatus.executing"></vdl-section>
View developers can implement conditional logic based on execution state, so that I can render a view differently depending on whether scenarios are executing or not. For example, an overlay can be applied if the scenario is queued. 
<vdl-overlay vdl-if="=scenario.executionStatus.queued">
 <vdl-include src="my-overlay.vdl">
</vdl-overlay>
Similarly, a VDL var can be associated with the execution status and display a modal dialog if the scenario is queued. 
<vdl-var name="isQueued" value="=scenario.executionStatus.queued" vdl-event="value-changed:actions.toggleModal">
Covered Topics
Parent Topic Preparing a View for Progress Updates

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