Customizations Supported by SuiteCloud Development Framework
SuiteCloud Development Framework (SDF) provides you with a way to customize NetSuite using SuiteCloud project components instead of using the NetSuite interface. These components can consist of files, scripts, and SDF custom objects such as custom records, custom forms, and workflows. Such components are sometimes referred to as customizations, SDF custom objects, and XML definitions. For more information, see SuiteCloud Development Framework Overview.
You can see the root XML tag and script ID prefix for each SDF custom object in SDF Custom Object File Structure.
The following customizations are supported as SDF custom objects:
Lists, Records, & Fields
-
List, see Custom Lists as XML Definitions and customlist
-
Record type, see Custom Record Types as XML Definitions and customrecordtype
-
Custom segment, see Custom Segments as XML Definitions and customsegment
-
Transaction type, see Custom Transaction Record Types as XML Definitions and customtransactiontype
-
Entity field, see Custom Entity Fields as XML Definitions and entitycustomfield
-
Item field, see Custom Item Fields as XML Definitions and itemcustomfield
-
CRM field, see Custom CRM Fields as XML Definitions and crmcustomfield
-
Transaction body field, see Custom Transaction Body Fields as XML Definitions and transactionbodycustomfield
-
Transaction line field (formerly transaction column field), see Custom Transaction Line Fields as XML Definitions and transactioncolumncustomfield
-
Transaction Item option field, see Custom Transaction Item Option Fields as XML Definitions and itemoptioncustomfield
-
Item number field, see Custom Item Number Fields as XML Definitions and itemnumbercustomfield
-
Other record field (formerly other custom field), see Custom Other Record Fields as XML Definitions and othercustomfield
Forms
You cannot create new address forms, entry forms and transaction forms using SDF. To work with those forms in SDF, you must first import them from a NetSuite account into a SuiteCloud project. See Account Component Imports to SuiteCloud Projects.
-
Address form, see Custom Address Forms as XML Definitions and addressForm
-
Entry form, see Custom Entry Forms as XML Definitions and entryForm
-
Transaction form, see Transaction Forms as XML Definitions and transactionForm
-
Sublist, see Sublists as XML Definitions and sublist
-
Subtab, see Subtabs as XML Definitions and subtab
Import/Export
-
Saved CSV import, see Saved CSV Import Maps as XML Definitions and savedcsvimport
-
Saved search, see Saved Searches as XML Definitions and savedsearch
Note:Do not manually edit the
savedsearch
XML in SDF. Modifications to the system-generated XML may result in validation and deployment failures. You should customize saved searches with NetSuite rather than SDF.
Published Dashboards & Portlets
-
Published Dashboard, see Published Dashboards as XML Definitions and publisheddashboard
The following portlets are supported:
-
Analytics Portlet
-
Calendar Portlet
-
Custom Portlet
-
Custom Search Portlet
-
Event Scheduler Portlet
-
Key Performance Indicator (KPI) Portlet
-
Key Performance Indicator (KPI) Scorecard Portlet
-
KPI Meter Portlet
-
Links Portlet
-
List Portlet
-
Quick Search Portlet
-
Recent Records Portlet
-
Recent Reports Portlet
-
Reminders Portlet
-
Search Form Portlet
-
Settings Portlet
-
Tasks Portlet
-
Trend Graph Portlet
Note:Each portlet type is supported by SDF as part of its support for published dashboards. For more information about defining portlets in SDF, see Supported Published Dashboard Object Portlets.
-
Scripting
-
Bundle installation script, see SuiteScript 2.x Bundle Installation Script Type and bundleinstallationscript
-
Client script, see Client Scripts as XML Definitions and clientscript
-
Map/Reduce script, see Map/Reduce Script Objects as XML Definitions and mapreducescript
-
Mass update script, see Mass Update Scripts as XML Definitions and massupdatescript
-
Portlet script, see Portlet Scripts as XML Definitions and portlet
-
RESTlet script, see RESTlet Scripts as XML Definitions and restlet
-
Scheduled script, see Scheduled Scripts as XML Definitions and scheduledscript
-
Suitelet script, see Suitelet Scripts as XML Definitions and suitelet
-
User event script, see User Event Scripts as XML Definitions and usereventscript
-
Workflow action script, see SuiteScript 2.x Workflow Action Script Type and workflowactionscript
-
SDF Installation script, see SDF Installation Scripts as XML Definitions sdfinstallationscript
-
Translation Collections, see Translation Collections as XML Definitions and translationcollection
Note:When importing
translationcollection
objects into a SuiteCloud project, the corresponding XLIFF files are not created. For more information, see Translation Collections as XML Definitions. -
Workflow, see Workflows as XML Definitions and workflow
-
Integration record, see Integration Records as XML Definitions and integration
-
API secret, see Secrets as XML Definitions and secret
Plug-ins
-
Plug-in – Financial Institution Connectivity, see Financial Institution Connectivity Plug-ins as XML Definitions and ficonnectivityplugin
-
Plug-in – Financial Institution Parser, see Financial Institution Parser Plug-ins as XML Definitions and fiparserplugin
-
Plug-in – Bank Statement Parser, see Bank Statement Parser Plug-ins as XML Definitions and bankstatementparserplugin
-
Plug-in – Custom GL Lines, see Custom GL Lines Plug-ins as XML Definitions and customglplugin
-
Plug-in – Email Capture, see Email Capture Plug-ins as XML Definitions and emailcaptureplugin
-
Plug-in – Promotions, see promotionsplugin
-
Plug-in – Dataset Builder, see Dataset Builder Plug-ins as XML Definitions and datasetbuilderplugin
-
Plug-in – Workbook Builder, see Workbook Builder Plug-ins as XML Definitions and workbookbuilderplugin
-
Plug-in – Custom Plug-in Type, see Creating a Custom Plug-in Type in an XML Definition and plugintype
-
Plug-in – Custom Plug-in Implementation, see Creating a Custom Plug-in Implementation in an XML Definition and pluginimplementation
Centers and Tabs
-
Center, see Centers as XML Definitions and center
-
Center category, see Center Categories as XML Definitions and centercategory
-
Center tab, see Center Tabs as XML Definitions and centertab
-
KPI Scorecard, see KPI Scorecards as XML Definitions and kpiscorecard
Users/Roles
-
Role, see Custom Roles as XML Definitions and role
Templates
-
Email template, see Email Templates as XML Definitions and emailtemplate
-
Advanced HTML/PDF template, see Advanced HTML/PDF Templates as XML Definitions and advancedpdftemplate
Reports
-
Financial reports, see Financial Reports as XML Definitions, reportdefinition and financiallayout
SuiteCommerce Web Site Management
-
CMS Content Type (also known as Custom Content Type), see CMS Content Types as XML Definitions see cmscontenttype
-
SSP Application, see SSP Applications as XML Definitions and sspapplication
SuiteAnalytics Workbooks
-
Dataset, see Custom Dataset Objects and dataset
-
Workbook, see Workbooks as XML Definitions and workbook
Important:Do not modify the contents of the definition structure or its character data. Modifications may corrupt the workbook data when you deploy the modified object to a target NetSuite account.
You should use NetSuite to modify custom workbooks rather than using SDF to modify workbook objects. After you save your changes in NetSuite and re-import the workbook into your SuiteCloud project, the workbook object gets updated safely and automatically.
Related Topics
- SuiteCloud Development Framework
- SuiteCloud Development Framework Overview
- Getting Started with SuiteCloud Development Framework
- Developing SuiteCloud Projects for SuiteCloud Development Framework
- Conversion of a Bundle to an Account Customization Project for SDF
- SuiteCloud Development Framework XML Reference
- SuiteCloud Development Framework Error Handling