Export and Import Project Data

To perform a backup, a project owner can export the project’s data to an OCI Object Storage bucket or OCI Object Storage Classic container in any data center. Then later, the exported project data can be imported into the same project (or a different one) in the same data center (or a different one).

To export or import data, you'll need to set up a connection to OCI Object Storage or OCI Object Storage Classic:

If your organization uses VB Studio with OCI, you'll need to contact your OCI administrator to get the required input values to set up the connection to the OCI Object Storage bucket.
You can select the Remember check box before you connect to Object storage bucket to direct VB Studio to remember the input and export data you entered. See step 14 in Export Project Data to an OCI Object Storage Bucket or step 14 in Import Project Data from an OCI Object Storage Bucket.
If your organization uses VB Studio with OCI Classic, you'll need to contact the identity domain administrator or the OCI Object Storage Classic administrator to get the required input values to set up the connection to the OCI Object Storage Classic container.

The values you need are explained in the import and export sections for OCI Object Storage buckets and OCI Object Storage Classic container in the sections that follow.

What Project Data Does VB Studio Automatically Export?

Before exporting your project's data, you should be aware that VB Studio doesn't export all the artifacts automatically. You'll still have to manually export any artifacts and data that weren't exported automatically.

Here's a list of the artifacts that are exported by VB Studio and the ones you'll have to export manually:

Artifact	Exported?	Notes
Project users	No	When you export a project's data, its users are not exported. However, all the data associated with the usernames (issue ownership and reviewers of a merge request, for example) will be preserved. After you import the project's data to another project, all the data associated with the username will automatically be restored after you add a user with the same username to the project.
User's favorite settings or personal preferences	No
Hosted Git repositories	Yes
Mirrored public external Git repositories	Yes
Mirrored private external Git repositories	No	Password-protected external Git repositories aren't exported. After you import the project's data to another project, you must add each external private Git repository.
Branch restrictions	Yes
Merge Requests	Yes
Default reviewers of a branch	Yes	After you import the project's data to another project, default reviewers will be automatically added after you add the same users to the target project.
Workspaces	No	Repositories that are associated with your user's workspaces will be exported, but the workspaces themselves will not be.
Maven artifacts	No
Linked Docker registries	No
Build jobs	Yes	All builds of jobs are exported, along with their logs and artifacts. If a job retains an excessive number of builds, it will adversely affect the export process and will require a large amount of storage space in your bucket or container. Configure a job to retain a reasonable number of builds before you export the project.
Build job's history and artifacts	Yes
Name of the build job's build executor template	No
Pipelines	Yes
Releases	Yes
Deployment configurations	No
Environments	No
Issues	Yes
Agile boards	Yes
Wiki pages	Yes
Snippets	Yes
Project template definition	No
Announcements	No
Webhooks	No
RSS/ATOM feeds	No
Link rules	No
Project tags	Yes
Issue products and components	Yes
Default owners of issue components	Yes	After you import your project's data to another project, owners will be automatically activated after the same users are added to the target project.
Issue custom fields	Yes
Named passwords/private keys	Yes	Note: The passwords are securely exported and imported as keystore binary data.

Export to and Import from an OCI Object Storage Bucket

If you're a project owner in an organization that runs VB Studio on OCI, you'll export project data to and import exported project data from an OCI Object Storage bucket.

Exported project data isn't encrypted and can be downloaded from the bucket. Your OCI administrator will already have set up an OCI Object Storage bucket for the project and users who can read from or write to it. It may be a common bucket that's used for all the organization's projects, but more likely it's separate buckets for each project, which allows archive files to be organized without being grouped with archive files from other projects.

Export Project Data to an OCI Object Storage Bucket

You must be a Project Owner to export project data. When you export project data, VB Studio will export data to an archive file in the specified OCI Object Storage bucket.

To export project data to an OCI Object Storage bucket, you need the following:

Name of the target bucket
Private key and fingerprint of a user who can write objects to the bucket
Details of the compartment that hosts the bucket

Contact your OCI administrator for the details and get the required input values, which are explained in Get OCI input Values in Administering Oracle Visual Builder.

Here's how to export your project's data:

Open the VB Studio project.
In the left navigator, click Project Administration .
Click Data Export/Import.
Click the Job tab.
In Account Type, select OCI.
In Tenancy OCID, enter the tenancy's OCID copied from the Tenancy Details page.
In User OCID, enter the user's OCID value who can access the bucket.
In Home Region, select the home region of the OCI account.
In Private Key, enter the private key of the user who can access the bucket.
In Passphrase, enter the passphrase used to encrypt the private key. If no passphrase was used, leave the field empty.
In Fingerprint, enter the fingerprint value of the private-public key pair.
In Compartment OCID, enter the compartment's OCID copied from the Compartments page.
In Storage Namespace, enter the storage namespace copied from the Tenancy Details page.
Click Connect.

Tip:

Select the Remember check box before you press the Connect button if you want VB Studio to remember the OCI credential input values you entered.

After the export operation starts, the fields in the OCI credentials window that were saved are cleared. The data from those fields has been saved, but it is cleared to protect the administrator's OCI information while the export operation is in progress. After the operation concludes, the saved OCI information will be filled in and visible once again. Credentials are saved only after successfully connecting to the storage. This prevents saving bad credentials.

Credentials are also saved separately for each user. so even if the same storage account is being connected to, each user has a distinct set of credentials that enable access by that user only.

To clear the saved OCI credential information, you need to explicitly uncheck the Remember check box and reconnect. This will clear all the fields.

Only OCI credentials can be saved; OCI Classic credentials cannot be saved.
In the Create Job section, in Type, select Export.
In Name, enter a name for the export job.
In Description, enter the job's description.
In Storage Container, select the bucket to export the project data.
In Storage Object, if required, update the default .zip file name.
Click Export.
In the Confirm Project Export dialog box, select the Export project data check box, and click Yes.
In the Exporting Project page, expand Steps to see the status of each module.

After the export is complete, the Recent Activities feed on the Project Home page (and the History tab of the Data Export/Import page) display messages about the export action.

Import Project Data from an OCI Object Storage Bucket

You must be a Project Owner to import project data. When you import project data, it will overwrite all the project data in the target project. All of the project's artifacts will be replaced with the components from the imported project.

To import project data from an OCI Object Storage bucket, you need the following information:

Name of the target bucket
Name of the archive file with the project data
Private key and fingerprint of a user who can read objects from the bucket
Details of the compartment that hosts the bucket

Contact your OCI administrator for the details and get the required input values, which are explained in Get OCI input Values in Administering Oracle Visual Builder.

Here's how to import data to your target project:

Open the VB Studio project.
In the left navigator, click Project Administration .
Click Data Export/Import.
Click the Job tab.
In Account Type, select OCI.
In Tenancy OCID, enter the tenancy's OCID copied from the Tenancy Details page.
In User OCID, enter the user's OCID value who can access the bucket.
In Home Region, select the home region of the OCI account.
In Private Key, enter the private key of the user who can access the bucket.
In Passphrase, enter the passphrase used to encrypt the private key. If no passphrase was used, leave the field empty.
In Fingerprint, enter the fingerprint value of the private-public key pair.
In Compartment OCID, enter the compartment's OCID copied from the Compartments page.
In Storage Namespace, enter the storage namespace copied from the Tenancy Details page.
Click Connect.

Tip:

Select the Remember check box before you press the Connect button if you want VB Studio to remember the OCI credential input values you entered.

After the import operation starts, the fields in the OCI credentials window that were saved are cleared. The data from those fields has been saved, but it is cleared to protect the administrator's OCI information while the import operation is in progress. After the operation concludes, the saved OCI information will be filled in and visible once again. Credentials are saved only after successfully connecting to the storage. This prevents saving bad credentials.

Credentials are also saved separately for each user. so even if the same storage account is being connected to, each user has a distinct set of credentials that enable access by that user only.

To clear the saved OCI credential information, you need to explicitly uncheck the Remember check box and reconnect. This will clear all the fields.

Only OCI credentials can be saved; OCI Classic credentials cannot be saved.
In the Create Job section, in Type, select Import.
In Name, enter a name for the import job.
In Description, enter the job's description.
In Storage Container, select the bucket to import the project data from.
In Storage Object, select the .zip file name of the exported data.
Click Import.
In the Confirm Project Import dialog box, read and verify the container and object details, select the Import project data check box, and click Yes.
In the Importing Project page, expand Steps to see the status of each module.
If you want to cancel the import process, click Cancel.

When an import job is in progress, the project will be in the locked state. You can’t access other pages of the project until the import job has finished. After the import is complete, you'll be redirected to the Project Home page. The Recent Activities feed on the Project Home page (and the History tab in the Data Export/Import page) display messages about the import action.

Export to and Import from an OCI Object Storage Container

If you're a project owner in an organization that runs VB Studio on OCI Classic, you'll export project data to and import project data from an OCI Object Storage Classic container.

The exported data isn't encrypted and can be downloaded from the container. If you're exporting the project's data for the first time, set up an OCI Object Storage Classic container for the project and users who can read from or write to it. You can use a common container for all projects of the organization, but it's recommended that you use a separate container for each project. This allows you to organize archive files better as they aren't mixed with the archive files of other projects. Contact the identity domain administrator or the OCI Object Storage Classic administrator to create the container. You should also ask the administrator to set up users with read-write access to the container.

Export Project Data to an OCI Object Storage Classic Container

You must be the Project Owner to export project data. VB Studio will export your project's data to an archive file in the OCI Object Storage Classic container you specify.

To export project data to an OCI Object Storage Classic container, you'll need the following:

Name of the target container
Credentials of a user with the Storage.Storage_Administrator or the Storage_ReadWriteGroup identity domain role.
Service ID and the authorization URL of OCI Object Storage Classic

Contact the identity domain administrator or the OCI Object Storage Classic administrator for the details and get the required input values that are explained in Get OCI Classic Input Values in Administering Visual Builder Studio.

Here's how to export your project's data to an OCI Object Storage Classic container:

Open the VB Studio project.
In the left navigator, click Project Administration .
Click Data Export/Import.
Click the Job tab.
In Account Type, select OCI Classic.
In Service ID, enter the value copied from the last part of the REST Endpoint URL field of the Service Details page.
For example, if the REST Endpoint URL is https://demo12345678.storage.oraclecloud.com/v1/Storage-demo12345678, enter Storage-demo12345678.
In Username and Password, enter the user credentials that were assigned to the Storage.Storage_Administrator or Storage_ReadWriteGroup identity domain role.
In Authorization URL, enter the URL copied from the Auth V1 Endpoint field on the Service Details page.
Example: http://storagetria01234-usoracletria12345.storage.oraclecloud.com/auth/v1.0.
Click Connect.
In the Create Job section, in Type, select Export.
In Name, enter a name for the export job.
In Description, enter the job's description.
In Storage Container, select the container to export the project data.
In Storage Object, if required, update the default .zip file name.
Click Export.
In the Confirm Project Export dialog box, select the Export project data check box, and click Yes.
In the Exporting Project page, expand Steps to see the status of each module.

After the export has been completed, the Recent Activities feed on the Project Home page and the History tab of the Data Export/Import page will display messages about the export action.

Import Project Data to an OCI Object Storage Classic Container

When you import data, all existing project data will be overwritten by the imported data. All project artifacts will be replaced with the components from the imported project.

To import project data from an OCI Object Storage Classic container, you need the following information:

Name of the target container
Name of the archive file with the project data
Credentials of a user with the Storage.Storage_Administrator, Storage_ReadWriteGroup, or Storage_ReadOnlyGroup identity domain role
Service ID and the authorization URL of OCI Object Storage Classic

Contact the identity domain administrator or the OCI Object Storage Classic administrator for these details and get the required input values that are explained in Get OCI Classic Input Values in Administering Visual Builder Studio.

Here's how to import project data that was previously exported to an OCI Object Storage Classic container to your target project:

Open the VB Studio project.
In the left navigator, click, click Project Administration .
Click Data Export/Import.
Click the Job tab.
In Account Type, select OCI Classic.
In Service ID, enter the value copied from the last part of the REST Endpoint URL field of the Service Details page.

For example, if the value of REST Endpoint URL is https://demo12345678.storage.oraclecloud.com/v1/Storage-demo12345678, then enter Storage-demo12345678.
In Username and Password, enter the credentials of the user assigned the Storage.Storage_Administrator, Storage_ReadWriteGroup, or Storage_ReadOnlyGroup identity domain role.
In Authorization URL, enter the URL copied from the Auth V1 Endpoint field of the Service Details page.

Example: http://storagetria01234-usoracletria12345.storage.oraclecloud.com/auth/v1.0.
Click Connect.
In the Create Job section, in Type, select Import.
In Name, enter a name for the import job.
In Description, enter the job's description.
In Storage Container, select the container to import the project data from.
In Storage Object, select the .zip file name of the exported data.
Click Import.
In the Confirm Project Import dialog box, read and verify the container and object details, select the Import project data check box, and click Yes.
In the Importing Project page, expand Steps to see the status of each module.

If you want to cancel the import process, click Cancel.

When an import job is in progress, the project will be locked. You can’t access other pages of the project until the import job has finished. After the import is complete, you'll be redirected to the Project Home page. The Recent Activities feed in the Project Home page and the History tab in the Data Export/Import page will display messages about the import action.

View Export and Import History of the Project

You can examine a project's export and import history from the Data Export/Import page's History tab:

In the left navigator, click Project Administration .
Click Data Export/Import.
Click the History tab.

The history of all export and import jobs is displayed. Select a job to view its details. In the case of a failed job, expand Steps to view the modules that passed and those which failed.