Initializing help system before first use

Scenarios

Data Types

ins~scenario  : record
Information about a scenario.
id  : text
The ID of this scenario
created  : text
The timestamp this scenario was created
ownerid  : text
The ID of the user that owns this scenario
ownername  : text
The full name of the user that owns this scenario
appid  : text
The ID of the app that owns this scenario
parentid  : text
The ID of the app or folder that is the parent of this scenario. For top-level scenarios this will be the same as the appid value.
parenttype  : string
The type of the parent of this attachment, either APP or FOLDER
name  : text
The name of this scenario
path  : text
The path within the repository
type  : text
The scenario's custom type if it has one, otherwise SCENARIO.
sharestatus  : string
The share status of this scenario (one of: FULLACCESS, PRIVATE, READONLY)
datastate  : string
The current state of this scenario's data (one of: LOADED, RESULTS,, RESULTS_DIRTY, UNLOADED)
execduration  : real
The duration of the last execution of this scenario in milliseconds
execmode  : text
The execution mode for the last execution
execusername  : text
The full name of the user that last executed this scenario
execuserid  : text
The ID of the user that last executed this scenario
dataver  : integer
The version number of the model data
status  : string
The model status for this scenario (one of: OK, BREAK, ERROR, EXIT, INSTR, IOERR, LICERR , MATHERR, NA, NIFCT, NULL, PROB, STOP, UNKNOWN, UNKN_PF, UNKN_SYS)
probstatus  : string
The problem status for this scenario (one of: INFEASIBLE, NA, OPTIMAL, OTHER, SOLUTION, UNBOUNDED, UNFINISHED, UNKNOWN)
execstart  : text
Timestamp when this scenario last started loading or executing
execfinish  : text
Timestamp when this scenario last finished loading or executing
See also
ins~getscen, ins~getscenbypath

Subroutines

ins~cancelscen
If scenario is currently queued or executing, cancel it.
ins~clonescen
Create a copy of an existing scenario within an app.
ins~createscen
Create a new scenario within an app.
ins~delscen
Delete a scenario from the Insight server.
ins~execandwaitforscen
Execute a scenario and wait for it to complete.
ins~execscen
Queue the given execution mode of the given scenario for execution.
ins~getscen
Request information about a scenario.
ins~getscenbypath
Request information about the scenario at a given path.
ins~getscenrunlog
Download the scenario's run log into the given local file.
ins~isscenexec
Checks if the given scenario is currently executing/queued for execution.
ins~movescen
Move a scenario to another folder.
ins~renamescen
Rename a scenario on the Insight server.
ins~setscenowner
Update the owner and optionally share status of a scenario on the Insight server.
ins~setscensharestatus
Update the share status of a scenario on the Insight server.
ins~waitforscen
If the specified scenario is executing, wait until it completes or is cancelled. If not, return immediately.
Covered Topics
Parent Topic Insight Scenario Access Package

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