About Bundles

Version and Size Requirements

• Bundles work when the source and target environments are on the same version, or when the target is on a higher version than the source.
• Keep bundle size under 1 GB. If a bundle exceeds 1 GB, split it by including only the required artifacts. A practical way to confirm size is to generate and download the bundle.

Validation Before Deployment

Before deployment, the system validates that the bundles contain all prerequisites. If validation fails, the bundle shows Validation Failed and can’t be deployed until you correct the issue and retry.

Why Use Bundles?

Use bundles to:

• Package a subset of artifacts for development, test, or production environments.
• Migrate and deploy custom development to another environment.
• Synchronize environments by promoting changes from one environment to another. For example, from production to test environment.
• Restore an environment after an issue (full system restore).
• Create backups of an environment or a subset of artifacts.
• Restore specific artifacts by importing a bundle.

Bundle Types

• Data Config Bundle includes:
  • Pipeline parameters
  • Priority datasets
  • Functional area activation metadata
  • Data augmentations
  • Custom data configurations

  Notes:

  • Can be deployed after resetting the data warehouse to keep content unchanged and re-establish data pipeline configuration. See Reset the Data Warehouse.
  • Includes only deployed augmentations or configurations. Augmentations or configurations not deployed in the source aren’t included.
  • You can include extract configurations for connections, but not connection details. The target environment must already have the required connections defined.

  If you've enabled the Data Share capability, you can select the Data Share configuration in the Data Config bundle. See Configure the Connection to Oracle Cloud Infrastructure Object Storage (Preview).

• Semantic Model Bundle includes all custom components of the semantic model, such as:
  • External applications
  • System extensions
  • User extensions
  • Security configurations

  Notes:

  • Depending on the semantic model extensions framework that you use, bundle includes main sandbox or branch, and custom sandbox or branch along with the custom components. For the branch framework, you can select the tag and version to bundle and deploy.
  • Deployment merges the extensions and not replace them Existing extensions in the target environment remain if they aren’t overwritten by the bundle.
• Security Bundle includes:
  • Group to application role assignments
  • Custom application roles
  • Custom data security
• Content Bundle includes snapshots of Oracle Analytics Cloud content, such as:
  • Folders (excluding datasets)
  • Projects
  • Workbooks
  • Key metrics
  • Connections
  • Analyses
  • Duty roles for content
  • Report parameters
  • Custom data configurations (for example, configurable account analysis)

  Notes:

  • Content bundle always merges the catalog content from source to target.
  • If conflicts occur while merging, the system replaces conflicting items.
  • Deleted content. aren't tracked.
• Composite Bundle includes any combination of the other bundle types.

  Notes:

  • When you generate a composite bundle, the system generates the composite bundle and its included bundles together.
  • When you import a composite bundle, the system imports both the composite bundle and the individual bundles.
  • You can deploy the composite bundle as a whole or deploy the individual bundles as needed. For example, you can deploy the complete composite bundle in one environment and the individual bundles in different environments.
• Environment Bundle includes:
  • Everything in the semantic model, security, and Content bundles.
  • Additional essential elements not covered elsewhere.

  Before deploying an Environment bundle, you must deploy a Data Config bundle or activate data pipelines in the target environment.

• Application Bundle includes:
  • Content bundle
  • (Optional) Data Augmentation Scripts custom data configuration
  • Semantic model extensions
  • Security bundle

  Applications bundle includes applications created with the Pipeline Builder and other pipeline applications created on the Custom Data Configurations page. Using the Applications bundle, you can create a composite bundle including the Pipeline Builder, external semantic model, prebuilt content, and security (JAZN).

Prerequisites for Bundle Deployment

Before working with semantic models or content:

• Activate the functional areas and ensure data is available.
• In the target environment, to ensure that configurations and activation are at the same level as the source environment, either:
  • Manually configure and activate your data pipelines
  • Deploy a Data Config bundle

Only then should you deploy Environment bundle, Semantic Model bundle, or Composite bundle, because these depend on data being available.

Recommended Practices

• Include the applicable security-related information in the Semantic Model and Content bundles.
• Reassign groups to users after deployment because the Security bundle doesn’t overwrite the user-group mappings.
• When exporting a Semantic Model bundle from test to production, include security configuration.
• 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 semantic model extension steps to ensure tags work correctly when migrating with a Semantic Model bundle.