1. SuiteCloud Platform
  2. SuiteScript
  3. SuiteScript 2.x
  4. SuiteScript 2.x Script Types
  5. SuiteScript 2.x SDF Installation Script Type

SuiteScript 2.x SDF Installation Script Type

The SDF installation script type is used to perform tasks during deployment of a SuiteApp from SuiteCloud Development Framework (SDF) to your target account. You can use this script type to perform setup, configuration, and data management tasks that would otherwise have to be completed by account administrators, such as:

The SDF installation script type is similar to the bundle installation script type. However, this script type is designed for use with SuiteApps that are developed and deployed with the SDF, rather than with SuiteBundler.

For details about SDF installation scripts, see the following help topics:

SDF Installation Script Requirements

To run an SDF installation script when deploying your SuiteApp, you need to link it to a script record and a script deployment record. For more information, see the help topic Creating a Script Record.

You can create script records and script deployment records in a few ways: (1) within your SuiteCloud project as XML representations, (2) using SuiteScript, and (3) from within your NetSuite account. For more information, see the help topics SDF Installation Scripts as XML Definitions and SuiteCloud Development Framework XML Reference.

SDF installation scripts have a limit of 10,000 units per run. For more information about governance, see the help topics Script Type Usage Unit Limits and SuiteScript Governance and Limits.

Managing SDF Installation Scripts in SDF

You can use SuiteCloud Development Framework to manage SDF installation scripts as part of file-based customization projects. You can also add SDF installation scripts to your SuiteApp project deployment. SuiteApp projects can include SDF installation scripts, which run automatically when the project is deployed. For more information, see the following help topics:

You can monitor SDF installation scripts and deployments using the deploy log in SuiteCloud IDE or the Execution Log on the Script or Script Deployment page. For more information, see Deployment Logs for SuiteCloud Projects and Handling Exceptions and Monitoring SDF Installation Scripts.

Copy to Account Support for SDF Installation Scripts

Use the Copy to Account feature to copy an SDF installation script to another account. Find the Copy To Account option in the top right corner of each SDF installation script page. For information about Copy to Account, see the help topic Copy to Account.

SDF Installation Script Samples

SDF installation script samples are available in the following SuiteCloud Development Framework help topics:

Related Topics

General Notices