SDF Custom Object File Structure

This topic provides the script ID prefix and root XML tag for each supported SDF custom object in SuiteCloud Development Framework (SDF). This information can be useful when you are creating a new XML definition of an SDF custom object from your SuiteCloud project.

Important:

Objects must be stored in the Objects folder of the SuiteCloud project. The correct prefix must be used for its object type. The script ID for an SDF custom object must match that object's XML filename.

Tip:

For additional information about supported SDF custom objects, see Customizations Supported by SuiteCloud Development Framework and SuiteCloud Development Framework XML Reference.

SDF Custom Object Type	Script ID Prefix	Root XML Tag	Topics
addressform	custaddressform_	<addressForm scriptid="custform_"> ... </addressForm>	Custom Address Forms as XML Definitions and addressForm
advancedpdftemplate Note: When you add an advanced PDF template object to a SuiteCloud project, ensure that it is also associated with a custimpl_.template.xml file in the Templates folder.	custtmpl_	<advancedpdftemplate scriptid="custtmpl_"> ... </advancedpdftemplate>	Advanced HTML/PDF Templates as XML Definitions and advancedpdftemplate
bankstatementparserplugin	customscript	<bankstatementparserplugin scriptid="customscript_"> … </bankstatementparserplugin>	Bank Statement Parser Plug-ins as XML Definitions and bankstatementparserplugin
bundleinstallationscript	customscript_	<bundleinstallationscript scriptid="customscript_"> ... </bundleinstallationscript>	SuiteScript 2.x Bundle Installation Script Type and bundleinstallationscript
center	custcenter_	<center scriptid="custcenter_"> ... </center>	Centers as XML Definitions and center
centercategory	custcentercategory_	<centercategory scriptid="custcentercategory_"> ... </centercategory>	Center Categories as XML Definitions and centercategory
centerlink	custlink_	<centerlink scriptid="custlink_"> ... </centerlink>	Center Categories as XML Definitions and centerlink
centertab	custcentertab_	<centercentertab scriptid="custcentertab_"> ... </centercentertab>	Center Tabs as XML Definitions and centertab
clientscript	customscript_	<clientscript scriptid="customscript_"> ... </clientscript>	Client Scripts as XML Definitions and clientscript
cmscontenttype	custcontenttype_	<cmscontenttype scriptid="custcontenttype_"> ... </cmscontenttype>	CMS Content Types as XML Definitions see cmscontenttype
crmcustomfield	crmcustomfield_	<crmcustomrield scriptid="crmcustomfield_"> ... </crmcustomfield>	Custom CRM Fields as XML Definitions and crmcustomfield
customglplugin	customscript_	<customglplugin scriptid="customscript_"> ... </customglplugin>	Custom GL Lines Plug-ins as XML Definitions and customglplugin
customlist	customlist_	<customlist scriptid="customlist_"> ... </customlist>	Custom Lists as XML Definitions and customlist
customrecordtype	customrecord_	<customrecordtype scriptid="customrecord_"> ... </customrecordtype>	Custom Record Types as XML Definitions and customrecordtype
customsegment Note: Custom segment objects must be associated with a custom record object type.	customsegment_	<customsegment scriptid="cseg_"> ... </customsegment>	Custom Segments as XML Definitions and customsegment
customtransactiontype	customtransaction_	<customtransactiontype scriptid="customtransaction_"> ... </customtransactiontype>	Custom Transaction Record Types as XML Definitions and customtransactiontype
dataset	custdataset_	<dataset scriptid="custdataset_"> ... </dataset> Important: Do not modify the contents of the definition structure or its character data. Modifications may damage 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.	Custom Dataset Objects and dataset
datasetbuilderplugin	customscript_	<datasetbuilderplugin scriptid="customscript_"> ... </datasetbuilderplugin>	Dataset Builder Plug-ins as XML Definitions and datasetbuilderplugin
emailcaptureplugin	customscript_	<emailcaptureplugin scriptid="customscript_"> ... </emailcaptureplugin>	Email Capture Plug-ins as XML Definitions and emailcaptureplugin
emailtemplate	custemailtmpl_	<emailtemplate scriptid="custemailtmpl_"> ... </emailtemplate>	Email Templates as XML Definitions and emailtemplate
entitycustomfield	custentity_	<entitycustomfield scriptid="custentity_"> ... </entitycustomfield>	Custom Entity Fields as XML Definitions and entitycustomfield
entryForm	custform_	<entryForm scriptid="custform_"> ... </entryForm> Important: Due to the complexity of this object, you should import an existing instance of this object type from a NetSuite account when you want to work with this object in the SuiteCloud project.	Custom Entry Forms as XML Definitions and entryForm
ficonnectivityplugin	customscript	<ficonnectivityplugin scriptid="customscript_"> ... </ficonnectivityplugin>	Financial Institution Connectivity Plug-ins as XML Definitions and ficonnectivityplugin
financiallayout	customlayout_	<financiallayout scriptid="customlayout_"> ... </financiallayout>	Financial Reports as XML Definitions, reportdefinition and financiallayout
fiparserplugin	customscript	<fiparserplugin scriptid="customscript_"> ... </fiparserplugin>	Financial Institution Parser Plug-ins as XML Definitions and fiparserplugin
integration	custinteg	<integration scriptid="custinteg_"> ... </integration>	Integration Records as XML Definitions and integration
itemcustomfield	custitem_	<itemcustomfield scriptid="custitem_"> ... </itemcustomfield>	Custom Item Fields as XML Definitions and itemcustomfield
itemnumbercustomfield	custitemnumber_	<itemnumbercustomfield scriptid="custitemnumber_"> ... </itemnumbercustomfield>	Custom Item Number Fields as XML Definitions and itemnumbercustomfield
itemoptioncustomfield	custcol_	<itemoptioncustomfield scriptid="custcol_"> ... </itemoptioncustomfield>	Custom Transaction Item Option Fields as XML Definitions and itemoptioncustomfield
kpiscorecard	custkpiscorecard_	<kpiscorecard scriptid="custkpiscorecard_"> ... </kpiscorecard>	KPI Scorecards as XML Definitions and kpiscorecard
mapreducescript	customscript_	<mapreducescript scriptid="customscript_"> ... </mapreducescript>	Map/Reduce Script Objects as XML Definitions and mapreducescript
massupdatescript	customscript_	<massupdatescript scriptid="customscript_"> ... </massupdatescript>	Mass Update Scripts as XML Definitions and massupdatescript
othercustomfield	customrecord_	<othercustomfield scriptid="customrecord_"> ... </othercustomfield>	Custom Other Record Fields as XML Definitions and othercustomfield
pluginimplementation	customscript_	<pluginimplementation scriptid="customscript_"> ... </pluginimplementation>	Creating a Custom Plug-in Implementation in an XML Definition and pluginimplementation
plugintype	customscript_	<plugintype scriptid="customscript_"> ... </plugintype>	Creating a Custom Plug-in Type in an XML Definition and plugintype
portlet	customscript_	<portlet scriptid="customscript_"> ... </portlet>	Portlet Scripts as XML Definitions and portlet
publisheddashboard	custpubdashboard_	<publisheddashboard scriptid="custpubdashboard_"> ... </publisheddashboard>	Published Dashboards as XML Definitions and publisheddashboard
reportdefinition	customreport_	<reportdefinition scriptid="customreport_"> ... </reportdefinition>	Financial Reports as XML Definitions, reportdefinition and financiallayout
restlet	customscript_	<restlet scriptid="customscript_"> ... </restlet>	RESTlet Scripts as XML Definitions and restlet
role	customrole_	<role scriptid="customrole_"> ... </role>	Custom Roles as XML Definitions and role
savedcsvimport	custimport_	<savedcsvimport scriptid="custimport_"> ... </savedcsvimport>	Saved CSV Import Maps as XML Definitions savedcsvimport
savedsearch	customsearch_	<savedsearch scriptid="customsearch_"> ... </savedsearch> Warning: 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.	Saved Searches as XML Definitions and savedsearch
scheduledscript	customscript_	<scheduledscript scriptid="customscript_"> ... </scheduledscript>	Scheduled Scripts as XML Definitions and scheduledscript
sdfinstallationscript	customscript_	<sdfinstallationscript scriptid="customscript_"> ... </sdfinstallationscript>	SDF Installation Scripts as XML Definitions sdfinstallationscript
secret	custsecret_	<secret scriptid="custsecret_"/> </secret>	Secrets as XML Definitions and secret
singlepageapp	custspa_	<singlepageapp scriptid="custspa_"> ... </singlepageapp>	Single Page Applications as XML Definitions and singlepageapp
sspapplication	webapp_	<sspapplication scriptid="webapp_"> ... </sspapplication>	SSP Applications as XML Definitions and sspapplication
sublist	custsublist_	<sublist scriptid="custsublist_"> ... </sublist>	Sublists as XML Definitions and sublist
subtab	custtab_	<subtab scriptid="custtab_"> ... </subtab>	Subtabs as XML Definitions and subtab
suitelet	customscript_	<suitelet scriptid="customscript_"> ... </suitelet>	Suitelet Scripts as XML Definitions and suitelet
transactionForm	custform_	<transactionForm scriptid="custform_"> ... </transactionForm> Important: Due to the complexity of this object, you should import an existing instance of this object type from a NetSuite account when you want to work with this object in the SuiteCloud project.	Transaction Forms as XML Definitions and transactionForm
transactionbodycustomfield	custbody_	<transactionbodycustomfield scriptid="custbody_"> ... </transactionbodycustomfield>	Custom Transaction Body Fields as XML Definitions and transactionbodycustomfield
transactioncolumncustomfield	custcol_	<transactioncolumncustomfield scriptid="custcol_"> ... </transactioncolumncustomfield>	Custom Transaction Line Fields as XML Definitions and transactioncolumncustomfield
translationcollection	custcollection_	<translationcollection scriptid="custcollection_"> .... </translationcollection>	Translation Collections as XML Definitions and translationcollection
usereventscript	customscript_	<usereventscript scriptid="customscript_"> ... </usereventscript>	User Event Scripts as XML Definitions and usereventscript
workbook	custworkbook_	<workbook scriptid="custworkbook_"> ... </workbook> Important: Do not modify the contents of the definition structure or its character data. Modifications may damage 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.	Workbooks as XML Definitions and workbook
workbookbuilderplugin	customscript_	<workbookbuilderplugin scriptid="customscript_"> ... </workbookbuilderplugin>	Workbook Builder Plug-ins as XML Definitions and workbookbuilderplugin
workflow	customworkflow_	<workflow scriptid="customworkflow_"> ... </workflow>	Workflows as XML Definitions and workflow
workflowactionscript	customscript	<workflowactionscript scriptid="customscript_"> ... </workflowactionscript>	workflowactionscript

Related Topics

• Developing SDF Custom Objects
• Syntax Guidelines and Reference Formats for SDF Custom Objects
• Translatable Fields on SDF Custom Objects
• Downloading the XML Definition of an Object from a NetSuite Account
• Account-Specific Values Validation in SuiteCloud Projects
• Date and Time Formats in SDF Custom Objects
• Lists, Records, and Fields
• Reports
• Forms
• Import and Export
• Published Dashboards and Portlets
• Scripting
• Plug-ins
• Centers and Tabs
• Users and Roles in SDF
• Templates
• SuiteCommerce Web Site Management
• SuiteAnalytics Workbooks

General Notices