Calyx RIM Administration

Assembly

Class Name:
com::liquent::insight::manager::content::dto::Assembly
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.
Note: If a field name contains an automatically populated value, that value will be used in the Assembly. It will overwrite any value that may be defined in the Assembly XML.
Field Name Field Type Matching UI Field Req (Y/N) Description Acceptable Values Default Value
abbreviatedName string N This field is not used for import. Automatically populated value is the Name of Assembly.
absoluteChildSeqNo long N This field is not used for import. Automatically populated value is "1"
activeFlag string N This field is not used for import. Automatically populated value is "Y".
assemblyId long N This field is not used for import. Default value is equal to id field.
assemblySubmissionType string Y Defines the output type of the Assembly.
  • eCTD
  • US eCTD
  • CN eCTD
  • Standard
assemblyTypeId long Assembly Type Y Internal codes that correspond to the assemblySubmissionType field:
  • eCTD = ECTD
  • US eCTD = US
  • CN eCTD = CN
  • Standard = STANDARD
  • ECTD
  • US
  • CN
  • STANDARD
autoCreateLeafFlag string Create Leaf Elements N Determines if Leaf elements are created when dragging files onto folders.
  • Y
  • N
Y
autoPopulateOutputFlag string Auto Populate Output Folder N If “Auto Populate Output Folder” is set to Yes and a folder is created during assignment from DMS:
  • A folder that is created has Output Folder attribute set to the name of VDoc/Folder that was used to create it.
  • All subfolders that were created as a result of the parent VDoc/Fodleer assignment have Output Folder attribute set to the name of VDoc/Folder that was used to create them.
  • Y
  • N
N
auxiliaryOutputLocation string Auxiliary Output Location N Path to the location for the publishing elements to be stored. Example: //root/folder
baselineFlag string N This field is not used for import.
bindingRule string Default Binding Rule 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 long Category N The Assembly high level category. The field value is CODE value of Data Administration: Assembly Category. Values from the database: ISM.ASSEMBLY_CATEGORY_TYPE.CODE
changeReasonComment string N This field is not used for import.
changeReasonTypeId long N This field is not used for import.
childSeqNo long N This field is not used for import. Automatically populated value is “-1”
comments string Comments N Comments to be added to the Assembly.
currencyFlag string N This field is not used for import.
dctmRefObjectId string N This field is not used for import.
depth long N This field is not used for import.
description string Description N Description of the Assembly.
discriminator string N Discriminator. The fixed value for Assembly is “A”.
displayBindingRule string N This field is not used for import.
displayCopiedFromName string Created From N This field is not used for import.
displayStatusName string N This field is not used for import.
dueDate date Due Date N The date the Assembly is due to be complete for submission. Date is in Unix Timestamp date format.
electronicOutputLocation string Electronic Output Location N Path to the location for the electronic published output to be stored. Example: //root/folder
extensionDisplayName string N This field is not used for import. Fixed value is “Default”.
extensionType string N This field is not used for import. Fixed value is “Default”.
guid string N This field is not used for import.
id long Y Unique Assembly 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 assembly. Example: 5513035
internalCopyChronId long N This field is not used for import.
keywords string Keywords N Keywords that apply to the specific Assembly.
lastTemplate string N This field is not used for import.
latestVersionFlag string N This field is not used for import.
leafAutoStartWorkflowIds object Default Leaf Workflow N This field is not used for import.
lockFlag string Lock Indicator N Indicates if the Assembly has been locked or not.
  • U – Unlocked
  • L – Locked
  • E - Locked with an eCTD lock
U
majorFolderAutoStartWorkflowIds object Default Major Division Folder Workflow N This field is not used for import.
modifiedFile string N This field is not used for import.
name string Name Y Assembly Name.
nodeNumber string N This field is not used for import.
numLifecycledChildren long N This field is not used for import.
operatedInSequenceId long N This field is not used for import.
other string N This field is not used for import.
owner string Owner N The owner of the Assembly. The User name of existing User in the system. Default value is User name of User who performs import.
paperOutputLocation string Paper Output Location N Path to the location for the paper published output to be stored. Example: //root/folder
parentId long N This field is not used for import.
publishingSettingsLibraryId long Y Value of the ID field of the Publishing Settings Library class.
referenceLocationName string Reference Location Name N This field is not used for import.
refreshDate date Last Repository Data Retrieval N The date when content was created. Date format - Unix Timestamp. Unix Timestamp date format. Example: 1169580727000 Default is today's date.
refreshFlag string N This field is not used for import.
revision string N This field is not used for import.
statusDate date Status Date N This field is not used for import. Unix Timestamp date format. Example: 1169580727000 Default is today's date.
statusTypeId long Status N The field is not used for import. IN_DRAFT
subCategory long Subcategory N The Assembly low-level category. Available options depend on the Category selected. The field value is CODE value of Data Administration: Assembly Subcategory Values. Values from the database: ISM.ASSEMBLY_SUBCATEGORY_TYPE.CODE
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.
transAsmType string N The numeric Assembly type code.
  • 1 – Template
  • 2 – Standalone Assembly
  • 6 – Sequence Assembly
  • 11 – Assembly Plan Sequence
2
transOperatedSeqId long N This field is not used for import.
type string N This field is not used for import.
uiVersion string Version Number N This field is not used for import.
versionLabel string N This field is not used for import. Automatically populated value is CURRENT.
versionNumber string N This field is not used for import. Automatically populated value is 1.0