File and Folder Management in Bundles

You can use the Bundle Builder to include files and folders from the File Cabinet in a bundle. When a user installs the bundle, NetSuite installs the files and folders included in the bundle into the target account. You can use this feature to include any File Cabinet file in a bundle.

To include a file or folder in a bundle, you must first check the Available for SuiteBundles box on the file or folder record. The file or folder record then appears in the Bundle Builder.

The location where NetSuite installs files and folders in the target account depends on the type of source account:

Source Account Type	Installation Location
Sandbox	NetSuite installs the files and folders with the same path information as the source account. The installation location is the same for bundles installed from a sandbox account to another sandbox account, or for bundles installed from a sandbox account into a production account. The Preview Install page for SuiteBundler displays the folder and file paths for the files included in the bundle. Use this information to determine the changes that the bundle makes to the files and folders in the target account. Note: This feature does not apply for bundles created in Version 2014 Release 2 or earlier and installed in Version 2015 Release 1 or later, or for bundles installed from a production account into another production account.
Production	If it does not already exist, NetSuite creates a folder called SuiteBundles in the target account and installs all files and folders into a subfolder that contains the bundle ID in the title. For example, if you include a file named foo.js in a bundle with an ID of 100, NetSuite installs the file into the following File Cabinet directory in the target account: /SuiteBundles/Bundle 100/foo.js A user can access this file or folder with a descriptive URL that references the file and folder location. See Accessing Installed Files and Folders with Descriptive URLs.

The following screenshot shows an example of using the Bundle Builder to include folders in a bundle:

Rules and Guidelines for Bundling Files and Folders

Important:

Use the following rules and guidelines when working with files and folders in SuiteBundler.

• If the file or folder included in a bundle already exists in the target account, NetSuite updates the file or folder and the associated properties from the source account.

• To update a file or folder in a bundle after you create the bundle, edit the bundle and update the file or folder. When a user installs or updates the bundle, the file or folder is installed or updated with the changes. See Editing a Bundle.

  Note:

  When a remote file that was added to the File Cabinet using a URL is modified, the File Content Hash field changes when you download this file or its parent folder from the File Cabinet. The value of the File Content Hash field also changes when NetSuite accesses the modified file through an internal process, such as a SuiteScript method call, or a SuiteFlow workflow step. This change is reflected in the system notes for that file. For more information, see File Cabinet Overview.

• If you are creating a bundle on a sandbox account for installation in a production account, and you include a file from a subfolder, but do not explicitly include the folder in the bundle, NetSuite automatically includes the complete folder path for the file. The included subfolders do not appear on the Set Preferences page in the Bundle Builder. However, you can use the Preview Bundle Install page to view the included files and folders when you install the bundle.

• If you include a file or folder in a bundle and then clear the Available for Suitebundles box, NetSuite still includes the file or folder in the bundle. To remove the object, edit the bundle and remove the file or folder.

• Use the Hide in SuiteBundles box on a server SuiteScript file record to prevent anyone who installs the bundle from accessing the file or folder.

• NetSuite may automatically include files in a bundle due to dependency on other objects. For example, when you include a script deployment record in a bundle, NetSuite automatically includes the script file. However, if you lock the script deployment record, NetSuite does not automatically lock the script file. You must manually lock the script file for the script deployment.

• Including large folders in a bundle can extend installation time, in some cases causing network connection problems that result in a failed installation. To ensure installation success, you can perform one of the following actions:

  • You can divide folder contents into multiple smaller bundles.

  • Instead of transferring folder contents to the target account through a bundle installation, you can export all folder contents from the File Cabinet of the source account to a ZIP file and then upload that ZIP file to the File Cabinet of the target account, where you have installed the bundle. For more information, see Downloading Files from the File Cabinet and Uploading Files to the File Cabinet.

    However, even if you exclude some files from bundle installation and import them to the target account through a ZIP file afterward, some objects in the bundle can still reference such previously excluded files and pull them into the target account during bundle installation, thus resulting into duplicate files being installed in the target account.

    There is also a difference in where the files are installed in the File Cabinet, depending on whether you choose to install the files through a bundle, or import the files through a ZIP file.

    For example, if you include a file named foo.js in a bundle with an ID of 100, NetSuite installs the file into the following File Cabinet directory in the target account:

    /SuiteBundles/Bundle 100/foo.js

    However, if you decide to exclude files from bundle installation and import them to the target account through a ZIP file instead, the files imported to the File Cabinet in the target account retain the same folder structure as in the source account.

Related Topics

• Bundle Builder Reference
• Hiding Bundle Components in Target Accounts
• Using Bundle Installation Scripts
• Bundle Support during NetSuite Release Phasing
• Documenting a Bundle
• Defining Bundle Terms of Service
• Protecting Your Bundled Server SuiteScripts
• Adding Files and Folders to a Bundle
• Installing a Bundle That Contains Files and Folders
• Accessing Installed Files and Folders with Descriptive URLs
• Bundling NetSuite Financial Statements
• Bundle Object Preferences
• Locking Objects in Customization Bundles

General Notices