To create a custom template: 

  1. Open MS Office Word, create a .docx document.
  2. Design your template – add a header, footer, styles, table of context, chapters, etc.
  3. List all the parameters which you want to output in you report with appropriate tags.  
  4. Create tables, if you need them
    1. Table sizes, number of columns, column names – all these you could put in the template with usual MS Word tools.
    2. If you are about to use repetitions, make sure that each loop begins with [i] and ends with [i+1], e.g. {d.damages[i].damageType} and {d.damages[i+1].damageType}.
  5. If you need to export an image or set of images:
    1.  Use a placeholder image in the template, i.e., just put any image having desired sizes and placed in a required way.
    2. Add an ALT text (picture below) with a proper tag to this image (it’s a standard option for image in MS Word available on the mouse right click on the image area), e.g. {d.inspection.asset.overviewImage}. 
  6. You may insert links to the inspection or related asset by using tags, namely {d.inspection.link} and {d.inspection.asset.link}. 
  7. It could be useful to check the Carbone Style Guide to ensure that you avoid common report template configuration mistakes.
  8. Upload your document while report generation or as organization-wide report template.

 

Note: At the moment only Microsoft Word files are supported as custom template files.