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.
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.
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 |
---|---|---|---|
|
|
|
|
Note:
When you add an advanced PDF template object to a SuiteCloud project, ensure that it is also associated with a |
|
|
Advanced HTML/PDF Templates as XML Definitions and advancedpdftemplate |
|
|
|
Bank Statement Parser Plug-ins as XML Definitions and bankstatementparserplugin |
|
|
|
SuiteScript 2.x Bundle Installation Script Type and bundleinstallationscript |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Custom GL Lines Plug-ins as XML Definitions and customglplugin |
|
|
|
|
|
|
|
|
Note:
Custom segment objects must be associated with a custom record object type. |
|
|
|
|
|
|
Custom Transaction Record Types as XML Definitions and customtransactiontype |
|
|
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. |
|
|
|
|
Dataset Builder Plug-ins as XML Definitions and datasetbuilderplugin |
|
|
|
Email Capture Plug-ins as XML Definitions and emailcaptureplugin |
|
|
|
|
|
|
|
Custom Entity Fields as XML Definitions and entitycustomfield |
|
|
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. |
|
|
|
|
Financial Institution Connectivity Plug-ins as XML Definitions and ficonnectivityplugin |
|
|
|
Financial Reports as XML Definitions, reportdefinition and financiallayout |
|
|
|
Financial Institution Parser Plug-ins as XML Definitions and fiparserplugin |
|
|
|
|
|
|
|
|
|
|
|
Custom Item Number Fields as XML Definitions and itemnumbercustomfield |
|
|
|
Custom Transaction Item Option Fields as XML Definitions and itemoptioncustomfield |
|
|
|
|
|
|
|
Map/Reduce Script Objects as XML Definitions and mapreducescript |
|
|
|
|
|
|
|
Custom Other Record Fields as XML Definitions and othercustomfield |
|
|
|
Creating a Custom Plug-in Implementation in an XML Definition and pluginimplementation |
|
|
|
Creating a Custom Plug-in Type in an XML Definition and plugintype |
|
|
|
|
|
|
|
Published Dashboards as XML Definitions and publisheddashboard |
|
|
|
Financial Reports as XML Definitions, reportdefinition and financiallayout |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Warning:
Do not manually edit the |
|
|
|
|
|
|
|
|
SDF Installation Scripts as XML Definitions sdfinstallationscript |
|
|
|
|
|
|
|
Single Page Applications as XML Definitions and singlepageapp |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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 Transaction Body Fields as XML Definitions and transactionbodycustomfield |
|
|
|
Custom Transaction Line Fields as XML Definitions and transactioncolumncustomfield |
|
|
|
Translation Collections as XML Definitions and translationcollection |
|
|
|
|
|
|
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. |
|
|
|
|
Workbook Builder Plug-ins as XML Definitions and workbookbuilderplugin |
|
|
|
|
|
|
|
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