Skip Headers
Oracle® Fusion Middleware Integration Guide for Oracle Enterprise Repository
11g Release 1 (11.1.1.4.0)

Part Number E15754-07
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

7 Integration with Development Environments

This chapter describes how to integrate Oracle Enterprise Repository with various development environments.

This chapter contains the following sections:

7.1 Overview

The Oracle Enterprise Repository provides integration within development environments so developers can easily search for and use assets from the repository without leaving their developent environment. Assets and any associated artifacts are downloaded directly to the developer's workspace. Integration also provides a convenient way to submit or harvest assets from the development environment into the Oracle Enterprise Repository for use throughout the enterprise.

Repository Access within the developer's workspace also provides a view into Oracle Enterprise Repository that enables developers to, download artifacts and assets from the repository, query the repository, and view the contents of the repository.

The goal of this integration is to ensure that SOA Governance becomes part of the fabric of every day development.

This section contains the following topics:

7.2 Best Practices

This section describes the following best practice processes:

7.2.1 Asset Production Process

Oracle Enterprise Repository is used to track new assets and asset enhancements from the time they are proposed through the retirement of the assets, which also includes the time when the assets are being developed and when the assets are completed. Through Oracle Enterprise Repository, assets are used to produce and consume projects, to provide traceability and support impact analysis, and to point out project-level impacts of changes to the asset release plans.

Initially, a business analyst provides a description of the functionality that must be produced. If determined that the proposed functionality does not already exist, then an architect provides the functional designs and non-functional requirements. The development team then produces, harvests, or enhances an asset that meets the functional and non-functional requirements.

Figure 7-1 describes a sample asset production process.

Figure 7-1 The Asset Production Process

Description of Figure 7-1 follows
Description of "Figure 7-1 The Asset Production Process"

This means that the development team needs visibility into the assets that they are to produce such as the requirements, use cases and so on. Oracle Enterprise Repository provides that visibility by allowing developers to view an asset details of an asset directly from the development environment. The development team builds the specified asset and then harvests the asset into the Oracle Enterprise Repository, where it goes through a review and approval process.

This section contains the following topics:

7.2.1.1 Policies

The production and enhancement of assets can be governed through design-time policies. Policies are applied to assets to communicate asset requirements that must be considered during design and development, and to provide administrators with the means to enforce and monitor asset compliance with governance, architecture, and other organizational standards. For example, a policy might articulate corporate quality standards, identifying the platforms that an asset should run on and identifying acceptable defect density rates.

  • A policy can be applied to multiple assets.

  • Multiple policies can be applied to any asset.

  • Each policy consists of at least one assertion statement. Each assertion has a name and description and includes a technical definition. The technical definition accommodates additional metadata that may be required to automatically validate the assertion using third-party testing and validation tools. This metadata may be Web service-specific policy information, XML, or any other format that can be read by an external system. For example, an assertion statement for defect density might state that defect density must be less than .1% .

Policy information in Oracle Enterprise Repository can be accessed through the development environment. Once the development team harvests an asset into Oracle Enterprise Repository, then the policies can be automatically validated through tooling or manually validated by subject matter experts.

7.2.1.2 Propose/Submit Assets

Assets may be proposed or submitted to the Oracle Enterprise Repository in multiple ways, depending on the role and situation, some of the methods are as follows:

  • The general Oracle Enterprise Repository user community can submit asset requests or completed assets from the console.

  • Business analysts and architects can create assets to be built using the Asset Editor.

  • Development teams can submit or harvest assets from their development environments.

  • Existing assets stored in files or directories can be harvested by Competency Centers or Portfolio Managers.

  • QA or IT Operations can harvest assets from the build environment or from the run time environment.

7.2.2 Asset Consumption Process

There are two primary design-time consumption models within a standard Software Development Lifecycle (SDLC) process:

Model 1: Assets are identified early in the lifecycle (also known as Prescriptive Reuse)

  • Business analysts and/or project architects identify assets that fulfill the functional and non-functional requirements of the project.

  • Development teams then receive a "kit" of relevant assets.

Model 2: Development-driven discovery

  • Developers identify assets that might fulfill the functional and non-functional requirements of the project.

Model 1 is the most-preferred design-time consumption models because it results in a higher level of reuse, but requires the organization to have a mature SDLC process and well-defined roles.

This section contains the following topics:

7.2.2.1 Prescription Reuse

Within the Oracle Enterprise Repository Web console, business analysts and/or project architects identify assets that fulfill the functional and non-functional requirements of the project. They package these assets into a "kit" called a Compliance Template. A Compliance Template communicates asset requirements or asset solution sets to internal or outsourced project teams. Two types of Compliance Templates included in Oracle Enterprise Repository are:

  • Project Profiles

  • Architecture Blueprints

Project profiles are usually created for individual projects, whereas architecture blueprints are reusable solution sets that can be leveraged by multiple projects. Some of the common use cases include:

  • Project planners generate a project profile for each project in the portfolio, identifying the reusable assets that factored into the project's planning and estimating assumptions.

  • Business analysts generate a project profile to identify assets that fulfill a project's business requirements.

  • Project architects generate a project profile to identify assets that fulfill a project's technical requirements.

  • Enterprise architects generate an architecture blueprint that specifies the standard frameworks and assets that are to be used to fulfill project-level security requirements.

  • Those responsible for Service-Oriented Architecture(s) (SOA) generate an architecture blueprint to identify the services that orchestrate a particular business function.

  • Product line architects generate an architecture blueprint that specifies the assets that are to be used to build a specific product line (similar to a Bill of Material).

Figure 7-2 describes a sample prescriptive reuse process.

Figure 7-2 Prescriptive Reuse

Description of Figure 7-2 follows
Description of "Figure 7-2 Prescriptive Reuse"

Compliance Templates are applied to projects through the Oracle Enterprise Repository Web console and the assets identified in the compliance template are automatically displayed in the project's development environment. In this way, development teams get a jump-start on their development efforts.

For more information about Compliance Templates, see Oracle Fusion Middleware Configuration Guide for Oracle Enterprise Repository.

7.2.2.2 Developer-Driven Discovery

There are two ways that developers can get assets from the Oracle Enterprise Repository:

  • Through the Oracle Enterprise Repository Web Console

  • Through their IDE (Note that this functionality is currently available for Eclipse and VS .NET. Developers are able to download assets from JDeveloper in a future release.)

Developers can come to the Oracle Enterprise Repository to obtain the assets that they would like to use on their projects. The Use-Download function in the Oracle Enterprise Repository provides access to the asset artifacts. In addition, developers can select and download all assets related to the primary asset, ensuring that they have all necessary dependencies. The repository tracks usage and generates usage-based reports.

Developers can also access Oracle Enterprise Repository from their development environment. This means that developers never have to leave their IDE's to get access to the assets that they need.

7.2.2.3 Automated Usage Detection

Oracle Enterprise Repository tracks and reports on the design-time use of assets. The automated usage detection is tracked through two methods:

  • Through the manual asset Use - Download process within Oracle Enterprise Repository or through the development environment

  • Automatic usage detection leveraging Software File Identification (SFID)

Software File Identification (SFID) provides the ability to determine asset usage independent of the manual asset Use - Download process. The SFID process tags selected files and asset artifacts with a unique SFID fingerprint. This tag is then used to detect when and where an asset is used, even if the asset was acquired through means other than the Use - Download process. An instance of usage is recorded by Oracle Enterprise Repository when tagged files within the asset are opened in a developer's IDE. For more information about SFID, see Oracle Fusion Middleware Configuration Guide for Oracle Enterprise Repository.

7.3 High Level Use Cases

The Section 7.2, "Best Practices" provides an overview of the production and consumption processes, and encompasses the development environment use cases. The individual use cases are described below. Each development environment includes a subset of these use cases.

7.3.1 Submit Files

Through the development environment, developers can select files to submit to the Enterprise Repository. The files are bundled into a .zip format for submission. The developer can submit single and/or compound-payload assets to Oracle Enterprise Repository.

7.3.2 Harvest Files

Oracle Enterprise Repository can harvest from Oracle products and standards based files. This includes Oracle SOA Suite, Oracle Service Bus, and standard BPEL, WSDL, XSD and XSLT files and file directories. When harvested, Oracle Enterprise Repository automatically creates assets, populates asset metadata, and generates relationship links based on the information in the artifact files. The harvesting function is available from the command line, and can be integrated into the IDE, or into the build process.

For more information, see Oracle Fusion Middleware Configuration Guide for Oracle Enterprise Repository.

7.3.3 Search Oracle Enterprise Repository

Access to assets and artifacts in the Enterprise Repository is available through the development environment. Through the IDE, developers can search for assets matching various criteria or view assets that may be of interest to a development project project.

7.3.4 View Asset Details

For selected assets, developer can view asset details, such as description, usage history, expected savings, relationships, etc. Within the asset metadata, links to supporting documentation, user guides, test cases, etc., are provided to better enable developers to reuse existing functionality.

7.3.5 Download Artifacts

Developers can download an asset's artifacts (i.e., payload) into their project. Typically an asset payload is the functionality that a developer must use a service (such as a WSDL file) or incorporate into their code base (such as a binary or a BPEL file).

7.3.6 Prescriptive Reuse

Through the Oracle Enterprise Repository, analysts, architects, technical leads, and others who are involved in the design stages of a project can create a list of assets that fulfills a project's requirements. The list of assets are captured in compliance templates in the repository and the compliance templates are associated with an Oracle Enterprise Repository project.

From within the IDE, you can view a list of assets appearing in all of the Compliance Templates assigned to your project. You can see which of the assets have been used and/or other project members. For more information about compliance templates, see Oracle Fusion Middleware Configuration Guide for Oracle Enterprise Repository.

7.3.7 Automatic Usage Detection

Oracle Enterprise Repository can automatically detect asset reuse within the development environment. This allows development teams to ensure that they get asset reuse credit, regardless of whether the assets have been downloaded through Oracle Enterprise Repository or pulled from another source, such as the developer's desktop.

For more information about each of these use cases for various IDEs, see Chapter 10, "Using the IDE to Interact with Oracle Enterprise Repository".

Table 7-1 describes the specific use cases supported for each development environment.

Table 7-1 Use Cases and Supported Development Environments

Use Case JDeveloper Eclipse VS .NET

Submit Files

 

Yes

 

Harvest (BPEL, WSDL, XSD, XSLT)

Yes

Yes

Yes

Harvest (SCA)

11g

   

Search Oracle Enterprise Repository

11g

Yes

Yes

View Asset Details

11g

Yes

Yes

Download Artifacts

11g

Yes

Yes

Prescriptive Reuse

 

Yes

Yes

Automatic Usage Detection

 

Yes

Yes


Table 7-2 describes the supported versions and target audience for each IDE.

Table 7-2 Supported Versions for the IDEs

IDE Target Audience Supported Versions

JDeveloper

Oracle Customers

10gR3, 11gR1

Eclipse

Java Developers

3.4

3.3 with Sun JDK 5.0

2.0.3 with Sun JDK 5.0

VS .NET

.Net Developers

2008

2005