Applications Administration Guide > Correspondence >

Configuring the Document Server

After finishing the installation steps, perform the following steps to configure the Document Server:

NOTE:  Whenever the Siebel application server is restarted, the Document Server must also be restarted after the Siebel application server has been brought up.

Enabling the Component Group

If you have not already done so during installation, you must enable the component group named Siebel eDocuments. This group contains the DocServer component, which generates Correspondence, Presentations, and Proposals. For more information about enabling this group, see Siebel Server Administration Guide.

Setting MaxTasks to 1

Due to design limitations, third-party applications can only process one document at a time. This means that each instance of the Siebel Document Server should only process one task at a time.

To set the MaxTasks parameter to 1

NOTE:  If MaxTasks is greater than 1, then an error message is sent to the log file as an alert. Processing of the request continues, but results are unpredictable when two requests arrive at the same time.

Setting Honor MaxTasks

Honor MaxTasks is a Siebel Application Object Manager parameter that affects the queuing process and the performance of Document Server. Refer to Table 22.

Table 22.  Honor MaxTasks Parameter for the Document Server
Setting
Behavior
TRUE 1
All requests to Document Servers queue on the SRM_REQUEST table; requests are not assigned to a Document Server until one is free to take the request.
FALSE
Requests are queued on the DocServer component's internal queue. If the Document Server stops processing (for example, crashes) all queued processes on that server are lost.

1This is the recommended value.

To set the Honor MaxTasks parameter

Synchronizing Components

This step is not specific to the Document Server, but is a required post-installation step for the server infrastructure. For information about synchronizing components, see Siebel Server Administration Guide.

Configuring Report Generation (Optional)

f you plan to include Report sections in Proposals, you must specify the Actuate connect string. Set this parameter on each object manager that will be submitting document requests. The value of the parameter will be included in the request sent by the object manager to the DocServer. When DocServer begins processing the request, it will use the parameter to connect back to the object manager to retrieve data for the report.

To specify the Actuate connect string

  1. Start the Server Manager.
  2. Change the server parameter ActuateConnStr to contain the following information:

    siebel.tcpip://gatewayserver:port/enterpriseserver/objectmgr/siebelserver

For example, if \\gtwy is the gateway server host, Sieb01 is the Siebel Server, siebel is the Enterprise Server, and you want to run your proposal with report section on callcenter, whose object manager is SCCObjMgr, you should enter the following command:

srvrmgr> change param ActuateConnStr=siebel.tcpip://gtwy/siebel/SCCObjMgr/Sieb01 for comp SCCObjMgr

The parameter ProposalReportTimeoutInSecond also affects the generation of reports. This is the time-out setting that controls how long the Document Server component will wait for a report to be generated. The default value is 1800 seconds.

Enabling HTML Generation (Optional)

By default, correspondence is only saved in document format, not in HTML format. The user's View HTML button is unavailable, and the user cannot view the correspondence in HTML format.

The server parameter DocumentServerViewHTML specifies whether the Document Server generates HTML versions of documents. The default value is FALSE. By default, the Document Server only generates documents in their native format, and not in HTML. To allow the user to display correspondence in HTML format, you must edit the parameter DocumentServerViewHTML to give it the value True instead of False. Any documents generated after the parameter is enabled is saved in both formats.

When you generate HTML documents, a copy of the generated document is created in HTML and stored in the Siebel File System. This may affect performance, and it will increase the storage space required in the File System. The clarity of the HTML document depends on your Office application's ability to translate its native format into HTML.

Entering the following command allows generation of HTML versions of Correspondence, Proposals, and Presentations.

To enable generation of HTML versions of documents

  1. Start the Server Manager.
  2. Enter the command:

    Srvrmgr> change param DocumentServerViewHTML=True for comp DocServer

NOTE:  While this procedure uses the Server Manager, parameters can also be changed using the Server Administration interface. For more information, see the Siebel Server Administration Guide.

Configuring Application Recycle Period (Optional)

You use the parameter MSWordLiveCount to control how often the office applications are restarted.

Each parameter can be set to a positive integer that specifies the number of documents to be processed before it shuts down and restarts the corresponding office application. A value of 0 (the default) indicates that the applications will not be shut down. If the parameter value is set to any integer other than 0 and the Document Server fails to launch, the corresponding application will be shut down and then restarted again.

To change the values of these parameters

  1. Start the Server Manager.
  2. To change the application recycling period for Microsoft Word, which is used by Correspondence and Proposals, enter the command:

    Srvrmgr> change param MSWordLiveCount=5 for comp DocServer

  3. To change the application recycling period for Microsoft PowerPoint, which is used by Presentations, enter the command:

    Srvrmgr> change param MSPPLiveCount=5 for comp DocServer

Specifying the Target Server (Optional)

If you are running multiple Document Servers within the same enterprise, then the server infrastructure will route document requests to different Document Servers in order to achieve load balancing.

However, it sometimes may be useful to specify that all requests be routed to one Document Server. For example, you can do this to help diagnose a server problem.

To route all requests to one document server

  1. Start the Server Manager.
  2. Enter the command:

    srvrmgr> change param DocumentServerName=DocSrvr1

Enabling Additional Logging (Optional)

Optionally, you may want to enable additional logging, which can be helpful for debugging.

The event logging system writes events to the log file based on the log level for each event type. The number you specify indicates the filtering level for logging. The default value is 3, which means that events with a level of 1, 2, or 3 will be logged, while events with a level of 4 or 5 will be suppressed. Setting the filtering level to 5 means that all events will be logged.

NOTE:  In the final command on the list, the parameter must be in quotation marks, because it has a space in it. In the other commands, quotation marks are optional and are not included in the list.

To enable additional logging

  1. Start the Server Manager.
  2. Enter the following commands:

    srvrmgr> change evtloglvl GenericLog=5 for comp Docserver

    srvrmgr> change evtloglvl ProposalDebug=5 for comp Docserver

    srvrmgr> change evtloglvl ProposalDetail=5 for comp Docserver

    srvrmgr> change evtloglvl PresentationDebug=5 for comp Docserver

    srvrmgr> change evtloglvl PresentationDetail=5 for comp DocServer

    srvrmgr> change evtloglvl DocServerDebug=5 for comp DocServer

    srvrmgr> change evtloglvl DocServerDetail=5 for comp DocServer

    srvrmgr> change evtloglvl CorrespDebug=5 for comp DocServer

    srvrmgr> change evtloglvl CorrespDetail=5 for comp DocServer

    srvrmgr> change evtloglvl MSProjectDebug=5 for comp DocServer

    srvrmgr> change evtloglvl "MS ProjectDetail"=5 for comp DocServer

For more information about event logging, see Siebel Server Administration Guide.


 Applications Administration Guide
 Published: 09 September 2004