Create Report: Snapshotter

Functionality

The Snapshotter is used to create exports of the screen you’ve been working on in different formats like PDF, MS Word, MS Powerpoint and screenshot.

Further explained here B10.3 Create Report (boardmanual.com)

How to Configure It

The config file is already configured but might need some adjustments based on your instance.

Path of the config file: C:\Program Files (x86)\Board\Board WebApi Server\App_Data\config\snapshotter.config

In the config you’ll find following settings:

<add key="host" value="http://localhost:8011/" />

It's the snapshotter process host address. Change the IP port if needed

<add key="applicationUrl" value="http://localhost/" />

As configured on your site bindings, for example: https://yourhostname.board.com/

If the web application port has been changed, you need to specify the port here in the applicationUrl definition

<add key="maxPoolSize" value="5" />

<add key="minPoolSize" value="1" />

Here is the number of Web Clients(Browsers) that can simultaneously generates reports

<add key="resolution" value="Standard" />

Resolution/ image quality of the export

<add key="workingFolderPath" value="..\reporting\" />

The temporary folder path where screenshots are saved while generating the report

<add key="logLevel" value="Error"/>

The level of the logging. Can be Error, Verbose, Debug

<add key="logPath" value="..\log\Snapshotter\{Date}.log" />

The path where the log files are saved

<add key="cefLogPath" value="..\log\Snapshotter\cef.log" />

The path where the cef log files are saved

Example config file:

<snapshotterConfiguration>
<add key="host" value="http://localhost:8011/" />
  <add key="maxPoolSize" value="3" />
  <add key="resolution" value="Standard" />
  <add key="workingFolderPath" value="..\reporting\" />
  <add key="logLevel" value="Error"/>
  <add key="logPath" value="..\log\Snapshotter\{Date}.log" />
  <add key="cefLogPath" value="..\log\Snapshotter\cef.log" />
</snapshotterConfiguration>

IIS Installation

To run the Snapshotter under IIS, make sure of the following two settings:The parameter Load User

  1. Profile is set to True in the Advanced Settings of the Application Pool: