A project gathers all the resources you need for developing software—in this case, a project for visual applications.
After you've set up VB Studio to develop visual applications, follow the steps in this table to create an empty project, add an environment with a Visual Builder instance, configure the deployment job, and add users to the project. When your VB Studio instance is in a different identity domain than your Visual Builder instance, you'll additionally need to authorize the connection to your Visual Builder instance.
Tip:
Instead of creating an empty project and setting it up manually (as described here), you can use the Visual Application template to quickly create a project with everything you need to develop visual applications. Note though that this option is available only when your VB Studio instance in the same identity domain as your Visual Builder instance. See Create and Set Up a Project Using the Visual Application Template.
On the Project Details page, enter a unique name and description for the project.
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.
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.
Click Next.
On the Template page, select the Empty Project template, then click Next.
On the Properties page, select the wiki markup type, then click Finish.
After the project is provisioned, the Project Home page opens where you can see a summary of the project's provisioning activities. Review the activities feed for any errors.
2. In the project, create an environment with your Visual Builder instance.
Note
Before you try to create an environment, make sure your VB Studio instance is authorized to access the Visual Builder instances that are connected to your OCI account. Without this authorization, those instances won't be available for selection in your environment as a deployment target. See Authorize VB Studio to Access Visual Builder and Integration Instances.
In the navigation menu, click Environments , then click + Create Environment.
In Environment Name and Description, enter a unique name and description, and click Create.
In the environment's Service Instances tab, click Add Instance.
Locate and add your Visual Builder instance:
Make sure Instance Type is set to Visual Builder and Add Instance Using is set to Instance List. This is the preferred approach.
Click next to OCI Details, select the region and compartment where your Visual Builder instance is, and click Update.
Select your Visual Builder instance from the selected compartment's instance list and click Add.
If you don't see the instance you want to add (because it's connected to a different OCI account), select Visual Builder Credentials under Add Instance Using. In Base URL, enter the Visual Builder instance's URL; update the Instance Name if needed; enter the credentials of a user who can access the Visual Builder instance in Username and Password; and click Add. Note though that using this approach won’t allow you to set up OAuth for this environment in the deployment build job, used by the Publish action in the Designer.
If your target instance uses a different identity domain than your VB Studio instance, OAuth tokens (via three-legged OAuth flows) are used to secure programmatic access to the instance. Before any OAuth tokens can be created, you must provide authorization to acquire OAuth tokens. Click Authorize when prompted, then sign in with credentials to connect and deploy to the target instance.
Once you're done, the Recent Activities feed on the Project Home page lists the newly created environment along with the Visual Builder instance you added.
3. When users are ready, they can create a workspace in the project.
In the navigation menu, click Workspaces.
Click New and select New Visual Application.
In Workspace Name, add a name for your workspace.
In Development Environment, select the environment you created in the previous step.
In Visual Application Template, don't change the default (Default VB Application).
In Git Repository, select Create new repository, and enter a repository name and working branch name.
4. The user that created the visual application will need to configure their deployment job.
In your Visual Builder Studio navigation menu, click Builds.
In the Jobs tab, click the deployment job.
Click Configure, then click the Steps tab.
In Target Instance, make sure that the environment you created in Step 2 is selected.
In the Authorization section, specify the authorization type to run this build step. With Use OAuth selected by default, you'll see the Authorization is required message, indicating that this build step needs a one-time authorization to handle OAuth requests to your environment's Visual Builder instance. Click Authorize and enter credentials to access your Visual Builder instance; you can also run the job manually and enter the credentials when prompted.
Either way, it is recommended that you authorize your OAuth connection during initial configuration. If you skip this step, you won't be able to publish your changes from the Designer and will need to complete the required authorization before attempting to deploy changes.
Once authorized, the Authorization has been provided message shows.
Note
OAuth is the recommended authorization type. Use Basic authentication only if you run into issues with setting up an OAuth connection. To use Basic authentication, select Use Basic, then enter the credentials of a user who can access the Visual Builder instance in Username and Password.
OAuth tokens (access and refresh) are cycled during regular use. A refresh token is used to obtain an access token whenever a user accesses the target instance. This refresh token is typically valid for seven days. (The token expiration time is set in the IDCS resource app and may be different based on your security requirements.) If the user authenticates with the target instance within the seven-day period, the active refresh token generates a new access token and a new refresh token. This cycle continues indefinitely as long as the refresh token stays valid. If the refresh token expires during extended periods of inactivity (say, when you're away on vacation), click Renew Authorization (or run the job manually, so you're prompted to authorize any expired OAuth tokens).
(Optional) Choose Use custom file names and add custom file name details.
(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 checkbox.
(Optional) In Application Profile, specify the development application profile. Leave it empty to use the application's default profile.
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. To learn more, see What Are Application Profiles?
(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.
Click Save.
5. Add users to the project.
To allow your team members to access the visual application project, invite them to join the project. See Add Users to the Project.