2 Get Started

Where you start in Oracle Visual Builder Studio depends on the type of IDCS role you've been assigned, as well as your membership status within the project:

Access VB Studio

You can access VB Studio using the latest version of Google Chrome, Firefox, and Safari. Google Chrome is the only browser currently certified to work with the VB Studio Designer. Other browsers could be used with the Designer, but some features may not work correctly.

To access VB Studio, you need the service URL, plus your identity domain name, username, and password. If you’re a new user, you can sign in from the Oracle Cloud home page. If you’re a returning user, you can find the service URL from the email with the subject Welcome to Oracle Visual Builder Studio or Verify your Oracle Visual Builder Studio:

Your identity domain name and credentials are available in the email with the subject Welcome to Oracle Cloud.

If you’re invited to Oracle Cloud, you can find those details in the email with the subject New Account Information:

Access VB Studio from the Oracle Cloud Home Page

You 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 tenancy name and click Next.
  3. On the Oracle Cloud Account sign-in page, enter your Oracle Cloud account credentials and click Sign In.
    The Oracle Cloud Console, also called the OCI console, opens.
  4. In the upper-left corner, click Navigation Menu the Menu icon.
  5. Under More Oracle Cloud Services, select Platform Services and then select VB Studio.
  6. On the Instances tab, click Manage this instance the Action menu icon and select Access service instance.

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

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

After you sign in to VB Studio, you'll see the Organization page that displays all the projects you're a member of, as well as your favorite projects, the projects you own, and all the shared projects in your organization.

Set Your User Preferences

You 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:

Update Your Display Name

By default, VB Studio displays your Oracle Cloud account name as your display name across all pages. If you want to change it, you can do so from the User Preference page’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 Close to return to the last opened page.

Update Your Email Address

By default, VB Studio displays your Oracle Cloud email address across all pages and sends 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 can change it on the User Preference page’s Profile tab:

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

  • After you provide another email address, you’ll receive a verification email. It's important that you take the time to verify the new email address because, if you don'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 email address.
    After the verification, you’re redirected to the service page.
  5. Open the Profile tab again and verify that the Email Address field displays the Verified label.
  6. To the left of the User Preferences title, click Close Close to return to the last opened page.

Add Your Avatar Picture

VB Studio displays your Gravatar picture as the avatar picture. If you don’t have a picture set in Gravatar or don’t have a Gravatar account, VB Studio displays your 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 to Oracle 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 your avatar picture in VB Studio.

Configure Your Global Email Notifications

You 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 must respond to the verification email you'll receive if you want to receive VB Studio email notifications.

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, its notifications from all projects of the organization where you’re a member are enabled. You must subscribe or set up a watch on the component to get notifications about its updates:

    Select this check box ... To receive email notifications about:

    Issue updates, attachments and comments

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

    Merge Request updates and comments

    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 system maintenance updates

    Service and system maintenance updates from the VB Studio team.

    Build activities

    Jobs you’re watching.

    SCM/Push Activities

    Git repository branches you’re watching.

    Wiki page updates and comments

    Wiki pages you’re watching.

    Project Updates

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

    Include my Own Updates

    Your own changes.

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

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

Upload Your Public SSH Key

Before you can connect to a Git repository using SSH, you must first generate a private-public RSA SSH key pair and upload the public key to VB Studio. If you use multiple computers to access Git repositories, you'll need to generate an SSH key pair from each computer and upload its public key.

Generate an SSH Key

To 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 a macOS 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 .ssh sub-directory under the Git HOME directory. For example, on Windows, the files are saved 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 you didn’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 the private key. If you are using another Git client, you may need to configure it to access the 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 Account

After generating an SSH private-public key pair, add the public key to your User Preferences page’s Authentication tab.

  1. On the computer where you generated the SSH key pair, navigate to the directory where the public key is saved.
  2. Open the public key file in a text editor, select the contents, and copy them to the clipboard.
  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 that you copied in Step 2.
  7. Click Create.
  8. To the left of the User Preferences title, click Close Close to return to the last opened page.

See the News Banner

A banner with the latest news from the VB Studio team is displayed on the Organization and Project Home pages' header.

To navigate between news pages, click the navigation buttons. To expand or collapse the banner, use the Expand the Down arrow icon or Collapse the Up arrow icon icons. To close the banner, click Close the X icon.
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.

Set Up a Git Client

You can use use any Git client, such as the Git command-line interface (CLI), to access Git repositories from your computer. However, you cannot access projects, issues, and builds from a Git client, however.

Git Command-Line Interface

Before you can use a Git client to access and update files of you project's Git repository, you must first install and configure it on your computer. The Git command line-interface (CLI) is the most popular Git client.

Here's how to download, install, and configure the Git CLI:

  1. Download and install the Git CLI.

    On Windows, use the Git Bash CLI to access project Git repositories. You can download Git Bash (version 1.8.x or later) from http://git-scm.com/downloads.

    On Linux and Unix, install Git using the preferred package manager. You can download Git for Linux and Unix from http://git-scm.com/download/linux.

  2. The VB Studio pages display your username and email address as the committer's name and email ID. Configure variables to set up your name and email address:

    • To configure your user name, set the user.name variable:

      git config --global user.name "John Doe"

    • To configure your email address, set the user.email variable:

      git config --global user.email "johndoe@example.com"

    • To disable SSL or configure the proxy server, set the http.sslVerify or http.proxy variables:

      git config --global http.sslVerify false

      git config --global http.proxy http://www.testproxyserver.com:80/

Tip:

To find out the value of a variable, use the git config <variable> command:

git config user.name

Use Projects

After signing in to VB Studio, you can create a project, open a shared project, or open a project you're a member of.

Create a Project

From the Organization page, you can create different types of projects:

Empty Project

If you haven’t decided which applications you want to upload, or want to start from scratch, create an empty project that has no pre-configured Git repository or any other artifact:

  1. On the Organization page, click + Create Project.
  2. On the Project Details page of the New Project wizard, in Name and Description, enter a unique project name and a project description.
  3. In Security, select the project's privacy.
  4. Click Next.
  5. On the Template page, select Empty Project, and click Next.
  6. On the Project Properties page, from Wiki Markup, select the project’s wiki markup language.
    Project team members use the markup language to format wiki pages and comments.
  7. Click Finish.
With an Initial Git Repository

If you plan to upload application files soon after you create a project, you should create a project with an initial Git repository. You can choose the Git repository to be empty, populated with a readme file, or populated with data imported from another Git repository:

  1. On the Organization page, click + Create Project.
  2. On the Project Details page of the New Project wizard, in Name and Description, enter a unique project name and a project description.
  3. In Security, select the project's privacy.
  4. Click Next.
  5. On the Template page, select Initial Repository, and click Next.
  6. On the Project Properties page, from Wiki Markup, select the project’s wiki markup language.
    Project team members use the markup language to format wiki pages and comments.
  7. In Initial Repository, specify how to initialize the Git repository.
    • If you prefer a blank repository or want to push a local Git repository to the project, select Empty Repository.

    • Some Git clients can’t clone an empty Git repository. Select Initialize repository with README file if you’re using such a client. VB Studio creates a readme.md file in the Git repository.

      You can edit the contents of the readme.md file after creating the project, or delete the file if you don’t want to use it.

    • To import a Git repository from another platform such as GitHub or Bitbucket, or from another project, select Import existing repository.

      In the text box, enter the external Git repository's URL. If the repository is password protected, enter the credentials in Username and Password. Note that VB Studio doesn’t store your credentials.

  8. Click Finish.
From an Exported Project

If you’ve created a project before and backed up its data to an OCI Object Storage bucket or an OCI Object Storage Classic container, you can create a project and import the data from the backed up project.

To import project data from an OCI Object Storage bucket or OCI Object Storage Classic container, you need this information:

OCI Object Storage OCI Object Storage Classic
Target bucket's name Target container's name
Exported archive file's name Exported archive file's name
Private key and user's fingerprint (user who has the BUCKET_INSPECT or BUCKET_READ, and OBJECT_READ bucket permissions) User credentials with the Storage.Storage_Administrator or Storage_ReadOnlyGroup identity domain role.
Details for the compartment hosting the bucket

Contact the OCI administrator for the details and get the required input values.

OCI Object Storage Classic service ID and authorization URL

Contact the identity domain administrator or the OCI Object Storage Classic administrator for the details and get the required input values.

After you have all the required input values, import the project:

  1. On the Organization page, click + Create Project.
  2. On the New Project wizard's Project Details page, in Name and Description, enter a unique project name and a project description.
  3. In Security, select the project's privacy setting.
  4. Click Next.
  5. On the Template page, select Import Project, and click Next.
  6. To import the project from an OCI Object Storage bucket, in the Project Properties page's Storage Connection section, in Account Type, select OCI and enter the required details:
    1. In Tenancy OCID, enter the tenancy's OCID copied from the Tenancy Details page.
    2. In User OCID, enter the user's OCID value (for a user that can access the bucket).
    3. In Home Region, select the OCI account's home region.
    4. In Private Key, enter the user;s private key (for a user who can access the bucket).
    5. In Passphrase, enter the passphrase used to encrypt the private key. If a passphrase wasn't used, leave the field empty.
    6. In Fingerprint, enter the private-public key pair's fingerprint value.
    7. In Compartment OCID, enter the compartment's OCID copied from the Compartments page.
    8. In Storage Namespace, enter the storage namespace copied from the Tenancy Details page.
  7. To import the project from an OCI Object Storage Classic container, in Account Type, select OCI Classic. Then, enter the required details:
    1. In Service ID, enter the value copied from the last part of the REST Endpoint URL field on the Service Details page.
      For example, if REST Endpoint URL's value is https://demo12345678.storage.oraclecloud.com/v1/Storage-demo12345678, enter Storage-demo12345678.
    2. In Username and Password, enter the user credentials for a user who can access the archive file.
    3. In Authorization URL, enter the URL copied from the Service Details page's Auth V1 Endpoint field:
      http://storagetria01234-usoracletria12345.storage.oraclecloud.com/auth/v1.0.
  8. Click Next.
  9. On the Project Properties page, from Wiki Markup, select the project’s wiki markup language.
    Project team members use the markup language to format wiki pages and comments.
  10. In Container, select the storage bucket or the container where the data was exported.
  11. In File, select the exported file.
  12. Click Finish.

If the import fails, an empty project will be created. You can try to import the data again without creating a project. To check the import log, under Project Settings, in the Data Export/Import page's History tab.

From a Project Template

Using a project template, you can quickly create a project with predefined and populated artifacts, such as Git repositories and build jobs. When you create a project from a project template, the defined artifacts of the project template are copied to the new project. If you don’t want to use a copied artifact, you can delete it. Note that after you create a project from a template, updates made to the project template won’t be reflected in the project you created.

These types of project templates are available:

Project Template Description

Public templates

The VB Studio team creates and manages the public templates. They are available to all users across all identity domains and are marked by a Public Template label.

Shared templates

Your organization users create and manage shared templates. They are listed by name and are available to all users of the organization.

Private templates

Not listed by name to general users, but accessible through their private keys. To create a project from a private project template, you must have its private key.

Private templates are visible by name only to the members of the project template.

  1. On the Organization page, click + Create Project.
  2. On the Project Details page of the New Project wizard, in Name and Description, enter a unique project name and a project description.
  3. In Security, select the project's privacy.
  4. Click Next.
  5. On the Template page, select the project template, and click Next:
    • To create a project for a visual application, select the Visual Application template, follow the instructions in Create a Project for Visual Applications, and see what was created for you in the project.
    • To create a project for an application extension, select the Application Extension template, follow the instructions in Create a Project for Fusion Application Configuration, and see what was created for you in the project.
    • To create a project from a private template, select Private Template, and click Next. On the Private Template Selection page, enter the private key in Private Key, and click Next.
  6. On the Project Properties page, from Wiki Markup, select the project’s wiki markup language.
    The markup language is used to format wiki pages, and comments on Issues and Merge Request pages.
  7. Click Finish.

In the new project, these artifacts are copied from the project template:

Artifacts Description

Git repositories

The project template's defined Git repositories are copied to the new project. You can use the copied Git repositories and modify their files, or delete them.

In the navigation menu, click Git Git to view the copied Git repositories.

Build jobs and pipelines

All the project template's build jobs and pipelines are copied to the new project. You can change these jobs, create their copies, or delete them.

In the navigation menu, click Builds Builds to view the copied jobs and pipelines.

Wiki pages

All the project template's wiki pages are copied to the new project. You can change the wiki pages or delete them.

In the navigation menu, click Wiki Wiki to see the copied wiki pages.

Announcements

All the project template's active project announcements are copied to the new project. You can’t edit the copied announcements since they are read-only, but you can activate or deactivate them.

In the navigation menu, click Project Administration Gear, and then click Announcements to activate or deactivate them.

Links

All the the project template's link rules are copied to the new project. Link rules enable you to convert plain text to links when the text is entered in the commit and merge request comments.

In the navigation menu, click Project Administration Gearand then click Links to see the copied link rules.

Open a Project

You can open a project only if you're a member or an owner, or if the project is shared. To open a project, click its name as it appears on the Organization page. To search for a project, use the filter toggle buttons or the search box:

To quickly access a project, click Favorite the Star iconand add it to your favorites list. To see your favorite projects, click the Favorites toggle button.

If you’re invited to join a project, you’ll find the project link in the email you received when you were added to the project.

To switch to another project from an open project, click Switch Project next to the project name. From the menu, click the project name to open it.

After opening the project, you land on the Project Home page.

Review a Project’s Summary

From the Project Home page, you can see a summary of the project's actions, repositories, team members, and statistics:

If you want to: Do this:

Switch from one VB Studio page to another

Use the navigation bar on the left side of the page

See your project’s software development environments

Expand Environments. Click an environment to view its service instances.

Check the latest activities in the project

Use the recent activities feed. To filter the feed, click Select activity categories the Filter icon.

See the project's Git, Maven, and linked Docker repositories

Click the Repositories tab.

See issues and merge requests that require your attention

Click the Graphs and Statistics tab.

See your team members

Click the Team tab.

The Project Home page remembers the last opened tab (Repository, Graphs, or Team) in the current browser session and opens it automatically the next time you open the Project Home page. If you sign out or close the browser and then sign in and open the Project Home page, the Repositories tab opens by default.

Add and Manage Project Users

After creating a project, you'll probably want to add team members to collaborate with. You may also want to allow or limit their access to project data or actions they can perform on the project.

In a project, you can add and manage team members from the Project Home page's Team tab. Before adding a user, make sure that the user is a member of the identity domain and is assigned the DEVELOPER_ADMINISTRATOR (Developer Service Administrator) or the DEVELOPER_USER (Developer Service User) identity domain role and is assigned one of these project memberships:

  • Project Owner
  • Developer
  • Limited Developer
  • Contributor

You must have the Project Owner project membership to add and manage project users. Manage users from the Team tab, as shown in this table:

If you want to: Do this:

Add a user to the project

  1. In the navigation menu, click Project Home Project Home.
  2. Click the Team tab.
  3. Click + Create Member.
  4. In the Create Member dialog box, in Role, specify the new member’s role.
  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 + Create Member.
  4. In the Create 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 adds to the Username List text box. If you know the usernames of users to add, enter the usernames manually separated by a space, a comma, a semicolon, or a new line.

  6. Click Add.

Change a user’s project membership

To change a user’s project membership, click the Change Membership icon Change Membership icon . From the dropdown, select a new project membership (Contributor, Developer, Developer Limited, or Project Owner) for that user.

Remove a user from the project

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

Select the user and click Remove the remove icon.

Add Users from Another Project

If the users that you want to add to your project are members of another project that you can access, you can copy that project’s user list and add the users to your 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 + Create Member.
  11. In the New 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.