ScenarioProperties

Method summary

Methods

cancel ( ) → {Promise}

Cancel any execution of this scenario.

Returns:

Type	Description
Promise	promise, resolves when the scenario is successfully cancelled, or the scenario is not in the execution queue

Example

var cancelledPromise = scenario.cancel();

cancelledPromise
     .then(function () {
         // at this point scneario has been cancelled.
     })
     .catch(function (err) {
         // scenario failed to cancel
     });

Back to Top

execute ( executionMode, options ) → {Promise}

Submits this scenario for execution, either to load the input data of a scenario, or to run it.

Parameters:

Name	Type	Argument	Default	Description
executionMode	string	optional	insight.enums.ExecutionType.RUN	the mode of execution to perform
options	Object	optional		execution options Properties Name Type Argument Description suppressClearPrompt boolean optional  whether, on using an execution mode that clears input data, to suppress the confirmation prompt

Returns:

Type	Description
Promise	promise, resolves when the scenario is successfully queued for execution

Example

var runPromise = scenario.execute(insight.enums.ExecutionType.RUN, 'SLOW');
runPromise
     .then(function () {
         // scenario has been queued for execution
     })
     .catch(function (err) {
         // scenario could not be executed.
     });

Back to Top

getAppId ( ) → {string}

The ID of the app this scenario belongs to.

Returns:

Type	Description
string	The ID of the app this scenario belongs to

Example

var appId = scenario.getAppId();

Back to Top

getCreationDate ( ) → {Date}

The date this scenario was created.

Returns:

Type	Description
Date	The date this scenario was created

Example

var creationDate = scenario.getCreationDate();

Back to Top

getId ( ) → {string}

The ID for this scenario.

Returns:

Type	Description
string	The ID for this scenario

Example

var scenId = scenario.getId();

Back to Top

getModelSchema ( ) → {ModelSchema}

The model's schema for this scenario.

Returns:

Type	Description
ModelSchema	The model's schema for this scenario

Example

var modelSchema = scenario.getModelSchema();

Back to Top

getName ( ) → {string}

The name of this scenario.

Returns:

Type	Description
string	The name of this scenario

Example

var name = scenario.getName();

Back to Top

getNotes ( ) → {string}

The notes associated with this scenario.

Returns:

Type	Description
string	The notes associated with this scenario

Example

var notesTxt = scenario.getNotes();

Back to Top

getOwnerId ( ) → {string}

The username of the user that owns this scenario.

Returns:

Type	Description
string	The username of the user that owns this scenario

Example

var username = scenario.getOwnerId();

Back to Top

getPath ( ) → {string}

The path to this scenario in the Insight Repository.

Returns:

Type	Description
string	The path to this scenario in the Insight Repository

Example

var pathString = scenario.getPath();

Back to Top

getScenarioType ( ) → {insight.enums.ScenarioType}

The type of this scenario.

Returns:

Type	Description
insight.enums.ScenarioType	the type of this scenario

Example

if (scenario.getScenarioType() === insight.enums.ScenarioType.SCENARIO) {
     // do something if this scenario has type 'SCENARIO'
}

Back to Top

getShareStatus ( ) → {insight.enums.ShareStatus}

The share status of this scenario.

Returns:

Type	Description
insight.enums.ShareStatus	The share status of this scenario

Example

if (scenario.getShareStatus() === insight.enums.ShareStatus.FULLACCESS) {
     // do something if share status is 'FULLACCESS'
}

Back to Top

isEditable ( ) → {boolean}

Check whether the scenario data is currently in an editable state. When a scenario is reserved for execution (queued, executing, completing) the scenario data cannot be modified.

Returns:

Type	Description
boolean	Whether the scenario data is currently editable

Example

if (scenario.isEditable()) {
    // modify scenario data
}

Back to Top

setNotes ( notes ) → {Promise}

Set notes on this scenario.

Parameters:

Name	Type	Description
notes	string	Notes to set against the scenario

Returns:

Type	Description
Promise	Promise object

Example

scenario
     .setNotes('A short note about this scenario')
     .then(function () {
         // notes have been set.
     })
     .catch(function () {
         // notes could not be set.
     });

Back to Top

setOwnerId ( newOwnerId ) → {Promise}

Change the ownership of this scenario.

Parameters:

Name	Type	Description
newOwnerId	string	the username of the new owner for this scenario

Returns:

Type	Description
Promise	Promise object

Example

scenario
     .setOwnerId('userid')
     .then(function () {
         // ownership has changed.
     })
     .catch(function (err) {
         // ownership could not be changed.
     });

Back to Top