Bundle Your Application Artifacts

As a service administrator, you can manage snapshots of your application artifacts as bundles.

Topics:

• About Bundles
• Create a Bundle
• Edit a Bundle
• Publish a Bundle
• Export a Bundle
• Import a Bundle
• Deploy a Bundle
• Delete a Bundle
• View the Activity History of Bundles
• Share Bundles

About Bundles

Bundles are snapshots of your application artifacts such as configurations and customizations at a certain point in time.

Bundles work on environments where the source and target are at the same level or the source is at a lower version and the target is at a higher version. For example, a bundle generated from a previous content version works on the latest content version. Ensure that your bundle size is less than 1 GB. If the bundle size exceeds 1GB, then consider splitting the bundle by selectively including necessary artifacts. Prior to deployment, the system validates the bundles to confirm whether the bundles contain all prerequisites. If there is a validation error, then you see the applicable bundle with "Validation Failed" status and you can't deploy it. You must fix the issue and try to deploy again.

Bundles enable you to:

• Package custom development by defining a bundle that represents a subset of application artifacts in an environment such as development, test, or production.
• Migrate custom development and deploy the bundle on a target environment.
• Synchronize instances by promoting changes from one environment to another such as production to test.
• Restore the system when something goes wrong with an environment and you need to do a complete system restore.
• Create a backup of the environment or subset of application to save current state of the artifacts.
• Restore artifacts by importing from a bundle to restore state of the relevant artifacts to what was in the bundle.

You can bundle your application artifacts as:

• Data Config bundle: This includes pipeline parameters, functional area activation metadata, data augmentations, and custom attribute mappings. You can install this bundle in an existing environment after a hard data reset. This is useful to leave content as-is and reset data pipeline. When you bundle data configurations, only the deployed data augmentations or configurations are included. Augmentations or configurations that aren't in deployed state in the source instance won't be included in a data configuration bundle.
• Semantic Model bundle: This includes all custom components of the semantic model, such as external applications, system extensions, user extensions, and security configurations. Depending on the semantic model extensions framework that you use, this bundle includes main sandbox or branch and custom sandbox or branch along with the custom components. When using the branch framework, you can select which tag and version to bundle and deploy. When you use a semantic model bundle from one environment to another environment, the system merges the extensions and not replace them. For example, if you created an extension in the target environment, it will remain in the target if the bundle doesn't bring that in.
• Security bundle: This includes group to application role assignments, custom application roles, and custom data security.
• Content bundle: This includes snapshots of Oracle Analytics Cloud folders (excluding datasets), projects, workbooks, key metrics, connections, analyses, duty roles for content, report parameters, and custom data configurations such as configurable account analysis. The content bundle always merges the catalog content from source to target. While merging, if any conflicts are found, it replaces the content. It doesn't track the deleted content.
• Composite bundle: This includes one or more of the other bundles in any combination. When you generate a composite bundle, the system generates the composite bundle and the bundles inside it as a whole. When you import a composite bundle, all the individual bundles inside the composite are imported separately as well as together. You can deploy the composite bundle as a whole or deploy the individual bundles as applicable. For example, you can deploy the complete composite bundle in one environment and the individual bundles in different environments.
• Environment bundle: The environment bundle encompasses all components included in the semantic model, security, and content bundles, along with other essential elements not explicitly grouped elsewhere. To deploy the environment bundle, you must either deploy the data configuration bundle or activate your data pipelines first.Bundles are snapshots of your application artifacts such as configurations and customizations at a certain point in time. and enables you to restore your environment to a previous state. It's advised to create weekly bundles for backup and restoration purposes.

Note:

Ensure that you've activated the functional areas and data is available prior to working with the semantic models or content. Either manually configure and activate your data pipelines in the target environment, or deploy a Data Config bundle to ensure that configurations and activations are at the same level as the source environment. Only then, it makes sense to deploy an Environment bundle, Semantic bundle, or Composite bundle because they depend on data.

Follow these recommended practices to ensure a smooth experience:

• Include the applicable security-related information in the Semantic Model and Content bundles.
• Reassign the groups to the users because the Security bundle doesn’t overwrite the user-group mappings.
• Include the security configuration when you’re exporting a Semantic Model bundle from a test to a production environment.
• While creating a Security bundle, if the number of application roles exceed 1000, then you may encounter an error. In such a case, use the Select Application Roles button to select specific roles.
• Use unique names for the semantic model extension steps. This enables the tags to work correctly while using the Semantic Model bundle to migrate your content to the target instance.

What’s Available In Bundles

Learn what's available in bundles.

Area	Artifact	Included in Bundles
Security	Application Roles	Security and Environment
Security	Users and Groups	No – move manually, done in Identity Cloud Service
Security	Group to Application Role assignments	Security and Environment
Security	Security contexts including Configurable Context	No – move manually
Uploaded files	Financial Categories, Security assignments	No – move manually
System settings	Oracle Analytics Cloud system settings including Preview features	No – create manually in target environment
Enable features	Activated Oracle Fusion Data Intelligence features	No – create manually in target environment
Semantic model extensions	System, user, security configuration	Semantic and Environment
Data validations	Scheduled validations such as AP Invoices, weekly	No – create manually in target environment
Reporting configurations	Basic reporting configurations	Content
Reporting configurations	Advanced (Configurable Account Analysis)	No – create manually in target environment
Data pipeline	Pipeline parameters, functional areas, augmentations, and priority datasets	Data configurations
Data pipeline	Frequent refresh modules and tables	No – create manually in target environment
Data pipeline	Warehouse full reload schedules	No – create manually in target environment
Data pipeline	Custom data configurations – DFFs	Data configurations
Data pipeline	Custom data configurations such as Configurable Account Analysis	Content
Data pipeline	Data share and bulk data augmentations, if enabled	Data configurations
Connections	Data Augmentation Connectors	No – create manually in target environment
Oracle Analytics Cloud content	Key metrics, Workbooks, Connections, Analyses	Content and Environment
Oracle Analytics Cloud	Data flows, Functions, Machine Learning apps	Environment
Oracle Analytics Cloud	Datasets	No – move manually
Oracle Cloud Infrastructure Console settings	Entitlements, connections, PaaS component settings	No – create manually in target environment
Oracle Autonomous Data Warehouse custom schema	OAX_USER schema objects and data	No – use data pump to back up to and restore from Oracle Object Storage Service

Create a Bundle

Create a snapshot of your application artifacts to save their current state. You can view the bundles that you created on the Bundles page.

While creating a bundle in your source instance, ensure that you select only the data sources that are also available in the target instance to avoid deployment failures in the target instance.

Prior to creating and generating a content bundle, ensure that none of the datasets have names with special characters. Also, if some of the datasets don't have key metrics to back up, manually select the key metrics from the respective subject areas and datasets and regenerate the content bundle. If there aren't any key metrics to back up in the bundle, then you can only select the OAC Content option from the user interface.

1. Sign in to your service.
2. In Oracle NetSuite Analytics Warehouse Console, click Bundles under Application Administration.
3. On the Bundles page, click Create.
   
   

   
   Description of the illustration fawag-bundles-create.png

   
   
4. In Create Bundles, select the type of bundle that you want to create. For example, Content Bundle.
   
   

   
   Description of the illustration fawag-create-bundle.png

   
   
5. Enter a name and description for your bundle.
6. Depending on the type of bundle, select the applicable option and then click Save:
   • For a content bundle, select the Include All Content check box, or select the applicable Oracle Analytics Cloud content, workbooks, and key metrics using the corresponding toggles and buttons. You can select the Include Reporting Parameters and Include Configurable Account Analysis check boxes, if applicable.
     
     
     Description of the illustration fawag-content-bundle.png
     
     
   • For a key metrics content bundle, select the key metrics you want to bundle using the corresponding toggles and buttons. Key metrics are also included with Environment Bundles. To improve performance, select the specific key metrics you want to bundle.
     
     

     

     
     

     Note:

     To import key metrics, you must deploy a key metric bundle into a new instance with key metrics enabled. You can import key metrics in datasets however the entire dataset won't be imported due to security limitations. Datasets without key metrics aren't included in key metrics.
   • For a data configuration bundle, select the Include all data configuration settings check box, or select the applicable modules, augmentations, custom attribute mappings, and pipeline settings using the corresponding toggles and Select buttons.

     Note:

     The Include all data configuration settings selects only the deployed custom data configurations, the activated data augmentations, and the activated functional areas.
   • For a semantic extensions bundle, you can select Include all semantic extensions check box (this adds the external semantic model too) to include everything or select Include External RPD to only include external elements. Select the Publish External RPD check box to publish external elements. Select a tag or branch from the dropdown box to define which tag or branch you want to publish.
     
     
     Description of the illustration fawag-semantic-extensions-bundle.png
     
     

     If you've migrated to the latest wizards for extending the semantic model, select the Semantic Extensions to include all sandbox customizations. If required, select an external application to include external elements in the bundle.
     
     

   • For a security bundle, select the Include all security settings check box or select the Oracle NetSuite Analytics Warehouse-related application roles using the Select Application Roles button as the recommended approach.

     Note:

     If you've uptaken the enhanced security capability of Oracle NetSuite Analytics Warehouse, then you no longer can specifically select groups as part of the Security bundle. See About Managing Users, Groups, and Application Roles.
     
     
     
     Description of the illustration fawag-security-bundle.png
     
     
   • For an environment bundle, provide a name.
     
     
     Description of the illustration fawag-environment-bundle.png
     
     
   • For a composite bundle, select any of the other bundles.
     
     
     Description of the illustration fawag-composite-bundle.png
     
     

Edit a Bundle

Edit a bundle if you need to change the application artifacts captured in the bundle.

Note:

When you edit a bundle, you can't see the bundle definitions till you complete the bundle deployment. Functional areas and data augmentations in the bundle are visible after the bundle deployment process schedules them. The custom data configurations in the bundle are visible after the deploy custom data configurations process is completed.

1. Sign in to your service.
2. In Oracle NetSuite Analytics Warehouse Console, click Bundles under Application Administration.
3. On the Bundles page, hover over the bundle that you created and click under Actions.
4. From Actions, select Edit.
   
   

   
   Description of the illustration fawag-bundles-actions-edit.png

   
   
5. On the applicable bundles page, make your changes and then click Update.

Publish a Bundle

Publish a bundle from the source environment. This action generates a snapshot of the application artifacts and saves the snapshot to a repository. You can download this bundled artifact and import it into different instances.

1. Sign in to your service.
2. In Oracle NetSuite Analytics Warehouse Console, click Bundles under Application Administration.
3. On the Bundles page, hover over the bundle that you created and click under Actions.
4. From Actions, select Generate to create and publish the bundle.
   
   

   
   Description of the illustration fawag-bundles-actions-generate.png

   
   

You see the bundle with Generated status on the Bundles page.

Deploy a Bundle

You can deploy a generated bundle in the target environment to revert to the state of artifacts represented by the bundle. The system validates the bundle before attempting any deployment to ensure software and model versions and any other dependencies are met.

For example, if you have a bundle A (created in instance A) and then later made some changes but want to revert those changes, then use the Deploy option. This option restores the artifacts to an older version by deploying the previous bundle in the system.

If you’re deploying the semantic extensions bundle or the composite bundle, you can either merge the sandbox content in the target environment or replace it. The Replace Sandbox Content option enables you to delete the existing semantic model extensions in the target environment and migrate the latest bundle content. This option completely overwrites all existing content in the target instance with the content from your source sandbox instance. You must confirm the semantic model replacement to prevent unintended content loss. It's important to note that the security details continue to merge. This option is helpful when you've deleted items in your source instance and want those deletions to be applied to the target instance. When you deploy an environment bundle, it replaces the target environment. The default, Merge Sandbox Content, combines the changes from your source sandbox instance with the existing content on the target system.

1. Sign in to your service.
2. In Oracle NetSuite Analytics Warehouse Console, click Bundles under Application Administration.
3. On the Bundles page, hover over the bundle that you created, click Actions, and from Actions, select Deploy.
4. In Deploy Bundle, if you’re deploying the semantic extensions bundle or the composite bundle, select the applicable option and click Deploy. For other bundles, verify that you see the bundle that you selected.
   
   

   

   
   
5. If you choose to replace the sandbox content, in Semantic Extensions Bundle Confirmation, click Confirm to continue the replace immediately without a final warning, or click Cancel to abort.
   
   

   

   
   

Export a Bundle

Export the bundle .aab file from your source system to a repository or your local machine.

1. Sign in to your service.
2. In Oracle NetSuite Analytics Warehouse Console, click Bundles under Application Administration.
3. On the Bundles page, hover over the bundle that you created and click under Actions.
4. From Actions, select Export.
   
   

   
   Description of the illustration fawag-bundles-actions-export.png

   
   

Import a Bundle

Import the bundle .aab file into the target environment from your computer to restore the state of the application to the checkpoint represented by the bundle.

1. Sign in to your service.
2. In Oracle NetSuite Analytics Warehouse Console, click Bundles under Application Administration.
3. On the Bundles page, click Import.
   
   

   
   Description of the illustration fawag-bundles-import-option.png

   
   
4. In the Import Bundle dialog, click in Drag and Drop, and then select the applicable .aab file from your local machine.
   
   

   
   Description of the illustration fawag-import-bundle.png

   
   
5. Click Import.

Delete a Bundle

Delete a bundle if you no longer require the snapshot of your application artifacts captured in the bundle.

1. Sign in to your service.
2. In Oracle NetSuite Analytics Warehouse Console, click Bundles under Application Administration.
3. On the Bundles page, hover over the bundle that you created and click under Actions.
4. From Actions, select Delete.
   
   

   
   Description of the illustration fawag-bundles-actions-delete.png

   
   

View the Activity History of Bundles

View all the bundles-related activities to understand the changes made to your instance, which bundles to use, and whether the existing bundles are still current. This information enables you to make informed decisions about creating updated bundles or deploying an existing bundle.

You see all the activities by bundle-related action, bundle names, bundle type, status, user who performed the activity, and date. You can organize the display by sorting columns, searching for activities, and filtering by action, bundle type, or status.

1. Sign in to your service.
2. In Oracle NetSuite Analytics Warehouse Console, click Bundles under Application Administration.
3. On the Bundles page, click the Activity tab.
   
   

   

   
   

Share Bundles

You can share bundles within the same tenancy as private bundles and as public bundles for tenancies with specific entitlements.

The Bundle Repository is a resilient store for bundles and provides the ability to create and manage the deployment of bundles. This repository enables you to easily manage sharing, importing, and deploying bundles.

Topics:

• About the Bundle Repository
• Publish a Bundle to the Repository
• Import a Shared Bundle
• Deploy a Shared Bundle

About the Bundle Repository

The Bundle Repository is an app-store like experience for users to import bundles created by partners or other users.

The repository enables Oracle internal and external partners to share bundles easily with users and provide updates. You can migrate bundles from lower to higher environments in the same tenancy. You don’t need to download bundles on your local machine or server.

As a bundle creator, you can create a bundle using the Bundles tile on the Console and publish it to the repository using the Bundles Repository tile on the Console. While publishing the bundle to the repository, you can add terms and conditions, documentation, and usage guidelines. When you share any bundle to the Bundle Repository, the bundle is accessible to other instances. You must review and ensure the bundles are shared with correct settings and descriptions.

As a bundle consumer, you can view the details of each shared bundle and import them into your instance. After you import a shared bundle, you can then deploy it in your instance.

Bundle creators maintain any updates to a bundle and any restrictions for use. The updated bundle displays an "Update Available" message if you had installed it previously. You can then reimport it.

Publish a Bundle to the Repository

You publish a bundle to the repository to share it with others.

On the Bundle Repository page, under My Bundles, you see the bundles that you created using the Bundles tile. See About Bundles.

1. Sign in to your service.
2. In Oracle NetSuite Analytics Warehouse Console, click Bundle Repository under Application Administration.
   
   

   

   
   
3. On the Bundle Repository page, click the My Bundles tab, and for the applicable bundle, click the Action icon and then click Publish.
   
   

   

   
   
4. On the Publish Bundle page, provide the bundle details based on private or public bundle permissions and then click Done.

   
   
   

   
   
   

Import a Shared Bundle

You can view the bundles shared by others on the Bundles Repository page and you can import it into your instance to use the bundle objects in your semantic model extensions and data augmentations.

1. Sign in to your service.
2. In Oracle NetSuite Analytics Warehouse Console, click Bundle Repository under Application Administration.
3. On the Bundle Repository page, under the Bundle Repository tab, click an applicable bundle or search for a shared bundle, click View Details to review the shared details, and click Import to install the bundle in your instance.
   
   

   

   
   
4. In the Import Bundle dialog, review the terms of use, select the I Agree to the terms check box, and click Submit.
   
   

   

   
   
5. Verify the status of the import process on the Activity page and then verify that the shared bundle is visible under the Local Bundles tab.
   
   

   

   
   

Deploy a Shared Bundle

You can deploy the shared bundle that you imported into your instance to use the objects in the shared bundle. Oracle NetSuite Analytics Warehouse validates the bundle before attempting any deployment to ensure software and model versions and any other dependencies are met.

1. Sign in to your service.
2. In Oracle NetSuite Analytics Warehouse Console, click Bundle Repository under Application Administration.
3. On the Bundle Repository page, click the Local Bundles tab, hover over a shared bundle that you had imported, and then click the Actions icon.
   
   

   

   
   
4. From Actions, select Deploy.
5. In the Deploy Bundle dialog, ensure that you see the bundle that you have selected, select the applicable actions, and then click Deploy.