Introduction

Report template helps to add dynamic content to the scheduled report. You can create a custom template with logos, text, background image and more.

Report template has prearranged placeholders. The placeholders give you an idea of what your report might look like. 

Note: For Skedler v3.12 and below refer How to create report template

Pre-requisites

• A successful configuration of Skedler settings. Refer How to configure email settings, timezone settings and default logo for reports

Step-by-Step Instruction

Click on Report Templates in the main menu, to navigate to the template creating page. By default a “Default Template” is available. Click Create New Template button to create custom templates.

Select the appropriate option listed below for creating the templates.

1. Click the pencil icon to enter the name of the report template.

2. Choose Orientation (portrait or landscape)

3. Select the Page Size you can configure the report paper size with the following options - A3, A4, Letter, or Legal.

4. Select the Font Family you can select the type of font in which the report needs to be generated.

5. Select the template from the Template drop-down to customize the new report template.

6. The report template has two list of pages Cover Page and a Report Page. You can set placeholder elements to the pages. The elements with the parameter will be replaced with the corresponding values during report generation.

Cover Page

Cover page has three sections: Header, Main, and Footer

Here are some tips for working with the custom tools for Introduction page:

• Header and Footer - The Header is a section that appears in the top margin, while the Footer is a section that appears in the bottom margin. Headers and footers generally contain additional information such as page numbers, date, report title, and logo.
  

• You can set the information by dragging the report template elements like Text(Dynamic), Image, Data & Time(Dynamic), Time Window(Dynamic), Report Title(Dynamic) and Pagination(Dynamic) to your desired position. 

  Note: If Header and Footer sections are enabled it's common across all the pages (Cover and Report page).

• You can change the background color of the Cover page Header/Footer. To choose a background color for the header/footer section. Click the Color bar and choose the color scheme you want to apply.

• 

• Apply layout to all pages - Report template elements present in the header or footer of the Cover page will appear on the Report page.

• Properties - You can set report template elements to the report with the help of the following properties.

Note: Elements with dynamic are parameters. The elements will be replaced by the value during report generation.

1. Text - You can add text to your page with the Text elements.
   • Click and drag the Text element to the desired position in header/main/footer section
   • Double-click the item. Type your text in the text area. 
   • To format the text, 
     • Select the text you want to modify       

     • To apply the formatting, click one or more of the formatting buttons on the Mini-Toolbar: Font Size, Underline, Strikethrough, Bulleted list, Alignment or Font Color.  

   • Click the save icon.
   • To delete, the object on the object hover click the delete icon.
   • To edit, double click the object perform the necessary changes and then click the Save button
   • To increase or decrease the size in one or more directions, You’ll see a box around the object with dots along the edges and in the corners, click, hold down the mouse button and drag a sizing handle inwards to shrink or outward to enlarge.
   • Note: Delete, Edit, Format or Resize options of the report template item(Text) is similar to following subsequent items.
2.  Image - You can add  image to the Introduction page with the Image element
   • Click and drag the Image(Logo) item to the Main section.
   • Double-click the item.
   • Click the Picture icon. 
   • Choose the image that you want to set as the logo and then click the Insert Image button and click the save icon.
   • To increase or decrease the size in one or more directions, You’ll see a box around the object with dots along the edges and in the corners, click, hold down the mouse button and drag a sizing handle inwards to shrink or outward to enlarge. Click the SAVE button.
3. Date & Time(Dynamic) - You can add the current Date and Time to the page with the Date & Time(Dynamic) item. 
   • Click and drag the Date & Time(Dynamic) item to the desired position in header/footer section
   • To save the object click the save icon
4. Time Window(Dynamic) -  You can add the scheduled Time window to the page with the Time Window(Dynamic) item
   • Click and drag the Time Window(Dynamic) item to the desired position in header/footer section
   • To save the object click the save icon.
5. Report Title(Dynamic) - You can add the report title to the page with the Report Title(Dynamic) item
   • Click and drag the Report Title(Dynamic) item to the desired position in header/main/footer section
   • To save the object click the save icon.
     
6. Pagination(Dynamic) - You can add the page numbers to the page with the Pagination(Dynamic) item
   • Click and drag the Pagination(Dynamic) item to the desired position in header/footer section
   • To save the object click the save icon.

When the Apply layout to all pages option is enabled in the Cover page then the report template items present in the Introduction page Header/Footer section will be available on the subsequent Report pages also. 

To save the report template click the Save and Exit button.

To reset the report template click the Reset button.

To save as a new report template click the Save as New Template option

Report Page

If the Apply layout to all pages options is NOT enabled, scroll down, below the Cover page is the Report page, customize the Report page Header/Footer section with the report template elements.

In the report page, the main section is the Dynamic chart area where you can drag and drop the Kibana chart at the time of report creation. Also, you can drag and drop the needed report template elements. 

Note: Image element is not available for the Report page

After customizing the report , you can click the Save and Exit button. To discard the changes and use default template, click the Reset button.

The custom template will now be available in the list under Templates menu

Next Steps

• Download a Report Template
• Schedule a custom report based on Kibana dashboard
• Edit a Report Template