Assembly
Assembly XML Structure
The Assembly XML has the following structure:
<?xml version="1.0"?>
<insightExport version="5.1" product="Insight Manager" name="root tag name ">
<class name="class name">
<field name="field name" type="field type">field value</field>
| Class Name |
Req (Y/ N) |
Description |
| com::liquent::insight::manager::content::dto::Assembly | Y |
See Assembly topic |
| com::liquent::insight::manager::content::dto::Folder | N | See Folder topic |
| com::liquent::insight::manager::content::dto::Leaf | N | See Leaf topic |
</class>
</insightExport>
Where the XML attributes represent the following:
— root tag name – Arbitrary text. This does not take part in assembly import, and can be left blank.
— class name – The name of the class corresponding to the node of Assembly hierarchy.
— field name – The name of the field being imported.
— field type – The type of field being imported.
— field value – The value of the field being imported.
For convenience, the AssemblyImport.xsd file is provided to enable you to validate Assembly XML created manually or programmatically using third-party tools. Validation should be done according to the instructions or guidelines of the third-party tool being used.
Assembly XML Classes
| Class Name |
Req (Y/ N) |
Description |
| com::liquent::insight::manager::content::dto::Document | N |
See Document topic |
| com::liquent::insight::manager::content::dto::PublisherMetaData | N |
See Metadata topic |
| com::liquent::insight::manager::content::documents::DocRef | N | This class is not used for import. |
| com::liquent::insight::manager::publisher::data::Volume | Y |
See Volume Settings topic |
| com::liquent::insight::manager::publisher::data::Variable | N |
See Variable topic |
| com::liquent::insight::manager::publisher::data::Extract | N | This class is not used for import. |
| com::liquent::insight::manager::publisher::data::SettingsProfile | Y |
See Link Profiles topic |
| com::liquent::insight::manager::publisher::data::PageMarker | N |
See Page Marker topi |
| com::liquent::insight::manager::publisher::data::paper::ValidPrinterMedia | N | This class is not used for import. |
| com::liquent::insight::manager::publisher::data::publishsettings::SlipSetting | N |
See Slip Sheet Settings |
| com::liquent::insight::manager::publisher::data::publishsettings::TabSetting | N |
See Tab Settings |
| com::liquent::insight::manager::publisher::data::publishsettings::PubSettingsRefDtd | Y |
See XML Definition |
| com::liquent::insight::manager::publisher::data::publishsettings::PublishingSettings | Y |
See Publishing Settings |
| Class Name |
Req (Y/ N) |
Description |
| com::liquent::insight::manager::publisher::data::publishsettings::CoverPageSetting | N |
See Cover Page Settings |
| com::liquent::insight::manager::publisher::data::publishsettings::PubSettingPdfProperty | N |
See PDF Property Settings |
| com::liquent::insight::manager::publisher::data::publishsettings::CoverSettingOutputChannel | N |
See Output Channel fo Cover Page Settings |
| com::liquent::insight::manager::publisher::data::publishsettings::PublishingSettingsLibrary | Y |
See Publishing Settings Library |
| com::liquent::insight::manager::publisher::data::publishsettings::DefaultPublishingValues | N |
See Default Values |
| com::liquent::insight::manager::publisher::data::specialsheets::Tab | N | See Tab |
| com::liquent::insight::manager::publisher::data::specialsheets::Slip | N | SeeSlip |
| com::liquent::insight::manager::publisher::data::specialsheets::TOC | N |
See Table Of Content (TOC) |
| com::liquent::insight::manager::publisher::data::specialsheets::Cover | N | See Cover |
| com::liquent::insight::manager::publisher::data::specialsheets::TOCEntryGenOption | N |
See Tree Elements t Include in TOC |
| com::liquent::insight::manager::publisher::data::specialsheets::TocType | N |
See TOC Settings |
| com::liquent::insight::manager::publisher::data::outputchannels::VariableOutputChannel | N |
See Output Channel fo Variable |
| com::liquent::insight::manager::publisher::data::outputchannels::SpecialSheetOutputChannel | N |
See Output Channel fo Tab |
Assembly
Class Name: com::liquent::insight::manager::content::dto::Assembly
| Class Name |
Req (Y/ N) |
Description |
| com::liquent::insight::manager::publisher::data::outputchannels::TOCTypeOutputChannel | N |
See Output Channel fo TOC Settings |
| com::liquent::insight::manager::publisher::data::outputchannels::ContentOutputChannel | N |
See Output Channel fo Document |
| com::liquent::insight::manager::publisher::data::metadata::MetaDataLibrary | N |
See Metadata Library |
| com::liquent::insight::manager::publisher::data::overlays::Overlay | N |
See Overlay Settings |
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.
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 | N | This field is not used for import. |
Automatically populated value is the Name of Assembly. |
||
| absoluteChild SeqNo | 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. |
| Field Name | Field Type | Matching UI Field |
Req (Y/N) |
Description | Acceptable Values | Default Value |
| assemblySub missionType | string | Y | Defines the output type of the Assembly. |
— eCTD — US eCTD — CN eCTD — Standard |
||
| assemblyTyp eId | long | Assembly Type | Y |
Internal codes that correspond to the assemblySub missionType field: — eCTD = ECTD — US eCTD = US — CN eCTD = CN — Standard = STANDAR D |
— ECTD — US — CN — STANDAR D |
|
| autoCreateLe afFlag | string | Create Leaf Elements | N |
Determines if Leaf elements are created when dragging files onto folders. |
— Y — N |
Y |
| Field Name | Field Type | Matching UI Field |
Req (Y/N) |
Description | Acceptable Values | Default Value |
| autoPopulate OutputFlag | 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 assignmen t have Output Folder attribute set to the name of VDoc/ Folder that was used to create them. |
— Y — N |
N |
| Field Name | Field Type | Matching UI Field |
Req (Y/N) |
Description | Acceptable Values | Default Value |
| auxiliaryOutp utLocation | 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_la bel=CURR ENT; — status=(In Draft|In Review| Approved| In Approval); — version_nu mber=[stri ng that represent version number] |
Example: version_la bel=CURREN T; status=App roved; version_nu mber=1.0; |
version_label =CURRENT |
| Field Name | Field Type | Matching UI Field |
Req (Y/N) |
Description | Acceptable Values | Default Value |
| category | long | Category | N |
The Assembly high level category. The field value is CODE value of Data Administratio n: Assembly Category. |
Values from the database: ISM.ASSEMB LY_CATEGOR Y_TYPE.COD E |
|
| changeReaso nComment | string | N | This field is not used for import. | |||
| changeReaso nTypeId | 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. | |||
| dctmRefObje ctId | 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”. |
| Field Name | Field Type | Matching UI Field |
Req (Y/N) |
Description | Acceptable Values | Default Value |
| displayBindin gRule | string | N | This field is not used for import. | |||
| displayCopied FromName | string | Created From | N | This field is not used for import. | ||
|
displayStatus Name |
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. |
|
| electronicOut putLocation | string |
Electronic Output Location |
N | Path to the location for the electronic published output to be stored. | Example: // root/ folder | |
| extensionDisp layName | string | N | This field is not used for import. | Fixed value is “Default”. | ||
| extensionTyp e | string | N | This field is not used for import. | Fixed value is “Default”. | ||
| 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 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 correspondin g fields in child classes. This ID will be replaced by the database ID in the imported assembly. |
Example: 5513035 |
||
| internalCopyC hronId | 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. | |||
| latestVersion Flag | string | N | This field is not used for import. | |||
| leafAutoStart WorkflowIds | object | Default Leaf Workflow | N | This field is not used for import. |
| Field Name | Field Type | Matching UI Field |
Req (Y/N) |
Description | Acceptable Values | Default Value |
| 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 |
| majorFolderA utoStartWorkf lowIds | 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. | |||
| numLifecycle dChildren | long | N | This field is not used for import. | |||
| operatedInSe quenceId | 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. |
| Field Name | Field Type | Matching UI Field |
Req (Y/N) |
Description | Acceptable Values | Default Value |
| paperOutputL ocation | 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. | |||
| publishingSet tingsLibraryId | long | Y |
Value of the ID field of the Publishing Settings Library class. |
|||
| referenceLoc ationName | 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: 1169580727 000 |
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: 1169580727 000 |
Default is today's date. |
| statusTypeId | long | Status | N | The field is not used for import. | IN_DRAFT |
| Field Name | Field Type | Matching UI Field |
Req (Y/N) |
Description | Acceptable Values | Default Value |
| subCategory | long | Subcategory | N |
The Assembly low-level category. Available options depend on the Category selected. The field value is CODE value of Data Administratio n: Assembly Subcategory Values. |
Values from the database: ISM.ASSEMB LY_SUBCATE GORY_TYPE. CODE |
|
| 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. | |||
| transAsmTyp e | string | N | The numeric Assembly type code. |
— 1 – Template — 2 – Standalone Assembly — 6 – Sequence Assembly — 11 – Assembly Plan Sequence |
2 | |
| transOperate dSeqId | long | N | This field is not used for import. |
| Field Name | Field Type | Matching UI Field |
Req (Y/N) |
Description | Acceptable Values | Default Value |
| 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. |
||
| versionNumb er | string | N | This field is not used for import. | Automatically populated value is 1.0 |