Calyx RIM Administration

PublishingSettings

Class Name:
com::liquent::insight::manager::publisher::data::publishsettings::PublishingSettings
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
id long Y Unique PublishingSettings ID represented by numerical value. Field is used to link classes within Assembly XML. Example:

370516

printerTypeId long Printer Y The Printer that will be used for a Paper Publish. Values from the database:
  • CODE column from ODS.PRINTER_TYPE table
By default STANDARDPDF
mediaParameterTypeId long Paper Size/Type Y The Type and Size of the paper that will be printed on (Example: Blue Letter), available options controlled by which printer is selected. Values from the database:

SELECT mpt.code FROM ods.printer_type pt, ods.valid_printer_media_type valid, ods.media_parameter_type mpt WHERE valid.printer_type_id = pt.id AND mpt.id = valid.media_parameter_type_id AND mpt.tabs_per_set IS NULL AND pt.code = <CODE>;

Where <CODE> is value of ODS.PRINTER_TYPE.CODE (field value of printerTypeId).

Example:
  • L-1
  • A4-1
tabPaperSizeId long Tab Paper Size/Type Y The Type and Size of the paper that will be used for the Tab when printed (Example: Blue Letter). Available options are controlled by the printer that is selected. Values from the database:

SELECT mpt.code FROM ods.printer_type pt, ods.valid_printer_media_type valid, ods.media_parameter_type mpt WHERE valid.printer_type_id = pt.id AND mpt.id = valid.media_parameter_type_id AND mpt.tabs_per_set IS NOT NULL AND pt.code = <CODE>;

Where <CODE> is value of ODS.PRINTER_TYPE.CODE (field value of printerTypeId).

previewLocationPath string Preview Location N The location used to store any generated previews (Volumes, Tabs). Example:

//root/folder

inProcessRenditionLocationPath string In-Process Rendition Location N The location used to store the in-process rendition used when creating in-process links in Calyx RIM. Example:

//root/folder

tocDestinationNotFoundText string TOC Destination Not Found Text N The text that appears in TOCs when a TOC Entry cannot be resolved at publishing time. 
Destination Not Found Text
is used in the following places:
  • If the target does not exist then value of tocDestinationNotFoundText field is used in the right columns of a TOC
  • This attribute is left blank by default, but text may be entered to assist in the QC of invalid destinations or variables.
marginXrefDestinationNotFoundText string Cross Reference Destination Not Found Text N The text to insert when Calyx RIM attempts to insert a margin cross-reference but cannot resolve the variable. If blank, no margin cross-reference is created for links that cannot be resolved.
publishingSettingsLibraryId long Publishing Settings Library Y Value of the ID field of the PublishingSettingsLibrary class. Example:

370515

printerAndPaperSizeId long Y Value of the ID field of the ValidPrinterMedia class.
expandBookmarksToLevel long Expand Bookmarks to Level N This field enables users to specify the number of levels to which bookmarks are expanded on the initial opening of electronic (PDF) files published from Calyx RIM. Users can choose to expand bookmarks from 1 to 20 levels, or expand ALL bookmarks, when the published PDF files are opened. The expansion of bookmarks applies to all Publish to eCTD / Electronic options, except XML only. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20 0 - it means ALL bookmarks
pdfVersion string PDF Version for Published Output N The field enables users to select the PDF version for the published output.
Select one of the following items:
  • 1.3, Acrobat 4
  • 1.4, Acrobat 5
  • 1.5, Acrobat 6
  • 1.6, Acrobat 7
  • 1.7, Acrobat 8
  • 1.3
  • 1.4
  • 1.5
  • 1.6
  • 1.7
1.4
defaultRenditionIdentifier long N The default Rendition Identifier. Rendition Identifier value from Data Administration > Rendition Identifier Values

Example: Standard Rendition

Standard Rendition
useStandardRenditionFlag string Missing Rendition Identifier Handling N Defines how to handle situations when the PDF with the defined Rendition Identifier is not available.
  • Y
  • N
Y
optimizeFonts string Optimize Font in Paper Output N Minimize the font compatibility issues and provide stability to the process of printing the paper output.
  • Y
  • N
Y
allTabsPreviewLocationPath string N This field is not used for import.