Interstage BusinessProcessManager V10€¦ · TableofContents AboutthisManual.....5 1 SystemConfigurations.....7

InterstageBusiness Process ManagerV10.1

Console Installation Guide

B1WD-1481-07ENZ0(00)January 2009

January 2009Publication Date

3Revision

Interstage is a trademark of Fujitsu Limited.Microsoft, Windows, Windows NT, and Windows Server areregistered trademarks of Microsoft Corporation in the UnitedStates and other countries.UNIX is a registered trademark of the Open Group in theUnited States and in other countries.Java, all Java-based trademarks and Solaris are trademarksof Sun Microsystems, Inc. in the U.S. or other countries.AIX is a trademark of IBM Corp.Linux is a registered trademark of Linus Torvalds in the USAand other countries.Red Hat, the Red Hat "Shadow Man" logo, RPM, MaximumRPM, the RPM logo, Linux Library, PowerTools, LinuxUndercover, RHmember, RHmember More, Rough Cuts,Rawhide and all Red Hat-based trademarks and logos aretrademarks or registered trademarks of Red Hat, Inc. in theUnited States and other countries.All other trademarks and trade names mentioned have beenregistered by their respective manufacturer.

Trademarks

All rights reserved, including those of translation into otherlanguages. No part of this manual may be reproduced inany formwhatsoever bymeans of photocopying, microfilmingor any other process without the written permission of FujitsuLimited.

All Rights Reserved,Copyright © FUJITSULIMITED 2005-2009

High Risk Activity

The Customer acknowledges and agrees that the Product is designed, developed andmanufactured as contemplated for general use, including without limitation, general officeuse, personal use, household use, and ordinary industrial use, but is not designed,developed andmanufactured as contemplated for use accompanying fatal risks or dangersthat, unless extremely high safety is secured, could lead directly to death, personal injury,severe physical damage or other loss (hereinafter "High Safety Required Use"), includingwithout limitation, nuclear reaction control in nuclear facility, aircraft flight control, air trafficcontrol, mass transport control, medical life support system, missile launch control inweapon system. The Customer shall not use the Product without securing the sufficientsafety required for the High Safety Required Use. In addition, Fujitsu (or other affiliate'sname) shall not be liable against the Customer and/or any third party for any claims ordamages arising in connection with the High Safety Required Use of the Product.

Table of ContentsAbout this Manual............................................................................5

1 System Configurations....................................................................7

1.1 Minimum Configuration: All Systems on the same Computer..........................7

1.2 Interstage BPM Server and Client on Different Computers...............................8

2 System Requirements......................................................................9

2.1 Hardware Requirements for Console on Windows.............................................9

2.2 Hardware Requirements for Server on Linux......................................................9

2.3 Minimum Software Requirements for Console on Windows.............................9

2.4 Hardware Requirements for Console on Solaris................................................9

2.5 Minimum Software Requirements for Console on Solaris...............................10

2.6 Minimum Software Requirements for Console on Linux.................................10

2.7 Hardware Requirements for Browser.................................................................10

2.8 Minimum Software Requirements for Web Browser Clients...........................10

3 Installing the Interstage Business Process Manager Console...11

3.1 Installing the Console on the BEA WebLogic Server.......................................113.1.1 Configuring a WebLogic 9.2 Domain for the Interstage BPM Console..................133.1.2 Deploying the BPM Console using the WebLogic Administration Console............153.1.3 UTF-8 Character Support.......................................................................................213.1.4 Special WebLogic Server Configurations to Enable Web Service Operations......223.1.5 Configuring WebLogic's Embedded LDAP Server.................................................223.1.6 Configuring the Console (Initial Access)................................................................23

3.2 Installing the Console on the JBoss Application Server.................................263.2.1 Configuring the Console (Initial Access)................................................................293.2.2 Setting Up an Interstage BPM Console Cluster on JBoss.....................................31

3.3 Installing the Console on the WebSphere Application Server........................323.3.1 Adding the Required Custom Property..................................................................40

3.4 Installing the Console on the Interstage Application Server...........................423.4.1 Configuring the Console (Initial Access)................................................................46

3.5 Configuring the SOAP Listener..........................................................................48

Interstage Business Process Manager Console Installation Guide 3

Table of Contents

3.6 Using the Interstage BPM Command Interface Web Services.........................503.6.1 Verifying Command Interface Web Services Operation.........................................503.6.2 Invoking the Command Interface Web Services....................................................513.6.3 Invoking Web Services Using XMLSpy..................................................................51

3.7 Uninstalling the Interstage Business Process Manager Console...................543.7.1 Uninstalling the Console from the BEA WebLogic Server.....................................553.7.2 Uninstalling the Console from the JBoss Application Server.................................553.7.3 Uninstalling the Console from the WebSphere Application Server........................553.7.4 Uninstalling the Console from the Interstage Application Server...........................57

AppendixA Web Services Interfaces................................................................58

A.1 Web Services Interface........................................................................................58A.1.1 WSDL File of the Web Services Interface .............................................................58A.1.2 Process Definition Operations................................................................................69A.1.3 Process Instance Operations.................................................................................72A.1.4 Work Item Operations............................................................................................76

A.2 Asynchronous Web Services Interfaces............................................................79A.2.1 WSDL File of the Server-Level Web Services Interface........................................79A.2.2 Operations of the Server-Level Web Services Interface........................................82A.2.3 WSDL File of the Process-Level Web Services Interface......................................82A.2.4 Operations of the Process-Level Web Services Interface......................................88

A.3 Fault Messages.....................................................................................................88

Index .........................................................................................................90


Table of Contents

About this ManualThis manual describes how to configure the system environment and install Interstage BusinessProcess Manager (Interstage BPM).

Intended AudienceThis manual is intended for system administrators. It assumes that the reader has a working knowledgeof Operating system administration

This Manual ContainsHere is a list of what is in this manual:

DescriptionTitleChapter

Description of the minimumsystem requirements byplatform.

System Requirements1

Instructions for installingInterstage BPM.

Installation2

Description of the InterstageBPM Web Services Interfacesthat includes code samples.

Web Services InterfacesAppendix A

Screenshots of external products that appear in this manual are approximations only. What you seewhen using that product may differ in appearance due to platform or product version differences.

Typographical ConventionsThe following conventions are used throughout this manual:

MeaningExample

Text, which you are required to type at acommand line, is identified by Courier font.

command

Text, which is visible in the user interface, is bold.screen text

Reference material is in italics.Reference

A command parameter is identified by Courierfont.

Parameter

Other ReferencesThe following references for Interstage Business Process Manager are also available:• Release Notes

Contains an overview of Interstage Business Process Manager, installation tips, and late-breakinginformation that could not make it into the manuals.

• Interstage Business Process Manager Server Installation Guide


About this Manual

Describes software and hardware requirements for Interstage Business Process Manager Server,and how to install Interstage Business Process Manager Server.

• Interstage Business Process Manager Server Administration GuideExplains how to configure and administrate Interstage Business Process Manager. This guidecontains the descriptions of the Interstage BPM Server Configuration parameters.

• Interstage Business Process Manager Developer's GuideDescribes Interstage Business Process Manager Developer instructions.

• Interstage Business Process Manager Studio User's GuideExplains how to model processes using the Interstage Business Process Manager Studio.

• Interstage Business Process Manager Console User's GuideExplains how to use the Interstage Business Process Manager client user interfaces.

• Interstage Business Process Manager ARIS Process Performance Manager Integration GuideDescribes how to install and configure the PPM adapter and the PPM autoConfig tool. With bothprograms, process data can be transferred from Interstage Business Process Manager to ARISProcess Performance Manager.

• API Javadoc DocumentationThis HTML documentation provides the API and syntax of the packages, interfaces and classesfor developing custom applications or embedding Interstage Business Process Manager intoother products.

AbbreviationsThe products described in this manual are abbreviated as follows:• "ARIS Process Performance Manager" is abbreviated as "ARIS PPM".• "Interstage Business Process Manager" is abbreviated as "Interstage BPM".• "Microsoft® Windows Server® 2003" is abbreviated as "Windows Server® 2003".• "Solaris ™ Operating System" is abbreviated as "Solaris".• "Microsoft® SQL Server 2000 Standard Edition", "Microsoft® SQL Server 2000 Enterprise Edition",

"Microsoft® SQL Server 2005 Standard Edition", and "Microsoft® SQL Server 2005 EnterpriseEdition" are abbreviated as "Microsoft® SQL Server","Microsoft SQL Server", or "SQL Server".

• "Oracle 9i R2 Standard Edition", "Oracle 9i R2 Enterprise Edition", "Oracle 10g R2 StandardEdition", "Oracle 10g R2 Standard Edition One", and "Oracle 10g R2 Enterprise Edition" areabbreviated as "Oracle".


About this Manual

1 System ConfigurationsInterstage Business Process Manager (Interstage BPM) is a server-based workflow engine with APIs(Application Programming Interfaces) for workflow application development. The Interstage BPMConsole is the Client that connects to the Interstage BPM Server.The Interstage BPM Console must run on the same type of application server as the Interstage BPMServer to which it connects.The system configurations described in the next sections are typically used. The decision, whichconfiguration is to be used, depends on the desired performance of the employed systems.

1.1 Minimum Configuration: All Systems on the sameComputerYou can install the Interstage BPM Server and Console on the same computer.

Figure 1: All systems on the same computer

For details about the architecture of the Interstage BPM Server, refer to the Interstage BusinessProcess Manager Server Installation Guide for your particular configuration. For example if theServer to which you are connecting is installed on theWebLogic Application Server, see the InterstageBusiness Process Manager Server Installation Guide (BEA WebLogic Server).


1: System Configurations

1.2 Interstage BPM Server and Client on Different ComputersThe Interstage BPM Server and the Interstage BPM Client are installed on different computers.

Figure 2: Interstage BPM Server and Interstage BPM Client on different computers


1: System Configurations

2 System Requirements2.1 Hardware Requirements for Console on Windows

MachineFujitsu PRIMERGY or other Intel Architecture servers

ProcessorMinimum: Intel® Pentium III processor, 1 GHz, 1 CPU or greaterRecommended: Intel® Pentium III processor, 2 GHz, 2 CPU or greater

MemoryMinimum: 1GB, Recommended: 4 GB or more

Hard DriveInterstage BPM Console installation: 600 MB

2.2 Hardware Requirements for Server on Linux

MachineFujitsu PRIMERGY or other Intel Architecture server

ProcessorMinimum: Intel® Pentium III processor, 1 GHz, 1 CPU or greaterRecommended: Intel® Pentium III processor, 2 GHz, 2 CPU or greater



2.3 MinimumSoftware Requirements for Console onWindowsFor software requirements, refer to the Release Notes.

2.4 Hardware Requirements for Console on Solaris

MachineFujitsu PRIMEPOWER or other Solaris servers


2: System Requirements

ProcessorMinimum: Ultra SPARC or SPARC64 V (kernel arch: sun4u/sun4us/sun4d) 1 GHz, 1 CPU or greaterRecommended: SPARC 1.2GHz, 2CPU or greater



2.5 Minimum Software Requirements for Console on SolarisFor software requirements, refer to the Release Notes.

2.6 Minimum Software Requirements for Console on LinuxFor software requirements, refer to the Release Notes.

2.7 Hardware Requirements for Browser

MachineFujitsu DESKPOWER, ESPRIMO, SCENIC, SCALEO, CELCIUS, Lifebook, AMILO, PRIMERGY orother Windows PC / Intel Architecture servers

ProcessorPentium III 500 MHz or greater

MemoryMinimum: 512 MB, Recommended: 2 GB or more

2.8 MinimumSoftware Requirements forWebBrowser ClientsFor software requirements for the client machines connecting to the Console remotely, refer to theRelease Notes.


2: System Requirements

3 Installing the Interstage Business Process ManagerConsoleThe Interstage BPM Console is a Web Application that must be deployed on the same type of WebContainer used by the Interstage BPM Server to which you want to connect.For example, if the Interstage BPM Server is installed on the WebLogic Application Server, you mustinstall the Console on the WebLogic Server.Installation and use of the Console is greatly simplified if you install it on the same machine as theInterstage BPM Server in the same Web Container.For instructions installing the Console on the BEA WebLogic Server, see Installing the Console onthe BEA WebLogic Server on page 11.For instructions installing the Console on the JBoss Application Server, see Installing the Consoleon the JBoss Application Server on page 26.For instructions installing the Console on the WebSphere Application Server, see Installing theConsole on the WebSphere Application Server on page 32.For instructions installing the Console on the Interstage Application Server, see Installing the Consoleon the Interstage Application Server on page 42.

3.1 Installing the Console on the BEA WebLogic ServerPrerequisite: Make sure that the BEA WebLogic Server of the version stated in the SystemRequirements is properly installed and running on your machine. Also, make sure that a basicWebLogic Domain is configured on your machine. If you are deploying the Console on the samemachine where the Interstage BPMServer is installed, theWebLogic Application Server was alreadyinstalled, and theWebLogic Domain was already configured as part of the installation of the InterstageBPM Enterprise Edition.If you are configuring the Console on a machine different than the Interstage BPM Server machine,see theWebLogic Administration Documentation on configuringWebLogic Domains for instructions.For an example of a WebLogic Version 9.2 domain configuration, see Configuring a WebLogic 9.2Domain for the Interstage BPM Console on page 13.

These instructions are for installing the Interstage BPMConsole on theWebLogic Application ServerVersion 9.2. Two different scenarios are presented in these instructions. In Case 1, the Console isdeployed in the sameWebLogic Server Domain as the Interstage BPMServer. In Case 2, the Consoleis deployed in a WebLogic Server Domain other than the one used by the Interstage BPM Server.To install the Interstage BPM Console on the WebLogic Application Server:1. Create a directory on your machine. For example purposes, the following directory will be used:

On UNIX or Linux:/opt/FJSVibpm/ibpmconsole

On Windows:c:\fujitsu\InterstageBPM\ibpmconsole

2. Copy ibpmconsole.war from the console directory of your Interstage BPM Console InstallationCD or CD Image to the directory that you just created on your machine.

3. Extract the files from ibpmconsole.war into the ibpmconsole directory. Use the following Javacommand:jar -xvf ibpmconsole.war


3: Installing the Interstage Business Process Manager Console

4. Copy iFlow.jar from the Interstage BPM Server to which you are connecting (usually at<Interstage BPM Server Installation Directory>/client/lib) to the <Interstage BPMConsole Installation Directory>/WEB-INF/lib directory.

5. Start the WebLogic Server Default Server with the following command:

# cd /usr/local/bea/user_projects/domains/base_domain/bin# ./startWebLogic.sh

The WebLogic Administration Server will start in a Console Window.

6. Start the Interstage BPM Server to which you want to connect in WebLogic with the followingcommand:

# cd /usr/local/bea/user_projects/domains/base_domain/bin# ./startManagedWebLogic.sh <Server Name>

If the default Server is used, the Interstage BPM Server would be started as follows:

# cd /usr/local/bea/user_projects/domains/base_domain/bin# ./startManagedWebLogic.sh IBPMServer

The Interstage BPM Server will start in a Console Window.

7. Open the WebLogic Admin Console by entering the following URL in you Web Browser:http://<HOSTNAME>:7001/console

The WebLogic Administration Console will open in your Web Browser.

8. Login to the WebLogic Administration Console.9. Deploy the Console on the WebLogic Application Server. See the Deploy Web Application topic

in the WebLogic Server Administration Console Help for instructions specific to the particularversion of WebLogic that you are using. To see instructions for deploying the Console(ibpmconsole) on theWebLogic Application Server Version 9.2 using theWebLogic AdministrationConsole, see Deploying the BPM Console using the WebLogic Administration Console on page15.The Console is deployed on the WebLogic Application Server.

10. If you will be using any of the Wf-XML 2.0-Based Functions listed in the following paragraphs,you must perform a special WebLogic Configuration. For instructions in performing thisconfiguration, see Special WebLogic Server Configurations to Enable Web Service Operationson page 22.Wf-XML-Based Functions• Download process definitions.• Upload process definitions.• Make Wf-XML 2.0 requests from external Wf-XML 2.0 Clients to the Interstage BPM Server.• Use Remote Subprocess whether Interstage BPM is the Server or the Client.Wf-XML-Based Functions on the Studio: Since the Studio uses the Interstage BPM Consolefor Wf-XML Functions, the followingWf-XML Functions performed on the Studio are listed becausethey also depend on this configuration (for instructions performing any of these functions, seethe Interstage BPM Studio Users Guide):• List process definitions stored in an Interstage BPM Server.• Retrieve a process definition from an Interstage BPM Server and display it in the Studio Target

Area.



• Save a process definition newly created or updated in the Studio to the Interstage BPM Server.

11. Access the Console at http://<hostname>:<port>/ibpmconsole. <hostname> is the machine nameof the computer upon which you have deployed the Interstage BPM Console. For Case 1, thedefault <port> is 49950. For Case 2, the default <port> is 7001.Since you just deployed the Console, this is your first access to the Interstage BPM Console, soyou will see a Console Configuration log in screen. You must configure the Console before youcan use it.

Figure 3: Console Configuration Login

12. Log in to the Console Configuration and configure the Console.For instructions, see Configuring the Console (Initial Access) on page 23.

13. Login to the Console and begin using it according to the Interstage BPM User's Guide.

3.1.1 Configuring aWebLogic 9.2 Domain for the Interstage BPMConsolePrerequisite: You have installed the WebLogic Application Server Version 9.2.

If you already have a WebLogic domain to which the Interstage BPM Console can bedeployed configured on the machine where you will be installing the Console, you do nothave to configure another one, so you don't have to perform the instructions in this topic.

Note:

You must have a WebLogic domain to which the Interstage BPM Console can be deployed. AWebLogic domain is a collection of resources, such as servers, clusters, database connections,security services, and J2EE applications that you manage as a unit.



You can create and configure a special WebLogic Server domain for the Console by running theWebLogic Domain Configuration Wizard. You can create and configure your domain at any timeafter installing the WebLogic Application Server but before installing the Console.For detailed instructions on creating and configuring WebLogic domains, refer to your WebLogicServer documentation.

If you want to use a pre-existing WebLogic domain for the Console (like the one that youconfigured for Interstage BPM), there is no need to create a WebLogic domain using theseinstructions. However, you must enter the existing domain's name and the path to itsWebLogic Configuration Directory manually on the Interstage BPM Server Configurationscreen when you install the Console.If this existing WebLogic domain is from a WebLogic version previous to 9.2, you mustupgrade it to WebLogic 9.2; make sure that the Run Quickstart checkbox is checked onthe final WebLogic Application Server installation screen. Then, select the Upgrade yourdomains to 9.2 option.

Note:

To create a WebLogic domain for the Interstage BPM Console:1. Start the WebLogic Domain Configuration Wizard as follows:

• Run the config.cmd script located in the <WL_HOME>/common/bin directory.TheWelcome page appears.

2. Make sure that the Create a new WebLogic domain checkbox is selected. Then, click Next.The Select Domain Source page appears.

3. Make sure that the Generate a domain configured automatically to support the followingBEA products andWebLogic Server (Required) check boxes are selected. Then, click Next.The Configure Administrator Username and Password page appears.

4. Enter a user name and password. This user becomes the initial administrative user for the domain.Then, click Next.The Configure Server Start Mode and JDK page appears.

5. Select the appropriate Java SDK and click Next:• On Solaris, select the SUN SDK.The Customize Environment and Services Settings page appears.

6. Select No and click Next.The Create WebLogic Configuration page appears.

7. In the Domain location field, specify a configuration location. By default,<BEA_HOME>/user_projects/domains is used. In the Domain name field, specify a name foryour name. By default, base_domain is used. Then, click Create.

You do not have to accept the default domain name or domain location. You can chooseany name or location for your new domain.

Note:

The Creating Domain page appears and will indicate the progress of your domain creation.

8. When your domain creation is completed, check the Start Admin Server checkbox and clickDone.

When your Admin Server appears, you are ready to deploy the Interstage BPM Console.



3.1.2 Deploying the BPM Console using the WebLogic AdministrationConsoleThese instructions are for deploying the Interstage BPMConsole on theWebLogic Application ServerVersion 9.2. Two different scenarios are presented in these instructions. In Case 1, the Console isdeployed in the sameWebLogic Server Domain as the Interstage BPMServer. In Case 2, the Consoleis deployed in a WebLogic Server Domain other than the one used by the Interstage BPM Server.1. In the left pane of the Administration Console, click Lock & Edit, so you can deploy the Console.

This action greys out the Lock & Edit button and makes the Release Configuration buttonavailable. TheWebLogic Administration Console is now in edit mode. TheWebLogic configurationcannot be changed unless you are in edit mode.

2. In the left pane of the Administration Console, click Deployments in the Domain Structure list.The Summary of Deployments page appears.

In Case 2, the Interstage BPM Server Application will not appear. The figure below is usingCase 2.

Note:

Figure 4: Summary of Deployments Page Before Deployment

3. In the right pane, click Install.



The Install Application Assistant page appears.

Figure 5: Locating the Console in the Install Application Assistant

4. Click the link for Location (prime1 is the link in the example) and navigate to the ibpmconsoledirectory.



The path displayed in Location is the default path to the ibpmconsole directory.

Figure 6: Navigating to ibpmconsole Directory

5. Check the ibpmconsole checkbox. Then, click Next.The Choose Targeting Style step of the Install Application Assistant is displayed.

6. Make sure that the Install this deployment as an application checkbox is checked. Then, clickNext.In Case 2, the Optional Settings step of the Install Application Assistant is displayed. In Case 1,you can skip the next step.

7. You don't need to make any optional settings, so click Next.8. For Case 1, check the InterstageBPMServer checkbox in the Servers list. For Case 2, you only

have the option of using the Admin Server, so no action is needed on this screen.



The figure below is for Case 1.Note:

Figure 7: Selecting a Server for the Console

9. For Case 1, click Next. For Case 2, click Finish.In Case 1, the Optional Settings step of the Install Application Assistant is displayed. In Case 2,you can skip the next step.

10. You don't need to make any optional settings, so click Next.11. Activate your deployment by clicking Activate Changes.

A message appears informing you that your changes have been activated.

12. Click Deployments in the Domain Structure list.Your newly deployed Web Application appears in the Deployments list.

13. For Case 1, make sure that your Interstage BPM Server is running because you will not be ableto start ibpmconsole if it is not running. You will be able to tell because the Server will be runningin a Console window just like the WebLogic Default Server.



14. Check the Selection box of ibpmconsole, then select Servicing all requests from the Startdrop-down list to the Web application.

Figure 8: Starting the ibpmconsole Web Application



15. Click Yes to confirm that you want to start the selected Web applications.

Figure 9: Confirming ibpmconsole Start



A page indicating that the deployment has started will appear.

Figure 10: ibpmconsole Started

3.1.3 UTF-8 Character SupportThe Servlet engine on which you run the Interstage BPM Console must be configured correctly tosend and receive UTF-8 characters in URL query parameters. This would be the standard way tosend and receive the Java character set. Many, but not all, Servlet engines may be configured thatway by default. For instance, if you are using TomCat 5.0, then you need to make sure that thecontainer setting in <Tomcat_Home>/conf/server.xml has the following attribute:URIEncoding="UTF-8". Please refer to your Servlet container documentation to assure that passedURI parameters are propertly interpreted as being UTF-8 encoded.The following is an example of adding the UTF-8 Attribute to server.xml:

<Connector URIEncoding="UTF-8" port="49950"

maxPostSize="0"...

If the Servlet engine in improperly configured, the you will get an error message displayed when youtry to use the Console.



3.1.4 Special WebLogic Server Configurations to Enable Web ServiceOperationsDeploy the Interstage BPM Console on the WebLogic Server before using the instructions in thistopic.

The instructions in this topic are needed only if you have deployed the Interstage BPMConsole on the WebLogic Server.

Note:

The instructions in this topic are needed if you want to perform the following operations:• Download or upload process definitions from remote Interstage BPM Servers.• Run remote subprocesses using SWAP (Simple Workflow Access Protocol) or ASAP

(Asynchronous Service Access Protocol).• Call Web Services from process definitions without specifying an endpoint URL.As an option to performing the instructions in this topic, you can enable the Web Service Operationslisted above by performing the instructions in the topic following this one Configuring WebLogic'sEmbedded LDAP Server on page 22.To enable the listed Web Services Operations :1. Stop the WebLogic Administration Server and Interstage BPM Server in which the Console is

running.2. Add the following tag block as the last block in the <security-configuration> tag block to the

<BEA_HOME>/user_projects/domains/base_domain/config/config.xml file for the WebLogicServer Domain in which the Interstage BPM Console is deployed:<enforce-valid-basic-auth-credentials>false</enforce-valid-basic-auth-credentials>

For example:

...<enforce-valid-basic-auth-credentials>false</enforce-valid-basic-auth-credentials>

</security-configuration>

3. Save the changes you have made to this file.4. Start the WebLogic Administration Server and Interstage BPM Server in which the Console is

configured.

The WebLogic configuration change described in these instructions effectively "turns off" WebLogicauthentication. For Interstage BPM purposes, WebLogic authentication is unnecessary because theConsole authenticates its users.

3.1.5 Configuring WebLogic's Embedded LDAP ServerIf you have performed the instructions in the previous topic Special WebLogic ServerConfigurations to Enable Web Service Operations on page 22, the instructions in this topicare unnecessary.

Note:

To configure the embedded LDAP Server, do one of the following:• Configure the Directory Service that you are using as an authentication provider for the embedded

LDAP Server.• Add the required users manually to the embedded LDAP Server.



If you want to run remote subprocesses, you need to add the owner of the parent process definition.If you want to call Interstage BPM Web Services from process definitions without specifying anendpoint URL, you need to add the Interstage BPM Administrator account. This is the accountthat you defined during the deployment of Interstage BPM Server.

For detailed instructions on how to configure the embedded LDAP Server, refer to the WebLogicApplication Server documentation.

3.1.6 Configuring the Console (Initial Access)Before you can access the Interstage BPMConsole for the first time, you must configure it to connectto your Interstage BPM Server.To configure the Console to connect to your Interstage BPM Server:1. The first time that you access the Interstage BPM Console you will be asked for your Console

Configuration password. This password is admin. Enter your Console Configuration password.Then, click Login.The Console Configuration page appears.

2. Select the EE Checkbox under Transport Type and make sure that WebLogic is selected in theTransport Type drop-down list.The Enterprise Edition version of the Configuration page appears.

3. In Case 1, the settings on this page will most likely be correct, and you need to enter only thelocation of your Interstage BPM Server Document Management System (DMS) Directory in theDMS Application Root field. This must be one of the Document Management System (DMS)Directories specified in the Interstage BPM Server Configuration. For information about specifyingDMSDirectories in the Server Configuration, see the Interstage BPMServer Administration Guide.

The DMS Directory specified for use as the DMS Application Root must be specified asending with a slash in the DMS configuration of the Interstage BPM Server for the Consoleto be able to use it as a DMS Application Root (and specify it in the DMS Application Rootfield on the Console Configuration page). For example if the DMS Directory used for theDMSApplication Root is /opt/FJSVibpm/server/instance/default/attachments, then the ServerDMS directory must be specified as/opt/FJSVibpm/server/instance/default/attachments/.

Note:

In Case 2, you must also change the name displayed in the Host Name field and the NamingProvider URL field to that of the machine where your Interstage BPM Server is installed. Use thefigure below as an example. In the example, prime1 is the name of the machine where InterstageBPM Server is installed.

4. Click Test Connection to make sure that your Console Configuration is correct.



If it is correct, the Console Configuration was tested successfully.message is displayed.If there is a problem with the configuration, an error message with diagnostic information willappear.

Figure 11: Testing the Console Configuration

5. Click Save to save the configuration.



If the configuration is saved correctly, the Console Configuration was saved successfully. messageis displayed.

Figure 12: Saving the Console Configuration

6. Click Login.The Interstage BPM Login page appears.

7. Enter your Interstage BPM User Name and Password and begin using the Console according tothe Interstage BPM Console User's Guide.

8. Change the value of the ServerEmailBaseURL parameter in the Interstage BPM ServerConfiguration to the following using the Interstage BPMEngine Configuration Page (for instructions,see the Interstage BPM Server Administration Guide):http://<ConsoleHost>:<ConsolePort>/ibpmconsole/System/

Example:http://docone:49950/ibpmconsole/System/

As an option to using the Interstage BPM Engine Configuration Page, the value of thisparameter can be changed using the Server Configuration page on the Console (Settings> Server Configuration). However, the Console must be installed and configured before youcan use this page. For instructions using the page, see the Interstage BPM Console User'sGuide.

Note:

Changing this value will make all of your Client-related URLs correct with regard to the Console.

9. Change the value of the ServerBaseURL parameter in the Interstage BPM Server Configurationto the following using the Interstage BPM Engine Configuration Page (for instructions, see theInterstage BPM Server Administration Guide):



http://<ConsoleHost>:<ConsolePort>/ibpmconsole/

Example:http://docone:49950/ibpmconsole/

As an option to using the Interstage BPM Engine Configuration Page, the value of thisparameter can also be changed using the Server Configuration page on the Console (Settings> Server Configuration). However, the Console must be installed and configured before youcan use this page. For instructions using the page, see the Interstage BPM Console User'sGuide.

Note:

Changing this value will make all of your Client-related URLs correct with regard to the ConsoleWeb Services.

10. If you want to use Decision Tables, make sure that the values in dtmconfig.properties (in the<Interstage BPM Console Installation Directory>/apps/System/web directory) are correct.If the values in dtmconfig.properties are incorrect, open dtmconfig.properties in any text editorand correct them. For instructions on editing the dtmconfig.properties file, see the InterstageBPM Console User's Guide.

Both the Interstage Server and Console must be installed on the same machine to useDecision Tables.

Note:

Your Interstage BPM Console is now configured correctly.

To change your configuration, select Settings > Console Configuration.

You must be an Interstage BPM Administrator to access the Console Configuration pageafter this initial configuration.If the Interstage BPM Server hostname has been changed, the following parameters mustbe updated to reflect the new hostname by navigating to the Console Configuration pageand using the instructions in this topic:

Note:

• Host Name• Naming Provider URL

3.2 Installing the Console on the JBoss Application ServerPrerequisite: Make sure that the Interstage BPMServer to which you will be connecting the Consoleis installed according to the instructions in the Interstage BPM Server Installation Guide (for theJBoss Server) and running on the JBoss Application Server and that it is of the version stated in theSystem Requirements. Also, make sure that the JBoss Application Server into which you will beinstalling the Console is installed and running and that it is also of the version stated in the SystemRequirements.

These instructions are for installing the Interstage BPM Console on the JBoss Application Serverand connecting it to an Interstage BPM Server running on the JBoss Application Server. Typically,the Console will be installed in IBPMServer, the JBoss Server created during the installation of theInterstage BPM Server.To install the Interstage BPM Console on the JBoss Application Server:1. Create a directory on your machine in the JBoss Installation Directories. This will be your Interstage

BPM Console Installation Directory. For example purposes, the following directory will be used:



On UNIX or Linux:<JBoss Installation Directory>/server/IBPMServer/deploy/ibpmconsole.war

On Windows:<JBoss Installation Directory>\server\IBPMServer\deploy\ibpmconsole.war

For example purposes, the IBPMServer directory was used because this is the JBoss Servercreated during the installation of the Interstage BPM Server. However, you could use anyserver under the server directory.

Note:

2. Copy ibpmconsole.war from the console directory of your Interstage BPM Console InstallationCD or CD Image to the directory that you just created on your machine.

3. Extract the files from ibpmconsole.war into the ibpmconsole.war directory. Use the followingJava command:jar -xvf ibpmconsole.war

4. Copy the following JBoss JAR Files from the <JBoss Installation Directory>/client directoryto the <Interstage BPM Console Installation Directory>/WEB-INF/lib directory:• jbossall-client.jar• jboss-common-client.jar• jboss-j2ee.jar• jboss-system-client.jar• jnp-client.jar

5. Copy iFlow.jar from the Interstage BPM Server to which you are connecting (usually at<Interstage BPM Server Installation Directory>/client/lib) to the <Interstage BPMConsole Installation Directory>/WEB-INF/lib directory.

6. Change the value of the ServerEmailBaseURL parameter in the ibpm.properties file on theInterstage BPM Server to the following:http://<ConsoleHost>:<ConsolePort>/<ContextRoot>/System/


The value of this parameter can also be changed using the Server Configuration page(Settings > Server Configuration).

Note:


7. Change the value of the ServerBaseURL parameter in the ibpm.properties file on the InterstageBPM Server to the following:http://<ConsoleHost>:<ConsolePort>/<ContextRoot>/



Note:




8. If you want to use Decision Tables, make sure that the values in dtmconfig.properties (in the<Interstage BPM Console Installation Directory>/apps/System/Web directory) are correct.If the values in dtmconfig.properties are incorrect, open dtmconfig.properties in any text editorand correct them. For instructions on editing the dtmconfig.properties file, see the InterstageBusiness Process Manager Console User's Guide.


Note:

9. Start the Interstage BPM Server with the following commands:

# cd <JBoss Installation Directory>/bin# ./runIBPM.sh (# run.bat on Windows)

The JBoss Server will start in a Console Window.

10. If you have installed the Console in a JBoss Server other that the one in which you have installedthe Interstage BPM Server, start that JBoss Server with the following command (if you are usingthe all JBoss Server:

# cd <JBoss Installation Directory>/bin# ./run.sh –Djava.net.preferIPv4Stack=true –c all (# run.bat on Windows)

The JBoss Server will start in a Console Window.

11. Access the Console at http://<hostname>:<port>/ibpmconsole. <hostname> is the machine nameof the computer upon which you have deployed the Interstage BPM Console. The default <port>is 49950.



Since you just deployed the Console, this is your first access to the Interstage BPM Console, soyou will see a Console Configuration log in screen. You must configure the Console before youcan use it.



13. Login to the Console and begin using it according to the Interstage BPM Console User's Guide.



2. Select the EE Checkbox under Transport Type and make sure that JBoss is selected in theTransport Type drop-down list.The Enterprise Edition version of the Configuration page appears.



3. The settings on this page will most likely be correct, and you need to enter only the location ofyour Interstage BPM Server Document Management System (DMS) Directory in the DMSApplication Root field. This must be one of the Document Management System (DMS) Directoriesspecified in the Interstage BPM Server Configuration. For information about specifying DMSDirectories in the Server Configuration, see the Interstage BPM Server Administration Guide.You may need to change the name displayed in the Host Name field or the port number in yourNaming Provider URL field depending on your Client-Server Configuration.

The DMS Directory specified for use as the DMS Application Root must be specified asending with a slash in the DMS configuration of the Interstage BPM Server for the Consoleto be able to use it as a DMS Application Root (and specify it in the DMS Application Rootfield on the Console Configuration page). For example if the DMS Directory used for theDMSApplication Root is /opt/FJSVibpm/server/instance/default/attachments, then the ServerDMS directory must be specified as/opt/FJSVibpm/server/instance/default/attachments/.

Note:

4. Click Test Connection to make sure that your Console Configuration is correct.If it is correct, the Console Configuration was tested successfully.message is displayed.If there is a problem with the configuration, an error message with diagnostic information willappear.

5. Click Save to save the configuration.If the configuration is saved correctly, the Console Configuration was saved successfully. messageis displayed.


7. Enter your Interstage BPM User Name and Password and begin using the Console according tothe Interstage BPM Console User's Guide.

8. Change the value of the ServerEmailBaseURL parameter in the Interstage BPM ServerConfiguration to the following using the Interstage BPMEngine Configuration Page (for instructions,see the Interstage BPM Server Administration Guide):http://<ConsoleHost>:<ConsolePort>/ibpmconsole/System/


As an option to using the Interstage BPM Engine Configuration Page, the value of thisparameter can be changed using the Server Configuration page on the Console (Settings> Server Configuration). However, the Console must be installed and configured before youcan use this page. For instructions using the page, see the Interstage BPM Console User'sGuide.

Note:


9. Change the value of the ServerBaseURL parameter in the Interstage BPM Server Configurationto the following using the Interstage BPM Engine Configuration Page (for instructions, see theInterstage BPM Server Administration Guide):http://<ConsoleHost>:<ConsolePort>/ibpmconsole/




As an option to using the Interstage BPM Engine Configuration Page, the value of thisparameter can also be changed using the Server Configuration page on the Console (Settings> Server Configuration). However, the Console must be installed and configured before youcan use this page. For instructions using the page, see the Interstage BPM Console User'sGuide.

Note:


10. If you want to use Decision Tables, make sure that the values in dtmconfig.properties (in the<Interstage BPM Console Installation Directory>/apps/System/web directory) are correct.If the values in dtmconfig.properties are incorrect, open dtmconfig.properties in any text editorand correct them. For instructions on editing the dtmconfig.properties file, see the InterstageBusiness Process Manager Console User's Guide.


Note:




Note:


3.2.2 Setting Up an Interstage BPM Console Cluster on JBossPrerequisite: Download and install the Apache 2.2.xWeb Server. Get the latest Apache2.2.x package(apache_2.2.8-win32-x86-no_ssl.msi) from Apache.org and install it on aWindows machine to whichyou have access from the Console Installations that you want to cluster together. No specialconfiguration is required. In the steps of this topic, <APACHE_HOME> will represent the ApacheWeb Server Installation Directory.

These instructions use the Apache Web Server to set up an Interstage BPM Console Cluster thatcan be used for load balancing.To set up an Interstage BPM Console Cluster:1. Set up the ApacheWeb Server to use mod_proxy (HTTP) by making sure that the related modules

are loaded. Do this by uncommenting the following lines in <APACHE_HOME>/conf/httpd.conf:

LoadModule proxy_module modules/mod_proxy.soLoadModule proxy_balancer_module modules/mod_proxy_balancer.soLoadModule proxy_http_module modules/mod_proxy_http.so

These modules are sufficient for HTTP load balancing.



2. Add the following lines to <APACHE_HOME>/conf/httpd.conf:

<Proxy balancer://mycluster>Order deny,allowAllow from all

BalancerMember http://host1:8080/ibpmconsole route=node1BalancerMember http:// host2:8080/ibpmconsole route=node2

</Proxy>

ProxyPass /ibpmconsole balancer://mycluster stickysession=JSESSIONIDnofailover=off

ProxyPassReverse /ibpmconsole http:// host1:8080/ibpmconsoleProxyPassReverse /ibpmconsole http:// host2:8080/ibpmconsole

Where host1 and host2 are the machines where the Interstage BPM Consoles (ibpmconsole)that you want to cluster are installed.You can find more information about <Proxy> attributes at the following URL:• http://httpd.apache.org/docs/2.2/mod/mod_proxy.html#proxy

3. Configure Tomcat to use an HTTP Session by editing <JBOSS_HOME>/server/<JBoss ServerWhere You Deployed ibpmconsole>/deploy/jbossweb-tomcat50.sar/server.xml file as follows:Locate the <Engine….> element and add a jvmRoute attribute.The <Engine….> element should look like the following when you have completed your addition:

<Engine name="jboss.web" defaultHost="localhost" jvmRoute="node1">.</Engine>

4. Configure the JBoss session to add jvmRoute to the sessions by editingJBOSS_HOME/server/<JBoss Server Where You Deployedibpmconsole>/deploy/jbossweb-tomcat50.sar/META-INF/jboss-service.xml as follows:Locate the <attribute> element with a name of UseJK, and set its value to true. Use the followingas an example:

<attribute name="UseJK">true</attribute>

The tomcat version can be 50 or 55 depending on the AS that you use.Note:

This change tells Tomcat to add the jvmRoute value to its session cookies so that mod_jk canroute incoming requests.

5. Access the Interstage BPM Console by entering the following URL in the Location field of yourbrowser:http://host0:port/ibpmconsole

host0 is the name of the machine where you configured the Apache Web Server.port is the web Server Port that you configured your Apache Web Server to use.

3.3 Installing theConsole on theWebSphereApplicationServerPrerequisite: Make sure that the WebSphere Application Server of the version stated in the SystemRequirements is properly installed and running on your machine. You must deploy the Console on



the same machine where the Interstage BPM Server is installed, the WebSphere Application Serverwas already installed as part of the installation of the Interstage BPM Enterprise Edition.Youmust set the following web container custom property to true using theWebSphere AdministrationConsole:com.ibm.ws.webcontainer.invokeFiltersCompatibility

For instructions, see Adding the Required Custom Property on page 40.

To install the Interstage BPM Console on the WebSphere Application Server:1. Create a new folder on the computer, and copy the following files/folders to it:

• ibpmconsole.war (from the Interstage BPM CD-Image\console\)• fujitsu-ibpm-engine-model-ejb.jar (from the Interstage BPM Server installation

directory\client\lib\)• META-INF folder (from Interstage BPM CD-Image\console\ibpmconsole-ear\)

2. To create ibpmconsole.ear, from this new folder run the following command:<JAVA_HOME>\jar.exe cvfm ibpmconsole.ear META-INF\MANIFEST.MF .

The ibpmconsole.ear will be created in the new folder.

3. Login to the WebSphere Administration Console if you have not already done so.4. Select Applications>Install New Application5. Click Browse and navigate to the location of the Interstage BPM Console EAR file

(ibpmconsole.ear).The Install New Application page should appear as follows:

Figure 14: Deploying ibpmconsole.ear

6. Click Next.A pop-up appears asking you to Please Wait... The Interstage BPM Console is being deployed.This could take several minutes. Please wait while it is being installed. When the deployment hascompleted, Step 1: Select installation options will appear.

7. Accept all defaults and click Next.



The Application Name should be fujitsu-console-ear.Note:

Step 2: Map modules to servers page appears.

Figure 15: Step 2: Mapping Modules to Servers

8. Select Integration and ibpmconsole and click Next.Step 3: Map virtual hosts for Web modules appears.

Figure 16: Step 3: Mapping Virtual Hosts for Web Modules

9. Select ibpmconsole and click Next.Step 4: Summary appears.

10. Click Finish to complete the installation.An installation status page appears along with a pop-up asking you to Please Wait... This couldtake several minutes. Status messages will begin to appear. The Interstage BPM Console isbeing deployed. Please wait while the Console is being deployed. When the deployment has



completed, the message Application fujitsu-console-ear installed successfully.appears.

Figure 17: Installation Status Page

11. Click the Save directly to Master Configuration link to save your changes.The Interstage BPMConsole will be saved as a newWeb Application in theWebSphere ApplicationServer. When saving is completed, the Preparing for the application installation page willre-appear.

12. Select Applications>Enterprise Applications.A list of Enterprise Applications appears.

13. Click the fujitsu-console-ear link.



The configuration page for the application appears.

Figure 18: Enterprise Application Configuration Page

14. Select the Class loading and update detection link.The class loader details page appears.

Figure 19: Enterprise Application Class Loader Details Page

15. In theWAR class loader policy section, select the Single class loader for application option,and click Apply. Save your changes.



The Enterprise Applications page is displayed. fujitsu-console-ear appears on the list witha red icon indicating that it has not been started.

Figure 20: Enterprise Applications Page with Console Not Started

16. Copy the iFlow.jar from the IBPM server (usually at <Interstage BPM Server InstallationDirectory>\client\lib) to the <Interstage BPM Console InstallationDirectory>\WEB-INF\lib directory.The Interstage BPM Console Installation Directory is normally under the <WebSphereInstallationDirectory>\profiles\<profile_name>\installedApps\<WebSphere_Cell_Name>\fujitsu-console-ear.ear\ibpmconsole.wardirectory.

17. Copy fujitsu-ibpm-engine-ejb.jarfromIBPM_HOME\server\deployment\InterstageBPMServerApplication.ear to\fujitsu-console-ear.ear\ibpmconsole.war\WEB-INF\lib.

18. Select fujitsu-console-ear and click Start to start the Interstage BPM Console application.



A pop-up asking you to PleaseWait... appears. This could take a fewminutes. When the InterstageBPM Console has started, the Enterprise Applications page appears with a message informingyou that the Console has started.

Figure 21: Enterprise Applications Page with Console Started

19. Change the value of the ServerEmailBaseURL parameter in the Interstage BPM ServerConfiguration to the following:http://<ConsoleHost>:<ConsolePort>/<ContextRoot>/System/



Note:


20. Change the value of the ServerBaseURL parameter in the Interstage BPM Server Configurationto the following:http://<ConsoleHost>:<ConsolePort>/<ContextRoot>/



Note:






Note:

22. Access the Console at http://<hostname>:<port>/ibpmconsole. <hostname> is the machine nameof the computer upon which you have deployed the Interstage BPM Console. For Case 1, thedefault <port> is 9080. For Case 2, the default <port> is 9080.Since you just deployed the Console, this is your first access to the Interstage BPM Console, soyou will see a Console Configuration log in screen. You must configure the Console before youcan use it.



24. Login to the Console and begin using it according to the Interstage BPM User's Guide.



3.3.1 Adding the Required Custom PropertyYou must install the Interstage BPM Server on the WebSphere Application Server before you canperform these instructions.

This Application Server setting must be made only the first time that you install the InterstageBPM Console. It is unnecessary on subsequent installations.

Note:

To add the required Custom Property to WebSphere and set it to true:1. Login to the WebSphere Administration Console if you have not already done so.2. Select Servers>Application Servers.3. Double-click the appropriate server link (e.g. server1) in the right pane.

This will display the following page:

Figure 23: server1 Configuration

4. Expand theWeb Container Settings folder. You can find this folder underAdditional Propertiesin the right pane. Then, double-click theWeb Container link.



This will display the followingWeb Container page:

Figure 24: Web Container for server1

5. Double-click Custom Properties.This displays the Custom Properties page.

6. Click New.A page appears allowing you to enter a new Custom Property.

7. Enter com.ibm.ws.webcontainer.invokeFiltersCompatibility in the Name field and truein the Value field.The new Custom Properties page appears as follows:

Figure 25: New Property on New Custom Properties Page

8. Double-click Apply.



The Custom Properties page will reappear with the new Custom Property displayed on it asfollows:

Figure 26: New Property on Custom Properties Page

3.4 Installing the Console on the Interstage Application ServerPrerequisite: Make sure that the Interstage Application Server of the version stated in the SystemRequirements is properly installed and running on your machine.

To install the Interstage BPM Console on the Interstage Application Server:1. Login to the Interstage Application Server Administration Console if you have not already done

so.2. Create a new work unit named BPMConsole.

For instructions on creating a new work unit, see the Interstage Application Server Users Guide.Make sure that the Type setting is IJServer (Web Only). Also, the Servlet Container Request URIencoding Setting should be UTF-8. There is no special configuration needed to have the InterstageBPM Console and Server on different machines.See the figure below for an example of a correct Work Unit page.

3. Copy ibpmconsole.war from the console directory on the Interstage BPM CD to any directoryon the network available to your Interstage Application Server machine. In the example,ibpmconsole.war is copied to E:\fujitsu on your local machine.

4. Use the Interstage Application Server Administration Console Deployment page to deploy theInterstage BPM Console (ibpmconsole.war) into the work unit referred to in Step 2 according tothe instructions in the Interstage Application Server User’s Guide. The figure below shows howyou would use this page to upload ibpmconsole.war located at E:\fujitsu on your local machine.Use the following instructions to deploy the Console in the Work Unit:a) Click the work unit in the navigation tree (left pane) in which you are deploying the Console.

BPMConsole is selected in the figure. The text is highlighted when it is selected.

b) Select the Deploy tab to display the Deploy Pane of the Work Unit.c) Make sure that the Upload a local file for deployment radio button is selected.



d) Click Browse and navigate to the ibpmconsole.war file that you copied to your local machinein the previous step of these instructions. Make sure that the path and file name appears inthe Browse field (shown in figure below).

e) Click Deploy to deploy the Interstage BPM Console into this Work Unit.Status messages will appear in the lower panel of the console. If the Interstage BPM Consoleis successfully deployed, a deployment completed message will appear.

Figure 27: Installing the Interstage BPM Console into a Work Unit

The Interstage Application Server will create an Interstage BPM Console Installation directory.

The Interstage BPM Console Installation directory is referred to in Steps 5 and 6 of theseinstructions.

Note:

If you are installing onWindows, the Interstage BPMConsole Installation directory will be createdat <Interstage Application Server InstallationDirectory>\J2EE\var\deployment\ijserver\BPMConsole\apps\ibpmconsole.war (assuming that thework unit name is BPMConsole).If you are installing on UNIX or Linux, the Interstage BPM Console Installation directory will becreated at <Interstage Application Server Installation



Directory>/FJSVj2ee/var/deployment/ijserver/BPMConsole/apps/ibpmconsole.war (assumingthat the work unit name is BPMConsole).

5. Copy iFlow.jar from the Interstage BPM Server (usually at <Interstage BPM ServerInstallation Directory>\client\lib) to the following directories:On Windows:• <Interstage BPM Console Installation Directory>\WEB-INF\lib• <Interstage BPM Console Installation Directory>\apps\System\web\libOn Solaris:• <Interstage BPM Console Installation Directory>/WEB-INF/lib• <Interstage BPM Console Installation Directory>/apps/System/web/lib

6. Copy fujitsu-ibpm-engine-ejb_jar_client.jar from the <Interstage Application ServerInstallationDirectory>\J2EE\var\deployment\ijserver\Interstage_BPM\distribute\fujitsu-ibpm-engine.ear\fujitsu-ibpm-engine-ejb.jardirectory (where Interstage_BPM is the Work Unit Name of the Interstage BPM Server) to thefollowing directory:On Windows:• <Interstage BPM Console Installation Directory>\WEB-INF\libOn Solaris:• <Interstage BPM Console Installation Directory>/WEB-INF/lib

7. Restart the Interstage BPM Console by restarting the Work Unit into which you installed theConsole as follows.a) Click the work unit in the navigation tree (left pane) in which you are deploying the Console.

BPMConsole is selected in the figure. The text is highlighted when it is selected.

b) Select the Status tab to display the Status Pane of the Work Unit.c) Click Stop to stop the Work Unit.

Status messages will appear in the lower panel of the console. If the Interstage BPM Consoleis successfully stopped, a Work Unit Stopped message will appear.

d) Click Start to start the Work Unit.Status messages will appear in the lower panel of the console. If the Interstage BPM Consoleis successfully started, a Work Unit Started message will appear.

The Work Unit has now been restarted, and the Console deployment will take effect.

8. Access the Console at http://<hostname>:<port>/ibpmconsole. <hostname> is the machine nameof the computer upon which you have deployed the Interstage BPM Console. For Case 1, thedefault <port> is 49950. For Case 2, the default <port> is 7001.



Since you just deployed the Console, this is your first access to the Interstage BPM Console, soyou will see a Console Configuration log in screen. You must configure the Console before youcan use it.



10. Login to the Console.11. Change the value of the ServerEmailBaseURL parameter in the Interstage BPM Server

Configuration to the following:http://<ConsoleHost>:<ConsolePort>/<ContextRoot>/System/



Note:


12. Change the value of the ServerBaseURL parameter in the Interstage BPM Server Configurationto the following:http://<ConsoleHost>:<ConsolePort>/<ContextRoot>/

Example:



http://docone:49950/ibpmconsole/


Note:




Note:

14. Begin using the Console according to the Interstage BPM User's Guide.



2. Select the EE Checkbox under Transport Type and make sure that Interstage is selected inthe Transport Type drop-down list.The Enterprise Edition version of the Configuration page appears.

3. The settings on this page will most likely be correct, and you need to enter only the location ofyour Interstage BPMServer Document Management System (DMS) Directory in the DMSDirectoryfield. This must be the same value that you entered on the Document Management System (DMS)Directory screen when you installed Interstage BPM.

The DMS Directory specified for use as the DMS Application Root must be configured asa DMS Directory in the Interstage BPM Server Configuration for the Console to be able touse it as a DMS Application Root. For example if the DMS Directory used for the DMSApplication Root is /opt/FJSVibpm/server/instance/default/attachments, then one of theDocument Management System (DMS) directories configured in your Interstage BPMServermust be /opt/FJSVibpm/server/instance/default/attachments/.

Note:

4. Click Test Connection to make sure that your Console Configuration is correct.



If it is correct, the Console Configuration was tested successfully.message is displayed.If there is a problem with the configuration, an error message with diagnostic information willappear.

Figure 29: Testing the Console Configuration

5. Click Save to save the configuration.



If the configuration is saved correctly, the Console Configuration was saved successfully. messageis displayed.

Figure 30: Saving the Console Configuration


7. Enter your Interstage BPM User Name and Password and begin using the Console according tothe Interstage BPM User's Guide.




Note:


3.5 Configuring the SOAP ListenerBefore you can configure the SOAP Listener, you must make sure that your Interstage BPM Serverand Console are running properly and that you are logged in to the Console. For instructions, seethe previous topics in this Guide.



To configure the SOAP Listener:1. Check to make sure that the services required for SOAPMessaging are available with the following

instructions:a) Enter the following URL in the Location field of your browser:

http://<host>:<port>/<context-root>/soapindex.html

Example:http://ConsoleHost:49950/ibpmconsole/soapindex.html

b) If no page is displayed, the SOAP Services are not available, so you must start them by runningthe following batch file:<Interstage BPM Console>/apps/System/web/soap/soaplisteners_start.bat onWindows or<Interstage BPM Console>/apps/System/web/soap/soaplisteners_start.sh onUNIX.

In case you need to stop the SOAP services, run the following batch file:<Interstage BPM Console>/apps/System/web/soap/soaplisteners_stop.bat onWindows or<Interstage BPM Console>/apps/System/web/soap/soaplisteners_stop.sh on UNIX.

Note:

You may need to update the following in the startup and stop scripts before running themNote:• JAVA_HOME, SOAPLISTENER_CLASSES, and SOAPLISTENER_LIB properties• MACHINE_NAME and port numbers in all URLs

c) Click Run.The Apache SOAP Admin page appears.

d) Click List.If the required services are available, a page appears that lists the following services:• urn.POClientListener• urn.HRClientListener

2. Update the file <Interstage BPM Console>/apps/System/web/soap/iflowsoap.propertiesby replacing the <Interstage BPM Console> tag with your Console Installation path.

3. Update your Client authentication by making the following changes in the file <Interstage BPMConsole>/apps/System/web/soap/clientlisteners.xml:• <servertype> “EE” for Enterprise Edition, “RMI” for AE Edition• <servername> <Server-Host>Flow• <userid> userid to be used to log in to the Server• <password>password to be used to log in to the Server

4. Update the log file location by replacing <Interstage BPM Console InstallationDirectory>/apps/System/web/soap/with path to the SOAP directory in the log4j.propertiesfile.

5. Make sure that the following files are in the CLASSPATH of the Web Container in which theConsole is deployed:



If you are installing the Console on the Interstage Application Server, this step is unnecessary.Note:

• iFlowClient.properties• iflowsoap.properties• iFlow.jar

6. Restart the Web Container.

3.6 Using the InterstageBPMCommand InterfaceWebServicesThere are three types of Web Services used in Interstage BPM:• Wf XML Web Services (SOAP)• Command Interface Web Services (SOAP)• Web Services for the Interstage BPM Studio (RESTful)Only the Command Interface Web Services are discussed in this section.The Interstage BPMCommand InterfaceWeb Services should be deployed as part of the deploymentof the Interstage BPM Console. This topic explains how you check the proper operation of the WebServices and how you might use them to access Interstage BPM from a different application usingWeb Services.

3.6.1 Verifying Command Interface Web Services OperationTo verify Command Interface Web Services Operation:1. Log in to the Interstage BPM Console.2. Enter the following URL in the Address field of your browser to open the Home Page for the

embedded Apache-AXIS Engine:http://<hostname>:<port>/<context root>/wsindex.html

Example:http://iasee:49950/ibpmconsole/wsindex.html

The Home Page for the embedded Apache-AXIS Engine should be displayed.

3. Click Visit.This will open the list of the Web Services deployed on the Apache-AXIS Engine including theInterstage BPM Command Interface Web Services.You should see an IFWebServices entry withWeb Services listed under it. These are the InterstageBPMCommand InterfaceWeb Services. Their appearance on this list confirms that the InterstageBPM Web Services are deployed and available for use.

4. Click the wsdl link next to the IFWebServices entry.This will open the definition page for the Interstage BPMWeb Services written in theWeb ServiceDefinition Language (WSDL). This is also known as the Interstage BPM Web Services WSDL.

5. Look at this page to see the precise WSDL definitions for all the available Interstage BPM WebServices.

6. Note the address of the WSDL (as you will be using it in the instructions below). It should be thefollowing:http://<hostname>:<port>/<context root>/services/IFWebServices?wsdl

Example:



http://iasee:49950/ibpmconsole/services/IFWebServices?wsdl

7. If the Interstage BPM Command Interface Web Services cannot be verified, they either failed tostart during the installation of the Interstage BPM Console or the Web Services have beenundeployed by running undeployibpmws.sh. In either case, you must start the Web Services asfollows:

The Web Services Undeployment Script (undeployibpmws.sh) and the Web ServicesDeployment Script (deployibpmws.sh) are located in the Interstage BPMConsole InstallationDirectory.

Note:

a) Check the following parameters in the Web Services Deployment Script to make sure thatthey are set properly.:• JAVA_HOME: This should be the same JAVA_HOME that is used by the Application Server

upon which you have deployed the Console.• Port: This should be the same port that is used by the Interstage BPM Console. You will

probably have to change this value before running the Web Services Deployment Scriptas follows:The following URL is displayed in the Web Services Deployment Scripthttp://localhost:48850/ibpmconsole/services/AdminService

48850 must be changed to the port number used by the Interstage BPM Console.

b) Run the Web Services Deployment Script (<Interstage BPM Console InstallationDirectory>/deployibpmws.sh on Solaris, <Interstage BPM Console InstallationDirectory>/deployibpmws.bat on Windows) to start (deploy) the Web Services.

This should start the Web Services. Verify Web Services operation by repeating Steps 1-6 of thistopic.

3.6.2 Invoking the Command Interface Web ServicesTo invoke the Interstage BPM Web Services, you will need a Web Service Client and provide it withthe address of the WSDL. The following are examples of Web Services Clients that could be usedto invoke the Interstage BPM Web Services:• XMLSpy Enterprise Edition• Interstage BPM’s Web Service Java Action• Programmatically using the Java APIsHow you specify the WSDL address, select the operation, provide input parameters, send the webservice request and receive the response depends on the Web Service client that you use.For more information on the Command Interface Web Services, seeWeb Services Interfaces onpage 58.

3.6.3 Invoking Web Services Using XMLSpyThis topic provides instructions in how you might invoke the Interstage BPM Command InterfaceWeb Services using XMLSpy.To invoke Web Services using XMLSpy:1. Specify the WSDL Address as follows:

a) Select Create new SOAP request from the SOAP menu.The Please enter the WSDL file location message box appears.



b) Enter the Interstage BPM Web Services WSDL URL (noted earlier) in the Choose a file fieldand click OK.

XMLSpy retrieves the WSDL and identifies the operations available by displaying them in a list.These are the Interstage BPM Command Interface Web Services operations.

2. Select an operation to invoke from the displayed list and click OK.The operation selected in the example is getMyTemplateList. This operation should retrieve theprocess definitions owned by the user specified in the following step.

Figure 31: List of Operations with getMyTemplateList Selected

XMLSpy creates and displays a template of the web service request.

3. Fill in the request parameters in0 and in1 with the Interstage BPM username and password ofthe user for which you want to perform the operation. In the following example, you would replaceString within the in0 and in1 tags with iflow, the username and iflow123, the password.



4. Select Send request to server from the SOAP Menu.

Figure 32: Sending the Web Services Request to the Server



Interstage BPM processes the Web Services Request and sends a response to XMLSpy. Theweb service response shows the results of the operation. In the example, the list of processdefinitions owned by the user specified in the previous step is displayed.

Figure 33: Web Services Response: Process Definitions List

3.7 Uninstalling the Interstage Business Process ManagerConsoleThe Interstage BPMConsole is aWeb Application, so what you are actually doing when you uninstallthe Console is undeploying theWeb Application. The instructions for undeploying the Console dependon the Web Container into which you deployed it.See the following for specific instructions:• For detailed instructions on undeploying the Console from the Tomcat Server, see the Undeploy

an Existing Application topic in the Tomcat Documentation. For an example of undeploying theConsole from the Tomcat Server, see Undeploying the Console from the Tomcat Server.

• For detailed instructions on undeploying the Console from the WebLogic Server, see the DeleteWeb applications topic in the WebLogic Server Administration Console Help. For an example ofundeploying the Console from the WebLogic Server, see Uninstalling the Console from the BEAWebLogic Server on page 55.



3.7.1 Uninstalling the Console from the BEA WebLogic ServerYou must have the Console deployed on the WebLogic Server to use these instructions.

To uninstall or undeploy the Interstage BPM Console from your machine, you must delete theibpmconsole Web Application in the WebLogic Application Server Administration Console. Thefollowing example instructions can be used for deleting the ibpmconsole Web Application in theWebLogic Application Server Version 9.2:1. Log in to the WebLogic Server Administration Console like you did when you deployed the

Interstage BPM Console. See Installing the Console on the BEA WebLogic Server on page 11for instructions.

2. If you have not already done so, in the Change Center of the Administration Console, click Lock& Edit.

3. In the left pane of the Administration Console, select Deployments.4. Make sure that the ibpmconsole Web application is stopped. You will not be able to uninstall it if

it is running. For instructions, see theWebLogic Server Console Help topic for starting and stoppingan application.

5. In the right pane, select the check box next to the ibpmconsole Web application.6. Click Delete.7. Click Yes to confirm your decision.8. To activate these changes, in the Change Center of the Administration Console, click Activate

Changes.The Console (ibpmconsole) Web Application will disappear from the Deployments page.

9. Delete the installation files from the Interstage BPM Console Installation directory. If you haveapplications installed in the Interstage BPM Console, be sure to back them up before you deletethese files.

The Interstage BPM Console is now deleted (undeployed) from WebLogic Server.

3.7.2 Uninstalling the Console from the JBoss Application ServerYou must have the Console deployed on the JBoss Application Server to use these instructions.

If you have deployed the Console in the same JBoss Server as the Interstage BPM Serverand want to uninstall the Server, uninstalling the Server will simultaneously uninstall theConsole.

Note:

To uninstall or undeploy the Interstage BPM Console from your machine, you must delete theibpmconsole Web Application directory. The following example instructions can be used:1. Make sure that the JBoss Server in which the Console has been deployed is stopped.2. Delete the Interstage BPM Console Installation Directory (ibpmconsole.war). This is the directory

that you created when you installed the Console.

The Interstage BPM Console is now deleted (undeployed) from the JBoss Server.

3.7.3 Uninstalling the Console from the WebSphere Application ServerYoumust have the Console installed on theWebSphere Application Server to use these instructions.

To uninstall or undeploy the Interstage BPM Console from your machine:1. Select Applications>Enterprise Applications.



A list of Enterprise Applications appears. ibpmconsole_war appears on the list.

Figure 34: Enterprise Applications Page

2. Select ibpmconsole_war and click Stop to stop the Interstage BPM Console application.A pop-up asking you to Please Wait... appears. When the Interstage BPM Console has stopped,a red icon appears on the ibpmconsole row indicating that the Console has stopped.

Figure 35: Enterprise Applications Page with Console Stopped

3. Select ibpmconsole_war and clickUninstall to uninstall the Interstage BPMConsole application.A confirmation page appears.

4. Click OK to confirm that you want to remove (uninstall) the Interstage BPM Console.



A pop-up asking you to PleaseWait... appears. This could take a fewminutes. When the InterstageBPM Console has been removed, the Enterprise Applications page re-appears showing that theConsole has been removed and with links that allow you to either save or review the changesyou have made.

Figure 36: Enterprise Applications Page with Console Removed

5. Click Save to save your changes directly to the master configuration.The Interstage BPM Console has now been uninstalled from the WebSphere Application Server.

3.7.4 Uninstalling the Console from the Interstage Application ServerYou must have the Console installed on the Interstage Application Server to use these instructions.

To uninstall or undeploy the Interstage BPM Console from your machine:1. Navigate to the Application Status tab in the work unit upon which you installed the Interstage

BPM Console. Select ibpmconsole.war from the Module List and click Undeploy.All of the contents of the ibpmconsole.war installation directory (e.g., <Interstage ApplicationServer InstallationDirectory>\J2EE\var\deployment\ijserver\BPMConsole\apps\ibpmconsole.war) will bedeleted. This includes the Interstage BPM Console Configuration Settings.



Appendix A: Web Services InterfacesA.1 Web Services Interface

The Web Services Interface offers operations for the following Interstage BPM objects:• Process definitions• Process instances• Work items

A.1.1 WSDL File of the Web Services InterfaceWSDL file address: http://<server name>:<portnumber=49950>/ibpmconsole/services/IFWebServices?wsdl

<wsdl:definitions targetNamespace="http://www.fsw.fujitsu.com">

<wsdl:types>

<schema elementFormDefault="qualified"targetNamespace="http://www.fsw.fujitsu.com">

<element name="getUserData">

<complexType>

<sequence><element name="in0" type="xsd:string"/><element name="in1" type="xsd:string"/><element name="in2" type="xsd:long"/>

</sequence></complexType>

</element>

<element name="getUserDataResponse">

<complexType>

<sequence><element maxOccurs="unbounded" name="getUserDataReturn"

type="impl:UdaStruct"/></sequence>

</complexType></element>

<complexType name="UdaStruct">

<sequence><element name="name" type="xsd:string"/><element name="type" type="xsd:string"/><element name="value" type="xsd:string"/>


<element name="getMyTemplateList">

<complexType>


Appendix A: Web Services Interfaces

<sequence><element name="in0" type="xsd:string"/><element name="in1" type="xsd:string"/>


</element>

<element name="getMyTemplateListResponse">

<complexType>

<sequence><element maxOccurs="unbounded" name="getMyTemplateListReturn"

type="impl:ObjList"/></sequence>


<complexType name="ObjList">

<sequence><element name="name" type="xsd:string"/><element name="id" type="xsd:long"/>


<element name="startProcess">

<complexType>



</element>

<element name="startProcessResponse">

<complexType>

<sequence><element name="startProcessReturn" type="xsd:long"/>


</element>

<element name="getTemplateState">

<complexType>



</element>



<element name="getTemplateStateResponse">

<complexType>

<sequence><element name="getTemplateStateReturn" type="xsd:string"/>


</element>

<element name="getMyProcessList">

<complexType>



</element>

<element name="getMyProcessListResponse">

<complexType>

<sequence><element maxOccurs="unbounded" name="getMyProcessListReturn"



<element name="addUserDataItem">

<complexType>

<sequence><element name="in0" type="xsd:string"/><element name="in1" type="xsd:string"/><element name="in2" type="xsd:long"/><element name="in3" type="xsd:string"/><element name="in4" type="xsd:string"/><element name="in5" type="xsd:string"/>


</element>

<element name="addUserDataItemResponse">

<complexType>

<sequence><element name="addUserDataItemReturn" type="xsd:boolean"/>


</element>

<element name="modifyUserDataItem">

<complexType>



<sequence><element name="in0" type="xsd:string"/><element name="in1" type="xsd:string"/><element name="in2" type="xsd:long"/><element name="in3" type="xsd:string"/><element name="in4" type="xsd:string"/>


</element>

<element name="modifyUserDataItemResponse">

<complexType>

<sequence><element name="modifyUserDataItemReturn" type="xsd:boolean"/>


</element>

<element name="getAttachmentList">

<complexType>



</element>

<element name="getAttachmentListResponse">

<complexType>

<sequence><element maxOccurs="unbounded" name="getAttachmentListReturn"

type="xsd:string"/></sequence>


<element name="getProcessState">

<complexType>



</element>

<element name="getProcessStateResponse">

<complexType>

<sequence>



<element name="getProcessStateReturn" type="xsd:string"/></sequence>


<element name="getMyWorkItemList">

<complexType>



</element>

<element name="getMyWorkItemListResponse">

<complexType>

<sequence><element maxOccurs="unbounded" name="getMyWorkItemListReturn"



<element name="getWorkItemChoices">

<complexType>



</element>

<element name="getWorkItemChoicesResponse">

<complexType>

<sequence><element maxOccurs="unbounded" name="getWorkItemChoicesReturn"

type="xsd:string"/></sequence>


<element name="submitWorkItem">

<complexType>

<sequence><element name="in0" type="xsd:string"/><element name="in1" type="xsd:string"/><element name="in2" type="xsd:long"/><element name="in3" type="xsd:string"/>




</element>

<element name="submitWorkItemResponse">

<complexType>

<sequence><element name="submitWorkItemReturn" type="xsd:boolean"/>


</element>

<element name="getWorkItemState">

<complexType>



</element>

<element name="getWorkItemStateResponse">

<complexType>

<sequence><element name="getWorkItemStateReturn" type="xsd:string"/>


</element></schema>

</wsdl:types>

<wsdl:message name="getWorkItemChoicesResponse"><wsdl:part element="impl:getWorkItemChoicesResponse" name="parameters"/>

</wsdl:message>

<wsdl:message name="getTemplateStateResponse"><wsdl:part element="impl:getTemplateStateResponse" name="parameters"/>

</wsdl:message>

<wsdl:message name="getProcessStateRequest"><wsdl:part element="impl:getProcessState" name="parameters"/>

</wsdl:message>

<wsdl:message name="getMyTemplateListResponse"><wsdl:part element="impl:getMyTemplateListResponse" name="parameters"/>

</wsdl:message>

<wsdl:message name="getAttachmentListRequest"><wsdl:part element="impl:getAttachmentList" name="parameters"/>

</wsdl:message>

<wsdl:message name="getMyWorkItemListRequest"><wsdl:part element="impl:getMyWorkItemList" name="parameters"/>



</wsdl:message>

<wsdl:message name="submitWorkItemRequest"><wsdl:part element="impl:submitWorkItem" name="parameters"/>

</wsdl:message>

<wsdl:message name="getMyProcessListRequest"><wsdl:part element="impl:getMyProcessList" name="parameters"/>

</wsdl:message>

<wsdl:message name="startProcessResponse"><wsdl:part element="impl:startProcessResponse" name="parameters"/>

</wsdl:message>

<wsdl:message name="getTemplateStateRequest"><wsdl:part element="impl:getTemplateState" name="parameters"/>

</wsdl:message>

<wsdl:message name="startProcessRequest"><wsdl:part element="impl:startProcess" name="parameters"/>

</wsdl:message>

<wsdl:message name="getUserDataRequest"><wsdl:part element="impl:getUserData" name="parameters"/>

</wsdl:message>

<wsdl:message name="addUserDataItemRequest"><wsdl:part element="impl:addUserDataItem" name="parameters"/>

</wsdl:message>

<wsdl:message name="modifyUserDataItemRequest"><wsdl:part element="impl:modifyUserDataItem" name="parameters"/>

</wsdl:message>

<wsdl:message name="getWorkItemStateRequest"><wsdl:part element="impl:getWorkItemState" name="parameters"/>

</wsdl:message>

<wsdl:message name="submitWorkItemResponse"><wsdl:part element="impl:submitWorkItemResponse" name="parameters"/>

</wsdl:message>

<wsdl:message name="getWorkItemChoicesRequest"><wsdl:part element="impl:getWorkItemChoices" name="parameters"/>

</wsdl:message>

<wsdl:message name="getProcessStateResponse"><wsdl:part element="impl:getProcessStateResponse" name="parameters"/>

</wsdl:message>

<wsdl:message name="getUserDataResponse"><wsdl:part element="impl:getUserDataResponse" name="parameters"/>

</wsdl:message>

<wsdl:message name="getWorkItemStateResponse"><wsdl:part element="impl:getWorkItemStateResponse" name="parameters"/>

</wsdl:message>

<wsdl:message name="addUserDataItemResponse">



<wsdl:part element="impl:addUserDataItemResponse" name="parameters"/>

</wsdl:message>

<wsdl:message name="getMyProcessListResponse"><wsdl:part element="impl:getMyProcessListResponse" name="parameters"/>

</wsdl:message>

<wsdl:message name="getMyWorkItemListResponse"><wsdl:part element="impl:getMyWorkItemListResponse" name="parameters"/>

</wsdl:message>

<wsdl:message name="getMyTemplateListRequest"><wsdl:part element="impl:getMyTemplateList" name="parameters"/>

</wsdl:message>

<wsdl:message name="modifyUserDataItemResponse"><wsdl:part element="impl:modifyUserDataItemResponse" name="parameters"/>

</wsdl:message>

<wsdl:message name="getAttachmentListResponse"><wsdl:part element="impl:getAttachmentListResponse" name="parameters"/>

</wsdl:message>

<wsdl:portType name="IFWebServices">

<wsdl:operation name="getUserData"><wsdl:input message="impl:getUserDataRequest"

name="getUserDataRequest"/><wsdl:output message="impl:getUserDataResponse"

name="getUserDataResponse"/></wsdl:operation>

<wsdl:operation name="getMyTemplateList"><wsdl:input message="impl:getMyTemplateListRequest"

name="getMyTemplateListRequest"/><wsdl:output message="impl:getMyTemplateListResponse"

name="getMyTemplateListResponse"/></wsdl:operation>

<wsdl:operation name="startProcess"><wsdl:input message="impl:startProcessRequest"

name="startProcessRequest"/><wsdl:output message="impl:startProcessResponse"

name="startProcessResponse"/></wsdl:operation>

<wsdl:operation name="getTemplateState"><wsdl:input message="impl:getTemplateStateRequest"

name="getTemplateStateRequest"/><wsdl:output message="impl:getTemplateStateResponse"

name="getTemplateStateResponse"/></wsdl:operation>

<wsdl:operation name="getMyProcessList"><wsdl:input message="impl:getMyProcessListRequest"

name="getMyProcessListRequest"/>



<wsdl:output message="impl:getMyProcessListResponse"name="getMyProcessListResponse"/>

</wsdl:operation>

<wsdl:operation name="addUserDataItem"><wsdl:input message="impl:addUserDataItemRequest"

name="addUserDataItemRequest"/><wsdl:output message="impl:addUserDataItemResponse"

name="addUserDataItemResponse"/></wsdl:operation>

<wsdl:operation name="modifyUserDataItem"><wsdl:input message="impl:modifyUserDataItemRequest"

name="modifyUserDataItemRequest"/><wsdl:output message="impl:modifyUserDataItemResponse"

name="modifyUserDataItemResponse"/></wsdl:operation>

<wsdl:operation name="getAttachmentList"><wsdl:input message="impl:getAttachmentListRequest"

name="getAttachmentListRequest"/><wsdl:output message="impl:getAttachmentListResponse"

name="getAttachmentListResponse"/></wsdl:operation>

<wsdl:operation name="getProcessState"><wsdl:input message="impl:getProcessStateRequest"

name="getProcessStateRequest"/><wsdl:output message="impl:getProcessStateResponse"

name="getProcessStateResponse"/></wsdl:operation>

<wsdl:operation name="getMyWorkItemList"><wsdl:input message="impl:getMyWorkItemListRequest"

name="getMyWorkItemListRequest"/><wsdl:output message="impl:getMyWorkItemListResponse"

name="getMyWorkItemListResponse"/></wsdl:operation>

<wsdl:operation name="getWorkItemChoices"><wsdl:input message="impl:getWorkItemChoicesRequest"

name="getWorkItemChoicesRequest"/><wsdl:output message="impl:getWorkItemChoicesResponse"

name="getWorkItemChoicesResponse"/></wsdl:operation>

<wsdl:operation name="submitWorkItem"><wsdl:input message="impl:submitWorkItemRequest"

name="submitWorkItemRequest"/><wsdl:output message="impl:submitWorkItemResponse"

name="submitWorkItemResponse"/></wsdl:operation>

<wsdl:operation name="getWorkItemState"><wsdl:input message="impl:getWorkItemStateRequest"

name="getWorkItemStateRequest"/><wsdl:output message="impl:getWorkItemStateResponse"

name="getWorkItemStateResponse"/></wsdl:operation>

</wsdl:portType>



<wsdl:binding name="IFWebServicesSoapBinding" type="impl:IFWebServices">

<wsdlsoap:binding style="document"transport="http://schemas.xmlsoap.org/soap/http"/>

<wsdl:operation name="getUserData"><wsdlsoap:operation soapAction=""/>

<wsdl:input name="getUserDataRequest"><wsdlsoap:body use="literal"/>

</wsdl:input>

<wsdl:output name="getUserDataResponse"><wsdlsoap:body use="literal"/>

</wsdl:output></wsdl:operation>

<wsdl:operation name="getMyTemplateList"><wsdlsoap:operation soapAction=""/>

<wsdl:input name="getMyTemplateListRequest"><wsdlsoap:body use="literal"/>

</wsdl:input>

<wsdl:output name="getMyTemplateListResponse"><wsdlsoap:body use="literal"/>


<wsdl:operation name="startProcess"><wsdlsoap:operation soapAction=""/>

<wsdl:input name="startProcessRequest"><wsdlsoap:body use="literal"/>

</wsdl:input>

<wsdl:output name="startProcessResponse"><wsdlsoap:body use="literal"/>


<wsdl:operation name="getTemplateState"><wsdlsoap:operation soapAction=""/>

<wsdl:input name="getTemplateStateRequest"><wsdlsoap:body use="literal"/>

</wsdl:input>

<wsdl:output name="getTemplateStateResponse"><wsdlsoap:body use="literal"/>


<wsdl:operation name="getMyProcessList"><wsdlsoap:operation soapAction=""/>

<wsdl:input name="getMyProcessListRequest"><wsdlsoap:body use="literal"/>

</wsdl:input>

<wsdl:output name="getMyProcessListResponse">



<wsdlsoap:body use="literal"/></wsdl:output>

</wsdl:operation>

<wsdl:operation name="addUserDataItem"><wsdlsoap:operation soapAction=""/>

<wsdl:input name="addUserDataItemRequest"><wsdlsoap:body use="literal"/>

</wsdl:input>

<wsdl:output name="addUserDataItemResponse"><wsdlsoap:body use="literal"/>


<wsdl:operation name="modifyUserDataItem"><wsdlsoap:operation soapAction=""/>

<wsdl:input name="modifyUserDataItemRequest"><wsdlsoap:body use="literal"/>

</wsdl:input>

<wsdl:output name="modifyUserDataItemResponse"><wsdlsoap:body use="literal"/>


<wsdl:operation name="getAttachmentList"><wsdlsoap:operation soapAction=""/>

<wsdl:input name="getAttachmentListRequest"><wsdlsoap:body use="literal"/>

</wsdl:input>

<wsdl:output name="getAttachmentListResponse"><wsdlsoap:body use="literal"/>


<wsdl:operation name="getProcessState"><wsdlsoap:operation soapAction=""/>

<wsdl:input name="getProcessStateRequest"><wsdlsoap:body use="literal"/>

</wsdl:input>

<wsdl:output name="getProcessStateResponse"><wsdlsoap:body use="literal"/>


<wsdl:operation name="getMyWorkItemList"><wsdlsoap:operation soapAction=""/>

<wsdl:input name="getMyWorkItemListRequest"><wsdlsoap:body use="literal"/>

</wsdl:input>

<wsdl:output name="getMyWorkItemListResponse"><wsdlsoap:body use="literal"/>




<wsdl:operation name="getWorkItemChoices"><wsdlsoap:operation soapAction=""/>

<wsdl:input name="getWorkItemChoicesRequest"><wsdlsoap:body use="literal"/>

</wsdl:input>

<wsdl:output name="getWorkItemChoicesResponse"><wsdlsoap:body use="literal"/>


<wsdl:operation name="submitWorkItem"><wsdlsoap:operation soapAction=""/>

<wsdl:input name="submitWorkItemRequest"><wsdlsoap:body use="literal"/>

</wsdl:input>

<wsdl:output name="submitWorkItemResponse"><wsdlsoap:body use="literal"/>


<wsdl:operation name="getWorkItemState"><wsdlsoap:operation soapAction=""/>

<wsdl:input name="getWorkItemStateRequest"><wsdlsoap:body use="literal"/>

</wsdl:input>

<wsdl:output name="getWorkItemStateResponse"><wsdlsoap:body use="literal"/>


</wsdl:binding>

<wsdl:service name="IFWebServicesService">

<wsdl:port binding="impl:IFWebServicesSoapBinding" name="IFWebServices">

<wsdlsoap:addresslocation="http://myibpmhost:49950/ibpmconsole/services/IFWebServices"/>

</wsdl:port></wsdl:service>

</wsdl:definitions>

A.1.2 Process Definition Operations

getMyTemplateListRetrieves a list of all the process definitions belonging to the user specified in the request. The listof process definitions including names and IDs is returned in the response message.



Sample Request

<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:fsw="http://www.fsw.fujitsu.com"><soapenv:Body><fsw:getMyTemplateList><fsw:in0>SomeUserName</fsw:in0><fsw:in1>SomePassword</fsw:in1>

</fsw:getMyTemplateList></soapenv:Body>

</soapenv:Envelope>

Elements of the Request• fsw:in0: Name of the user who owns the process definitions.• fsw:in1: Password of the user.Sample Response

<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><soapenv:Body><getMyTemplateListResponse xmlns="http://www.fsw.fujitsu.com"><getMyTemplateListReturn><name>Simple Process Definition</name><id>7</id>

</getMyTemplateListReturn><getMyTemplateListReturn><name>Simple Process Definition</name><id>18</id>

</getMyTemplateListReturn><getMyTemplateListReturn><name>Vacation Request</name><id>40</id>

</getMyTemplateListReturn></getMyTemplateListResponse>

</soapenv:Body></soapenv:Envelope>

If the user has no process definitions, the following response is returned:

...<getMyTemplateListResponse xmlns="http://www.fsw.fujitsu.com"><getMyTemplateListReturn xsi:nil="true"/>

</getMyTemplateListResponse>...

getTemplateStateLets the user retrieve the current state of the specified process definition.Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:fsw="http://www.fsw.fujitsu.com"><soapenv:Body><fsw:getTemplateState><fsw:in0>SomeUserName</fsw:in0>



<fsw:in1>SomePassword</fsw:in1><fsw:in2>40</fsw:in2>

</fsw:getTemplateState></soapenv:Body>

</soapenv:Envelope>

Elements of the Request• fsw:in0: Name of an Interstage BPM user.• fsw:in1: Password of the user.• fsw:in2: Process definition ID.Sample Response

<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><soapenv:Body><getTemplateStateResponse xmlns="http://www.fsw.fujitsu.com"><getTemplateStateReturn>DRAFT</getTemplateStateReturn>

</getTemplateStateResponse></soapenv:Body>

</soapenv:Envelope>

startProcessStarts a process instance from a specified process definition ID and returns the process instanceID.Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:fsw="http://www.fsw.fujitsu.com"><soapenv:Body><fsw:startProcess><fsw:in0>SomeUserName</fsw:in0><fsw:in1>SomePassword</fsw:in1><fsw:in2>50</fsw:in2>

</fsw:startProcess></soapenv:Body>

</soapenv:Envelope>

Elements of the Request• fsw:in0: Name of an Interstage BPM user.• fsw:in1: Password of the user.• fsw:in2: Process definition ID.Sample Response

<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><soapenv:Body><startProcessResponse xmlns="http://www.fsw.fujitsu.com"><startProcessReturn>522</startProcessReturn>

</startProcessResponse>




A.1.3 Process Instance Operations

getMyProcessListRetrieves the list of process instances belonging to the user specified in the request. The list ofprocess instance names and IDs is returned in the response message.Sample Request

<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:fsw="http://www.fsw.fujitsu.com"><soapenv:Body><fsw:getMyProcessList><fsw:in0>SomeUserName</fsw:in0><fsw:in1>SomePassword</fsw:in1>

</fsw:getMyProcessList></soapenv:Body>

</soapenv:Envelope>

Elements of the Request• fsw:in0: Name of the user who owns the process instances.• fsw:in1: Password of the user.Sample Response

<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><soapenv:Body><getMyProcessListResponse xmlns="http://www.fsw.fujitsu.com"><getMyProcessListReturn><name>Vacation Request</name><id>522</id>

</getMyProcessListReturn></getMyProcessListResponse>


If the user has no process instances, the following response is returned:

...<getMyProcessListResponse xmlns="http://www.fsw.fujitsu.com"><getMyProcessListReturn xsi:nil="true"/>

</getMyProcessListResponse>...

getUserDataRetrieves values of all User Defined Attributes (UDAs) associated with the specified process instance.The UDA names and values are returned in the response message.



Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:fsw="http://www.fsw.fujitsu.com"><soapenv:Body><fsw:getUserData><fsw:in0>SomeUserName</fsw:in0><fsw:in1>SomePassword</fsw:in1><fsw:in2>522</fsw:in2>

</fsw:getUserData></soapenv:Body>

</soapenv:Envelope>

Elements of the Request• fsw:in0: Name of an Interstage BPM user.• fsw:in1: Password of the user.• fsw:in2: Process instance ID.Sample Response

<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><soapenv:Body><getUserDataResponse xmlns="http://www.fsw.fujitsu.com"><getUserDataReturn><name>EmployeeName</name><type>STRING</type><value></value>

</getUserDataReturn><getUserDataReturn><name>EmployeeAddress</name><type>STRING</type><value></value>

</getUserDataReturn></getUserDataResponse>


addUserDataItemAdds a new User Defined Attribute (UDA) to the specified process instance. The return valuedetermines if the call was successful or not.Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:fsw="http://www.fsw.fujitsu.com"><soapenv:Body><fsw:addUserDataItem><fsw:in0>SomeUserName</fsw:in0><fsw:in1>SomePassword</fsw:in1><fsw:in2>522</fsw:in2><fsw:in3>Info</fsw:in3><fsw:in4>STRING</fsw:in4><fsw:in5>Some additional information</fsw:in5>

</fsw:addUserDataItem>




Elements of the Request• fsw:in0: Name of an Interstage BPM user.• fsw:in1: Password of the user.• fsw:in2: Process instance ID.• fsw:in3: Name of the UDA to be added.• fsw:in4: Data type of the UDA: BIGDECIMAL, BOOLEAN, DATE, FLOAT, INTEGER, LONG,

STRING.• fsw:in5: Value of the UDA.Sample Response

<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><soapenv:Body><addUserDataItemResponse xmlns="http://www.fsw.fujitsu.com"><addUserDataItemReturn>true</addUserDataItemReturn>

</addUserDataItemResponse></soapenv:Body>

</soapenv:Envelope>

modifyUserDataItemChanges the value of an existing User Defined Attribute (UDA) of the specified process instance.The return value determines if the call was successful or not.Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:fsw="http://www.fsw.fujitsu.com"><soapenv:Body><fsw:modifyUserDataItem><fsw:in0>SomeUserName</fsw:in0><fsw:in1>SomePassword</fsw:in1><fsw:in2>522</fsw:in2><fsw:in3>Info</fsw:in3><fsw:in5>Some new information</fsw:in5>

</fsw:modifyUserDataItem></soapenv:Body>

</soapenv:Envelope>

Elements of the Request• fsw:in0: Name of an Interstage BPM user.• fsw:in1: Password of the user.• fsw:in2: Process instance ID.• fsw:in3: Name of an existing UDA.• fsw:in4: Value of the UDA that is to be set.



Sample Response

<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><soapenv:Body><modifyUserDataItemResponse xmlns="http://www.fsw.fujitsu.com"><modifyUserDataItemReturn>true</modifyUserDataItemReturn>

</modifyUserDataItemResponse></soapenv:Body>

</soapenv:Envelope>

getAttachmentListRetrieves a list of attachments associated with the specified process instance.Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:fsw="http://www.fsw.fujitsu.com"><soapenv:Body><fsw:getAttachmentList><fsw:in0>SomeUserName</fsw:in0><fsw:in1>SomePassword</fsw:in1><fsw:in2>522</fsw:in2>

</fsw:getAttachmentList></soapenv:Body>

</soapenv:Envelope>


<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><soapenv:Body><getAttachmentListResponse xmlns="http://www.fsw.fujitsu.com"><getAttachmentListReturn>Billing information</getAttachmentListReturn>

<getAttachmentListReturn>Customer record</getAttachmentListReturn></getAttachmentListResponse>


If the process instance has no attachments, the following response is returned:

<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><soapenv:Body><getAttachmentListResponse xmlns="http://www.fsw.fujitsu.com"/>




getProcessStateRetrieves the current state of the specified process instance.Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:fsw="http://www.fsw.fujitsu.com"><soapenv:Body><fsw:getProcessState><fsw:in0>SomeUserName</fsw:in0><fsw:in1>SomePassword</fsw:in1><fsw:in2>522</fsw:in2>

</fsw:getProcessState></soapenv:Body>

</soapenv:Envelope>


<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><soapenv:Body><getProcessStateResponse xmlns="http://www.fsw.fujitsu.com"><getProcessStateReturn>RUNNING</getProcessStateReturn>

</getProcessStateResponse></soapenv:Body>

</soapenv:Envelope>

A.1.4 Work Item Operations

getMyWorkItemListRetrieves a list of all the work items assigned to the user specified in the request. The work itemnames and IDs are returned in the response message.Sample Request

<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:fsw="http://www.fsw.fujitsu.com"><soapenv:Body><fsw:getMyWorkItemList><fsw:in0>SomeUserName</fsw:in0><fsw:in1>SomePassword</fsw:in1>

</fsw:getMyWorkItemList></soapenv:Body>

</soapenv:Envelope>



Elements of the Request• fsw:in0: Name of an Interstage BPM user.• fsw:in1: Password of the user.Sample Response

<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><soapenv:Body><getMyWorkItemListResponse xmlns="http://www.fsw.fujitsu.com"><getMyWorkItemListReturn><name>Send Purchase Order</name><id>533</id>

</getMyWorkItemListReturn><getMyWorkItemListReturn><name>Send Purchase Order</name><id>567</id>

</getMyWorkItemListReturn></getMyWorkItemListResponse>


If the user has no work items, the following response is returned:

<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><soapenv:Body><getMyWorkItemListResponse xmlns="http://www.fsw.fujitsu.com"><getMyWorkItemListReturn xsi:nil="true"/>

</getMyWorkItemListResponse></soapenv:Body>

</soapenv:Envelope>

getWorkItemChoicesRetrieves a list of work item choices. The list of work item choices associated with the specified workitem is returned in the response message.Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:fsw="http://www.fsw.fujitsu.com"><soapenv:Body><fsw:getWorkItemChoices><fsw:in0>SomeUserName</fsw:in0><fsw:in1>SomePassword</fsw:in1><fsw:in2>567</fsw:in2>

</fsw:getWorkItemChoices></soapenv:Body>

</soapenv:Envelope>

Elements of the Request• fsw:in0: Name of an Interstage BPM user.• fsw:in1: Password of the user.



• fsw:in2: Work item ID.Sample Response

<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><soapenv:Body><getWorkItemChoicesResponse xmlns="http://www.fsw.fujitsu.com"><getWorkItemChoicesReturn>Approve</getWorkItemChoicesReturn>

</getWorkItemChoicesResponse></soapenv:Body>

</soapenv:Envelope>

submitWorkItemMakes a choice in submitting an assigned work item. The return value specifies whether the operationwas successful.Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:fsw="http://www.fsw.fujitsu.com"><soapenv:Body><fsw:submitWorkItem><fsw:in0>SomeUserName</fsw:in0><fsw:in1>SomePassword</fsw:in1><fsw:in2>567</fsw:in2><fsw:in3>Approve</fsw:in3>

</fsw:submitWorkItem></soapenv:Body>

</soapenv:Envelope>

Elements of the Request• fsw:in0: Name of an Interstage BPM user.• fsw:in1: Password of the user.• fsw:in2: Work item ID.• fsw:in3: Work item choice.Sample Response

<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><soapenv:Body><submitWorkItemResponse xmlns="http://www.fsw.fujitsu.com"><submitWorkItemReturn>true</submitWorkItemReturn>

</submitWorkItemResponse></soapenv:Body>

</soapenv:Envelope>

getWorkItemStateRetrieves the current state of the specified work item.



Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:fsw="http://www.fsw.fujitsu.com"><soapenv:Body><fsw:getWorkItemState><fsw:in0>SomeUserName</fsw:in0><fsw:in1>SomePassword</fsw:in1><fsw:in2>533</fsw:in2>

</fsw:getWorkItemState></soapenv:Body>

</soapenv:Envelope>

Elements of the Request• fsw:in0: Name of an Interstage BPM user.• fsw:in1: Password of the user.• fsw:in2: Work item ID.Sample Response

<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><soapenv:Body><getWorkItemStateResponse xmlns="http://www.fsw.fujitsu.com"><getWorkItemStateReturn>ACTIVE</getWorkItemStateReturn>

</getWorkItemStateResponse></soapenv:Body>

</soapenv:Envelope>

A.2 Asynchronous Web Services InterfacesThis section contains the WSDL documents describing the Asynchronous Web Services Interfacesand a description of the available operations.

A.2.1 WSDL File of the Server-Level Web Services InterfaceWSDL file address: http://<server name>:<portnumber=49950>/ibpmconsole/System/ServReg.jsp?wsdl

<?xml version="1.0" encoding="UTF-8" ?><wsd:definitions xmlns:asxsd="http://www.oasis-open.org/asap/0.9/asap.xsd"xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"xmlns:tns="http://myibpmhost:49950/ibpm/jsp/ServReg.jsp?wsdl"xmlns:wsd="http://schemas.xmlsoap.org/wsdl/"xmlns:xsd="http://www.w3.org/2001/XMLSchema"targetNamespace="http://myibpmhost:49950/ibpmconsole/System/ServReg.jsp?wsdl">

<wsd:types><xsd:schema xmlns:as="http://www.oasis-open.org/asap/0.9/asap.xsd"

elementFormDefault="qualified"targetNamespace="http://www.oasis-open.org/asap/0.9/asap.xsd"xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<xsd:element name="Request"><xsd:complexType>



<xsd:sequence><xsd:element minOccurs="0" name="SenderKey" type="xsd:anyURI"

/><xsd:element name="ReceiverKey" type="xsd:anyURI" /><xsd:element minOccurs="0" name="ResponseRequired"

type="as:YesNoIfError" /><xsd:element minOccurs="0" name="RequestID" type="xsd:anyURI"

/></xsd:sequence>

</xsd:complexType></xsd:element><xsd:simpleType name="YesNoIfError"><xsd:restriction base="xsd:string"><xsd:enumeration value="Yes" /><xsd:enumeration value="No" /><xsd:enumeration value="IfError" />

</xsd:restriction></xsd:simpleType><xsd:element name="Response"><xsd:complexType><xsd:sequence><xsd:element name="SenderKey" type="xsd:anyURI" />

<xsd:element minOccurs="0" name="ReceiverKey" type="xsd:anyURI"/>

<xsd:element minOccurs="0" name="RequestID" type="xsd:anyURI"/>

</xsd:sequence></xsd:complexType>

</xsd:element><xsd:complexType name="processDefinitionType"><xsd:sequence><xsd:element name="ProcessLanguage" type="xsd:string" /><xsd:element name="Definition"><xsd:complexType><xsd:sequence><xsd:any minOccurs="0" namespace="##any"

processContents="lax" /></xsd:sequence>

</xsd:complexType></xsd:element>

</xsd:sequence></xsd:complexType><xsd:element name="NewDefinitionRq" type="as:processDefinitionType"

/><xsd:element name="NewDefinitionRs" type="as:processDefinitionType"

/><xsd:element name="ListDefinitionsRq" /><xsd:element name="ListDefinitionsRs"><xsd:complexType><xsd:sequence><xsd:element maxOccurs="unbounded" minOccurs="0"

ref="as:DefinitionInfo" /></xsd:sequence>

</xsd:complexType></xsd:element><xsd:element name="DefinitionInfo"><xsd:complexType><xsd:sequence><xsd:element name="DefinitionKey" type="xsd:anyURI" /><xsd:element minOccurs="0" name="Name" type="xsd:string" />

<xsd:element minOccurs="0" name="Description" type="xsd:string"



/><xsd:element minOccurs="0" name="Version" type="xsd:string"

/><xsd:element minOccurs="0" name="Status"

type="as:DefinitionStatusType" /></xsd:sequence>

</xsd:complexType></xsd:element><xsd:simpleType name="DefinitionStatusType"><xsd:restriction base="xsd:string"><xsd:enumeration value="Draft" /><xsd:enumeration value="Published" /><xsd:enumeration value="Obsolete" /><xsd:enumeration value="Private" /><xsd:enumeration value="Deleted" />

</xsd:restriction></xsd:simpleType>

</xsd:schema></wsd:types><wsd:message name="RequestHeader"><wsd:part element="asxsd:Request" name="head" />

</wsd:message><wsd:message name="ResponseHeader"><wsd:part element="asxsd:Response" name="head" />

</wsd:message><wsd:message name="ListDefinitionsRequest"><wsd:part element="asxsd:ListDefinitionsRq" name="body" />

</wsd:message><wsd:message name="ListDefinitionsResponse"><wsd:part element="asxsd:ListDefinitionsRs" name="body" />

</wsd:message><wsd:message name="NewDefinitionRequest"><wsd:part element="asxsd:NewDefinitionRq" name="body" />

</wsd:message><wsd:message name="NewDefinitionResponse"><wsd:part element="asxsd:NewDefinitionRs" name="body" />

</wsd:message><wsd:portType name="Registry_PortType"><wsd:operation name="ListDefinitions"><wsd:input message="tns:ListDefinitionsRequest" /><wsd:output message="tns:ListDefinitionsResponse" />

</wsd:operation><wsd:operation name="NewDefinition"><wsd:input message="tns:NewDefinitionRequest" /><wsd:output message="tns:NewDefinitionResponse" />

</wsd:operation></wsd:portType><wsd:binding name="Registry_Binding" type="tns:Registry_PortType"><soap:binding style="document"

transport="http://schemas.xmlsoap.org/soap/http" /><wsd:operation name="ListDefinitions">



<soap:operation /><wsd:input><soap:body parts="body" use="literal" />

<soap:header message="tns:RequestHeader" part="head" use="literal"/>

</wsd:input><wsd:output><soap:body parts="body" use="literal" />

<soap:header message="tns:ResponseHeader" part="head" use="literal"/>

</wsd:output></wsd:operation><wsd:operation name="NewDefinition"><soap:operation /><wsd:input><soap:body parts="body" use="literal" />

<soap:header message="tns:RequestHeader" part="head" use="literal"/>

</wsd:input><wsd:output><soap:body parts="body" use="literal" />

<soap:header message="tns:ResponseHeader" part="head" use="literal"/>

</wsd:output></wsd:operation>

</wsd:binding><wsd:service name="Registry_Service"><wsd:port binding="tns:Registry_Binding" name="Registry_Port"><soap:address

location="http://myibpmhost:49950/ibpmconsole/System/ServReg.jsp" /></wsd:port>

</wsd:service></wsd:definitions>

A.2.2 Operations of the Server-Level Web Services Interface

listDefinitionsReturns information on each of the currently available process instances. The response returns thelatest version of the process definition URIs that are enabled for process instance creation.

newDefinitionCreates a new process definition.

A.2.3 WSDL File of the Process-Level Web Services InterfaceWSDL file address: http://<server name>:<portnumber=49950>/ibpmconsole/System/ProcDef.jsp?planName=<process definitionname>&ver=<version number>&wsdl



The WSDL file describing a process definition is generated automatically. The following is a samplefor a process definition called Vacation Request having the User Defined Attributes EmployeeNameand EmployeeAddress.

<?xml version="1.0" encoding="UTF-8" ?><wsd:definitions xmlns:asxsd="http://www.oasis-open.org/asap/0.9/asap.xsd"xmlns:soapbind="http://schemas.xmlsoap.org/wsdl/soap/"xmlns:tns="http://myibpmhost:49950/ibpm/jsp/ProcDef.jsp?planName=Vacation+Request&ver=2.0&wsdl"xmlns:wsd="http://schemas.xmlsoap.org/wsdl/"xmlns:xsd="http://www.w3.org/2001/XMLSchema"targetNamespace="http://myibpmhost:49950/ibpmconsole/System/ProcDef.jsp?planName=Vacation+Request&ver=2.0&wsdl">

<wsd:types><xsd:schema xmlns:as="http://www.oasis-open.org/asap/0.9/asap.xsd"

elementFormDefault="qualified"targetNamespace="http://www.oasis-open.org/asap/0.9/asap.xsd"xmlns:xsd="http://www.w3.org/2001/XMLSchema">



<xsd:complexType name="schemaType"><xsd:sequence><xsd:any namespace="##other" />

</xsd:sequence><xsd:attribute name="href" type="xsd:anyURI" />

</xsd:complexType><xsd:simpleType name="YesNoIfError"><xsd:restriction base="xsd:string"><xsd:enumeration value="Yes" /><xsd:enumeration value="No" /><xsd:enumeration value="IfError" />

</xsd:restriction></xsd:simpleType><xsd:element name="Request"><xsd:complexType><xsd:sequence><xsd:element minOccurs="0" name="SenderKey" type="xsd:anyURI"

/><xsd:element name="ReceiverKey" type="xsd:anyURI" /><xsd:element minOccurs="0" name="ResponseRequired"

type="as:YesNoIfError" /><xsd:element minOccurs="0" name="RequestID" type="xsd:anyURI"

/></xsd:sequence>

</xsd:complexType></xsd:element><xsd:element name="Response"><xsd:complexType><xsd:sequence><xsd:element name="SenderKey" type="xsd:anyURI" />

<xsd:element minOccurs="0" name="ReceiverKey" type="xsd:anyURI"/>

<xsd:element minOccurs="0" name="RequestID" type="xsd:anyURI"/>


</xsd:element>



<xsd:group name="factoryPropertiesGroup"><xsd:sequence><xsd:element name="Key" type="xsd:anyURI" /><xsd:element name="Name" type="xsd:string" /><xsd:element name="Subject" type="xsd:string" /><xsd:element name="Description" type="xsd:string" /><xsd:element name="ContextDataSchema" type="as:schemaType" /><xsd:element name="ResultDataSchema" type="as:schemaType" /><xsd:element name="Expiration" type="xsd:duration" />

</xsd:sequence></xsd:group><xsd:element name="GetPropertiesRq" /><xsd:element name="GetPropertiesRs"><xsd:complexType><xsd:choice><xsd:group ref="as:factoryPropertiesGroup" />

</xsd:choice></xsd:complexType>

</xsd:element><xsd:element name="CreateInstanceRs"><xsd:complexType><xsd:sequence><xsd:element name="InstanceKey" type="xsd:anyURI" />


</xsd:element><xsd:complexType name="FilterType"><xsd:simpleContent><xsd:extension base="xsd:string"><xsd:attribute name="filterType" type="xsd:NMTOKEN" />

</xsd:extension></xsd:simpleContent>

</xsd:complexType><xsd:element name="ListInstancesRq"><xsd:complexType><xsd:sequence><xsd:element name="Filter" type="as:FilterType" />


</xsd:element><xsd:element name="Instance"><xsd:complexType><xsd:sequence><xsd:element name="InstanceKey" type="xsd:anyURI" /><xsd:element minOccurs="0" name="Name" type="xsd:string" /><xsd:element minOccurs="0" name="Subject" type="xsd:string"

/><xsd:element minOccurs="0" name="Priority" type="xsd:int" />


</xsd:element><xsd:element name="ListInstancesRs"><xsd:complexType><xsd:sequence><xsd:element maxOccurs="unbounded" minOccurs="0"

ref="as:Instance" /></xsd:sequence>




<xsd:complexType name="processDefinitionType"><xsd:sequence><xsd:element name="ProcessLanguage" type="xsd:string" /><xsd:element name="Definition"><xsd:complexType><xsd:sequence><xsd:any minOccurs="0" namespace="##any"

processContents="lax" /></xsd:sequence>


</xsd:sequence></xsd:complexType><xsd:element name="GetDefinitionRq"><xsd:complexType><xsd:sequence><xsd:element name="ProcessLanguage" type="xsd:string" />


</xsd:element><xsd:element name="GetDefinitionRs" type="as:processDefinitionType"

/><xsd:element name="SetDefinitionRq" type="as:processDefinitionType"

/><xsd:element name="SetDefinitionRs" type="as:processDefinitionType"

/><xsd:element name="CreateInstanceRq"><xsd:complexType><xsd:sequence><xsd:element name="StartImmediately" type="xsd:boolean" />

<xsd:element minOccurs="0" name="ObserverKey" type="xsd:anyURI"/>

<xsd:element minOccurs="0" name="Name" type="xsd:string" /><xsd:element minOccurs="0" name="Subject" type="xsd:string"

/><xsd:element minOccurs="0" name="Description" type="xsd:string"

/><xsd:element name="ContextData"><xsd:complexType><xsd:sequence><xsd:element minOccurs="0" name="EmployeeName"

type="xsd:string" /><xsd:element minOccurs="0" name="EmployeeAddress"

type="xsd:string" /></xsd:sequence>



</xsd:element></xsd:schema>

</wsd:types><wsd:message name="RequestHeader"><wsd:part element="asxsd:Request" name="head" />

</wsd:message><wsd:message name="ResponseHeader"><wsd:part element="asxsd:Response" name="head" />

</wsd:message><wsd:message name="CreateInstanceRequest"><wsd:part element="asxsd:CreateInstanceRq" name="body" />

</wsd:message>



<wsd:message name="CreateInstanceResponse"><wsd:part element="asxsd:CreateInstanceRs" name="body" />

</wsd:message><wsd:message name="ListInstancesRequest"><wsd:part element="asxsd:ListInstancesRq" name="body" />

</wsd:message><wsd:message name="ListInstancesResponse"><wsd:part element="asxsd:ListInstancesRs" name="body" />

</wsd:message><wsd:message name="GetPropertiesRequest"><wsd:part element="asxsd:GetPropertiesRq" name="body" />

</wsd:message><wsd:message name="GetPropertiesResponse"><wsd:part element="asxsd:GetPropertiesRs" name="body" />

</wsd:message><wsd:message name="GetDefinitionRequest"><wsd:part element="asxsd:GetDefinitionRq" name="body" />

</wsd:message><wsd:message name="GetDefinitionResponse"><wsd:part element="asxsd:GetDefinitionRs" name="body" />

</wsd:message><wsd:message name="SetDefinitionRequest"><wsd:part element="asxsd:SetDefinitionRq" name="body" />

</wsd:message><wsd:message name="SetDefinitionResponse"><wsd:part element="asxsd:SetDefinitionRs" name="body" />

</wsd:message><wsd:portType name="Vacation RequestFactory_PortType"><wsd:operation name="CreateInstance"><wsd:input message="tns:CreateInstanceRequest" /><wsd:output message="tns:CreateInstanceResponse" />

</wsd:operation><wsd:operation name="ListInstances"><wsd:input message="tns:ListInstancesRequest" /><wsd:output message="tns:ListInstancesResponse" />

</wsd:operation><wsd:operation name="GetProperties"><wsd:input message="tns:GetPropertiesRequest" /><wsd:output message="tns:GetPropertiesResponse" />

</wsd:operation><wsd:operation name="GetDefinition"><wsd:input message="tns:GetDefinitionRequest" /><wsd:output message="tns:GetDefinitionResponse" />

</wsd:operation><wsd:operation name="SetDefinition"><wsd:input message="tns:SetDefinitionRequest" /><wsd:output message="tns:SetDefinitionResponse" />

</wsd:operation></wsd:portType><wsd:binding name="Vacation RequestFactory_Binding" type="tns:Vacation

RequestFactory_PortType">



<soapbind:binding style="document"transport="http://schemas.xmlsoap.org/soap/http" />

<wsd:operation name="CreateInstance"><soapbind:operation /><wsd:input><soapbind:header message="tns:RequestHeader" part="head"

use="literal" /><soapbind:body parts="body" use="literal" />

</wsd:input><wsd:output><soapbind:header message="tns:ResponseHeader" part="head"


</wsd:output></wsd:operation><wsd:operation name="ListInstances"><soapbind:operation /><wsd:input><soapbind:header message="tns:RequestHeader" part="head"




</wsd:output></wsd:operation><wsd:operation name="GetProperties"><soapbind:operation /><wsd:input><soapbind:header message="tns:RequestHeader" part="head"




</wsd:output></wsd:operation><wsd:operation name="GetDefinition"><soapbind:operation /><wsd:input><soapbind:header message="tns:RequestHeader" part="head"




</wsd:output></wsd:operation><wsd:operation name="SetDefinition"><soapbind:operation /><wsd:input><soapbind:header message="tns:RequestHeader" part="head"


</wsd:input>



<wsd:output><soapbind:header message="tns:ResponseHeader" part="head"


</wsd:output></wsd:operation>

</wsd:binding><wsd:service name="Vacation RequestFactory_Service"><wsd:port binding="tns:Vacation RequestFactory_Binding" name="Vacation

RequestFactory_Port"><soapbind:address

location="http://myibpmhost:49950/ibpmconsole/System/ProcDef.jsp?planName=Vacation+Request&ver=2.0"/>

</wsd:port></wsd:service>

</wsd:definitions>

A.2.4 Operations of the Process-Level Web Services Interface

getPropertiesProvides a description of what User Defined Attributes should be passed in the createInstancerequest.

createInstanceCreates a new process instance of a process definition.

getDefinitionRetrieves the definition of a particular process definition in XPDL.

setDefinitionSets the definition of a process definition from an XPDL file. The XPDL passed in the request is thesame that is returned in the response. Thus it does not reflect the latest process definition. Thereturned XPDL is only a means for the confirmation that the XPDL sent in the request was received.

listInstancesLists the process instances created from a process definition.

A.3 Fault MessagesWhen an error occurs, a SOAP fault message is returned. soapenv:Server.generalException isreturned as the fault code for any error. The fault string contains a specific error message, and thedetail element provides additional information relevant to the error. The following is an example ofa fault message:

<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">



<soapenv:Body><soapenv:Fault><faultcode>soapenv:Server.generalException</faultcode><faultstring>Error in Web Service to get process list for ibpm.

{Unable to authenticate user 'ibpm'. Either the User name or the Passwordis incorrect. {Unable to authenticate user '(!)'. Either the User nameor the Password is incorrect.}}

</faultstring><detail><string>Unable to authenticate user 'ibpm'. Either the User name

or the Password is incorrect. {Unable to authenticate user '(!)'. Eitherthe User name or the Password is incorrect.}</string>

</detail></soapenv:Fault>




Index

A

about this manual, 5

I

Interstage BPMdocumentation list, 5Overview, 7

Interstage BPM ConsoleUninstalling, 54

W

Web ServicesAPI description, 58

WebLogicEmbedded LDAP Server, 22


Index

Documents

Interstage BusinessProcessManager V10€¦ · TableofContents AboutthisManual.....5 1 SystemConfigurations.....7