Oracle Cloud Infrastructure Documentation

Bundle Your Application Artifacts

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, activation metadata, data augmentations, and custom data configurations. You can install this bundle in an existing environment after a hard data reset. This is useful to leave content as-is and reset the 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 main branch, tags, custom branch, and all the security customizations. Use this bundle to import the semantic model extensions because it allows you to select which tag and version to publish and what to publish.
  • Security bundle: This includes custom application roles and custom data security.
  • Content bundle: This includes snapshots of Oracle Analytics Cloud folders, projects, dataset definitions,workbooks, duty roles for content, and report parameters. 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.
  • Environment bundle: Environment bundle publishes the original semantic model without the customizations. This includes all artifacts of a specific environment to revert to a known state of system. For example, at the end of every week, the service administrator can create a bundle called DevEnv_YYMMDD to maintain a backup of the environment. You must first deploy the data configuration bundle or manually activate your data pipelines before deploying the environment bundle.
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 Content 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 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
Oracle Analytics Cloud content    
Key metrics, Workbooks, Connections, Analyses Content and Environment  
Data flows, Functions, Machine Learning apps Environment  
Key metrics No – create service request  
Datasets No – move manually  
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 Data configurations
Data pipeline Frequent refresh modules, tables, prioritized refresh No – create manually in target environment
Data pipeline Warehouse full reload schedules No – create manually in target environment
Data pipeline Custom data configurations – DFFs, custom applications such as Configurable Account Analysis No – create manually in target environment
Connections Data Augmentation Connectors No – create manually in target environment
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 Fusion Data Intelligence Console, click Bundles under Application Administration.
  3. On the Bundles page, click Create.
  4. In Create Bundles, select the type of bundle that you want to create. For example, Content Bundle.
  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 fawag_content_bundle.png follows
      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.

      Key Metrics on the Content Bundle page

      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, and custom data configurations using the corresponding toggles and buttons.
      Description of fawag_data_config_bundle.png follows
      Description of the illustration fawag_data_config_bundle.png

    • For a semantic extensions bundle, select the Include all semantic extensions check box, or select the applicable branch or tag in the Publish a branch or tag in the target environment field, or select applicable tags and branches using the corresponding toggles and buttons. You can select the Include External RPD or Publish External RPD check boxes to include or publish the external semantic model.
      Description of fawag_semantic_extensions_bundle.png follows
      Description of the illustration fawag_semantic_extensions_bundle.png

      If you've migrated to the latest wizards for extending the semantic model, then select the applicable external application and select the Semantic Extensions check box to include all the extensions.
      Semantic Extensions Bundle page if you've migrated to the latest semantic model extensions wizards

    • For a security bundle, select the Include all security settings check box or select all the application roles. 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.
      Note

      If you've uptaken the enhanced security capability of Oracle Fusion Data Intelligence, then you no longer can specifically select groups as part of the Security bundle. See About Managing Users, Groups, Application Roles, and Data Access.

      Description of fawag_security_bundle.png follows
      Description of the illustration fawag_security_bundle.png

    • For an environment bundle, provide a name.
      Description of fawag_environment_bundle.png follows
      Description of the illustration fawag_environment_bundle.png

    • For a composite bundle, select any of the other bundles.
      Description of fawag_composite_bundle.png follows
      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 Fusion Data Intelligence 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.
  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 Fusion Data Intelligence 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.
You see the bundle with Generated status on the Bundles page.

Export a Bundle

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

Tutorial icon LiveLabs Sprint

  1. Sign in to your service.
  2. In Oracle Fusion Data Intelligence 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.

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 Fusion Data Intelligence Console, click Bundles under Application Administration.
  3. On the Bundles page, click Import.
  4. In the Import Bundle dialog, click in Drag and Drop, and then select the applicable .aab file from your local machine.
  5. Click Import.

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.
  1. Sign in to your service.
  2. In Oracle Fusion Data Intelligence 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 Deploy.
  5. In the Deploy Bundle dialog, ensure that you see the bundle that you have selected.
  6. Click Deploy.

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 Fusion Data Intelligence 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.

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 Fusion Data Intelligence Console, click Bundles under Application Administration.
  3. On the Bundles page, click the Activity tab.

    Activity tab on the Bundles page