This section describes how an admin user can configure the text and logo that appear in header and footer of the published PDF report. It includes the following sections:
Section 3.1, "Configuring the Logo in the Report Header and Footer"
Section 3.2, "Configuring the Text in the Report Header and Footer"
The report logo should be stored on domain_home on the server and the paths (including the logo name) should be configured using admin APIs.
Images for the logo should be of 0.75” × 0.75" dimension (height*width) so that the logo is not stretched or squeezed.
Use the following API to configure the report logo:
Method | PUT |
API Path | <server url>/ohpm/opmconfigapi/v1.0/config/{configurationName} |
JSON Body |
:{ "Key":"value " } |
Example | host:port/ohpm/opmconfigapi/v1.0/config/PUBLISH_REPORT_HEADER_LOGO1
{ "PUBLISH_REPORT_HEADER_LOGO1":"./DynImages/Footer.jpg " } |
Configuration Key Names for header and footer logo images are:
Header Logo
PUBLISH_REPORT_HEADER_LOGO1
PUBLISH_REPORT_HEADER_LOGO2
Footer Logo
PUBLISH_REPORT_FOOTER_LOGO
Admin user can configure the text in the report header and footer using the same API that is used to configure the logo.
Configuration Names for header and footer text are:
Report Header: Text at top of report header, 3 lines
PUBLISH_REPORT_HEADER_LINE1
PUBLISH_REPORT_HEADER_LINE2
PUBLISH_REPORT_HEADER_LINE3
Report Footer: Text at bottom of report, 2 lines
PUBLISH_REPORT_FOOTER_LINE1
PUBLISH_REPORT_FOOTER_LINE2