Document
Document
Class Name: com::liquent::insight::manager::content::dto::Document
Note: If a field name is not required, but does contain a default value, the default value will be set automatically in the imported Assembly unless otherwise specified in the Assembly XML.
| Field Name | Field Type | Matching UI Field |
Req (Y/N) |
Description | Acceptable Values | Default Value |
| abbreviatedN ame | string |
Abbreviated Name |
N |
The abbreviated name of the Document/ Placeholder. |
||
| absoluteChild SeqNo | long | Y | The value of this field is an index that increases from top to bottom in the assembly tree. | See example in Explanation for childSeqNo and absoluteChild SeqNo Fields on page 747. | ||
| activeFlag | string | N | This field is not used for import. | |||
| assemblyId | long | N | This field is not used for import. | |||
| assignmentSt atus | string | N | This field is not used for import. |
| Field Name | Field Type | Matching UI Field |
Req (Y/N) |
Description | Acceptable Values | Default Value |
| bindingRule | string | Bound Version | N |
The default rule used to bind documents from the DMS to one of the following document properties: — version_la bel=CURR ENT — status=(In Draft|In Review| Approved| In Approval) — version_nu mber=[stri ng that represent version number] |
Example: — version_ label=CU RRENT — status=A pproved — version_ number=1 .0 |
version_label =CURRENT |
| category | string | Category | N |
The category of the document/ placeholder. |
||
| changeReaso nComment | string | N | This field is not used for import. | |||
| changeReaso nTypeId | long | N | This field is not used for import. | |||
| checkOutDate | date | N | This field is not used for import. |
| Field Name | Field Type | Matching UI Field |
Req (Y/N) |
Description | Acceptable Values | Default Value |
| checkOutLoca tionId | long | N | This field is not used for import. | |||
| childSeqNo | long | Y |
The value of this field is an index that increases from top to bottom within the current parent node of the assembly tree. |
See example in Explanation for childSeqNo and absoluteChild SeqNo Fields on page 747. | ||
| comments | string | Comments | N |
Comments regarding the Document. |
||
| copiedFromId | long | Copied From | N | This field is not used for import. | ||
| depth | long | N | This field is not used for import. | |||
| description | string | Desciption | N | Description of the document. | ||
| discriminator | string | N | This field is not used for import. |
The fixed value for Document is "D" |
||
| displayCopied FromName | string | N | This field is not used for import. | |||
| displayNewer VersionAvaila ble | string | N | This field is not used for import. |
| Field Name | Field Type | Matching UI Field |
Req (Y/N) |
Description | Acceptable Values | Default Value |
| displayRevie wStatus | string | N | This field is not used for import. | |||
| displayTypeN ame | string | N | This field is not used for import. | |||
| dueDate | date | Due Date | N | Displays the date the document is due to be completed. |
Date is in Unix Timestamp date format. |
|
| extensionDisp layName | string | N | This field is not used for import. | |||
| extensionTyp e | string | N | This field is not used for import. | |||
| guid | string | N | This field is not used for import. |
| Field Name | Field Type | Matching UI Field |
Req (Y/N) |
Description | Acceptable Values | Default Value |
| id | long | Y |
Unique Document ID represented by a numerical value. This field is used to link classes within the Assembly XML. This value will be used to populate correspondin g fields in child classes. This ID will be replaced by the database ID in the imported Document. |
Example: 5516639 |
||
| inclInPageNu mbersFlag | string |
Include in Page Numbering |
N | Enables the document to be exempt from page numbering (when using variables). |
— Y — N |
Y |
| keywords | string | Keywords | N | Keywords about the document. | ||
| lockFlag | string | N | Indicates if the Leaf has been locked or not. |
— U - Unlocked — L - Locked |
U |
| Field Name | Field Type | Matching UI Field |
Req (Y/N) |
Description | Acceptable Values | Default Value |
| modifiedFile | string | N | The name of the leaf that is modified, used when lifecycling. | |||
| name | string | Name | Y |
The name of the Document/ Placeholder. |
||
| nodeNumber | string | Number | N | Number of the document, can contain numbers and letters. |
1, 2, 3, 4, 5, 1.0, 1.A, etc. |
Default value is empty. |
| numLifecycle dChildren | long | N | This field is not used for import. | |||
| operatedInSe quenceId | long | N | This field is not used for import. | |||
| other | string | Other | N | Other information about the document. | ||
| overlaySettin gsId | long | Overlay Settings | N | This field is not used for import. | ||
| owner | string | Owner | N | Displays the owner of the document. User who assigned the document. |
| Field Name | Field Type | Matching UI Field |
Req (Y/N) |
Description | Acceptable Values | Default Value |
| pageRangeFr om | int | Page Range From | N | Enables the user to define the range of pages within the document to be used. | ||
| pageRangeTo | int | Page Range To | N | Enables the user to define the range of pages within the document to be used. | ||
| parentId | long | Y | id of parent element. | See example in Explanation for parentId Field on page 748. | ||
| plannedPage Count | int |
Planned Number of Pages |
N | For placeholders, enables the user to plan for a specific number of pages. | ||
| refreshDate | date |
Last Repository Retrieval Date |
N | The date of the last DMS sync execution. |
Date is in Unix Timestamp date format. |
Default value is Creation date. |
| renditionModif ierTypeId | long | Rendition Identifier | N | The rendition identifier to use for this document. |
Rendition Identifier Name value from Data Administratio n > Rendition Identifier Values |
Default value is "Standard Rendition" |
| reviewStatus | string | N | This field is not used for import. |
| Field Name | Field Type | Matching UI Field |
Req (Y/N) |
Description | Acceptable Values | Default Value |
| srcContentTy pe | string | Content Type | N | Displays the content type of the assigned document. | ||
| srcDisplayAss ignmentStatu s | string | N | This field is not used for import. | |||
| srcDisplayBo undVersion | string | N | This field is not used for import. | |||
| srcHasRenditi onslFlag | string | N | This field is not used for import. | |||
| srcLocation | string | Source Location | N | The location of the physical file within DMS. |
Example: //root/ folder |
|
| srcName | string |
Source Document |
N | The name of the physical file including extension within DMS. |
Example: SomeFile.p df |
|
| srcPageCount | int | N | This field is not used for import. | |||
| srcReviewSta tus | string | Review Status | N | The review status of the document. | ||
| srcTitle | string | Title | N | The title of the document/ placeholder. |
ContentOutputChannel
Class com::liquent::insight::manager::publisher::data::outputchannels::ContentOutputC Name:
| Field Name | Field Type | Matching UI Field |
Req (Y/N) |
Description | Acceptable Values | Default Value |
| statusTypeId | long | Assignment Status | N | Status of assigned document. |
— BOUND — MISSING — MISSING_ CONTENT — MISSING_ VERSION — SUPERCED ED — UNASSIGN ED |
UNASSIGNED |
| supersededFl ag | string | N | This field is not used for import. | |||
| titleRef | string | N | This field is not used for import. | |||
| transApplicati onId | long | N | This field is not used for import. | |||
| typeCode | string | N | This field is not used for import. |
The fixed value for Document is "DOCUMENT" |
Note: The ContentOutputChannel is a specific class that is related to the "Output Channel" UI multiselect field of the Document UI element. Therefore, you need to declare as many ContentOutputChannel classes in Assembly XML for each Document class as you need to select the "OutputChannel" values for the corresponding Document class.
For example, if you want to select ELEC and PAPER for the current Document class, then you need to create two
ContentOutputChannel classes. One for ELEC (the outputChannelTypeId field value is ELEC), one for PAPER (the outputChannelTypeId field value is PAPER), and associate both to the current Document class (value of the documentId field is value of id field of this Document class).
| Field Name | Field Type |
Matching UI Field |
Req (Y/N ) |
Description | Acceptable Values | Default Value |
| id | long | Y |
Unique ContentOutputChannel ID represented by numerical value. This value will be used to populate corresponding fields in child classes. This ID will be replaced by the database ID in the imported assembly. |
|||
| outputChannelTypeId | long | Output Channel | Y | Defines if the document should be included in the paper or electronic (or both) output channels. |
— ELEC — PAPER |
|
| documentId | long | Y | Value of the ID field of a Document class that the ContentOutputChannel belong to. | |||
| changeReasonComment | string | N | This field is not used for import. | |||
| changeReasonTypeId | long | N | This field is not used for import. |