3 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 customize certain Oracle Cloud Applications by creating application extensions.

An app extension is an artifact that allows you to extend certain Oracle Cloud Applications to meet your business needs. You deploy an app extension to an Oracle Cloud Applications instance. This documentation assumes that you have created and set up Oracle Cloud Applications instances for development and production environments in different identity domains.

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 instance, file a service request a service request so that we can delete the VB Studio instance associated with your *-TEST instance and create a new one in your in your preferred identity domain.

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

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 app extension to Oracle Cloud Applications development and production instances, you'll need the credentials of users who can access them.
3. 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.

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 app extension. You should create one project for each of your base Oracle Cloud Applications.

To perform this action: See this: Why do I need to perform this action?
1. Create a project for app extensions Create a Project for Application Extensions To develop an app extension, 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 an app extension project, 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 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 app extension View the Deployed Application Extension After you've deployed the app extension, you can view it's URL on the Environments page.
3. Add Oracle Cloud Applications users to the project Add Users to the Project To allow your team members to access the app extension project, invite them to join the project.
4. Optional configuration Optional Configuration After you've set up the project, if required, you can make some optional advanced configuration to it.

After setting up the project, follow these steps to set up the project for deploying your app 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 First, create an environment and 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 app 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 app extensions to your Oracle Cloud Application's production instance.
4. Run the pipelines Run Production Pipelines Run the production pipelines and jobs that deploy app 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 built-in free VM, and best practices.

To deploy app extensions, you'll also need 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 application extensions.

To deploy your app 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.

Best Practices

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

  • Follow your organization's guidelines to create and set up Oracle Cloud Applications instances. Your guidelines may suggest to 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 your base Oracle Cloud Applications, taking care to use the Application Extension project template.
  • After creating the project, add Oracle Cloud Applications users to the project and assign them proper project roles.

    For example:

    • Assign the Developer Limited role to users who want to work on customization, but don't run build jobs.
    • 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 the application.
  • If you use the Application Extension template to create your project, VB Studio automatically creates a Development environment that points to the Oracle Cloud Application's development instance you specify. The build jobs, created by default, package and deploy the app extension's artifact to the Oracle Cloud Application's development instance.

    If you want to use VB Studio to also deploy to your Oracle Cloud Application's production instance, you'll need to manually create a VB Studio environment for the instance.

  • To add Oracle Cloud Application's production instance from other identity domain, get either the identity domain's details or a user's credentials who can connect to the instance.
  • Follow your organization's guidelines to create and manage Git repository's branches. By default, the project uses the main branch for development. This documentation assumes that you'll continue to use main as the development branch and create a separate branch for production.
  • You should set restrictions on the production branch to control who can merge to it.
  • To deploy to your Oracle Cloud Application's production instance, create separate jobs to package the artifact and to deploy it to the Oracle Cloud Applications instance. Then, create a pipeline to run the packaging and deploy jobs in sequence.
  • Set restrictions on who can edit or run production jobs.
  • 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.

Get the Required Roles

To set up VB Studio and your Oracle Cloud Applications instances, 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

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)

VB Studio administrator (DEVELOPER_ADMINISTRATOR)
Application Developer (ORA_FND_APPLICATION_DEVELOPER_JOB) VB Studio user (DEVELOPER_USER)

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 app extension, and deploy it to an Oracle Cloud Applications instance. The builds and pipelines run on build executors, also called Build Virtual Machines (VMs). These Build VMs are Oracle Cloud Infrastructure (OCI) VM compute instances dedicated to run VB Studio builds. To use Build VMs, 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 that you can use to run build jobs that package and deploy your app extensions. However, there some limitations associated with the built-in free VM, so you may want to connect to your own OCI account instead, if you have one. See VB Studio's Built-In Free Account for more details.

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

  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 app extensions, no additional configuration is required. Go ahead and create your app extension project. VB Studio creates the built-in free VM 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 Build VMs.

If you're new to OCI, see Welcome to Oracle Cloud Infrastructure and Configure VB Studio to Connect to OCI.

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 Build VMs.
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 app extension project.

Your organization's developers can design the app, preview their changes, updates source code files in Git repositories, review the source code, track issues, and collaborate using wikis, but they won't be able to build and deploy the app extension.

To run builds, either contact your sales representative to create an OCI account or 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 Build VMs, the first build VM is created for you when you create the first project. If the project isn’t the initial one, the VM must be created manually.

Add the Built-In Free VM Manually

If you're using VB Studio's built-in free account, the built-in free VM is added when you create your first project. Add the build VM manually if you've deleted it or it wasn't added when you created the project.

  1. In the navigation menu, click Organization Organization.
  2. Click the Virtual Machines tab.
    If you see a VM of the System Default OL7 for Visual Builder template, ignore the remaining steps. This VM is the built-in free VM.

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

  3. Click Create Free Build VM to create the VM.

Create a Project for Application Extensions

A VB Studio project gathers all the resources you need for developing software. To ensure an optimal environment for your team members creating application extensions, be sure to base your project on the Application Extension project template. You should create one project for each of your base Oracle Cloud Applications.

  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.
  7. On the Project Properties page:
    1. In Extension, if necessary, change the app extension's name. Make sure that the extension's name is unique across the base Oracle Cloud Application's name.
    2. 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 app 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 and Why Do I Need One?

    3. 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 app extensions.
      If there are multiple Oracle Cloud Applications instances in your identity domain, select the Oracle Cloud Applications instance you want to use to develop app extensions. Make sure that the selected instance has a VB Studio instance provisioned and also has the base application you want to extend.
    4. From Base Application, select the Oracle Cloud Application you want to extend in this project.
    5. In Git Repository Name, change the Git repository's default name, if required.
    6. In Working Branch Name, if required, change the workspace's working branch name. By default, it is branch1.
      When the project is provisioned, the Git repository's main branch contains your application's files. While creating the workspace, VB Studio creates a copy of the main branch, renames it with your specified name and uses it as the workspace's working branch.
  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 contains the app extension's source code.

    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 your base Oracle Cloud Application is running.

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

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

    By default, Application-Extension-Package and Application-Extension-Deploy jobs are created for you. The Application-Extension-Package job generates the app extension's artifact file. The Application-Extension-Deploy job deploys the app 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 Build VMs and make the appropriate deployment configurations. See Set Up the Project for Development. Without the appropriate configuration or VMs, the builds won't run.

  • A pipeline to run the 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 to edit the app extension in the VB Studio Designer.

    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 required, you can change the project's markup language from the Project Administration page. See Change a Project’s Wiki Markup Language.
  • A Build VM is created if this project is VB Studio's first project and no build VMs had existed when you created the project. The VM uses the System Default OL7 for Visual Builder VM template. You can use this VM 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 Virtual Machines tab to see the VM.

Set Up the Project for Development

Before your team members can use the project for developing app 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
3. View the deployed app extension View the Deployed Application 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 app 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 yours or an Oracle Cloud Applications user's credentials who can connect and deploy 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

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 Application Extension

After the deployment job has successfully run, you can view the deployed app 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.
  5. If the Oracle Cloud Application's access credentials have changed, provide the credentials again.
  6. Expand App Extensions (V1).
  7. Expand the base Oracle Cloud Application to view its deployed app extensions.
    By default, the Deployments tab shows app extensions deployed to the Oracle Cloud Application's instance. If you want to see shared or previewed app extensions too, select the Show development/sandbox versions check box.

    For each app extension, the page displays its ID, name, version, and status. Here's an example:

    In the packaging build step, if you didn't specify a version to overwrite the app 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.

To open the Oracle Cloud Application with the deployed app extension, copy the application's base URL and paste it in a web browser.

Add Users to the Project

You must explicitly add users before they can work within a project, as explained in this table:

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.

Optional Configuration

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 VMs or VM templates.

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

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

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

Configure the Packaging Job
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 Build VMs

If you want to add more VMs to reduce the wait time for your organization's members or create custom VM templates, or use advanced features for VMs (such as use your own VCN or use a different VM shape), you should configure VB Studio to connect to your own OCI account.

  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.

The VM template and the built-in free VM of your built-in free account migrate to the OCI account.

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

To add more VMs:

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

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

    If you're not sure about the number of VMs you'll need, start with one Build VM and then add more as required. Note that the more VMs 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 Virtual Machines page to automatically shut down inactive VMs. You can always return to the Virtual Machines tab to remove or add VMs, based on your actual usage.

  4. In VM Template, select System Default OL7 for Visual Builder or a VM template with Node.js 10 (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 Build VM 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.
Configure the Packaging Job

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

The app 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 app 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.

What Next?

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

  • How Do I Use Visual Builder Studio to Extend Oracle Cloud Applications in Extending Oracle Cloud Applications with Visual Builder Studio describes how to create, edit and publish app extensions using the VB Studio Designer.
  • Get Started in Using Visual Builder Studio is a good resource, as it explains how to manage a project, create and manage issues and Agile boards, review source code with merge requests, and more.

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 app extension 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 app 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 app extension's code files that are ready for production. Create a Production Branch
3. Configure build jobs to package and deploy the app 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 app 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 a Connection to Oracle Cloud Applications of 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 base Oracle Cloud Application's 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 app extensions to your Oracle Cloud Application's production instance. This topic explains how to do that.

To do this: See this:
Package app extension for the Oracle Cloud Application's production instance Create the Production Packaging Build Job
Deploy the packaged app extension artifact to the Oracle Cloud Application's production instance. 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 app extension to the Oracle Cloud Applications production instance, you'll create these jobs and pipelines:

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

The packaging job generates an app 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 app 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 app 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 app 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. In Authorized Users, add yourself.
    To add other users, select their names.
  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.

A private job must be run manually. It won't run if a non-authorized user tries to run the job directly, through an SCM/periodic trigger or a pipeline.

Set Up Production Build Pipelines

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

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

This pipeline allows you to deploy the app 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 app extension to the production instance mainline, run production jobs and pipelines.

  1. In the navigation menu, click Builds Builds.
  2. Click the Pipelines tab.
  3. For 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 app extension has been pushed to the Oracle Cloud Application's production instance.

Delete an App Extension

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

You can delete a app extension manually if it is deployed to an Oracle Cloud Applications instance that's in the same identity domain as VB Studio. If the app extension is deployed to an Oracle Cloud Applications instance 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 App Extension Manually

You can delete an app 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 app extension is deployed.
  3. Click the Deployments tab.
  4. Expand the base application's name.
  5. For the app 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 App Extension

To delete an app 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 app extension from the development instance (or your test instance) and make sure there aren't any effects of deleting the app extension on the instance. For example, let's assume you have an attribute that's hidden in the app extension's business object and the user interface. After you delete the app 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 app 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 the System Default OL7 for Visual Builder Build VM template.
  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 app extension's base application, name, and version.
    You can find the details on the Deployments tab of the environment where the app extension is deployed.

    Example:

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