1. Home
  2. Docs
  3. How To
  4. Working with XcooBee Templates

Working with XcooBee Templates

In some areas of the XcooBee network you are allowed to bring your own templates. This process allows you to create documents that have the same look and feel that you would generate from your in-house systems or customize the look and feel of documents XcooBee produces on your behalf.

The Base Format

Template documents are based on HTML and thus anyone with basic web skills can create and make changes to them. You can layout text, fonts, and images as you see fit. Within the documents you can use the handlebars markup to replace processing based data. This is similar to a mail merge you do with other programs.

The HTML document template should not contain any scripting or backend code as this will not bee run by the XcooBee template processors.

The Output

The XcooBee Network will convert all templates into PDF documents which then will used to communicate with users.

The Handlebars Markup Elements

Your HTML templates contain replacement fields that will be replaced at run-time with processing data. These fields are normally surrounded by double braces {{ ... }}. For example {{company.displayName}} will be replaced by your organization name when the template is processed. There are also commands like {{#if}}. Please review handlebars documentation for many more options that are possible.

Common Field List

To see a list of common fields please download the example platform template. You have the link in each of the Project It contains all used fields. Not all fields are available for all templates. You should check the example template to see which fields you can place into your own templates.

URL and Image Payload Fields

URL and Image Payload fields are surrounded by three braces {{{ ... }}}. Here are some examples

  • {{{logoUrl}}} -> the URL to your company logo
  • {{{receiptUrl}}} -> the URL to receipt of payment
Was this article helpful to you? Yes No

How can we help?