Configuring Guided Procedures for Interactive Forms

SAP Composite Application Framework Document Version 1.00 – November 2005

SAP AG Neurottstraße 16 69190 Walldorf Germany T +49/18 05/34 34 24 F +49/18 05/34 34 20 www.sap.com

© Copyright 2005 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, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. IBM, DB2, DB2 Universal Database, OS/2, Parallel Sysplex, MVS/ESA, AIX, S/390, AS/400, OS/390, OS/400, iSeries, pSeries, xSeries, zSeries, z/OS, AFP, Intelligent Miner, WebSphere, Netfinity, Tivoli, and Informix are trademarks or registered trademarks of IBM Corporation 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. MaxDB is a trademark of MySQL AB, Sweden.

SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, 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 in several other countries all over the world. 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. Disclaimer Some components of this product are based on Java™. Any code change in these components may cause unpredictable and severe malfunctions and is therefore expressively prohibited, as is any decompilation of these components. Any Java™ Source Code delivered with this product is only to be used by SAP’s Support Services and may not be modified or altered in any way.

T yp o g r a p h i c C o n v e n t i o n s I c o n s Type Style Represents Example Text Words or characters quoted from

the screen. These include field names, screen titles, pushbuttons labels, menu names, menu paths, and menu options. Cross-references to other documentation.

Example text Emphasized words or phrases in body text, graphic titles, and table titles.

EXAMPLE TEXT Technical names of system objects. These include report names, program names, transaction codes, table names, and key concepts of a programming language when they are surrounded by body text, for example, SELECT and INCLUDE.

Example text Output on the screen. This includes file and directory names and their paths, messages, names of variables and parameters, source text, and names of installation, upgrade and database tools.

Example text Exact user entry. These are words or characters that you enter in the system exactly as they appear in the documentation.

<Example text> Variable user entry. Angle brackets indicate that you replace these words and characters with appropriate entries to make entries in the system.

EXAMPLE TEXT Keys on the keyboard, for example, F2 or ENTER.

Icon Meaning

Caution

Example

Note

Recommendation

Syntax

Contents Introduction......................................................................................................................... 2

About This Document................................................................................................ 2 Prerequisites ............................................................................................................. 2 Recommended Readings.......................................................................................... 2 Disclaimer.................................................................................................................. 2

Adobe Document Service (ADS)........................................................................................ 2 Configure Interactive Forms Receipt.................................................................................. 7 Configure the Outbox ....................................................................................................... 13

Introduction About This Document This tutorial is a part of a series that describes how to implement a composite application using SAP Composite Application Framework (CAF) capabilities. The tutorial describes how to configure your system so that you can send, receive, and process interactive forms in processes modeled with Guided Procedures.

Prerequisites The following table describes the prerequisites for running this tutorial. Software The tutorial is compliant with:

• Sneak Preview SAP NetWeaver 04 – Web Application Server 6.40 Java. You can download the sneak preview at http://sdn.sap.com

• SAP NetWeaver 2004s SPS04 Documents Before you start with this tutorial, see:

• Interactive Forms in Guided Procedures (PPT)

Authorizations You must hold administration permissions for the Java server, as well as the following Guided Procedures roles:

• GP Administrator

Recommended Readings After you have completed this tutorial, you can familiarize yourself with the following documents:

• My First Form Process

• Exposing an Interactive Form as a Callable Object

• Using a Standalone Interactive Form

Disclaimer Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or grossly negligent.

Adobe Document Service (ADS) Creating Connection to the Java Server ...

1. Make sure that your Java server is started and launch the Visual Administrator.

If a default connection is not available, create a new one.

a. Choose New. b. Enter the system ID (SID) for the display name of the connection. c. Choose to connect using the Message Server.

d. Enter the user name, host and HTTP port of the message server.

2. Select a connection you created and choose Connect.

3. Enter the relevant password and choose Connect.

Configuring SLD 4. Navigate to <SID> → Server → Services → SLD Data Supplier. Open the Runtime → HTTP

Settings tab page. a. If you have installed a local System Landscape Directory (SLD), enter the local SLD

host, port, user and password. Otherwise enter the data for a remote SLD host, port, user and password provided by your system administrator.

b. Choose Save.

5. Open the Runtime → CIM Client Generation Settings tab page.

a. Enter the SLD settings you used previously. You can also use a different user for the client generation.

b. Choose Save.

c. Choose CIMClient Test to test your settings.

You should receive a message confirming that the test was successful. Choose OK to continue.

`

Configuring ADS Web Service Client 6. Navigate to <SID> → Server → Services → Web Services Security. Open the Runtime tab

page. 7. Navigate to Security Configuration → Web Service Clients → sap.comtc~wd~pdfobect →

com.sap.tc.webdynpro.adsproxy.AdsProxy*ConfigPort_Document. a. Select SLD for destination URL and BASIC for destination authentication. b. Enter the username and password that can be used to authenticate with the ADS.

c. For system name enter:

<SID>.SystemHome.<MachineHost>

d. For WS name enter: {com.adobe/AdobeDocumentServices}{AdobeDocumentServicesAssembly.jar}{AdobeDocumentServices}

e. For WS Port enter:

{com.adobe/AdobeDocumentServices}{AdobeDocumentServicesAssembly.jar}{AdobeDocumentServices}{urn:AdobeDocumentServicesWsd}ConfigPort_Document

f. Choose Save.

8. Log out from the Visual Administrator and restart your Java server. 9. Log on to the Visual Administrator again and check whether the destination has been properly

set in the Web Services Security service.

You should now be able to use the Adobe Document Service.

Configure Interactive Forms Receipt Interactive Forms Adapters ...

1. In the portal, navigate to Guided Procedures → Administration tab.

2. Choose Configure Adapters.

For each adapter, you can assign a mailbox. It is used to collect all submitted interactive forms.

3. Select the adapter that you want to assign the email server to then choose Add.

4. Choose the protocol you want to use – either POP3 or IMAP4. 5. Enter the server address, user name, password, client and domain.

Optionally, you can enter a folder name in the mailbox where the interactive form mails are to be received.

6. Choose Create

You email server should be configured for the adapter. You can add more email servers if required.

Next, you must activate the time interval for GP to check the email servers.

7. To do so, start the Visual Administrator and navigate to <SID> → Server → Services → caf/eu/gp/model.

8. In the Properties tab page, select the property mailconnector.start_thread, enter true as

its value, and choose Update.

9. Restart the Java server so that the changes take effect.

Maintaining Inbox Queue 10. In the portal, navigate to Guided Procedures → Administration and choose Maintain Queues to

open the Queue Manager.

11. Select the queue that you want to see.

In the Select Queue dropdown list you should be able to see the adapter, for which you configured an e-mail server.

After selecting the queue, you should be able to see the emails that have been received in the Queue Entries tab page. You can refresh the queue or delete an item in it.

If you select an item in the queue, its details are displayed in the Queue Item Details tab page.

You can check the item content be viewed under the Queue Item Content tab.

To check the supported states, go to the Queue Header Data tab page.

Managing Impersonalized Forms (Optional) 12. In the portal, navigate to Guided Procedures → Administration and choose Manage

Unpersonalized Forms.

Here, you can see a list of all impersonalized form callable objects that have been defined and activated in the Guided Procedures design time. To be able to use the form (for example, publish it and ask users to fill it out, or send it by e-mail), you need to create an instance of the form. You can

define when the form expires, and you can download the instance locally. The following functions are available:

• You can create a form instance. The request count shows the number of instances created from each form callable object. The number changes each time you create a new instance using Create. The available form instances are displayed under Current Requests.

• You can download a form template by clicking on Download. • You can remove a form callable object using Remove. This removes the object from the gallery

as well. To remove a form instance only, choose Remove under Current Requests.

• You can see how many times each form instance has been submitted back to the system (return count).

To create a new form instance: 13. Select a form callable object and choose Create. 14. Select an expiry date and choose Create.

The expiry date defines the deadline for submitting the form back to the system.

15. Download the form locally, and then choose Back.

You can publish the form on a Web site or send it by e-mail.

The form should now appear under Current Requests.

Configure the Outbox In addition to configuring your inbox, you can also configure outbox email servers. Any e-mails that the Guided Procedures framework sends use this email server and the service user e-mail. ...

1. To configure the system for sending e-mails, launch the Visual Administrator, and navigate to <SID> → Server → Services → caf/eu/gp/model.

2. Update the values for the following properties: a. smtp.server b. smtp.service_user_mail

3. Restart your server after the changes.