Help Topic Abstract

An abstract of the help document, with specific attributes for industry, localization, release, and language.

QName: {http://xmlns.oracle.com/apps/atk/helpPortal/helpPortalService/applicationModule/}HelpTopicAbstract

Relationships

The following table describes how this service data object is related to other service data objects or business object services.

Relationship Type Object or Service

Handled by

Help Topic Abstract

Attributes

The following table describes attributes in the service data object.

Name Type Description

AbstractSummary

string

An abstract summarizing the content of a help file.

FileType

string

The code name for a help type, such as FAQ, EXAMPLE, DEMO, or CONCEPTUAL.

LastUpdateDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

Date that the help file was last updated.

Rating

int

Average rating for a help file, on a scale of 1 to 5.

RatingCount

long

Number of users who have rated the help file.

Source

string

A description for a help file source.

SourceCode

string

The source of a help file, either ORACLE or CUSTOM_TOPIC.

Title

string

A help file heading or name.

TopicAttributeHierStr

string

Reserved for future use.

TopicId

string

A unique identifier for a help file.
  • Primary Key

TopicType

string

A help type, such as FAQ, Example, Demo, or Help Topic.

TopicTypeStr

string

The description for a help type such as "Frequently asked questions".