Before You Begin
Purpose
In this tutorial, you will learn to navigate the various components of the Oracle Developer Cloud Service web user interface (the web UI).
Time to Complete
Approximately 30 minutes
Background
Oracle Developer Cloud Service is a cloud-based hosting environment for software development projects. It is available as a web interface accessible from a web browser. Oracle Developer Cloud Service provides the following features and services:
- Project creation, configuration, and user management
- Integrated issue tracking for tasks, bugs, and enhancements
- Source code repository through Git or external Git repositories to store your application source
- Maven repositories to store your application dependencies and libraries
- Team collaboration through code review and Agile development
- Continuous software build integration
- Wiki collaboration
- Deployment to a publicly available Oracle Java Cloud Service server, Oracle Java Cloud Service - SaaS Extension Server, or Application Container Cloud Service server
This tutorial familiarizes you with the components of the Oracle Developer Cloud Service web UI:
- Welcome page
- Project Home
- Source code browsing
- Maven
- Snippets
- Merge Requests
- Issues
- Agile
- Build
- Deploy
- Wiki
- Administration (available to a project owner only)
These components allow you to view and (if you are the project owner) manage team members, manage Git repositories, conduct code reviews, track tasks and issues, perform Agile development, build applications, deploy applications, document your project, and administer projects.
Scenario
You are an application developer whose department will be developing Java applications in the Oracle Cloud. You need to begin by learning the basics of the user interface.
This tutorial assumes that you will be logging in to an Oracle Developer Cloud Service installation that is populated with one or more projects. You will observe the settings for these projects, but the tutorial will not ask you to modify any of them.
What Do You Need?
-
A login to an Oracle Developer Cloud Service instance
-
One of the following supported browsers:
- Chrome 48 or later (also for Android)
- Firefox 38 or later
- Internet Explorer 11 or 12
- Safari 7 or 8 (Mac OS)
- Safari Mobile 5 (iOS)
Viewing the Welcome Page
-
Launch your Oracle Developer Cloud Service, following the instructions in "Accessing Oracle Developer Cloud Service Using the Web Interface" in Using Oracle Developer Cloud Service.
-
The first time you log in to Oracle Developer Cloud Service, you see the Welcome page, which lists the projects in your organization. By default, the Member tab is selected, displaying all the projects of which you are a member.
View ImageDescription of this image -
Click Favorites to see all projects that you have marked as favorites (none, if you are logging in for the first time). To mark a project as a favorite, click the star icon on the right.
-
Click Owner to see all projects you own.
-
Click All to see all shared projects in the organization.
From this page, you can click the New Project button to create a new project.
You can always return to the Welcome page by clicking the Oracle Developer Cloud Service link at the top of the page.

Viewing the Project Page
-
On the Welcome page, click the name of a project to go to the Project page of the project.
View ImageDescription of this image The Project page has a project menu with tabs on the far left. In the middle is an activity feed. On the right is a news feed, with another tab set below it.
View ImageDescription of this image On the far left is the project menu, which enables you to access all the project modules: Code, Maven, Snippets, Merge Requests, Issues, Agile, Build, Deploy, Wiki, Administration. You can click the
icon at the top of the page to hide or show the tabs.
View ImageDescription of this image -
Click the
icon at the bottom to hide the labels and save screen space. The icon arrow points the other way when the labels are hidden. Click it again to expand the labels, if you wish.
View ImageDescription of this image -
The left side of the page shows the activity feed for the project. Click links on the page for more detailed information about builds, issues, reviews, commits, and other activities.
View ImageDescription of this image -
Click the filter funnel at the top right corner of the activity feed to show only certain types of activities. By default, all activity types are displayed. You can select an activity type to turn off the display of those activities. You can select None to display no activities, or Invert to display activity types that were previously not displayed.
View ImageDescription of this image The Repositories tab on the right side of the page shows the Git and Maven repositories for the project. You can click the New Repository button to create another repository, and you can click the star icon on the right to mark a Git repository as a favorite. Click the Favorites button to display only your favorite repositories. You can specify a sort order (Alphabetical Order, Favorites First, or Most Active First); the default is Favorites First.
View ImageDescription of this image -
Click the Graphs and Statistics tab beneath the Repositories tab to view graphical information about issues, commits, and merge requests.
View ImageDescription of this image -
Click the Team tab beneath the Graphs and Statistics tab to view the project owners and team members. Use the Filter Members field to narrow the list if it is large. If you are a project owner, you can click the New Member button to add a new member to the project team, and you can click the person-with-star button to the right of the member name to make the member an owner.
View ImageDescription of this image
From the home page or from other tabs within the project, you can do the following:
-
Click the project name or down arrow at the top of the page to view the project picker menu, which allows you to filter the project list, select another project, or create a new project.
View ImageDescription of this image -
On most pages, you can enter text in the Search field at the top of the page and click the search icon to search within the page. The search field is disabled on the Agile and Administration pages.
View ImageDescription of this image -
Select your user name in the top right corner, then do one of the following:
- If you are an Identity Domain administrator, you can select Organization to administer your identity domain. (If you are not, this selection is not visible.)
- Select Preferences to modify your profile, authentication keys, or notification choices.
- Select Help to go to documentation for Oracle Developer Cloud Service or to a help topic appropriate to the page you are working in. The question mark icon to the right of your user name is a shortcut to Help for This Page.
- Select About to display information about this Oracle Developer Cloud Service instance.
- Select Sign Out to log out of Oracle Developer Cloud Service.
View ImageDescription of this image
Browsing Source Code
-
Click the
tab to browse the contents of the source code repositories and to see the commits to each of them.
The drop-down list on the top left shows the source code repository or repositories. The drop-down list to its right shows the branches, tags, and commits for each repository. The page shows the folders and files in the selected repository and branch. Click the buttons on the right to see other views of the repository.
View ImageDescription of this image -
Click the Commits button to view the commits to the selected branch of the repository.
View ImageDescription of this image Click the Files button to return to the Files view.
-
Click a folder to traverse the repository, and click the name of a file to see its contents.
View ImageDescription of this image -
Click the Raw button.
View ImageDescription of this image The contents are displayed in a browser tab or window. Click the browser's back button to return to the Files view. Here, the HTML output of a JSP file is displayed. For a source file, the file text is displayed.
View ImageDescription of this image -
Click the Blame button to view the changes to the file and the committer who is responsible for each.
View ImageDescription of this image -
Click the / (slash) button to return to the repository root.
View ImageDescription of this image -
Click the Branches button to view the current branches in the repository. You create a branch when you need to make code changes and have them reviewed. The New Branch button allows you to create a new branch.
View ImageDescription of this image The Tags button allows you to create tags, and the Compare button allows you to compare changes in any two revisions of the code.
Viewing Maven Repositories
Click the
tab. The Maven page allows you to view the Maven
repository created for the project. You can also
upload, download, and search for repository
artifacts.

Viewing Snippets
-
Click the
tab. The Snippets page allows you to store code and text for copying and pasting into command lines, search fields, wiki pages, text areas, and other locations. Snippets can be shared or private, and you can mark a snippet as a favorite.
View ImageDescription of this image -
Click Shared Snippets to see only shared snippets. You can also view only favorite snippets. The New Snippet button allows you to add a new snippet.
View ImageDescription of this image
Viewing Code Reviews
-
Click the
tab to go to the Merge Requests page, which provides a table that lists all the code reviews for the project.
View ImageDescription of this image By default, only requests you have created are listed. Click one of the other links in the Standard Searches list to see requests assigned to you, all open requests, all closed requests, and all requests.
The New Request button on the right allows you to create a new request.
A merge request requires two branches to exist in the Git repository: one for the review, and one that the review branch will merge into after the review is complete. Normally, you create the review branch and push your code changes to that branch before you create a merge request. You can also create the review branch at the same time you create the merge request and then push your code changes to it.
-
Click the link in either the ID or the Summary column for a detailed view of the review, including its full history.
View ImageDescription of this image From the review page, users can add comments, approve or reject changes, and perform a merge. By default, the Conversation tab shows comments related to the review. Click the Commits or Changed Files tab to view commits and code changes related to the review. The Linked Issues and Linked Builds tabs display any issues or builds related to the review.
View ImageDescription of this image -
Click the Merge Requests tab or the back arrow (<) to return to the Merge Requests page. From there, you can click the link in the Repository or Branch column to see the code on the review branch. Both of these links take you to the Code tab.
View ImageDescription of this image
For more information, see the OBE tutorial Performing Code Reviews Using Oracle Developer Cloud Service.
Viewing Issues
-
Click the
tab to go to the Track Issues page.
The Track Issues page provides a table of information about project issues, along with ways to sort and search for issues and to create new ones. Issues allow you to manage project activities. The New Issue button allows you to create a new issue.
The table lists all issues created for the project. By default, only recently changed issues are displayed.
View ImageDescription of this image -
Select one or more of the Standard Searches to view all issues, issues assigned to you, open issues, or issues related to you.
View ImageDescription of this image -
Click Advanced Searches to see the criteria you can use to perform more refined searches.
View ImageDescription of this image After you perform an advanced search, you can click the Save this search or Edit this search link at the top of the Issues page to save or modify your search.
View ImageDescription of this image -
Click any of the column heads in the table to sort the results by that column.
View ImageDescription of this image
For more information, see the OBE tutorial Managing Issues Using Oracle Developer Cloud Service.
Viewing Agile Boards and Sprints
-
Click the
tab to go to the Find Board page, which lists the Agile boards that belong to the project. From this page, you can filter which boards you see, and you can create a new board.
The Agile tab provides a mechanism for allocating issues to boards and to sprints, making it easy to use Agile development techniques.
View ImageDescription of this image -
Click a board to view the sprints associated with that board, along with the issue backlog, if any. Some of the sprints may also be associated with other Agile boards. From the Backlog view, you can create a new sprint, or you can move issues from the backlog to a sprint.
View ImageDescription of this image -
Click Configure in the Board drop-down list to see how the board is configured.
View ImageDescription of this image The configuration tabs allow you to specify the search criteria for assigning an issue to the board, to modify a set of progress states, and to configure the working days.
View ImageDescription of this image -
Click the Progress States tab. The default progress states are To Do, In Progress, and Completed. For this project, the owner has created a new progress state, Awaiting Verification.
View ImageDescription of this image -
Click the Working Days tab. You can specify which days of the week are working days, specify holidays, and specify whether non-working days should appear in reports.
View ImageDescription of this image -
Click Cancel to return to the Backlog view. From the Backlog view, click Active Sprints to see the currently active sprints, sorted by progress state. The issues are organized into swimlanes based on their status and assignees, and you can sort them in several ways.
View ImageDescription of this image -
Click Reports. The Reports view provides several ways to view the progress a team is making on a sprint.
View ImageDescription of this image
For more information, see the OBE tutorial Using Agile Methodology in Oracle Developer Cloud Service.
Viewing Project Builds
-
Click the
tab to go to the Jobs Overview page.
The table lists all build jobs created for the project, along with some status information. In the table, you can also view the console output for the build, view information about the last build, or run a build.
View ImageDescription of this image Above the table, the build queue (if any) is displayed. Click View Build History to see the results of all builds. The Job Statistics pie chart gives an overall view of the job status.
The New Job button allows you to create a new build job. Buttons on the right allow you to view only successful, failed, or unstable jobs. By default, all jobs are displayed.
-
Click the name of a job in the Job column for a detailed view of the job, including its full history.
View ImageDescription of this image From this page, you can perform tasks that include starting another build, viewing changes to the code for each build, configuring email notifications, and disabling or deleting the job.
-
Click the Configure button to see the details of the job configuration, including tabs for source code management, build triggers, and the actual details of the build steps.
View ImageDescription of this image -
Click the build name or the Cancel button to return to the detailed view of the build, or click Jobs Overview to return to the Jobs Overview page.
Viewing Deployments
-
Click the
tab to see what deployments have been configured or to create new deployments. If there are no deployments, a message states that You currently have no deployment configurations.
View ImageDescription of this image The New Configuration button allows you to set up a deployment configuration.
Deployment configurations are listed on the left side of the page. For the selected deployment configuration, the history is displayed on the right side of the page. This example shows deployments to a Java Cloud Service - SaaS Extension server, a Java Cloud Service server, and an Application Container Cloud Service server. To deploy to Oracle Java Cloud Service - SaaS Extension, you must have the role of Administrator.
View ImageDescription of this image -
You can click the gear icon for a deployment configuration to perform tasks associated with the deployment.
View ImageDescription of this image
For more information, see the OBE tutorial Deploying an Application from Oracle Developer Cloud Service to Oracle Java Cloud Service.
Viewing Wiki Pages
-
Click the
tab to see a list of wiki pages for the project. Wiki pages allow you to create documentation for a project. The New Page button allows you to create a page. When you create a project, you select one of three wiki markup languages: Textile, Confluence, and Markdown.
View ImageDescription of this image -
Click the name of a page to view its contents. The Edit and Delete buttons on the wiki page allow you to modify or remove the page.
View ImageDescription of this image From any wiki page, you can click New Page to create a new top-level page, or you can click New Child to create a child of the current page.
If the text of a wiki page includes an issue ID ("Task 21" or "Issue 3", for example), a link to that issue is automatically created when you save the page.
-
If you click Edit to edit the page, you can click the reference link for the wiki language to view a cheat sheet.
View ImageDescription of this image
Viewing the Administration Pages
-
Select a project that you own and click the
tab. This tab is visible only for projects you own. It contains several pages that enable the owner to administer the project.
View ImageDescription of this image -
Click the Properties tile to go to the Properties page.
View ImageDescription of this image The Properties page allows you to modify the properties set when you created the project. You can change the name, description, security setting, preferred language, and wiki markup language. You can click the Delete Project button at the top right to delete the project.
View ImageDescription of this image -
Click the
icon next to the Administration tab to expand the Administration navigation menu.
View ImageDescription of this image -
In the sidebar, click Usage Metrics to see the storage used by the repositories, build, and tasks/wiki areas of the project. For a small project or a new project, no metrics may be available.
View ImageDescription of this image -
Click Issue Tracking to go to several pages that allow you to create and modify fields that can be specified when a user creates an issue.
-
The default page, Products, lets you add and modify a new product or modify the product named Default. All issues have an associated product.
View ImageDescription of this image -
The Tags page lets you add or modify product tags. By default, there are three available tags (Epic, Plan, and Release).
-
The Custom Fields page lets you add new properties needed for your products.
-
-
Click Repositories to add, edit, index, or remove repositories for your project.
View ImageDescription of this image -
Click Branches to set default reviewers for the branches of your project, to protect or lock a branch, or to designate branch administrators.
View ImageDescription of this image -
Click Webhooks to add webhooks for your project. A webhook (also called a web callback or HTTP push API) is a way for an application to provide other applications with real-time information.
View ImageDescription of this image -
Click RSS/ATOM Feeds to add RSS/ATOM handlers for your project.
View ImageDescription of this image -
Click Job Import to import an external Hudson job into your project.
View ImageDescription of this image -
Click Links to define how links are to be specified in your project.
View ImageDescription of this image
Want to Learn More?
- Performing Code Reviews Using Oracle Developer Cloud Service OBE
- Managing Issues Using Oracle Developer Cloud Service OBE
- Using Agile Methodology in Oracle Developer Cloud Service OBE
- Deploying an Application from Oracle Developer Cloud Service to Oracle Java Cloud Service OBE
- Oracle Developer Cloud Service in the Oracle Help Center
- Using Oracle Developer Cloud Service in the Oracle Help Center
- Oracle Developer Cloud Service product page