4 Set Up VB Studio for Developing Visual Applications

This chapter tells you how to set up Oracle Visual Builder Studio (VB Studio) so that your users can create visual applications.

A visual application is a responsive web or native mobile application developed using VB Studio's browser-based development environment. You deploy a visual application to a Visual Builder instance or to a Visual Builder instance available in Oracle Integration. The Visual Builder instance must be version 19.4.3.1, or later. This documentation assumes that you have created and set up Visual Builder instances for development, test, and production environments in different identity domains.

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

To perform this action: See this: Why do I need to perform this action?
1. Get the required IDCS roles assigned to you Before You Begin To create and set up the VB Studio instance, you must be assigned some specific IDCS roles.
2. Create the VB Studio instance Create the VB Studio Instance To use any Oracle Cloud service, you must first create an instance of the service.
3. Set up OCI or OCI Classic connections Connect to OCI or OCI Classic You need a connection to OCI or OCI Classic Compute VMs because this is where your VB Studio builds will run.
4. Get access to Visual Builder instances Get Access to Visual Builder Instances To deploy an app, you need a user's credentials who can deploy apps to the Visual Builder instance. If an instance isn't available, you must create it.
5. Create a project for visual applications Create a Project for Visual Applications To develop a visual application, you must create a VB Studio project based on the Visual Application template.
6. Set up the project for development Set Up the Project for Development When you create a project based on the Visual Application template, some artifacts are created by default. These artifacts require additional configuration before your team members can use them.
a) Add Build VMs Add Build VMs To run visual application's development, test, or production builds, you must create build jobs. Build jobs in VB Studio run on Build VMs. Only VB Studio administrators can create and manage the Build VMs.
b) Configure the packaging and deployment jobs Configure the Packaging Job and Configure the Deployment Job When you create a visual application project, certain packaging and deployment build jobs are created by default, but they're missing some configuration options. You must specify them manually.
7. Add users to the project Add Users to the Project To allow your team members to access the visual application project, invite them to join the project.
8. Set up the project for testing Set Up the Project for Testing After your team members have completed their development tasks, you'll want to deploy the visual application to your VB Studio's test instance.
a) Add the Visual Builder test instance to an environment Add a Visual Builder Instance to an Environment Create an environment for testing and add the Visual Builder test instance to the environment.
b) Create the packaging and deployment build jobs, and set up a build pipeline Create a Packaging Build Job, Create a Deployment Build Job, and Create and Configure a Pipeline Create and configure the packaging and deployment jobs so that your visual applications will be promoted to your VB Studio's test instance.
c) (Optional) Restrict access to the build jobs Configure a Job's Privacy Setting To restrict who can view a build job's configuration, edit it, or run its build, mark the job as private.
9. Set up the project for deployment to production Set Up the Project to Deploy for Production You will likely want to set things up so that after your team members have completed their development tasks and tested the application thoroughly, the visual application is deployed to your Visual Builder production instance.
a) Add the Visual Builder production instance to an environment Add the Visual Builder Production Instance to an Environment First, create an environment and add the Visual Builder production instance to it.
b) Create the packaging and deployment build jobs, and set up a build pipeline Create a Production Packaging Build Job, Create a Production Deployment Build Job, and Create and Configure a Pipeline Next, create and configure the packaging and deployment jobs so that your visual applications will be promoted to your Visual Builder production instance.
c) (Optional) Restrict access to the build jobs Configure a Job's Privacy Setting To restrict who can view the job's configuration, edit it, or run its build, you should mark both packaging and deployment jobs as private.

Before You Begin

Before you set up VB Studio, you may want to review VB Studio key concepts in Key Concepts, Components, and Terms.

This table lists the identity domain roles you'll need to set up VB Studio:

You must be assigned this role: To ...
Identity Domain Administrator or User Administrator Add users and assign IDCS roles.
DEVCS_APP_ENTITLEMENT_ADMINISTRATOR Create the VB Studio instance.
DEVELOPER_ADMINISTRATOR Set up VB Studio. After you're assigned the role, you're considered VB Studio's Organization Administrator.
OCI_Administrator (OCI Administrator) Set up OCI compartments and buckets, which are required to set up the VB Studio build system.
Compute.Compute_Operations and Storage.Storage_Administrator Create and manage VMs on OCI Compute Classic and store artifacts on OCI Object Storage Classic. These roles are required only if you're an OCI Classic user.

To deploy visual applications, you'll also need access to standalone Visual Builder development, test, and production instances. If you're an Oracle Integration user, you can also deploy applications to Visual Builder instances available in Oracle Integration.

Best Practices

Here are some best practices to follow while setting up VB Studio to develop visual applications.

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

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

  • Create the VB Studio instance in the same Oracle Cloud account and identity domain as the Visual Builder development instance. See Create the VB Studio Instance.
  • Ensure that you and your organization's users are assigned the correct VB Studio identity domain roles.
  • If you're using OCI, keep these things in mind while setting up the OCI connection in VB Studio:
    • Create a separate compartment for VB Studio resources. This allows you to organize resources better because they aren't mixed with the other resources in 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, a group, 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 them proper project roles.

    For example:

    • Assign the Limited Developer role to users who can access the code files, but not run build jobs.
    • Assign the Contributor role to users who can access the project, but not update the code files.
    • Assign the Developer role to trusted users who can access code files, build, and deploy the application.
  • If you use the Visual Application template to create your project, VB Studio automatically creates a Development environment that points to the Visual Builder you specify. The build jobs, created by default, package and deploy the application's artifact to the Visual Builder.

    If you want to use VB Studio to also deploy to your Visual Builder test or production instance, you'll need to manually create a VB Studio environment for each 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 access token who can connect to the instance.
  • Follow your organization's guidelines to create and manage Git repository's branches. By default, the project uses the master branch for development. This documentation assumes that you'll continue to use master as the development branch and create separate branches for test and production.
  • You should set restrictions on the test and production branches to control who can merge to it.
  • Build jobs in VB Studio run on Build VMs. Build VM templates define the operating system and software installed on Build VMs. By default, a System Default OL7 for Visual Builder Build VM template is available with the necessary software to build visual applications, but no Build VMs are available.

    Before you run builds of the default build jobs, you should add Build VMs that use the default System Default OL7 for Visual Builder Build VM template.

  • To deploy to your Visual Builder test or production instances, create separate jobs to 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 and whether you want to include the version in the deployed application's URL. In jobs that deploy to development, test, and non-production instances, include the version 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 changes have been pushed to the production branch and there are no open merge requests.

Get Access to Visual Builder Instances

You can deploy a visual application to a Visual Builder instance or to a Visual Builder instance available in Oracle Integration. The Visual Builder instance must be version 19.4.3.1, or later.

VB Studio doesn't support deployment to Visual Builder available in Oracle Integration Generation 2, so you cannot add it to a VB Studio environment.

To deploy your visual application to Visual Builder development, test, and production instances, you'll need credentials or personal access tokens of users who can access them.

If an instance isn't available, then do this:

  1. Create a Visual Builder Service Instance.

    To create an instance, you'll need the IDCS VISUALBUILDER_ENTITLEMENT_ADMINISTRATOR service role.

  2. Add an IDCS User to Your Cloud Account and assign the user a Visual Builder role to connect and deploy applications.

You should also make sure that administration settings in each Visual Builder instance is configured as described in Administrative Tasks of Administering Oracle Visual Builder.

Create the VB Studio Instance and Set Up the OCI Connection

  1. Create the VB Studio Instance in the same Oracle Cloud account and identity domain as the Visual Builder development instance.
  2. Set Up the OCI Account.
  3. Add Users to IDCS.

Create a Project for Visual Applications

A project gathers all the resources you need for developing software. To ensure an optimal environment for your employees creating visual applications, be sure to base your 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't access it or make changes to it. You can invite users after creating the project.

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

  5. In Preferred Language, specify the language for the email notifications your project users will receive.
    You can change the language in which the user interface appears in your user preferences.
  6. Click Next.
  7. On the Template page, select the Visual Application project template, then click Next.
    When you choose a project template, some project artifacts are created for you. More on that later.
  8. On the Visual Application Properties page:
    1. (Optional) In Git Repository Name, update the project's Git repository's default name, if required.
    2. From Visual Application Template, select the visual application's template.
    3. In Development VB Instance, select the Visual Builder development instance.
      The list shows Visual Builder instances defined in the same identity domain as the VB Studio.

      If you're assigned the PaaSAdministrator IDCS role, you'll see both current identity domain's service instances and PSM Visual Builder instances in this list. If you see both, select a PSM Visual Builder instance as it provides options to control the instance.

    4. To create a private workspace along with the project, click the Create a Workspace toggle button.

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

      In Workspace Name, enter a unique name.

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

    5. 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 markup language. If required, you can change the markup language later from the Project Administration 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 see a summary of the project's provisioning activities; default environments; default workspaces; and Git repositories. Review the activities feed and the Environments box for any errors.

When you create a project using the Visual Application template, these artifacts are created 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 the Repositories tab, then click the Git repository name:

  • A Development environment pointing to the Visual Builder development instance.

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

  • Build jobs that package and deploy the visual application's artifact to the Visual Builder development instance.

    By default, Visual-Application-Package and Visual-Application-Deploy jobs are created for you. The Visual-Application-Package job generates the visual application's artifact file. The Visual-Application-Deploy job deploys the visual application's artifact file to the Visual Builder development instance.

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

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

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

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

  • (Optional) A private workspace to edit the visual application in the VB Studio Designer.

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

Set Up the Project for Development

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

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

To perform this action: See this:
1. Add Build VMs.

VMs are needed to run build jobs for the project.

Add Build VMs
2. (Optional) Configure the packaging job.

By default, the packaging job generates two archive 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't have credentials to connect to the target development instance, so you must specify them manually.

Configure the Deployment Job
4. (Optional) Protect the Git repository's master branch.

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

Set Merge Restrictions on the master Branch

Add Build VMs

Builds in VB Studio run on Build VMs running in a Virtual Cloud Network (VCN). A Build 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 VMs and Build VM Templates?

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

To run builds of your visual applications, you should add Build VMs that use the default System Default OL7 for Visual Builder VM template. The System Default OL7 for Visual Builder VM template includes Node.js 10, which is the minimum version required for packaging visual applications.

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

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

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

  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 Virtual Cloud Network (VCN).
    • A region is a localized geographic area where the data centers are located. Remember, a Build VM is a VM on OCI Compute or OCI Compute Classic. Choose the region where your VB Studio account is or the one that's closest to you geographically.
    • A shape is a template that determines the number of CPUs, amount of memory, and other resources allocated to the created instance. Choose a shape of your preference.
    • A VCN is a software-defined network that you set up in the Oracle Cloud Infrastructure data centers in a particular region. By default, builds run in your VB Studio's compartment. To run builds in your own VCN, select Custom and specify its details.

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

  7. Click Add.

Configure the Packaging Job

From the source files in the Git repository's master branch, the packaging job generates two archive files: a source archive file that contains the visual application's source files and a build artifact archive file.

If you don't want to change the visual application's default archive file names, no need to configure the packaging job. If you want to specify custom names, follow these steps:
  1. In the navigation menu, click Builds Builds.
  2. In the Jobs tab, click the packaging job.
  3. Click Configure.
  4. Click Configure the Tools icon.
  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 before running the build. If you don't want to minify the source files, deselect the Optimize application check box.
    Minification is a process to remove the unnecessary characters (such as blank spaces, new lines, and comments) from the source code and reduce the size of the 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 Use custom file names.
    In Sources, specify the visual application source archive file's name and path. In Build 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 Job

The deployment job deploys the visual application's build artifact to your Visual Builder development instance. In the job, specify the application's version and profile, and the credentials required to connect and deploy build artifact to your Visual Builder development instance.

  1. In the navigation menu, click Builds Builds.
  2. In the Jobs tab, click the deployment job.
  3. Click Configure.
  4. Click Configure the Tools icon.
  5. Click the Steps tab.
  6. In the Oracle Deployment section, under 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 and deploy to the Visual Builder development instance.
    • To authenticate using the user's personal access token, select Use Access Token. Click Set Access Token, upload the token file, and click OK.

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

  7. (Optional) In the packaging job, if you changed the default file names of archive artifact files, then in File names, select Use custom file names.
    In Sources and Build Artifact, enter the same file names (with path) you specified in the packaging job.
  8. (Optional) To overwrite the application's default version, specify the new version in Application Version. Leave it empty to use the version defined in the application's visual-application.json file.
    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 settings for different environments, such as development, test, and production. Using application profiles, you can define different combinations of servers and security settings for each of your environments, and use them when deploying the application to an environment. This simplifies management of the visual application as you move through development and test to production. To learn more, see About Application Profiles.

  10. (Optional) To use the existing application's database, in Data Management, select Keep existing environment data. To use a clean database for the application, in Data Management, select Use clean database.
  11. Click Save.

Get a Visual Builder User's Personal Access Token

To get a user's personal access token, sign in to the Oracle Identity Cloud Service console with the user's credentials. To learn more, see Generate Personal Access Tokens.

Personal access tokens have a short life. Generate them only when you need them.

Run the Pipeline

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

If you want to run the pipeline manually:
  1. In the navigation menu, click Builds Builds.
  2. Click the Pipelines tab.
  3. For the pipeline you want to run, click Build 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 Build Now. You can monitor its build on the job's details page.

View the Deployed Visual Applications

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

  1. In the navigation menu, click Environments Environments.
  2. Select the Visual Builder environment.
  3. Click the Deployments tab.
  4. Click the Visual Applications toggle button.
  5. If the Visual Builder instance is from a different identity domain, provide the personal access token or its access credentials.
  6. Expand the app's name to see the deployed app's link.

    The Deployments tab displays the applications you've deployed from the current project. It doesn't show applications deployed by other users of the project, or applications deployed from other projects.

    Example:

Undeploy a Visual Application

You can undeploy a visual application that's deployed to your current identity domain's Visual Builder manually from the Deployments tab of its environment, or configure a build job to undeploy it.

To undeploy a visual application that's deployed to Visual Builder of another identity domain, configure a build job and run it. You can't undeploy it manually.
Undeploy a Visual Application Manually
  1. In the navigation menu, click Environments Environments.
  2. Select the environment where the visual application is deployed.
  3. Click the Deployments tab.
  4. Expand the application.
  5. For the visual application to undeploy, click Actions Hamburger icon and select Undeploy.
  6. In the confirmation dialog box, click Undeploy.
Configure a Job to Undeploy a Visual Application
To undeploy a visual application through a build job, you'll need either a personal access token or access credentials of a user who can access the Visual Builder instance where the visual application is deployed.
  1. In the navigation menu, click Builds Builds.
  2. In the Jobs tab, click + Create Job.
  3. In the New Job dialog box, in Name, enter a unique name.
  4. In Description, enter the job's description.
  5. In Template, select the System Default OL7 for Visual Builder template.
  6. Click Create.
  7. Click Configure the Tools icon.
  8. Click the Steps tab.
  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. In Username and Password, enter the user's credentials who can connect and undeploy from the Visual Builder instance.
    • To authenticate using the user's personal access token, select Use Access Token. Click Set Access Token, upload the token file, and click OK.

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

  12. In Application URL Root and Application Version, enter the visual application's root URL and its version.
    You can find the application's root URL and its version from the Deployments tab of the environment where the visual application is deployed.

    Example:

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

Set Merge Restrictions on the master Branch

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

  1. In the navigation menu, click Project Administration Gear.
  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 reviewer when a merge request is created on the branch.
  6. From the Approvals drop-down list, select the minimum number of reviewers who must approve the review branch of a merge request, where the selected branch is the target branch
  7. (Optional) To allow a review branch to be merged to the selected branch only if the last build of the linked job in Merge Request is successful, select the Require successful build check box.
    To use this option, link a build job to a merge request.
  8. (Optional) If you want to reset the approval status of reviewers if change is pushed to a branch after they have approved the merge request, select the Reapproval needed when branch is updated check box.
  9. (Optional) To ensure changes pushed to the target branch match the contents of the review branch, select the Changes pushed to target branch must match review content check box.
  10. (Optional) In Merge Request Exempt Users, specify users who can bypass the branch restrictions and merge the review branch of a merge request outside VB Studio or without required approvals.
    This is useful if you want to allow some users to merge the review branch irrespective of review conditions being met.
  11. Click Save.

Learn More About VB Studio

Now that you've set up VB Studio and created a visual application project, it's time to learn more about the other features that VB Studio offers.

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

  • Build Web and Mobile Applications with VB Studio in Building Web and Mobile Applications with Visual Builder Studio describes how to create, edit and publish visual applications.

Add Users to the Project

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

Action How To

Add a user to the project

  1. In the navigation menu, click Project Home Project Home.
  2. Click the Team tab.
  3. Click + Add Member.
  4. In the Add Member dialog box, specify the new member’s project membership in Membership.

    To learn about different types of memberships, see What Are the VB Studio Project Memberships?

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

Add multiple users to the project

  1. In the navigation menu, click Project Home Project Home.
  2. Click the Team tab.
  3. Click + Add Member.
  4. In the Add Member dialog box, select the Multiple Users check box.
  5. In Username, enter or select the user from the list, and click Add User the add user icon.

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

  6. Click Add.
Add users from another project
  1. Open the project that has users already added.
  2. In the navigation menu, click Project Home Project Home.
  3. Click the Team tab.
  4. Click Export the export members icon.
  5. In the Members List Export dialog box, copy the names of project members.
  6. Click OK or Close the close icon to close the dialog box.
  7. Open the project where you want to add the copied users.
  8. In the navigation menu, click Project Home Project Home.
  9. Click the Team tab.
  10. Click + Add Member.
  11. In the Add Member dialog box, select the Multiple Users check box.
  12. In Username List text box, paste the copied names of project members.
  13. Click Add.

Change a user’s project membership

To change a user’s membership, mouse over the user's name, click Change Membership the Change Membership icon, and then select the membership.

Set Up the Project for Testing

After your development and QA cycles are complete, you may want to configure the project to build and deploy visual applications to the Visual Builder test instance, or the instance 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 the Visual Builder test instance is properly configured and running. For example, make sure that the test instance's security options are configured and the instance points to the correct database.

Here's a summary of how to set up the VB Studio project. You can follow these steps to configure the project for other non-production environments.

To perform this action: See this:
1. Create an environment for the Visual Builder test instance. Add a Visual Builder Instance to an Environment
2. Create a Git repository test branch from the master branch. Create a Test Branch
3. Create test packaging and deployment build jobs, and then set up a pipeline.

You may also want to restrict who can see or edit the test build jobs' configuration, or run its build.

Create and Configure Build Jobs

Add a Visual Builder Instance to an Environment

If you want to set up things so that visual applications are deployed to the Visual Builder test instance, you must create a separate VB Studio environment and add the correct 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 in another identity domain. If your test instance resides in another identity domain, to add it to an environment, you'll need any of these:

  • Test instance's identity domain ID, region, and a user's credentials who can access the instance
  • A user's personal access token who can access the instance
  • Visual Builder test instance's base URL and a user's credentials who can access 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 Client Application) in the background. The IDCS Application generates an OAuth token to access the newly added Visual Builder instance and handles authentication when VB Studio tries to access the target instance. Provisioning of the IDCS Application takes a few seconds to complete after VB Studio adds the Visual Builder instance to an environment.

If the newly added instance stays in the Unknown status for some time, it typically indicates that the IDCS Application provisioning may have failed. VB Studio added the Visual Builder instance but can't access it. In such a case, delete the Visual Builder instance from the environment and add it again.

Add a Connection to Visual Builder of Your Current Identity Domain
  1. In the navigation menu, click Environments Environments.
  2. Select an existing environment or create one.
    To create an environment, click Create (or Create Environment if the page is empty). In Environment Name and Description, enter a unique name and description, and click Create.
  3. In the Service Instances tab, click Add.
  4. In the Add Service Instances dialog box, click the Visual Builder toggle button.
  5. Select the Identity Domain option.
  6. Select the check box for the Visual Builder instance you want to add and click Add.

    If you're assigned the PaaSAdministrator IDCS role, you'll see both current identity domain's service instances and PSM Visual Builder instances. In the Type column, the current identity domain's service instances are marked as IDCS Resource and PSM instances are marked as Visual Builder or Integration (if you're an Oracle Integration user). If you see both current identity domain's service instances and PSM instances, select a PSM Visual Builder instance as it provides options to control 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
  1. In the navigation menu, click Environments Environments.
  2. Select an existing environment or create one.
    To create an environment, click Create (or Create Environment if the page is empty). In Environment Name and Description, enter a unique name and description, and click Create.
  3. In the Service Instances tab, click Add.
  4. In the Add Service Instances dialog box, click the Visual Builder toggle button.
If you have these details of the Visual Builder instance you want to add: Follow these steps:
Identity domain ID, region, username, and password
  1. Select the Identity Domain option.
  2. Click Edit next to the current identity domain's details.
  3. In Identity Domain Id/Identity Domain, enter the Visual Builder instance's identity domain name or its ID. The ID is usually in the idcs-<hexadecimalID> format.

    You can find the identity domain name and the Identity Service ID in the About dialog box of IDCS Dashboard.

  4. In Region, select the identity domain's region.
  5. In Username and Password, enter the credentials of a user who can access the Visual Builder instance.
  6. Click Update.
  7. Select the check box for the Visual Builder instance you want to add and click Add.
Personal access token of a user who can access the instance

To generate the personal access token, see Get a Visual Builder User's Personal Access Token.

  1. Select the Personal Access Token option.
  2. Drag and drop the token file to the Drag and Drop Token File area, or copy the token's text and paste it in paste token here.
  3. Click Add.
Visual Builder instance's base URL and credentials of a user who can access the instance
  1. Select the Visual Builder Credentials option.
  2. To add a standalone Visual Builder instance, select the Visual Builder option.

    To add an Oracle Integration's Visual Builder instance, select the Oracle Integration option.

  3. In Base URL, enter the base Visual Builder instance's URL.
  4. In Instance Name, if required, update the instance's display name. The name will be displayed in the Service Instances tab.
  5. In Username and Password, enter the credentials of a user who can access the Visual Builder instance.
  6. Click Add.

Create a Test Branch

Follow your organization's guidelines to create a branch and protect it from unverified changes. To protect a branch, you can set merge restrictions, make the branch private and 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 review branch 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 Git.
  2. Click the Refs view and then click Branches Branches.
  3. From the Repositories drop-down list, select the repository.
  4. Click + Create Branch.
  5. In the New Branch dialog box, in Name, enter the branch name. From the Base drop-down list, select master as the base branch.
  6. Click Create.
After creating the test branch, if you want to set merge restrictions on it, see Set Review and Merge Restrictions on a Repository Branch. To freeze the branch or make it private, or set other restrictions, see Protect a Branch.

Create and Configure Build Jobs

To deploy visual applications to your Visual Builder test or any other instance, you'll need to set up separate packaging and deployment jobs.

Here's an example of jobs that generate the visual application's artifact and deploy it to the test and the development instance:

Here's an example of test and development pipelines:

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

  • Access credentials or the personal access token of a Visual Builder user who can connect and deploy to the Visual Builder test instance.
  • Artifact archive file names

    In the development packaging job, if you changed the default file names of artifact archive files, get the new names and their paths.

  • Application's version

    If you configured the development packaging job to overwrite the application's version defined in visual-application.json, get the new version.

  • Test application profile

    If you've created an application profile for testing, get its name.

Create a Packaging Build Job

The packaging job generates a visual application artifact that's ready to deploy.

  1. In the navigation menu, click Builds Builds.
  2. In the Jobs tab, click + Create Job.
  3. In the New Job dialog box, in Name, enter a unique name.
  4. In Description, enter the job's description.
  5. In Template, select the System Default OL7 for Visual Builder template.
  6. Click Create.
  7. Click Configure the Tools icon.
  8. Click the Git tab.
  9. From the Add Git list, select Git.
  10. In Repository, select the Git repository. In Branch or Tag, select the test branch of the repository.
  11. Select the Automatically perform build on SCM commit check box.
  12. Click the Steps tab.
  13. From Add Step, select Visual Application, and then select Package.
  14. By default, the build jobs minifies the application's source code before running the build. If you don't want to minify the source files, deselect the Optimize application check box.
    Minification is a process to remove the unnecessary characters (such as blank spaces, new lines, and comments) from the source code and reduce the size of the files, making the transfer of files consume less bandwidth and storage.
  15. If you want to change the default names of the archive files, in File names, select Use custom file names.
    In Sources, specify the visual application source archive file's name and path. In Build Artifact, specify the build artifact archive file's name and path.

    You'll need both archive files to deploy the visual application.

  16. Click the After Build tab.
  17. From Add After Build Action, select Artifact Archiver.
  18. In Files to archive, enter the build artifact name. You can also use wild characters. For example, *.zip.
  19. If you want to discard old artifacts of the build, click Settings the Gear icon. In the General tab, select the Discard Old Builds check box and specify the discard options.
  20. Click Save.
Create a Deployment Build Job

The deployment job deploys the visual application's artifact that was generated in the packaging job to the Visual Builder test instance. Before you create the job, get the access credentials or the personal access token of a Visual Builder user who can connect and deploy to the Visual Builder test instance.

  1. In the navigation menu, click Builds Builds.
  2. In the Jobs tab, click + Create Job.
  3. In the New Job dialog box, in Name, enter a unique name.
  4. In Description, enter the job's description.
  5. In Template, select the System Default OL7 for Visual Builder template.
  6. Click Create.
  7. Click Configure the Tools icon.
  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 visual application's artifact.
  11. In Which Build, select Last Successful Build.
  12. Leave other fields with their default or empty values.
  13. Click the Steps tab.
  14. From Add Step, select Oracle Deployment.
  15. In Target Instance, select the environment that points to the Visual Builder test instance.
  16. 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 and deploy to Visual Builder test instance.
    • To authenticate using the user's personal access token, select Use Access Token. Click Set Access Token, upload the token file, and click OK.

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

  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.
    In Sources and Build Artifact, enter the same file names (with path) you specified in the packaging job.
  18. To overwrite the application's default version, specify the new version in Application Version. Leave it empty to use the version defined in the application's visual-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 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 settings for different environments, such as development, test, and production. Using application profiles, you can define different combinations of servers and security settings for each of your environments, and use them when deploying the application to an environment. This simplifies management of the visual application as you move through development and test to production. To learn more, see About Application Profiles.

  20. To use a clean database for the application, in Data Management, select Use clean database.
  21. Click Save.
Configure a Job's Privacy Setting

Mark a job as private to restrict who can see or edit a job's configuration, or run its build:

  1. In the navigation menu, click Project Administration Gear.
  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 Lock icon in the jobs list on the right side of the Job Protection page, in the Jobs tab of the Builds page, and in the pipelines.

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

Create and Configure a Pipeline

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

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

    Example:

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

    Example:

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

    Example:

    Test pipeline
  9. Click Save.
Run the Pipeline

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

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

To monitor the pipeline, click the pipeline's name on the Builds page. After a successful build, you'll find the deployed application's link in the Deployments tab of the Environments page.

If you want to run a job's build manually, open the job's details page and click Build Now. You can monitor its build on the job's details page. To view the latest build log of a job, open the Builds page, click the job's name, and then click Build Log Latest Console.

Undeploy a Visual Application

You can undeploy a visual application that's deployed to your current identity domain's Visual Builder manually from the Deployments tab of its environment, or configure a build job to undeploy it.

To undeploy a visual application that's deployed to Visual Builder of another identity domain, configure a build job and run it. You can't undeploy it manually.
Undeploy a Visual Application Manually
  1. In the navigation menu, click Environments Environments.
  2. Select the environment where the visual application is deployed.
  3. Click the Deployments tab.
  4. Expand the application.
  5. For the visual application to undeploy, click Actions Hamburger icon and select Undeploy.
  6. In the confirmation dialog box, click Undeploy.
Configure a Job to Undeploy a Visual Application
To undeploy a visual application through a build job, you'll need either a personal access token or access credentials of a user who can access the Visual Builder instance where the visual application is deployed.
  1. In the navigation menu, click Builds Builds.
  2. In the Jobs tab, click + Create Job.
  3. In the New Job dialog box, in Name, enter a unique name.
  4. In Description, enter the job's description.
  5. In Template, select the System Default OL7 for Visual Builder template.
  6. Click Create.
  7. Click Configure the Tools icon.
  8. Click the Steps tab.
  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. In Username and Password, enter the user's credentials who can connect and undeploy from the Visual Builder instance.
    • To authenticate using the user's personal access token, select Use Access Token. Click Set Access Token, upload the token file, and click OK.

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

  12. In Application URL Root and Application Version, enter the visual application's root URL and its version.
    You can find the application's root URL and its version from the Deployments tab of the environment where the visual application is deployed.

    Example:

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

Set Up the Project to Deploy for Production

After your development and test cycles are complete, you may want to configure the project to build and deploy visual applications to the Visual Builder production instance.

Before you proceed, contact the Visual Builder administrator and make sure that the Visual Builder production instance is properly configured and running. For example, make sure that the test instance's security options are configured and the instance points to the correct database.

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

To perform this action: See this:
1. In the VB Studio project, create an environment for the Visual Builder production instance. Add the Visual Builder Production Instance to an Environment
2. Create a production branch from the test branch. Use this branch to push your application to production. Create a Production Branch
3. Create the production packaging and deployment build jobs, and set up the pipeline. Create and Configure Production Build Jobs
4. (Optional) Restrict users who can edit the production 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 to the production branch and there are no open merge requests.

Add the Visual Builder Production Instance to an Environment

To deploy a visual application to the Visual Builder production instance, you must create a separate VB Studio environment and add the production instance to it. You can add only one Visual Builder instance to an environment.

The Visual Builder production instance usually resides in another identity domain. To add 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 can access the instance
  • A user's personal access token who can access the instance
  • Visual Builder production instance's base URL and a user's credentials who can access 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 Client Application) in the background. The IDCS Application generates an OAuth token to access the newly added Visual Builder instance and handles authentication when VB Studio tries to access the target instance. Provisioning of the IDCS Application takes a few seconds to complete after VB Studio adds the Visual Builder instance to an environment.

If the newly added instance stays in the Unknown status for some time, it typically indicates that the IDCS Application provisioning may have failed. VB Studio added the Visual Builder instance but can't access it. In such a case, delete the Visual Builder instance from the environment and add it again.

Add a Connection to Visual Builder of Another Identity Domain
  1. In the navigation menu, click Environments Environments.
  2. Select an existing environment or create one.
    To create an environment, click Create (or Create Environment if the page is empty). In Environment Name and Description, enter a unique name and description, and click Create.
  3. In the Service Instances tab, click Add.
  4. In the Add Service Instances dialog box, click the Visual Builder toggle button.
If you have these details of the Visual Builder instance you want to add: Follow these steps:
Identity domain ID, region, username, and password
  1. Select the Identity Domain option.
  2. Click Edit next to the current identity domain's details.
  3. In Identity Domain Id/Identity Domain, enter the Visual Builder instance's identity domain name or its ID. The ID is usually in the idcs-<hexadecimalID> format.

    You can find the identity domain name and the Identity Service ID in the About dialog box of IDCS Dashboard.

  4. In Region, select the identity domain's region.
  5. In Username and Password, enter the credentials of a user who can access the Visual Builder instance.
  6. Click Update.
  7. Select the check box for the Visual Builder instance you want to add and click Add.
Personal access token of a user who can access the instance

To generate the personal access token, see Get a Visual Builder User's Personal Access Token.

  1. Select the Personal Access Token option.
  2. Drag and drop the token file to the Drag and Drop Token File area, or copy the token's text and paste it in paste token here.
  3. Click Add.
Visual Builder instance's base URL and credentials of a user who can access the instance
  1. Select the Visual Builder Credentials option.
  2. To add a standalone Visual Builder instance, select the Visual Builder option.

    To add an Oracle Integration's Visual Builder instance, select the Oracle Integration option.

  3. In Base URL, enter the base Visual Builder instance's URL.
  4. In Instance Name, if required, update the instance's display name. The name will be displayed in the Service Instances tab.
  5. In Username and Password, enter the credentials of a user who can access the Visual Builder instance.
  6. Click Add.

Create a Production Branch

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

If you want to use an existing production branch and merge changes from the test branch to it, then create a merge request with the test branch as the review branch and the production branch as the target branch. After approvals from reviewers, merge the review branch into the target branch.

To create a production branch from the test branch, follow these steps:

  1. In the navigation menu, click Git Git.
  2. Click the Refs view and then click Branches Branches.
  3. From the Repositories drop-down list, select the repository.
  4. Click + Create Branch.
  5. In the New Branch dialog box, in Name, enter the branch name. From the Base drop-down list, select the test branch as the base branch.
  6. Click Create.
After creating the production branch, if you want to set merge restrictions on it, see Set Review and Merge Restrictions on a Repository Branch. To freeze the branch or make it private, or set other restrictions, see Protect a Branch.

Create and Configure Production Build Jobs

You need to set up some packaging and deployment jobs before you can deploy visual applications to your Visual Builder production instance. This topic explains how to do that.

Before you configure production build jobs, make a note of these:

  • In the production packaging job, use the Git repository's production branch to generate production artifacts.
  • In the test packaging job, if you changed the default file names of archive artifact files, get the new names and their paths. You'll need them when you configure the production packaging job.
  • If you configured the test packaging job to overwrite the application's version defined in visual-application.json, get the new version. You'll need it when you configure the production packaging job.
  • In the production deployment job, don't include the application's version in the app'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 to the Visual Builder production instance.
  • If you deploy a version of visual application that's never been deployed, VB Studio overwrites the last deployed version with the new version.

    VB Studio doesn't undeploy the previously deployed version from the production instance. It continues to remain on the target instance, but is inaccessible.

  • If you want to redeploy a previously deployed version, undeploy it first, else the deploy build fails. To undeploy a previously deployed production visual application version, configure a build job and run it. You can't undeploy it manually from the Environments page.
  • If you've created an application profile for production, get its name. You'll need it when you configure the production deployment job.
Create a Production Packaging Build Job

The production packaging job generates a visual application artifact that's ready to deploy.

  1. In the navigation menu, click Builds Builds.
  2. In the Jobs tab, click + Create Job.
  3. In the New Job dialog box, in Name, enter a unique name.
  4. In Description, enter the job's description.
  5. In Template, select the System Default OL7 for Visual Builder template.
  6. Click Create.
  7. Click Configure the Tools icon.
  8. Click the Git tab.
  9. From the Add Git list, select Git.
  10. In Repository, select the Git repository. In Branch or Tag, select the production branch.
  11. Click the Steps tab.
  12. From Add Step, select Visual Application, and then select Package.
  13. By default, the build jobs minifies the application's source code before running the build. If you don't want to minify the source files, deselect the Optimize application check box.
    Minification is a process to remove the unnecessary characters (such as blank spaces, new lines, and comments) from the source code and reduce the size of the files, making the transfer of files consume less bandwidth and storage.
  14. If you want to change the default names of the archive files, in File names, select Use custom file names.
    In Sources, specify the visual application source archive file's name and path. In Build Artifact, specify the build artifact archive file's name and path.

    You'll need both archive files to deploy the visual application.

  15. Click the After Build tab.
  16. From Add After Build Action, select Artifact Archiver.
  17. In Files to archive, enter the build artifact name. You can also use wild characters. For example, *.zip.
  18. If you want to discard old artifacts of the build, click Settings the Gear icon. In the General tab, select the Discard Old Builds check box and specify the discard options.
  19. Click Save.
Create a Production Deployment Build Job

The production deployment job deploys the visual application's artifact that was generated 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 a user who can connect and deploy to the Visual Builder production instance.

  1. In the navigation menu, click Builds Builds.
  2. In the Jobs tab, click + Create Job.
  3. In the New Job dialog box, in Name, enter a unique name.
  4. In Description, enter the job's description.
  5. In Template, select the System Default OL7 for Visual Builder template.
  6. Click Create.
  7. Click Configure the Tools icon.
  8. Click the Before Build tab.
  9. From Add Before Build Action, select Copy Artifacts.
  10. In From Job, select the production packaging job that generated the visual application's artifact.
  11. In Which Build, select Last Successful Build.
  12. Leave other fields with their default or empty values.
  13. Click the Steps tab.
  14. From Add Step, select Oracle Deployment.
  15. In Target Instance, select the Visual Builder production instance.
  16. 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 and deploy to the Visual Builder production instance.
    • To authenticate using the user's personal access token, select Use Access Token. Click Set Access Token, upload the token file, and click OK.

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

  17. In the production packaging job, if you changed the default file names of archive artifact files, then in File names, select Use custom file names.
    In Sources and Build Artifact, enter the same file names (with path) you specified in the packaging job.
  18. (Optional) To overwrite the application's default version, specify the new version in Application Version. Leave it empty to use the version defined in the application's visual-application.json file.
    If the version is already deployed, undeploy it first.
  19. Deselect the Include the application version in the URL check box.
    When deploying to a production instance, don't include the application's version in the deployed application's URL.
  20. (Optional) In Application Profile, specify the production 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 settings for different environments, such as development, test, and production. Using application profiles, you can define different combinations of servers and security settings for each of your environments, and use them when deploying the application to an environment. This simplifies management of the visual application as you move through development and test to production. To learn more, see About Application Profiles.

  21. To use a clean database for the application, in Data Management, select Use clean database.
  22. Click Save.
Configure a Production Job's Privacy Setting

Mark a job as private to restrict who can see or edit a job's configuration, or run its build.

A private job must be run manually. It won't run if a non-authorized user tries to run the job directly, through an SCM/periodic trigger or a pipeline.
  1. In the navigation menu, click Project Administration Gear.
  2. Click Builds.
  3. Click the Job Protection tab.
  4. From the jobs list, select the packaging production job.
  5. Select the Private option.
  6. In Authorized Users, add yourself.
    To add other users, select their names.
  7. Repeat the steps 4-6 for the deployment production job.
  8. Click Save.

A private job shows a Lock Lock icon in the jobs list on the right side of the Job Protection page, in the Jobs tab of the Builds page, and in the pipelines.

Create and Configure a Pipeline

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

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

    Example:

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

    Example:

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

    Example:

    Production pipeline with deploy job
  9. Click Save.
Run the Pipeline

To run the production packaging job and the deployment job in sequence, run the production pipeline.

  1. In the navigation menu, click Builds Builds.
  2. Click the Pipelines tab.
  3. For the production pipeline, click Build Build.

After a successful build, you'll find the deployed application's link in the Deployments tab of the Environments page.

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

Configure a Job to Undeploy a Visual Application
To undeploy a visual application through a build job, you'll need either a personal access token or access credentials of a user who can access the Visual Builder instance where the visual application is deployed.
  1. In the navigation menu, click Builds Builds.
  2. In the Jobs tab, click + Create Job.
  3. In the New Job dialog box, in Name, enter a unique name.
  4. In Description, enter the job's description.
  5. In Template, select the System Default OL7 for Visual Builder template.
  6. Click Create.
  7. Click Configure the Tools icon.
  8. Click the Steps tab.
  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. In Username and Password, enter the user's credentials who can connect and undeploy from the Visual Builder instance.
    • To authenticate using the user's personal access token, select Use Access Token. Click Set Access Token, upload the token file, and click OK.

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

  12. In Application URL Root and Application Version, enter the visual application's root URL and its version.
    You can find the application's root URL and its version from the Deployments tab of the environment where the visual application is deployed.

    Example:

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