The New SAP Sourcing and CLM DOCX Generation Service
The New SAP Sourcing & CLM DOCX Generation service
(SAP Sourcing & CLM 7.0 SP5)
As we all know that SAP Sourcing & CLM can use the Microsoft .NET-based WordService to generate structured clause documents, collection variables documents and contract document templates. The Microsoft .NET-based WordService requires setup of an additional Windows server. Due to this overhead and additional TCO SAP Sourcing & CLM now with SAP Sourcing & CLM 7.0 SP5* also supports WordService based on JAVA technology. This new wordservice is called SAP Sourcing DOCX Generation Service. The does not require an additional Windows server.
Customers must enable SAP Sourcing for either the .NET service or the SAP Sourcing DOCX Generation Service, not for both services.
Comparison between .NET service and SAP Sourcing DOCX Generation Service
Microsoft .NET-based WordService
New SAP Sourcing DOCX Generation Service
Requires setup of an additional Windows server
No additional server required
Supports .doc & .docx format
Supports only MS 2007 .docx format
Available in all 7.0 and 9.0 versions
Available from SAP Sourcing & CLM 7.0 SP 5 onwards*
Enabling SAP Sourcing DOCX Generation Service
To use the SAP Sourcing DOCX Generation Service, you must first convert all legacy contract clauses, collection variables documents, and contract document templates to .docx and .dotx formats. Therefore, you must have the .NET WordService enabled in order to convert these document types. After the conversion, disable .NET WordService.
Customers new to SAP Sourcing & CLM, and those who have not yet configured WordService, should set up the SAP Sourcing DOCX Generation Service.
We also recommend that customers with SAP Sourcing & CLM already installed and WordService already configured should update directly to the SAP Sourcing DOCX Generation Service as well. However, these customers may instead update Microsoft .NET WordService to the latest version.
Steps involved for enabling SAP Sourcing DOCX generation service.
a) Take a backup of your whole database
b) Log on as a member of the administrator group. Make sure WordService is enabled. Select Setup->System Properties. Select Contractgen.wordservice.enabled.
If contractgen.wordservice.enabled is not listed, create the property by clicking New, and add it. Then, if the DB Importer is run with the system context, set this property in the system portal. Select Edit. In the Value field, type TRUE, and select Save.
c) Convert .DOC and .DOT files to .DOCX and .DOTX respectively: With new SAP Sourcing DOCX Generation service, CLM supports only .docx and .dotx formats. Convert the legacy .doc and .dot files to .docx and .dotx respectively with the conversion script provided in DB Importer. Find DB Importer on the Sourcing server, in the Sourcing bin subdirectory.
Invoke the DB Importer tool. For Linux servers, invoke dbimport.sh. For Windows servers, invoke dbimport.bat. On the Setup tab, select the fcieso.jar file. Navigate to the com/sap/eso/odp/install/scripts/upgrade directory, and select the convert_doc_to_docx.xml script file. Run the upgrade script, convert_doc_to_docx. This script converts all the existing contract .doc and .dot files to .docx and .dotx respectively.
d) After testing the SAP Sourcing DOCX Generation Service thoroughly, and checking your documents, disable WordService. Select Setup->System Properties. Select Contractgen.wordservice.enabled . Select Edit. In the Value field type FALSE, and select Save. Setting the FALSE value to this system property will automatically enable new word service
Customers new to SAP Sourcing, and those who have not yet configured WordService, should set up the SAP Sourcing DOCX Generation Service.
We recommend also that customers with SAP Sourcing already installed and WordService already configured should update directly to the SAP Sourcing DOCX Generation Service as well. However, these customers may instead update Microsoft .NET WordService to the latest version.
The SAP Sourcing DOCX Generation Service generates and works with documents only in .docx or .dotx formats. For example, you cannot upload .doc or .dot files to the SAP Sourcing DOCX Generation Service. Therefore, to use the SAP Sourcing DOCX Generation Service, you must convert your legacy .doc and .dot files to .docx and .dotx formats.
* Enabling SAP Sourcing DOCX Generation Service on the SAP Sourcing & CLM 9.0 and its various SP’s is still in development.
Hello, Varsh. Great post!
Do you know if this new DOCX generation service now supports MS Word 2010 .docx files? On the contract generation service we had some problems when using variables + MS Word 2010 files.
Thanks in advance.
Robert, Thanks for your feedback.
Yes, the new DOCX generation service now supports MS Word 2010 .docx files as well.
Hi Harsh ,
Great Post !!! Thanks for Info , as mentioned in a blog the DOCX generation will not support wave 9 ( in development) , we are using the word generator in different server , i have a situation , need your valuable inputs to resolve .
Sourcing version : 9.00.05
Win word : 2010 professional
case 1 :I am able to load clause , contract templates and create the contract documents using the docx (2007) standard template , but when i try to check out and check in i get the following error .
Server unable to process request --->value cannot be null.parameter name:0
case 2 : i am able to check in and check out document in win 98-2003 version , but if i compare the document , system does nothing , not compare or provide the result .
Many thanks in advance
Note also that new versions of the installation guides and upgrade guides for SAP Sourcing Wave 7/7.0 SP05 have been posted to Service Marketplace. These include instructions for setting up the new DOCX generation service. https://websmp110.sap-ag.de/eso
Hello Harsh very helpful post thanks,
In old word service scenario microsoft word was called by "OfficeAutomationUser" this time which user is accesing word service ?
I see that new service is using org.apache.poi API from logs and methods to encrypt files. So before getting into detail I wanted to confirm with you if new docx service is supporting to produce automatically password protected files by coding ?
Many Thanks & Regards,
SAP Sourcing DOCX Generation Service is in-house contract generation service and does not need any additional server. Hence there is no need of any specific user to access the word service.
New docx service does not support to automatically generate password protected files.
In trying to run the upgrade script I am failing on a .doc file, but with no details and dbimport isn't creating any logs. Running v7 sp06 and CGen on sp05. Any thoughts?
We would request you raise this issue in CSS system with appropriate priority so that we can track and work on the issue accordingly.
Thank you for the reply. I have done that as well. I'll post an update once we make some progress.
Thanks Harsh for the blog - really useful.
I know this question is dependent on hardware and the number of docs so may get a vague response, but any idea how long the conversion might take - any rules of thumb?
Or is it a case of trial and error?
Thanks for the blog Harsh
do you know if SAP CLM 10.0 accepts MS Office 2013 ? Or where i can have, a link for the example,for the prerequisites of SAP CLM 10.0 on it ?