Calyx RIM Administration

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
abbreviatedName string Abbreviated Name N The abbreviated name of the Document/Placeholder.
absoluteChildSeqNo 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 absoluteChildSeqNo Fields.
activeFlag string N This field is not used for import.
assemblyId long N This field is not used for import.
assignmentStatus string N This field is not used for import.
bindingRule string Bound Version N The default rule used to bind documents from the DMS to one of the following document properties:
  • version_label=CURRENT
  • status=(In Draft|In Review|Approved|In Approval)
  • version_number=[string that represent version number]
Example:
  • version_label=CURRENT
  • status=Approved
  • version_number=1.0
version_label=CURRENT
category string Category N The category of the document/placeholder.
changeReasonComment string N This field is not used for import.
changeReasonTypeId long N This field is not used for import.
checkOutDate date N This field is not used for import.
checkOutLocationId 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 absoluteChildSeqNo Fields.
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"
displayCopiedFromName string N This field is not used for import.
displayNewerVersionAvailable string N This field is not used for import.
displayReviewStatus string N This field is not used for import.
displayTypeName 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.
extensionDisplayName string N This field is not used for import.
extensionType string N This field is not used for import.
guid string N This field is not used for import.
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 corresponding fields in child classes. This ID will be replaced by the database ID in the imported Document. Example:

5516639

inclInPageNumbersFlag 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
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.
numLifecycledChildren long N This field is not used for import.
operatedInSequenceId long N This field is not used for import.
other string Other N Other information about the document.
overlaySettingsId 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.
pageRangeFrom 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.
plannedPageCount 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.
renditionModifierTypeId long Rendition Identifier N The rendition identifier to use for this document. Rendition Identifier Name value from Data Administration > Rendition Identifier Values Default value is "Standard Rendition"
reviewStatus string N This field is not used for import.
srcContentType string Content Type N Displays the content type of the assigned document.
srcDisplayAssignmentStatus string N This field is not used for import.
srcDisplayBoundVersion string N This field is not used for import.
srcHasRenditionslFlag 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.pdf

srcPageCount int N This field is not used for import.
srcReviewStatus string Review Status N The review status of the document.
srcTitle string Title N The title of the document/placeholder.
statusTypeId long Assignment Status N Status of assigned document.
  • BOUND
  • MISSING
  • MISSING_CONTENT
  • MISSING_VERSION
  • SUPERCEDED
  • UNASSIGNED
UNASSIGNED
supersededFlag string N This field is not used for import.
titleRef string N This field is not used for import.
transApplicationId 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"