Feature Dependencies for SDF Custom Objects in SuiteCloud Projects
When you use SuiteCloud Development Framework (SDF) to develop SuiteApps or account customizations in SuiteCloud projects, you must consider which NetSuite features are required for the SDF custom objects and which features are optional:
-
For some SDF custom objects, NetSuite features must be added to the SuiteCloud project manifest so that the SDF SuiteApp successfully installs (or SuiteCloud project deploys) to the target account. For more information, see Standard Feature Dependencies for SDF Custom Objects and Enhanced Feature Dependencies for SDF Custom Objects Containing OneWorld Components.
-
NetSuite features can be optional for some SDF custom objects even though the record type or field on an SDF custom object is feature dependent. For those SDF custom objects, the SuiteApp installation (or SuiteCloud project deployment) succeeds, but those objects or fields that require the features are not visible to the users of the target account. For more information, see Enhanced Feature Dependencies for SDF Custom Objects.
Standard Feature Dependencies for SDF Custom Objects
For SDF custom objects that are not listed in Enhanced Feature Dependencies for SDF Custom Objects and Enhanced Feature Dependencies for SDF Custom Objects Containing OneWorld Components, you must reference the feature dependencies in the SuiteCloud project so that validation and deployment succeeds. This ensures that the required features are enabled in the target account so that the SDF custom objects can be used in that account.
Dependencies are referenced using the feature
element in the SuiteCloud project manifest. Each element has a required
attribute that accepts a string value of true
or false
. You can update the project manifest manually or let SDF evaluate the project and update the manifest automatically.
When you set a required
element to true
, the referenced feature is required to be enabled in the target NetSuite account. Any SDF custom object in the SuiteCloud project that is feature-dependent should work as intended.
When you set a required
element to false
, the referenced feature does not need to be enabled in the target NetSuite account. Any SDF custom object in the SuiteCloud project that is feature-dependent may cause errors or warnings during validation. The element contents are ignored if they depend on features that are not required. These elements cause warnings when the SuiteCloud project is validated.
To add and define feature dependencies:
-
Using SuiteCloud Extension for Visual Studio Code, see Adding Dependencies to the Manifest in SuiteCloud Extension for Visual Studio Code.
-
Using SuiteCloud IDE plug-in for WebStorm, see Defining Feature Dependencies in SuiteCloud IDE Plug-in for WebStorm.
-
Using CLI for Node.js, see project:adddependencies.
-
Using CLI for Java, see listmissingdependencies and adddependencies.
-
Manually, see Manually Defining Feature Dependencies in the SuiteCloud Project Manifest.
Related Topics
- Developing SuiteCloud Projects for SuiteCloud Development Framework
- Account Component Imports to SuiteCloud Projects
- SDF Custom Object Dependencies in SuiteApps
- Account Component Dependencies in SuiteCloud Projects
- Account Configuration from an Account Customization Project
- SDF Custom Object and File Development in SuiteCloud Projects
- SuiteCloud Project Validation
- SuiteCloud Project Deployment Preparation
- Deployment Logs for SuiteCloud Projects
- Viewing and Uninstalling SDF SuiteApps in a NetSuite Account
- Publishing an SDF SuiteApp