Best Practices (6/6): Administration of the Export Service
In this Blog Post, we will discuss the recommended server settings – configuration parameters and Connection Templates, which are used for the Booklet generation. We will also describe the tasks that have to be performed if you update the export solution.
Export Templates are centrally stored in folder C:\OPENBI\export_resources – see parameter RESOURCE_DIRECTORY below.
The Export Traces (export logs and export temp files) are centrally stored in folder C:\OPENBI\export_temp – see parameter TEMP_DIRECTORY below.
If you are using Load Balancing (recommended in export scenarios with heavy load), you should always keep the parameters of the different Export Nodes in sync.
We recommend installing separate instances of the Export service for productive usage and development / quality assurance!
If you are combining Online Exports and Booklet Exports, we recommend setting up load balancing as follows. Load Balancing has to be licensed separately.
|9091 / 9092 / 9093||Dedicated Server for Online Exports||C:\OPENBI_DEDICATED|
|9191 / 9192 / 9193||Load Balancing Node for Booklet Exports||C:\OPENBI|
|X091 / X092 / X093||Export Node X for Load Balancing||C:\OPENBI_X|
Create as many Export Nodes X as you need for your scenario. Replace “X” with a number from 1 to 9. For details on how to setup Load Balancing, see section 1.2.5 of the User Manual).
The following general parameters shall be defined for each Export Node via the openbi Configurator:
|SMTP_SERVER||<server name>||Exchange Server, which shall send the export mails|
Directory, in which you upload the Export Templates.
|EXPORT_ENGINE||GECKO||The Export Service uses the GECKO engine by Firefox for document generation.|
|To be maintained only on the Load Balancing Node!
Used to connect the single Export Nodes to the Load Balancer
The following parameters have to be defined to enable tracing:
|EXPORT_TRACE|| ERRORS (Dedicated and Export Nodes)
BASIC (Load Balancer)
Only errors are logged on the Export nodes. The Load Balancer shows all messages, e.g. how exports are routed to the Export nodes. This simplifies the trace analysis.
If bi excellence support requests a trace file, set this parameter to ALL. With this setting, all trace messages are logged and also the Export Temp files are generated.
Only if this parameter is set to “X”, the trace file is stored in the folder specified via TRACE_PATH. The parameter EXPORT_TRACE defines the granularity.
Folder, into which the Export Temp files are stored, in case EXPORT_TRACE is set to ALL.
File, into which the trace log is written, if parameter TRACE is set to X.
The following parameters have to be defined to enable Booklet exports:
The maximum period of time, which the Export Service waits for an http response from the BO server when executing a URL during Booklet export.
If the application needs a long time to load and this parameter iss et too low, the application will not occur in the Export document!
Corresponds to 3 seconds.
For performance optimization you should try out lower and higher values for this parameter!
Iterations (single URL calls) of a single Booklet generation are performed one after another. This setting prevents an overload on the BO server!
For performance optimization you should try to raise this parameter to 2 or 3!
Booklet generations are performed one after another. A second Export request is queued.
Connection Templates for Booklet Exports
Connection Templates allow the Export Service to connect to the BO server. You should maintain a connection to the productive BO server on the productive Export Service. On the development / quality assurance Export Service, you can create two Connection Templates for the two BO servers.
If you use load balancing, you have to create the Connection Templates on all Export Nodes in the same way. Only the USERNAME should be different, to assure optimal performance on the BO server. You so not have to create the Connection Templates on the Load Balancing Node.
The parameter CMS_URL must correspond to the URL, which is used to run the Design Studio application in the browser.
For more information, see section 1.2.4 of the User Manual.
Once you update SAP Design Studio, we recommend updating the Export Service and Component versions as well. Also you should update if you need a newly developed function or bugfix.
In all other cases, you should stay with the running version!
How to update the Design Studio Export Component:
How to update the openbi Design Studio Export Plugin:
How to update the OPENBI Server: