Initializing help system before first use

insight.enums

Holds identifiers used and produced by the base Insight API.

details

Members

members
AttachmentTagUsage - {
type
string }
Define the usages for attachment tags
details
Properties:
properties
Name Type Description
SINGLE_FILE
type
string 		The attachment tag can be assigned to only one file.
MULTI_FILE
type
string 		The attachment tag can be assigned to multiple files.
members
ClientType - {
type
string }
Enum of client types. A client type is the environment that the browser is running in.
details
Properties:
properties
Name Type Description
ANALYST
type
string 		App is running in the Analyst Client environment.
WEB
type
string 		App is running in the Web Client environment.
members
Comparators - {
type
string }
Built-in Set comparators.
details
Properties:
properties
Name Type Description
NUMERIC
type
string 		A numeric comparator.
STRING
type
string 		An alpha-numeric string comparator. Handles strings containing numbers and sorts based on any numbers within the strings, e.g. a3test, a10test, b2test, b10test
BOOLEAN
type
string 		A boolean comparator. Handles different representations of a boolean, i.e. boolean, string ('True', 'False', 't', 'f', ''), number (0,1)
MONTHS
type
string 		A month name comparator. Compares short and long form month names in en-US
DAYS
type
string 		A day name comparator. Compares short and long form day names in en-US
members
DataType - {
type
string }
Enum of Insight entity data types.
details
Properties:
properties
Name Type Description
UNSUPPORTED
type
string
BOOLEAN
type
string
INTEGER
type
string
REAL
type
string
STRING
type
string
SET
type
string
ARRAY
type
string
DECISION_VARIABLE
type
string
CONSTRAINT
type
string
MODEL
type
string
CONSTRAINT_TYPE
type
string
VARIABLE_TYPE
type
string
PROBLEM_STATUS
type
string
members
EditorType - {
type
string }
Editor types
details
Properties:
properties
Name Type Description
CT_ATTACHMENT_EDITOR
type
string 		Common Tree editor
TEXT_ATTACHMENT_EDITOR
type
string 		Text editor
DECISION_TABLE_ATTACHMENT_EDITOR
type
string 		Decision Table Editor
members
EntityDataDimension - {
type
number }
Enum of Dimensions.

Equivalent to com.fico.xpress.insight.data.XPRIEntityDataDimension.
details
Properties:
properties
Name Type Description
NORMAL_DATA
type
number
DISABLE_CONSTRAINT
type
number
RELAX_CONSTRAINT
type
number
CONSTRAINT_VIOLATION
type
number
CONSTRAINT_RHS
type
number
CONSTRAINT_TYPE
type
number
CONSTRAINT_DUAL
type
number
REDUCED_COST
type
number
VARIABLE_TYPE
type
number
TOTAL_RUN_TIME
type
number
GAP
type
number
NUM_SOLUTIONS
type
number
PROBLEM_STATUS
type
number
members
EntityManagementType - {
type
string }
Enum of the Management Types for model entities.
details
Properties:
properties
Name Type Description
DEFAULT
type
string
INPUT
type
string
RESULT
type
string
IGNORE
type
string
members
ExecutionType - {
type
string }
The type of scenario execution to perform.
details
Properties:
properties
Name Type Description
LOAD
type
string
RUN
type
string
members
ModelStatus - {
type
string }
Enum of model status.
details
Properties:
properties
Name Type Description
OK
type
string
INSTR
type
string
MATHERR
type
string
UNKN_PF
type
string
UNKN_SYS
type
string
PROB
type
string
ERROR
type
string
EXIT
type
string
IOERR
type
string
BREAK
type
string
NIFCT
type
string
NULL
type
string
LICERR
type
string
STOP
type
string
UNKNOWN
type
string
members
ProblemStatus - {
type
string }
Enum of problem statuses.

Equivalent to com.fico.xpress.insight.data.XPRIProblemStatus.
details
Properties:
properties
Name Type Description
UNKNOWN
type
string
SOLUTION
type
string
OPTIMAL
type
string
UNFINISHED
type
string
INFEASIBLE
type
string
UNBOUNDED
type
string
CUTOFF
type
string
members
ScenarioDataChangeStatus - {
type
number }
Scenario data change status
details
Properties:
properties
Name Type Description
STATUS_LOCKED
type
number 		Scenario is locked
members
ScenarioExecutionStatus - {
type
string }
Define the execution statuses for a scenario job.

Equivalent to com.fico.xpress.insight.client.XPRIJobStatus.
details
Properties:
properties
Name Type Description
EXECUTING
type
string
EXECUTING_LOCALLY
type
string
PREPARING
type
string
CONNECTING
type
string
COMPLETING
type
string
PAUSING
type
string
CANCELLING
type
string
PAUSED
type
string
QUEUED
type
string
FAILED
type
string
CANCELLED
type
string
COMPLETED
type
string
NO_JOB_STATUS
type
string
members
ScenarioType - {
type
string }
The type of scenario to be created.
details
Properties:
properties
Name Type Description
SCENARIO
type
string
VIRTUAL
type
string
members
ShareStatus - {
type
string }
Enum of share statuses.
details
Properties:
properties
Name Type Description
PRIVATE
type
string
READONLY
type
string
FULLACCESS
type
string
members
SortDirection - {
type
string }
Sort direction for a comparator function applied to a set.
details
Properties:
properties
Name Type Description
ASC
type
string 		Sort in ascending order
DESC
type
string 		Sort in descending order
Parent Topic Namespaces

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