Bundle Object Preferences
For customization bundles, preferences are available for some object types. These preferences, which are applied during bundle installations and updates in target accounts, help to properly set up bundle objects. You set these preferences on the Step 4 Set Preferences page of the Bundle Builder when you create or edit a bundle, by choosing from options displayed in Preference column dropdown lists.
You can control preferences for pushed and managed bundle accounts, and you can supply default preferences for other install base accounts. The bundle preference options you choose are applied directly to target accounts during managed bundle and other pushed bundle installations and updates. For other bundles, target account administrators can override these preferences before bundle installation or update.
The following types of bundle objects have preferences available in the Bundle Builder.
-
Dashboards
For any dashboard, you can set a preference to indicate whether updates to the bundled dashboard should be applied to the dashboards of target account users to whom the dashboard has been published. (Updates are always applied to the target account dashboard definition.)
This setting is applied during bundle updates, when the dashboard is updated in the target account.
The default option is not to apply updates to users, allowing target account administrators to publish updates to users' dashboards as desired after bundle updates. See Applying Changes to Published Dashboards.
-
Custom Fields
For any custom field, you can set a preference to choose whether the field should be shown or hidden on existing custom forms in target accounts. The default option is to hide the field.
This setting is applied during bundle installations and updates, whenever the field is first added to a target account. This setting does not affect bundled forms, because all custom fields in a bundle are always shown on all custom forms included in that bundle.
-
Custom Lists
For any custom list, you can set a preference, applied during bundle updates, to choose whether: the bundled custom list data should replace data in the target account custom list, the target account custom list data should be preserved, or data from the bundled custom list and target account custom list should be merged. The default option is to preserve data.
This preference is also available, during both installations and updates, for conflicting custom lists that have the Replace Existing Object option chosen. See Resolving Conflicting Objects.
-
Custom Records
For any custom record that includes data, you can set a preference, applied during bundle updates, to choose whether: the bundled custom record data should replace data in the target account custom record, the target account custom record data should be preserved, or data from the bundled custom record and target account custom record should be merged. The default option is to preserve data.
This preference is also available, during both installations and updates, for conflicting custom records that include data and have the Replace Existing Object option chosen. See Resolving Conflicting Objects.
-
Custom Segments
For any custom segment that includes data, you can set a preference, applied during bundle updates, to choose whether: the target account custom segment data should be preserved, or data from the bundled custom segment and target account custom segment should be merged. The default option is to preserve data.
When the Preserve Data option is selected, the bundle update does not make any changes to target account custom segment values. When the Merge Data option is selected, the bundle update merges custom segment values, without deleting any values from the target account custom segment. The avoidance of target account custom segment value deletion is due to the possibility that a custom segment may have GL impact. In addition, no option is provided to replace data for a custom segment, also to avoid unintentional changes to GL impact.
For more information about bundling custom segments, see Adding a Custom Segment to a Bundle.
Note:If a custom record's data is referenced by another custom record for which the Include Data preference is enabled, data for the referenced custom record is included as well, even if the Include Data preference is not enabled for that referenced custom record.
-
Custom Forms
For any custom form, you can set a preference to choose whether the form should be set as the preferred form for the record type in target accounts. The default option is not to set the form as preferred.
Warning:This setting is applied during pushed installations only. Unlike other preferences, bundle installers cannot override this preference's Bundle Builder setting.
-
SuiteScripts
For any SuiteScript, you can set a preference, applied during bundle updates, to choose whether target account script deployments should be updated with deployments from the bundled scripts. The default option is to not update target account script deployments, leaving them unchanged after the bundle update.
If the update deployments option is applied, bundled script deployments completely overwrite target account script deployments, except for script deployment audience definitions. Bundle updates implement an intelligent merge of audience definitions in source and target accounts when the update deployments option is applied. For details, see Bundle Update Reference.
Note that changes to an icon associated with a dashboard SuiteApp portlet are always copied during a bundle update. This overwrite of the icon in the target account occurs even if the bundle preference is set to prevent the update of script deployments. See Giving Users Dashboard Access to a SuiteApp.
Note:Bundle updates do not change the values of script deployment parameters that have a user or company preference set, even if the bundle preference for the script is set to Update Deployments. For more information, see Script Parameter Preferences and Bundles.
Bundle Object Preferences Table
The following table provides a quick reference to customization bundle object preferences:
Object |
Options (** =Default) |
Applied During |
---|---|---|
Dashboards |
|
updates |
Custom Fields |
|
Note:
This setting is applied whenever the field is first added to a target account. This setting does not affect bundled forms, because all custom fields in a bundle are always shown on all custom forms included in that bundle. |
|
|
|
Custom Segments |
|
updates |
Custom Forms |
|
installations (push only) |
SuiteScripts |
|
updates |
Preferences in Bundles Created Prior to Version 2011 Release 1
Most bundle object preferences became available to bundle authors as of Version 2011 Release 1. After your account was upgraded to this release, any bundles that you created prior to this release have the default option set for each preference. If you want one of these bundles to use any non-default options, you need to edit the bundle in the Bundle Builder and explicitly set the preference(s). See Editing a Bundle.
The preference for dashboards became available as of Version 2012 Release 1.
Preferences in Copied Bundles
Preferences set for a bundle are not applied in an account where the bundle is copied. Note that data is always replaced and script deployments are always updated during an update of a bundle copy. However the preferences set for a bundle are maintained as the defaults on the Step 4 Set Preferences page of the copied bundle, and are applied in target accounts where the copied bundle is installed, unless the preferences are edited in the copied bundle. See Copying a Bundle to Other Accounts.
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
- File and Folder Management in Bundles
- Bundling NetSuite Financial Statements
- Locking Objects in Customization Bundles
- SuiteApp Creation and Distribution
- Creating a Bundle with the Bundle Builder
- Step 4 Set Preferences
- Editing a Bundle
- SuiteApp Installation and Update
- Resolving Conflicting Objects