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. 

Pre-requisites


Step-by-Step Instruction

Click on Templates in the Menu

To create the report template, click the ADD NEW TEMPLATE button.



1. Enter the name of the report template in the Template Name field.

2. Select the required report template format from the Select Format dropdown. The available option is PDF.

3. Select the Page Size If the report template type is “PDF”, you can configure the report paper size with the following options

Set the Paper or sheet size example A3, A4, Letter, Legal and Tabloid.

4. Choose Page orientation (portrait or landscape)

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

6. Select the Introduction Page checkbox to add an introduction page to the beginning of the report. By default, the Introduction page is set for the scheduled report.

7. Click NEXT.


If the Introduction Page option is enabled then the list of pages on your report template is as follows:

  • Introduction Page
  • Report Page

You can set placeholder items to the pages. The items with the parameter will be replaced with the corresponding values during report generation.


Introduction Page



Introduction page has three section: 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 items like Pagination(Dynamic), Time Window(Dynamic), Report Title(Dynamic), and Image(Logo) to your desired position. 

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

  • You can change the background color of the Header/Footer. 
    1. To choose a background color for the header/footer section. Click the Color bar.
    2. Pick the color scheme you want to apply.
  • Apply layout to all pages - Report template items present in the header or footer of the Introduction page will appear on the Report page.
  • Properties - You can set report template items to the report with the help of the following properties. Note: Items with dynamic are parameters. The items will be replaced by the value during report generation.
    1. Text - You can add text to your page with the Text item.
      • Click and drag the Text item 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(Logo) - You can add logo to the page with the Image(Logo) item
      • Click and drag the Image(Logo) item to the desired position in header/footer 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.
    3.  Image(Background-image) - You can add background image to the Introduction page with the Image(Background-image) item
      • 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.
    4. 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
    5. 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.
    6. 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.
    7. 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 Introduction 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 button.


Report Page


If the Apply layout to all pages options is not enabled, click the NEXT button to customize the Report page Header/Footer section with the report template items.

 

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.

To save the report template click the SAVE button.

Note: Image(Background-image) object is not available for the report page


1. To reset to the default objects click the RESET button.


2. Click OK to confirm the reset of the report template items in the page


3. The page is reset. You can drag and drop the needed report template items and then click the SAVE button.




Next Steps