This is the documentation for Clover Club 12.0.
Documentation for the upcoming version Rampur 13.0 can be found here.

Set Up Publishing Templates

Owned by Jan Panoušek
Jun 14, 2024
2 min read

In Configuration in Publishing Templates you can configure publishing either documents or logics.

Document Publishing Templates

To set up a template:

  1. Select one of the supported objects for which to define a template. 
     For each object, you can define multiple templates. When you click the Export Excel, Export Word or Export PDF button and if there is more than one template for the object, you will be prompted to select the template that you want to use.

  2. Click the Add button above the table to create a template entry. 

  3. Provide a name for the template and set those options which are configurable:

    1. Default – Indicates the template, which will be used if no template is specified for export (this can happen if you use the executeformula command). Even though you can select multiple default templates, selecting only one for each format makes sense.

    2. Convertible to PDF – Marks the template as suitable for PDF export and makes it available in the PDF export template dropdown menu.

    3. Preprocessing Logic – Calculation logic that prepares data for the template.

    4. To Sign – Available for Quotes, Rebate Agreements, Agreements/Promotions and Compensation Plans. Marks the template as intended for export to an e-signature system.

  4. Click the Upload Template button and provide your Excel/Word file.

For guidance with the next step see:

On the server, it is possible to select which export format can be used for a specific publishing template, so that users can download only PDF documents (and not DOCX/XLSX documents). To set it up, use the attribute isConvertibleToInputType. When you set its value to true for an individual publishing template, it means that this template allows you to export to PDF, as well as to the original input type (i.e., DOCX or XLSX).

Logic Publishing Templates

You can define your own Excel template and use it for exporting a logic when its output format is XLSX. The logic results are then generated into a copy of the template. Without a template, the logic would be produced into a plain empty XLSX file.

Simple results are in the main data sheet as name/value; more complex results (e.g., list of maps or resultMatrix) are in their own sheet.

See also How to Generate Excel Reports from Calculation Logic.

Requirements for Publishing Templates

  • The uploaded Excel files must be in the XLSX or XLSM format, Word files in the DOCX format.

  • The version required to open and create XLSX or XLSM file type is Excel 2007 (or later).

  • The maximum file size is 10 MB.

  • Excel templates can have as many tabs as needed.

  • Excel templates can (and likely will) contain some macros. Templates that should be convertible to PDF cannot contain macros.

  • It is advisable to store a backup of the default template versions.

  • The publishing template name must not have more than 1000 characters.

 If your Excel template file size is larger than the allowed 10 MB, try removing "blank spaces" from the spreadsheet.