Contained Attributes Profiler

Use this topic for a simple page, dialog or other UI without any sections or tabs. You must describe every field and option on the page.

To configure this topic so it generates correctly in the help output, perform the following steps:

1. Configure the Sect1 element:

   1. Create the context-sensitive topic as a Sect1.

   2. Title the context-sensitive topic to reflect the name of the UI, using a simple noun phrase with headline-style capping. In the page title, include the generic noun. For example, Preferences Page, Preferences Dialog, Editing Window, Resource Catalog. If this is a topic that you are migrating, use the same title as before..

   3. Set the HelpTOC attribute to TopicOnly, so this topic does not appear in the TOC.

   4. Modify the sample OutputFileName attribute of the element to include the name of your UI and optionally include the product name. For example, if your product is Oracle XYZ Server and the UI is the Preferences Dialog, modify the value of this attribute from cs_pagename1.htm to something like cs_preferences.htm or xyz_cs_preferences.htm.

   5. Modify the HelpTopicID attribute to match the topicID for the Help icon, button, or UI.

      Use the topicID provided by the engineer as the value for the HelpTopicID attribute for the Sect1 topic. If converting help from another format, use the existing HelpTopicID. Alternatively, you can assign a topicID to the topic and then provide the engineer with the topicID you assigned. The important thing is to make sure the topicID you assign to the topic in FrameMaker matches the topicID assigned to the UI, Help icon or button by development.

2. Configure the InformalTable element with the following guidelines:

   1. Modify the Summary and Title attributes as appropriate for the table.

   2. In the Element column, enter all the elements or options in the UI that should be documented, using the HelpPara element. In the Element column, do not bold the UI element.

   3. To indent the text in the Element column in order to groups the elements as they display in the UI, edit the Role attribute of the HelpPara element. Select Level1 to indent the text from the left margin. You can indent up to four levels to reflect the organization of options displayed in the UI, if needed, using Level1, Level2, Level3, and Level4.

   4. In the Description column, use the Para element, not the HelpPara element. You will not indent text in this column. Describe the option or element in detail. If you reference UI elements other than the one you are describing, use the Bold emphasis. If you provide a code snippet or code reference, apply the Code emphasis.

   5. In the Description column, include More inline links to conceptual topics in administrator, developer and user guides in the documentation library; include How? inline links to individual task topics in these books. Do not include inline links for other information. Instead, include those other links under the Related Topics heading, as described below.

   6. To insert More and How? link to books, use the Xulink element and for the Attribute value, enter olink:DOCID (for example, olink:ASADM11113). For more detailed information about linking, see the topic Applying TopicID Values and Adding Links to Books in the online help standards.

   7. In both the Element and Description columns, add inline graphics where necessary, as described below. Use inline graphics sparingly, only as needed, to provide UI overviews and define unlabeled elements on screen. Icons and buttons are not required in context sensitive online help.

   8. Inline graphics are limited to a height of 22 pixels. If you insert an image that exceeds 22 pixels in height, the image will be reduced and distorted in the OHW/OHJ help JAR, so do not insert it. There are no specific restrictions to the pixel width of an image, however images that fill more than half a column would be better inserted as informal figures in the introductory paragraphs.

3. To insert an inline graphic, follow these guidelines:

   1. Select the location where you want to insert the inline graphic.

   2. In the Elements window, select InlineGraphic, and click Insert. The Attributes for New Element window appears.

   3. Type the AltText value. This is a required attribute and the book will fail if you do not enter some text. Click Insert Element. The Import dialog appears.

   4. Select the graphic to be imported from the graphics folder. The Import Graphic Scaling dialog appears.

   5. Select 72 dpi. Click Set. The graphic is inserted.

   6. Using the spacebar, insert one space before or after the graphic as needed, so there is a single space between the image and text A single space is required between an image and text before or after it (identical to the space between words). No extra space should be added before an image at the beginning of a line.

4. To include the RelatedTopics element and links, follow these guidelines:

   1. The RelatedTopics element is the last element in a Sect1 element and is mandatory. It is included in the template and does not need to be inserted.

   2. The only child element available under the RelatedTopics element is the Para element. You can add multiple Para elements under the RelatedTopics element, in addition to those already in the template.

   3. Add any topics about technologies mentioned, if they are not covered by inline How? and More links.

   4. Add additional cross references to chapters or Sect1s in the documentation library.

   5. To insert link to books, use the Xulink element and for the Attribute value, enter olink:DOCID (for example, olink:ASADM11113). For more detailed information about linking, see the topic Applying TopicID Values and Adding Links to Books in the online help standards.

The Contained Attributes Profiler searches records across a number of attributes for pairs of attributes where one attribute value often contains the other attribute's value. A threshold option is used to drive whether or not to relate pairs of attributes together, depending on the percentage of records where one attribute value contains the other.

Use the Contained Attributes Profiler to find attributes which are, or should be, related. Where there is strong attribute linkage, this may indicate a potentially redundant attribute.

Alternatively, attributes may be supposed to be related, but that relationship may be broken; that is, one column value may be blank but could be derived from another column's value.

The following table describes the configuration options:

Configuration	Description
Inputs	Specify any attributes that you want to examine for contained attribute linkage.
Options	None.
Contained attribute threshold %	Controls the percentage of values that must match using Contains matching in two attributes for those two attributes to be considered as related, and to appear in the results. Specified as a percentage. Default value is 80%. Note that the value must be between 50% and 100% inclusive.
Ignore case?	Controls whether or not case will be ignored when checking if one attribute value contains another. Specified as Yes or No. Default is Yes.
Outputs	Describes any data attribute or flag attribute outputs.
Data Attributes	None.
Flags	None.

The Contained Attributes Profiler requires a batch of records to produce its statistics; that is, in order to find meaningful relationships between pairs of attributes, it must run to completion. Therefore, its results are not available until the full data set has been processed, and this processor is not suitable for a process that requires a real time response.

When executed against a batch of transactions from a real time data source, it will finish its processing when the commit point (transaction or time limit) configured on the Read Processor is reached.

The Contained Attributes Profiler provides a summary view of any pairs of attributes that have a high enough percentage of related values, where one attribute value often contains the other. The following table describes a top-level view showing the following statistics for each pair of related attributes:

Statistic	Description
Contained	The number of records where the values for both the related attributes were the same.
Not contained	The number of records where the values for the related attributes were not the same.

Click on the Additional Data button to display the above statistics as percentages of the records analyzed.

Drill-down on the number of records where the pair of attributes matched exactly to see a breakdown of the frequency of occurrence of each matching value. Drill-down again to see the records.

Alternatively, drill-down on the number of records where the pair of attributes were not equal to see the records directly. If there should be a relationship between attributes, these will be the records where the relationship is broken.

Example

In this example, a number of attributes are checked for a Contains relationship. A relationship is found between the FirstName and EmailAddress attributes, where the FirstName is often contained in the EmailAddress. The summary data:

Field 1	Field 2	Contained (desc)	Not Contained
EmailAddress	FirstName	1829	172

Drilling down on the 1829 records where the EmailAddress contains the FirstName attribute reveals the following view of all the distinct pairs of records where the relationship was found:

EmailAddress	FirstName	Count
[e-mail]	LINDA	2
[e-mail]	PAUL	2
[e-mail]	SHEILA	2
[e-mail]	NORMAN	2
[e-mail]	TONY	2
[e-mail]	PAULINE	2
[e-mail]	ROWLAND	2
[e-mail]	JOHN	2
[e-mail]	TEST	2
EILEEN_BEARD@WILSONS_PENARTH.COM	EILEEN	1
[e-mail]	BRIGETTE	1
[e-mail]	MICHAEL	1
[e-mail]	JOYCE	1
[e-mail]	JOANNA	1
[e-mail]	MAHAJAN	1