The Altair Community is migrating to a new platform to provide a better experience for you. In preparation for the migration, the Altair Community is on read-only mode from October 28 - November 6, 2024. Technical support via cases will continue to work as is. For any urgent requests from Students/Faculty members, please submit the form linked here

RM 4.2 Enterprise Report Generation

haddockhaddock Member Posts: 849 Maven
edited November 2018 in Help
I've searched this forum and the main website for documentation on the Report Generation facilities of the 4.2 Enterprise edition, but without success. I can't believe that there is no documentation for features that cost money, so where is it?

Answers

  • haddockhaddock Member Posts: 849 Maven
    Hi folks!

    In the absence of documentation I'm trying to get get to grips with report generation by trial and error, hardly the best way but I need to produce reports, urgently...

    I've got the HTML example going and am interested by some of its output...
    You can even specify simple templates to ensure that the reports will have your corporate design.
    I would really like to have some guidance on how to make such templates, can anybody help?

  • landland RapidMiner Certified Analyst, RapidMiner Certified Expert, Member Posts: 2,531 Unicorn
    Hi,
    all I can say is, that we are working on some kind of handbook. But as you might imagine we've got our hands full. If humans only got six of them. Two additional would help me a lot :)

    Greetings,
      Sebastian
  • IngoRMIngoRM Employee-RapidMiner, RapidMiner Certified Analyst, RapidMiner Certified Expert, Community Manager, RMResearcher, Member, University Professor Posts: 1,751 RM Founder
    Hey there,

    as Sebastian said, we are currently working on a documentation of the Reporting Engine. The examples on the web page are certainly a good starting point for now. Here are some additional hints:

    - for PDF reports, you can specify a background image or PDF file in the report options

    - for HTML reports, you can specify a template file which can make use of the following HTML tags and stylesheet ids / classes: 

    TAGS:
    html
    body
    h1
    h2
    h3
    p
    b
    img
    a

    Stylesheet IDs:

    div rm_content
    div rm_toc
    div rm_logo

    Stylesheet Classes:

    a .rm_content_header
    ul .rm_toc
    li .rm_toc_entry
    table .rm_table
    tr .rm_table
    th .rm_table
    td .rm_table
    Additionally, the macros %{RM_REPORT_TITLE}, %{RM_REPORT_CONTENT}, %{RM_REPORT_TOC}, %{RM_REPORT_LOGO} are supported. At places where these macros are placed, the corresponding content will be added (the report title, the report content, the report table of contents (TOC), and a logo)


    Here is an example for a HTML template: 

    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    <head>
    <title>%{RM_REPORT_TITLE}</title> 
    <style type="text/css">
    	html { font-family: sans-serif; font-size: 11px; line-height: 1.4em; background: #CABCA5; color: #60420A; }
    	body { margin: 0px; }		
    	li.rm_toc_entry a { color: #777777; text-decoration: none; }
    	li.rm_toc_entry a:hover { color: #B6A891; }
    	p { padding-top: 2px; margin-top: 2px; padding-bottom: 2px; margin-bottom: 2px; }
    	h1 { font-size: 24px; font-weight: bold; color: #60420A; padding-top: 36px; }
    	h2 { font-size: 20px; font-weight: bold; color: #60420A; padding-top: 24px;  }
    	h3 { font-size: 16px; font-weight: bold; color: #60420A; padding-top: 18px;  }
    	li.rm_toc_entry { font-size: 8; line-height: 2em; }
    	.rm_content_header { color: #60420A; font-weight: bold; font-size: 11px; padding-top: 16px; }
    	.rm_table { border: 1px solid #60420A; padding: 5px; margin: 0; border-spacing: 0; border-collapse: collapse; }
    	.rm_toc { list-style-type: none; padding-right: 5px; padding-left: 1em; margin-left: 1em; }
    	div#rm_content    { padding: 8px; border: 1px solid #60420A; background: white; }
    	div#rm_toc        { padding: 8px; border: 1px solid #60420A; background: white; }
    	div#rm_logo       { padding: 8px; border: 1px solid #60420A; background: white; margin-bottom: 28px; }
    	div#custom_title  { padding: 15px; border: 1px solid white; background: #60420A; text-align: center; color: white; font-weight: bold; font-size: 18px; }
    </style>
    </head>
    <body> 
    	<table border="0" width="100%" style="width: 100%" cellpadding="10" cellspacing="10">
    	<colgroup>
    		<col width="250px" />
    		<col width="*" />
    	</colgroup> 
    	<tr>
    		<td colspan="2">
    			<div id="custom_title">
    				%{RM_REPORT_TITLE}
    			</div>
    		</td>
    	</tr>		
    	<tr>
    		<td valign="top">
    			<table border="0" cellpadding="0" cellspacing="0">
    			<tr>
    				<td valign="middle" align="center">
    					%{RM_REPORT_LOGO}
    				</td>
    			</tr>
    			<tr>
    				<td>
    					%{RM_REPORT_TOC}
    				</td>
    			</tr>
    			</table>
    		</td>
    		<td valign="top">
    			%{RM_REPORT_CONTENT}
    		</td>
    	</tr>
    	</table> 
    </body>
    </html>
    Cheers,
    Ingo
  • haddockhaddock Member Posts: 849 Maven
    Bonsoir Ingo,

    You are a Saint, many many thanks. I was amusing myself with document manipulation via Javascript, slipped in via the TextReporter operator, and am happy to stop!
  • IngoRMIngoRM Employee-RapidMiner, RapidMiner Certified Analyst, RapidMiner Certified Expert, Community Manager, RMResearcher, Member, University Professor Posts: 1,751 RM Founder
    Hi,

    Just as a follow-up: I just noticed that there were some small copy and paste errors in the sample template (as you probably noticed yourself). I edited the sample code above and it shows now a correct example.

    Cheers,
    Ingo
Sign In or Register to comment.