A Other Configurations

A.1.1 Download the Help File

1. Download the compressed Oracle Enterprise Repository Help file. (Contact Oracle support for the correct version for your system.)

2. Extract the contents of the compressed Help file to the desired URL-accessible directory on the appserver/web server.

A.1.2 Configure the Custom Help URL Property

This procedure is performed on the Oracle Enterprise Repository Admin screen.

1. In the left panel, click System Settings. The System Settings section is displayed, as shown in Figure A-1.

   Figure A-1 Oracle Enterprise Repository System Settings Section

   
   Description of "Figure A-1 Oracle Enterprise Repository System Settings Section"
   
   

2. Type cmee.tool.help.url into the System Settings Search text box. The Custom Help URL property is displayed, as shown in Figure A-2.

   Figure A-2 Custom Help URL Property

   
   Description of "Figure A-2 Custom Help URL Property"
   
   

3. Enter the appropriate URL for the Help files in the Custom Help URL property text box. The proper end-point to the URL should be wwhelp.htm.

   The primary Help URL must reflect the newly created file location. For example:

4. Click Save.

5. Refresh the browser.

6. Click Help in the Oracle Enterprise Repository menu bar to verify that the link points to the appropriate URL.

A.2.1 Asset Upload System Settings

This procedure is performed on the Oracle Enterprise Repository Admin screen.

1. In the left panel, click System Settings.

2. Locate the Upload Area section in the Server Settings group.

   Figure A-3 Upload Area Section

   
   Description of "Figure A-3 Upload Area Section"
   
   

3. Using the following information as a guide, change the Upload Area settings to reflect your organization and its environment.

   Submission Upload Directory

   • cmee.server.paths.upload

   • Defines the directory used to store files uploaded with an asset submission. If left blank, you cannot upload files. The directory should be placed inside the Oracle Enterprise Repository web app. For example: <ORACLE_HOME>/user_projects/domains/<oerdomain>/autodeploy/<oer-app-name>/oer-app/custom/upload where upload is a directory created inside the custom directory. It is not necessary that the upload directory be a child of a custom directory but it is a recommended practice. This property enables the following features:

     • Enables the Add Attachment Now option in the Asset Submission form. (Required if files are to be attached to assets during the submission process.)

     • Enables Uploaded Submission Files option in the Asset Editor.

   Registrar Submission Upload Path

   • cmee.server.paths.upload-registrar

   • Defines the directory path for registrar browsing, typically a UNC path, which allows direct access to the submission upload directory. The upload folder should have a windows share. For example: \\<machineName>\<sharename>\upload. Leave blank if the upload repository is not UNC.

     • Enables file browsing through the Asset Editor (Optional).

     • The path, when hosted by UNC, requires Windows OS or Samba/Sharity.

     • Enables the appearance of the Browse button in Uploaded Submission Files in the Asset Editor.

   Submission Upload Artifact Store

   • cmee.server.paths.upload-repository

   • Specifies a configured artifact store to allow direct public access to the submitted files. Used for one-step acceptance of submitted files in the Asset Editor. When this property is set:

     • Asset files that are available for use/download are visible.

     • The Accept button is visible in the uploaded submission files section of the Asset Editor.

Proxy Downloads

Oracle Enterprise Repository includes an additional option that allows the Repository application server to act as a repository proxy for the user. This feature automatically removes username and password text that is supplied in the HTTP URL during file downloads. This feature is applicable to any artifact store providing that Oracle Enterprise Repository can have network connectivity to resources in that store. Contact Oracle Enterprise Repository support for details.

Examples of Artifact Store Configurations

For instructions on configuring one of the following artifact stores, see Creating and Configuring an Artifact Store.

• UNC

  • Hostname: unc.oer.com

  • Path: upload/

  • Username: user_oer

  • Password: flash

  • URL: file:////unc.oer.com/upload/

• HTTP

  • Hostname: http.oer.com

  • Path: oer-web/upload

  • Username: user_oer

  • Password: flash

  • URL: http://user_oer:[email protected]/oer-web/upload/

• FTP

  • Hostname: meta.oer.com

  • Path: upload

  • Username: user_oer

  • Password: flash

  • URL: ftp://user_oer:[email protected]/upload/

• ClearCase

  • Hostname: clearcase.oer.com

  • Path: ccaseweb/bin/ccweb

  • Username: user_oer

  • Password: flash

  • URL: http://clearcase.oer.com/ccaseweb/bin/ccweb/?dir=/&elem=&cmd=view&user=user_oer&password=flash

• PVCS

  • Hostname: pvcs.oer.com

  • Path: dav

  • Username: user_oer

  • Password: flash

  • URL: http://user_oer:[email protected]/dav/

• Raw URI

  • Name: Example RAW URI

  • RAW URI: http://www.example.com/path1/path2?parameter1&parameter2

  • URL: http://www.example.com/path1/path2?parameter1&parameter2

A.2.2 Creating and Configuring an Artifact Store

An Artifact Store is where the files relevant to assets in Oracle Enterprise Repository are stored. Launch the Asset Editor window from the Oracle Enterprise Repository home page.

1. Click Edit/Manage Assets. The Asset Editor is displayed, as shown in Figure A-4.

   Figure A-4 Asset Editor

   
   Description of "Figure A-4 Asset Editor"
   
   

2. Select Configure Artifact Stores in the Actions menu. The Configure Artifact Stores dialog is displayed, as shown in Figure A-5.

   Figure A-5 Configure Artifact Stores Dialog

   
   Description of "Figure A-5 Configure Artifact Stores Dialog"
   
   

3. Click Add. The Create a New Artifact Store dialog is displayed, as shown in Figure A-6.

   Figure A-6 Create a New Artifact Store Dialog

   
   Description of "Figure A-6 Create a New Artifact Store Dialog"
   
   

4. Enter a unique name for the artifact store in the Name text box.

5. Select the type of artifact store from the Type list (this example uses UNC).

6. Enter the host name of the application server in the Hostname box.

7. Enter the rest of the path in the Path text box.

   A file link, appended with the host name and path, appears in the URL text box. This link can be cut/pasted into a file explorer/browser window in order to view the file.

8. If necessary, enter the appropriate information in the Username and Password text boxes.

9. Click OK.

10. Enable the artifact store using Submission Upload Artifact Store system setting, as described in Section A.2.3, "Selecting a New Artifact Store".

A.2.3 Selecting a New Artifact Store

After configuring an artifact store as described in Creating and Configuring an Artifact Store, you must select it using the Submission Upload Artifact Store system setting on the Oracle Enterprise Repository Admin page.

1. Open the Oracle Enterprise Repository Admin page.

2. In the left panel, click System Settings.

3. Locate the Upload Area section in the Server Settings group of system settings, as shown in Figure A-3.

4. Use the Submission Upload Artifact Store list to select the newly created artifact store.

5. Click Save.

A.6.1 Under Tomcat

This section describes the application deployment steps for the Tomcat application server:

1. Regardless if this application is a new installation or an upgrade installation, you will find that a number of XSLT templates are delivered with the product to correspond with the sample asset types shipped with the current version of the new installation/upgrade of the product. In the case of an upgrade, it would be advantageous to move/remove these sample templates as they reference asset types that will not exist within the upgraded application. They can certainly be used for reference, but for the most part, will not be compatible with the asset types defined in the application.

2. If the installation is an upgrade, make a backup copy of any existing XSL stylesheet files.

3. Perform the application upgrade as described within the Upgrade Documentation.

4. All files backed up from Step 1 should be restored/copied back into the new pdfreport/xsl directory.

5. Restart the Tomcat application server process.

6. Login to the application as a user with the sysadmin role.

7. Click Admin in the menu bar.

8. Click System Settings in the left pane of the Admin page.

9. Enable each of the options listed below with the appropriate directory information for your environment:

   • For Windows - (NOTE: The trailing slashes are required):

     • cmee.asset.xml.paths.export-destination=C:\\java\\jakarta-tomcat-5.0.25\\webapps\\oer\\report\\export\\

     • cmee.asset.xml.paths.out-destination=C:\\java\\jakarta-tomcat-5.0.25\\webapps\\oer\\report\\pdf\\

     • cmee.asset.xml.paths.xsl-source=C:\\java\\jakarta-tomcat-5.0.25\\webapps\\oer\\report\\xsl\\

     • cmee.asset.xml.paths.export-destination-url=http://localhost:8080/pdfreport/export/

     • cmee.asset.xml.paths.out-destination-url=http://localhost:8080/pdfreport/pdf/

     • cmee.asset.xml.paths.webapp-url=http://localhost:8080/pdfreport

   • For Linux/Unix - (NOTE: The trailing slash is required):

     • cmee.asset.xml.paths.export-destination=/usr/local/java/jakarta-tomcat-5.0.25/webapps/pdfreport/export/

     • cmee.asset.xml.paths.out-destination=/usr/local/java/jakarta-tomcat-5.0.25/webapps/pdfreport/pdf/

     • cmee.asset.xml.paths.xsl-source=/usr/local/java/jakarta-tomcat-5.0.25/webapps/pdfreport/xsl/

     • cmee.asset.xml.paths.export-destination-url=http://localhost:8080/pdfreport/export/

     • cmee.asset.xml.paths.out-destination-url=http://localhost:8080/pdfreport/pdf/

     • cmee.asset.xml.paths.webapp-url=http://localhost:8080/pdfreport

10. Save all changes applied to properties. The updates to these properties take effect immediately upon a successful save operation.

A.6.2 Maintaining XSL:FO Templates for use with Oracle Enterprise Repository

This section describes how to maintain XSL:FO templates for use with Oracle Enterprise Repository. This section contains the following topic:

Maintaining the XSL template from an Asset XML export

Prerequisites:

• Oracle Enterprise Repository has been configured for XSLT printing (as described above).

• The process described below requires the use of Altova XML Spy.

1. Configure an instance of Oracle Enterprise Repository with the XSLT Printing functionality as described above.

2. Login to Oracle Enterprise Repository.

3. Use Search or other means to select a registered asset of the Type for which the XSL template is to be created.

   Note:

   Selecting a well-documented asset will facilitate previewing the XSL:FO template.

4. Create a local work folder that contains the following sub-directories:

   • xml

   • schema

   • xsl

   • sps

5. Transfer the XML document from the <oer_home>/reports/export directory <<HOW DID IT GET THERE?>> to the newly created xml sub-directory.

6. Open that XML document with Altova XML Spy.

7. Select Generate DTD/Schema from the DTD/Schema menu in Altova XML Spy.

8. When prompted, select the following options for the generated schema file:

   • DTD/Schema file format: W3C Schema

   • List of Values: Unlimited

   • Attribute/Element type detection: Best possible

   • Represent complex elements as: Complex types

   • Elements that were used once: Make local definition

9. Click OK to generate the schema.

10. Save the resulting XSD file to your schema sub-directory in the work folder.

11. When prompted, "Do you want to assign generated DTD/Schema to your XML document?", Select No.

12. Close Altova XML Spy. The generated XML schema from the previous step contains data element values that must be removed before processing the schema.

13. Use the find-and-replace function in a text editor to remove all lines containing the expression: <xs:enumeration value=.

14. Save the changes to the schema file.

15. Exit the text editor.

16. Open the modified schema file with Altova StyleVision.

    WARNING:

    Opening a schema file containing any element related to the value field will cause a StyleVision error.

17. Use StyleVision to modify the layout of the printed document.

    To view layout modifications:

    1. Select Assign Working XML File... in the File menu.

    2. Select the exported XML document.

       This will generate a preview of the output of the XSL:FO template populated with live information. The most common layout method is one that closely mimics the layout of the asset detail in Oracle Enterprise Repository.

18. When the layout is completed, save the StyleVision formatted document to the sps sub-directory in the local work folder for later retrieval and modification.

19. Open the File menu.

20. Select Save Generated Files.

21. Select Save Generated XSL:FO File...

22. Save the XSL document to the xsl sub-directory in the local work folder.

    Use a filename that is appropriate for the Type to which the XSL document is associated.

23. Copy the generated XSL file to the <oer_home>/reports/xsl folder (as designated in the cmee.asset.xml.paths.xsl-source property listed above).

24. In Oracle Enterprise Repository, select the asset that was exported to generate the original XML schema.

25. Click the Print button in the asset detail to export the asset's XML schema. A dialog is displayed.

26. Follow the prompts in the dialog to select the newly created XSL:FO template, which is used to generate the PDF document. The generator will create the PDF document.

27. Click the View Document button to open the PDF document.

28. Compare the PDF document to the template design created in StyleVision.

29. Make changes as necessary.

A.8.1 Base Data Pack

The Base Data Pack is the set Oracle Enterprise Repository data, which is installed with a new installation of Oracle Enterprise Repository. This Data Pack is initially required by every new instance of Oracle Enterprise Repository.

A.8.2 Harvester Solution Pack

The Harvester is available in 11.1.1.x.0-OER-Harvester-Solution-Pack.zip, which is bundled with the Oracle Enterprise Repository 11g installation.

A.9.1 Flags on Asset Type Elements

Many elements, which can be added to Asset Types, have a pair of flags to enhance Oracle Enterprise Repository functionality. These flags are toggled in the Type Manager when Adding or Editing an element.

Required Flag - These are elements, which are expected to be populated, for the Asset Editor to save the asset. The flag does not restrict save through the Open API.

Indexed Flag - These are elements, which are available for Advanced Searches on Assets. It is most meaningful for assets, which are stored in Custom Data.

A.9.2 Grandfathered Data

There are several operations in Oracle Enterprise Repository, which affect the types in the repository and future operations on assets of those types, but which do not affect metadata already associated with assets.

• Elements removed from an asset type

  If an element is removed from an asset type, assets that have values specified for that element keep those values in the database and continue to persist those values with future saves of the asset. The values will not appear to the UI, but are available through API operations, custom reporting, and restoration if the element is readded to the asset type.

• Data values in elements which are restricted by Acceptable Value Lists

  An Acceptable Value List specifies the values that are legal for when an asset with a list or multiple aelection list is being assigned a value. Oracle Enterprise Repository also considers any value already assigned to the element to be a legal value. When the list is changed, the assets using values from the list are not subsequently saved.

  In order to propagate a change in the list of values to assets using those values, an OpenAPI program could be utilized. That program should search for element/value pairs that will return those assets using the removed value. The program should then change those values to something legal and save the assets.

  For example, A Traffic Light value list contains the values "Red", "Yellow", "Green". Any new asset will have the values "Red", "Yellow", "Green" available for populate of the Traffic Light list.

  There is an existing asset that has the value "Left-Turn". This value was legal at one point in the past, but is no longer part of the Traffic Light value list. For this existing asset, the legal values in the Traffic Light list are "Red", "Yellow", "Green", Left-Turn".

A.9.3 Element Storage

Asset metadata in Oracle Enterprise Repository is stored in elements, which belong to one of four different groups. Each of these groups is persisted and behaves in different ways. The four groups are:

• Mandatory-Data

  These are elements, which must be part of an Asset Type.

  Mandatory Data elements are persisted to the database in true relational fashion, with columns holding the data, accessible by an Asset ID Foreign Key. All Mandatory Data elements have an XML Mapping, which begins with "mandatory-data/".

• Custom-Data

  These are elements, which are suitable for customization and removal. Newly created elements in the Type Manager appear in this section.Custom Data elements are persisted in a single block of XML, which is stored in the database, as a CLOB. All Custom Data elements have an XML Mapping, which begins with "custom-data/".

• Admin-Data

  These are the elements, which appear on the Administration tab of the Asset Editor. No customization of these elements is possible. These elements are used for Registration Workflow and Status and Custom Access Settings.

  Admin Data elements are persisted to the database in true relational fashion, with columns holding the data, accessible by an Asset ID Foreign Key. This data is modified by firing actions on an asset, for example, AssetRegister().

• Custom Metadata Framework (CMF) metadata

  The metadata that is persisted by this framework is considered System-Supplied and is protected from modification by the Oracle Enterprise Repository UI. This framework is primarily utilized by integrations, which utilize specific structures of metadata and are often tied to XML Schemas.CMF metadata elements are persisted as BLOBs in blocks, which conform to the CMF Entry Type. Generally, these blocks are XML.

A.9.4 Elements Required to Exist on Asset Types

There are several elements, which cannot be removed from any Asset Type:

• Name

  This element is the name of the asset. The name and version pair must be unique within Oracle Enterprise Repository. It is limited to 128 characters. It is possible to limit a search to this element by using the prefix "name:". In Asset Detail, the name is part of the Asset Header.

• Version

  This element is the version of the asset. The name and version pair must be unique within Oracle Enterprise Repository. It is limited to 128 characters. In Asset Detail, the version is part of the Asset Header.

• Description

  This element is the description of the asset. This element can contain HTML and is treated as HTML by the browser when the asset is loaded. It is limited to 4000 characters. It is possible to limit a search to this element by using the prefix "description:" or "desc:".

• Notification Email

  This element is the email address, which will receive notifications when the asset is used. The email address is a single address, without comma or other separation. If multiple recipients need to be notified, then the email address must be a group, established by an email system and outside of Oracle Enterprise Repository.

• Keywords

  This element contains the keywords for the asset. These are included in all searches using a typed search string.

• File Information

  This element contains the URIs to the downloadable files on the asset. This element never appears in Asset Detail.

• Uploaded Submission Files

  This element contains the list of files, which have been uploaded to Oracle Enterprise Repository and have not yet been accepted into File Information. This element never appears in Asset Detail.

A.9.5 Elements Tied to Functionality

• Policy: The Policy feature requires two elements, one relationship type and two system settings. It uses the Policy archetype in the Type Manager.

  • The Policy (instance of type with archetype Policy Type) requires a plugin to host the list of Policy Assertions. This plugin is "Policy Assertions" (PolicyAssertionPlugin).

  • An asset (instance of type with archetype Asset Type) requires a two-way, order matters relationship to be governed by a Policy. The default relationship type is "Policy Applied To".

    • The relationship type linking a policy to a governed asset is specified by the cmee.asset-policy.relationship system setting.

  • The governed asset requires a plugin to allow the True/False response on each Policy Assertions. This plugin is "Applied Asset Policies" (AppliedAssetPolicyPlugin).

  • The System Setting "Enable Asset Policies" (cmee.asset-policy.enable) allows use of the Policy Type archetype, the "Policy Assertions" and the "Applied Asset Policies".

• Compliance Templates: This feature requires three relationships and one system setting. It uses the Compliance Template archetype in the Type Manager.

  • Compliance Templates require relationships to prescribe assets for use. The list of required relationship names are:

    • "Assets-to-be-Used" [Asset Prescribed by/Prescribed Asset(s)]

    • "Required-Environments" [Environment Prescribed by/ Prescribed Environment(s)]

    • "Processes-to-be-Followed" [Process Prescribed by/ Prescribed Process(es)]

  • The System Setting "Enable Compliance Templates" (cmee.compliance-template.enable) allows use of the Compliance Template archetype.

• Producing Project: The Producing Project feature requires one element and one system setting.

  • Producing Project requires a plugin to map the asset to the list of projects which contributed to its creation. This plugin is "Producing Projects" (ProducingProjectsPlugin).

  • The System Setting "Producing Projects" (cmee.project.producing.enabled) allows use of Producing Projects.

• Unique Element: The Unique Element feature requires one element and two system settings.

  • The Unique Element requires a plugin to persist the unique value. This plugin is "Unique Element" (UniqueElementPlugin).

  • The System Setting "Enable Custom Unique Element" (cmee.unique-element.enable) allows use of the Unique Element.

  • The System Setting "Unique Element Per Type" (cmee.unique-element.per-assettype) determines if the Unique Element applies to the entire system or within individual types.

• Predicted Net Hours Saved (PNHS): PNHS drives most reporting. It requires one element.

  • PNHS requires a Numeric Text Field to persist the number of hours saved. It must be a positive number. The Numeric Text Field must have an XML Mapping of "custom-data/development-hours".

  • If this element needs to be added to an asset type, create a Numeric Text Field named "development hours" to properly create the XML Mapping. Then Edit the element and change the name to "Predicted Net Hours Saved" to properly label it. Do not use quotes when adding or editing the element.

• Total development hours (TDH): This element drives some reporting. It requires one element.

  • Total development hours (TDH) requires a Numeric Text field to persist the number of hours saved. It must be a positive number. The Numeric Text field must have an XML Mapping of "custom-data/total-development-hours--tdh-".

  • If this element needs to be added to an asset type, then create a Numeric Text field named Total development hours (TDH). Do not use quotes when adding or editing the element.

• Harvesting: The Harvester tool allows integration with many products, including Oracle SOA Suite, Oracle Service Bus, Oracle Enterprise Manager, Oracle BPEL PM, UDDI Registries, and others. For harvesting to be possible the Harvester Solution Pack is required to be imported and all of the asset types included in that Solution Pack must exist and be active. The Harvester will write metadata into a combination of mandatory-data, custom-data, and CMF metadata sections of an asset.

  • Fields utilized by Harvesting include:

    • Name: The asset name is a concatenation of several harvested attributes ·

      For abstract entities, the Name is the "internalName", which is a combination of the "namespace", "shortName", and "discriminator".

      For artifact entities, the Name is a combination of the "namespace" and "path".For type entities, the Name is the "internalName", which is a combination of the entity's "type" and "shortName".

    • Version: The asset version comes from the harvested "version" attribute.

    • FileInformation: The asset file information contains the list of files available on an asset's Use/Download operation. For artifact entities, the File Information is constructed to contain either the URI of the file or the file contents. The parameter "path" contains the URI.

    • harvesterProperties: Metadata from an harvesting operation places its data into a CMF metadata entry named "internal.introspector.store". The metadata is exposed to asset detail within the viewer named "Introspection Standard Attributes Viewer". The expected properties within the internal.introspector.store vary by harvesting source and Oracle Enterprise Repository asset type. For more information about the harvester properties, see Section A.10, "Harvester Properties Matrix".

Fields on asset types used by various integrations with Oracle Enterprise Repository:

A.9.6 Description of the Asset Type Catalog

The Asset Type Catalog lists those Asset Types, which are shipped with the Base Data pack and the Harvester Solution Pack. It is contained within an Excel spreadsheet named Asset Type Catalog.xls. Each asset type is included with the complete list of elements found on that type. For each element several pieces of information are listed, as follows:

• Asset Type: The asset type on which the element resides.

• Source: The Solution or Data Pack, which ships the element with the asset type.

• Tab: The Editor tab on which the element can be found. The elements are not ordered within the tab.

• Element: The name of the element as it appears within the Asset Editor.

• Type: The data type for the element using the data types listed when adding a new element in the Type Manager.

• XML Mapping: The XPath to the data as it would appear in the XML generated by an assetRead() operation;

• Properties: A list of properties relevant to the data type of the element, strings have the maximum length, numbers have the scale, precision and range, lists have the name of the value list, etc.

• Value List: For elements that are restricted to the list of values specified by an acceptable value list, the legal values are shown. Oracle Enterprise Repository allows grandfathered data to be retained in value restricted elements.

• Required: The value of the Required flag for the element.

• Indexed: The value of the Indexed flag for the element.

• Notes: A column to allow Oracle Enterprise Repository customers to add their own notes about their use of the element.