Create and Set Up a Project Using the Visual Application Template
When your VB Studio instance in the same identity domain as your Visual Builder instance, you can 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 starting with the Visual Application template:
To perform this action: | See this: |
---|---|
1. Create a project. | Create a Project Using the Visual Application Template Note
Before you try to create a project, make sure your VB Studio instance is authorized to access Visual Builder instances that are connected to your OCI account. Without this authorization, these instances won't be available for selection as a deployment target in your project. See Authorize VB Studio to Access Visual Builder and Integration Instances. |
2. Configure the deployment job.
By default, the deployment job lacks the credentials for connecting 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 Using the Visual Application Template
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 can quickly get started by basing your project on the Visual Application project template.
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 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 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 and then click the Pipelines tab. In the pipeline's row, click the 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 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 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.
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.
- In the left navigator, click Builds .
- Click the Pipelines tab.
- In development pipeline's row, click the 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.