Administering Visual Builder Studio...IDCS Roles1-13 What Are the VB Studio Project Memberships?1-14 Set Up Oracle Visual Builder Studio to Manage Your Development CycleCycle Cycle

Oracle® CloudAdministering Visual Builder Studio

F20926-02June 2020

Oracle Cloud Administering Visual Builder Studio,

F20926-02

Copyright © 2020, 2020, Oracle and/or its affiliates.

Primary Author: Oracle Corporation

This software and related documentation are provided under a license agreement containing restrictions onuse and disclosure and are protected by intellectual property laws. Except as expressly permitted in yourlicense agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license,transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverseengineering, disassembly, or decompilation of this software, unless required by law for interoperability, isprohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. Ifyou find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it onbehalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software,any programs embedded, installed or activated on delivered hardware, and modifications of such programs)and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Governmentend users are "commercial computer software" or “commercial computer software documentation” pursuantto the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such,the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works,and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programsembedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oraclecomputer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in thelicense contained in the applicable contract. The terms governing the U.S. Government’s use of Oracle cloudservices are defined by the applicable contract for such services. No other rights are granted to the U.S.Government.

This software or hardware is developed for general use in a variety of information management applications.It is not developed or intended for use in any inherently dangerous applications, including applications thatmay create a risk of personal injury. If you use this software or hardware in dangerous applications, then youshall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure itssafe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of thissoftware or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks oftheir respective owners.

Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks areused under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc,and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registeredtrademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products,and services from third parties. Oracle Corporation and its affiliates are not responsible for and expresslydisclaim all warranties of any kind with respect to third-party content, products, and services unless otherwiseset forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will notbe responsible for any loss, costs, or damages incurred due to your access to or use of third-party content,products, or services, except as set forth in an applicable agreement between you and Oracle.

Contents

1 Overview

What Is Oracle Visual Builder Studio? 1-1

Extend Oracle Cloud Applications with VB Studio 1-2

Build Web and Mobile Applications with VB Studio 1-3

Use VB Studio to Manage Your Development Cycle 1-4

How Do I Administer VB Studio? 1-6

Setting Up for Application Extensions 1-6

Setting Up for Visual Applications 1-8

Setting Up for Other Types of Applications 1-11

Key Concepts, Components, and Terms 1-11

Assign the Right Roles 1-13

IDCS Roles 1-13

What Are the VB Studio Project Memberships? 1-14

2 Set Up Oracle Visual Builder Studio to Manage Your DevelopmentCycle

Before You Begin 2-1

Create the VB Studio Instance 2-1

Access VB Studio from the Oracle Cloud Home Page 2-3

Connect to OCI or OCI Classic 2-4

Set Up the OCI Connection 2-4

Set Up the OCI Account 2-4

Get the Required OCI Input Values 2-8

Set Up the OCI Connection in VB Studio 2-11

Set Up the OCI Classic Connection 2-12

Get OCI Object Storage Classic Input Values 2-12

Create an OCI Classic Connection from VB Studio 2-13

Compute_Operations Role: Terms of Use 2-14

Set Up the Build System 2-14

What Are Build VMs and Build VM Templates? 2-14

Build VMs in Virtual Cloud Network 2-15

Use VB Studio's Default VCN 2-16

iii

Run Build VMs in Your VCN 2-16

Create and Manage Build VM Templates 2-24

Add and Manage Build VMs 2-26

Add Users to IDCS 2-31

Manage the Organization 2-32

Update the Organization’s Display Name and Description 2-32

Set the Organization’s Default Wiki Markup Language 2-32

Manage Projects of the Organization 2-33

Manage Your Development Cycle 2-35

Set Your User Preferences 2-35

Update Your Display Name 2-36

Update Your Email Address 2-36

Add Your Avatar Picture 2-36

Configure Your Global Email Notifications 2-37

Upload Your Public SSH Key 2-38

See the News Banner 2-39

3 Set Up Oracle Visual Builder Studio for Extending Oracle CloudApplications


Best Practices 3-4

Get Access to Oracle Cloud Applications Instances 3-5

Create the VB Studio Instance and Set Up the OCI Connection 3-6

Set Up VB Studio Users 3-6

Configure Single Sign-On (SSO) and Synchronize Users 3-6

Set Oracle Cloud Applications as the Identity Cloud Service Provider 3-9

Assign VB Studio Roles to Oracle Cloud Applications Users 3-9

Create a Project for Application Extensions 3-10

Set Up the Project for Development 3-13

Add Build VMs 3-13

Configure the Packaging Job 3-14

Configure the Deployment Job 3-15

Get an Oracle Cloud Applications User's Personal Access Token 3-15

Run the Pipeline 3-16

View the Deployed Application Extensions 3-16

Delete an App Extension 3-17

Delete an App Extension Manually 3-17

Configure a Job to Delete an App Extension 3-17

Set Merge Restrictions on the master Branch 3-18

Learn More About VB Studio 3-19

iv

Add Users to the Project 3-19

Set Up the Project For Testing 3-20

Add an Oracle Cloud Application's Instance to an Environment 3-21

Add a Connection to Oracle Cloud Applications of Your Current IdentityDomain 3-22

Add a Connection to Oracle Cloud Applications of Another Identity Domain 3-22

Create a Test Branch 3-23

Create and Configure Build Jobs 3-23

Create a Packaging Build Job 3-24

Create a Deployment Build Job 3-25

Configure a Job's Privacy Setting 3-26

Create and Configure a Pipeline 3-27


Delete an App Extension 3-28

Migrate Your Oracle Cloud Application’s Customizations 3-29

Before You Migrate Customization 3-30

Configure a Job to Export Customization 3-30

Configure a Job to Import Customization 3-32

Configure a Job to Abort Customization Migration 3-33

Configure a Job to Apply and Save the Customization Migration 3-34

Create and Configure the CSM Pipeline 3-35


Set Up the Project to Deploy to Production 3-36

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

Add a Connection to Oracle Cloud Applications of Another Identity Domain 3-37

Create a Production Branch 3-38


Create a Production Packaging Build Job 3-39

Create a Production Deployment Build Job 3-40




Migrate Your Oracle Cloud Application’s Customization 3-42

4 Set Up VB Studio for Developing Visual Applications


Best Practices 4-3

Get Access to Visual Builder Instances 4-5

Create the VB Studio Instance and Set Up the OCI Connection 4-5

Create a Project for Visual Applications 4-6

Set Up the Project for Development 4-9

v

Add Build VMs 4-9

Configure the Packaging Job 4-10

Configure the Deployment Job 4-11

Get a Visual Builder User's Personal Access Token 4-12


View the Deployed Visual Applications 4-12

Undeploy a Visual Application 4-13

Undeploy a Visual Application Manually 4-13

Configure a Job to Undeploy a Visual Application 4-13

Set Merge Restrictions on the master Branch 4-14

Learn More About VB Studio 4-15

Add Users to the Project 4-15

Set Up the Project for Testing 4-17

Add a Visual Builder Instance to an Environment 4-17

Add a Connection to Visual Builder of Your Current Identity Domain 4-18

Add a Connection to Visual Builder of Another Identity Domain 4-18

Create a Test Branch 4-20


Create a Packaging Build Job 4-21

Create a Deployment Build Job 4-22




Undeploy a Visual Application 4-25

Set Up the Project to Deploy for Production 4-26

Add the Visual Builder Production Instance to an Environment 4-27

Add a Connection to Visual Builder of Another Identity Domain 4-27

Create a Production Branch 4-29

Create and Configure Production Build Jobs 4-29

Create a Production Packaging Build Job 4-30

Create a Production Deployment Build Job 4-31

Configure a Production Job's Privacy Setting 4-32



Configure a Job to Undeploy a Visual Application 4-33

5 Manage Your Component Exchange

What is a Component Exchange? 5-1

Use a Project as the VB Studio Component Exchange 5-1

Use an External Server as the VB Studio Component Exchange 5-2

vi

Share the Component Exchange's URL 5-3

Workflow for Web Components 5-4

vii

Abstract

Documentation for Oracle Visual Builder Studio administrators that describes how toadminister and set up the service.

8

1Overview

Learn about Oracle Visual Builder Studio, its projects, components, roles, and how toaccess the service.

See Oracle Cloud Terminology in Getting Started with Oracle Cloud for definitions ofterms found in this and other documents in the Oracle Cloud library.

What Is Oracle Visual Builder Studio?Oracle Visual Builder Studio (VB Studio) is a robust application development platformthat helps your team effectively plan and manage your work throughout all stages ofthe app dev lifecycle: design, build, test, and deploy.

In addition, VB Studio makes it easy for your entire team to develop the artifacts theyneed, including:

• Oracle Cloud Applications developers, who need to extend their Apps withbusiness-specific customizations;

• Low-code developers, who want to create web or mobile apps using a visualdesigner;

• Experienced programmers, who want to modify the source code for web andmobile apps created by others, or to develop bespoke apps using the webprogramming language of their choice.

With VB Studio you get:

• Built-in repositories for hosting code in Git and for hosting binaries, such as Mavendependencies

• A continuous integration service so you can automate your build and test systems

• A continuous delivery service that tightly integrates with Oracle Cloud Applications

• A rich visual designer integrated with source control (Git) so that developers canmanage changes, apply version control best practices, and collaborate with theirteammates to develop applications

• The ability to build and display different flavors of the UI to meet the needs ofdiscrete users of certain Oracle Cloud Applications (those built with VB Studio andOracle Java Extension Toolkit (Oracle JET)), also within a Git framework

• Agile boards and an issue tracking system for tracking sprints, tasks, defects, andfeatures

VB Studio enables developers to easily deploy their applications to their preferredtarget, whether it’s a staging or production instance of Oracle Cloud Applications or anOracle Cloud Infrastructure (OCI) service instance.

1-1

Extend Oracle Cloud Applications with VB StudioThe changes you make to your Oracle Cloud Application in VB Studio are stored in anartifact called an application extension. Physically, the source code associated with theapp extension is stored in a Git repository off its master branch. When working on anapp extension, best practice is to have only one app extension for the base app in theproject, and to store all the sources for the app extension in the same Git repositoryin the project. Multiple developers can work together to develop the app extension, butthey should all be working from the same repository. (Your individual work in VB Studiois also referred to as an application extension.)

Here are the key components of the VB Studio ecosystem as it pertains to applicationextensions:

• Within a single VB Studio instance, you and your team members who use thatinstance are considered an organization. Within your organization, you will likelybelong to one or more projects, each of which is devoted to a discrete softwareeffort. For example, you might have a project for building an application extensionfor an Oracle Cloud Application, and another project for building a bespoke webor mobile application for use by your own department. A project brings togetherall the tools you need to create those artifacts, such as a Git repository for storingyour source code, a pipeline to provide continuous integration and delivery, anissue tracking system, team wikis, and more.

• Each base app should have only one app extension, and all work on the appextension is stored in the same Git repository. The workspaces of developersworking on the app extension should all use clones of the same Git repository.

• When you work on an application extension, you do so within the editors providedin the VB Studio Designer. Depending on which aspect of the page you'recustomizing, VB Studio invokes the proper editor to provide the experience youneed.

Chapter 1What Is Oracle Visual Builder Studio?

1-2

• All of your work in VB Studio is done in the context of a workspace, a completelyprivate area where you can work on your application extension. A workspaceprovides several important components:

– A reference to the base application, which is the Oracle Cloud Applicationyou're extending;

– A pointer to the Oracle Cloud Application sandbox, which contains any datamodel changes you may have made;

– A pointer to the Oracle Cloud Application development or test environmentwhere you plan to deploy your app. You can deploy your app manually, or wireit up to a pipeline to do it automatically, such as when a developer on yourproject merges his or her branch to the master branch.

– Your own clone of the app extension's Git repository, where the source codefor your application extension lives. Your work is not visible to others until youa) merge it to the project's Git repo, b) choose to Share it with other for testing,or c) deploy it.

Build Web and Mobile Applications with VB StudioVB Studio provides a visual environment to develop, test, and deploy mobile and webapplications.

It provides easy access to data from any REST-based service, and enables youto create custom reusable business objects for storing and managing data. Usingthe cloud-based visual development tools, you can create and test responsive webapplications, progressive web apps, and native mobile applications without the need toinstall any additional software. The visual designer (Designer) enables you to lay outpages in your applications by dragging and dropping UI components, customizing theirattributes and defining their behavior.

VB Studio uses Oracle JET to create web and mobile interfaces. Reusable OracleJET Web Components, built using the Web Component standard, can be added to theapplication to further enhance the user experience.

VB Studio also provides the following tools for building and publishing applications:

• Robust tools to describe requests and responses to Oracle Cloud Applicationservices in the integrated catalog

• Data management tools for managing business objects and importing andexporting data

• Tools to configure role-based security and user access management

• Tools to access Git repositories so you can share application resources with teammembers

If you previously developed visual applications in Visual Builder and now work with VBStudio, you’ll see that some things have changed. For details about tasks that you nowdo differently in VB Studio, see For Visual Builder Users.

This diagram shows the main artifacts in a visual application project.


1-3

Here are the key components of the VB Studio ecosystem as it pertains to visualapplications (that is, web and mobile applications):

• Within a single VB Studio instance, you and your team members who use thatinstance are considered an organization. Within your organization, you will likelybelong to one or more projects, each of which is devoted to a discrete softwareeffort. For example, you might have a project for building a new Financial mobileapp, and a different project for creating an HR web application. A project bringstogether all the tools you need to create those artifacts, such as a Git repository forstoring your source code, a pipeline to provide continuous integration and delivery,an issue tracking system, team wikis, and more.

• If you used Visual Builder Cloud Service in the past, you're familiar with theDesigner, which helps you build visual applications using a declarative graphicaluser interface. Specifically, you get a page editor, a Components Palette, and aPage Structure view, for designing the layout of a page. The Designer remains akey component in VB Studio as well.

• All of your work in VB Studio is done in the context of a workspace, a completelyprivate area where you can work on your visual application. Your work is storedin your own clone of the project's Git repository, and is not visible to others untilyou a) merge it to the project's Git repo, b) choose to Share it with other fortesting, or c) deploy it. A workspace also includes a pointer to the development ortest environment where you plan to deploy your app, which must be a separateVisual Builder instance (also known as an environment). You can deploy yourapp manually, or wire it up to a pipeline to do it automatically, such as when adeveloper on your project merges his or her branch to the master branch.

• The data for your visual applications can come from a database (in the form ofbusiness objects), Oracle REST services, or external REST services, just as inVisual Builder Cloud Service.

Use VB Studio to Manage Your Development CycleYou can take advantage of VB Studio features to maximize your productivity and helpyou manage and monitor every phase of your development process:


1-4

• Plan:

Manage your software development environments; use issues to track andmanage tasks, defects, and features; use Agile boards to manage and updateissues and help plan your team's workflow.

• Develop:

Use Git Repositories to version control your source code; use the VB StudioDesigner to extend Oracle Cloud Applications; and use the project's Mavenrepository to manage binary files and dependencies.

• Collaborate:

Encourage team members to use merge requests to review, critique, and approvesource code changes; use wikis to document project information; and use snippetsto share reusable pieces of source code.

• Build:

Manage project jobs and builds; use pipelines to create more sophisticatedworkflows that include deployment to testing and production environments as wellas implement continuous integration and delivery.

• Integrate with external software:

Use webhooks to integrate use event notifications with Jenkins, GitHubapplications, Slack, PagerDuty, and Oracle Social Network; and link externalDocker registries to your project.

• Import/Export project data:

Manage software releases and their build artifacts; and export and import projectdata to and from Storage containers and buckets.

• Project Management:

Configure project templates; set and implement visibility, rules, and variables;mange Git and Maven repositories; manage announcements and tags; displayfeeds; view metrics and verify the organization's Storage configuration.

The diagram shows VB Studio components that are used to manage the developmentprocess for applications other than visual applications or application extensions:

Though many users will rely on Visual Builder Studio to help them create visualapplications or create application extensions for Oracle Cloud Applications, you canuse VB Studio purely as a tool to help you manage your development processes:

• Within a single Visual Builder Studio instance, you and your team members whouse that instance are considered an organization. Within your organization, youwill likely belong to one or more projects, each of which is devoted to a discretesoftware effort. A project brings together all the tools you need to create thoseartifacts, such as a Git repository for storing your source code, a pipeline to


1-5

provide continuous integration and delivery to the Oracle Cloud, an issue trackingsystem, team wikis, and more.

• Although VB Studio provides a Git repository for you, you can choose to useexternal repos, such as GitHub and BitBucket.

How Do I Administer VB Studio?Using VB Studio's hosted development and delivery platform, you and your teamcan develop software applications using any language you choose. You can alsoextend certain Oracle Cloud Applications by creating application extensions, which aremanaged just like any other VB Studio artifact.

Before your team can use VB Studio you, as the administrator, must set it up andconfigure it. You must also add your team members to Oracle Identity Cloud Service(IDCS) and assign them proper roles.

Setting Up for Application ExtensionsIf your team plans to develop app extensions to customize certain Oracle CloudApplications, follow the steps shown here to set up VB Studio:

Here's a summary of how to set up VB Studio for developing app extensions:

To perform this action: See this: Why do I need to performthis action?

1. Get the required IDCS rolesassigned to you

Before You Begin To create and set up the VBStudio instance, you must beassigned some specific IDCSroles.

2. Create the VB Studioinstance

Create the VB Studio Instance To use any Oracle Cloudservice, you must first createan instance of the service.

3. Set up OCI or OCI Classicconnections

Connect to OCI or OCI Classic You need a connectionto OCI or OCI ClassicCompute Virtual Machines(VMs) because this is whereyour VB Studio builds will run.

Chapter 1How Do I Administer VB Studio?

1-6


4. Set Up VB Studio andassign VB Studio roles toOracle Cloud Applicationsusers

Set Up VB Studio Users To allow access to VBStudio, your Oracle CloudApplications users needadditional roles in VB Studioif they plan to create appextensions.

5. Create a project for appextension

Create a Project forApplication Extensions

To develop an app extension,you must create a VBStudio project based onthe Application Extensiontemplate.

6. Set up the project fordevelopment

Set Up the Project forDevelopment

When you create a projectbased on the ApplicationExtension template, someartifacts are created bydefault. These artifacts requireadditional configuration beforeyour team members can usethem.

a) Add Build VMs Add Build VMs Builds in VB Studio run onBuild VMs. Only VB Studioadministrators can create andmanage the Build VMs.

b) Configure the packagingand deployment jobs

Configure the Packaging Joband Configure the DeploymentJob

When you create an appextension project, certainpackaging and deploymentbuild jobs are created bydefault, but they're missingsome configuration options.You must specify themmanually.

c) (Optional) Protect themaster branch of the Gitrepository

Set Merge Restrictions on themaster Branch

By default, any projectmember can push commitsor merge another branch tothe Git repository's masterbranch. It's a good idea toset restrictions on masterto control who can makechanges to it.

7. Add Oracle CloudApplications users to theproject

Add Users to the Project To allow your team membersto access the app extensionproject, invite them to join theproject.

8. Set up the project fordeployment to test

Set Up the Project For Testing After your team members havecompleted their developmenttasks, the app extension isdeployed to your Oracle CloudApplication's test instance.

a) Add the Oracle CloudApplication's test instance toan environment

Add an Oracle CloudApplication's Instance to anEnvironment

First, create an environmentand add the Oracle CloudApplication's test instance to it.


1-7


b) Create build jobs to migrateOracle Cloud Application'scustomization data

Migrate Your Oracle CloudApplication’s Customizations

Next, migrate yourOracle Cloud Application'scustomization from thedevelopment instance to thetest instance.

c) Create the packaging anddeployment build jobs, and setup a build pipeline

Create a ProductionPackaging Build Job, Createa Production DeploymentBuild Job, and Create andConfigure a Pipeline

Then, create and configurethe packaging and deploymentjobs so that your appextensions will be promotedto your Oracle CloudApplication's test instanceautomatically.

d) (Optional) Restrict accessto the build jobs

Configure a Job's PrivacySetting

To restrict who can view thejob's configuration, edit it, orrun its build, you should markboth jobs as private.

8. Set up the project fordeployment to production

Set Up the Project to Deployto Production

You will likely want to setthings up so that afteryour team members havecompleted their developmenttasks and tested theapplication thoroughly, the appextension is deployed to yourOracle Cloud Application'sproduction instance.

a) Add the OracleCloud Application's productioninstance to an environment

Add the Oracle CloudApplication's ProductionInstance to an Environment

First, create an environmentand add the OracleCloud Application's productioninstance to it.

b) Create build jobs to migrateOracle Cloud Application'scustomization data

Migrate Your Oracle CloudApplication’s Customization

Next, migrate yourOracle Cloud Application'scustomization from the testinstance to the productioninstance.



Then, create and configurethe packaging and deploymentjobs so that yourapp extensions will bepromoted to your OracleCloud Application's productioninstance automatically.

d) (Optional) Restrict accessto the build jobs



Setting Up for Visual ApplicationsIf your team plans to develop visual applications, follow the steps shown here to set upVB Studio:


1-8

Here's a summary of how to set up VB Studio for developing visual applications:





Connect to OCI or OCI Classic You need a connection to OCIor OCI Classic Compute VMsbecause this is where your VBStudio builds will run.

3. Create a project for visualapplications

Create a Project for VisualApplications

To develop a visualapplication, you must createa VB Studio project basedon the Visual Applicationtemplate.



When you create a projectbased on the VisualApplication template, someartifacts are created bydefault. These artifacts requireadditional configuration beforeyour team members can usethem.

a) Add Build VMs Add Build VMs To run visual application'sdevelopment, test, orproduction builds, you mustcreate build jobs. Build jobs inVB Studio run on Build VMs.Only VB Studio administratorscan create and manage BuildVMs.


1-9




When you create a visualapplication project, certainpackaging and deploymentbuild jobs are created bydefault, but they're missingsome configuration options.You must specify themmanually.

5. Add users to the project Add Users to the Project To allow your team membersto access the visualapplication project, invite themto join the project.

6. Set up the project fordeployment to test

Set Up the Project for Testing You will likely want to setthings up so that afteryour team members havecompleted their developmenttasks and tested theapplication thoroughly, thevisual application is deployedto your Visual Builder testinstance.

a) Add the Visual Builder testinstance to an environment

Add a Visual Builder Instanceto an Environment

First, create an environmentand add the Visual Builder testinstance to it.

b) Create the packaging anddeployment build jobs, and setup a build pipeline

Create and Configure BuildJobs

Next, create and configurethe packaging and deploymentjobs so that your visualapplications will be promotedto your Visual Builder testinstance automatically.


Set Up the Project to Deployfor Production

You will likely want to setthings up so that afteryour team members havecompleted their developmenttasks and tested theapplication thoroughly, thevisual application is deployedto your Visual Builderproduction instance.

a) Add the Visual Builderproduction instance to anenvironment

Add the Visual BuilderProduction Instance to anEnvironment

First, create an environmentand add the Visual Builderproduction instance to it.



Next, create and configurethe packaging and deploymentjobs so that yourvisual applications will bepromoted to your VisualBuilder production instanceautomatically.

c) (Optional) Restrict accessto the build jobs




1-10

Setting Up for Other Types of ApplicationsIf your team develops applications using popular build frameworks such as Maven,Gradle, Ant, and Node.js; or uses standard infrastructure interfaces such as Docker,Kubernetes, and Terraform, follow the steps shown here to set up VB Studio:

The diagram shows how to set up VB Studio to support your development process,regardless of the nature of those applications:




2. Create the VB Studioservice instance


3. Add users to IDCS Add Users to IDCS To add your organization'smembers to Oracle Cloud, addthem to IDCS and assign themproper roles.



5. Create and manage BuildVMs

Set Up the Build System Builds in VB Studio run onBuild VMs. Only VB Studioadministrators can create andmanage the Build VMs andBuild VM templates.

6. (Optional) Set your userpreferences

Set Your User Preferences To change your display name,set an avatar image, changethe email address, or set emailnotification preferences.

Key Concepts, Components, and TermsBefore you use VB Studio, it helps to become familiar with these key concepts,components, and terms. (If you have general questions about Oracle Cloud featuresand services, see Oracle Cloud Terminology in Getting Started with Oracle Cloud.)

Term Description

Oracle CloudApplications

Oracle Cloud Applications are a set of modular Cloud-ready enterpriseapplications. To learn more, see https://www.oracle.com/applications/.

Chapter 1Key Concepts, Components, and Terms

1-11

Term Description

Application extension An artifact that allows you to extend certain Oracle Cloud Applicationsto meet your business needs.You deploy an application extension to an Oracle Cloud Application'sinstance.

Visual Builder A Visual Builder instance that provides the server for delivering pagesin web applications, and services your web and mobile apps mightuse to access data, including the database used to store data and theproxy server for managing connections to REST services.

Visual application A responsive web or native mobile application developed using VBStudio's browser-based development environment.You deploy a visual application to a Visual Builder instance.

Project A project is a collection of VB Studio features.You can use a project to host source code files, track issues,collaborate on code, build, and deploy your applications. A project canhost multiple Git repositories. Each Git repository can have multiplebranches and hundreds of code files. You can create a merge requestfor each branch of the Git repository and ask reviewers to review thecode. You can create and configure multiple build jobs to generatedifferent project artifacts that you can deploy to Oracle Cloud or youron-premise web server.

Organization The top-most entity in the project structure of VB Studio. Think ofan organization as the umbrella for all the projects in a given identitydomain.

VB Studio Designer VB Studio's browser-based development environment.

Git repository A Source Code Management (SCM) and distributed version controltool to host source code files.

Maven repository A hosted binary repository to store build artifacts, library files, anddependencies for Maven applications.

Issue tracker A built-in issue management system to create and track tasks, defects,and features.

Environment Defines the target Oracle Cloud Applications, Visual Builder, OracleCloud SaaS, or Oracle Cloud Infrastructure service instance as asingle entity. You'll define an an environment to deploy an application toa service instance or to get information from a service instance.

Merge request andcode review

A method to merge a Git repository branch with another branch. Beforemerging the branches, team members can review differences betweenfiles of both branches and provide their feedback.

Build system A built-in system to define and automate builds of your applications.

Build VM A Virtual Machine (VM) in OCI Compute, which runs project builds.Only one build can run on a Build VM at a time.

Build VM template A template that defines the operating system and the software installedon the Build VM.

Job A configuration that defines your application's builds.You can create a job to perform various actions, such as packageartifacts, run shell commands, run unit test scripts, and deployapplication artifacts.

Build The result from a job’s run.

Pipeline A path or a chain of builds. A pipeline helps you run continuousintegration jobs and reduce network traffic.

Wiki Built-in wiki system to help your team author and manage wiki pages.

Chapter 1Key Concepts, Components, and Terms

1-12

Term Description

Oracle CloudInfrastructure

Oracle Cloud Infrastructure is a set of cloud services that enableyou to build and run a wide range of applications and services ina highly available hosted environment. Oracle Cloud Infrastructureoffers high-performance compute capabilities (as physical hardwareinstances) and storage capacity in a flexible overlay virtual network thatis securely accessible from your on-premise network.

If you're new to OCI, see Key Concepts and Terminology to understandOCI concepts and terminologies.

Oracle CloudInfrastructureCompute (OCICompute) and OracleCloud InfrastructureCompute Classic (OCICompute Classic)

Service that hosts virtual machines (VMs) on Oracle Cloud with all thenecessary storage and networking resources. VB Studio uses the VMsto run project builds.

Oracle CloudInfrastructure ObjectStorage (OCI ObjectStorage) and OracleCloud InfrastructureObject StorageClassic (OCI ObjectStorage Classic)

Oracle Cloud service that hosts containers on Oracle Cloud to storeproject data. VB Studio uses the containers to archive build artifactsand Maven artifacts, and export project data.

Oracle Java CloudService

Oracle Cloud service to deploy web applications to a public OracleWebLogic Server domain on Oracle Cloud.

For more information about the service, see About Oracle Java CloudService in Administering Oracle Java Cloud Service.

Oracle ApplicationContainer CloudService

Oracle Cloud service to deploy Java SE, Node.js, PHP, Python, Ruby,Go, Java EE 7 (or later), and .NET applications to Oracle Cloud.

For more information about the service, see About Oracle ApplicationContainer Cloud Service in Using Oracle Application Container CloudService and About Your Application and Oracle Application ContainerCloud Service in Developing for Oracle Application Container CloudService.

Assign the Right RolesTo access a VB Studio project, an Oracle Cloud user must be assigned the rightOracle Identity Cloud Service (IDCS) role and a VB Studio project membership.

IDCS RolesIDCS roles define who can sign in to VB Studio.

If you're setting up VB Studio so your users can create app extensions, you'll needan additional Oracle Cloud Applications role as well. See Assign VB Studio Roles toOracle Cloud Applications Users.

There are several types of VB Studio IDCS roles, each of which has differentprivileges:

Chapter 1Assign the Right Roles

1-13

https://docs.cloud.oracle.com/iaas/Content/GSG/Concepts/concepts.htm

This VB Studiorole...

Enables a user to:

DEVCS_APP_ENTITLEMENT_ADMINISTRATOR

Create a VB Studio instance.

DEVELOPER_ADMINISTRATOR

Manage the VMs and update the organization details. The user withthis role is also called the Organization Administrator.The role is available after a VB Studio instance is created. By default,the role is assigned to the service subscriber who can assign the roleto other users.

DEVELOPER_USER Create and access VB Studio projects. All non-admin users of VBStudio must be assigned this role. The role is available after a VBStudio instance is created.Note that this role doesn't allow the user to update the organizationdetails.

Additional Roles

To access other Oracle Cloud services from VB Studio, these roles should beassigned to the appropriate users:

This role... Enables a user to:

Cloud Administrator Manage OCI resources and compartments.

JaaS_Administrator(Java Administrators)

Connect to Oracle Java Cloud Service and Oracle Java Cloud Service- SaaS Extension and deploy build artifacts.

APaaS_Administrator(APaaS Administrator)

Connect to Oracle Application Container Cloud Service and deploybuild artifacts.

Compute.Compute_Operations (ServiceAdministrator)

Create and manage VB Studio VMs on Oracle Cloud InfrastructureCompute Classic.

Storage.Storage_Administrator (ServiceAdministrator)

Create and manage containers, and export to and import project datafrom Oracle Cloud Infrastructure Object Storage Classic.

What Are the VB Studio Project Memberships?Project memberships define what users can do in a project:

This projectmembership...

Enables a user to:

OrganizationAdministrator

Access and manage all projects of the organization, and setconnections to OCI and OCI Classic.

Individuals that head up organizations and members of the ITdepartment are assigned this membership. The individual that createsthe service instance is automatically assigned this membership.


1-14

This projectmembership...

Enables a user to:

Project Owner Access all components of the project and perform project managementand administrative tasks, such as adding or removing Git repositories,managing project users, assigning default reviewers, and configuringwebhooks.

Project managers and team leaders are assigned this membership.The individual that creates the project is automatically assigned thismembership.

Developer Access most components of the project, but has restricted projectmanagement or administrative actions.

Senior developers are assigned this membership.

Limited Developer Access some components of the project, but has restricted jobconfiguration, environment management, board management, projectmanagement, and administrative actions.

Junior developers and members of the QA team are assigned thismembership.

Contributor Access the project's components in read-only mode but can entercomments, update issues, view wikis, and download build artifacts.

Usually, new developers, technical writers, and other members areassigned this membership.

Non-member Access the same things as the Contributor membership, but for sharedprojects only.


1-15

2Set Up Oracle Visual Builder Studio toManage Your Development Cycle

Like other Oracle Cloud services, you must create an instance of Oracle Visual BuilderStudio (VB Studio) before you can start using it. You can create only one instance inan Oracle Cloud account.

Before You BeginBefore you set up VB Studio, ensure that you are assigned the correct roles in OracleIdentity Cloud Service (IDCS).

You must be assigned this role: To ...

Cloud Administrator Set up Oracle Cloud Infrastructure(OCI) compartments and buckets. OCIcompartments and buckets are required to setup the VB Studio build system.If you're not assigned the role, you mustbelong to the OCI_Administrator group inOCI.

Identity Domain Administrator or UserAdministrator

Add users and assign IDCS roles.If you're not an administrator, make sure thatyour OCI group is assigned a policy like this:

Allow group MyGroup to inspectidentity-providers in tenancy


Create the VB Studio instance

DEVELOPER_ADMINISTRATOR Set up VB Studio. After you're assignedthe role, you're also called the VB Studio'sOrganization Administrator.

Compute.Compute_Operations andStorage.Storage_Administrator

Create and manage VMs on OCI ComputeClassic and store artifacts on OCI ObjectStorage Classic. The role is required only ifyou're an OCI Classic user.

Create the VB Studio InstanceYou can create one only one VB Studio instance in an Oracle Cloud account, so makesure you don't already have one before you get started.

1. In a web browser, go to https://cloud.oracle.com/sign-in.

To view the list of supported browsers, see https://docs.cloud.oracle.com/iaas/Content/GSG/Tasks/signingin.htm#supported_browsers.

2. On the Sign-In page, in Account, enter your account name and click Next.

2-1

3. On the Oracle Cloud Account sign-in page, enter your Oracle Cloud accountcredentials and click Sign In.

The Oracle Cloud Console, also called the Oracle Cloud Infrastructure console orOCI console, opens.

4. In the upper-left corner, click Navigation Menu .

5. Under More Oracle Cloud Services, select Platform Services, and then selectVisual Builder Studio.

6. In the Instances tab, click Create Instance.

7. On the Create New Instance page, in Instance, enter a unique name. InDescription, enter a description.

The name helps you to identify the service instance.

8. In Notification Email, enter your email address where you'd like to receive emailnotification when the instance is ready.

9. In Region, select your home region.

You'll find your region on the OCI console's header.

10. Click Next.

11. On the Service Details page, verify the entered details and click Next.

12. On the Confirmation page, click Create.

Expand the Instance Create and Delete History section to track the status.

Once the service instance is created, you can open the service console by clicking

Action and then selecting Access Service Instance.The VB Studio Organization page opens. Click the OCI Credentials link or the OCIAccount tab to configure OCI connections before you create a project.

Chapter 2Create the VB Studio Instance

2-2

Access VB Studio from the Oracle Cloud Home PageYou can sign in to and open VB Studio from the Oracle Cloud home page:

1. In a web browser, go to https://cloud.oracle.com/sign-in.

2. On the Sign-In page, in Account, enter your Oracle Cloud account or tenancyname and click Next.

3. On the Oracle Cloud Account sign-in page, enter your Oracle Cloud accountcredentials and click Sign In.

The Oracle Cloud Console, also called the OCI console, opens.


5. Under More Oracle Cloud Services, select Platform Services and then selectVB Studio.

6. On the Instances tab, click Manage this instance and select Access serviceinstance.

If you’re signing in to VB Studio for the first time, you should have received an emailwith the subject Verify your Oracle Visual Builder Studio email. Open the email andclick the URL link in the email body to verify your email. This is required to receiveemail notifications from the service.

After your email address is verified, you’ll receive another email with the subjectWelcome to Oracle Visual Builder Studio. This email contains the VB Studio URLthat you can bookmark.

After you sign in to VB Studio, you'll see the Organization page that displays all theprojects you're a member of, as well as your favorite projects, the projects you own,and all the shared projects in your organization.From the Organization page, you can manage all projects, OCI connections, virtualmachines, and the properties of the organization. To open a project, click its name.You can't open a project if you're not a member.

Chapter 2Access VB Studio from the Oracle Cloud Home Page

2-3

Connect to OCI or OCI ClassicYou need to connect to the Oracle Cloud Infrastructure Compute (OCI Compute) orOracle Cloud Infrastructure Compute Classic (OCI Compute Classic) because theyprovide the virtual machines (VMs) on which VB Studio runs its builds.

You need to connect to Oracle Cloud Infrastructure Object Storage (OCI ObjectStorage) or Oracle Cloud Infrastructure Object Storage Classic (OCI Object StorageClassic) because they are used to store build and Maven artifacts for VB Studioprojects.

If you're an OCI user, set up connections to OCI Compute and OCI Object Storage. VBStudio runs its builds on OCI Compute VMs, and stores build and Maven artifacts inthe OCI Object Storage buckets.

If you're an OCI Classic user, set up connections to OCI Compute Classic and OCIObject Storage Classic. VB Studio runs its builds on OCI Compute Classic VMs, andstores build and Maven artifacts in the OCI Object Storage Classic containers.

Set Up the OCI ConnectionBefore you set up the connections, set up your OCI account to host and managenecessary resources, such as VMs for your builds and storage buckets for your projectdata.

To set up the OCI account, open the OCI console and create a compartment, agroup and a user to access the compartment, and a policy that defines access to thecompartment.You can use the root compartment and the tenancy user that was created when theOCI account was created, but it's recommended to create a dedicated compartmentto host VB Studio resources. This allows you to organize VB Studio resources betterbecause they aren't mixed with the other resources of your tenancy. You can alsorestrict users and control read-write access to the compartment without affecting otherresources. To learn more about compartments, see Understanding Compartments.

After setting up your OCI account, share the compartment's and the created user'sdetails with the VB Studio Organization Administrator to set up the OCI connection inVB Studio.

Set Up the OCI Account

1. On the OCI console, in the upper-left corner, click Navigation Menu .

2. Under Governance and Administration, select Identity, and then selectCompartments.

3. On the Compartments page, create a compartment to host VB Studio resources.

a. To create the compartment in the tenancy (root compartment), click CreateCompartment.

b. In the Create Compartment dialog box, fill in the fields and click CreateCompartment.

Here's an example:

Chapter 2Connect to OCI or OCI Classic

2-4

https://docs.cloud.oracle.com/iaas/Content/GSG/Concepts/settinguptenancy.htm#two

To learn more about compartments, see Working with Compartments.

4. Create a user to access the VB Studio compartment.

a. In the left navigation menu, under Governance and Administration, clickIdentity, and then click Users.

b. Click Create User.

c. In the Create User dialog box, fill in the fields and click Create.

Here's an example:

To learn more about OCI users, see Working with Users.

5. On your computer, generate a private-public key pair in the PEM format.

To find out how to generate a private-public key pair in the PEM format, see Howto Generate an API Signing Key.


2-5

https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm

https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingusers.htm

https://docs.cloud.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#How

https://docs.cloud.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#How

Here's an example of private-public key files on a Windows computer:

6. Upload the public key to the user's details page.

a. Open the public key file in a text editor and copy its contents.

b. In the left navigation menu of the OCI console, under Governance andAdministration, click Identity, and then click Users.

c. Click the user's name created in Step 4.

d. In the User Details page, click Add Public Key.

Here's an example:

e. In the Add Public Key dialog box, paste the contents of the public key file, thenclick Add.

To learn more about uploading keys, see How to Upload the Public Key.

7. On the Groups page, create a group for the user who can access the VB Studiocompartment and add the user to the group.

a. In the left navigation menu, under Governance and Administration, go toIdentity, and click Groups.

b. Click Create Group.

c. In the Create Group dialog box, fill in the fields and click Submit.


2-6

https://docs.cloud.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#three

Here's an example:

d. On the Groups page, click the group's name.

e. On the Group Details page, click Add User to Group.

f. In the Add User to Group dialog box, select the user created in Step 4 andclick Add.

Here's an example:

To learn more about groups, see Working with Groups.

8. In the root compartment, not the VB Studio compartment, create a policy to allowthe group created in step 6 to access the VB Studio compartment.

a. In the navigation menu, under Governance and Administration, clickIdentity, and then click Policies.

b. On the left side of the Policies page, from the Compartment list, select theroot compartment.

c. Click Create Policy.

d. In Name and Description, enter a unique name and a description.


2-7

https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managinggroups.htm

e. In Policy Statements, add these statements.

• allow group <group-name> to manage all-resources in compartment<compartment-name>This grants all permissions to the VB Studio group users to manage allresources within the VB Studio compartment.

• allow group <group-name> to read all-resources in tenancyThis grants read permissions to the VB Studio group so that its users canread—but not use, create or modify—all resources inside and outside theVB Studio compartment. The group users can't use, create, or modify theresources.

Here's an example:

f. Click Create.

To learn more about policies, see Working with Policies.

Get the Required OCI Input ValuesEvery Oracle Cloud Infrastructure resource has an Oracle-assigned unique ID calledan Oracle Cloud Identifier (OCID).

To connect to OCI, you need the account's tenancy OCID, home region, the OCID ofthe compartment that hosts VB Studio resources, and the OCID and the fingerprint


2-8

https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingpolicies.htm?Highlight=create%20a%20policy#two

of the user who can access the VB Studio compartment. To connect to OCI ObjectStorage, you need the Storage namespace. You can get these values from the OCIConsole pages.

This table describes how to get the OCI input values required for the connection.

To get thesevalues ...

Do this:

Tenancy OCID, HomeRegion, and StorageNamespace

Open the OCI console. In the navigation menu, under Governanceand Administration, select Administration, and then select TenancyDetails.The Tenancy Information tab displays the tenancy OCID in OCID, thehome region in Home Region, and the storage namespace in ObjectStorage Namespace.

Here's an example:


2-9


Do this:

User OCID andFingerprint

Open the OCI console. In the navigation menu, under Governanceand Administration, select Identity, and then select Users. On theUsers page, click the user's name.The User Information tab displays the user OCID in OCID. Click theCopy link to copy it to the clipboard.

Here's an example of vbstudio.user:

To get the fingerprint of the public key associated with your OCIaccount, scroll down to the API Keys section and copy the fingerprintvalue.


2-10


Do this:

Compartment OCID Open the OCI console. In the navigation menu, under Governanceand Administration, select Identity, and then select Compartments.On the Compartments page, click the compartment's name.The Compartment Information tab displays the compartment's OCIDin OCID. Click the Copy link to copy the compartment's OCID to theclipboard.

Here's an example:

Set Up the OCI Connection in VB StudioTo connect to OCI, get the VB Studio compartment's details, user details, and therequired OCID values. Then, create an OCI connection from VB Studio. If you're notthe OCI administrator, get the details from the OCI administrator.

1. In the navigation menu, click Organization .

2. Click the OCI Account tab.

3. Click Connect.

4. In Account Type, select OCI.

5. In Tenancy OCID, enter the tenancy's OCID copied from the Tenancy Detailspage.

6. In User OCID, enter the OCID of the user who can access the VB Studiocompartment.

7. In Home Region, select the home region of the OCI account.

8. In Private Key, enter the private key of the user who can access the VB Studiocompartment.

The private key file was generated and saved on your computer when you createdthe private-public key pair in the PEM format. See Step 5 in Set Up the OCIAccount.

9. In Passphrase, enter the passphrase used to encrypt the private key. If nopassphrase was used, leave the field empty.

10. In Fingerprint, enter the fingerprint value of the private-public key pair.


2-11

11. In Compartment OCID, enter the compartment's OCID copied from theCompartments page.

12. In Storage Namespace, enter the storage namespace copied from the TenancyDetails page.

13. To agree to terms and conditions, select the terms and conditions check box.

14. To validate the connection details, click Validate.

15. After validating the connection details, click Save.

Here's an example of an OCI Account tab filled with required OCI details.

Set Up the OCI Classic ConnectionTo connect to OCI Classic, you need the credentials of a user withthe Compute.Compute_Operations and Storage.Storage_Administrator identitydomain roles along with the service ID and Authorization URL of OCI Object StorageClassic.

The Compute.Compute_Operations role enables you to create, update, anddelete VMs on OCI Compute Classic. The Storage.Storage_Administrator roleenables you to store artifacts on OCI Object Storage Classic.

Before you create the OCI Compute Classic connection, you must check theCompute_Operations Role: Terms of Use and get the Service ID and the authorizationURL of OCI Object Storage Classic:

Get OCI Object Storage Classic Input Values1. Open the Oracle Cloud Dashboard.


2-12

2. In the Storage Classic tile, click Action and select View Details.

If the Storage Classic tile isn’t visible, click Customize Dashboard. UnderInfrastructure, find Storage Classic, click Show, and then close the CustomizeDashboard window.

3. On the Service Details page, in the Additional Information section of theOverview tab, note the values of the Auth V1 Endpoint URL and the last partof the REST Endpoint URL.

If you’re using an Oracle Cloud traditional account, the fields shown in this graphicmight differ from the fields on your Service Details page.

Create an OCI Classic Connection from VB StudioAfter you have the required values, create an OCI Classic connection from VB Studio.

1. Sign in to VB Studio.


3. Click the OCI Account tab.

4. To create a connection, click Connect. To edit the connection details, click Edit.

5. In Account Type, select OCI Classic.

6. In the OCI Object Storage Classic section, fill in the required details.

a. In Service ID, enter the value copied from the last part of the REST EndpointURL field of the Service Details page.

For example, if the value of the REST Endpoint URL is https://demo12345678.storage.oraclecloud.com/v1/Storage-demo12345678, thenenter Storage-demo12345678.

b. In Username and Password, enter the credentials of the user assigned theStorage.Storage_Administrator identity domain role.

c. In Authorization URL, enter the URL copied from the Auth V1 Endpoint fieldof the Service Details page.

Example: http://storagetria01234-usoracletria12345.storage.oraclecloud.com/auth/v1.0.

d. Click Validate.

7. In the OCI Compute Classic section, fill in the required details.

a. In Username and Password, enter the credentials of the user who’s assignedthe Compute.Compute_Operations identity domain role.

b. To agree to terms and conditions, select the terms and conditions check box.

c. Click Validate.


2-13

8. Click Save.

Compute_Operations Role: Terms of UseHere are some special legal terms and guidance that apply to the usage of theCompute_Operations role for VB Studio.

In addition to these VB Studio terms, you should follow security best practices inmaintaining the security of the username and password.

• You must create a dedicated username and password for use by VB Studio. Whencreating a username, avoid including personal names or personal information (likebirthdays). Your password should always be complex and impossible to guess.

• You understand that a user with the Compute_Operations role can view, create,update and delete OCI Compute Classic resources such as VM instances, storagevolumes, security rules, and security IP lists. Your failure to maintain securitybest practices to secure the username and password of the user with theCompute_Operations role may create a high risk for you and your organization.

• You should assign the Compute_Operations role privileges only to the usernamecreated for VB Studio.

• Notwithstanding VB Studio terms, you acknowledge that Oracle isn’t responsibleor liable for any action you take in accessing or creating access to the VB Studioor OCI Compute Classic.

Set Up the Build SystemVB Studio builds run on OCI Virtual Machines (VMs), also called as Build VMs. TheBuild VMs run in a public subnet of an OCI Virtual Cloud Network (VCN). Before yourorganization’s members can run builds, you must set up a VCN to run Build VMs,create Build VM templates, and then allocate Build VMs to those templates.

If you're new to OCI Networking, see Overview of Networking to learn about OCInetworking concepts such as VCN and subnets.

What Are Build VMs and Build VM Templates?A Build Virtual Machine (VM) is an OCI Compute or OCI Compute Classic VM thatruns builds of jobs defined in VB Studio projects. A Build VM Template defines theoperating system and software installed on Build VMs.

Before your organization's members create jobs and run builds, you should first createBuild VM templates with software that the organization's members use. After creatingthe templates, allocate Build VMs to each Build VM template.

When you define a Build VM template, you specify:

• The VM's operating systemYou can choose from Oracle Linux 6 and Oracle Linux 7.

• Software and their versionsTo find the list of software packages and their versions available in VB Studio, seeSoftware Installed on the Build Executor.

When you add a Build VM, you specify:

Chapter 2Set Up the Build System

2-14

https://docs.cloud.oracle.com/en-us/iaas/Content/Network/Concepts/overview.htm

• The Build VM templateWhen a Build VM starts, VB Studio installs the operating system and the softwareyou've defined in the template on the VM.

• The VM's OCI regionOracle Cloud Infrastructure is hosted in regions and availability domains. A regionis a localized geographic area, and an availability domain is one or more datacenters located within a region. Remember, a Build VM is a VM on OCI Compute.To learn more about regions and availability domains, see Regions and AvailabilityDomains.

• The VM's shapeA shape is a template that determines the number of CPUs, amount of memory,and other resources allocated to a newly created instance. To learn more aboutshapes, see VM Shapes.

• The VM's Virtual Cloud Network (VCN)A VCN is a software-defined network that you set up in the Oracle CloudInfrastructure data centers in a particular region. To find more about VCNs andsubnets, see VCNs and Subnets.

When the organization's members create jobs, they simply associate the appropriateBuild VM template with each job. The Build VM starts automatically when a build runson it and stops after its sleep timeout period. You can manually start and stop it too.

When a build runs:

1. The build executor checks the job's Build VM template and then looks for the VMthat's allocated to the template:

• If a VM is available, the build executor immediately runs the build on the VM.

• If all VMs are busy running builds of other jobs using the same Build VMtemplate, the build executor waits until a VM becomes available and then runsthe current job's build on it.

• If a VM doesn't exist, the build executor reports an error.

2. If the build runs on a VM for the first time or after a VM wakes up after its sleeptimeout period, the build executor installs the software defined in the Build VMtemplate before it runs the build. This takes time.

3. Depending on how the job is configured, after installing the software, the executorclones the job’s Git repositories to the VM, runs the defined build steps, createsartifacts, and performs post-build steps.

4. After the build completes, the executor copies any generated artifacts to the OCIObject Storage bucket or the OCI Object Storage Classic container.

5. The Build VM waits for a period of time for any queued builds. If no builds run inthe wait time period, the Build VM uninstalls its software and stops.

Build VMs in Virtual Cloud NetworkA Build VM runs in a Virtual Cloud Network (VCN). You can run Build VMs in the VBStudio's default VCN, or in your VCN.

If you don't have a VCN or want to use the default option without any additionalconfiguration, use the VB Studio default VCN. If you want Build VMs to accessservices that are running in your VCN, then run Build VMs in your VCN.


2-15

https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm


https://docs.cloud.oracle.com/iaas/Content/Compute/References/computeshapes.htm#VMShapes

https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVCNs.htm

Use VB Studio's Default VCNIf you don't have a VCN, you should use VB Studio's default VCN to run your BuildVMs.

VB Studio's default VCN resides in the compartment you created and configured in SetUp the OCI Connection. When a Build VM that uses the default VCN starts, VB Studiocreates a VCN called dcs-slave-vcn with CIDR block 10.0.0.0/16.

When VB Studio creates the default VCN, it also creates these components and addsthem to the VCN:

• An Internet Gateway

• A Route Table that uses the Internet Gateway as the routing rule

• A Security Rule with these rules:

– Ingress: Allow TCP traffic on destination port 22 (SSH), 9003 (Executor agentdebug), 9005 (VM agent debug), 9082 (Executor agent), and 9085 (VM agent)from source 0.0.0.0/0 and any source port.

– Egress: To any destination from any protocol

• Three subnets, one for each availability domain. Their CIDR is set to 10.0.0.0/24,10.0.1.0/24, and 10.0.2.0/24.

As soon as the default VCN is available, you have full control over it and canmodify it. You can add private subnets for your private services, add more publicsubnets or delete the existing subnets, modify security lists, and add or remove othercomponents.

Note:

• If you modify the default VCN, make sure that at least one public subnetis available in the VCN. If there are no public subnets, Build VMs in thedefault VCN won't run and your builds will fail.

• The default VCN is created once and continues to stay until it is deletedmanually.

• If your organization's members configure jobs that access services in theprivate or public subnets of the VCN, ask them to configure their jobs toaccess the services using private IPs or Fully Qualified Domain Name(FQDN).

Run Build VMs in Your VCNIf you run Oracle Cloud services in your VCN, you should configure your VCN to runVB Studio Build VMs so your services and Build VMs are in the same VCN. This letsBuild VMs access your Oracle Cloud services easily without any complex networkingconfiguration.

Before you configure your VCN, make a note of these:


2-16

• In your VCN, create a public subnet or configure an existing public subnet to allowinbound access from and outbound access to VB Studio.

• When you're creating or configuring a public subnet, make sure it is regional.

• Instead of modifying an existing security list's security rules, you should create anew security list for the public subnet.For the public subnet, create a security list and add ingress rules from sourceCIDR 0.0.0.0/0 for VB Studio ports 22 (SSH), 9082 (Executor Agent), and 9085(VM Agent). This is required to allow VB Studio access the Build VMs in yourVCN.

• If your VCN isn't in the same compartment that VB Studio is in, make sure thatthe user whose OCID you've specified in Set Up the OCI Connection in VB Studiois assigned the use virtual-network-family policy for the VCN's compartment.This is required for networking permissions and builds to run in your VCN. Thisstatement assigns the policy to the user's group:allow group <group-name> to use virtual-network-family in compartment<vcn-compartment-name>

Here's an example of the use virtual-network-family policy added to thepolicies you created in Set Up the OCI Account.

• Make sure that your VCN has a route table with a rule that allows Internet access.


2-17

• To allow Build VMs access your private subnet's services and resources, configurethe private subnet's security rules to allow incoming traffic from the public subnetused by Build VMs.

• After adding Build VMs to your VCN, ask your organization's members to configuretheir build jobs to use the private IP addresses or the Fully Qualified DomainName (FQDN) of services that are running in the VCN.Tell them not to use public IP addresses, because when Build VMs are in thesame VCN as the service, public IP addresses will route the traffic outside theVCN, causing builds to fail.

Build VMs run in a VCN's public subnet. This table describes what you need to do ifyou have a VCN.

If ... Then :

You have a VCN without a public subnet 1. Create and Configure a Public Subnet inYour VCN.You'll also configure the subnet's securitylist to allow inbound access from andoutbound access to VB Studio.

2. To allow Build VMs access a servicerunning in your private subnet, configurethe private subnet's security list. SeeAllow Build VMs to Access Your PrivateVCN Resources.

3. Add and Manage Build VMs in your VCN.

You have a VCN with a public subnet 1. In your VCN, create a security listwith ingress rules and egress rules, asdescribed in steps 6-11 of Create andConfigure a Public Subnet in Your VCN.

2. Open your public subnet's details pageand add the security list. See 13 of Createand Configure a Public Subnet in YourVCN.

3. To allow Build VMs access servicesrunning in your private subnet, configurethe private subnet's security list. SeeAllow Build VMs to Access Your PrivateVCN Resources.



2-18

If ... Then :

You don't have a VCN and want to create one 1. Use the VCN wizard to create a VCN witha public subnet and an internet gateway.See Virtual Networking Quickstart.

2. Create and Configure a Public Subnet inYour VCN.You'll also configure the subnet's securitylist to allow inbound access from andoutbound access to VB Studio.

3. To allow Build VMs access servicesrunning in your private subnet, configurethe private subnet's security list. SeeAllow Build VMs to Access Your PrivateVCN Resources.


Create and Configure a Public Subnet in Your VCNBefore you can run Build VMs in your VCN, you must first create a public subnet inyour VCN with security rules that allow inbound access from and outbound access toVB Studio.

1. Sign in to Oracle Cloud Console.


3. Under Core Infrastructure, select Networking, and then select Virtual CloudNetworks.

4. Under List Scope, select the compartment.

5. From the VCNs list, click the VCN's name.

6. Under Resources, click Security Lists, and then click Create Security List.

7. In Name, enter a name for the security list.

8. In Create in Compartment, ensure that the correct compartment is selected.

9. In Allow Rules for Ingress, click + Additional Ingress Rule and follow thesesteps:

a. In Source Type, select CIDR.

b. In Source CIDR, enter 0.0.0.0/0.

c. In Destination Port Range, enter 9082.

d. (Optional) In Description, add a description.

Here's an example:


2-19

https://docs.cloud.oracle.com/en-us/iaas/Content/Network/Tasks/quickstartnetworking.htm

e. Click + Additional Ingress Rule and repeat steps from 9.a to 9.d to add ports9085 and 22.

10. In Allow Rules for Egress, click + Additional Egress Rule and follow thesesteps:

a. In Source Type, select CIDR.

b. In Source CIDR, enter 0.0.0.0/0.

c. In IP Protocol, select All Protocols.

d. (Optional) In Description, add a description.

11. Click Create Security List.

After creating the security list, click its name to verify the ingress and egress rulesyou added.Here's an example of ingress rules:

Here's an example of the egress rule:


2-20

12. Under Resources, select Subnets and follow these steps to create a publicsubnet:

If you want to edit an existing public subnet, jump to the next step.

a. Click Create Subnet.

b. In Name, enter the subnet's name.

c. In Subnet Type, make sure that Regional is selected.

d. In CIDR Block, enter the subnet's CIDR block.

Don't set it to 172.17.0.0/16 as it's the default subnet allocated to Docker.

e. In Route Table, select the VCN's route table.

f. In Subnet Access, make sure that Public Subnet is selected.

g. In DHCP Options, select the VCN's DHCP options.

h. In Security List, select the security list you created in Step 6.

i. Fill in the other fields.

Here's an example:


2-21


2-22

j. Click Create Subnet.

13. If you want to edit an existing subnet, follow these steps:

a. Under Resources, select Subnets and click the public subnet's name.

b. Click Add Security List.

c. In the Add Security List dialog box, in Security List, select the security list youcreated in Step 6.

d. Click Add Security List.

That's it. After creating or editing the public subnet, your Build VMs can now run inyour VCN.

Allow Build VMs to Access Your Private VCN ResourcesAfter adding a public subnet in your VCN, if you want Build VMs to access theresources and services (such as Java Cloud Service or a VM-based Database)running in the VCN's private subnet, configure the private subnet's security rules toallow incoming traffic from the public subnet used by Build VMs.

For example, to allow Build VMs access Java Cloud Service running in a privatesubnet, configure the subnet's security list to add the Build VMs CIDR ranges to theIngress rule associated with the JCS Admin port.

1. Sign in to Oracle Cloud Console.


3. Under Core Infrastructure, select Networking, and then select Virtual CloudNetworks.

4. On the Virtual Cloud Networks page, click the VCN.

5. Under Resources, click Security Lists, and then click the private subnet'ssecurity list.

6. Click Add Ingress Rules.

If you want to modify an existing rule, click the Actions icon (three dots), and thenselect Edit.

7. In Source Type, select CIDR.

8. In Source CIDR, enter the Build VMs public subnet's CIDR range.

9. In Destination Port Range, enter the service's port number.

10. (Optional) In Description, add a description.

Here's an example of Java Cloud Service port 7002 with a source CIDR of10.0.4.0/24:


2-23

11. Click Add Ingress Rules.

12. If required, repeat steps from 6 to 11 for each service's port.

Create and Manage Build VM TemplatesYou can create and manage Build VM templates from the VM Templates page inOrganization Administration.

Action How To

Create a Build VMtemplate 1. In the navigation menu, click Organization .

2. Click the Virtual Machines Templates tab.

3. Click + Create Template.

4. In the New VM Template dialog box, enter a name and descriptionof the VM template. In Platform, select the operating system torun on the VM.

5. Click Create.


2-24

Action How To

Configure a VMtemplate’s software 1. In the navigation menu, click Organization .


3. Select the template and click Configure Software.

4. If necessary, in Filter Software Packages, enter the search termand click the Search icon.

To see the latest version of the software, select the Show latestversions only check box. This is helpful if multiple versions of thesame software are available in the catalog.

5. In the Software Catalog, click Add .

If a software is dependent on another software, a messageinforms you about the dependencies that must be added alongto use the software.

6. Click Done.

Edit a VM template'sname or description 1. In the navigation menu, click Organization .


3. Select the template and click Edit.

4. In the Edit VM Template dialog box, update the name ordescription.

5. Click Save.

Delete a VM template When you delete a VM template, its Build VMs are deleted too.



3. Select the template and click Delete .

4. In the Delete VM dialog box, click Yes to confirm.


2-25

Add and Manage Build VMsWhen you add a Build VM, you allocate a VM on the linked OCI Compute or OCICompute Classic to run builds of jobs.

Tip:

To minimize build execution delays, set the number of VMs of a specific BuildVM template to the number of jobs that you expect to run in parallel usingthat template. If the VM quota is available, that number of Build VMs will beadded to the Virtual Machines tab.

You should also make sure that all VMs of a specific Build VM templaterun in the same VCN. If you add VMs in different VCNs, your builds mightbehave unpredictably.

You can always return to the Virtual Machines tab to add or remove VMs,based on your actual usage. Note that the more VMs you have running at aspecific time, the higher the cost. To minimize the higher cost, use the SleepTimeout setting on the Virtual Machines page to automatically shut downinactive VMs.

Each build runs in one build executor, or one VM. You can build up to 99 builds inparallel using the same Build VM template.

To add Build VMs, you'll need these details:

• Build VM template's name that defines the software to be installed on Build VMs.Make sure that the template has the correct software.

• OCI region where you have authorization to add Build VMs. To learn more aboutregions and availability domains, see Regions and Availability Domains.

• VM's shape. To learn more about shapes, see VM Shapes.

• VM's VCN, if you want to run it in another VCN than the VB Studio's default VCN.To find more about VCNs and subnets, see VCNs and Subnets.

Action How To

Find VMs that use aparticular template 1. In the navigation menu, click Organization .

2. Click the Virtual Machines tab.

3. From the Sort By list, select Template to sort the VMs in theBuild VMs tab.

4. Scroll down and search the list for the template's name.

You might find multiple VMs that use the same VM template.


2-26




Action How To

Add a Build VM inthe VB Studio's defaultVCN



3. Find whether any VMs that use the VM template already exist.If you don't find VMs using the VM template, jump to Step 4. Ifyou find one or more Build VMs that uses the VM template, followthese steps:

a. In the Details column of the Build VM, click Show Machine

Details .

b. Note the VCN's name.Here's an example:

The VM's name is displayed for VMs that are in the Availablestate. If the VM is in the Stopped or the Pendingstate, start

it. Click and select Start.

If the VCN's name isn't dcs-slave-vcn, delete the VM oruse another VM template. You should not add Build VMs todifferent VCNs that use the same Build VM template.

To delete the VM, click and select Delete.

4. In the Build VMs tab, click + Create VM.

5. In the Add Build VM dialog box, in Quantity, specify the number ofVMs you want to allocate.

6. In VM Template, select the Build VM template.

7. In Region, specify the VM's region.

8. In Shape, select the VM's shape.

9. In VCN Selection, select Default.


2-27

Action How To

10. Click Add.

After adding Build VMs, you can configure the jobs to use the VMtemplate.


2-28

Action How To

Add a Build VM inyour VCN

Before you add a VM, make sure that you've added a public subnet inyour VCN. See Create and Configure a Public Subnet in Your VCN.


2. In the Virtual Machine Templates tab, make sure that the BuildVM template has the correct software.


4. Find whether any VMs that use the VM template already exist.If you don't find VMs using the VM template, jump to Step 4. Ifyou find one or more Build VMs that uses the VM template, followthese steps:

a. In the Build VM's Details column, click Show Machine

Details .

b. Note the VCN's name.Here's an example:

The VM's name is displayed for VMs that are in the Availablestate. If the VM is in the Stopped or the Pendingstate, start

it. Click and select Start.

If the VCN is different from your VCN, delete the VM oruse another VM template. You should not add Build VMs todifferent VCNs that use the same Build VM template.

To delete the VM, click and select Delete.

5. In the Build VMs tab, click + Create VM.

6. In the Add Build VM dialog box, in Quantity, specify the number ofVMs you want to allocate.

7. In VM Template, select the Build VM template.


2-29

Action How To

8. In Region, specify the VM's region.

9. In Shape, select the VM's shape.

10. In VCN Selection, select Custom.

11. In VCN Compartment, select the compartment.

12. In VCN, select the VCN.

13. In Subnets, select a subnet. The list shows public subnets only.You can add multiple public subnets. If VB Studio can't create aBuild VM on the first subnet you've added, it tries to create it onthe second subnet, and so on.

14. Click Add.

After adding Build VMs, you can configure the jobs to use the VMtemplate.

View a Build VM’s log The Build VM’s log has entries for all events along with informationabout when the events occurred, the type of event, and event details.



3. In the Build VMs tab, select the VM, click Actions and selectDisplay Log.

4. In the Provisioning Log window, review the log.

To download the log file to your computer, click Download Log.

Start or stop a VMmanually

When a build of a job triggers, its VM starts automatically if it wasin the stopped state. It takes some time to start a VM, and the usermust wait for a VM to start before the job's build runs on it. Similarly, aVM stops automatically if no builds run on it during the sleep timeoutperiod.At times, you may want to manually start a VM before triggering a job'sbuild or stop it to free resources immediately.



3. In the Build VMs tab, select the VM, click Actions and selectStart or Stop.


2-30

Action How To

Delete a Build VM When you delete a Build VM, it waits for all builds running on it tocomplete and won't accept new builds while it’s waiting for the runningbuilds to complete. After all the builds are complete, it shuts down andis removed.



3. In the Build VMs tab, select the VM, click Actions and selectDelete.

To delete multiple VMs, select them using the Ctrl or Shift keys,click Update Selected and select Delete Selected VMs.

The deleted VMs are listed in the Deleted VMs tab.

Change the sleeptimeout of all VMs

The sleep timeout defines the duration (in minutes) a VM would beavailable in the active state if no builds run on it. By default, it is 1500minutes.



3. Click Sleep Timeout.

4. In the Sleep Timeout dialog box, change the timeout duration, andclick Save.

Add Users to IDCSTo add users to VB Studio and its projects, make sure they are added to IDCS andassigned appropriate VB Studio roles.

If you want to federate with your existing identity provider, see Federating with IdentityProviders.

To add users manually to IDCS, follow these steps:

1. Open the Oracle Cloud Console page.


3. Under Governance and Administration, select Identity, and then selectFederation.

4. On the Federation page, click the identity service provider's link.

5. On the Identity Provider Details page, click Create IDCS User.

6. In the Create IDCS User dialog box, enter the new user's details and click Create.

7. To send the password reset instructions and URL to the new user, click EmailPassword Instructions.

8. Click close.

9. On the Identity Provider Details page, click the user's IDCS Username link.

10. On the User Details page, click Manage Service Roles.

Chapter 2Add Users to IDCS

2-31

https://docs.cloud.oracle.com/en-us/iaas/Content/Identity/Concepts/federation.htm

https://docs.cloud.oracle.com/en-us/iaas/Content/Identity/Concepts/federation.htm

11. On the Manage Service Roles page, search for the service with DeveloperCloud Service description, click the Actions icon (three dots) and select ManageInstance Access.

12. On the Manage Access page, in the Instance Role column, select the role youwant to grant to the user.Assign the DEVELOPER_ADMINISTRATOR role to users who can administer VBStudio. Assign the DEVELOPER_USER role to other non-admin users. A usermust be assigned one of these two roles to access VB Studio.

13. Click Save Instance Settings.

14. On the Manage Service Roles page, click Apply Role Settings.

For more details about adding users to IDCS and assigning them roles, see ManagingOracle Identity Cloud Service Users in the Console and Managing Instance Roles inthe Console. To learn more about VB Studio IDCS roles, see IDCS Roles.

Manage the OrganizationYou can update your VB Studio organization’s name or description, manage projects,manage virtual machines (VM) and VM templates, and view the usage metric ofprojects.

Update the Organization’s Display Name and DescriptionBy default, the organization's display name is <your_vbstudio_instance_name>-<your_oracle_account_name>.


2. Click the Properties tab.

3. In Name, edit the organization name.

4. In the Confirm Organization Name Change dialog box, click Yes.

5. In Description, if necessary, enter or edit the organization's description.

Set the Organization’s Default Wiki Markup LanguageWhen you create a project, the project creation wizard displays the organization'sdefault wiki markup language. If you don’t change the wiki markup language, thedefault markup language is used as the project’s markup language. You can changethe default markup language for new projects, but note that existing projects continueto use their original markup language.


2. Click the Properties tab.

3. In Markup Language, select the default wiki markup language.

Chapter 2Manage the Organization

2-32

https://docs.cloud.oracle.com/en-us/iaas/Content/Identity/Tasks/addingidcsusersandgroups.htm#manageusers

https://docs.cloud.oracle.com/en-us/iaas/Content/Identity/Tasks/addingidcsusersandgroups.htm#manageusers

https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managinguserrolesidcs.htm#ManagingInstanceRolesintheConsole

https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managinguserrolesidcs.htm#ManagingInstanceRolesintheConsole

Manage Projects of the OrganizationAs the Organization Administrator, you can access and manage all projects. You canassign a project’s Project Owner role to yourself, delete a project, revoke the project'sdeletion, or postpone the project's deletion by a few days.


2. Click the Projects tab.

Example:

Here are the project management actions you can perform:

Action How To

Create a project Click + Create.See Create a Project.

Open a project In the Name column, click the project name.See Open a Project.

You can open a project only if you're a member or an owner. Projectswhere you aren't a member or an owner don't appear as links. Youcan't open a project that's in the deleted state.

Search for a project Use the search box above the projects list.

Filter projects In Member/Owner/Favorite/All, click a filter option to enable it.

Click the Member button to view projects where you're a member.Click Owner to view projects where you're a Project Owner. ClickFavorite to view your favorite projects. Click All to view organization'sall projects.To see more filter options, click Detailed Filter .


2-33

Action How To

Mark a project as afavorite

In the Favorite column, click Favorite to add it to your favorites list.

View a project's teammembers

The Members column shows the gravatars of the project's teammembers. A blue circle around a user's gravatar indicates the user isassigned the project's Project Owner role. Click the gravatars to displaynames and email addresses of all team members.

Assign a project’sProject Owner role toyourself

You can assign a project’s Project Owner role to yourself. This isusually helpful in a case when all project's owners are removed orhave left the organization. As the Organization Administrator, you canthen take the ownership of such projects and then assign the ProjectOwner role to another project user.

For the project whose ownership you want to assign to yourself, click

Update Project and select Assign Me as Owner.

Delete a project As the Organization Administrator, you can delete any project.

1. For the project you want to delete, click Update Project andselect Delete.

2. In the Delete Project dialog box, click Delete.

The project’s State is marked as Deleted - Project will beremoved automatically in N days., but the project isn’t removedimmediately. In the Delete Project dialog box, read the message beforeyou click Delete. Also, check the project’s delete message to knowwhen the project will be permanently removed. To immediately remove

the project permanently, click and select Remove Forever.

Postpone a deletedproject's removal

At times, you may be unsure if you want to revoke a project's deletionthat’s close to its permanent removal date. For such projects, you canchoose to postpone their removal by a few days.

For the deleted project you want to postpone, click Update Project and select Postpone Removal.

The project’s permanent removal date is rescheduled and themessage is displayed at the top. In Status, check the project’s deletemessage to know when the project will be permanently removed.

Undelete a project When you undelete a project, you get an option to update the nameand description of the project. When the deletion is revoked, theproject URLs will change if a different name of the deleted project isspecified.

1. For the deleted project you want to undelete, click Update Project

and select Undelete.

2. In the Undelete Project dialog, if necessary, update the projectname in Name, and update the description in Description.

You would have to change the project name if another project withthe same name was created after this project was deleted.

3. Click Undelete.


2-34

Action How To

Select multipleprojects

You can select multiple projects and perform a common action onthem.

1. If necessary, filter and sort the projects as desired.

2. Press the Ctrl key or the Shift key and select project rows.

To select all projects, click the check box to the left of the Namecolumn header.

3. Click Update Selected and select the desired action from themenu.

Some options, such as Undelete, are not available in the UpdateSelected menu.

View usage metrics ofprojects

Next to the Detailed Filter , review the projects and the disk usagemetrics of the organization.

For each project, the Disk Usage column shows the project's diskusage and its usage percentage with respect to the total disk usage ofall projects. Click the number to open a pop-up with details of usage byeach service in the project.

Manage Your Development CycleAfter setting up VB Studio and adding users to IDCS, you should learn and then guideyour organization's members about the development cycle in VB Studio.

To find out more about VB Studio and its projects, see Get Started in Managing YourDevelopment Process with Visual Builder Studio. Learn about how to create a project,administer a project, add users to it, create and manage issues and Agile boards,review source code with merge requests, create and manage build jobs and pipelines,and use other features of VB Studio.

Set Your User PreferencesYou can set your preferences, including your display name, email address, gravatar,and email notifications, from the User Preferences page.

To get to this page, click the user avatar and select Preferences:

Chapter 2Manage Your Development Cycle

2-35

Update Your Display NameBy default, VB Studio displays your Oracle Cloud account name as your display nameacross all pages. If you want to change it, you can do so from the User Preferencepage’s Profile tab:

1. On the User Preferences page, click the Profile tab.

2. In First Name and Last Name, update your name.

The name is saved when the focus moves out of the field.

3. To the left of the User Preferences title, click Close to return to the last openedpage.

Update Your Email AddressBy default, VB Studio displays your Oracle Cloud email address across all pages andsends email notifications, such as merge request notifications and issue notifications,to this email address.

If you want VB Studio email notifications sent to another email address, you canchange it on the User Preference page’s Profile tab:

• If you’re using an email address as your Oracle Cloud login username, youroriginal Oracle Cloud email address continues to be your login username evenafter you change your email address preference.

• After you provide another email address, you’ll receive a verification email. It'simportant that you take the time to verify the new email address because, if youdon't, you won't receive any VB Studio email notifications. You can, however,continue to use VB Studio.

Here's how to change the email address that email notifications will be sent to:

1. On the User Preferences page, click the Profile tab.

2. In the Email Address field, enter your new email address.

The email address is saved when the focus moves out of the field.

3. Click the Re-send email button.

4. In the email that you receive, click the confirmation link to confirm the emailaddress.

After the verification, you’re redirected to the service page.

5. Open the Profile tab again and verify that the Email Address field displays theVerified label.


Add Your Avatar PictureVB Studio displays your Gravatar picture as the avatar picture. If you don’t have apicture set in Gravatar or don’t have a Gravatar account, VB Studio displays your


2-36

initials instead of your avatar picture. To find out more about Gravatar, see https://gravatar.com/.

Here's how to create a Gravatar account and upload your Gravatar picture:

1. Open http://en.gravatar.com/ in your browser.

2. Click Create Your Own Gravatar.

3. Follow the on-screen instructions, enter the required details, and sign up.

Create your account with the same email address that you used to subscribe toOracle Cloud.

4. After activating your account, sign in to Gravatar.

5. Upload the avatar picture to your Gravatar account.

The picture uploaded to your Gravatar account is automatically displayed as youravatar picture in VB Studio.

Configure Your Global Email NotificationsYou can configure your preferences to receive email notifications when a component,such as an issue or a Git repository's branch that you’re subscribed to is updated.Your preferences apply to all projects in which you are a member. Note that you mustrespond to the verification email you'll receive if you want to receive VB Studio emailnotifications.

Here's how to set your preferences for email notifications.

1. On the User Preferences page, click the Notifications tab.

2. Select or deselect the Notify Me Of check boxes.

Some check boxes are selected by default. For a selected component, itsnotifications from all projects of the organization where you’re a member areenabled. You must subscribe or set up a watch on the component to getnotifications about its updates:

Select this checkbox ...

To receive email notifications about:

Issue updates,attachments andcomments

Issues you’re assigned to, or you’re watching.

Merge Requestupdates andcomments

Merge requests where you’re a reviewer, or you’re watching.

New features, tips,and events

New features, tips, and events from the VB Studio team.

Service and systemmaintenanceupdates

Service and system maintenance updates from the VB Studioteam.

Build activities Jobs you’re watching.

SCM/PushActivities

Git repository branches you’re watching.

Wiki page updatesand comments

Wiki pages you’re watching.


2-37

Select this checkbox ...

To receive email notifications about:

Project Updates User updates when you or a user is added to or removed from aproject, or the project role is changed.

Include my OwnUpdates

Your own changes.

If you don’t select the check box, you won’t receive emailnotifications for issues, merge requests, and Git updates that youinitiated or created even though the Issues updates, attachmentsand comments, the Merge Request updates and comments, orthe SCM/Push Activities check boxes are selected.


Upload Your Public SSH KeyBefore you can connect to a Git repository using SSH, you must first generate aprivate-public RSA SSH key pair and upload the public key to VB Studio. If you usemultiple computers to access Git repositories, you'll need to generate an SSH key pairfrom each computer and upload its public key.

Generate an SSH KeyTo generate an RSA SSH key pair, you can use any SSH client, including the Git CLI.

These steps assume you’re using Git CLI to generate the SSH keys:

1. Open the Git CLI.

2. On the command prompt, enter ssh-keygen -t rsa.

To generate a larger key, enter ssh-keygen -t rsa -b 4096. If you're using amacOS version 10.13.6 (or higher), enter ssh-keygen -m PEM -t rsa.

3. When prompted, enter a file name for the key and press Enter.

If you don’t want to specify a file name, leave the name blank and press Enter.By default, the key pair files are saved as id_rsa.pub and id_rsa in the .sshsub-directory under the Git HOME directory. For example, on Windows, the files aresaved in C:\Users\<USER_PROFILE>\.ssh\.

4. Enter a passphrase and press Enter. If you don’t want to specify a passphrase,leave it blank and press Enter.

When prompted to confirm the passphrase, enter the same passphrase. If youdidn’t specify a passphrase earlier, leave it blank and press Enter.

By default, Git CLI access the C:\Users\<USER_PROFILE>\.ssh\ directory to locate theprivate key. If you are using another Git client, you may need to configure it to accessthe private SSH key. Check your Git client’s documentation to find out how to do that.

Add the Public SSH Key to Your VB Studio AccountAfter generating an SSH private-public key pair, add the public key to your UserPreferences page’s Authentication tab.

1. On the computer where you generated the SSH key pair, navigate to the directorywhere the public key is saved.


2-38

2. Open the public key file in a text editor, select the contents, and copy them to theclipboard.

3. In VB Studio, click the user avatar and select Preferences.

4. Click the Authentication tab.

5. Click Add Key.

6. In the New SSH Key dialog box, enter a unique name and paste the SSH key thatyou copied in Step 2.

7. Click Create.


See the News BannerA banner with the latest news from the VB Studio team is displayed on theOrganization and Project Home pages' header.

To navigate between news pages, click the navigation buttons. To expand or collapsethe banner, use the Expand or Collapse icons. To close the banner, click Close

.

If the banner isn't visible, here's how to enable it:

1. On the User Preferences page, click the General tab.

2. Select the Show News Banner on Organization and Project Home check box.


2-39

3Set Up Oracle Visual Builder Studio forExtending Oracle Cloud Applications

This chapter tells you how to set up Oracle Visual Builder Studio (VB Studio) so thatyour users can customize certain Oracle Cloud Applications by creating applicationextensions.

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

Here's a summary of how to set up VB Studio for developing app extensions:




2. (Optional) Create the VBStudio instance

Create the VB Studio Instance To use any Oracle Cloudservice, you must first createan instance of the service. Ifthe VB Studio instance isn'tprovisioned for you, create it.



4. Assign Oracle CloudApplications users VB Studioaccess

Set Up VB Studio Users To allow Oracle CloudApplications access to VBStudio, sync Oracle CloudApplications with OracleIdentity Cloud Service (IDCS)and then assign them VBStudio roles.

5. Create a project for appextensions

Create a Project forApplication Extensions

To develop an app extension,you must create a VBStudio project based onthe Application Extensiontemplate.



When you create a projectbased on the ApplicationExtension template, someartifacts are created bydefault. These artifacts requireadditional configuration beforeyour team members can usethem.

3-1


a) Add Build VMs Add Build VMs To run app extension'sdevelopment, test, orproduction builds, you mustcreate build jobs. Build jobs inVB Studio run on Build VMs.Only VB Studio administratorscan create and manage theBuild VMs.



When you create an appextension project, certainpackaging and deploymentbuild jobs are created bydefault, but they're missingsome configuration options.You must specify themmanually.

7. Add Oracle CloudApplications users to theproject

Add Users to the Project To allow your team membersto access the app extensionproject, invite them to join theproject.

8. Set up the project for testing Set Up the Project For Testing After your team members havecompleted their developmenttasks, you'll want to deploythe app extension to yourOracle Cloud Application's testinstance.

a) Add the Oracle CloudApplication's test instance toan environment

Add an Oracle CloudApplication's Instance to anEnvironment

Create an environment fortesting and add the OracleCloud Application's testinstance to the environment.

b) Migrate Oracle CloudApplication's customizationdata from the developmentinstance to the test instance

Migrate Your Oracle CloudApplication’s Customizations

Create and configure jobsto migrate customizationdata from the Oracle CloudApplications developmentinstance to the test instance.


Create a Packaging BuildJob, Create a DeploymentBuild Job, and Create andConfigure a Pipeline

Create and configure thepackaging and deploymentjobs so that your appextensions will be promotedto your Oracle CloudApplication's test instance.

d) (Optional) Restrict accessto the test build jobs


To restrict who can view abuild job's configuration, edit it,or run its build, mark the jobas private.


Set Up the Project to Deployto Production

You will likely want to setthings up so that afteryour team members havecompleted their developmenttasks and tested theapplication thoroughly, the appextension is deployed to yourOracle Cloud Application'sproduction instance.

Chapter 3

3-2


a) Add the OracleCloud Application's productioninstance to an environment

Add the Oracle CloudApplication's ProductionInstance to an Environment

First, create an environmentand add the OracleCloud Application's productioninstance to it.

b) Migrate Oracle CloudApplication's customizationfrom the test instance to theproduction instance

Migrate Your Oracle CloudApplication’s Customization

Create and configure jobsto migrate customizationdata from the Oracle CloudApplications test instance tothe production instance.



Next, create and configurethe packaging and deploymentjobs to promote your appextensions to your OracleCloud Application's productioninstance.

d) (Optional) Restrict accessto the production build jobs


To restrict who can view thejob's configuration, edit it,or run its build, you shouldmark both packaging anddeployment jobs as private.

Before You BeginBefore you set up VB Studio, you may want to review VB Studio key concepts in KeyConcepts, Components, and Terms.

This table lists the Oracle Cloud Applications and identity domain roles you'll need toset up VB Studio:



Add users and assign IDCS roles.


Create the VB Studio instance.

DEVELOPER_ADMINISTRATOR Set up VB Studio. After you're assignedthe role, you're considered VB Studio'sOrganization Administrator.

OCI_Administrator (OCI Administrator) Set up OCI compartments and buckets, whichare required to set up the VB Studio buildsystem.


Create and manage VMs on OCI ComputeClassic and store artifacts on OCI ObjectStorage Classic. These roles are required onlyif you're an OCI Classic user.

Chapter 3Before You Begin

3-3


FND_ADMINISTER_SANDBOX_PRIVprivilege in Oracle Cloud Applications,or any of these roles in your OracleCloud Application's development, test, andproduction instances:• APPLICATION ADMINISTRATOR• APPLICATION DEVELOPER• SALES_ADMINISTRATOR• CUSTOMER RELATIONSHIP

MANAGEMENT APPLICATIONADMINISTRATOR

Access sandboxes and your OracleCloud Application's development, test, andproduction instances.

Best PracticesHere are some best practices to follow while setting up VB Studio to develop appextensions.

• Follow your organization's guidelines to create and set up Oracle CloudApplications instances. Your guideline may suggest to create instances fordifferent software development environments, such as development, integration,test, pre-stage, stage, pre-production, and production. You can create theseinstances in different identity domains or in a common identity domain.This documentation assumes that you have created and set up Oracle CloudApplications instances for development, test, and production environments, whereeach instance is in a different identity domain.

• Create the VB Studio instance in the same Oracle Cloud account and identitydomain as the Oracle Cloud Applications development instance. See Create theVB Studio Instance.

• Ensure that you and your organization's users are assigned the correct OracleCloud Applications and VB Studio roles, as discussed in Assign VB Studio Rolesto Oracle Cloud Applications Users.

• If you're using OCI, keep these things in mind while setting up the OCI connectionin VB Studio:

– Create a separate compartment for VB Studio resources. This allows you toorganize resources better because they aren't mixed with the other resourcesin your tenancy.

– Create a separate group and a user to access the compartment.

– Create a policy that defines access to the compartment.

Set Up the OCI Connection tells you more about setting up a compartment, agroup, and a policy.

• Before you create a project, make sure that your Oracle Cloud Application'sdevelopment, test, and production instances are up and running.

• Create one project for each of your base Oracle Cloud Applications, taking care touse the Application Extension project template.

• After creating the project, add Oracle Cloud Applications users to the project andassign them proper project roles.For example:

Chapter 3Best Practices

3-4

– Assign the Limited Developer role to users who want to work oncustomization, but not run build jobs.

– Assign the Contributor role to users who can access the project, but notupdate 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 Studioautomatically creates a Development environment that points to the Oracle CloudApplication's development instance you specify. The build jobs, created by default,package and deploy the app extension's artifact to the Oracle Cloud Application'sdevelopment instance.If you want to use VB Studio to also deploy to your Oracle Cloud Application's testor production instance, you'll need to manually create a VB Studio environment foreach of those instances.

• To add Oracle Cloud Application's test and production instances from otheridentity domains, get either the identity domain's details, or a user's credentialsor personal access token who can connect to the instance.

• Follow your organization's guidelines to create and manage Git repository'sbranches. By default, the project uses the master branch for development. Thisdocumentation assumes that you'll continue to use master as the developmentbranch and create separate branches for test and production.

• You should set restrictions on the test and production branches to control who canmerge to it.

• Build jobs in VB Studio run on Build VMs. Build VM templates define the operatingsystem and software installed on Build VMs. By default, a System Default OL7for Visual Builder Build VM template is available with the necessary software tobuild app extensions, but no Build VMs are available.Before you run builds of the default build jobs, you should add Build VMs that usethe default System Default OL7 for Visual Builder Build VM template.

• To deploy to your Oracle Cloud Application's test or production instance, createseparate jobs to package the artifact and to deploy it to the Oracle CloudApplications instance. Then, create a pipeline to run the packaging and deployjobs in sequence.

• Set restrictions on who can edit or run production jobs.

• Before you run production build jobs or pipelines, make sure that all code changeshave been pushed to the production branch and there are no open mergerequests.

Get Access to Oracle Cloud Applications InstancesTo deploy your app extension to Oracle Cloud Applications development, test, andproduction instances, you'll need credentials or personal access tokens of users whocan access them. Contact the Oracle Cloud Applications administrator and get thedetails of users.

You should also make sure that each Oracle Cloud Applications instance is properlyconfigured and running.

If an instance isn't available or not configured, then follow the Oracle CloudApplications documentation to create and configure it.

Chapter 3Get Access to Oracle Cloud Applications Instances

3-5

Create the VB Studio Instance and Set Up the OCIConnection

1. (Optional) Create the VB Studio Instance if it isn't provisioned for you in thesame Oracle Cloud account and identity domain as the Oracle Cloud Applicationsdevelopment instance.

2. Set Up the OCI Account.

Set Up VB Studio UsersTo allow access to VB Studio, you must add your Oracle Cloud Applications users toOracle Identity Cloud Service (IDCS) and assign them VB Studio IDCS roles. Insteadof adding users manually, you can synchronize Oracle Cloud Applications users withIDCS and then grant them correct roles.

When a new user is added in Oracle Cloud Applications, the user is automaticallysynchronized with IDCS. Note that it can take up to an hour for the user to be syncedwith IDCS.

Here's a summary of how to synchronize Oracle Cloud Applications users with IDCS:

To perform this action: See this:

1. Set up single sign-on and synchronizeOracle Cloud Applications users with IDCS

Configure Single Sign-On (SSO) andSynchronize Users

2. Set Oracle Cloud Applications as the defaultidentity provider

Set Oracle Cloud Applications as the IdentityCloud Service Provider

3. Assign VB Studio IDCS roles to OracleCloud Applications users

Assign VB Studio Roles to Oracle CloudApplications Users

To perform the above steps, you must be assigned the Identity domain administratorand the Security administrator role in IDCS, and the security admin privileges in yourOracle Cloud Applications environment.

Configure Single Sign-On (SSO) and Synchronize UsersTo set up SSO and synchronize users, follow these steps:

1. In Oracle Cloud Applications, assign the FND_ADMINISTER_SANDBOX_PRIVprivilege, or one of these Oracle Cloud Applications roles to users who want toaccess VB Studio:

• Application Administrator(ORA_FND_APPLICATION_ADMINISTRATOR_JOB)

• Application Developer (ORA_FND_APPLICATION_DEVELOPER_JOB)

• Sales Administrator (ORA_ZBS_SALES_ADMINISTRATOR_JOB)

• Customer Relationship Management Application Administrator(ORA_ZCA_CUSTOMER_RELATIONSHIP_MANAGEMENT_APPLICATION_ADMINISTRATOR_JOB )

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

Chapter 3Create the VB Studio Instance and Set Up the OCI Connection

3-6

2. Enable SSO for Oracle Cloud Applications users.To do that, set IDCS as the identity provider and Oracle Cloud Applications asthe service provider, as described in Configure Single Sign-On of Oracle IdentityCloud Service - Application Catalog.

After the successful configuration, open the IDCS Console. You should see a

Configured message under Single Sign-On.

Here's an example:

3. Enable synchronization between Oracle Cloud Applications and IDCS.

Chapter 3Set Up VB Studio Users

3-7

https://docs.oracle.com/en/cloud/paas/identity-cloud/appcatalog/oraclefusionapplicationsrelease13.html#before-you-begin

To do that, establish a connection from IDCS to your Oracle Cloud Applicationsenvironment, as described in Configure Provisioning and Synchronization ofOracle Identity Cloud Service - Application Catalog.

To verify Oracle Cloud Applications users in IDCS, open the IDCS console, clickNavigation Drawer and select Users.

Here's an example of the IDCS Users page with synchronized Oracle CloudApplications users:

For each Oracle Cloud Applications role, IDCS automatically creates a grouprepresenting users assigned to that role. For example, the ApplicationAdministrator IDCS group represents users who are assigned the ApplicationAdministrator role in Oracle Cloud Applications.

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


3-8

https://docs.oracle.com/en/cloud/paas/identity-cloud/appcatalog/oraclefusionapplicationsrelease13.html#configure-provisioning-and-synchronization

Set Oracle Cloud Applications as the Identity Cloud Service ProviderWhen you set up single sign-on, by default, both IDCS and Oracle Cloud Applicationsare set as identity providers. To avoid any conflict, remove IDCS as the identityprovider. To find out how to do that, see Remove Identity Provider Policies inAdministering Oracle Identity Cloud Service.

After removing IDCS, you should see Oracle Cloud Applications as the only identityprovider on the Identity Providers page.

Here's an example:

Assign VB Studio Roles to Oracle Cloud Applications UsersAfter Oracle Cloud Applications users are synchronized and are available in IDCS,open the Oracle Cloud console and assign the VB Studio IDCS roles to users orgroups. To assign roles, you must be assigned the IDCS Identity domain administratorrole or the Security administrator role.

1. Sign in to Oracle Cloud and open the Oracle Cloud Console page.


3. Under Governance and Administration, select Identity, and then selectFederation.

4. On the Federation page, to assign a role to a user, in the Users tab underResources, click the user's name.

To assign a role to a group, in the Groups tab under Resources, click the group'sname.

5. Click Manage Roles.


3-9

6. On the Manage Service Roles page, search for the service with Developer CloudService description, click the Actions icon (three vertical dots) and select ManageInstance Access.

7. On the Manage Access page, in the Instance Role column, select the role.

Assign the DEVELOPER_ADMINISTRATOR role to Oracle Cloud Applicationsadministrators or to the APPLICATION ADMINISTRATOR group.Assign the DEVELOPER_USER role to non-admin users or groups, such as theAPPLICATION DEVELOPER group.

To find more about VB Studio IDCS roles, see IDCS Roles.

8. Click Update Instance Settings.

9. Click Apply Role Settings.

To learn more about assigning and managing roles for a group, see Managing OracleIdentity Cloud Service Roles for Groups; for users, see Managing Oracle IdentityCloud Service Roles for Users.

Create a Project for Application ExtensionsA project gathers all the resources you need for developing software. To ensure anoptimal environment for your employees creating application extensions, be sure tobase your project on the Application Extension project template.

1. Sign in to VB Studio. See Access VB Studio from the Oracle Cloud Home Page.

2. On the Organization page, click + Create Project.

3. On the Project Details page, enter a unique name and description for the project.

4. In Security, select the project's privacy setting.

A private project is accessible to invited users only. Users who aren't invited can'taccess 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 viewthe source code, create or update issues, edit wiki pages, and interact with projectbuilds. However, only invited users can make updates to the source code in Gitrepositories, create and run build jobs, and perform deployment operations.

5. In Preferred Language, specify the language for the email notifications yourproject users will receive.

You can change the language in which the user interface appears in your userpreferences.

6. Click Next.

7. On the Template page, select the Application Extension template, then clickNext.

8. On the Application Extension Project Properties page:

a. In Oracle Cloud Applications Development Instance, select the baseapplication's development instance.

The list shows Oracle Cloud Applications instances defined in the sameidentity domain as the VB Studio.

b. (Optional) In Git Repository Name, update the project's Git repository'sdefault name, if required.

Chapter 3Create a Project for Application Extensions

3-10

https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managinggrouprolesidcs.htm

https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managinggrouprolesidcs.htm

https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managinguserrolesidcs.htm

https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managinguserrolesidcs.htm

c. In Base Application, select the Oracle Cloud Application you want to extendin this project.

d. To create a private workspace along with the project, click the CreateWorkspace toggle button.

A workspace contains all the artifacts that you need to develop app extensionsand visual applications, including a clone of this project's Git repository ̶ andthe branch ̶ containing the source files. To learn more about workspaces,see What Is a Workspace and Why Do I Need One?

In Workspace Name, enter a unique name.

If you don't want to use the Git repository's master branch as the workspace'sworking branch, in Working Branch Name, enter the new branch's name.When the project is provisioned, VB Studio creates a copy of the masterbranch, renames it your specified name and uses it as the workspace'sworking branch.

e. In Wiki Markup, select the project's wiki markup language.

Project's users use the markup language to format wiki pages and comments.If you're not sure which markup language to choose, use the default markuplanguage. You can change the markup language later from the ProjectAdministration page. See Change a Project’s Wiki Markup Language.

9. Click Finish.

After the project is provisioned, the Project Home page opens where you can seea summary of the project's provisioning activities; default environments; and Gitrepositories. Review the activities feed and the Environments box for any errors.When you create a project using the Application Extension template, these artifactsare 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 theRepositories tab, then click the Git repository name:

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

In the navigation menu, click Environments to see the Developmentenvironment:


3-11

• Build jobs that package and deploy the app extension's artifact to Oracle CloudApplication's development instance.By default, Application-Extension-Package and Application-Extension-Deployjobs are created for you. The Application-Extension-Package job generates theapp extension's artifact file. The Application-Extension-Deploy job deploys theapp extension's artifact file to Oracle Cloud Application's development instance.

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

By default, the packaging job uses the Git repository's master branch as thesource and triggers a build whenever a commit is pushed to it. To enable auser to run a build, you must first allocate Build VMs and make the appropriatedeployment configurations. See Set Up the Project for Development. Without theappropriate configuration or VMs, the build will fail.

• A pipeline to run the build jobs in a sequence.

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


3-12

• (Optional) A private workspace to edit the app extension in the VB StudioDesigner.

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

Set Up the Project for DevelopmentBefore your team members can use the project for developing app extensions, youneed to make a few configuration settings in the project.

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


1. Add Build VMs.VMs are needed to run build jobs for theproject.

Add Build VMs

2. (Optional) Configure the packaging job.By default, the packaging job uses the appextension's version defined in the visual-application.json file. If you want to specifyanother version when a build runs, configurethe job.

Configure the Packaging Job

3. Configure the deployment job.By default, the deployment job doesn'thave credentials to connect to the targetdevelopment instance, so you must specifythem manually.

Configure the Deployment Job

4. (Optional) Protect the Git repository'smaster branch.By default, a branch is accessible to all projectusers and anyone can make changes to itsfiles. To restrict changes and push commitsto the master branch, set restrictions on itto allow branch merges only after they areapproved.

Set Merge Restrictions on the master Branch

Add Build VMsBuilds in VB Studio run on Build VMs running in a Virtual Cloud Network (VCN). ABuild VM Template defines the operating system and software installed on Build VMs.

To find out more about Build VMs and Build VM templates, see What Are Build VMsand Build VM Templates?

Chapter 3Set Up the Project for Development

3-13

You can run Build VMs in the VB Studio's default VCN or in your VCN. See Use VBStudio's Default VCN to learn about VB Studio's default VCN. To run builds in yourown VCN, see Run Build VMs in Your VCN.

To run builds of your app extensions, you should add Build VMs that use the defaultSystem Default OL7 for Visual Builder VM template. The System Default OL7for Visual Builder VM template includes Node.js 10, which is the minimum versionrequired for packaging app extensions.



3. Click + Create VM.

4. In the Add Build VM dialog box, in Quantity, specify the number of VMs you wantto allocate.

To minimize build execution delays, set the number of VMs to the number of jobsthat 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 VMand then add more as required. Note that the more VMs you have running at aspecific time, the higher the cost of OCPUs. To minimize the higher cost, use theSleep Timeout setting on the Virtual Machines page to automatically shut downinactive VMs. You can always return to the Virtual Machines tab to remove or addVMs, based on your actual usage.

5. In VM Template, select System Default OL7 for Visual Builder.

6. In Region, Shape, and VCN Selection specify the VM's region, shape, and VirtualCloud 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 or OCI Compute Classic.Choose the region where your VB Studio account is or the one that's closestto you geographically.

• A shape is a template that determines the number of CPUs, amount ofmemory, and other resources allocated to the created instance. Choose ashape of your preference.

• A VCN is a software-defined network that you set up in the Oracle CloudInfrastructure data centers in a particular region. By default, builds run in yourVB Studio's compartment. To run builds in your own VCN, select Custom andspecify its details.

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

7. Click Add.

Configure the Packaging JobThe packaging job generates the app extension's build artifact from the source files inthe Git repository's master branch.

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


3-14




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 .

2. In the Jobs tab, click the packaging job.

3. Click Configure.

4. Click 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 thevisual-application.json file with the new version.

7. Click Save.

Configure the Deployment JobThe deployment job deploys the app extension's build artifact to your Oracle CloudApplication's development instance. In the job, specify the credentials required toconnect and deploy build artifact to your Oracle Cloud Application's developmentinstance.


2. In the Jobs tab, click the deployment job.

3. Click Configure.



6. In the Oracle Deployment section, under Authorization, select one of theseoptions:

• To authenticate using a username and a password, select Use Credentials. InUsername and Password, enter the credentials of an IDCS user who is notonly an Oracle Cloud Applications user, but one who can connect and deployto the Oracle Cloud Application's development instance.

• To authenticate using an Oracle Cloud Applications user's personal accesstoken, select Use Access Token. Click Set Access Token, upload the tokenfile, and click OK.Note that personal access tokens have a short life. Before uploading, ensurethat the access token isn't expired. If you need to generate a personal accesstoken, see Get an Oracle Cloud Applications User's Personal Access Token.

7. Click Save.

Get an Oracle Cloud Applications User's Personal Access TokenTo get a user's personal access token, sign in to the Oracle Identity Cloud Serviceconsole with the user's credentials. To learn more, see Generate Personal AccessTokens.Personal access tokens have a short life. Generate them only when you need them.


3-15

Run the PipelineThe development build pipeline runs automatically when a commit is pushed to the Gitrepository's branch specified in the packaging job.

If you want to run the pipeline manually:


2. Click the Pipelines tab.

3. For the pipeline you want to run, click Build .

To monitor the pipeline, click the pipeline's name on the Builds page.

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

View the Deployed Application ExtensionsAfter the deployment job has successfully run, you can view the deployed appextension in the Deployments tab of the Environments page.

1. In the navigation menu, click 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 a personal access token has expired or its accesscredentials have changed, provide the token or the credentials again.

6. Expand the base Oracle Cloud Application to view its deployed app extensions.

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 appextension's version defined in /visual-application.json, the Version columnappends 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 theapplication's base URL and paste it in a web browser.


3-16

Delete an App ExtensionYou can delete an app extension that's deployed to your current identity domain'sOracle Cloud Applications manually from the Deployments tab of its environment, orconfigure a build job to delete it.

To delete an app extension that's deployed to Oracle Cloud Applications of anotheridentity domain, configure a build job and run it. You can't delete it manually.

Delete an App Extension Manually


2. Select the environment where the app extension is deployed.


4. Expand the base application's name.

5. For the app extension to delete, click Actions and select Delete.

6. In the confirmation dialog box, click Delete.

Configure a Job to Delete an App ExtensionTo delete an app extension through a build job, you'll need either a personal accesstoken or access credentials of a user who can access the Oracle Cloud Application'sinstance where the app extension is deployed.


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 VMtemplate.

6. Click Create.

7. On the Job Configuration page, click Configure .


9. From Add Step, select Application Extension, and then select Delete.

10. In Instance, select the Oracle Cloud Applications instance where the application isdeployed.

11. In Authorization, select one of these options.

• To authenticate using a username and a password, select Use Credentials.In Username and Password, enter the user's credentials who can connect tothe Oracle Cloud Applications instance.

• To authenticate using the user's personal access token, select Use AccessToken. Click Set Access Token, upload the token file, and click OK.


3-17

Note that personal access tokens have a short life. Before uploading, ensurethat the access token isn't expired. If you need to generate a personal accesstoken, see Get a Visual Builder User's Personal Access Token.

12. In Base Application, Name, and Version, enter the app extension's baseapplication, name, and version.

You can find the details on the Deployments tab of the environment where theapp extension is deployed.Example:

13. Click Save.

14. To run a build, click Build Now.

Set Merge Restrictions on the master BranchBy default, the master branch is accessible to all project users and anyone can makechanges to its files. To restrict changes and who can push commits to it, you may wantto set restrictions on it and allow branch merges only after they are approved.

1. In the navigation menu, click Project Administration .

2. Click Branches.

3. In Repository and Branches, select the Git repository and the master 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 reviewerwhen a merge request is created on the branch.

6. From the Approvals drop-down list, select the minimum number of reviewers whomust approve the review branch of a merge request, where the selected branch isthe target branch

7. (Optional) To allow a review branch to be merged to the selected branch only ifthe last build of the linked job in Merge Request is successful, select the Requiresuccessful 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 pushedto a branch after they have approved the merge request, select the Reapprovalneeded when branch is updated check box.


3-18

9. (Optional) To ensure changes pushed to the target branch match the contents ofthe review branch, select the Changes pushed to target branch must matchreview content check box.

10. (Optional) In Merge Request Exempt Users, specify users who can bypass thebranch restrictions and merge the review branch of a merge request outside VBStudio or without required approvals.

This is useful if you want to allow some users to merge the review branchirrespective of review conditions being met.

11. Click Save.

Learn More About VB StudioNow that you've set up VB Studio, created an app extension project and added OracleCloud Applications users to it, it's time to learn more about the other features that VBStudio offers.

• Get Started in Managing Your Development Process with Visual Builder Studiois a good resource, as it explains how to manage a project, create and manageissues and Agile boards, review source code with merge requests, and more.

• How Do I Use Visual Builder Studio to Extend Oracle Cloud Applications inExtending Oracle Cloud Applications with Visual Builder Studio describes how tocreate, edit and publish app extensions.

Add Users to the ProjectYou must explicitly add users before they can work within a project, as explained inthis table:

Action How To

Add a user to theproject 1. In the navigation menu, click Project Home .

2. Click the Team tab.

3. Click + Add Member.

4. In the Add Member dialog box, specify the new member’s projectmembership in Membership.To learn about different types of memberships, see What Are theVB Studio Project Memberships?

5. In Username, enter or select the user from the list.

6. Click Add.

Chapter 3Add Users to the Project

3-19

Action How To

Add multiple users tothe project 1. In the navigation menu, click Project Home .



4. In the Add Member dialog box, select the Multiple Users checkbox.

5. In Username, enter or select the user from the list, and click Add

User .The selected user is added to the Username List text box. Ifyou know the usernames of users to add, enter them manuallyseparated by a space, a comma, a semicolon, or a new line.

6. Click Add.

Add users fromanother project

1. Open the project that has users already added.

2. In the navigation menu, click Project Home .


4. Click Export .

5. In the Members List Export dialog box, copy the names of projectmembers.

6. Click OK or Close to close the dialog box.

7. Open the project where you want to add the copied users.





12. In Username List text box, paste the copied names of projectmembers.

13. Click Add.

Change a user’sproject membership

To change a user’s membership, mouse over the user's name, click

Change Membership , and then select the membership.

Set Up the Project For TestingAfter your development and QA cycles are complete, you may want to configurethe project to build and deploy app extensions to the Oracle Cloud Application's testinstance, or the instance you use to test the application before deploying it to theproduction instance.

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

Chapter 3Set Up the Project For Testing

3-20

Here's a summary of how to set up the VB Studio project for test or other non-production environments.


1. In the VB Studio project, create anenvironment for the Oracle Cloud Application'stest instance.

Add an Oracle Cloud Application's Instance toan Environment

2. Create a Git repository test branch from themaster branch.

Create a Test Branch

3. Create test packaging and deployment buildjobs, and then set up a pipeline.You may also want to restrict who can see oredit the test build jobs' configuration, or run itsbuild.

Create and Configure Build Jobs

4. Migrate your Oracle Cloud Application'scustomizations to the test instance.

Migrate Your Oracle Cloud Application’sCustomizations

Add an Oracle Cloud Application's Instance to an EnvironmentIf you want to set up things so that app extensions are deployed to the OracleCloud Application's test or any other instance, you must create separate VB Studioenvironments and add the correct instances to it. You can only add one Oracle CloudApplications instance to an environment.

Here's an example of environments for development, test, stage, and pre-productioninstances:

Your Oracle Cloud Applications instance can reside either in your current identitydomain or in another identity domain. If your test instance resides in another identitydomain, to add it to an environment, you'll need any of these:

• A user's personal access token who can access the instance

• Base Oracle Cloud Application's URL and a user's credentials who can access theinstance

When you add an Oracle Cloud Applications instance (a service instance or an IDCSresource) to an environment, VB Studio creates an IDCS Application (also known asa Client Application) in the background. The IDCS Application generates an OAuthtoken to access the newly added Oracle Cloud Applications instance and handles


3-21

authentication when VB Studio tries to access the target instance. Provisioning of theIDCS Application takes a few seconds to complete after the Oracle Cloud Applicationsinstance is added to an environment.

If the newly added instance stays in the Unknown status for some time, it typicallyindicates that the IDCS Application provisioning may have failed. VB Studio addedthe Oracle Cloud Applications instance but can't access it. In such a case, delete theOracle Cloud Applications instance from the environment and add it again.

Add a Connection to Oracle Cloud Applications of Your Current Identity Domain


2. Select an existing environment or create one.

To create an environment, click Create (or Create Environment if the pageis empty). In Environment Name and Description, enter a unique name anddescription, and click Create.

3. In the Service Instances tab, click Add.

4. In the Add Service Instances dialog box, click the Oracle Cloud Applicationstoggle button.

5. Select the Identity Domain option.

6. Select the check box for the Oracle Cloud Applications instance you want to addand click Add.

You can add only a single Oracle Cloud Applications instance to an environment.

Add a Connection to Oracle Cloud Applications of Another Identity Domain





4. In the Add Service Instances dialog box, click Oracle Cloud Applications togglebutton.

If you have these details of the targetOracle Cloud Applications instance:

Follow these steps:

Personal access token of a user who canaccess the instanceTo generate the personal access token, seeGet an Oracle Cloud Applications User'sPersonal Access Token.

1. Select the Personal Access Tokenoption.

2. Drag and drop the token file to the Dragand Drop Token File area, or copy thetoken's text and paste it in paste tokenhere.

3. Click Add.


3-22


Follow these steps:

Base Oracle Cloud Application's URL andcredentials of a user who can access theinstance

1. Select the Application Credentialsoption.

2. In Base URL, enter the base OracleCloud Application's URL.

3. In Instance Name, if required, update theinstance's display name. The name will bedisplayed in the Service Instances tab.

4. In Username and Password, enter thecredentials of a user who can access theOracle Cloud Applications instance.

5. Click Add.

Create a Test BranchFollow your organization's guidelines to create a branch and protect it from unverifiedchanges. To protect a branch, you can set merge restrictions, make the branch privateand restrict who can push commits to it, or freeze it.

To use an existing branch for Test, create a merge request with master as the reviewbranch and the test branch as the target branch. After approvals from reviewers,merge the review branch into the target branch.To create a branch from master, follow these steps:

1. In the navigation menu, click Git .

2. Click the Refs view and then click 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 Basedrop-down list, select master as the base branch.

6. Click Create.

After creating the test branch, if you want to set merge restrictions on it, see SetReview and Merge Restrictions on a Repository Branch. To freeze the branch or makeit private, or set other restrictions, see Protect a Branch.

Create and Configure Build JobsTo deploy app extensions to your Oracle Cloud Application's test or any other instance,you'll need to set up separate packaging and deployment jobs. You should also setrestrictions on who can see or edit the job's configuration, or run its build.

Here's an example of jobs that generate and package the app extension's artifact, anddeploy it to the development and test instances:


3-23

Here's an example of development and test pipelines:

Before you create and configure the jobs, you'll need these:

• Access credentials or the personal access token of an Oracle Cloud Applicationsuser who can connect and deploy to the test instance.

• Artifact's file nameIf you changed the default artifact's file name in the development packaging job,get the new name and its path.

• Application's versionIf you configured the development packaging job to overwrite the application'sversion defined in visual-application.json, get the new version.

Create a Packaging Build JobThe packaging job generates an app extension artifact that's ready to deploy.


3-24





5. In Template, select the System Default OL7 for Visual Builder template.

6. Click Create.


8. Click the Git tab.

9. From Add Git, select Git.

10. In Repository, select the Git repository. In Branch or Tag, select the repository'stest branch (or tag).


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 newname. By default, it is extension.vx.

14. (Optional) If you want to overwrite the app extension's default version defined inthe visual-application.json file, in Extension Version, specify the new 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 wildcharacters. For example, *.vx.

18. If you want to discard the build's old artifacts, click Settings . In the Generaltab, select the Discard Old Builds check box and specify the discard options.

19. Click Save.

Create a Deployment Build JobThe deployment job deploys the app extension's artifact that was generated in thepackaging job to the Oracle Cloud Application's instance. Before you create the job,get the access credentials or the personal access token of an IDCS user who can alsoaccess the Oracle Cloud Application's instance.






6. Click Create.



3-25

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.


14. From Add Step, select Oracle Deployment.

15. In Target Instance, select the environment with the Oracle Cloud Application'starget instance.


• To authenticate using an IDCS user's credentials who is also an Oracle CloudApplications user, select Use Credentials. In Username and Password,enter the credentials.

• To authenticate using an Oracle Cloud Applications user's personal accesstoken, select Use Access Token. Click Set Access Token, upload the tokenfile and click OK.Note that personal access tokens have a short life. Before uploading, ensurethat the access token hasn't expired. To generate a personal access token,see Get an Oracle Cloud Applications User's Personal Access Token.

17. In Build Artifact, enter the same artifact name that you used in the packagingbuild step.

18. Click Save.

Configure a Job's Privacy SettingMark a job as private to restrict who can see or edit a job's configuration, or run itsbuild.

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


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.

A private job shows a Lock icon in the jobs list on the right side of the JobProtection page, in the Jobs tab of the Builds page, and in the pipelines.

A non-authorized user who tries to view a private job will see this message: This jobis private. You need permission from your project owner to view this job.


3-26

Create and Configure a PipelineTo ensure the deployment job runs automatically after the packaging job, create apipeline and set the dependency.



3. Click + Create Pipeline.

4. In the Create Pipeline dialog box, in Name and Description, enter a unique nameand description.

5. Click Create.

6. On the design page, from the Jobs list, drag-and-drop the packaging job and thedeployment job to the designer area.

Example:

7. Mouse over the Start node's Gray circle handle. The cursor icon changes tothe + cursor icon. Drag the cursor from the Gray circle handle to the packagingjob's White circle handle. An arrow line appears.

Example:

8. Mouse-over the packaging job's Blue circle handle and drag-and-drop thearrow head over the deployment job's White circle handle.

Example:

9. Click Save.

Run the PipelineTo run the packaging job and the deployment job in sequence, run the pipeline.




After successful build, you'll find the deployed application's link in the Deploymentstab of the Environments page.


3-27

To view the latest build log of a job, open the Builds page, click the job's name, and

then click Build Log .

Delete an App ExtensionYou can delete an app extension that's deployed to your current identity domain'sOracle Cloud Applications manually from the Deployments tab of its environment, orconfigure a build job to delete it.

To delete an app extension that's deployed to Oracle Cloud Applications of anotheridentity domain, configure a build job and run it. You can't delete it manually.

Delete an App Extension Manually


2. Select the environment where the app extension is deployed.


4. Expand the base application's name.

5. For the app extension to delete, click Actions and select Delete.

6. In the confirmation dialog box, click Delete.

Configure a Job to Delete an App ExtensionTo delete an app extension through a build job, you'll need either a personal accesstoken or access credentials of a user who can access the Oracle Cloud Application'sinstance where the app extension is deployed.





5. In Template, select the System Default OL7 for Visual Builder Build VMtemplate.

6. Click Create.

7. On the Job Configuration page, click Configure .


9. From Add Step, select Application Extension, and then select Delete.

10. In Instance, select the Oracle Cloud Applications instance where the application isdeployed.


• To authenticate using a username and a password, select Use Credentials.In Username and Password, enter the user's credentials who can connect tothe Oracle Cloud Applications instance.


3-28

• To authenticate using the user's personal access token, select Use AccessToken. Click Set Access Token, upload the token file, and click OK.Note that personal access tokens have a short life. Before uploading, ensurethat the access token isn't expired. If you need to generate a personal accesstoken, see Get a Visual Builder User's Personal Access Token.

12. In Base Application, Name, and Version, enter the app extension's baseapplication, name, and version.

You can find the details on the Deployments tab of the environment where theapp extension is deployed.Example:

13. Click Save.


Migrate Your Oracle Cloud Application’s CustomizationsWhen you’re ready to deploy your app extension to the Oracle Cloud Application's testinstance, you should also migrate your Oracle Cloud Application's customization datafrom your source development instance to the target test instance.

You can migrate the customization manually from the source Oracle CloudApplications instance’s Customization Migration page to the target instance, orconfigure Customization Set Migration (CSM) builds jobs in VB Studio to automatethe migration process.

To migrate CSM data, VB Studio provides these CSM build steps in jobs:

Build Step Description

Export Data Generate the migration set from the sourceOracle Cloud Applications instance and getsthe customization set ID.

Import Data Import the generated migration set fromsource Oracle Cloud Applications instance tothe target Oracle Cloud Applications instance.

Apply Migration Apply the imported migration set to the targetinstance.

Abort Migration Delete the generated migration set.

While configuring CSM build jobs, add only one CSM build step in each job and runthem in this order:


3-29

1. Run the CSM export job.

2. Run the CSM import job only if the export job is successful.

3. If the CSM import job fails, run the CSM abort migration job.

4. If the CSM import is successful, manually test the changes on the target OracleCloud Applications instance.

5. Run the CSM apply migration job after your tests are successful.

Before You Migrate CustomizationHere are some things you need to do before you configure and run CSM build jobs tomigrate customization from the source instance to the target instance:

• Ensure that your source Oracle Cloud Applications instance’s sandboxes arepublished.

• On your source Oracle Cloud Applications instance's Migration page, ensurethat the Target Instance is set to point to the target Oracle Cloud Applicationsinstance's URL.Here's an example of an Oracle Cloud Applications migration page:

• Get the access credentials or personal access tokens of users who can accessthe source and the target Oracle Cloud Applications instances. You'll need them toconfigure CSM build jobs.

• Run the CSM export and import build jobs after you've deployed the app extensionto the target Oracle Cloud Applications instance.

Configure a Job to Export CustomizationConfigure a job to generate the outbound migration set from the source Oracle CloudApplications instance.







3-30

6. Click Create.



9. From Add Step, select Customization Set Migration, and then select ExportData.

10. In Source Instance, select the environment that points to the Oracle CloudApplication's source instance.

11. In ID Parameter Name, enter a name for the parameter that defines a unique IDfor the customization set. By default, it's set to CUSTOMIZATION_SET_ID.

When a build runs, the job generates a unique customization set ID, assigns it toCUSTOMIZATION_SET_ID, and passes it to downstream jobs when the job runs in apipeline.

12. In Name and Description, enter a name and description for the customization set.

If you're not sure about the name and description at the time of job's configuration,you can use build parameters and enter the details when you run the job's build.Here's an example:

Remember to define the build parameters in the Parameters tab.


3-31




14. Click Save.

Configure a Job to Import CustomizationConfigure a job to import the migration set to the target Oracle Cloud Applicationsinstance.



3-32





6. Click Create.



9. From Add Step, select Customization Set Migration, and then select ImportData.

10. In Target Instance, select the environment that points to the Oracle CloudApplication's target instance.

11. In ID Parameter Name, if you changed the default parameter name in the CSMexport job, then enter the same parameter name in the $<PARAMETER_NAME> or ${<PARAMETER_NAME>} format. By default, it's set to ${CUSTOMIZATION_SET_ID}.

When a build of this job runs, the job gets the unique customization set IDgenerated by the CSM export job. If no ID is found, it fails.




13. Click Save.

Configure a Job to Abort Customization MigrationIf for some reason your CSM import job fails, you should abort the migration process.To do that, configure an abort migration job.






6. Click Create.




3-33

9. From Add Step, select Customization Set Migration, and then select AbortMigration.







13. Click Save.

Configure a Job to Apply and Save the Customization MigrationAfter your import job is successful and you have manually tested the changes on thetarget Oracle Cloud Applications instance, you should save the migration set. To dothat, configure an apply migration job.






6. Click Create.



9. From Add Step, select Customization Set Migration, and then select ApplyMigration.





3-34




13. Click Save.

Create and Configure the CSM PipelineTo ensure the CSM jobs runs automatically in the correct order, create a pipeline andset the dependency.

When you define the pipeline, make sure that the CSM import job runs after the CSMexport job is successful. If the CSM import job fails, run the CSM abort migration job.Don't add the CSM apply migration job to the pipeline. You should run it manually afterverifying your changes on the target Oracle Cloud Applications instance.





5. Click Create.

6. On the design page, from the Jobs list, drag-and-drop the CSM export, import,and abort jobs to the designer area.

Here's an example:

7. Mouse over the Start node's Gray circle handle. The cursor icon changes tothe + cursor icon. Drag the cursor from the Gray circle handle to the exportCSM job's White circle handle. An arrow line appears.

8. Mouse-over the export CSM job's Blue circle handle and drag-and-drop thearrow head over the import CSM job's White circle handle.

9. Mouse-over the import CSM job's Blue circle handle and drag-and-drop thearrow head over the abort CSM job's White circle handle.

Your pipeline diagram should look like this example:


3-35

10. Click to select the line that that goes from the import CSM job's Blue circle tothe abort CSM job's White circle handle.

Here's an example:

11. Click Configure Selected Link .

12. In the Pipeline flow config editor dialog box, from Result Condition, select Failedand click Apply.

13. Click Save.

Run the PipelineTo run the CSM jobs in sequence, run the pipeline.




4. If you've defined build parameters in the CSM jobs, enter the required details inthe Build Pipeline dialog box, and click Build Now.

To view build log of a job, open the Builds page, click the job's name, and then click

Build Log .

Set Up the Project to Deploy to ProductionAfter your development and test cycles are complete, you may want to configure theproject to build and deploy app extension to the Oracle Cloud Application's productioninstance.

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

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


1. In the VB Studio project, create anenvironment for the Oracle Cloud Application'sproduction instance.

Add the Oracle Cloud Application's ProductionInstance to an Environment

2. Create a production branch from thetest branch. Use this branch to push yourapplication to production.

Create a Production Branch

3. Create the packaging and deployment buildjobs, and set up the pipeline.


4. (Optional) Restrict users who can edit theproduction jobs or run their builds.

Configure a Job's Privacy Setting

Chapter 3Set Up the Project to Deploy to Production

3-36


5. Migrate your Oracle Cloud Application'scustomization data to the production instance

Migrate Your Oracle Cloud Application’sCustomization

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

Add the Oracle Cloud Application's Production Instance to anEnvironment

To deploy an app extension to the Oracle Cloud Application's production instance, youmust create a VB Studio environment and add the correct instance to it. You can onlyadd one Oracle Cloud Applications instance to an environment.

The Oracle Cloud Applications production instance usually resides in another identitydomain. To add an Oracle Cloud Applications production instance that resides inanother identity domain to an environment, you'll need any of these:


• Base Oracle Cloud Application's URL and a user's credentials who can access theinstance

When you add an Oracle Cloud Applications instance (a service instance or an IDCSresource) to an environment, VB Studio creates an IDCS Application (also known asa Client Application) in the background. The IDCS Application generates an OAuthtoken to access the newly added Oracle Cloud Applications instance and handlesauthentication when VB Studio tries to access the target instance. Provisioning of theIDCS Application takes a few seconds to complete after the Oracle Cloud Applicationsinstance is added to an environment.

If the newly added instance stays in the Unknown status for some time, it typicallyindicates that the IDCS Application provisioning may have failed. VB Studio addedthe Oracle Cloud Applications instance but can't access it. In such a case, delete theOracle Cloud Applications instance from the environment and add it again.

Add a Connection to Oracle Cloud Applications of Another Identity Domain





4. In the Add Service Instances dialog box, click Oracle Cloud Applications togglebutton.


3-37


Follow these steps:

Personal access token of a user who canaccess the instanceTo generate the personal access token, seeGet an Oracle Cloud Applications User'sPersonal Access Token.



3. Click Add.

Base Oracle Cloud Application's URL andcredentials of a user who can access theinstance

1. Select the Application Credentialsoption.

2. In Base URL, enter the base OracleCloud Application's URL.


4. In Username and Password, enter thecredentials of a user who can access theOracle Cloud Applications instance.

5. Click Add.

Create a Production BranchFollow your organization's guidelines to create a branch and protect it from unverifiedchanges. To protect the branch, you can set merge restrictions, make the branchprivate and restrict who can push commits to it, or freeze it.

If you're using an existing branch for Production, you should create a merge requestwith the test branch as the review branch and the production branch as the targetbranch. After approvals from reviewers, merge the review branch into the targetbranch.To create a production branch from the test branch, follow these steps:





5. In the New Branch dialog box, in Name, enter the branch name. From the Basedrop-down list, select the test branch as the base branch.

6. Click Create.

After creating the production branch, if you want to set merge restrictions on it, see SetReview and Merge Restrictions on a Repository Branch. To freeze the branch or makeit private, or set other restrictions, see Protect a Branch.


3-38

Create and Configure Build JobsYou need to set up some packaging and deployment jobs before you can deploy appextensions to your Oracle Cloud Application's production instance. This topic explainshow to do that.


• Access credentials or the personal access token of an Oracle Cloud Applicationsuser who can connect and deploy to the production instance.

• Artifact's file nameIf you changed the default artifact's name in the test packaging job, get the newname and its path.


Create a Production Packaging Build JobThe packaging job generates an app extension artifact that's ready to deploy.






6. Click Create.



9. From the Add Git list, select Git.

10. In Repository, select the Git repository. In Branch or Tag, select the productionbranch.


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 newname. By default, it is extension.vx.

14. (Optional) If you want to overwrite the app extension's default version defined inthe visual-application.json file, in Extension Version, specify the new version.



17. In Files to archive, enter the build artifact name. You can also use wildcharacters. For example, *.vx.


3-39

18. If you want to discard the build's old artifacts, click Settings . In the Generaltab, select the Discard Old Builds check box and specify the discard options.

19. Click Save.

Create a Production Deployment Build JobThe deployment job deploys the app extension's artifact that was generated in thepackaging job to the Oracle Cloud Application's production instance. Before you createthe job, get the access credentials or the personal access token of an IDCS user whocan also access the Oracle Cloud Application's production instance.






6. Click Create.




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.




15. In Target Instance, select the environment with the Oracle Cloud Application'sproduction instance.




17. In Build Artifact, enter the same artifact name that you used in the packagingbuild step.

18. Click Save.


3-40

Configure a Job's Privacy SettingMark a job as private to restrict who can see or edit a job's configuration, or run itsbuild:


2. Click Builds.






7. Click Save.








5. Click Create.


Example:

7. Mouse over the Start node's Gray circle handle. The cursor icon changes tothe + cursor icon. Drag the cursor from the Gray circle handle to the packagingjob's White circle handle. An arrow line appears.

Example:


3-41

8. Mouse-over the packaging job's Blue circle handle and drag-and-drop thearrow head over the deployment job's White circle handle.

Example:

9. Click Save.

Run the PipelineTo run the packaging job and the deployment job in sequence, run the pipeline.




After successful build, you'll find the deployed application's link in the Deploymentstab of the Environments page.

To view the latest build log of a job, open the Builds page, click the job's name,

and then click Build Log . After a successful build, inform the Oracle CloudApplications administrator that the app extension's artifact has been pushed to theOracle Cloud Application's production instance.

After a successful build, inform the Oracle Cloud Applications administrator that theapp extension's artifact has been pushed to the Oracle Cloud Application's productioninstance.

Migrate Your Oracle Cloud Application’s CustomizationWhen you’re ready to deploy your app extension to the Oracle Cloud Application'sproduction instance, you should also migrate your Oracle Cloud Application'scustomization from your source instance, such as the test instance, to the targetproduction instance.

Before you migrate your customizations to the production instance, make sure that youhave migrated and applied customizations from all app extensions you're developingto the test instance. After successfully verifying the migration, configure CSM jobs tomigrate all customizations from the test to the production instance.

See these topics to configure your jobs and set up the pipeline. Remember to usethe environment with the Oracle Cloud Applications test as your source, and theenvironment with the Oracle Cloud Applications production instance as your target.

• Configure a Job to Export Customization


3-42

• Configure a Job to Import Customization

• Configure a Job to Abort Customization Migration

• Configure a Job to Apply and Save the Customization Migration

• Create and Configure the CSM PipelineDon't add the CSM Apply job to the pipeline.

Here's an example of the test to production pipeline:

• Run the Pipeline

Run the CSM Apply job's build after manually testing your changes on the targetproduction instance.


3-43

4Set Up VB Studio for Developing VisualApplications

This chapter tells you how to set up Oracle Visual Builder Studio (VB Studio) so thatyour users can create visual applications.

A visual application is a responsive web or native mobile application developedusing VB Studio's browser-based development environment. You deploy a visualapplication to a Visual Builder instance or to a Visual Builder instance available inOracle Integration. The Visual Builder instance must be version 19.4.3.1, or later. Thisdocumentation assumes that you have created and set up Visual Builder instances fordevelopment, test, and production environments in different identity domains.

Here's a summary of how to set up VB Studio for developing visual applications:








4. Get access to Visual Builderinstances

Get Access to Visual BuilderInstances

To deploy an app, you needa user's credentials who candeploy apps to the VisualBuilder instance. If an instanceisn't available, you must createit.

5. Create a project for visualapplications

Create a Project for VisualApplications

To develop a visualapplication, you must createa VB Studio project basedon the Visual Applicationtemplate.



When you create a projectbased on the VisualApplication template, someartifacts are created bydefault. These artifacts requireadditional configuration beforeyour team members can usethem.

4-1


a) Add Build VMs Add Build VMs To run visual application'sdevelopment, test, orproduction builds, you mustcreate build jobs. Build jobs inVB Studio run on Build VMs.Only VB Studio administratorscan create and manage theBuild VMs.



When you create a visualapplication project, certainpackaging and deploymentbuild jobs are created bydefault, but they're missingsome configuration options.You must specify themmanually.

7. Add users to the project Add Users to the Project To allow your team membersto access the visualapplication project, invite themto join the project.

8. Set up the project for testing Set Up the Project for Testing After your team members havecompleted their developmenttasks, you'll want to deploy thevisual application to your VBStudio's test instance.

a) Add the Visual Builder testinstance to an environment

Add a Visual Builder Instanceto an Environment

Create an environment fortesting and add the VisualBuilder test instance to theenvironment.


Create a Packaging BuildJob, Create a DeploymentBuild Job, and Create andConfigure a Pipeline

Create and configure thepackaging and deploymentjobs so that your visualapplications will be promotedto your VB Studio's testinstance.



To restrict who can view abuild job's configuration, edit it,or run its build, mark the jobas private.


Set Up the Project to Deployfor Production

You will likely want to setthings up so that afteryour team members havecompleted their developmenttasks and tested theapplication thoroughly, thevisual application is deployedto your Visual Builderproduction instance.

a) Add the Visual Builderproduction instance to anenvironment

Add the Visual BuilderProduction Instance to anEnvironment

First, create an environmentand add the Visual Builderproduction instance to it.

Chapter 4

4-2




Next, create and configurethe packaging and deploymentjobs so that your visualapplications will be promotedto your Visual Builderproduction instance.



To restrict who can view thejob's configuration, edit it,or run its build, you shouldmark both packaging anddeployment jobs as private.

Before You BeginBefore you set up VB Studio, you may want to review VB Studio key concepts in KeyConcepts, Components, and Terms.

This table lists the identity domain roles you'll need to set up VB Studio:



Add users and assign IDCS roles.


Create the VB Studio instance.

DEVELOPER_ADMINISTRATOR Set up VB Studio. After you're assignedthe role, you're considered VB Studio'sOrganization Administrator.

OCI_Administrator (OCI Administrator) Set up OCI compartments and buckets, whichare required to set up the VB Studio buildsystem.


Create and manage VMs on OCI ComputeClassic and store artifacts on OCI ObjectStorage Classic. These roles are required onlyif you're an OCI Classic user.

To deploy visual applications, you'll also need access to standalone Visual Builderdevelopment, test, and production instances. If you're an Oracle Integration user, youcan also deploy applications to Visual Builder instances available in Oracle Integration.

Best PracticesHere are some best practices to follow while setting up VB Studio to develop visualapplications.

• Follow your organization's guidelines to create and set up Visual Builder instances.Your guideline may suggest to create instances for different software developmentenvironments, such as development, integration, test, pre-stage, stage, pre-production, and production. You can create these instances in different identitydomains or in a common identity domain.

Chapter 4Before You Begin

4-3

This documentation assumes that you have created and set up Visual Builderinstances for development, test, and production environments, where eachinstance is in a different identity domain.

• Create the VB Studio instance in the same Oracle Cloud account and identitydomain as the Visual Builder development instance. See Create the VB StudioInstance.

• Ensure that you and your organization's users are assigned the correct VB Studioidentity domain roles.

• If you're using OCI, keep these things in mind while setting up the OCI connectionin VB Studio:

– Create a separate compartment for VB Studio resources. This allows you toorganize resources better because they aren't mixed with the other resourcesin your tenancy.

– Create a separate group and a user to access the compartment.

– Create a policy that defines access to the compartment.

Set Up the OCI Connection tells you more about setting up a compartment, agroup, and a policy.

• Before you create a project, make sure that your Visual Builder development, test,and production instances are up and running.

• After creating the project, add VB Studio users to the project and assign themproper project roles.For example:

– Assign the Limited Developer role to users who can access the code files, butnot run build jobs.

– Assign the Contributor role to users who can access the project, but notupdate the code files.

– Assign the Developer role to trusted users who can access code files, build,and deploy the application.

• If you use the Visual Application template to create your project, VB Studioautomatically creates a Development environment that points to the VisualBuilder you specify. The build jobs, created by default, package and deploy theapplication's artifact to the Visual Builder.If you want to use VB Studio to also deploy to your Visual Builder test orproduction instance, you'll need to manually create a VB Studio environment foreach of those instances.

• To add Visual Builder test and production instances from other identity domains,get either the identity domain's details, or a user's credentials or personal accesstoken who can connect to the instance.

• Follow your organization's guidelines to create and manage Git repository'sbranches. By default, the project uses the master branch for development. Thisdocumentation assumes that you'll continue to use master as the developmentbranch and create separate branches for test and production.

• You should set restrictions on the test and production branches to control who canmerge to it.

• Build jobs in VB Studio run on Build VMs. Build VM templates define the operatingsystem and software installed on Build VMs. By default, a System Default OL7

Chapter 4Best Practices

4-4

for Visual Builder Build VM template is available with the necessary software tobuild visual applications, but no Build VMs are available.Before you run builds of the default build jobs, you should add Build VMs that usethe default System Default OL7 for Visual Builder Build VM template.

• To deploy to your Visual Builder test or production instances, create separate jobsto package the artifact and to deploy the artifact to the Visual Builder instance.Then, create a pipeline to run the packaging and deployment jobs in sequence.

• Set restrictions on who can edit or run production jobs.

• When you configure a deployment job, you'll specify the application's version andwhether you want to include the version in the deployed application's URL. Injobs that deploy to development, test, and non-production instances, include theversion number in the URL. In the job that deploys to the production instance,don't include the version number in the URL.

• Before you run production build jobs or pipeline, make sure that all code changeshave been pushed to the production branch and there are no open mergerequests.

Get Access to Visual Builder InstancesYou can deploy a visual application to a Visual Builder instance or to a Visual Builderinstance available in Oracle Integration. The Visual Builder instance must be version19.4.3.1, or later.

VB Studio doesn't support deployment to Visual Builder available in Oracle IntegrationGeneration 2, so you cannot add it to a VB Studio environment.

To deploy your visual application to Visual Builder development, test, and productioninstances, you'll need credentials or personal access tokens of users who can accessthem.

If an instance isn't available, then do this:

1. Create a Visual Builder Service Instance.To create an instance, you'll need the IDCSVISUALBUILDER_ENTITLEMENT_ADMINISTRATOR service role.

2. Add an IDCS User to Your Cloud Account and assign the user a Visual Builder roleto connect and deploy applications.

You should also make sure that administration settings in each Visual Builder instanceis configured as described in Administrative Tasks of Administering Oracle VisualBuilder.

Create the VB Studio Instance and Set Up the OCIConnection

1. Create the VB Studio Instance in the same Oracle Cloud account and identitydomain as the Visual Builder development instance.

2. Set Up the OCI Account.

3. Add Users to IDCS.

Chapter 4Get Access to Visual Builder Instances

4-5

Create a Project for Visual ApplicationsA project gathers all the resources you need for developing software. To ensure anoptimal environment for your employees creating visual applications, be sure to baseyour project on the Visual Application project template.

1. Sign in to VB Studio. See Access VB Studio from the Oracle Cloud Home Page.

2. On the Organization page, click + Create Project.

3. On the Project Details page, enter a unique name and description for the project.

4. In Security, select the project's privacy setting.

A private project is accessible to invited users only. Users who aren't invited can'taccess 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 viewthe source code, create or update issues, edit wiki pages, and interact with projectbuilds. However, only invited users can make updates to the source code in Gitrepositories, create and run build jobs, and perform deployment operations.



6. Click Next.

7. On the Template page, select the Visual Application project template, then clickNext.

When you choose a project template, some project artifacts are created for you.More on that later.

8. On the Visual Application Properties page:

a. (Optional) In Git Repository Name, update the project's Git repository'sdefault name, if required.

b. From Visual Application Template, select the visual application's template.

c. In Development VB Instance, select the Visual Builder developmentinstance.

The list shows Visual Builder instances defined in the same identity domain asthe VB Studio.If you're assigned the PaaSAdministrator IDCS role, you'll see both currentidentity domain's service instances and PSM Visual Builder instances in thislist. If you see both, select a PSM Visual Builder instance as it providesoptions to control the instance.

d. To create a private workspace along with the project, click the Create aWorkspace toggle button.

A workspace contains all the artifacts that you need to develop visualapplications, including a clone of this project's Git repository–and the branch–containing the source files. To learn more about workspaces, see What Is aWorkspace and Why Do I Need One?

In Workspace Name, enter a unique name.

Chapter 4Create a Project for Visual Applications

4-6

If you don't want to use the Git repository's master branch as the workspace'sworking branch, in Working Branch Name, enter the new branch's name.When the project is provisioned, VB Studio creates a copy of the masterbranch, renames it your specified name and uses it as the workspace'sworking branch.

e. In Wiki Markup, select the project's wiki markup language.

Project's users use the markup language to format wiki pages and comments.If you're not sure which markup language to choose, use the default markuplanguage. If required, you can change the markup language later fromthe Project Administration page. See Change a Project’s Wiki MarkupLanguage.

9. Click Finish.

After the project is provisioned, the Project Home page opens where you cansee a summary of the project's provisioning activities; default environments; defaultworkspaces; and Git repositories. Review the activities feed and the Environments boxfor any errors.When you create a project using the Visual Application template, these artifacts arecreated for you:

• A Git repository, which contains the visual application's source code.To see the Git repository's files, go to the Project Home page, click theRepositories tab, then click the Git repository name:

• A Development environment pointing to the Visual Builder development instance.

In the navigation menu, click Environments to see the Developmentenvironment:


4-7

• Build jobs that package and deploy the visual application's artifact to the VisualBuilder development instance.By default, Visual-Application-Package and Visual-Application-Deploy jobsare created for you. The Visual-Application-Package job generates the visualapplication's artifact file. The Visual-Application-Deploy job deploys the visualapplication's artifact file to the Visual Builder development instance.

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

By default, the packaging job uses the Git repository's master branch as thesource and triggers a build whenever a commit is pushed to it. To enable auser to run a build, you must first allocate Build VMs and make the appropriatedeployment configurations. See Set Up the Project for Development. Without theappropriate configuration or VMs, the build will fail.

• A pipeline to run the build jobs in a sequence.

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

• (Optional) A private workspace to edit the visual application in the VB StudioDesigner.

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


4-8

Set Up the Project for DevelopmentBefore your team members can use the project for developing visual applications, youneed to make a few configuration settings in the project.

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


1. Add Build VMs.VMs are needed to run build jobs for theproject.

Add Build VMs

2. (Optional) Configure the packaging job.By default, the packaging job generates twoarchive files: sources.zip and built-assets.zip.If you want to specify custom file names,configure the packaging job.

Configure the Packaging Job

3. Configure the deployment job.By default, the deployment job doesn'thave credentials to connect to the targetdevelopment instance, so you must specifythem manually.

Configure the Deployment Job

4. (Optional) Protect the Git repository'smaster branch.By default, a branch is accessible to all projectusers and anyone can make changes to itsfiles. To restrict changes and push commitsto the master branch, set restrictions on itto allow branch merges only after they areapproved.

Set Merge Restrictions on the master Branch

Add Build VMsBuilds in VB Studio run on Build VMs running in a Virtual Cloud Network (VCN). ABuild VM Template defines the operating system and software installed on Build VMs.

To find out more about Build VMs and Build VM templates, see What Are Build VMsand Build VM Templates?

You can run Build VMs in the VB Studio's default VCN or in your VCN. See Use VBStudio's Default VCN to learn about VB Studio's default VCN. To run builds in yourown VCN, see Run Build VMs in Your VCN.

To run builds of your visual applications, you should add Build VMs that use the defaultSystem Default OL7 for Visual Builder VM template. The System Default OL7


4-9

for Visual Builder VM template includes Node.js 10, which is the minimum versionrequired for packaging visual applications.



3. Click + Create VM.

4. In the Add Build VM dialog box, in Quantity, specify the number of VMs you wantto allocate.

To minimize build execution delays, set the number of VMs to the number of jobsthat 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 VMand then add more as required. Note that the more VMs you have running at aspecific time, the higher the cost of OCPUs. To minimize the higher cost, use theSleep Timeout setting on the Virtual Machines page to automatically shut downinactive VMs. You can always return to the Virtual Machines tab to remove or addVMs, based on your actual usage.

5. In VM Template, select System Default OL7 for Visual Builder.

6. In Region, Shape, and VCN Selection specify the VM's region, shape, and VirtualCloud 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 or OCI Compute Classic.Choose the region where your VB Studio account is or the one that's closestto you geographically.

• A shape is a template that determines the number of CPUs, amount ofmemory, and other resources allocated to the created instance. Choose ashape of your preference.

• A VCN is a software-defined network that you set up in the Oracle CloudInfrastructure data centers in a particular region. By default, builds run in yourVB Studio's compartment. To run builds in your own VCN, select Custom andspecify its details.

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

7. Click Add.

Configure the Packaging JobFrom the source files in the Git repository's master branch, the packaging jobgenerates two archive files: a source archive file that contains the visual application'ssource files and a build artifact archive file.

If you don't want to change the visual application's default archive file names, no needto configure the packaging job. If you want to specify custom names, follow thesesteps:


2. In the Jobs tab, click the packaging job.

3. Click Configure.


4-10





5. Click the Steps tab and navigate to the Visual Application Packaging section.

6. (Optional) By default, the build jobs minifies the application's source code beforerunning the build. If you don't want to minify the source files, deselect theOptimize application check box.

Minification is a process to remove the unnecessary characters (such as blankspaces, new lines, and comments) from the source code and reduce the size ofthe files, making the transfer of files consume less bandwidth and storage.

7. To change the default names of the archive files, in File names, select Usecustom file names.

In Sources, specify the visual application source archive file's name and path. InBuild Artifact, specify the build artifact archive file's name and path.You'll need both archive files to deploy the visual application.

8. Click Save.

Configure the Deployment JobThe deployment job deploys the visual application's build artifact to your Visual Builderdevelopment instance. In the job, specify the application's version and profile, andthe credentials required to connect and deploy build artifact to your Visual Builderdevelopment instance.


2. In the Jobs tab, click the deployment job.

3. Click Configure.



6. In the Oracle Deployment section, under Authorization, select one of theseoptions:

• To authenticate using a username and a password, select Use Credentials. InUsername and Password, enter the user's credentials who can connect anddeploy to the Visual Builder development instance.


7. (Optional) In the packaging job, if you changed the default file names of archiveartifact files, then in File names, select Use custom file names.

In Sources and Build Artifact, enter the same file names (with path) youspecified in the packaging job.

8. (Optional) To overwrite the application's default version, specify the new version inApplication Version. Leave it empty to use the version defined in the application'svisual-application.json file.


4-11

Don't deselect the Include the application version in the URL check box.

9. (Optional) In Application Profile, specify the development application profile.Leave it empty to use the application's default profile.

Your visual application accesses data from different servers for REST services(development, test, and production) and may need different security settingsfor different environments, such as development, test, and production. Usingapplication profiles, you can define different combinations of servers andsecurity settings for each of your environments, and use them when deployingthe application to an environment. This simplifies management of the visualapplication as you move through development and test to production. To learnmore, see About Application Profiles.

10. (Optional) To use the existing application's database, in Data Management, selectKeep existing environment data. To use a clean database for the application, inData Management, select Use clean database.

11. Click Save.

Get a Visual Builder User's Personal Access TokenTo get a user's personal access token, sign in to the Oracle Identity Cloud Serviceconsole with the user's credentials. To learn more, see Generate Personal AccessTokens.Personal access tokens have a short life. Generate them only when you need them.

Run the PipelineThe development build pipeline runs automatically when a commit is pushed to the Gitrepository's branch specified in the packaging job.





To monitor the pipeline, click the pipeline's name on the Builds page.

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

View the Deployed Visual ApplicationsAfter the deployment job has successfully run, you can view the deployed applicationsin the Deployments tab of the Environments page.


2. Select the Visual Builder environment.


4. Click the Visual Applications toggle button.

5. If the Visual Builder instance is from a different identity domain, provide thepersonal access token or its access credentials.


4-12

6. Expand the app's name to see the deployed app's link.

The Deployments tab displays the applications you've deployed from the currentproject. It doesn't show applications deployed by other users of the project, orapplications deployed from other projects.

Example:

Undeploy a Visual ApplicationYou can undeploy a visual application that's deployed to your current identity domain'sVisual Builder manually from the Deployments tab of its environment, or configure abuild job to undeploy it.

To undeploy a visual application that's deployed to Visual Builder of another identitydomain, configure a build job and run it. You can't undeploy it manually.

Undeploy a Visual Application Manually


2. Select the environment where the visual application is deployed.


4. Expand the application.

5. For the visual application to undeploy, click Actions and select Undeploy.

6. In the confirmation dialog box, click Undeploy.

Configure a Job to Undeploy a Visual ApplicationTo undeploy a visual application through a build job, you'll need either a personalaccess token or access credentials of a user who can access the Visual Builderinstance where the visual application is deployed.






6. Click Create.


4-13



9. From Add Step, select Visual Application, and then select Undeploy.

10. In Instance, select the Visual Builder instance where the application is deployed.

11. In Authorization, select one of these options:

• To authenticate using a username and a password, select Use Credentials. InUsername and Password, enter the user's credentials who can connect andundeploy from the Visual Builder instance.


12. In Application URL Root and Application Version, enter the visual application'sroot URL and its version.

You can find the application's root URL and its version from the Deployments tabof the environment where the visual application is deployed.Example:

13. Click Save.


Set Merge Restrictions on the master BranchBy default, the master branch is accessible to all project users and anyone can makechanges to its files. To restrict changes and who can push commits to it, you may wantto set restrictions on it to allow branch merges only after they are approved.


2. Click Branches.

3. In Repository and Branches, select the Git repository and the master 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 reviewerwhen a merge request is created on the branch.


4-14

6. From the Approvals drop-down list, select the minimum number of reviewers whomust approve the review branch of a merge request, where the selected branch isthe target branch

7. (Optional) To allow a review branch to be merged to the selected branch only ifthe last build of the linked job in Merge Request is successful, select the Requiresuccessful 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 pushedto a branch after they have approved the merge request, select the Reapprovalneeded when branch is updated check box.

9. (Optional) To ensure changes pushed to the target branch match the contents ofthe review branch, select the Changes pushed to target branch must matchreview content check box.

10. (Optional) In Merge Request Exempt Users, specify users who can bypass thebranch restrictions and merge the review branch of a merge request outside VBStudio or without required approvals.

This is useful if you want to allow some users to merge the review branchirrespective of review conditions being met.

11. Click Save.

Learn More About VB StudioNow that you've set up VB Studio and created a visual application project, it's time tolearn more about the other features that VB Studio offers.

• Get Started in Managing Your Development Process with Visual Builder Studiois a good resource, as it explains how to manage a project, create and manageissues and Agile boards, review source code with merge requests, and more.

• Build Web and Mobile Applications with VB Studio in Building Web and MobileApplications with Visual Builder Studio describes how to create, edit and publishvisual applications.

Add Users to the ProjectYou must explicitly add users before they can work within a project, as explained inthis table:


4-15

Action How To

Add a user to theproject 1. In the navigation menu, click Project Home .



4. In the Add Member dialog box, specify the new member’s projectmembership in Membership.To learn about different types of memberships, see What Are theVB Studio Project Memberships?

5. In Username, enter or select the user from the list.

6. Click Add.

Add multiple users tothe project 1. In the navigation menu, click Project Home .




5. In Username, enter or select the user from the list, and click Add

User .The selected user is added to the Username List text box. Ifyou know the usernames of users to add, enter them manuallyseparated by a space, a comma, a semicolon, or a new line.

6. Click Add.

Add users fromanother project

1. Open the project that has users already added.



4. Click Export .

5. In the Members List Export dialog box, copy the names of projectmembers.

6. Click OK or Close to close the dialog box.

7. Open the project where you want to add the copied users.





12. In Username List text box, paste the copied names of projectmembers.

13. Click Add.


4-16

Action How To

Change a user’sproject membership

To change a user’s membership, mouse over the user's name, click

Change Membership , and then select the membership.

Set Up the Project for TestingAfter your development and QA cycles are complete, you may want to configure theproject to build and deploy visual applications to the Visual Builder test instance, or theinstance you use to test the application before deploying it to the production instance.

Before you proceed, contact the Visual Builder administrator and make sure that theVisual Builder test instance is properly configured and running. For example, makesure that the test instance's security options are configured and the instance points tothe correct database.

Here's a summary of how to set up the VB Studio project. You can follow these stepsto configure the project for other non-production environments.


1. Create an environment for the Visual Buildertest instance.

Add a Visual Builder Instance to anEnvironment

2. Create a Git repository test branch from themaster branch.

Create a Test Branch

3. Create test packaging and deployment buildjobs, and then set up a pipeline.You may also want to restrict who can see oredit the test build jobs' configuration, or run itsbuild.


Add a Visual Builder Instance to an EnvironmentIf you want to set up things so that visual applications are deployed to the VisualBuilder test instance, you must create a separate VB Studio environment and add thecorrect instance to it. You can add only one Visual Builder instance to an environment.

Here's an example with development and test environments:

Your Visual Builder test instance can reside either in your current identity domain or inanother identity domain. If your test instance resides in another identity domain, to addit to an environment, you'll need any of these:

Chapter 4Set Up the Project for Testing

4-17

• Test instance's identity domain ID, region, and a user's credentials who canaccess the instance


• Visual Builder test instance's base URL and a user's credentials who can accessthe instance

When you add a Visual Builder instance (a service instance or an IDCS resource)to an environment, VB Studio creates an IDCS Application (also known as a ClientApplication) in the background. The IDCS Application generates an OAuth token toaccess the newly added Visual Builder instance and handles authentication when VBStudio tries to access the target instance. Provisioning of the IDCS Application takesa few seconds to complete after VB Studio adds the Visual Builder instance to anenvironment.

If the newly added instance stays in the Unknown status for some time, it typicallyindicates that the IDCS Application provisioning may have failed. VB Studio added theVisual Builder instance but can't access it. In such a case, delete the Visual Builderinstance from the environment and add it again.

Add a Connection to Visual Builder of Your Current Identity Domain





4. In the Add Service Instances dialog box, click the Visual Builder toggle button.


6. Select the check box for the Visual Builder instance you want to add and clickAdd.

If you're assigned the PaaSAdministrator IDCS role, you'll see both current identitydomain's service instances and PSM Visual Builder instances. In the Type column,the current identity domain's service instances are marked as IDCS Resource andPSM instances are marked as Visual Builder or Integration (if you're an OracleIntegration user). If you see both current identity domain's service instances andPSM instances, select a PSM Visual Builder instance as it provides options tocontrol the instance, such as start or stop the instance.

Remember, you can add only a single Visual Builder instance to an environment.

Add a Connection to Visual Builder of Another Identity Domain






4-18


If you have these details of the VisualBuilder instance you want to add:

Follow these steps:

Identity domain ID, region, username, andpassword


2. Click Edit next to the current identitydomain's details.

3. In Identity Domain Id/Identity Domain,enter the Visual Builder instance's identitydomain name or its ID. The ID is usually inthe idcs-<hexadecimalID> format.You can find the identity domain nameand the Identity Service ID in the Aboutdialog box of IDCS Dashboard.

4. In Region, select the identity domain'sregion.

5. In Username and Password, enter thecredentials of a user who can access theVisual Builder instance.

6. Click Update.

7. Select the check box for the Visual Builderinstance you want to add and click Add.

Personal access token of a user who canaccess the instanceTo generate the personal access token, seeGet a Visual Builder User's Personal AccessToken.



3. Click Add.

Visual Builder instance's base URL andcredentials of a user who can access theinstance

1. Select the Visual Builder Credentialsoption.

2. To add a standalone Visual Builderinstance, select the Visual Builder option.To add an Oracle Integration's VisualBuilder instance, select the OracleIntegration option.

3. In Base URL, enter the base VisualBuilder instance's URL.



6. Click Add.


4-19

Create a Test BranchFollow your organization's guidelines to create a branch and protect it from unverifiedchanges. To protect a branch, you can set merge restrictions, make the branch privateand restrict who can push commits to it, or freeze it.

To use an existing branch for Test, create a merge request with master as the reviewbranch and the test branch as the target branch. After approvals from reviewers,merge the review branch into the target branch.To create a branch from master, follow these steps:





5. In the New Branch dialog box, in Name, enter the branch name. From the Basedrop-down list, select master as the base branch.

6. Click Create.

After creating the test branch, if you want to set merge restrictions on it, see SetReview and Merge Restrictions on a Repository Branch. To freeze the branch or makeit private, or set other restrictions, see Protect a Branch.

Create and Configure Build JobsTo deploy visual applications to your Visual Builder test or any other instance, you'llneed to set up separate packaging and deployment jobs.

Here's an example of jobs that generate the visual application's artifact and deploy it tothe test and the development instance:


4-20

Here's an example of test and development pipelines:


• Access credentials or the personal access token of a Visual Builder user who canconnect and deploy to the Visual Builder test instance.

• Artifact archive file namesIn the development packaging job, if you changed the default file names of artifactarchive files, get the new names and their paths.


• Test application profileIf you've created an application profile for testing, get its name.

Create a Packaging Build JobThe packaging job generates a visual application artifact that's ready to deploy.






6. Click Create.




10. In Repository, select the Git repository. In Branch or Tag, select the test branchof the repository.


4-21

11. Select the Automatically perform build on SCM commit check box.


13. From Add Step, select Visual Application, and then select Package.

14. By default, the build jobs minifies the application's source code before runningthe build. If you don't want to minify the source files, deselect the Optimizeapplication check box.


15. If you want to change the default names of the archive files, in File names, selectUse custom file names.




18. In Files to archive, enter the build artifact name. You can also use wildcharacters. For example, *.zip.

19. If you want to discard old artifacts of the build, click Settings . In the Generaltab, select the Discard Old Builds check box and specify the discard options.

20. Click Save.

Create a Deployment Build JobThe deployment job deploys the visual application's artifact that was generated in thepackaging job to the Visual Builder test instance. Before you create the job, get theaccess credentials or the personal access token of a Visual Builder user who canconnect and deploy to the Visual Builder test instance.






6. Click Create.




10. In From Job, select the packaging job that generated the visual application'sartifact.

11. In Which Build, select Last Successful Build.



4-22



15. In Target Instance, select the environment that points to the Visual Builder testinstance.


• To authenticate using a username and a password, select Use Credentials. InUsername and Password, enter the user's credentials who can connect anddeploy to Visual Builder test instance.


17. In the packaging job, if you changed the default file names of archive artifact files,then in File names, select Use custom file names.


18. To overwrite the application's default version, specify the new version inApplication Version. Leave it empty to use the version defined in the application'svisual-application.json file.

Don't deselect the Include the application version in the URL check box.

19. In Application Profile, specify the test application profile. Leave it empty to usethe application's default profile.


20. To use a clean database for the application, in Data Management, select Useclean database.

21. Click Save.

Configure a Job's Privacy SettingMark a job as private to restrict who can see or edit a job's configuration, or run itsbuild:


2. Click Builds.






4-23


7. Click Save.








5. Click Create.


Example:

7. Mouse over the Start node's Gray circle . The cursor icon changes to the +cursor icon. Drag the cursor from the Gray circle handle to the packaging job'sWhite circle handle. An arrow line appears.

Example:

8. Mouse-over the packaging job's Blue circle handle and drag-and-drop thearrow head over the deployment job's White circle .

Example:

9. Click Save.


4-24

Run the PipelineThe test build pipeline runs automatically when a commit is pushed to the Gitrepository's test branch specified in the packaging job.





To monitor the pipeline, click the pipeline's name on the Builds page. After asuccessful build, you'll find the deployed application's link in the Deployments tabof the Environments page.

If you want to run a job's build manually, open the job's details page and click BuildNow. You can monitor its build on the job's details page. To view the latest build log of

a job, open the Builds page, click the job's name, and then click Build Log .

Undeploy a Visual ApplicationYou can undeploy a visual application that's deployed to your current identity domain'sVisual Builder manually from the Deployments tab of its environment, or configure abuild job to undeploy it.

To undeploy a visual application that's deployed to Visual Builder of another identitydomain, configure a build job and run it. You can't undeploy it manually.

Undeploy a Visual Application Manually


2. Select the environment where the visual application is deployed.


4. Expand the application.

5. For the visual application to undeploy, click Actions and select Undeploy.

6. In the confirmation dialog box, click Undeploy.








4-25

6. Click Create.










13. Click Save.


Set Up the Project to Deploy for ProductionAfter your development and test cycles are complete, you may want to configurethe project to build and deploy visual applications to the Visual Builder productioninstance.

Before you proceed, contact the Visual Builder administrator and make sure that theVisual Builder production instance is properly configured and running. For example,make sure that the test instance's security options are configured and the instancepoints to the correct database.

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

Chapter 4Set Up the Project to Deploy for Production

4-26


1. In the VB Studio project, create anenvironment for the Visual Builder productioninstance.

Add the Visual Builder Production Instance toan Environment

2. Create a production branch from thetest branch. Use this branch to push yourapplication to production.

Create a Production Branch

3. Create the production packaging anddeployment build jobs, and set up the pipeline.

Create and Configure Production Build Jobs

4. (Optional) Restrict users who can edit theproduction jobs or run their builds.

Configure a Job's Privacy Setting

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

Add the Visual Builder Production Instance to an EnvironmentTo deploy a visual application to the Visual Builder production instance, you mustcreate a separate VB Studio environment and add the production instance to it. Youcan add only one Visual Builder instance to an environment.

The Visual Builder production instance usually resides in another identity domain. Toadd the production instance to an environment, you'll need any of these details:

• Production instance's identity domain ID, region, and a user's credentials who canaccess the instance


• Visual Builder production instance's base URL and a user's credentials who canaccess the instance

When you add a Visual Builder instance (a service instance or an IDCS resource)to an environment, VB Studio creates an IDCS Application (also known as a ClientApplication) in the background. The IDCS Application generates an OAuth token toaccess the newly added Visual Builder instance and handles authentication when VBStudio tries to access the target instance. Provisioning of the IDCS Application takesa few seconds to complete after VB Studio adds the Visual Builder instance to anenvironment.

If the newly added instance stays in the Unknown status for some time, it typicallyindicates that the IDCS Application provisioning may have failed. VB Studio added theVisual Builder instance but can't access it. In such a case, delete the Visual Builderinstance from the environment and add it again.

Add a Connection to Visual Builder of Another Identity Domain






4-27


If you have these details of the VisualBuilder instance you want to add:

Follow these steps:

Identity domain ID, region, username, andpassword


2. Click Edit next to the current identitydomain's details.

3. In Identity Domain Id/Identity Domain,enter the Visual Builder instance's identitydomain name or its ID. The ID is usually inthe idcs-<hexadecimalID> format.You can find the identity domain nameand the Identity Service ID in the Aboutdialog box of IDCS Dashboard.

4. In Region, select the identity domain'sregion.


6. Click Update.

7. Select the check box for the Visual Builderinstance you want to add and click Add.

Personal access token of a user who canaccess the instanceTo generate the personal access token, seeGet a Visual Builder User's Personal AccessToken.



3. Click Add.

Visual Builder instance's base URL andcredentials of a user who can access theinstance

1. Select the Visual Builder Credentialsoption.

2. To add a standalone Visual Builderinstance, select the Visual Builder option.To add an Oracle Integration's VisualBuilder instance, select the OracleIntegration option.

3. In Base URL, enter the base VisualBuilder instance's URL.



6. Click Add.


4-28

Create a Production BranchFollow your organization's guidelines to create a branch and protect it from unverifiedchanges. To protect the branch, you can set merge restrictions, make the branchprivate and restrict who can push commits to it, or freeze it.

If you want to use an existing production branch and merge changes from the testbranch to it, then create a merge request with the test branch as the review branchand the production branch as the target branch. After approvals from reviewers, mergethe review branch into the target branch.To create a production branch from the test branch, follow these steps:





5. In the New Branch dialog box, in Name, enter the branch name. From the Basedrop-down list, select the test branch as the base branch.

6. Click Create.

After creating the production branch, if you want to set merge restrictions on it, see SetReview and Merge Restrictions on a Repository Branch. To freeze the branch or makeit private, or set other restrictions, see Protect a Branch.

Create and Configure Production Build JobsYou need to set up some packaging and deployment jobs before you can deploy visualapplications to your Visual Builder production instance. This topic explains how to dothat.

Before you configure production build jobs, make a note of these:

• In the production packaging job, use the Git repository's production branch togenerate production artifacts.

• In the test packaging job, if you changed the default file names of archive artifactfiles, get the new names and their paths. You'll need them when you configure theproduction packaging job.

• If you configured the test packaging job to overwrite the application's versiondefined in visual-application.json, get the new version. You'll need it when youconfigure the production packaging job.

• In the production deployment job, don't include the application's version in theapp's URL. The visual application must be deployed without the version in its URL.

• You can only deploy only one production application without version in its URL tothe Visual Builder production instance.

• If you deploy a version of visual application that's never been deployed, VB Studiooverwrites the last deployed version with the new version.VB Studio doesn't undeploy the previously deployed version from the productioninstance. It continues to remain on the target instance, but is inaccessible.


4-29

• If you want to redeploy a previously deployed version, undeploy it first, else thedeploy build fails. To undeploy a previously deployed production visual applicationversion, configure a build job and run it. You can't undeploy it manually from theEnvironments page.

• If you've created an application profile for production, get its name. You'll need itwhen you configure the production deployment job.

Create a Production Packaging Build JobThe production packaging job generates a visual application artifact that's ready todeploy.






6. Click Create.




10. In Repository, select the Git repository. In Branch or Tag, select the productionbranch.


12. From Add Step, select Visual Application, and then select Package.

13. By default, the build jobs minifies the application's source code before runningthe build. If you don't want to minify the source files, deselect the Optimizeapplication check box.


14. If you want to change the default names of the archive files, in File names, selectUse custom file names.




17. In Files to archive, enter the build artifact name. You can also use wildcharacters. For example, *.zip.

18. If you want to discard old artifacts of the build, click Settings . In the Generaltab, select the Discard Old Builds check box and specify the discard options.

19. Click Save.


4-30

Create a Production Deployment Build JobThe production deployment job deploys the visual application's artifact that wasgenerated in the production packaging job to the Visual Builder production instance.Before you create the job, get the access credentials or the personal access token of auser who can connect and deploy to the Visual Builder production instance.






6. Click Create.




10. In From Job, select the production packaging job that generated the visualapplication's artifact.

11. In Which Build, select Last Successful Build.




15. In Target Instance, select the Visual Builder production instance.


• To authenticate using a username and a password, select Use Credentials. InUsername and Password, enter the user's credentials who can connect anddeploy to the Visual Builder production instance.


17. In the production packaging job, if you changed the default file names of archiveartifact files, then in File names, select Use custom file names.


18. (Optional) To overwrite the application's default version, specify the new version inApplication Version. Leave it empty to use the version defined in the application'svisual-application.json file.

If the version is already deployed, undeploy it first.

19. Deselect the Include the application version in the URL check box.


4-31

When deploying to a production instance, don't include the application's version inthe deployed application's URL.

20. (Optional) In Application Profile, specify the production application profile. Leaveit empty to use the application's default profile.


21. To use a clean database for the application, in Data Management, select Useclean database.

22. Click Save.

Configure a Production Job's Privacy SettingMark a job as private to restrict who can see or edit a job's configuration, or run itsbuild.



2. Click Builds.


4. From the jobs list, select the packaging production job.




7. Repeat the steps 4-6 for the deployment production job.

8. Click Save.


Create and Configure a PipelineTo ensure the production deployment job runs automatically after the productionpackaging job, create a pipeline and set the dependency.






4-32

5. Click Create.


Example:

7. Mouse over the Start node's Gray circle . The cursor icon changes to the +cursor icon. Drag the cursor from the Gray circle handle to the packaging job'sWhite circle handle. An arrow line appears.

Example:

8. Mouse-over the packaging job's Blue circle handle and drag-and-drop thearrow head over the deployment job's White circle .

Example:

9. Click Save.

Run the PipelineTo run the production packaging job and the deployment job in sequence, run theproduction pipeline.



3. For the production pipeline, click Build .

After a successful build, you'll find the deployed application's link in the Deploymentstab of the Environments page.

To view the latest build log of a job, open the Builds page, click the job's name, and

then click Build Log .



4-33






6. Click Create.










13. Click Save.



4-34

5Manage Your Component Exchange

If your team develops custom components for visual applications and want thecomponents to be available to all users in the VB Studio Designer Components tab,you'll need to first set up a component exchange. This chapter tells you how to set upthe Component Exchange in VB Studio.

What is a Component Exchange?A Component Exchange is a repository of custom components that you use in yourvisual applications. The custom components include web components, applicationtemplates, UI patterns, and actions and are available to all VB Studio users.

To host the custom components, you can define either a VB Studio project or anexternal server as the Component Exchange. Any VB Studio project can be used asthe Component Exchange, but you should create and set up a separate project to hostcomponents. If you have multiple VB Studio instances across multiple tenancies, youcan specify an external server as the common Component Exchange for all VB Studioinstances.

To use a project or a server as the Component Exchange, specify its details onthe Organization page. When set, the VB Studio Designer automatically shows theComponent Exchange's hosted components in the Components tab.

Use a Project as the VB Studio Component Exchange1. On the Organization page, click + Create Project.

If you've already created a project to use as Component Exchange, jump to step10.

2. On the Details page, enter a unique name and description for the project.

Example:

5-1

3. In Security, select Shared.



5. Click Next.

6. On the Template page, select Empty Project, and click Next.

7. In Wiki Markup, select the project's wiki markup language.

Project's users use the markup language to format wiki pages and comments.If you're not sure which markup language to choose, use the default markuplanguage. You can change the markup language later from the ProjectAdministration page. See Change a Project’s Wiki Markup Language.

8. Click Finish.

After the project is provisioned, you're navigated to the Project Home page.

9. Add users to the project and assign them proper memberships. See Add Users tothe Project.

Add users who would develop the components and assign them eitherthe Developer or Limited Developer membership. Assign the Project Ownermembership to trusted users only. Remember that a user with the Project Ownermembership can delete the project and Git repositories.


11. Click the Component Exchange tab.

12. Click Edit.

13. Select the Enable organization-wide component hosting check box.

14. Select the In a project option.

15. In Select Project, select the project you created.

16. Click Save.

That's it. When your team members upload the components to the ComponentExchange, they'll be automatically available in the Designer's Component tab.

Use an External Server as the VB Studio ComponentExchange


2. Click the Component Exchange tab.

3. Select the Enable organization-wide component hosting check box.

4. Select the Custom Server option.

5. In Server URL, enter the server's URL.

6. In Username and Password, enter the access credentials.

7. Click Test Connection.

Chapter 5Use an External Server as the VB Studio Component Exchange

5-2

8. When the connection is successful, click Save.

Share the Component Exchange's URLAfter defining a project or an external server as the Component Exchange, share itsURL with developers who'll upload components.

If you've defined an external server as the Component Exchange, share its URLas-it-is with developers.If you've defined a project as the Component Exchange, share its URL in the https://{hostname}/{org_id}/s/{project_id}/compcatalog/0.2.0/ format. These steps tellyou how to construct the URL in the required format.

1. Open the Component Exchange project's Project Home page.

2. In the Maven section of the Repositories tab, click the Project Repository's

URLs drop-down list and then click the HTTPS URL's Copy icon.

Example:

3. Paste the copied URL in a text editor.

4. In the copied URL, remove the profile/ and maven/ elements.

For example, if the copied URLis https://vbs-vbstest.developer.ocp.oraclecloud.com/profile/vbs-vbstest/s/vbs-vbstest_my-project_902/maven/, then remove the elementsmarked in bold.After removing the elements, the URL should be similar to this:

Chapter 5Share the Component Exchange's URL

5-3

https://vbs-vbstest.developer.ocp.oraclecloud.com/vbs-vbstest/s/vbs-vbstest_my-project_902/

5. Append compcatalog/0.2.0 at the end of the URL.

For example: https://vbs-vbstest.developer.ocp.oraclecloud.com/vbs-vbstest/s/vbs-vbstest_my-project_902/compcatalog/0.2.0

6. Share the URL with developers who'll upload components to the ComponentExchange.

Workflow for Web ComponentsTo find out how to create a web component; test it; use it in your application; build,package, and deploy it to the component exchange, see Typical Workflow for Workingwith Oracle JET Web Components in Developing Applications with Oracle JET.

Chapter 5Workflow for Web Components

5-4

Documents

Administering Visual Builder Studio...IDCS Roles1-13 What Are the VB Studio Project Memberships?1-14 Set Up Oracle Visual Builder Studio to Manage Your Development CycleCycle Cycle