Create and Set Up the Project for Development (Same Identity Domain)

To develop visual applications using a VB Studio instance that's in the same identity domain as your Visual Builder instance, you'll first need to first create a project based on the Visual Application template, then make a few configuration settings in the project so that it's ready for developing visual applications.

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

To perform this action: See this:
1. Create a project. Create a Project
2. 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
3. Verify your credentials by running the development pipeline. Run the Pipeline Manually
4. View the deployed visual applications. View the Deployed Visual Application
5. Add team members to the project. Add Users to the Project

Create a Project

If you're developing a visual application using a VB Studio instance that's in the same identity domain as your Visual Builder instance, you'll need 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.
  3. On the Project Details page of the New Project wizard, enter a unique name and description for the project.
  4. In Security, select the project's privacy:
    1. Select Private to restrict access to project members only.

      Select the Discoverable checkbox to allow organization members that aren't org admins or project members to see basic information, such as name and owner contact information, about your private project. Private projects that aren't discoverable won't be exposed to non-members.

    2. Select Shared to make the project code, wiki docs, tasks, and builds available to anyone inside your organization.
  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, and then click Next.

    Tip:

    If you don’t see the Visual Application template, use these steps to create a new visual application when a Visual Application project template isn't available::
    1. Create an empty project.
    2. Open the Environments page and create an Environment that uses your VB runtime instance.
    3. Open the Workspaces page, click New, then select New Visual Application.

    These steps produce the same result as using the Visual Application project template.

  8. On the Project Properties page:
    1. In Git Repository Name, change the Git repository's default name, if required.
    2. In Development VB Instance, if not already selected, select the Visual Builder development instance.
      If there is only one Visual Builder instance in your VB Studio's identity domain, VB Studio selects it as the development instance. If there are more than one Visual Builder instances in your identity domain, the drop-down lists all the Visual Builder instances.

      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.

    3. In Visual Application Template, select a visual application template available on the selected development instance.
      By default, VB Studio uses the Default VBCS Application template. To select another template, click Change Template, select the template and click Use Selected.
    4. (Optional) In Workspace Name, if required, change your private workspace's name. By default, it is Workspace1.

      A workspace contains all the artifacts that you need to develop 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?

    5. (Optional) In Working Branch Name, if required, change the workspace's working branch name. By default, it is branch1.
      When the project is provisioned, the Git repository's main branch contains your application's files. While creating the workspace, VB Studio creates a copy of the main branch, renames it with your specified name and uses it as the workspace's working branch.
    6. Click Next.
  9. On the Team page:
    1. Click Add Members and select users or groups to add to the project, from the list displayed.
    2. Select the membership (Project Owner, Developer Full Access, Developer Limited Access, or Contributor) that the members you're adding will have in the project.
      See What Are Project Memberships? for more information about each membership.
    3. Click Add.
    4. Repeat substeps a, b, and c for different users and groups with various membership types, if needed.
  10. Click Finish.
After the project is provisioned, the Project Home page opens where you can see a summary of the project's provisioning activities; default environment; default workspace; and Git, Maven, and NPM 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 left navigator, 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 left navigator, click Builds Builds and then click the Jobs tab to see the build jobs:

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

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

    In the left navigator, click Builds Builds and then click the Pipelines tab. In the pipeline's row, click the Actions Actions menu and select View Layout.

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

    In the left navigator, click Workspaces Designer to see the workspace:

  • By default, the project uses the organization's default markup language. Your project's users use the markup language to format wiki pages and comments. If required, you can change the project's markup language from the Project Administration page. See Change a Project’s Wiki Markup Language.
  • A VM executor is created if this project is VB Studio's first project and no build VM executors had existed when you created the project. The VM executor uses the System Default OL7 for Visual Builder build executor template. You can use this VM executor to run build jobs that reference the System Default OL7 for Visual Builder template in the current project and other projects as well. See VM Build Executors for more information about VM executors and build executor templates.

    In the left navigator, click Organization Organization and then click the VM Build Executors tab to see the VM executor.

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 left navigator, click Builds Builds.
  2. In the Jobs tab, click the deployment job.
  3. Click Configure.
  4. Click Configure Builds.
  5. Click the Steps tab.
  6. In Username and Password, enter yours or a user's credentials who can connect and deploy to the Visual Builder development instance.
    The credentials will be used when the package and deploy build pipeline runs.
  7. (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.
  8. (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 and may need different security settings for different environments, such as development 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 to production. To learn more, see About Application Profiles.

  9. (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 <uicontrol>Data Management</uicontrol>, select Use clean database.

  10. Click Save.

Run the Pipeline Manually

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

If you want to run the pipeline manually:
  1. In the left navigator, click Builds Builds.
  2. Click the Pipelines tab.
  3. In development pipeline's row, click the Actions Actions menu and select Run Pipeline.

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

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

View the Deployed Visual Application

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

  1. In the left navigator, click Environments Environments.
  2. Select the Visual Builder environment.
  3. Click the Deployments tab.
  4. If not enabled, click the Visual Applications toggle button.
  5. If the Visual Builder instance is from a different identity domain, provide 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: