Calculated Attribute expressions can be written using the following available functions. Use Cases follow the available functions table.
Note: Publishing functions require the Print Publisher component. Additionally, most publishing functions only return a value if a publication version is selected. For information on selecting a version, refer to the Publication Versions section of the Getting Started documentation here.
|
Function |
Parameters |
Description |
|---|---|---|
|
getInheritedPublicationValue |
('attribute-id') |
Returns the value from the specified description attribute on the currently selected publication. If there is no value at the publication level, the value (if any) is read from the publication group. If this function is applied to a product (i.e., within a calculated attribute valid for the product object), values placed on the section level are ignored when resolved on the product. Section-level values are returned if used to mount publication template 'furniture' in AutoPage and Flatplanner. |
|
getInheritedPublicationHierarchyValue |
('attribute-id') |
Similar to the GetInheritedPublicationValue() function, with the additional capability of reading a description attribute value that is placed on either the section, publication, or publication group. |
|
getPublication |
() |
Returns information from the publication if the current object is a page or section. If the function is not being used on a page or section (e.g., if it is used on a product object), the information will be pulled from the publication associated with the current publication version. |
|
getPublicationVersionID |
() |
Returns the ID of the current publication version. |
|
getPublicationVersionName |
() |
Returns the name of the current publication version. |
|
pagenumbers |
() |
Returns a list of page numbers where the currently selected product is included in the current publication version. |
|
sectionFirstPageNumber |
() |
Obtains the first page number of the DTP document corresponding to the publication section. This function retrieves a number only and does not check if there are any products on that page. May be used for building a section table of contents. |
|
sectionLastPageNumber |
() |
Obtains the last page number of the DTP document corresponding to the section. This function retrieves a number only and does not check if there are any products on that page. May be used for building a section table of contents. |
Use Cases
Refer to the Publishing Examples topic in the Calculated Attributes documentation here for sample formulas and scenarios.