4 Set Up VB Studio to Extend Oracle Cloud Applications

This chapter tells you how to set up Oracle Visual Builder Studio (VB Studio) so that your users can work with Oracle Cloud Applications in an extension.

An extension is what your team members use to deliver new capabilities into Oracle Cloud Applications. In most cases, an extension contains the work a user has done to customize an app to meet specific business needs. See What Is an Extension? for more information about extensions.

Note:

Only one VB Studio instance can be provisioned in an Oracle Cloud account. By default, a VB Studio instance is provisioned with your first Oracle Cloud Applications TEST instance that your organization's members can use to develop application extensions. If you wish to use VB Studio with a different Oracle Cloud Applications TEST or DEV instance, file a service request so that we can terminate the VB Studio instance associated with your current *-TEST or *-DEV instance, create a new one, and associate this new one to your preferred instance. (Provisioning VB Studio for PROD instances is not supported.)

This documentation assumes that you have created and set up Oracle Cloud Applications instances for development and production environments in different identity domains.

Note:

You can also use the VB Studio instance that was provisioned alongside your Oracle Cloud Applications account to create visual applications, but you'll need to follow the procedures for deploying a visual application to a Visual Builder instance in a different identity domain as described in Create and Set Up a Project for Development (Different Identity Domain).

Here's a summary of steps to do before you set up VB Studio for developing an extension:

To perform this action: See this: Why do I need to perform this action?
1. Get the required roles assigned to you Get the Required Roles To create and set up the VB Studio instance, you must be assigned some specific Oracle Cloud Applications roles.
2. Get access to Oracle Cloud Applications instances Get Access to Oracle Cloud Applications Instances To deploy your extension to Oracle Cloud Applications development and production instances, you'll need the credentials of users who can access them.
3. Review ORA_CORS_ORIGINS settings and add the VB Studio instance’s root URL if needed. Add VB Studio's Root URL to the ORA_CORS_ORIGINS Profile Option To ensure that VB Studio can properly render application pages in the Designer, you must set this option.
4. Grant Oracle Cloud Applications users access to VB Studio Set Up VB Studio Users Some Oracle Cloud Applications roles are configured to automatically assign VB Studio IDCS roles to the users. To allow access to VB Studio, assign any one of those roles to your Oracle Cloud Applications users.
5. If your Oracle Cloud Applications instances are behind a corporate network/VCN, whitelist the VB Studio IP addresses from the location closest to you. VB Studio Public IP Addresses This allows Oracle Cloud Applications behind a corporate network to access to the VB Studio servers.

Follow these steps to set up VB Studio before you create a project:

To perform this action: See this: Why do I need to perform this action?
1. Access VB Studio from an Oracle Cloud Applications instance Access VB Studio from Oracle Cloud Applications To set up VB Studio, open VB Studio's Organization page.
2. (Optional) Configure VB Studio to run build jobs and pipelines Configure VB Studio to Run CI/CD Pipelines To run build jobs and pipelines, you must configure VB Studio to connect to an OCI account or the built-in free account.

Follow these steps to create and set up a VB Studio project for developing your extension. You should create one project for each of the Oracle Cloud Applications you plan to work on: one for Digital Sales, another for Human Capital Management, and so on.

To perform this action: See this: Why do I need to perform this action?
1. Create a project for extensions Create a Project for Extensions To allow your users to extend an Oracle Cloud Application, you must create a VB Studio project based on the Application Extension template.
2. Set up the project for development Set Up the Project for Development When you create a project based on the Application Extension template, some artifacts are created by default. These artifacts require additional configuration before your team members can use them.
a) Configure the deployment job Configure the Deployment Job When you create a project based on the Application Extension template, the deployment job is missing the credentials to connect to the target development instance, so you must specify them manually.
b) Run the development build pipeline Run the Pipeline Manually Test the default package and build jobs to make sure they generate a build artifact and deploy it to the Oracle Cloud Application's development instance.
c) View the deployed extension View the Deployed Extension After you've deployed the extension, you can view details about the deployment on the Environments page.
3. Add Oracle Cloud Applications users to the project Add Users to the Project Invite your team members to use this project by adding them as users.
4. Optional configuration Advanced Settings After you've set up the project, if required, you can make some optional advanced configuration to it.

After setting up the project, you may also want to follow these steps to set up the project to deploy your extension to the production instance:

To perform this action: See this: Why do I need to perform this action?
1. Add the Oracle Cloud Application's production instance to an environment Add the Oracle Cloud Application's Production Instance to an Environment Create an environment, then add the Oracle Cloud Application's production instance to it.
2. Create the production branch Create a Production Branch Create a production branch from the main branch and use it to host extension's code files that are ready for production.
3. Create the packaging and deployment build jobs, and set up build pipelines Create and Configure Production Build Jobs and Set Up Production Build Pipelines Next, create and configure the packaging and deployment jobs to promote your extensions to your Oracle Cloud Application's production instance.
4. Run the pipelines Run Production Pipelines Run the production pipelines and jobs that deploy the extension to the production instance.

Before You Begin

Before you set up VB Studio, you may want to review VB Studio key concepts in Key Concepts, Components, and Terms. You should also learn about the built-in free account, its free VM build executor, and get access to Oracle Cloud Applications instances.

Get Access to Oracle Cloud Applications Instances

A VB Studio instance is provisioned with your Oracle Cloud Applications instance. Your organization's members use this instance, also called the development instance, to develop extensions.

To deploy your extension to another instance, such as your production instance, you'll need the credentials of a user who can access the instance and deploy to it. If you don't have them, contact the Oracle Cloud Applications administrator and get the user's credentials.

You should also make sure that each Oracle Cloud Applications instance is properly configured and running. If an instance isn't available or not configured, then follow the Oracle Cloud Applications documentation to create and configure it.

Here are some best practices to follow while setting up VB Studio to develop extensions:

  • Follow your organization's guidelines to create and set up Oracle Cloud Applications instances. Your guidelines may suggest that you create instances for different software development environments, such as development, integration, test, pre-stage, stage, pre-production, and production. You can create these instances in different identity domains or in a common identity domain.

    This documentation assumes that you have created and set up Oracle Cloud Applications instances for development and production environments, where each instance is in a different identity domain.

  • Before you create a project, make sure that your Oracle Cloud Application's development and production instances are up and running.
  • Create one project for each of Oracle Cloud Applications you want to configure, taking care to use the Application Extension project template.

Get the Required Roles

To set up VB Studio and your Oracle Cloud Applications instances and deploy an extension to an Oracle Cloud Application environment, make sure you're assigned the FND_ADMINISTER_SANDBOX_PRIV privilege or any of these roles in your development and production instances:
  • APPLICATION ADMINISTRATOR
  • APPLICATION DEVELOPER
  • SALES_ADMINISTRATOR
  • CUSTOMER RELATIONSHIP MANAGEMENT APPLICATION ADMINISTRATOR

Add VB Studio's Root URL to the ORA_CORS_ORIGINS Profile Option

To enable Cross-Origin Resource Sharing (CORS) and set which services are allowed access, the Oracle Cloud Applications administrator needs to add the VB Studio's root URL to the Oracle Cloud Application instance's ORA_CORS_ORIGINS profile option. This option is used to specify which domains can talk to each other.

Note:

Production to Test (P2T) and other operations that replace the database can cause the profile option value to change. You must repeat these steps if you perform any operation that replaces the database.

The Oracle Cloud Applications administrator needs to perform these steps:

  1. Open VB Studio from your Oracle Cloud Applications instance and copy the VB Studio URL from the browser's address bar.
  2. In your Oracle Cloud Applications instance, click Navigator the Menu icon .
  3. Under Others, click Setup and Maintenance.
  4. On the right side of the page, click Tasks Tasks icon and then click Search.
  5. In the search box, enter Manage Administrator Profile Values and click the Search icon.
  6. In the search result, click Manage Administrator Profile Values.
  7. In Profile Option Code, enter ORA_CORS_ORIGINS and then click Search.
  8. Under ORA_CORS_ORIGINS: Profile Values, if you see a value with Profile Value set to *, you can ignore the remaining steps. Your Oracle Cloud Applications instance is set to allow all origins.
    If you don't see the * value or if you want to restrict allowed origins from all origins to certain origins, such as your VB Studio instance, proceed to the next step.
  9. Under ORA_CORS_ORIGINS: Profile Values, click New.
  10. In Profile Level, select Site.
  11. In Profile Value, enter the value 'self' (including the single quotes), followed by the VB Studio's root URL.

    For example, 'self' https://abcd-test-DEVCSAPP-07012210-2070-abcd.developer.ocp.oraclecloud.com.

    Note:

    Don't include port numbers, wild cards, or extraneous characters after the root. For example, if the VB Studio’s full URL is https://abcd-test-DEVCSAPP-07012210-2070-abcd.developer.ocp.oraclecloud.com:443/abcd-test-devcsapp-07012210-2070-abcd, the root is simply https://abcd-test-DEVCSAPP-07012210-2070-abcd.developer.ocp.oraclecloud.com.

    Here's an example:



  12. Click Save and Close.

Set Up VB Studio Users

To access VB Studio, a user must be assigned a VB Studio IDCS role. In your Oracle Cloud Applications development instance, some Oracle Cloud Applications roles are pre-configured to grant VB Studio IDCS roles to users.

Assign any of these Oracle Cloud Applications roles to your users to allow them access to VB Studio:

This Oracle Cloud Applications role: Grants this VB Studio IDCS role:

Application Administrator (ORA_FND_APPLICATION_ADMINISTRATOR_JOB)

Sales Administrator (ORA_ZBS_SALES_ADMINISTRATOR_JOB)

Customer Relationship Management Application Administrator (ORA_ZCA_CUSTOMER_RELATIONSHIP_MANAGEMENT_APPLICATION_ADMINISTRATOR_JOB)

Synchronization Enabled Administrator Identity (ORA_SYNC_ENABLED_ADMINISTRATOR_ABSTRACT)

VB Studio administrator (DEVELOPER_ADMINISTRATOR)

Application Developer (ORA_FND_APPLICATION_DEVELOPER_JOB)

Synchronization Enabled Developer Identity (ORA_SYNC_ENABLED_DEVELOPER_ABSTRACT)

VB Studio user (DEVELOPER_USER)

Note:

The ORA_SYNC_ENABLED_ADMINISTRATOR_ABSTRACT and ORA_SYNC_ENABLED_DEVELOPER_ABSTRACT roles grant access to VB Studio, but do not offer any additional privileges for Fusion Applications.

When you assign any of the above Oracle Cloud Applications roles to a user, Oracle Cloud Applications synchronizes the user with IDCS. For each Oracle Cloud Applications role, IDCS creates a group representing users assigned to that role. For example, the Application Administrator IDCS group represents users assigned to the Oracle Cloud Applications Application Administrator role. After the sync is complete, the user can access VB Studio. Note that sometimes it may take up to 12 hours for Oracle Cloud Applications user updates to sync with IDCS.

When you add an Oracle Cloud Applications user, assign the FND_ADMINISTER_SANDBOX_PRIV privilege, or any of the Oracle Cloud Applications roles that grant VB Studio access.

Here's an example of a new user assigned the Application Administrator role:

It may take a few hours until the new user can access VB Studio. If it seems to be taking too long, verify the newly added user in IDCS. Using the Identity domain administrator's credentials, sign-in to the IDCS console, click Navigation Drawer the Menu icon and select Groups. To see the group's users, click the Users tab.

Here's an example of the Application Administrator group in IDCS:

Access VB Studio from Oracle Cloud Applications

  1. In your Oracle Cloud Applications instance, click Navigator the Menu icon .
  2. In the navigation menu, under Configuration, select Visual Builder.

The VB Studio Organization page opens, which displays all the projects you're a member of, as well as your favorite projects, the projects you own, and all the shared projects in your organization.

Configure VB Studio to Run CI/CD Pipelines

In VB Studio, you use continuous integration and continuous delivery (CI/CD) build jobs and pipelines to compile the source code, package the extension, and deploy it to an Oracle Cloud Applications instance. The builds and pipelines run on build executors, also called VM build executors. These VM executors are Oracle Cloud Infrastructure (OCI) VM compute instances dedicated to run VB Studio builds. To use VM executors, VB Studio must be connected either to the built-in free account or to an OCI account.

In some Oracle Cloud regions and data centers, VB Studio is available pre-configured with a built-in free account, which provides one free VM executor that you can use to run build jobs that package and deploy your extensions. However, there some limitations (see VB Studio's Free VM Build Executor) associated with the free VM build executor, so you may want to connect to your own OCI account instead, if you have one. See OCI Resources in VB Studio for more a more comprehensive comparison between the built-in free account, free tier account, and your OCI account.

To find out whether the built-in free account is available in your VB Studio instance:

  1. In the navigation menu, click Organization Organization.
  2. Click the OCI Account tab.

You should see a similar page:

Depending on your VB Studio's data center, you may or may not see the Built-in (Free) option.

What do you see? What you need to do:
I see the Built-in (Free) option If you're trying out extensions, no additional configuration is required. Go ahead and create your extension project. VB Studio creates the free VM build executor when you create your first project.
I see the Built-in (Free) option, but want to run builds without any limitations Configure VB Studio to connect to your OCI account and add VM executors.

If you're new to OCI, see Welcome to Oracle Cloud Infrastructure.

I don't see the Built-in (Free) option, but have access to an OCI account The built-in free account isn't available in your data center. You should configure VB Studio to connect to your OCI account and add VM executors.
I don't see the Built-in (Free) option and don't have access to an OCI account either You can still use VB Studio to create the extension project.

To run builds, create an OCI account or the Oracle Cloud Free Tier account. The free tier account offers free micro Compute VMs that your organization's members can use to run builds. After creating the free tier account, create OCI resources as described in Set Up the OCI Account and get their details as described in Get the Required OCI Input Values. Then, set up the OCI connection in VB Studio.

If you can't create an OCI account or the free tier account, wait for the built-in free account to be available in your data center.

Before you create a project, note that in a VB Studio instance that has no projects and no VM executors, the first VM executor is created for you when you create the first project. If the project isn’t the initial one, the VM executor must be created manually.

Add the Free VM Build Executor Manually

If you're using VB Studio's built-in free account, the free VM build executor is added when you create your first project. If you've deleted the VM executor or if you need to create one manually, add the VM executor.

  1. In the navigation menu, click Organization Organization.
  2. Click the VM Build Executors tab.
    If you see a VM executor of the System Default OL7 for Visual Builder template, the free VM build executor is available in your VB Studio instance. Ignore the remaining steps.

    If you don't see the VM executor, jump to the next step.

  3. Click Create Free VM Build Executor.

Create a Project for Extensions

A VB Studio project gathers all the resources you need for developing software. To ensure an optimal environment for your team members creating extensions, be sure to base your project on the Application Extension project template. Ideally, you'll create one project for each Oracle Cloud Application you plan to customize, such as Digital Sales, Human Capital Management, and so on.

  1. On the Organization page, click + Create.
  2. On the Project Details page of the New Project wizard, in Name and Description, enter a unique name and description for the project.
  3. In Security, select the project's privacy setting.
    A private project is accessible to invited users only. Users who aren't invited can't access it or make changes to it. You can invite users after creating the project.

    A shared project is accessible to all users of the organization. Any user can view the source code, create or update issues, edit wiki pages, and interact with project builds. However, only invited users can make updates to the source code in Git repositories, create and run build jobs, and perform deployment operations.

  4. In Preferred Language, specify the language for the email notifications your project users will receive.
    You can change the language in which the user interface appears in your user preferences.
  5. Click Next.
  6. On the Template page, select the Application Extension template, then click Next.
    If you don’t see the Application Extension template, that means you’re in an OCI region that doesn’t yet support it. Use the steps in this workaround to create your project instead of the steps shown here.

    When you create a project, VB Studio also creates a workspace and an extension for you. Use these to create your own extension, if you like, or let one of your team members use it.

  7. On the Project Properties page:
    1. In Extension Name, if necessary, change the extension's name. Make sure that the extension name is unique across all the extensions created for this Oracle Cloud Application. By default, the name is <project_name> Extension.
    2. In Extension Id, if necessary, change the extension's ID. Make sure that the ID is unique across all the extensions created for this Oracle Cloud Application. By default, the ID is site_<extension_name>.
    3. In Workspace Name, if required, change your private workspace's name. By default, it is Workspace1.

      A workspace contains all the artifacts that you need to develop extensions, including a clone of this project's Git repository–and the branch–containing the source files. To learn more about workspaces, see What Is a Workspace? Again, you don't have to use this workspace to develop an extension; it's created purely for your convenience. (When a team member accesses VB Studio from their Oracle Cloud Application, a workspace is automatically created for the user if one doesn't already exist.)

    4. In Oracle Cloud Applications Development Instance, VB Studio preselects your current identity domain's Oracle Cloud Applications instance and uses it as the development instance to develop extensions.
      If there are multiple Oracle Cloud Applications instances in your identity domain, you'll be asked to choose. Make sure to select the Oracle Cloud Applications instance you want to use to develop extensions. Make sure that the selected instance has a VB Studio instance provisioned and also has the Oracle Cloud Application you want to extend.
    5. From Base Application, select the Oracle Cloud Application you want to extend in this project.
    6. In Git Repository Name, change the Git repository's default name, if required. When a team member creates a workspace, a copy of this repository is made for the user's local changes. When the user executes the Git Push command, the changes are copied to the project's repository (also known as the "remote repository", in VB Studio terms).
    7. In Working Branch Name, if required, change the workspace's working branch name. By default, it is branch1.
      Follow your organization's guidelines for creating and managing Git repository's branches. When the project is provisioned, the Git repository's main branch is ready for you to start working on an extension, should you opt to do so. Whenever someone creates a workspace, VB Studio creates a copy of the main branch, renames it with the specified name, and uses it as the workspace's working branch. This documentation assumes that you'll continue to use main as the development branch and create a separate branch for production.
  8. Click Finish.
After the project is provisioned, the Project Home page opens where you can see a summary of the project's provisioning activities; default environment; and Git, Maven, and NPM repositories. Review the activity feed and the Environments box for any errors.

When you create a project using the Application Extension template, these artifacts are automatically created for you:

  • A Git repository, which will contain the source code for all the extensions based on this project.

    To see the Git repository's files, go to the Project Home page, click the Repositories tab, then click the Git repository name:

  • A Development environment pointing to the development instance where the Oracle Cloud Application you plan to customize is running.

    In the navigation menu, click Environments Environments to see the Development environment:

  • Build jobs that package and deploy the extension's artifact to Oracle Cloud Application's development instance.

    The Application-Extension-Package and Application-Extension-Deploy jobs are created for you. The package job generates the extension's artifact file. The deploy job deploys the extension's artifact file to Oracle Cloud Application's development instance.

    In the navigation menu, click Builds Builds and then click the Jobs tab to see the build jobs:

    To run builds of the package and deploy jobs, you must first allocate VM build executors and make the appropriate deployment configurations. See Set Up the Project for Development. Without the appropriate configuration or VM executors, the builds won't run.

  • Application Extension - Package and Deploy pipeline to run the package and deploy build jobs in a sequence.

    In the navigation menu, click Builds Builds and then click the Pipelines tab to see the pipeline:

  • A private workspace for you to create your own extension, should you opt to do so.

    In the navigation menu, click Workspaces Designer to see the workspace:

  • By default, the project uses the organization's default markup language. Your project's users use the markup language to format wiki pages and comments. If needed, you can change the project's markup language from the Project Administration page. See Change a Project’s Wiki Markup Language.
  • A VM executor is created, but only if this is the first project in this VB Studio's instance and this instance did not already have any VM executors. The VM executor uses the System Default OL7 for Visual Builder executor template. You can use this VM executor to run build jobs that reference the System Default OL7 for Visual Builder template in the current project and other projects as well.

    In the navigation menu, click Organization Organization and then click the VM Build Executors tab to see the VM executor.

Set Up the Project for Development

Before your team members can use the project for developing extensions, you need to make a few configuration settings in the project.

Here's a summary of how to set up the VB Studio project for development:

To perform this action: See this:
1. Configure the deployment job.

By default, the deployment job doesn't have credentials to connect to the target development instance, so you must specify them manually.

Configure the Deployment Job
2. To verify your credentials, run the development pipeline Run the Pipeline Manually
3. View the deployed extension View the Deployed Extension
4. Add other members of your team to the project Add Users to the Project

Configure the Deployment Job

The deployment job deploys the extension's build artifact to your Oracle Cloud Application's development instance. In the job, specify the credentials required to connect and deploy the build artifact to your Oracle Cloud Application's development instance.

  1. In the navigation menu, click Builds Builds.
  2. In the Jobs tab, click the deployment job.
  3. Click Configure.
  4. Click Configure Builds.
  5. Click the Steps tab.
  6. In Username and Password, enter your credentials (or another user's) for connecting and deploying to the Oracle Cloud Application's development instance. The credentials will be used when the package and deploy build pipeline runs.
  7. Click Save.

Run the Pipeline Manually

The development build pipeline runs automatically when a commit is pushed to the Git repository's branch specified in the packaging job.

If you want to run the pipeline manually:
  1. In the navigation menu, click Builds Builds.
  2. Click the Pipelines tab.
  3. In development pipeline's row, click Build Build.

To monitor the pipeline and see each job's status, click the pipeline's name. To see a job's build log, click the job's name and click Build Log Build Log.

If you want to run a job's build manually, open the job's details page and click Build Now. You can monitor its build on the job's details page.

View the Deployed Extension

After the deployment job has successfully run, you can view the deployed extension in the Deployments tab of the Environments page.

  1. In the navigation menu, click Environments Environments.
  2. Select the Oracle Cloud Application's environment.
  3. Click the Deployments tab.
  4. Click the Application Extensions toggle button.


    This screen shows the Deployments tab only for the current project, SampleProject. There are two published extensions in this project, HCM_ProofOfConcept and sampleproject Extension.

    At the bottom of the Deployments tab you can see the Application Extensions Classic deployments, which are for older Oracle Cloud Applications. (If you don’t see “App UIs” in the Designer while extending an Oracle Cloud Application, you know your application is considered “classic”.) For each classic extension, the page displays its ID, name, version, and status, as shown here:



    Note:

    In the packaging build step, if you didn't specify a version to overwrite the extension's version defined in visual-application.json, the Version column appends the build's timestamp to the version number and displays it in the <version_number>.<build_run_timestamp> format.

  5. To open the Oracle Cloud Application with the deployed extension, click the Open button.

Add Users to the Project

After creating the project, add Oracle Cloud Applications users to the project and assign them proper project roles.

Here are some examples of roles you can assign to project users:

  • Assign the Developer Limited role to users who access the code files, can run build jobs (but can't create, configure, or delete them), and deploy extensions.

    If you want to assign the Developer Limited role but restrict access to specific build jobs, you should look into using protected jobs, which is explained in Configure a Job's Privacy Setting.

  • Assign the Contributor role to users who can access the project, but don't update the code files.
  • Assign the Developer role to trusted users who can access code files, build, and deploy extensions.
If you want to: Do this:

Add a user to the project

Before you add a user, make sure that the user is assigned one of the roles described in Set Up VB Studio Users.

  1. In the navigation menu, click Project Home Project Home.
  2. Click the Team tab.
  3. Click + Create Member.
  4. Click the Username drop-down list.
  5. Under Users, select the user.

    If you can't find a particular user, enter the user's name or username in the search box. As you begin typing, users matching the search term are displayed.

  6. From the membership option types, select the user's membership.
  7. Click Add.
Add a group to a project

In VB Studio, you can create groups of organization's users or import existing Oracle Identity Cloud Service (IDCS) groups, and then add these groups to the project.

  1. In the navigation menu, click Project Home Project Home.
  2. Click the Team tab.
  3. Click + Create Member.
  4. Click the Username drop-down list.
  5. Under Groups, select the group.
  6. From the membership option types, select the membership you want to assign to the group's members.
  7. Click Add.

Add multiple users or groups to the project

  1. In the navigation menu, click Project Home Project Home.
  2. Click the Team tab.
  3. Click + Create Member.
  4. Click the Username drop-down list.
  5. From the drop-down list, select a user or a group. Click Username again to select another user or group.

    If you can't find a particular user, enter the user's name or username in the search box. As you begin typing, users matching the search term are displayed.

  6. From the membership option types, select the user's membership.
  7. Click Add.

Change a user’s or a group's project membership

To change a user’s or a group's project membership, click the Change Membership icon Change Membership icon . From the drop-down, select a new project membership (Contributor, Developer, Developer Limited, or Project Owner).

Remove a user or a group from the project

Before removing a user, change the ownership of any assigned issues and merge requests to another user.

For the user or the group you to remove, click Remove the remove icon.

Advanced Settings

After setting up the project, you can follow these optional steps to configure some advanced settings in your project. You can perform these steps at any time during your development cycle.

To perform this action: See this:
Add more VM build executors or build executor templates.

By default, VB Studio is connected to its built-in free account and uses one free VM build executor with fixed software packages in the executor template. If you want to add more VM executors or customize executor template's software packages, configure VB Studio to connect to your OCI account.

Connect to Your OCI Account and Add VM Build Executors
Configure the packaging job to change the extension's version at build time.

By default, the packaging job uses the extension's version defined in the visual-application.json file. If you want to specify another version when a build runs, configure the job.

Specify a Different Version for the Extension
Protect the Git repository's main branch for unapproved code updates.

By default, a branch is accessible to all project users and anyone can make changes to its files. To restrict changes and push commits to the main branch, set restrictions on it to allow branch merges only after they are approved.

Set Merge Restrictions on the main Branch
Connect to Your OCI Account and Add VM Build Executors

You may want to configure VB Studio to connect to your own OCI account if you need more VM build executors to reduce the wait time for your organization's members, you want to create custom build executor templates, or you want to use advanced features for VM executors (such as use your own VCN or use a different VM shape).

  1. Set up your OCI account and get the required input values. If you don't have authorization to create and manage OCI resources, ask some one who can create the resources and share their details.

    See Set Up the OCI Account and Get the Required OCI Input Values.

  2. In the navigation menu, click Organization Organization.
  3. Click Connect OCI Account.
  4. Enter the required details and click Validate.
  5. After successful validation, click Save.

To create custom executor templates, see Create and Manage Build Executor Templates. Remember to add Node.js 16 (or a higher version) to the executor template. Node.js 16 is the minimum version required for packaging extensions.

To add more VM executors:

  1. Click the VM Build Executors tab.
  2. Click + Create VM.
  3. In the Add VM Build Executor dialog box, in Quantity, specify the number of VM executors you want to allocate.

    To minimize build execution delays, set the number of VM executors to the number of jobs that you expect to run in parallel using that template. If the OCI VM quota is available, that number of VM executors will be added to the Virtual Machines tab.

    If you're not sure about the number of VM executors you'll need, start with one VM executor and then add more as required. Note that the more VM executors you have running at a specific time, the higher the cost of OCPUs. To minimize the higher cost, use the Sleep Timeout setting on the VM Build Executors tab to automatically shut down inactive VM executors. You can always return to the VM Build Executors tab to remove or add VM executors, based on your actual usage.

  4. In Build Executor Template, select System Default OL7 for Visual Builder or a executor template with Node.js 16 (or higher) software.
  5. In Region, Shape, and VCN Selection specify the VM's region, shape, and Virtual Cloud Network (VCN).
    • A region is a localized geographic area where the data centers are located. Remember, a VM executor is a VM on OCI Compute. Choose the region where your VB Studio account is or the one that's closest to you geographically.
    • A shape is a template that determines the number of CPUs, amount of memory, and other resources allocated to the created instance. Choose a shape of your preference.
    • A VCN is a software-defined network that you set up in the Oracle Cloud Infrastructure data centers in a particular region. By default, builds run in your VB Studio's compartment. To run builds in your own VCN, select Custom and specify its details.

    To learn more about regions and shapes, see Regions and Availability Domains and VM Shapes. To find more about VCNs, see VCNs and Subnets.

  6. Click Add.
Specify a Different Version for the Extension

The packaging job generates the extension's build artifact from the source files in the Git repository's main branch.

The extension's version is defined in the visual-application.json file. If you want the build artifact to use the same version, don't make any changes to the packaging job's default configuration.

If you want to specify another version when a build runs without modifying the visual-application.json file, follow these steps:

  1. In the navigation menu, click Builds Builds.
  2. In the Jobs tab, click the packaging job.
  3. Click Configure.
  4. Click Configure Configure.
  5. Click the Steps tab.
  6. Specify the new version in Extension Version.
    When a build runs, VB Studio overwrites the extension's version defined in the visual-application.json file with the new version.
  7. Click Save.
Set Merge Restrictions on the main Branch

By default, the main branch is accessible to all project users and anyone can make changes to its files. To restrict changes and who can push commits to it, you may want to set restrictions on it and allow branch merges only after they are approved.

  1. In the navigation menu, click Project Administration Project Administration.
  2. Click Branches.
  3. In Repository and Branches, select the Git repository and the main branch.
  4. Select the Requires Review option.
  5. In Default Reviewers, enter and select the users.
    A default reviewer is a project member who is automatically added as a reviewer when a merge request is created on the branch.
  6. From the Approvals drop-down list, select the minimum number of reviewers who must approve the review branch of a merge request, where the selected branch is the target branch
  7. (Optional) To allow a review branch to be merged to the selected branch only if the last build of the linked job in Merge Request is successful, select the Require successful build check box.
    To use this option, link a build job to a merge request.
  8. (Optional) If you want to reset the approval status of reviewers if change is pushed to a branch after they have approved the merge request, select the Reapproval needed when branch is updated check box.
  9. (Optional) To ensure changes pushed to the target branch match the contents of the review branch, select the Changes pushed to target branch must match review content check box.
  10. (Optional) In Merge Request Exempt Users, specify users who can bypass the branch restrictions and merge the review branch of a merge request outside VB Studio or without required approvals.
    This is useful if you want to allow some users to merge the review branch irrespective of review conditions being met.
  11. Click Save.

Develop Your Application

Now that you've set up VB Studio, created an extension project and added Oracle Cloud Applications users to it, guide your organization members who develop extensions to these documents to learn more about VB Studio.

Set Up the Project to Deploy to Other Development and Test Instances

If you've followed this chapter to this point, you've configured VB Studio to deploy extensions to your primary Oracle Cloud Applications Development environment. Before the extension is deployed to the production instance, your team members may want to test the extension on other Oracle Cloud Applications development and test instances as well.

To deploy to other Oracle Cloud Applications instances, you must add each additional instance to an environment. Thereafter, you need to configure jobs and pipelines that package and deploy the extension to these instances. Before you proceed, make sure that the Oracle Cloud Applications instances are up and running.

Here's a workflow summary of how to set up the VB Studio project for deployment:

To perform this action: See this:
1. In the VB Studio project, create an environment for each Oracle Cloud Applications development and test instance.

To deploy your extension, you must add the Oracle Cloud Applications instance to an environment.

Add an Oracle Cloud Application's Instance to an Environment

Repeat the steps described in the above topic for each Oracle Cloud Applications development and test instance you want to deploy to.

2. Create and configure deployment build jobs and pipelines.

You won't create packaging jobs because you'll use the Application-Extension-Package job that was created with the project.

Create and Configure Deployment Build Jobs and Pipelines and Run a Pipeline

Add an Oracle Cloud Application's Instance to an Environment

To deploy an extension to an Oracle Cloud Applications instance, you must create a VB Studio environment and add the the instance to it. You can only add one Oracle Cloud Applications instance to an environment.

The Oracle Cloud Applications development and test instances are in another identity domain. To add an instance of another identity domain to an environment, you'll need its base URL and a user's credentials who can access the instance.

Here's an example of some Oracle Cloud Applications development and test instances added in a project:

After adding an instance to an environment, in the Service Instances tab, click Expand Downward Pointing Arrow to see the Oracle Cloud Applications instance's URL.

If the newly added instance stays in the Unknown status for some time, it typically indicates that the the provisioning may have failed. VB Studio added the Oracle Cloud Applications instance but can't access it. In such a case, click Actions Three horizontal dots and select Remove to remove the Oracle Cloud Applications instance from the environment, and then click Add to add it again.

Add an Oracle Cloud Applications Instance in Another Identity Domain
  1. In the navigation menu, click Environments Environments.
  2. Select an existing environment or create one.
    To create an environment, click + Create Environment. In Environment Name and Description, enter a unique name and description, and click Create.
  3. In the Service Instances tab, click + Add Instance.
  4. In the Add Service Instances dialog box, select the Oracle Cloud Applications option button.
  5. Under Authentication Method, select the Application Credentials option.
  6. In Base URL, enter the Oracle Cloud Application's base URL.
  7. In Instance Name, if required, update the instance's display name. The name will be displayed in the Service Instances tab.
  8. In Username and Password, enter the credentials of a user who can access the Oracle Cloud Applications instance.
  9. Click Add.

Create and Configure Deployment Build Jobs and Pipelines

You need to set up some packaging and deployment jobs before you can deploy extensions to Oracle Cloud Applications instances.

Instead of creating new packaging jobs, use the existing Application-Extension-Package job that was created with the project. This job packages the extension and creates a build artifact from the same branch your team members used to deploy to the primary Oracle Cloud Applications development instance. Remember, the packaging job is configured to trigger a build on every SCM commit.

To deploy the extension to other Oracle Cloud Applications instances, create one deploy job for each instance. You'll also need a user's credentials who can deploy to the Oracle Cloud Applications instance. To create the job, see Create a Deployment Build Job.

After you've created deployment jobs, create pipelines to run the package job and deployment jobs in sequence. You can create either of these pipelines:
  • A pipeline to deploy the extension to the primary and other Oracle Cloud Applications instances.

    Instead of creating a new pipeline, configure the existing Application Extension - Package and Deploy pipeline to deploy to other instances as well. See Configure the Default Pipeline to Deploy to Other Oracle Cloud Applications Instances. Remember, the Application Extension - Package and Deploy pipeline runs automatically when a code change is pushed to the main branch. After you've configured the pipeline, it deploys the extension to all development and test instances on every SCM commit to the main branch.

    After creating this pipeline, you'll have one pipeline in your project that deploys to all development and test instances.

    Here's an example:

    Main pipeline that deploys to other development and test instances
  • A pipeline to deploy the extension to other development and test Oracle Cloud Applications instances manually. See Create and Configure a Pipeline to Deploy to Other Oracle Cloud Applications Instances.

    Create this pipeline if you don't want to deploy the extension to other instances on every SCM commit, but only after your team members have validated the extension on the on the primary development instance.

    After creating this pipeline, you'll have two pipelines in the project: 1) Your primary Application Extension - Package and Deploy pipeline that deploys to the primary development instance and 2) this pipeline that deploys to other development and test instances.

    Here's an example:

    Main and other pipeline
Create a Deployment Build Job

The deployment job deploys the extension's artifact that was generated in the default packaging job to the Oracle Cloud Application's instance. Before you create the job, get the access credentials of a user who can also access the instance.

  1. In the navigation menu, click Builds Builds.
  2. In the Jobs tab, click + Create Job.
  3. In the New Job dialog box, in Name, enter a unique name.
  4. In Description, enter the job's description.
  5. Select the Copy From Existing check box.
  6. From the Copy From drop-down list, select the Application-Extension-Deploy job.
  7. In Template, make sure that the System Default OL7 for Visual Builder template is selected.
  8. Click Create.
  9. Click Configure the Hammer icon.
  10. Click the Steps tab.
  11. In Target Instance, select the environment with the target Oracle Cloud Applications instance.
  12. In Username and Password, enter the credentials of a user who can deploy to the Oracle Cloud Applications instance.
  13. Click Save.
Configure the Default Pipeline to Deploy to Other Oracle Cloud Applications Instances

If you want to deploy to other development and test instances along with the development Oracle Cloud Applications instance, configure the existing Application Extension - Package and Deploy pipeline to deploy to other instances as well.

  1. In the navigation menu, click Builds Builds.
  2. Click the Pipelines tab.
  3. In the Application Extension - Package and Deploy pipeline, click Configure the Gear icon.
  4. On the design page, from the Jobs list, drag-and-drop the deployment jobs to the designer area.

    Here's an example:

    Pipeline jobs
  5. Mouse-over the packaging job's Blue circle Blue circle on the right side of the job node handle and drag-and-drop the arrow head over each deployment job's White circle White circle on the left side of the job node handle.

    Here's an example:

    Setting a job's dependency in a pipeline
  6. Click Save.
Create and Configure a Pipeline to Deploy to Other Oracle Cloud Applications Instances
  1. In the navigation menu, click Builds Builds.
  2. Click the Pipelines tab.
  3. Click + Create Pipeline.
  4. In the Create Pipeline dialog box, in Name and Description, enter a unique name and description.
  5. Deselect the Auto start when pipeline jobs are built externally check box.
  6. Click Create.
  7. On the design page, from the Jobs list, drag-and-drop the Application-Extension-Package job and all deployment jobs to the designer area.
    Here's an example:
    Other pipeline jobs
  8. Mouse over the Start node's Gray circle Gray circle on the right of the Start node handle. The cursor icon changes to the + cursor icon. Drag the cursor from the Gray circle Gray circle on the right of the Start node handle to the packaging job's White circle White circle on the left side of the job node handle. An arrow line appears.
    Here's an example:
    Other pipeline jobs - define the pipeline's first job
  9. Mouse-over the packaging job's Blue circle Blue circle on the right side of the job node handle and drag-and-drop the arrow head over a deployment job's White circle White circle on the left side of the job node handle.
    Here's an example:
    Other pipeline jobs - dependency between package and a deploy job
  10. Repeat the steps 7 and 8 to connect the packaging job's Blue circle Blue circle on the right side of the job node with each deployment job's White circle White circle on the left side of the job node .
    Here's an example:
    Other pipeline jobs - all dependencies
  11. Click Save.

Run a Pipeline

  1. In the navigation menu, click Builds Builds.
  2. Click the Pipelines tab.
  3. For the pipeline you want to run, click Build Build.

After a successful build, you'll find the deployed application's link in the Deployments tab of the Environments page. Newer extensions, which are based on App UIs, are shown under Application Extensions, while older extensions are shown under Application Extensions Classic. You can learn more about this in Package, Deploy, and Manage Application Extensions.

To view the job's latest build log, open the Builds page, click the job's name, and then click Build Log.

Set Up the Project to Deploy to Production

After your development and test cycles are complete, you may want to configure the project to build and deploy extensions to the Oracle Cloud Application's production instance.

Before you proceed, contact the Oracle Cloud Applications production instance administrator and make sure that the production instance is properly configured and running.

Here's a workflow summary of how to set up the VB Studio project for deployment:

To perform this action: See this:
1. In the VB Studio project, create an environment for the Oracle Cloud Application's production instance.

To deploy your extension, you must add the Oracle Cloud Application's production instance to an environment.

Add the Oracle Cloud Application's Production Instance to an Environment
2. Create a production branch from the main branch. Use this branch to host extension's code files that are ready for production. Create a Production Branch
3. Configure build jobs to package and deploy the extension to the Oracle Cloud Application's production instance Create and Configure Production Build Jobs
4. Configure the production pipelines Set Up Production Build Pipelines
5. Run the production pipeline and build jobs.

Before you run production jobs and pipelines, make sure that all code changes have been pushed to the production branch and there are no open merge requests.

Run Production Pipelines

Add the Oracle Cloud Application's Production Instance to an Environment

To deploy an extension to the Oracle Cloud Application's production instance, you must create a VB Studio environment and add the production instance to it. You can only add one Oracle Cloud Applications instance to an environment.

The Oracle Cloud Applications production instance usually resides in another identity domain. To add an Oracle Cloud Applications production instance that resides in another identity domain to an environment, you'll need the base Oracle Cloud Application's URL and a user's credentials who can access the instance.

When you add an Oracle Cloud Applications instance (a service instance or an IDCS resource) to an environment, VB Studio creates an IDCS Application (also known as a Client Application) in the background. The IDCS Application generates an OAuth token to access the newly added Oracle Cloud Applications instance and handles authentication when VB Studio tries to access the target instance. Provisioning of the IDCS Application takes a few seconds to complete after the Oracle Cloud Applications instance is added to an environment.

After adding an instance to an environment, in the Service Instances tab, click Expand Downward Pointing Arrow to see the Oracle Cloud Applications instance's URL.

If the newly added instance stays in the Unknown status for some time, it typically indicates that the IDCS Application provisioning may have failed. VB Studio added the Oracle Cloud Applications instance but can't access it. In such a case, click Actions Three horizontal dots and select Remove to remove the Oracle Cloud Applications instance from the environment, and then click Add to add it again.

Add an Oracle Cloud Applications Instance in Another Identity Domain
  1. In the navigation menu, click Environments Environments.
  2. Select an existing environment or create one.
    To create an environment, click + Create Environment. In Environment Name and Description, enter a unique name and description, and click Create.
  3. In the Service Instances tab, click + Add Instance.
  4. In the Add Service Instances dialog box, select the Oracle Cloud Applications option button.
  5. Under Authentication Method, select the Application Credentials option.
  6. In Base URL, enter the Oracle Cloud Application's base URL.
  7. In Instance Name, if required, update the instance's display name. The name will be displayed in the Service Instances tab.
  8. In Username and Password, enter the credentials of a user who can access the Oracle Cloud Applications instance.
  9. Click Add.

Create a Production Branch

Follow your organization's guidelines to create a branch and protect it from unverified changes. To protect the branch, you can set merge restrictions, make the branch private and restrict who can push commits to it, or freeze it.

  1. In the navigation menu, click Git Git.
  2. Click the Refs view and then click Branches Branches.
  3. From the Repositories drop-down list, select the repository.
  4. Click + Create Branch.
  5. In the New Branch dialog box, in Name, enter the branch name. From the Base drop-down list, select the main branch as the base branch.
  6. Click Create.

After creating the production branch, any changes pushed to the main branch aren't automatically available in the production branch. You must create a merge request or manually push the changes to the production branch.

If you want to set merge restrictions on the production branch, see Set Review and Merge Restrictions on a Repository Branch. To freeze the branch or make it private, or set other restrictions, see Protect a Branch.

Create and Configure Production Build Jobs

You need to set up some packaging and deployment jobs before you can deploy extensions to your Oracle Cloud Application's production instance. This topic explains how to do that.

To do this: See this:
Migrate your configurations to the production Oracle Cloud Applications instance

Overview of Configuration Life Cycle and Migration in Configuring and Extending Applications to learn about customization migration.

Package extension for the Oracle Cloud Application's production instance Create the Production Packaging Build Job
Deploy the packaged extension artifact to the Oracle Cloud Application's production instance.

You'll use this job to deploy the extension to the production sandbox as well as to the mainline.

Create the Production Deployment Build Job
(Optional) Restrict who can see or edit the production build jobs or run their builds Configure a Job's Privacy Setting
Configure pipelines and run them Set Up Production Build Pipelines and Run Production Pipelines
Before You Configure Build Jobs and Pipelines

Here are some things you need to know and do before you configure and run build jobs and pipelines:

  • Get the access credentials of an Oracle Cloud Applications user who can connect and deploy to the production instance.
  • Make sure that the source and target instances are of the same release, with the same standard and one-off patches applied to both environments.
  • In the development packaging job, if you changed the default artifact's file name, get the new name and its path.
  • If you configured the development packaging job to overwrite the application's version defined in visual-application.json, get the new version. You'll configure the production's packaging job to use the same version.

To deploy your extension to the Oracle Cloud Applications production instance, you'll create these jobs and pipelines:

  • A packaging job that packages the extension for the Oracle Cloud Applications production instance.
  • A deployment job that deploys the extension to the Oracle Cloud Applications production instance.
  • A pipeline that packages and deploys the extension to the Oracle Cloud Applications production instance.
Create the Production Packaging Build Job

The packaging job generates an extension artifact that's ready to deploy to the mainline.

  1. In the navigation menu, click Builds Builds.
  2. In the Jobs tab, click + Create Job.
  3. In the New Job dialog box, in Name, enter a unique name.
  4. In Description, enter the job's description.
  5. In Template, select the System Default OL7 for Visual Builder template.
  6. Click Create.
  7. Click Configure Configure.
  8. Click the Git tab.
  9. From the Add Git list, select Git.
  10. In Repository, select the Git repository. In Branch or Tag, select the production branch.
  11. Click the Steps tab.
  12. From Add Step, select Application Extension, and then select Package.
  13. (Optional) If you want to change the artifact file's name, in Artifact, enter the new name. By default, it is extension.vx.
  14. (Optional) If you configured the development packaging job to overwrite the extension's default version defined in the visual-application.json file, specify the same version in Extension Version.
  15. Click the After Build tab.
  16. From Add After Build Action, select Artifact Archiver.
  17. In Files to archive, enter the build artifact name. You can also use wild characters. For example, *.vx.
  18. If you want to discard the build's old artifacts, click Settings the Gear icon. In the General tab, select the Discard Old Builds check box and specify the discard options.
  19. Click Save.
Create the Production Deployment Build Job

The deployment job deploys the extension's artifact that was generated in the packaging job to the Oracle Cloud Application's production instance. Before you create the job, get the access credentials of an IDCS user who can also access the Oracle Cloud Application's production instance.

  1. In the navigation menu, click Builds Builds.
  2. In the Jobs tab, click + Create Job.
  3. In the New Job dialog box, in Name, enter a unique name.
  4. In Description, enter the job's description.
  5. In Template, select the System Default OL7 for Visual Builder template.
  6. Click Create.
  7. Click Configure Configure.
  8. Click the Before Build tab.
  9. From Add Before Build Action, select Copy Artifacts.
  10. In From Job, select the packaging job that generated the extension's artifact.
  11. In Which Build, select the build that generated the artifact.
  12. Leave other fields with their default or empty values.
  13. Click the Steps tab.
  14. From Add Step, select Oracle Deployment.
  15. In Target Instance, select the environment with the Oracle Cloud Application's production instance.
  16. In Username and Password, enter the credentials of an IDCS user who is not only an Oracle Cloud Applications user, but one who can connect and deploy to the Oracle Cloud Application's production instance.
  17. In Build Artifact, enter the same artifact name that you used in the packaging build step.
  18. Click Save.
Configure a Job's Privacy Setting

The project owner can mark a job as private to restrict who can see or edit a job's configuration, or run its build:

  1. In the navigation menu, click Project Administration Project Administration.
  2. Click Builds.
  3. Click the Job Protection tab.
  4. From the jobs list, select the job.
  5. Select the Private option.
  6. Click in the Authorized Users/Groups field to see a list of Users and Groups that have permission to access this project. From the list, select a group, or several groups, and a user, or several users. Don't forget to add yourself.
  7. Click Save.

You can see if a job is private from several places in the VB Studio user interface. A private job is indicated by a Lock Lock icon:

  • In the jobs list found on the Project Administration tile's Builds page's Job Protection tab, to the right of each protected job's name.

  • In the Private column on the Builds page's Jobs tab.

  • In the jobs shown in the the Builds page's Pipelines tab.

An unauthorized user can't run a private build job manually, or through a pipeline, or via an SCM/periodic trigger.

Set Up Production Build Pipelines

After configuring production jobs, create pipelines to package and deploy the extension to the production instance.

To configure this pipeline: See this:
Package and deploy the extension to the Oracle Cloud Application's production instance.

This pipeline allows you to deploy the extension to the Oracle Cloud Application's production instance.

Create and Configure the Production Pipeline
Create and Configure the Production Pipeline

To ensure the deployment job runs automatically after the packaging job, create a pipeline and set the dependency.

  1. In the navigation menu, click Builds Builds.
  2. Click the Pipelines tab.
  3. Click + Create Pipeline.
  4. In the Create Pipeline dialog box, in Name and Description, enter a unique name and description.
  5. Click Create.
  6. On the design page, from the Jobs list, drag-and-drop the packaging job and the deployment job to the designer area.

    Example:

    Production pipeline jobs
  7. Mouse over the Start node's Gray circle Gray circle on the right of the Start node handle. The cursor icon changes to the + cursor icon. Drag the cursor from the Gray circle Gray circle on the right of the Start node handle to the packaging job's White circle White circle on the left side of the job node handle. An arrow line appears.

    Example:

    Packaging job
  8. Mouse-over the packaging job's Blue circle Blue circle on the right side of the job node handle and drag-and-drop the arrow head over the deployment job's White circle White circle on the left side of the job node handle.

    Example:

    Deploy job
  9. Click Save.

Run Production Pipelines

To deploy your extension to the production instance mainline, run production jobs and pipelines.

Before you run production build jobs or pipeline, make sure that all code changes are pushed to the production branch and there are no open merge requests.
  1. In the navigation menu, click Builds Builds.
  2. Click the Pipelines tab.
  3. In the production pipeline, click Build Build.

After a successful build, you'll find the deployed application's link in the Deployments tab of the Environments page. You should also inform the Oracle Cloud Applications administrator that the extension has been pushed to the Oracle Cloud Application's production instance.

Delete an Extension

If you want to delete an extension that's deployed to Oracle Cloud Applications, you can do so manually or through a job configuration.

You can delete an extension manually if it is deployed to an Oracle Cloud Applications instance that's in the same identity domain as VB Studio. If the extension is deployed to a different identity domain (like to your production instance), or if the Oracle Cloud Applications instance was in a different identity domain than VB Studio (such as your production instance) or the Oracle Cloud Applications instance was added to an environment through credentials, you should configure a build job to delete it.

Delete an Extension Manually

You can delete an extension that's deployed to your current identity domain's Oracle Cloud Applications instance from the the Deployments tab of its environment.

  1. In the navigation menu, click Environments Environments.
  2. Select the Development environment where the extension is deployed.
  3. Click the Deployments tab.
  4. Expand the base application's name.
  5. For the extension to delete, click Actions Three horizontal dots and select Delete.
  6. In the confirmation dialog box, click Delete.

Configure a Build Job to Delete an Extension

To delete an extension that's deployed to your production Oracle Cloud Applications instance or an Oracle Cloud Applications instance of another identity domain, configure a build job and run it. You can't delete it manually.

Before you configure and run the job, delete the extension from the development instance (or your test instance) and make sure there aren't any effects of deleting the extension on the instance. For example, let's assume you have an attribute that's hidden in the extension's business object and the user interface. After you delete the extension, the user interface shows the attribute that is still hidden in the business object. This may cause an error.

To configure the job, you'll need the access credentials of a user who can access the Oracle Cloud Application's instance where the extension is deployed.

  1. In the navigation menu, click Builds Builds.
  2. In the Jobs tab, click + Create Job.
  3. In the New Job dialog box, in Name, enter a unique name.
  4. In Description, enter the job's description.
  5. In Template, select System Default OL7 for Visual Builder.
  6. Click Create.
  7. On the Job Configuration page, click Configure Configure.
  8. Click the Steps tab.
  9. From Add Step, select Application Extension, and then select Delete.
  10. In Instance, select the Oracle Cloud Applications instance where the application is deployed.
  11. In Username and Password, enter the credentials of an IDCS user who is not only an Oracle Cloud Applications user, but one who can connect and undeploy from the Oracle Cloud Application's production instance.
  12. In Base Application, Name, and Version, enter the extension's base application, name, and version.
    You can find the details on the Deployments tab of the environment where the extension is deployed.

    Example:

  13. Click Save.
  14. To run a build, click Build Now.