Setting up the SAP Conversion Server to convert Graphical ... · PDF fileSetting up the SAP...

SAP COMMUNITY NETWORK SDN - sdn.sap.com | BPX - bpx.sap.com | BOC - boc.sap.com | UAC - uac.sap.com

© 2010 SAP AG 1

Setting up the SAP Conversion

Server to convert Graphical

Information via Right

Hemisphere’s Deep Server

Applies to:

SAP Product Lifecycle Management (SAP PLM), SAP Document Management System (SAP DMS)

Summary

This article describes the required steps to set up the SAP Conversion Server and to integrate it with a 3ed Party Software. In this example the Deep Server from Right Hemisphere was selected, as conversion of graphical information is a very common usecase. In addition SAP is shipping the viewing technology from Right Hemisphere.

The article is only intended as an example.

Author: Martin Bachmann

Company: SAP AG

Created on: 28 August 2010

Author Bio

Martin finished university as a mechanical engineer in 1997. Directly after that he joined SAP as a developer for order specific BOMs. Over the time I have been part of several other organizations inside SAP AG (PLM Field Services, Automotive Industry), but always dedicated towards the topic of PLM. A few years ago he moved to the Product Management Team for SAP PLM in Walldorf where Martin was involved with the planning and realization of SAP PLM 7.0

Setting up the SAP Conversion Server to convert Graphical Information via Right Hemisphere’s Deep Server


© 2010 SAP AG 2

Table of Contents

Overview ............................................................................................................................................................. 3

Setting Up the Conversion Server ...................................................................................................................... 3

Step1: Copy the Required Files on to Conversion Server .............................................................................. 4

Step 2: Start the Conversion Server Using the Batch File RunConvUtil.bat. ................................................. 4

Step 3: Setting up Batch Files ......................................................................................................................... 4

Step 4: Configure the Conversion Server to run as a Windows Service ........................................................ 5

Required Customizing in SAP ECC ................................................................................................................ 7 Create a RFC Destination ............................................................................................................................................ 7

DMS Customizing ........................................................................................................................................................ 9

Deep Server ...................................................................................................................................................... 12

Preparation of Deep Server .......................................................................................................................... 12

Exemplary Workflow for a Conversion to the *.rh format. ............................................................................. 14

Monitoring ......................................................................................................................................................... 19

Monitoring Inside Deep Server ..................................................................................................................... 19

Monitoring Inside SAP................................................................................................................................... 20

Result of the Conversion .................................................................................................................................. 21

Related Content ................................................................................................................................................ 23

Appendix A: MS DOS Batch file: Start Conversion Server (RunConvUtil.bat) ................................................. 24

Appendix B: MS DOS Batch File to Trigger the Conversion (ConvServ.bat) ................................................... 24

Appendix C: MS DOS Batch File to Start Deep Server (file2conv.bat) ............................................................ 25

Copyright........................................................................................................................................................... 28



© 2010 SAP AG 3

Overview

In SAP PLM very often there is a need for conversion of a file from one format to the other, like from a MS Word-file to a Adobe PDF format. These conversions usually happen during file check-in or a status change.

SAP PLM supports these conversions since SAP PLM 4.6c. In this document the functionality of the SAP Conversion Server is described by using a real-live example, the integration of the Right Hemisphere Deep Server.

A lot of the information shown below is coming of the Article „Integration of Microsoft Rights Management in SAP PLM‟. It was added here again to show the complete end-to-end process of the setting up.

In this example the conversion from CAD Files to various neutral files (RH, Animated GIF, PDF, JT, …) is highlighted.

SAP changed the SAP Conversion Server massively to address also very high load on the conversion server. The architecture was based on jobs earlier, with note 687199 a workflow based conversion server was introduced. This newer version is recommended because of the higher reliability. Additionally individual workflows (e.g. email notification on failure) can now be implemented without modification.

Setting Up the Conversion Server

As part of the SAP PLM shipment SAP provides a basic conversion server that can be used to perform document conversions using command line tools.

Technically the conversion server is a simple RFC Registered Server Program. An RFC server program can be registered with the SAP gateway and wait for incoming RFC call requests.

From the SAP PLM System it is thus accessed through a TCP IP RFC destination with activation type „T‟ Registered Server Program.

In this integration scenario the Conversion server must run on a Windows server where the Right Hemisphere Deep Server is installed (http://www.righthemisphere.com)

On the conversion server there are two ways to start the service (either or – not both…):

1. Manually by the user starting batch file or

2. Automatically as a Windows service.

You should start with option 1 when setting up the configuration because any error messages are available in clear text in the command prompt. Since option1 is not ideal for productive usage you should start the Conversion server as a Windows server once the setup has been tested.

http://www.sdn.sap.com/irj/scn/go/portal/prtroot/docs/library/uuid/c03dbad7-df4e-2d10-2296-a5f586a89307

http://www.sdn.sap.com/irj/scn/go/portal/prtroot/docs/library/uuid/c03dbad7-df4e-2d10-2296-a5f586a89307

http://www.righthemisphere.com/



© 2010 SAP AG 4

Please note that you cannot start the conversion server at the same time manually and as a Windows service. The second attempt to register the Conversion server would fail it is only possible to register once using the same registration ID at the SAP Gateway.

Step1: Copy the Required Files on to Conversion Server

Create a separate directory on the Windows server and copy the required files into this directory. You should always make sure to have up-to-date versions of the .exe and .dll files).

In this Wiki you can see where to find the files:

- SAPhttp.exe (use the latest version from the SAPGUI installer)

- SAPftp.exe (use the latest version from the SAPGUI installer)

- Librfc32.dll (use the latest version from the SAPGUI installer)

- ConvServSamp.exe

- ConvUtil.exe

- Sleep.exe

Step 2: Start the Conversion Server Using the Batch File RunConvUtil.bat.

You can start the conversion server using the batch file RunConvUtil.bat. The coding for the batch file is available in Appendix A.

Starting the Conversion server this way is easier for development and debugging but is usually not ideal for productive usage. The batch file has to be started one time, only then the SM59 can be used to check whether the system is able to connect to this RFC server program.

A Gateway Server should be installed on the Conversion Server. For this demo example we used the Gateway host from the SAP PLM System.

As a hint please add the path where the Conversion Server files are stored also to the global path in the Environment Variables to avoid issues with files that cannot be found.

Step 3: Setting up Batch Files

A script file is required for setting up the start parameters of the real conversion batch file (ConvServ.bat) -> Appendix B

In a third file the real conversion from CAD File to a graphical file is done. In this batch file the Deep Server is called with the required parameters (Appendix C). This Batch file checks, what outcome is required (jt, rh, gif, …) and moves then the file to the correct folder.

It then monitors, if Deep Server has completed the conversion. This is indicated by the creation of a „ConvPath.txt‟ file in the out-directory. The Batch file polls to see, if this file was created. As soon as it is created, the Conversion Server copies back the result to SAP PLM.

More details on the used syntax in the MS-DOS Batch can be found in the Related Content Section.

These Batch files are only templates to illustrate the general idea. Of course they can be changed depending to customer requirements. In addition the batch-files from the appendix contain a lot of remarks and comments for information.

https://wiki.wdf.sap.corp/wiki/display/PSupportERPPLM/Document+Conversion+-+Conversion+Server



© 2010 SAP AG 5

As a result the SAP Conversion Server is creating for every conversion a directory with a GUID as directory name. In the „in‟ and „out‟ folders the server is copying the CAD Part and additional information from the SAP System. The filename from the imported CAD Part is concatenated with the directory name and is moved to the folder which Deep Server monitors.

Step 4: Configure the Conversion Server to run as a Windows Service

The procedure how to start a registered RFC server program as a Windows service is described in detail in the blog How to start a RFC Registered Server Program as a Windows service that Andre has published in SDN recently.

The executable ConvUtil.exe is called using the following syntax

ConvUtil.exe -a DEWDFIAS181.ConvUtil -x sapgw26 -g uxai2e6c.wdf.sap.corp

Therefore the following value has to be entered in the Windows service registry settings

http://www.sdn.sap.com/irj/scn/weblogs?blog=/pub/wlg/19007



© 2010 SAP AG 6

In the service Control Centre you can now define the Startup-behaviour for the new windows service.

You have to make sure that programs that are started by the conversion server can be reached by the user running the service.

Therefore one should first try to start the service manually as described above.



© 2010 SAP AG 7

Required Customizing in SAP ECC

Create a RFC Destination

We can now set up a RFC Connection in SM59 to test the communication between the SAP PLM system and the conversion server.

1. Create new RFC Destination (T)

2. Enter as program ID the ID that is used in parameter “a” by the conversion server (see above). In our

example we have to use the program-ID “DEWDFIAS181.ConvUtil“.



© 2010 SAP AG 8

When there is a successful connection, then the Connection Test should look like this:



© 2010 SAP AG 9

DMS Customizing

Setting up Conversion Server Customizing in DMS Customizing:

Go to „Maintain Converter‟. Here the RFC-Destination from SM 59 needs to be entered.



© 2010 SAP AG 10

In „Define Conversion‟ the parameters for the Conversion need to be entered (which Document Type, which Workstation Application as a source and target, timeouts, …). Also the path on the conversion server is required. At this path on the conversion server the folders containing the information will be created.



© 2010 SAP AG 11

Also in the Parameters section information for the Batch file is stored – this is required to find out, which type of conversion was started.



© 2010 SAP AG 12

Deep Server

The Deep Server from Right Hemisphere has to be already installed and running on the server. In this document this topic will not be covered. http://www.righthemisphere.com/support/ offers various articles, documents, … that help during the setting up of the Deep Server. In our example we were using Deep Server 5.7.

Preparation of Deep Server

In order to separate the various conversion results we need a folder for every conversion type. These folders are created manually on the conversion server.

Inside Deep Server a process is then looking at every directory. As soon as the MS DOS Batch file has moved a file into a folder, Deep Server is triggering the right conversion process.

http://www.righthemisphere.com/support/



© 2010 SAP AG 13

The Deep Server Service Bureau is the central point for entering the monitored folders.



© 2010 SAP AG 14

Exemplary Workflow for a Conversion to the *.rh format.

The following steps explain the details of a conversion process.

This picture shows, how the overall process looks like. Deep Server offers so called „variables‟ to enter parameters or to save calculated results. This workflow makes use of these variables to store information needed for later steps.

In the MS DOS Batch file the generic GUID and the filename are concatenated. In the set_GUID and set_Filename activities inside Deep Server these concatenation is then copied to the variables GUID and Filename. Also additional information (the name of the out-dir) is calculated inside set_outdir.



© 2010 SAP AG 15

Via the very powerful XPath modeling inside Deep Server it is possible to perform these actions without any programming, only via drag & drop. This guide explains the basics of XPath.

The set_GUID action uses the first 32 Bytes to calculate the name of the working directory from the SAP conversion server.

http://www.w3schools.com/xpath/xpath_functions.asp



© 2010 SAP AG 16

Set_Filename calculates from the imported filename the real filename (without GUID)

Set Outdir concatenates out of the GUID the right name where the result of the conversion should be copied to.



© 2010 SAP AG 17

In go_open Deep Server is then finally opening the CAD Part.

Go_save_rh is then saving the file to the right output directory.



© 2010 SAP AG 18

As a last step in AppendFile the ConvPath.txt file is created by Deep Server. The name of the resulting neutral file is added to the ConvPath file. The ConvPath file is required by the SAP Conversion Server, as this file is required to find the converted neutral file.

An additional option is to use the Deep Server for the creation of Animated GIFs. In this element (go_animatethumbnail) this is shown.



© 2010 SAP AG 19

Monitoring

Monitoring Inside Deep Server

A click to the process is displaying the result and the status of each conversion activity. Additionally one could also enhance the workflows, so that a failure e.g. sends out an email, writes an error-log to the conversion server, …



© 2010 SAP AG 20

Monitoring Inside SAP

The Transaction CONV01 gives an overview on the conversions.

An additional overview gives the customizing transaction. If for example a conversion gets stuck by a time-out, … sometimes it is required to set the status manually to „ready‟ again here.

Some customers even scheduled a job to change the status to „Ready‟ every few minutes.



© 2010 SAP AG 21

Result of the Conversion

As a result of the conversion process the neutral files that were set up in customizing are now attached automatically at the document info record.

So if a status change happens, automatically the CAD Part is copied, gets converted, and is checked in back to SAP PLM DMS.

Depending on the power of the conversion server hardware, after some seconds the additional files are present. In the meantime the DIR is locked.



© 2010 SAP AG 22

Via the built in viewer now all SAP users can view the CAD Part without the need of an expensive CAD license.

The Deep Server can also create PDF-files that contain the geometry. This is usually also very useful when collaborating with externals.



© 2010 SAP AG 23

Related Content

SAP Online Help – Conversion Server

Wiki on Conversion Server

SAP DMS

SAP Online Help: Registering Server Programs with the SAP Gateway

Microsoft: Help on MS DOS Syntax

Additional Tips on MS DOS Syntax

Starting Files as Windows Service

SAP Documentation on Built-In 2D and 3D Viewer

XPath reference for usage inside Deep Server

http://help.sap.com/erp2005_ehp_04/helpdata/EN/e1/6ae63736544d4de10000009b38f8cf/frameset.htm

https://wiki.wdf.sap.corp/wiki/display/PSupportERPPLM/Document+Conversion+-+Conversion+Server

http://www.sdn.sap.com/irj/bpx/plm?rid=/webcontent/uuid/10887281-217c-2b10-e4a9-beffa143e16b

http://help.sap.com/saphelp_nw04/helpdata/en/22/0429aa488911d189490000e829fbbd/frameset.htm

http://www.microsoft.com/resources/documentation/windows/xp/all/proddocs/en-us/percent.mspx?mfr=true

http://www.dostips.com/

http://www.sdn.sap.com/irj/scn/weblogs?blog=/pub/wlg/19007

http://help.sap.com/erp2005_ehp_04/helpdata/en/76/6ccd218e924b869c88712fd74ecdf1/frameset.htm

http://www.w3schools.com/xpath/xpath_functions.asp



© 2010 SAP AG 24

Appendix A: MS DOS Batch file: Start Conversion Server (RunConvUtil.bat)

@echo off

rem (c) Copyright SAP AG Walldorf, 2000

rem use transaction sm59 (in SAP R/3) to create an RFC destination

rem pointing to this file (RunConvUtil.bat).

rem choose 'T' as 'Connection type' and

rem 'Registration' as 'Activation Type'.

rem Enter 'p08551.doc2pdf.ConvUtil' into the 'Program ID' field.

set ProgramID=DEWDFIAS181.ConvUtil

rem hint: you can choose any program ID you like.

rem But make sure the value you define in this program for

rem ProgramID is identical with the setting of Program ID in sm59

rem choose 'Destination->Gateway options' in the top menu.

rem enter the name of your gateway host (e.g. pwdf0288) and

rem your gateway service (e.g. sapgw28) into the appropriate fields.

set GATEWAY_HOST=uxai2e6c.wdf.sap.corp

set GATEWAY_SERVICE=sapgw26

rem hint: you MUST change the settings (pwdf0288 and sapgw28) used

rem in this example according to your local environment !!!

rem Ask you system administrator for your gateway host

rem and gateway service.

rem Start this program (RunConvUtil.bat) and

rem test the RFC destination using the button 'Test connection' !!

rem add path's to the PATH variable to make sure the

rem following programs will be found:

rem - sapftp.exe and saphttp.exe (on the SAP client CD)

rem - ConvUtil.exe

rem - ConvServ.bat (shell script in this directory)

set PATH=%~dp0;%~dp0..;%PATH%

:START

ConvUtil.exe -a %ProgramID% -g %GATEWAY_HOST% -x %GATEWAY_SERVICE%

echo ConvUtil stopped, start again in 1 minute

sleep 60

goto :START

Appendix B: MS DOS Batch File to Trigger the Conversion (ConvServ.bat)

@echo off

rem (c) Copyright SAP AG Walldorf, 2000

rem sample file to start the translator using ConvUtil

%~dp0ConvServSamp.exe -s %~dp0file2conv.bat -readDocumentDetails -logFile

%~dp0Conversion.txt -consoleLog %*



© 2010 SAP AG 25

Appendix C: MS DOS Batch File to Start Deep Server (file2conv.bat)

@echo off

rem ********************** init *********************************

set VERSION=%1%

rem indicates the features currently supported by R/3

rem 1: first Version

rem 2: key of document passed to the converter

rem 4: CURRENT_USER is passed to the converter and

rem bapireturn supported (=> you will see messages in the

rem Appl. Log. if BAPI_DOCUMENT_GETDETAIL2 fails)

rem 5: SY_LANGUAGE is passed to the converter

set WORKDIR=%~dp2

cd %WORKDIR%

rem temporary working directory unique for each conversion process

rem set in double quotes (")

set IN_FILE="%~f3"

rem path name of file which must be converted


set LANGUAGE=%4%

rem preferred language for error messages as set in the customizing

rem (X: no language specified)

rem hint: compare SY_LANGUAGE=%9%

set TIMEOUT_MINUTES=%5%

rem after this time the converter should stop

set CONVERSION_NAME=%6%

rem unique name of this conversion (32 characters long)

set DOCUMENT=%7%

rem key of document in double quotes ("), 33 digits long:

rem first 3 digits: documenttype

rem next 25 digits: documentnumber

rem next 3 digits: documentpart

rem next 2 digits: documentversion

set CURRENT_USER=%8%

rem user who initiated the conversion (implicitly or explicitly)


set SY_LANGUAGE=%9%

rem Language used by %CURRENT_USER% in SAP R/3


rem ***** only the file name, no path

set FILE_NAME=%~n3%~x3

rem ************ remove spaces from filename ************

set FILE_NAME=%FILE_NAME: =%



© 2010 SAP AG 26

rem ***** the new name with GUID is concatenated

set NEW_NAME=%CONVERSION_NAME%_%FILE_NAME%

rem ************ remove spaces from filename ************

set NEW_NAME=%NEW_NAME: =%

rem ************* ConvPath.txt **********************

set CONV_PATH=%WORKDIR%ConvPath.txt

rem ********************* starting ***************************

rem ***** what conversion? ***********

rem **** RH?

find "RH" %WORKDIR%Parameters.txt

if %errorlevel% EQU 0 goto :RH

rem **** PDF?

find "PDF" %WORKDIR%Parameters.txt

if %errorlevel% EQU 0 goto :PDF

rem **** Thumbnail?

find "THU" %WORKDIR%Parameters.txt

if %errorlevel% EQU 0 goto :THU

rem **** JT?

find "JT" %WORKDIR%Parameters.txt

if %errorlevel% EQU 0 goto :JT

echo No Input in Parameters Customizing found... > error.txt

goto :eof

rem ******************** RH ********************

:RH

rem ***** the new guid-name with folder

set DS_IN_NAME="D:\SAP_Deep_Server\RH_In\%NEW_NAME%"

goto :more

rem *************** PDF ************************

:PDF


set DS_IN_NAME="D:\SAP_Deep_Server\PDF_In\%NEW_NAME%"

goto :more

rem ******************** JT *****************

:JT


set DS_IN_NAME="D:\SAP_Deep_Server\JT_In\%NEW_NAME%"

goto :more

rem ************** Thumbnail *****************

:THU


set DS_IN_NAME="D:\SAP_Deep_Server\GIF_In\%NEW_NAME%"

goto :more



© 2010 SAP AG 27

rem ************** Continue ***********************

:more

rem ******* copy file to DS directory - start conversion

move %IN_FILE% %DS_IN_NAME%

if %errorlevel% NEQ 0 goto :MOVE_ERROR

rem ***** Conversion finished? ********************

:wait_4_file

sleep 1

if not exist %CONV_PATH% goto :wait_4_file

goto :eof

rem ****************** Error **********************

:MOVE_ERROR

echo %DS_OUT_NAME% could not be moved or copied > error.txt

:eof

echo Done



© 2010 SAP AG 28

Copyright

© Copyright 2010 SAP AG. All rights reserved.

No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice.

Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors.

Microsoft, Windows, Excel, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation.

IBM, DB2, DB2 Universal Database, System i, System i5, System p, System p5, System x, System z, System z10, System z9, z10, z9, iSeries, pSeries, xSeries, zSeries, eServer, z/VM, z/OS, i5/OS, S/390, OS/390, OS/400, AS/400, S/390 Parallel Enterprise Server, PowerVM, Power Architecture, POWER6+, POWER6, POWER5+, POWER5, POWER, OpenPower, PowerPC, BatchPipes, BladeCenter, System Storage, GPFS, HACMP, RETAIN, DB2 Connect, RACF, Redbooks, OS/2, Parallel Sysplex, MVS/ESA, AIX, Intelligent Miner, WebSphere, Netfinity, Tivoli and Informix are trademarks or registered trademarks of IBM Corporation.

Linux is the registered trademark of Linus Torvalds in the U.S. and other countries.

Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe Systems Incorporated in the United States and/or other countries.

Oracle is a registered trademark of Oracle Corporation.

UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group.

Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc.

HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C®, World Wide Web Consortium, Massachusetts Institute of Technology.

Java is a registered trademark of Sun Microsystems, Inc.

JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape.

SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP Business ByDesign, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries.

Business Objects and the Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Business Objects S.A. in the United States and in other countries. Business Objects is an SAP company.

All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.

Setting up the SAP Conversion Server to convert Graphical ... · PDF fileSetting up the SAP...

Documents

Transcript of Setting up the SAP Conversion Server to convert Graphical ... · PDF fileSetting up the SAP...