Skip Headers
Oracle® Fusion Middleware User's Guide for Oracle Enterprise Repository
11g Release 1 (11.1.1.7)

Part Number E15747-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
PDF · Mobi · ePub

3 Using the Type Manager

This chapter describes how to use the Type Manager to control the organization and display of information for each artifact as it appears in the Asset Editor and in the Asset Detail in Oracle Enterprise Repository.

This chapter includes the following sections:

3.1 Overview

Each artifact in Oracle Enterprise Repository falls under one of three general headings:

Each of these headings is represented by a variety of Types:

These types are patterns, various instances of which are created to accommodate the diverse artifacts that can be managed within Oracle Enterprise Repository. For example:

Types determine both the display of information for, and the taxonomy of, all of the artifacts (assets, compliance templates, policies) in Oracle Enterprise Repository. Oracle Enterprise Repository ships with several types. These can be modified, or new types can be created using the Type Manager.

The Type Manager controls the organization and display of information for each artifact as it appears in the Asset Editor and in the Asset Detail.

3.2 Launching the Type Manager

This procedure is performed in the Asset Editor.

  1. Select Manage Types in the Actions menu. The Type Manager page is displayed, as shown in Figure 3-1.

    Figure 3-1 Type Manager Page

    Description of Figure 3-1 follows
    Description of "Figure 3-1 Type Manager Page"

  2. Select an asset type, compliance template, or policy from the tree to view/edit its configuration.

3.2.1 Type Manager Views

Each type has an Editor and a Viewer.

Information relevant to the configuration of the Editor and the Viewer views for each type is stored in XML files in the database. The Type Manager loads the XML files into a GUI, which enables the creation, modification, and deletion of types. After the type is saved, the data is assembled in XML and loaded into the database.

3.2.1.1 The Editor

The Editor controls the organization and display of information for assets/compliance templates of the particular type as they appear in the Asset Editor.

The Editor display is divided into three sections:

  • General

    Includes the type name, the usage status selector, the type icon selector, and a Preview button, which displays the asset, compliance template, or policy type as seen through the Asset Editor.

  • Tabs

    Includes a list of available tabs for the type. These tabs correspond to tabs displayed in the Asset Editor view of an asset/compliance template. Click any listed tab to display its elements in the Elements section, just below the Tabs section.

  • Elements

    The elements of any tab listed in the Tabs section are displayed here when the item is clicked.

Several buttons appear to the right of the Tabs and Elements sections:

  • Add

  • Edit

  • Remove

  • Move Up

  • Move Down

These actions can be applied to any item listed in the Tabs or Elements sections. Simply select the item, and then click the appropriate button.

The elements listed below are required for valid Types. They can be renamed, but cannot be removed from a type.

  • Name

  • Version

  • Description

  • File Information

  • Notification Email

  • Keywords

3.2.1.2 The Viewer

The Viewer controls the organization and display of information for assets, compliance templates, or policies of the particular type as they appear in the Assets section of Oracle Enterprise Repository (the general user view of asset/compliance template information).

The Viewer display is divided into three main sections:

  • Hidden Elements

    Lists all elements available for display.

    • Use the Edit button (on the right) to change the configuration of any listed element.

    • Use the Display in Group button to assign the element to one of the two columns in the main asset display in Oracle Enterprise Repository.

  • Groups

    Includes Column One and Column Two. These correspond to the two main columns in the main asset display in Oracle Enterprise Repository. Use the buttons on the right to configure the elements in the respective columns.

  • Elements

    Click any item in Groups -- Column One or Groups -- Column Two to display the respective item's elements in the Elements section. Use the buttons on the right to configure these elements.

Caution:

Changes made to Types affect the display of all assets assigned to that type.

3.3 Creating a New Type

To preserve database integrity, only Types to which no assets are currently associated can be deleted.

Note:

This action can alter reuse measurements.

  1. Select New in the File menu to open the Create New Type dialog is displayed, as shown in Figure 3-4.

    Figure 3-4 Create New Type Dialog

    Description of Figure 3-4 follows
    Description of "Figure 3-4 Create New Type Dialog"

  2. Enter the appropriate information in the Type Name text box.

  3. In the Type for Defaults list, select one of the existing Types as the basic template for the new type.

  4. Click OK. The new type appears in the tree, as shown in Figure 3-5.

    Figure 3-5 Asset Type List

    Description of Figure 3-5 follows
    Description of "Figure 3-5 Asset Type List"

3.4 Configuring Tabs to Support Registration Workflow

Tabs should be positioned on a Type in a logical sequence that accommodates the registration workflow. For example, in the Framework asset type (shipped with Oracle Enterprise Repository), it is intuitive to complete the General information first. The Documentation and Testing tabs, being very similar, are located near each other. The actual registration step, the last in the workflow process, is performed on the Administration tab. For that reason the Administration tab is system generated and intentionally fixed in its position.

Whenever a tab is approved, a TabApprovedEvent event is triggered. This event, along with the tab name and certain other metadata, is sent to the workflows for processing. This event is used by the Multi-Tier workflows where, depending on the tab approved and depending on the configuration, the workflows decide if the next tier in the approval process must be assigned or not.

Also, the users can wire the TabApprovedEvent event to any of the pre-defined workflows such as ChangeAssetLifecycle. So, this is also tied to the Tab names.

3.4.1 Adding Tabs

You can add additional tabs in the Type Manager. Perform the following steps:

  1. Select the Type to be modified, as shown in Figure 3-6.

    Figure 3-6 Asset Type List

    Description of Figure 3-6 follows
    Description of "Figure 3-6 Asset Type List"

  2. In the Editor tab, click Add in the Tabs section. The Tabs dialog is displayed, as shown in Figure 3-7.

    Figure 3-7 Tab Information Dialog

    Description of Figure 3-7 follows
    Description of "Figure 3-7 Tab Information Dialog"

  3. Enter the appropriate information in the Tab Name text box.

  4. Click OK. The name for the new tab appears in the Tabs section list, as shown in Figure 3-8.

  5. Click Preview in the General section. The preview page is displayed. The new tab is displayed, as shown in Figure 3-9.

    Figure 3-9 Preview for Component Editor

    Description of Figure 3-9 follows
    Description of "Figure 3-9 Preview for Component Editor"

  6. Close the Preview page.

  7. Click Save to save the changes.

3.4.2 Change the Position of a Tab

To change the position of a tab, perform the following steps:

  1. Select the Type to be modified.

  2. In the Editor tab, select the tab to be moved.

  3. Click Move Up or Move Down, as appropriate. Each click moves the tab one level. Figure 3-11 shows the selected tab has moved from the bottom to the top of the list.

    Figure 3-11 Tabs List - Selected Tab at the Top

    Description of Figure 3-11 follows
    Description of "Figure 3-11 Tabs List - Selected Tab at the Top"

  4. Click Preview in the General section. The preview dialog is displayed. Note new position of the tab in Figure 3-12.

    Figure 3-12 Preview of the Component Editor

    Description of Figure 3-12 follows
    Description of "Figure 3-12 Preview of the Component Editor"

  5. Click Save to save the changes.

  6. Close the Preview window.

  7. Click Save to save the changes.

3.4.3 Editing Tabs

To edit a selected tab, perform the following steps:

  1. Select the Type to be modified, as shown in Figure 3-13.

    Figure 3-13 Asset Type List - Tab Selected

    Description of Figure 3-13 follows
    Description of "Figure 3-13 Asset Type List - Tab Selected"

  2. On the Editor tab, select the tab to be edited, as shown in Figure 3-14.

  3. Click Edit and rename the tab. The Tab Information dialog is displayed, as shown in Figure 3-15.

    Figure 3-15 Tab Information Dialog

    Description of Figure 3-15 follows
    Description of "Figure 3-15 Tab Information Dialog"

  4. Click OK.

  5. Click Save to save the changes.

3.4.4 Deleting Tabs

Note:

Deleting a tab deletes all data associated with the tab.

To delete a tab, perform the following steps:

  1. Select the Type to be modified.

  2. On the Editor tab, select the tab to be deleted, as shown in Figure 3-16.

  3. Click Remove. A confirmation dialog is displayed, as shown in Figure 3-17

    Figure 3-17 Confirmation Dialog

    Description of Figure 3-17 follows
    Description of "Figure 3-17 Confirmation Dialog"

  4. Click Yes. The tab is deleted, and no longer appears in the tabs list or in the preview.

  5. Click Save to save the changes.

All tabs can be deleted from a type, except for those containing any of the following required elements:

  • Name

  • Version

  • Description

  • File information

  • Notification Email

  • Keywords

The system prevents the deletion of any tab containing any of these elements. To delete a tab containing any of these elements the elements must first be moved to another tab.

3.5 Tab Elements

A variety of Elements can be added to tabs to accommodate the management and presentation of asset metadata. Some of these Elements are single-use: they are used only once in a type. After they are assigned, single-use elements no longer appear in the list of available elements. The properties for each element type are listed below.

3.5.1 Working with Elements

Numeric Text elements contain numeric information and are often used with reports. The following example adds a Numeric Text element to the Overview tab of a Type to create a reporting field.

  1. Select the Type to be modified.

  2. On the Editor tab, click Add in the Elements section, as shown in Figure 3-18.

    Figure 3-18 Elements Section

    Description of Figure 3-18 follows
    Description of "Figure 3-18 Elements Section"

    The Select an Element Type to Add dialog is displayed, as shown in Figure 3-19.

    Figure 3-19 Select an Element Type to Add Dialog

    Description of Figure 3-19 follows
    Description of "Figure 3-19 Select an Element Type to Add Dialog"

  3. Select Numeric Text Field from the list.

  4. Click OK. The Edit Numeric Text Field dialog is displayed.

    Figure 3-20 Edit Numeric Text Field Dialog

    Description of Figure 3-20 follows
    Description of "Figure 3-20 Edit Numeric Text Field Dialog"

  5. Enter the appropriate information in the Display Name text box.

  6. Checking Required means that assets of this type cannot be saved (in the Asset Editor) until the necessary data is supplied for all fields in this element.

  7. Check Indexed to include the element fields in Oracle Enterprise Repository searches.

  8. Enter the appropriate information in the Minimum Value and Maximum Value fields.

  9. When finished, click OK.

3.6 Adding Images for Type Manager Icons

You can add images to Type Manager icons. This section includes the following topics:

3.6.1 Icon Image Requirements

  • Size: 16x16 pixels

  • Format: GIF format

  • Save to: images/tree/enterprise/asset subdirectory in the host directory for Oracle Enterprise Repository installation files.

To add icon elements:

  1. Locate the icons.xml file in the images/tree/enterprise/asset subdirectory.

  2. Edit icons.xml as necessary to add icon elements for the new GIF images.

  3. If it is open, close and reopen the Asset Editor.

3.6.2 View/Select Available Type Icons

This procedure is performed in the Type Manager.

  1. Select a Type.

  2. On the Editor tab, click Assign in the General section, as shown in Figure 3-21.

    Figure 3-21 General Section

    Description of Figure 3-21 follows
    Description of "Figure 3-21 General Section"

    The Select Icon dialog is displayed, as shown in Figure 3-22.

    Figure 3-22 Select Icon Dialog

    Description of Figure 3-22 follows
    Description of "Figure 3-22 Select Icon Dialog"

  3. Select an icon from the list.

  4. Click OK.

  5. Click Save to save the changes. The new icon appears next to the Type in the list in the sidebar, as shown in Figure 3-23.

    Figure 3-23 Asset Type List - New Type

    Description of Figure 3-23 follows
    Description of "Figure 3-23 Asset Type List - New Type"

3.7 Unique ID

Every asset submitted to Oracle Enterprise Repository is automatically tagged with an Oracle Enterprise Repository-specific ID number, which is used in the organization and management of assets. However, in certain environments or situations it may be advantageous for an organization to assign an additional custom identification key to specific assets. For example, a Unique ID key might be used to enforce uniqueness when relating an asset to a resource or asset in a system external to Oracle Enterprise Repository.

Oracle Enterprise Repository's Unique ID feature enables users with access to the Type Manager to add the Unique ID element to selected asset and/or compliance template types. Only one Unique ID element can be added per type. This Unique ID element then appears in the Asset Editor display of assets of the selected types.

Users with access to the Asset Editor can assign a Unique ID key to these assets/compliance templates by adding the appropriate information in the Unique ID text box.

The uniqueness of each ID key can be enforced across the entire system, or limited to enforcement within a specific type. For example, when enforced across the entire system, no two assets, regardless of type, can be assigned the same Unique ID key. When enforced within a type, no two assets of the same type can be assigned the same key. However, the same Unique ID can be assigned multiple assets of different types. Within the Asset Editor, any attempt to save an asset with a Unique ID key that has already been assigned to another asset results in a error message.

The specific Type Manager configuration of the Unique ID element determines whether the element and information contained therein is visible to users in the asset detail display for individual assets in Oracle Enterprise Repository.

3.7.1 Adding the Unique ID Element to a Type

This procedure is performed in the Type Manager.

Note:

The properties associated with the Unique ID element must be enabled in the System Settings section of the Admin screen.

  1. Select the Type to be modified.

  2. Select the tab to which the Unique ID element is to be added.

    Figure 3-24 Elements Section

    Description of Figure 3-24 follows
    Description of "Figure 3-24 Elements Section"

    The elements assigned to that tab appear in the Elements section, as shown in Figure 3-24.

  3. Click Add in the Elements section. The Select an Element Type to Add dialog is displayed, as shown in Figure 3-25.

    Figure 3-25 Select an Element Type to Add Dialog

    Description of Figure 3-25 follows
    Description of "Figure 3-25 Select an Element Type to Add Dialog"

  4. Select Unique Element from the list.

  5. Click OK. The Edit Unique Element dialog is displayed, as shown in Figure 3-26.

    Figure 3-26 Edit Unique Element Dialog

    Description of Figure 3-26 follows
    Description of "Figure 3-26 Edit Unique Element Dialog"

  6. Enter the appropriate information in the Display Name text box in the Edit Unique Element dialog.

  7. Click OK. The Unique ID element now appears in the Elements list, as shown in Figure 3-27.

    Figure 3-27 Elements List - Unique ID

    Description of Figure 3-27 follows
    Description of "Figure 3-27 Elements List - Unique ID"

  8. Click Save.

3.7.2 Information Necessary for Custom Reporting

To include the Unique ID element in a custom report, the schema information for this element is required. This metadata is stored in a table which can be joined to the Assets table and is populated based on the value of certain System Settings. The location of the metadata and rules that control it are specified in this section.

  • Table Name:

    UniqueElementValues

  • Fields:

    • assetid: ID of asset (foreign key to assets.id)

    • assettypeid: ID of assettype (foreign key to assettypes.id)

    • value: Unique value (varchar 4000)

    Note:

    A record appears in the uniqueelementvalues table only if the asset's Unique ID element (as it appears in the Asset Editor) contains a value.

Properties

Two properties are associated with the unique element:

  • cmee.unique-element.enable

    • Enable/disable field for uniqueness.

  • cmee.unique-element.per-assettype

    • True = uniqueness enforced within the asset type

    • False = uniqueness enforced across the entire system.

Note:

Repeatedly toggling this property from true to false can result in unexpected system behavior.

Sample Scenarios

  • cmee.unique-element.per-assettype is set to true

    • Uniqueness is enforced within the asset type.

      • Multiple assets of different asset types can share the same Unique ID.

      • Assets of the same asset type cannot share the same Unique ID.

  • cmee.unique-element.per-assettype is set to false

    • Uniqueness is enforced across the system.

      • No two assets, regardless of asset type, can share the same Unique ID.

      • Prior Unique ID assignments are unaffected by this property change. However, attempts to save changes to assets can be rejected if the asset shares a Unique ID.

3.8 Common Metadata Viewers

There are two elements for Asset Types, Compliance Templates, and Policies that allow users to view XML-formatted metadata that is attached to an asset. One is based on XPath expressions and the other is based on XSLT transformations. After it is added to an asset type, the metadata can be viewed in the Asset Editor and the Asset Detail views. Although the metadata appears in the asset editor, it is for reference only. These viewers do not make the metadata editable.

This section includes the following topics:

3.8.1 XPath Common Metadata Viewer

When added to an asset type you must specify a Common Metadata type and an XPath. When viewing an asset, if the asset has common metadata of that type, the XPath is evaluated against the common metadata and the resulting items are displayed in the asset as a simple list.

3.8.2 XSLT Common Metadata Viewer

These viewers are imported into Oracle Enterprise Repository. After they are imported, the viewers appear as elements that can be added to asset types. There is no configuration of the viewer apart from giving it a name. After they are added to an asset type, assets of that type that contain common metadata compatible with the viewer displays the metadata as defined by the XSLT of the viewer.

3.9 Viewing and Editing Type XML Schemas

The Type Manager includes features that allow users to view and edit the XML schemas for Asset Types, Compliance Templates, and Policy Types.

3.9.1 Configuring XML Schemas

This section describes the configuring options available:

  • The Export Schema viewer is available only to users assigned to the Admin role.

  • The Support menu displayed is determined by the following conditions:

    • If the user has Admin privileges.

      • The XML Editor option is accessible in the Support menu.

    • If the property cmee.asseteditor.allow.manual.proxy is enabled.

      • The manual proxy configuration option is accessible in the Support menu.

3.9.2 Using the Export Schema Feature

This procedure is performed in the Type Manager.

  1. Select Export Schema from the File menu. The Load dialog is displayed, as shown in Figure 3-28.

  2. Select an XML schema type from the Type list.

  3. Click OK. The XML schema display is displayed, as shown in Figure 3-29.

    Figure 3-29 XML Schema Display

    Description of Figure 3-29 follows
    Description of "Figure 3-29 XML Schema Display"

    The display window does not allow editing of the schema. However, the schema can be saved to the local file system for later use. (Click Save in the window's File menu.)

    Note:

    The schema can also be copied/pasted into a local document to use for validation of Type XML documents.

3.9.3 Using the Type XML Editor

The XML Editor enables unvalidated modifications of the XML source for Asset Types, Compliance Templates, and Policy Types.

Caution:

Improper changes to the XML source can render all types inoperable.

  1. In the Type Manager, select XML Editor from the Support menu. The following warning message displays:

    Changes made in the XML Editor are not validated and can render a Type unavailable!

  2. Click OK. A blank dialog is displayed.

  3. Click OK. The XML schema display opens.

  4. Select Load from the File menu in the blank window.

  5. In the Load dialog, as shown in Figure 3-30, select the type of XML schema to be edited from the Type list.

  6. Select Editor or Viewer from the XML Type list. These selections refer to the Editor and Viewer tabs in the Type Manager.

  7. Click OK. The selected schema is displayed, as shown in Figure 3-31.

    Figure 3-31 XML Schema Display

    Description of Figure 3-31 follows
    Description of "Figure 3-31 XML Schema Display"

  8. Edit the schema as necessary.

  9. Save the changes by selecting Save on the File menu.