TOC
- Class Name:
- com::liquent::insight::manager::publisher::data::specialsheets::TOC
Note: If the
TOC class is declared in the Assembly XML, then the
TocType class must also be declared.
| Field Name | Field Type | Matching UI Field | Req (Y/N) | Description | Acceptable Values | Default Value |
|---|---|---|---|---|---|---|
| assemblyId | long | Y | The value of the ID field of the Assembly class. | |||
| begDate | date | N | This field is not used for import. | |||
| begUserId | long | N | This field is not used for import. | |||
| bookmark | long | Bookmark Handling | N | This field is not used for import. | ||
| changeReasonComment | string | N | This field is not used for import. | |||
| changeReasonTypeId | long | N | This field is not used for import. | |||
| childSeqNo | long | Y | The sequential number of the TOC in the list of Publishing Elements that defines the place in the sequence among the elements that are attached to the current Assembly node. The index starts from zero. See the example in Explanation for childSeqNo Field. | 0, 1, 2, etc. | ||
| comments | string | Comments | N | Comments specific to the TOC in the Assembly Outline. | ||
| creationDate | date | N | This field is not used for import. | |||
| creatorId | long | N | This field is not used for import. | |||
| definitionFileReferenceName | string | TOC Definition File | N | This field is not used for import. | ||
| desc | string | Description | N | A description of the TOC in the Assembly Outline. | ||
| destinationEntryText | string | Right Column Entry Text | N | This field is not used for import. | ||
| destinationHyperlinkStyle | string | N | This field is not used for import. | |||
| documentSourceId | long | N | This field is not used for import. | |||
| extractionExcludeText | string | Exclude All Bookmarks with the Text | N | This field is not used for import. | ||
| extractionIncludeText | string | Include Only Bookmarks with the Text | N | This field is not used for import. | ||
| extractLevels | long | Include Bookmarks up to Level | N | This field is not used for import. | ||
| generationDate | date | TOC Last Generated | N | Displays the date the TOC was last generated. | Date format - Unix Timestamp. | |
| generationLocationDisplay | string | TOC Generation location | N | This field is not used for import. | ||
| generationLocationId | long | N | This field is not used for import. | |||
| id | long | Y | Unique TOC ID represented by numerical value. This field is used to link classes within Assembly XML. This value will be used to populate corresponding fields in child classes. This ID will be replaced by database ID in the imported assembly. | |||
| includeInPageCountFlag | string | Include in Page Numbering | N | This field is not used for import. | ||
| keywords | string | Keywords | N | Keywords specific to the TOC in the Assembly Outline. | ||
| leaderText | string | Leader | N | This field is not used for import. | ||
| linksToInclude | object | Include Links to TOCs | N | This field is not used for import. | ||
| overlaySettingsId | long | Overlay Settings | N | The overlay to apply on the published output. If set to Use Default, the default overlay at the time of publish will be used. If the overlay settings are set to anything else, these settings will be used at the time of publish.
The value of the ID field of the Overlay class. |
||
| overwriteDocFlag | string | Do Not Overwrite Document | Y | Do not overwrite document. |
|
|
| parentContentId | long | Y | The value of the ID field of the class that contains this TOC. It can be any class from the following list:
|
|||
| parentExtractId | long | N | This field is not used for import. | |||
| parentVolumeId | long | N | This field is not used for import. | |||
| plannedPageCount | int | Planned Number of Pages | N | The planned number of pages. | ||
| previewDate | date | N | This field is not used for import. | |||
| previewFileName | string | N | This field is not used for import. | |||
| previewGenerationLocation | string | N | This field is not used for import. | |||
| previewGenerationLocationId | long | N | This field is not used for import. | |||
| rangeContentId | long | Range Start | N | Define a starting location for the content to be included in the TOC other than the node the TOC is inserted onto. It can be any class from the following list:
|
||
| sourceEntryText | string | Left Column Entry Text** | N | This field is not used for import. | ||
| specialSheetType | string | N | This field is not used for import. | |||
| ssIcon | string | Y | See fixed value. | Fixed value is TOC | ||
| title | string | Title | Y | A title for the Table of Contents. | ||
| tocLevels | long | Build TOCs to Level | N | This field is not used for import. | ||
| tocTypeId | long | Publishing Setting | Y | Value of the ID field of TocType class. | ||
| typeCaption | string | Header | N | This field is not used for import. |