Initializing help system before first use

App

Information about a app, its members and the model's schema.
Example
// to fetch the current App
var entity = insight
     .getView()
     .getApp();

Method summary

name description
createAttachment Create a new app attachment.
createFolder Create a new folder as a child of parent.
createScenario Create a new scenario inside the current app.
getAttachmentTagNames Get the list of attachment tag names defined by the app.
getAttachmentTags Get the list of attachment tags defined by the app.
getExecutionModes Returns the app's execution modes, indexed by name
getId The app's id.
getModelSchema The schema of the model used by this app.
getName The name of this app.
getUsers Get a list of users associated with the app.

Methods

method
createAttachment ( options ) → {Promise}

Create a new app attachment.

Parameters:
params
Name Type Argument Description
options
type
NewAttachmentOptions 		optional 
details
Returns:
returns table
Type Description
type
Promise 		Resolves when user closes the editor or if attachment create fails
Example
examples 
app.createAttachment({filename: 'my_file.xml', tag: 'atag'})
       .then(function(data) {
           console.log(data.attachment);
       });
Back to Top
method
createFolder ( parent, name ) → {Promise.<Object>}
Parameters:
params
Name Type Argument Description
parent
type
Folder 		optional  the parent node to create the folder on
name
type
string 		the name of the folder to create
details
Returns:
returns table
Type Description
type
Promise.<Object>
Example
examples 
// creates a new folder on a specified parent
app.createFolder(parentObj, 'my new folder');

// creates a new folder on the current app
app.createFolder('my new folder');
Back to Top
method
createScenario ( parent, name, type ) → {Promise.<Object>}
Parameters:
params
Name Type Argument Description
parent
type
Folder | App 		optional  the parent node to create the scenario on
name
type
string 		the name of the scenario to create
type
type
string 		optional  the type of scenario to create
details
Returns:
returns table
Type Description
type
Promise.<Object>
Example
examples 
app.createScenario(parentObj, 'my new scenario', null);
Back to Top
method
getAttachmentTagNames ( ) → {Promise.<Array.<string>>}

Get the list of attachment tag names defined by the app.

details
Returns:
returns table
Type Description
type
Promise.<Array.<string>> 		Promise containing an array of strings or an empty array if no attachment tag names found.
Example
examples 
var attachmentTagNames = app.getAttachmentTagNames();
Back to Top
method
getAttachmentTags ( ) → {Promise.<Array.<AttachmentTag>>}

Get the list of attachment tags defined by the app.

details
Returns:
returns table
Type Description
type
Promise.<Array.<AttachmentTag>> 		Promise containing an array of AttachmentTag objects or an empty array if no attachment tags found.
Example
examples 
var attachmentTags = app.getAttachmentTags();
Back to Top
method
getExecutionModes ( ) → {Object.<string, ExecutionMode>}

Returns the app's execution modes, indexed by name

details
Returns:
returns table
Type Description
type
Object.<string, ExecutionMode>
Back to Top
method
getId ( ) → {string}

The app's id.

details
Returns:
returns table
Type Description
type
string 		The app's Id
Example
examples 
var id = app.getId();
Back to Top
method
getModelSchema ( ) → {ModelSchema}

The schema of the model used by this app.

details
Returns:
returns table
Type Description
type
ModelSchema 		The schema of the model used by this app
Example
examples 
var modelSchema = app.getModelSchema();
Back to Top
method
getName ( ) → {string}

The name of this app.

details
Returns:
returns table
Type Description
type
string 		The name of this app
Example
examples 
var name = app.getName();
Back to Top
method
getUsers ( options ) → {Promise.<Array.<User>>}

Get a list of users associated with the app. Optionally filter the result by a custom authority.

Parameters:
params
Name Type Argument Description
options
type
object 		optional  fetch parameters and asynchronous callbacks
Properties
params
Name Type Argument Description
authorityFilter
type
string 		optional  custom authority to filter user list by
details
Returns:
returns table
Type Description
type
Promise.<Array.<User>> 		Promise containing an array of User objects or an empty array if no items found. The array elements will be ordered alphanumerically by username. The User objects will only contain custom authorities. Also the User object will not contain any authority groups.
Example
examples 
var usersList = app.getUsers();
Back to Top
Parent Topic Classes

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