Manually Create a Project for Extensions

The easiest way to create a project for extensions is through the Edit Page in Visual Builder Studio link in an Oracle Cloud Application, although the option to create a project manually is always available. Ideally, you'll create one project for each Oracle Cloud Application you plan to extend, such as Sales, Journeys, and so on.

To create an extension project manually:

  1. On the Organization page, click + Create.
  2. On the Project Details page of the New Project wizard, in Name and Description, enter a unique name and description for the project.
  3. In Security, select the project's privacy setting:
    1. Select Private to restrict access to project members only.
      The Discoverable checkbox, selected by default for private projects, allows 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.

      Note:

      If you want this project to be visible to users when they use the Edit Page in Visual Builder Studio option to make changes to their Oracle Cloud Applications page in VB Studio, mark it as Discoverable. This gives users an opportunity to select a project that's already associated with the page they want to modify (or they can create a new project, if they prefer).

    2. Select Shared to make the project code, wiki docs, tasks, and builds available to anyone inside your organization.
  4. In Preferred Language, specify the language for the email notifications your project users will receive.
    You can change the language in which the user interface appears in your user preferences.
  5. Click Next.
  6. On the Template page, select the Application Extension template, then click Next.
    If you don’t see the Application Extension template, that means you’re in an OCI region that doesn’t yet support it. Use the steps in this workaround to create your project instead of the steps shown here.

    When you create a project, VB Studio also creates a workspace and an extension for you. Use these to create your own extension, if you like, or let one of your team members use it.

  7. On the Project Properties page:
    1. In Extension Name, if necessary, change the extension's name. Make sure that the extension name is unique across all the extensions created for this Oracle Cloud Application. By default, the name is <project_name> Extension.
    2. In Extension Id, if necessary, change the extension's ID. Make sure that the ID is unique across all the extensions created for this Oracle Cloud Application. By default, the ID is site_<extension_name>.
    3. 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 extensions, including a clone of this project's Git repository–and the branch–containing the source files. To learn more about workspaces, see What Is a Workspace? Again, you don't have to use this workspace to develop an extension; it's created purely for your convenience. (When a team member accesses VB Studio from their Oracle Cloud Application, a workspace is automatically created for the user if one doesn't already exist.)

    4. In Oracle Cloud Applications Development Instance, VB Studio preselects your current identity domain's Oracle Cloud Applications instance and uses it as the development instance to develop extensions.
      If there are multiple Oracle Cloud Applications instances in your identity domain, you'll be asked to choose. Make sure to select the Oracle Cloud Applications instance you want to use to develop extensions. Make sure that the selected instance has a VB Studio instance provisioned and also has the Oracle Cloud Application you want to extend.
    5. From Base Application, select the Oracle Cloud Application you want to extend in this project.
    6. In Git Repository Name, change the Git repository's default name, if required. When a team member creates a workspace, a copy of this repository is made for the user's local changes. When the user executes the Git Push command, the changes are copied to the project's repository (also known as the "remote repository", in VB Studio terms).
    7. In Working Branch Name, if required, change the workspace's working branch name. By default, it is branch1.
      Follow your organization's guidelines for creating and managing Git repository's branches. When the project is provisioned, the Git repository's main branch is ready for you to start working on an extension, should you opt to do so. Whenever someone creates a workspace, VB Studio creates a copy of the main branch, renames it with the specified name, and uses it as the workspace's working branch. This documentation assumes that you'll continue to use main as the development branch and create a separate branch for production.
  8. On the Team page:
    1. Click Add Members and select Oracle Cloud Applications users or groups to add to the project, from the list displayed, if you know they may work in this project.
    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.
  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 environment; and Git, Maven, and NPM repositories. Review the activity feed and the Environments box for any errors.