Calyx RIM Administration

Calyx RIM System-Defined Variables

Calyx RIM uses system-defined variables to automatically insert data into documents.

The following descriptions are relevant to a number of the variables in this table:
Word/Phrase Description
Division Divisions, like Volumes, function independently from the assembly folder hierarchy.
Major Division A Major Division starts at a folder marked as a Major Division and ends at the next folder marked as a Major Division, regardless of its position in the folder structure.
Minor Division A Minor Division starts at a folder marked as a Minor Division and ends at the next folder marked as a Minor Division or Major Division, regardless of its position in the folder structure.
Publishing time variables Publishing time variables can be stamped only on: cover pages and overlays, published tabs (not preview), TOC right column text, paper cross-reference link text. They cannot be used within other variables.
Paper Publishing time variables Publishing time variables that are available during a paper channel publish only.
Variable Name Variable Code Description Active Flag Constraints
Abbreviated Major Division Name MABBR The Abbreviated Name attribute defined on the folder element in the assembly that has been selected to be a major division. For eCTD, this is an abbreviated form of the eCTD module name (Qual.). For other submission types, this is the Item. Active There must be major division folder assigned somewhere above the ancestor tree, with a non-blank abbreviated name.
Abbreviated Minor Division Name NABBR The Abbreviated Name attribute defined on the folder element in the assembly that has been selected to be a minor division. For eCTD, this is an abbreviated form of the eCTD section name (Drug Prod). For other submission types, this is the section. Active There must be minor division folder assigned somewhere above the ancestor tree, with a non-blank abbreviated name.
Assembly Name ANAME The name of the assembly as defined by the user. Active
Assembly Relative Major Division Number ARM Major divisions number relative to the assembly. Active Publishing time variable. There must be major division folder assigned somewhere above the ancestor tree, with a non-blank number.
Assembly Relative Page ARP Page number in the paper channel relative to the entire assembly. Active Publishing time variable.
Assembly Relative Page ARE Page number in the electronic channel relative to the entire assembly. Active Publishing time variable.
Assembly Relative Volume Number ARV The volume count relative to the current assembly. Active Paper Publishing time variable.

Must be within a defined volume.

Assembly Total Major Divisions ATM Total major divisions in assembly. Active Publishing time variable.
Assembly Total Pages ATP The total number of paper channel pages in the assembly. Active Publishing time variable.
Assembly Total Pages ATE The total number of electronic channel pages in the assembly. Active Publishing time variable.
Blank BL A blank character, used to resolve a variable to a blank. Active
Current Date CD Current date and time. Active Current date {CD} will not work for $DATETIME patterns. Use Current time {CT} to produce equivalent results.
Current Document Version DV Current document version. Active Must be used on a document assigned from a DMS repository (no filesystem).
Current Time CT Current date and time. Active Must be used within the date format function $DATETIME.
Document Name DNAME The Name attribute defined on the document element in the assembly. Active Must be used somewhere under a document that has a defined name.
Document Number DN The Number attribute defined on the document element in the assembly. Active Must be used somewhere under a document that has a defined number.
Document Relative Page DRP Page number in the paper channel relative to the current document (including TOC and cover pages that are included in page numbering). Active Publishing time variable.
Document Relative Page Number DRE Page number in the electronic channel relative to the current document (including TOCs and cover pages that are included in page numbering. Active Publishing time variable.
Document Total Pages DTE The total number of electronic channel pages in the current document. Active Publishing time variable.
Document Total Pages DTP The total number of paper channel pages in the current document. Active Publishing time variable.
Element Abbreviated Name ABBR The current element abbreviated name.

For Volume and Page Marker entities, ABBR resolves to the NAME of the entity.

Active There must be a defined, abbreviated name on the current element. For a TOC or Tab, this resolves to the Abbreviated Name (or NAME) of the entity where the special sheet is attached.
Element Name NAME The current element name. Active There must be a defined name on the current element. For a TOCs or Tab, this resolves to the NAME of the entity where the special sheet is physically located.

Cover Pages resolve to the NAME field attribute on the Cover Page entity. If no value is entered in the NAME field attribute of the Cover Page, this variable is not resolved.

Element Number N The current element number.

Page Markers do not have a Number Attribute.

Active There must be a defined number on the current element. For a TOC or Tab, this resolves to the NUMBER of the entity where the special sheet is attached. N does not resolve on Cover Pages.
Element Title TITLE The current element title.

For Volume, Folder, and Page Marker entities, TITLE resolves to the NAME of the entity.

Active There must be a defined TITLE on the current element

For a Tab, this resolves to the TITLE (or NAME) of the entity where the Tab is attached.

For a TOC, this resolves to the TITLE field on the TOC entity (from the TOC attributes).

The TITLE variable does not resolve for Cover Pages.

File Relative Page Number FR Page number relative to the current assigned file (TOC or cover page); or portion of a document between any special sheet or volume. Does not include any publication elements such as TOC or cover page. Active Publishing time variable.
File Total Pages FT Total number of pages in the current assigned file (TOC or cover page); or portion of a document between any special sheet or volume. Active Publishing time variable.
Leaf Abbreviated Name LABBR The abbreviated name on the current leaf. Active Will work on any element assigned under a leaf.
Leaf Name LNAME The Name attribute defined on the leaf element in the assembly. Active Will work on any element assigned under a leaf.
Leaf Number LN The Number attribute defined on the leaf element in the assembly. Active Will work on any element assigned under a leaf.
Leaf Output File Path LOP Actual output path of the leaf parts may be overridden by user but in general this is calculated; path should be the relative path starting at the publish destination (minus the application and sequence number), for example cover-letter.pdf path would be ./M1/US/ and the path and file name would be ./M1/US/cover-letter.pdf Active Will work on any element assigned under a leaf.
Leaf Output Filename LOF Actual output file of leaf determined by user but also may be calculated at publishing time Active Will work on any element assigned under a leaf.
Leaf Relative Page LR Page number in the electronic channel relative to the current leaf. This variable numbers electronic channel pages only. Active Publishing time variable. Will work on any element assigned under a leaf.
Leaf Total Pages LT Total number of pages contained in the leaf. This variable totals electronic channel pages only. Active Publishing time variable. Will work on any element assigned under a leaf.
Major Division Name MNAME The Name attribute defined on the folder element in the assembly that has been selected to be a major division. For eCTD, this is the eCTD module name (Quality). For other submission types, this is the Item. Active There must be major division folder assigned somewhere above the ancestor tree, with a non-blank name.
Major Division Number MN The Number attribute defined on the folder element in the assembly that has been selected to be a major division. For eCTD, this is the eCTD module number (3). For other submission types, this is the item. Active
Major Division Relative Minor Division MRN The count of the current minor division relative to the current major division. Active Publishing time variable. There must be both a major division folder and a minor division folder assigned somewhere above the ancestor tree.
Major Division Relative Page MRP Page number in paper channel relative to the current major division. Active Publishing time variable. There must be major division folder assigned somewhere above the ancestor tree.
Major Division Relative Page MRE Page number in the electronic channel relative to the current major division. Active Publishing time variable. There must be major division folder assigned somewhere above the ancestor tree.
Major Division Relative Volume Number MRV The current volume number relative to the current major division. Active Paper Publishing time variable. There must be a volume defined, and there must be major division folder assigned somewhere above the ancestor tree.
Major Division Total Minor Divisions MTN The total minor divisions in the current major division. Active Publishing time variable. There must be both a major division folder and a minor division folder assigned somewhere above the ancestor tree.
Major Division Total Pages MTP Total number of paper channel pages contained in the major division. Active Publishing time variable. There must be major division folder assigned somewhere above the ancestor tree.
Major Division Total Pages MTE Total number of electronic pages contained in the major division. Active Publishing time variable. There must be major division folder assigned somewhere above the ancestor tree.
Major Division Total Volumes MTV The total volumes in the current major division. Active Paper Publishing time variable. There must be a volume defined, and there must be major division folder assigned somewhere above the ancestor tree.
Minor Division Name NNAME The Name attribute defined on the folder element in the assembly that has been selected to be a minor division. For eCTD, this is the eCTD section name (Drug Product). For other submission types, this is the section. Active There must be minor division folder assigned somewhere above the ancestor tree, with a non-blank name attribute.
Minor Division Number NN The Number attribute defined on the folder element in the assembly that has been selected to be a minor division. For eCTD, this is the eCTD section (3.2.P). For other submission types, this is the section. Active There must be a major division folder assigned somewhere above the ancestor tree, with a non-blank number attribute.
Minor Division Relative Page NRE Page number in the electronic channel relative to the current minor division. Active Publishing time variable. There must be major division folder assigned somewhere above the ancestor tree.
Minor Division Relative Page NRP Page number in the paper channel relative to the current minor division. Active Publishing time variable. There must be major division folder assigned somewhere above the ancestor tree.
Minor Division Relative Volume Number NRV The current volume number relative to the current minor division. Active Paper Publishing time variable. There must be a volume defined, and there must be minor division folder assigned somewhere above the ancestor tree.
Minor Division Total Pages NTE Total number of electronic channel pages contained in the minor division. Active Publishing time variable. There must be major division folder assigned somewhere above the ancestor tree.
Minor Division Total Pages NTP Total number of paper channel pages contained in the minor division. Active Publishing time variable. There must be major division folder assigned somewhere above the ancestor tree.
Minor Division Total Volumes NTV The total volumes in the current minor division. Active Paper Publishing time variable. There must be a volume defined, and there must be minor division folder assigned somewhere above the ancestor tree.
Referenced Leaf Application Code RLAC For a Reference Leaf, this is the Application Code of the Application containing the referenced leaf. Active
Referenced Leaf Leaf Name RLLNAME For a Reference Leaf, this is the Name attribute defined on the Leaf element of the referenced leaf. Active Will work on any element assigned under a leaf.
Referenced Leaf Major Division Name RLMNAME For a Reference Leaf, this is the Name attribute defined on the Folder element containing the referenced leaf that has been selected to be a major division.  For eCTD, this is the eCTD module name (Quality), for other submission types, this is the Item. Active There must be major division folder assigned somewhere above the ancestor tree, with a non-blank name.
Referenced Leaf Major Division Number RLMN For a Reference Leaf, this is the Number attribute defined on the Folder element containing the referenced leaf that has been selected to be a major division.  For eCTD, this is the eCTD module number (3), for other submission types, this is the Item. Active
Referenced Leaf Minor Division Name RLNNAME For a Reference Leaf, this is the Name attribute defined on the Folder element containing the referenced leaf that has been selected to be a minor division.  For eCTD, this is the eCTD section name (Drug Product), for other submission types, this is the section. Active There must be minor division folder assigned somewhere above the ancestor tree, with a non-blank name attribute.
Referenced Leaf Minor Division Number RLNN For a Reference Leaf, this is the Number attribute defined on the Folder element containing the referenced leaf that has been selected to be a minor division. For eCTD, this is the eCTD section (3.2.P), for other submission types, this is the section. Active There must be major division folder assigned somewhere above the ancestor tree, with a non-blank number attribute.
Referenced Leaf Sequence Number/Code RLSC For a Reference Leaf, this is the Sequence Number/Code of the Sequence containing the referenced leaf. Active
Referenced Leaf Volume Number RLVN For a Reference Leaf, this is the Volume Number found on the Volume element containing the referenced leaf which is set by volumization. Active
Source Filename DFNAME The source file name according to the assigned document. Active Must be under an assigned document.
Space SP A single-space character, used to buffer other values or to resolve a variable to a blank. Inserts a Space into a variable string, which are normally removed from the beginning and end of evaluated variables. Active
Total Volumes ATV The total number of volumes in the assembly. Active Paper Publishing time variable
Volume Name VNAME The name of the current volume. Active Must be in a defined volume.
Volume Number VN Volume number found on volume element which is set by volumization. Active Must be in a defined volume.
Volume Relative Page VR Page number relative to the current volume. This variable numbers paper channel pages only. Active Paper Publishing time variable.
Volume Total Pages VT Total number of pages contained in the volume. This variable totals paper channel pages only. Active Paper Publishing time variable.