runtime.isFeatureInEffect(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description

Use this method to determine if a particular feature is enabled in a NetSuite account. These are the features that appear on the Enable Features page at Setup > Company > Enable Features.

Returns

boolean

Supported Script Types

Client and server scripts

For more information, see SuiteScript 2.x Script Types.

Governance

None

Module

N/runtime Module

Since

2015.2

Parameters
Note:

The options parameter is a JavaScript object.

Parameter

Type

Required / Optional

Description

Since

options.feature

string

required

The internal ID of the feature to check. For a list of feature internal IDs, see Feature Names and IDs.

2015.2

Errors

Error Code

Thrown If

SSS_MISSING_REQD_ARGUMENT

The options.feature parameter is not specified.

WRONG_PARAMETER_TYPE

The value for the options.feature parameter is not a string.

Syntax
Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/runtime Module Script Samples.

          // Add additional code 
...
var featureInEffect = runtime.isFeatureInEffect({
    feature: 'ADVBILLING'
});
log.debug('Advanced Billing feature is enabled: ' + featureInEffect);
...
// Add additional code 

        

Related Topics

N/runtime Module
SuiteScript 2.x Modules
SuiteScript 2.x

General Notices