vitalqip® workflow manager (wfm) northbound soap … · workflow manager (wfm) northbound soap api...

.

VitalQIP®

Workflow Manager (WFM)Northbound SOAP APIRelease 6.4Interface Specification

190-409-078R6.4Issue 2

June 5, 2006

Copyright © 2006 Lucent Technologies. All Rights Reserved.

This material is protected by the copyright laws of the United States and other countries. It may not be reproduced, distributed, or altered in any fashion by any entity (either internal or external to Lucent Technologies), except in accordance with applicable agreements, contracts, or licensing, without the express written consent of Lucent Technologies and the business management owner of the material.

Trademarks

All trademarks and service marks specified herein are owned by their respective companies.

Apache

This product includes software developed by the Apache Software Foundation (http:// www.apache.org/).

....................................................................iii

Contents

About this document v

Purpose................................................................................................................................................................v

Intended audience ...........................................................................................................................................v

How to use this information product .......................................................................................................v

Conventions used...........................................................................................................................................vi

Related information.......................................................................................................................................vi

Information product support .....................................................................................................................vii

Technical support..........................................................................................................................................vii

How to order ...................................................................................................................................................vii

How to comment......................................................................................................................................... viii

1 Workflow Manager Northbound SOAP API 1

Introduction.......................................................................................................................................................2

Requirements....................................................................................................................................................3

Purpose................................................................................................................................................................4

Mechanism used in the interface...............................................................................................................5

Assumptions......................................................................................................................................................7

2 API functionality 9

General Functionality..................................................................................................................................10

Operations supported ...............................................................................................................................11

WM_CreateWorkItem() .............................................................................................................................12

WM_UpdateWorkItem()............................................................................................................................13

WM_FindWorkItems() ...............................................................................................................................14

WM_RetrieveWorkItem() .........................................................................................................................18

WM_CancelWorkItem() ............................................................................................................................20

WM_LinkWorkItem().................................................................................................................................21

WM_UnlinkChildren() ...............................................................................................................................22

WM_UnlinkFromParent() .........................................................................................................................23

WM_AuthorizeUser() .................................................................................................................................24

WM_Logout() ................................................................................................................................................25

v

v

v

v

vi

vi

vii

vii

vii

viii

9

7

5

4

3

2

1

25

24

23

22

21

20

18

14

13

12

11

10

....................................................................iv

3 Signatures 27

Signatures .......................................................................................................................................................28

4 Sample Java client program 31

Sample Java client program......................................................................................................................32

5 Error Messages and Timeouts 35

Error messages.............................................................................................................................................36

Error codes and messages................................................................................................. 36

Timeouts..........................................................................................................................................................42

Types of timeouts ............................................................................................................. 42

6 SOAP notification 43

SOAP notification.........................................................................................................................................44

Configuring SOAP notification for SSL..............................................................................................47

A Workflow Manager Web Service WSDL 49

Workflow Manager Web Service WSDL............................................................................................50

B Workflow Manager SOAP notification WSDL 65

Sample SOAP notification WSDL.........................................................................................................66

C Sample request and response messages 73

Sample Create Work Item .........................................................................................................................74

Sample Retrieve Work Item .....................................................................................................................77

Sample Update Work Item........................................................................................................................81

Sample Link Work Item.............................................................................................................................83

Sample Unlink From Parent .....................................................................................................................85

Sample Unlink Children.............................................................................................................................87

Sample Cancel Work Item.........................................................................................................................89

Sample Find Work Items ...........................................................................................................................91

D Input parameters for standard workflows 95

Input parameters for standard workflows ............................................................................................96

Glossary 105

Index 107

96

95

91

89

87

85

83

81

77

74

73

66

65

50

49

47

44

43

42

42

36

36

35

32

31

28

27

105

107

....................................................................v

About this document

Purpose

The purpose of this guide is to describe the operations and methods for implementing the Workflow Manager Northbound SOAP API.

Intended audience

This guide is intended for personnel responsible for implementing a Southbound SOAP interface to Workflow Manager.

How to use this information product

This guide covers the following topics:

Chapter 1, “Workflow Manager Northbound SOAP API”

This chapter provides an overview of the Workflow Manager Northbound SOAP API.

Chapter 2, “API functionality” This chapter provides information on the functionality of the Northbound SOAP API. Descriptions, parameters, and return values for supported operations are also included in this section.

Chapter 3, “Signatures” This chapter provides information on the Java signatures of methods that can be invoked via the Workflow Manager Web Service.

Chapter 4, “Sample Java client program”

This chapter provides a sample Java client program.

Chapter 5, “Error Messages and Timeouts”

This chapter describes the various error messages and timeouts that may be received by the northbound system.

Chapter 6, “SOAP notification” This chapter describes SOAP notifications that may be received by the northbound system.

Appendix A, “Workflow Manager Web Service WSDL”

This appendix provides a sample Workflow Manager Web Service WSDL.

Appendix B, “Workflow Manager SOAP notification WSDL”

This appendix provides a sample SOAP notification WSDL.

Appendix C, “Sample request and response messages”

This appendix provides sample request and response messages for each supported method.

....................................................................vi

Conventions used

The following table lists the typographical conventions used throughout this manual.

Table 1 Typographical conventions

Related information

For related information see the following documents:• Workflow Manager User’s Guide (Part No. 190-409-063R6.4)

• Work Flow Editor II User’s Guide (Part No. 190-409-060R6.4)

Appendix D, “Input parameters for standard workflows”

This appendix provides input parameters for standard workflows.

Convention Meaning Example

boldface • Names of items on screens.• Names of commands and

routines.• Names of buttons you

should click.• Names of keys on the

keyboard to be pressed.• Uniform Resource Locators

(URLs)

• Select the Client check box.• The qip_getappllst routine returns the entire

list of existing applications.• Click OK.

• Press Enter to continue.

• Visit the website http://www.lucent.com

letter gothic Input that you should enter from your keyboard.

Run the following command:c:\setup.exe

<angle brackets> Variables that you must substitute another value for.

http://<server_IP_address_or_name>

italics • Names of manuals.

• Directories, paths, file names, and e-mail addresses.

• Indicates emphasis (used with boldface).

• See the Reference Manual for more information.

• E-mail your comments to the Comments Hotline ([email protected])

• Assign all Job Functions listed.

click Click the left button on your mouse once.

To delete the object, click Delete.

right-click Click the right button on your mouse.

Right-click on a service.

double-click Double-click the left button on your mouse.

Double-click the book icon.

....................................................................vii

• Task Configurator User’s Guide (Part No. 190-409-061R6.4)

• Interface Configurator User’s Guide (Part No. 190-409-062R6.4)

• Workflow Manager Installation Guide (Part No. 190-409-064R6.4)

• Workflow Manager Configuration Guide (Part No. 190-409-076R6.4)

Information product support

The Information Products & Training Group within Lucent offers cost-effective educational programs that cover the Lucent products. Our offerings also include courses on the underlying technology for the products (for example, DNS and DHCP). Our classes blend presentation, discussion, and hands-on exercises to reinforce learning. Students acquire in-depth knowledge and gain expertise by practicing with our products in a controlled, instructor-facilitated setting. For questions, please email us at [email protected].

Technical support

If you need assistance with VitalQIP, you can contact the Technical Assistance Center for your region. Contact information is provided in Table 2.

Table 2 Technical support information

How to order

Customers can order additional VitalQIP manuals online at http://www.cic.lucent.com/documents.html.

Region Address Contact information

North, Central, and South America

Lucent Technologies400 Lapp RoadMalvern, PA 19355 USA

Phone: 1-866-LUCENT8 (582-3688) Option 1Web: www.lucent.com/support

Europe, Middle East, Africa, and China

Lucent TechnologiesChiltern HouseSterling CourtBroad LaneBracknell, RG12 9GUUK

Phone: 00 800 00 LUCENT or +353 1 692 4579E-mail: [email protected]: www.lucent.com/support

Asia Pacific Lucent Technologies Australia68 Waterloo RoadNorth Ryde NSW 2113 Australia

Phone: 1800-458-236 (toll free from within Australia)(IDD) 800-5823-6888 (toll free from Asia Pacific - Hong Kong, Indonesia, South Korea, Malaysia, New Zealand, Philippines, Singapore, Taiwan, and Thailand)(613) 9614-8530 (toll call from any country)E-mail: [email protected]

....................................................................viii

How to comment

To comment on this information product, go to the Online Comment Form or email your comments to the Comments Hotline ([email protected]).

http://www.lucent-info.com/comments/enus

http://www.lucent-info.com/comments/enus

mailto:[email protected]

....................................................................1

1 Workflow Manager Northbound SOAP API

..........................................................................................................................................................................................Overview

Purpose

This chapter provides an overview of the Workflow Manager Northbound SOAP API.

Contents

This chapter covers these topics.

Introduction 2

Requirements 3

Purpose 4

Mechanism used in the interface 5

Assumptions 7

....................................................................2

..........................................................................................................................................................................................Introduction

WFM exposes a SOAP-based interface over the northbound API. This API is used for system-to-system interactions on transactions such as creating work items for scenarios and getting status updates. A published WSDL (Web Services Definition Language) document is included in this document as an appendix. This data structure (WSDL) will remain constant for all scenarios. Structures to support individual scenarios will be published as part of the scenario document and added to the appendix of this document.

The interface supports the following capabilities: create a work item, update a work item, retrieve one or more work items, cancel work item, link work item, unlink children, and unlink parent.

The GUI continues to use the current WFM Java API layer. The SOAP interface is a thin layer that operates at the same level as the GUI and implements a subset of GUI features as described below. SOAP service(s) transform the data structures and call the corresponding supported Java methods in the WFM Java API.

....................................................................3

Requirements

..........................................................................................................................................................................................Requirements

To implement the Northbound SOAP API, the following requirements must be met on a Solaris-based platform.

Software requirements• Apache Axis 1.2

• Apache TomCat 4.0

• Workflow Manager, Release 6.4

Hardware requirements

The SOAP application is run on Sun and Sun-compatible hardware such as Siemens-Fujitsu.

Standards requirements• SOAP1.1 and SOAP1.2 are supported.

• WSDL 1.0 and 1.1 are supported.

• HTTP 1.1 is supported. HTTPS is supported when using SSL.

....................................................................4

..........................................................................................................................................................................................Purpose

The purpose of this interface is to enable third-party systems to send requests to Workflow Manager using a published SOAP API that can be shared with outside parties. This makes WFM much more versatile and flexible. This interface is in addition to the Java API that already exists.

....................................................................5

Mechanism used in the interface

..........................................................................................................................................................................................Mechanism used in the interface

The SOAP Northbound Interface is implemented as a Web Service. The term Web Service describes a standardized way of integrating Web-based applications using the XML, SOAP, WSDL, and UDDI open standards over an Internet protocol backbone. XML is used to tag the data, SOAP is used to transfer the data and WSDL is used for describing the services available.

Web Services allow organizations to communicate data without in-depth knowledge of each other's IT systems even if the systems are behind a firewall. SOAP is an XML-based communication protocol and encoding format for inter-application communication. The current specification is version SOAP 1.2, although version 1.1 is more widespread. SOAP is widely viewed as the backbone of Web Services. Various implementations of SOAP exist, such as Apache Axis, gSOAP, TclSOAP, to name a few.

This interface uses Apache Axis version 1.2. Apache Axis is a Java-based implementation that supports SOAP 1.1 and 1.2 specifications. Implemented services in the Web Services application can be deployed in the Apache Axis server, which may or may not be co-resident with the TomCat server. The deployed services enable Axis to recognize, process and invoke requested service operations on the back-end service implementation. The TomCat servlet engine executes Axis as a web application and provides the necessary HTTP/HTTPS messaging framework. The Web Service is a multi-threaded Java process. Methods implemented by the Web Service are invoked by Axis.

The figure below shows the steps involved in the Web Service receiving a client request.

http://ws.apache.org/axis/

http://www.cs.fsu.edu/~engelen/soap.html

http://wiki.tcl.tk/1753

....................................................................6

Figure 1 Steps involved in receiving a client request

As indicated above, a Web Service is described by a WSDL (document). A WSDL binding describes how the service is bound to the SOAP messaging protocol. A WSDL SOAP binding can be either a RPC style binding or a document style binding. A SOAP binding can also have an encoded use or a literal use.

The WFM Web Service supports RPC/Literal style for the following reasons:

• The WSDL is simple.

• The operation name still appears in the message, which makes it easy for the interface to dispatch the message to the appropriate backend implementation method.

• The type encoding information is eliminated which results in better performance due to the overhead of encoding each element.

The WSDL for the interface to be used by the Web Service is included in Appendix A of this document.

....................................................................7

Assumptions

..........................................................................................................................................................................................Assumptions

The following assumptions are made:

• The upstream system is compliant with SOAP 1.1 or SOAP 1.2.

• The upstream system is compliant with WSDL1.0.

• Axis 1.2/TomCat 4.0 is used for the SOAP service.

• All operations supported by the SOAP service are implemented synchronously.

• TomCat servlet container/Axis supports use of proxy servers.

• Timeouts are supported through TomCat.

• Update milestones is not supported at this time. This capability will be added later.

• UDDI is currently not used.

....................................................................8

....................................................................9

2 API functionality

..........................................................................................................................................................................................Overview

Purpose

This chapter provides information on the functionality of the Northbound SOAP API. Descriptions, parameters, and return values for supported operations are also included in this section.

Contents


General Functionality 10

Operations supported 11

WM_CreateWorkItem() 12

WM_UpdateWorkItem() 13

WM_FindWorkItems() 14

WM_RetrieveWorkItem() 18

WM_CancelWorkItem() 20

WM_LinkWorkItem() 21

WM_UnlinkChildren() 22

WM_UnlinkFromParent() 23

WM_AuthorizeUser() 24

WM_Logout() 25

....................................................................10

..........................................................................................................................................................................................General Functionality

• The API extracts an “IP address” of the requestor and stores it for auditing needs.

• The API is SSL capable (SSL capability is optional).

• The API logs appropriate error/info messages.

• The API has a published “WSDL” that is sharable with the northbound system(s).

• The API is scalable to handle variations in throughput load from northbound systems.

• The API handles requests from multiple systems. These systems may be different or multiple instances of the same system.

• SOAP Service (Axis/TomCat) are on a separate server or can be co-resident with the WFM TomCat server. Both implementations are supported.

• The connection between the client and WFM can be taken down after each request. However, if the client initiates a “keepAlive” HTTP session, then the session is persistent, i.e., the connection is not taken down after each request, but stays open until it times out.

• Clients can use proxy servers to connect to the Web Service.

• Multiple clients can send requests simultaneously.

• Requests from a particular client are handled on a FIFO (first in first out) basis.

• Timeouts are supported through integration with Apache TomCat servlet container. Timeouts are defined in TomCat using the connectionTimeout parameter in the server.xml file at the connector level. Defining the timeout at the connector level allows the VitalQIP Web Service to set different timeout values depending on the specific requirements of various northbound systems. The default value for connectionTimeout is 60,000 milliseconds. In other words, if a request is not processed in 60,000 milliseconds, it is timed out and an error will be returned to the client. Setting the connectionTimeout value to –1 will disable the timeout.

• When a request fails, an appropriate error message is returned to the requester.

....................................................................11

General Functionality

Operations supported

The WM service(s) supports the following operations/methods. If the implementation is non-session-based, each method needs to send authentication parameters as specified in WM_AuthenticateUser().

All of the following operations return a fault in case of error. The fault includes two attributes that are used to determine the error, as described in Table 3:

Table 3 Fault attributes

Attribute Description

errorCode A unique integer.

errorMessage Message generated by the Web Service or returned by WFM.

....................................................................12

..........................................................................................................................................................................................WM_CreateWorkItem()

This service creates a work item in WFM and returns an acknowledgment. workItemId is returned as the key. The request can contain a list of parameters (Table 4), which, for interoperability reasons, can only contain data types that are supported by the SOAP specification and the WSDL.

Parameters

WM_CreateWorkItem() uses the parameters described in Table 4.

Table 4 WM_CreateWorkItem() input parameters

Return value

Table 5 shows the output parameter.

Table 5 WM_CreateWorkItem() output parameter

Input parameter Type Required? Description

taskModelName String Y Name of workflow

workItemId String N A Unique workItemId. If workItemId is not specified, then WFM will assign a unique work item identifier.

parameters Map N Name value pairs of attributes to use during work item creation (hashmap): For example, to define “name” to “John Doe”, parameters will be:key “name” – type stringvalue “John Doe” – type stringNote: A child WI may be linked to a parent WI (a WI that was previously created) by supplying an attribute called linkWorkItemId. Optionally, an attribute called linkApplTag can be supplied if there are multiple applications sending in Work Item requests. The linkApplTag must be the Application Tag of the parent WI. However, the linkApplTag can be omitted if the parent WI and the new child WI use the same Application Tag.

Output parameter Type Description

workItemId String Identifier of the work item just created.

....................................................................13

WM_UpdateWorkItem()

..........................................................................................................................................................................................WM_UpdateWorkItem()

Given a workItemId, the work item object(s) are updated with the data provided. The request can contain a list of parameters, which, for interoperability reasons, can only contain data types that are supported by the SOAP specification and the WSDL.

Parameters

Table 6 WM_UpdateWorkItem() input parameters

Return value

Table 7 WM_UpdateWorkItem() output parameter

Input Parameter Type Required Comment

workItemId String Y Identifier of the work item to be updated.

parameters Map Y List of name value pairs of attributes to update the work item with. To update “name” to “Jane Doe”, parameters need to be:key “name” – type stringvalue “Jane Doe” – type string

Output Parameter

Type Comment

workItemId String Identifier of the work item just updated. Same as input work item id.

....................................................................14

..........................................................................................................................................................................................WM_FindWorkItems()

Given one or more search criteria, the list of objects that match the criteria are returned. One or more work items can be retrieved. The maximum number of work items returned is configurable. The work items do not include the hash map.

Parameters

Table 8 WM_FindWorkItems() input parameters


startIndex integer Y index at which to start the list of records to be returned. For example, if the selection criteria specified in userInfo result in a list of 100 records and the startIndex is 50, then the first 49 records will not be returned.

totalNumber integer Y Maximum number of records to be returned.

....................................................................15

WM_FindWorkItems()

userInfo SearchCriteria Y SearchCriteria is a list of searchCriterion objects. Each searchCriterion object consists of the following:• key - The type string. This is the name of

column used for search.• searchType - The type is

SEARCH_TYPE. This is an enumerated type which determines the operator valid values are EQUALS, NOTEQUALS, GREATERTHAN,LESSTHAN, and BETWEEN.

• value - The type is string. This is the value for column specified by key

SOAP_SEARCH_CRITERIA property defined in $PLAT_BASE/config/WM_CustomSearchOptions.properties file is used to define custom search criteria. The values specified for this property are the column names found in WorkItemExt table in WM DB. The SOAP interface checks that specified key is one of the following or is defined in SOAP_SEARCH_CRITERIA property:WMWI#applicationTagWMWI#adminStateCodeWMWI#closedIndWMWI#statusWMWI#suspendIndWMWI#workItemIdWMWI#workItemType

When the searchType is "BETWEEN", the start and end column names are obtained from additional properties. For example, if IPAddress is one of values defined for SOAP_SEARCH_CRITERIA property, the following properties defines the lower and upper limit respectively:SEARCH.IPAddress.TUPLE1 = startIPAddress

SEARCH.IPAddress.TUPLE2 = endIPAddress


....................................................................16

Return value

Table 9 WM_FindWorkItems() output parameters - list of one or more work items

Output

String workItemId;

String applicationTag;

String activateReasonCode;

String adminStateCode;

short blockCancelInd;

short blockLinkInd;

String cancelDate;

String canceledById;

short cancelInd;

String cancelReasonCode;

String cancelReasonText;

short closedInd;

String completeTime;

String createTime;

String linkApplTag;

int linkCount;

short linkedInd;

String linkWorkItemId;

String startTime;

String status;

short suspendInd;

String suspendReasonCode;

String WI_PriorityCode;

String workItemSubType;

String workItemType;

....................................................................17

WM_FindWorkItems()

....................................................................18

..........................................................................................................................................................................................WM_RetrieveWorkItem()

Given a single workItemId, the specified work item is returned.

Parameters

Table 10 WM_RetrieveWorkItem() input parameter

Return value

Table 11 WM_RetrieveWorkItem() output parameters

Remarks

WMSoapWorkItem object contains following attributes:

String workItemId;String applicationTag;String activateReasonCode;String adminStateCode;short blockCancelInd;short blockLinkInd;String cancelDate;String canceledById;short cancelInd;String cancelReasonCode;String cancelReasonText;short closedInd;String completeTime;String createTime;String linkApplTag;int linkCount;short linkedInd;


retrieveWorkItemId String Y Identifier of work item to retrieve.

Output Comment

workitem work item object with attributes specified in WMSoapWorkItem.

workitemrequest object containing attributes in WMSoapWorkItem object. WMSoapWorkItem object contains:• workItemId• taskModelName• Map/list of name and values of attributes (hashmap)

....................................................................19

WM_RetrieveWorkItem()

String linkWorkItemId;String startTime;String status;short suspendInd;String suspendReasonCode;String WI_PriorityCode;String workItemSubType;String workItemType;

....................................................................20

..........................................................................................................................................................................................WM_CancelWorkItem()

Given a workItemId, a single work item is cancelled.

Parameters

Table 12 WM_CancelWorkItem() input parameters

Return value

None.


cancelWorkItemId String Y Identifier of work item to retrieve.

cancelReasonCode String N Reason for canceling the work item.

cancelWorkerId String N User initiating the cancellation.

cancelUserNotes String N Free text comments.

....................................................................21

WM_LinkWorkItem()

..........................................................................................................................................................................................WM_LinkWorkItem()

Given workItemId(s), work items are linked in a parent-child relationship. One parent work item and one or more child work items are specified.

Parameters

Table 13 WM_LinkWorkItem() input parameters

Return value

None.


parentWorkItemId String Y The identifier of the parent. Only one can be supplied.

childWorkItemIds String Y The identifier of the child. One or more can be supplied. More than one workItemId can be specified using a comma separated list.

userNotes String N Free text comments.

....................................................................22

..........................................................................................................................................................................................WM_UnlinkChildren()

Given a parent workItemId, all child work items are unlinked from that parent. Only the parent work item is specified.

Parameters

Table 14 WM_UnlinkChildren() input parameters

Return value

None.


parentWorkItemId String Y The identifier of the parent. Only one can be supplied.


....................................................................23

WM_UnlinkFromParent()

..........................................................................................................................................................................................WM_UnlinkFromParent()

Given one or more child work items, each child is unlinked from its parent.

Parameters

WM_UnlinkFromParent() uses the parameters described in Table 15.

Table 15 WM_UnlinkFromParent() parameters

Return value

None.

Remarks

If the implementation is session based, then the session ids are used for authentication. If the implementation is non-session-based, the following additional operations/methods are supported.


childWorkItemIds String Y The identifier of the child. One or more can be supplied. More than one workItemId can be specified using a comma separated list.


....................................................................24

..........................................................................................................................................................................................WM_AuthorizeUser()

The client provides a username and password as part of the request. A user is authenticated and a session is opened after the user has been successfully authenticated. Multiple sessions can be created for the same or different clients. A session id is returned to the client as a Cookie that must be sent for each subsequent operation. Sessions time out after a configurable amount of time.

Parameters

Table 16 WM_AuthorizeUser() parameters

Return value

None.

Parameter Name

Type Required

Description

userName string Y The identifier of the client.

passwd string Y The password of the client.

otherProperties Map N Map of name value of attributes to use for authentication.For example:key=realmvalue=xyz

....................................................................25

WM_Logout()

..........................................................................................................................................................................................WM_Logout()

End the session. The sessionId needs to be supplied.

Parameters

Return value

None.

Parameter Name Type Required Description

sessionId String Y The Identifier of the specific session to be taken down.

....................................................................26

....................................................................27

3 Signatures

..........................................................................................................................................................................................Overview

Purpose

This chapter provides information on the Java signatures of methods that can be invoked via the Workflow Manager Web Service.

Contents


Signatures 28

....................................................................28

Signatures

The Java signatures of methods that can be invoked via the Workflow Manager Web Service are given below:

/** * WMBindingImpl.java * * This file was auto-generated from WSDL * by the Apache Axis 1.2.1 Jun 14, 2005 (09:15:57 EDT) WSDL2Java emitter. */

package com.lucent.nos.core.gateways.soap.wm;

public class WMBindingImpl implements com.lucent.nos.core.gateways.soap.wm.WM_PortType{

public void WM_AuthorizeUser(com.lucent.nos.core.gateways.soap.wm.holders.WMSoapAuthInfo parameters) throws java.rmi.RemoteException, com.lucent.nos.core.gateways.soap.wm.ApplFault {

}

public com.lucent.nos.core.gateways.soap.wm.CreateWorkItemResponse WM_CreateWorkItem(com.lucent.nos.core.gateways.soap.wm.holders.WMSoapAuthInfo sessionHeader, com.lucent.nos.core.gateways.soap.wm.CreateWorkItemRequest parameters) throws java.rmi.RemoteException, com.lucent.nos.core.gateways.soap.wm.ApplFault {

}

public void WM_LinkWorkItem(com.lucent.nos.core.gateways.soap.wm.holders.WMSoapAuthInfo sessionHeader, com.lucent.nos.core.gateways.soap.wm.LinkWorkItemRequest parameters) throws java.rmi.RemoteException, com.lucent.nos.core.gateways.soap.wm.ApplFault {

}

public void WM_UnlinkFromParent(com.lucent.nos.core.gateways.soap.wm.holders.WMSoapAuthInfo sessionHeader, com.lucent.nos.core.gateways.soap.wm.UnlinkFromParentRequest parameters) throws java.rmi.RemoteException, com.lucent.nos.core.gateways.soap.wm.ApplFault {

}

public void WM_UnlinkChildren(com.lucent.nos.core.gateways.soap.wm.holders.WMSoapAuthInfo sessionHeader, com.lucent.nos.core.gateways.soap.wm.UnlinkChildrenRequest parameters) throws java.rmi.RemoteException, com.lucent.nos.core.gateways.soap.wm.ApplFault {

}

public com.lucent.nos.core.gateways.soap.wm.FindWorkItemsResponse WM_FindWorkItems(com.lucent.nos.core.gateways.soap.wm.holders.WMSoapAuthInfo sessionHeader, com.lucent.nos.core.gateways.soap.wm.FindWorkItemsRequest parameters) throws java.rmi.RemoteException, com.lucent.nos.core.gateways.soap.wm.ApplFault {

}

....................................................................29

Overview

public void WM_Logout() throws java.rmi.RemoteException, com.lucent.nos.core.gateways.soap.wm.ApplFault {

}

public com.lucent.nos.core.gateways.soap.wm.UpdateWorkItemResponse WM_UpdateWorkItem(com.lucent.nos.core.gateways.soap.wm.holders.WMSoapAuthInfo sessionHeader, com.lucent.nos.core.gateways.soap.wm.UpdateWorkItemRequest parameters) throws java.rmi.RemoteException, com.lucent.nos.core.gateways.soap.wm.ApplFault {

}

public void WM_CancelWorkItem(com.lucent.nos.core.gateways.soap.wm.holders.WMSoapAuthInfo sessionHeader, com.lucent.nos.core.gateways.soap.wm.CancelWorkItemRequest parameters) throws java.rmi.RemoteException, com.lucent.nos.core.gateways.soap.wm.ApplFault {

}

public com.lucent.nos.core.gateways.soap.wm.RetrieveWorkItemResponse WM_RetrieveWorkItem(com.lucent.nos.core.gateways.soap.wm.holders.WMSoapAuthInfo sessionHeader, com.lucent.nos.core.gateways.soap.wm.RetrieveWorkItemRequest parameters) throws java.rmi.RemoteException, com.lucent.nos.core.gateways.soap.wm.ApplFault {

}

}

....................................................................30

....................................................................31

4 Sample Java client program

..........................................................................................................................................................................................Overview

Purpose

This chapter provides a sample Java client program.

.Contents


Sample Java client program 32

....................................................................32

..........................................................................................................................................................................................Sample Java client program

The following is a sample Java client program:

import java.net.URL;import com.lucent.nos.core.gateways.soap.wm.*;// A sample program to create a work item via// Work Manager Soap Interface.// @version @(#)SampleClient.java108.1.2.3 10/06/05 108.1.2.3 13:40:01

public class SampleClient {

public static void main(String[] args) {

boolean session = true;String serviceURL;WMBindingStub wmServerStub = null;if (args.length < 1 )

serviceURL = "http://localhost/axis/services/WM_Port";else

serviceURL = args[0];

try {URL wmServerUrl = new URL(serviceURL);wmServerStub = new WMBindingStub(wmServerUrl, null);

}catch (Exception ex) {

ex.printStackTrace();System.exit(-1);

}// Define authentication attributesString username = "ovadm";String password = "ovadm123";

MapItem[] otherAttrList = new MapItem[1];otherAttrList[0] = new MapItem("realm", "dummyRealmValue");Map otherAuthAttr = new Map(otherAttrList);WMSoapAuthInfo authenticationInfo = new

WMSoapAuthInfo(username, password, otherAuthAttr);

try {

if (session) {wmServerStub.setMaintainSession(true);wmServerStub.WM_AuthorizeUser(authenticationInfo);authenticationInfo = null;

}

....................................................................33

Sample Java client program

// Define work itemString workItemId = "WmTestId123";String taskModelName = "NotifySOAP";MapItem[] parameterList = new MapItem[6];parameterList[0] = new MapItem("name", "FirstName

LastName");parameterList[1] = new MapItem("employeeId", "12345678");parameterList[2] = new MapItem("phoneNum", "8005557777");parameterList[3] = new MapItem("fax", "8005558888");parameterList[4] = new MapItem("emailAddress",

"[email protected]");parameterList[5] = new MapItem("location", "New Jersey,

USA");// ...// ... define other attributes to be used for this workitem.// ...

WMSoapWorkItemRequest workItem = new WMSoapWorkItemRequest(new Map(parameterList),

taskModelName, workItemId);CreateWorkItemRequest workItemRequest = new

CreateWorkItemRequest(workItem);

CreateWorkItemResponse response =wmServerStub.WM_CreateWorkItem(authenticationInfo,

workItemRequest);System.out.println("Successfully created work item, id=" +

response.getWorkitemId());// ... // ... Invoke other operations// ...

if (session) {wmServerStub.WM_Logout();

}}catch (ApplFault appEx) {

System.out.println("Application Exception: errorCode=" + appEx.getErrorCode() +

", errorMsg=" + appEx.getErrorMsg());}catch (Exception ex) {

System.out.println(ex.getMessage());System.exit(-2);

}}

}

....................................................................34

....................................................................35

5 Error Messages and Timeouts

..........................................................................................................................................................................................Overview

Purpose

This chapter describes the various error messages and timeouts that may be received by the northbound system.

Contents


Error messages 36

Timeouts 42

....................................................................36

Error messages

..........................................................................................................................................................................................Error codes and messages

Error message with error codes

The Web Service populates appropriate error messages with error codes. Not every error message described below will actually be sent to the northbound system. The list of error codes and messages are given below:

Table 17 Error codes and messages

Error messages and causes

Error messages may also come from WFM itself.

Table 18 WFM error messages and causes

ErrorCode Error Message

20001 Work Manager SOAP Server Initialization Error

20002 Invalid Session

20003 Missing Authentication Information

20004 No records found to match selection criteria

20005 Internal Error

20006 Missing parameters

20007 Missing Property

Error Message Cause

[%s] failed. An operation failed while processing a request.

A failure occurred in wmmon_server. A failure occurred in wmmon_server.

A notification could not be sent. A communication failure occurred.

APP_ERR=((APPLICATION ERROR)) An application error is encountered while processing the request. Please contact your System Administrator to save the error message and related log files, then report the problem to developers.

....................................................................37

Error codes and messages

Attempt to do log entry for MANUAL/AUTOMATIC not by WM.

An invalid request was sent to Work flow Manager.

Begin transaction failed, aborting transaction.

A problem exists with the database or with communication to the database.

Cannot create [%s] Possibly a problem with the database.

Cannot find [%s] Possibly a problem with the database.

Cannot find object [%s] with value [%s]. Possibly a problem with the database.

Cannot retrieve [%s] Possibly a problem with the database.

Cannot set connections to archived database tables.

A problem occurred with the database or with communication to the database.

Cannot set connections to database tables. A problem occurred with the database or with communication to the database.

Cannot use procedure [procedure name] as a top-level task model.

An attempt was made to create a work item using a procedure as the task model.

Child Work Item is closed The specified operation is not allowed on a closed work item.

Commit transaction failed, aborting transaction.

A problem occurred with the database or with communication to the database.

CONFIG_ERR=((CONFIGURATION ERROR))

A configuration error is encountered while processing the request. Please contact your System Administrator to check the correctness of task property files. If the problem persists, please save the error message and related log files, then report the problem to developers.

Create with Link request failed for Work Item [work item id, application tag] for parent [work item id, application tag] does not exist.

A non-existent parent work item was specified.

Create with Link request failed for Work Item [work item id, application tag] for parent [work item id, application tag] has block link set.

A work item was specified that has block link set.

Create with Link request failed for Work Item [work item id, application tag] for parent [work item id, application tag] is canceled.

A canceled parent work item was specified.

DB error while retrieving Possibly a problem with the database.

Error Message Cause

....................................................................38

Did not find [%s] for given [%s] Possibly a problem with the database.

Does not own the task The user does not own the specified task and cannot perform the specified task on it.

Duplicate input milestone name or type. The input to a Workflow Manager transaction contained duplicate or inconsistent milestone data.

ENV_VAR_NOT_SET=((ERROR)) An Environment Variable is not set. Please contact your System Administrator to ensure that this Variable is set.

Error creating [%s] Possibly a problem with the database.

Failed to complete task [task instance id] for work item [work item id] with outcome [the outcome specified in the request]: [the cause of the failure}.

An error occurred while processing a request to complete a task.

Failed to complete the START task. An error occurred while completing the START task of a work item.

Failed to create an entry in the Activity Log.

Possibly a problem with the database.

Failed to extract an interface object. An incorrect interface object was sent to Workflow Manager.

Failed to process task [task instance id] for work item [work item id]: [the cause of the failure].

An error occurred while starting the next task during a request to complete a task.

FIELD_VALUE_INVALID=((ERROR)) A Field value sent is invalid. Please check error log for details.

Input bad. An interface object sent to Workflow Manager contained incorrect data.

Interval between milestones: [name of the first milestone] and [name of the second milestone], are too close.

The time interval between two requested milestones is too short and rejectIntervalInd is true on the input.

Invalid outcome. An attempt was made to complete a task with an outcome that is not valid for the task in the task model.

Invalid procedure [procedure name] for work item [work item id].

The procedure name in a procedure call does not exist. This error should not occur because this was checked when the work item was created.

Error Message Cause

....................................................................39


Invalid value [the invalid value] for attribute [name of the attribute containing the invalid value]

An invalid value was sent to Workflow Manager.

Milestone [milestone name] requested time [milestone requested time] is not within the calendar.

The requested time given for the milestone associated with a task that has a calendar is not within the calendar and rejectCalendarInd is true in the input.

Milestone is completed. The input to a Workflow Manager transaction contained a requested time for a milestone that is already completed. This is only a warning.

Milestone not valid Work Item. The input to a Work Item transaction contained a requested time for a milestone that does not exist in the task model.

Multiple entries for work item [work item id, application tag], jogFunctionId [jobfunction id].

The input to a Workflow Manager transaction contained duplicate or inconsistent data.

No outcomes. A request to complete a task was sent to Workflow Manager with no outcome.

No rows in the ModelPath table for taskModelId [task model id] and stepNumber [step number].

The task model does not have a normal path from the specified step.

Not allowed to update work item [work item id, application tag], jobFunctionId [jobfunction id], currently assigned to [worker id].

An attempt was made to update or delete another user’s pre-assignment.

Null [%s] A null value was sent to Workflow Manager for a required attribute.

Object [string identifying the object that already exists] value [the value that already exists] already exists.

An attempt was made to create an object that already exists.

Object [string identifying the object that cannot be modified] is read only.

An invalid attempt was made to modify an object.

Object [string identifying the object that does not exist] value [the value that does not exist] does not exist.

An attempt was made to access an object that does not exist.

Parent work item [work item id] is canceled.

An attempt was made to link to a canceled work item.

Error Message Cause

....................................................................40

Pre-assignment for work item [work item id, application tag], jobfunctionId [jobfunction id] does not exist.

An attempt was made to delete a non-existent pre-assignment.

Procedure [the procedure name in a procedure task] not found.

An attempt was made to create a work item with a task model that calls a non-existent procedure.

PS error in [function in the software that detected the error]: [error message from the database].

An error occurred in a database operation.

Required attribute [name of attribute] not provided.

A null value was sent to Workflow Manager for a required attribute.

REQUIRED_FIELD_MISSING=((USERINPUT ERROR))

A required field is missing. Please check error log for details.

Task model [task model name] has no START task.

Possibly a problem with the database.

Task Model [task model name] not found. A request was sent to Workflow Manager containing a non-existent task-model name.

The child work item [work item id] has canceling blocked.

An attempt was made to cancel a work item, but a child of the work item has canceling blocked and checkChildCanInd is true in the input.

The specified task is already completed. An attempt was made to pick up a task that has already been completed.

The specified task is not a manual task. An attempt was made to perform an operation that is only allowed on a manual task.

The task is already picked up by [worker id].

An attempt was made to pick up a task that has already been picked up.

The work item [work item id] is linked but has no parent.

The data for the work item in the database is inconsistent.

The work item is already closed. The specified operation is not allowed on a closed work item.

The work item is closed. The specified operation is not allowed on a closed work item.

The work item is not allowed to start in the past.

The date and time specified for a requested milestone would cause the work item to start in the past and rejectRequestInd is true in the input.

Error Message Cause

....................................................................41


The work item is not suspended. An attempt was made to activate a work item that is not suspended.

There are no linked children. An attempt was made to unlink children from a work item that is not linked as a parent.

UNEXPECTED_EXCEPTION=((UNEXPECTED ERROR))

An UNEXPECTED exception was received while processing the request, therefore the request can not be completed! Please contact your System Administrator to save the error message and related log files, then report the problem to developers.

Unknown action. An incorrect interface object was sent to Workflow Manager.

Unknown UMT Type. A request was sent to Workflow Manager containing an invalid UMT type.

Work item [work item id, application tag] does not have jobFunctionId [jobfunction id]

Incorrect data was sent to Workflow Manager.

Work item [work item id] is canceled. An attempt was made to perform an operation that is not allowed on a canceled work item.

Work item [work item id] is linked to a different parent: [work item id].

An attempt was made to link a linked work item.

Work item cancel is blocked. An attempt was made to cancel a work item, but the work item has canceling blocked.

Work Item Id passed in does not match Work Item Id in model.

An attempt was made to complete a task, but the specified task does not belong to the specified work item.

Work Item(s) [work item id] has(have) linking blocked.

An attempt was made to link a work item, but the work item has linking blocked.

XML_INVALID=((USERINPUT ERROR))

The input XML does not follow the specified Schema and rules. Please contact your System Administrator.

Error Message Cause

....................................................................42

Timeouts

..........................................................................................................................................................................................Types of timeouts

Connection Timeout

Connection timeouts are configured through integration with the Apache TomCat servlet container. The timeout can be defined in TomCat using the connectionTimeout parameter in the $CATALINA_BASE/conf/server.xml file. The default value for connectionTimeout is 60,000 milliseconds. As a result, a request not processed within 60,000 milliseconds will be timed out and an error will be returned to the client. Setting the connectionTimeout value to –1 will disable the timeout.

Session Timeout

The inactivity interval after which the Web Service times out can be increased by updating the value of the session-timeout directive in the Axis Servlet Web.xml file ($AXIS_BASE/WEB-INF/web.xml) and the corresponding Tomcat Web.xml file ($CATALINA_BASE/conf/web.xml). The default interval for Axis is 5 minutes and for Tomcat is 30 minutes.

....................................................................43

6 SOAP notification

..........................................................................................................................................................................................Overview

Purpose

This chapter describes SOAP notifications that may be received by the northbound system.

Contents


SOAP notification 44

Configuring SOAP notification for SSL 47

....................................................................44

..........................................................................................................................................................................................SOAP notification

The northbound system that interfaces to Workflow Manager via SOAP may be notified of a status change, when the work item has been completed, or when an error occurred in the processing, etc. These notifications are part of the process followed by the work item that was created by WFM as a consequence of receiving a request from the northbound system.

When these notifications occur is process-specific and is specified in the workflows within WFM. It is thus not a given that the northbound system will receive notifications via SOAP; that is up to the designer of the workflows.

If a notification occurs, the northbound system can expect to receive the following:

The WFM Notification WSDL is included in Appendix B.

Table 19 SOAP notification descriptions

Attribute Type Required Comment

workItemId String Y

notificationType String Y

taskInstanceId String Y Identifier of the instantiated notification task in the workflow

....................................................................45

SOAP notification

activateReasonCode String N, but if present all are presentadminStateCode String

applicationTag String

blockCancelInd short

blockLinkInd short

cancelDate String

canceledById String

cancelInd short

cancelReasonCode String

cancelReasonText String

closedInd short

completeTime String

createTime String

linkApplTag String

linkCount int

linkedInd short

linkWorkItemId String

startTime String

status String

suspendInd short

suspendReasonCode String

WI_PriorityCode String

workItemSubtype String

workItemType String

Attributes provided on input by the NB interface

N


....................................................................46

Additional attributes on WI put on WI during processing.

N


....................................................................47

Configuring SOAP notification for SSL

..........................................................................................................................................................................................Configuring SOAP notification for SSL

When to use

The Workflow Manager SOAP API supports SSL. Use this procedure to configure SOAP notification for SSL.

Procedure

To use SSL for SOAP notifications, perform the following steps on the northbound system.

...........................................................................................................................................................................

1 Configure Tomcat Axis server to support SSL which typically runs on port 8443. This is the Web service server that will receive the SSL notification sent by the SOAPNotify task.

...........................................................................................................................................................................

2 Create a keystore file using the keytool utility. Detailed instructions can be found at: http://java.sun.com/j2ee/1.4/docs/tutorial/doc/index.html

...........................................................................................................................................................................

3 The following steps should be completed on the WFM Application machine:

1. Copy the keystore file set up on the northbound system.

2. Update $PLAT_BASE/config/LU.2500.WM.TaskServer to include the keystore file copied in the previous step:

JAVAFLAGS="${JAVAFLAGS} -Djavax.net.ssl.trustStore=<KEYSTORE_DIR>/.keystore"

Important! <KEYSTORE_DIR> is directory where the keystore file was copied.

3. Update $PLAT_BASE/config/SOAPNotifyTask.properties to include the URL of the northbound system. For example:

SOAPNotifyTask_recipientList=https://<NB_SYS_URL>:8443/axis/services/SOAPNotify

Important! NB_SYS_URL is the URL of the Northbound System.

...........................................................................................................................................................................

4 Make sure that all the Axis servers, which are configured to receive these secured notifications, use this keystore for SSL communication.

...........................................................................................................................................................................E N D O F S T E P S

....................................................................48

....................................................................49

A Workflow Manager Web Service WSDL

..........................................................................................................................................................................................Overview

Purpose

This appendix provides a sample Workflow Manager Web Service WSDL.

Contents

This appendix covers the following topic.

Workflow Manager Web Service WSDL 50

....................................................................50

..........................................................................................................................................................................................Workflow Manager Web Service WSDL

<?xml version="1.0"?>

<definitions name="WorkManagerService.wsdl" targetNamespace="http://lucent.com/wm/ws/V1_0" xmlns:wsdlns ="http://lucent.com/wm/ws/V1_0" xmlns:typens ="http://lucent.com/wm/ws/V1_0" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd ="http://www.w3.org/2001/XMLSchema" xmlns ="http://schemas.xmlsoap.org/wsdl/" >

<types>

<schema targetNamespace="http://lucent.com/wm/ws/V1_0" xmlns ="http://www.w3.org/2001/XMLSchema" elementFormDefault = "qualified" xmlns:xsd ="http://www.w3.org/2001/XMLSchema" xmlns:soap ="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:soapenc ="http://schemas.xmlsoap.org/soap/encoding/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"

>

<complexType name="MapItem"><xsd:sequence> <xsd:element name="key" type="xsd:anyType" minoccurs="1" maxoccurs="1" />

<xsd:element name="value" type="xsd:anyType" minoccurs="1" maxoccurs="1" />

</xsd:sequence></complexType>

<simpleType name="SEARCH_TYPE">

<xsd:restriction base="xsd:string"><xsd:enumeration value="EQUALS"/><xsd:enumeration value="NOTEQUALS"/><xsd:enumeration value="GREATERTHAN"/><xsd:enumeration value="LESSTHAN"/><xsd:enumeration value="BETWEEN"/>

</xsd:restriction></simpleType>

....................................................................51

Workflow Manager Web Service WSDL

<complexType name="SearchCriterion"><xsd:sequence> <xsd:element name="key" type="xsd:string" minoccurs="1" maxoccurs="1" />

<xsd:element name="searchType" type="wsdlns:SEARCH_TYPE" minoccurs="0" maxoccurs="1" />

<xsd:element name="value" type="xsd:string" minoccurs="1" maxoccurs="1" />


<complexType name="SearchCriteria"><xsd:sequence> <xsd:element name="criteria" type="wsdlns:SearchCriterion" minOccurs="1" maxOccurs="unbounded" />


<complexType name="Map"><xsd:sequence> <xsd:element name="item" type="wsdlns:MapItem" minOccurs="1" maxOccurs="unbounded" />


<complexType name="WMSoapAuthInfo"><xsd:sequence> <xsd:element name="userName" type="xsd:string" minOccurs="1" maxOccurs="1" />

<xsd:element name="password" type="xsd:string" minOccurs="1" maxOccurs="1" />

<xsd:element name="otherProperties" type="wsdlns:Map" minOccurs="0" maxOccurs="1" />


<complexType name="WMSoapUpdateRequest"><xsd:sequence> <xsd:element name="parameters" type="wsdlns:Map" minOccurs="1" maxOccurs="1" />

<xsd:element name="workItemId" type="xsd:string" minOccurs="1" maxOccurs="1" />

....................................................................52

<complexType name="WMSoapWorkItemRequest"><xsd:sequence> <xsd:element name="parameters" type="wsdlns:Map" minOccurs="1" maxOccurs="1" />

<xsd:element name="taskModelName" type="xsd:string" minOccurs="0" maxOccurs="1" />

<xsd:element name="workItemId" type="xsd:string" minOccurs="0" maxOccurs="1" />


 <complexType name="WMSoapWorkItem"> <xsd:sequence> <xsd:element name="workItemId" type="xsd:string" minOccurs="0" maxOccurs="1" />

<xsd:element name="applicationTag" type="xsd:string" minOccurs="0" maxOccurs="1" />

<xsd:element name="activateReasonCode" type="xsd:string" minOccurs="0" maxOccurs="1" />

<xsd:element name="adminStateCode" type="xsd:short"/> <xsd:element name="blockCancelInd" type="xsd:short"/> <xsd:element name="blockLinkInd" type="xsd:short"/> <xsd:element name="cancelDate" type="xsd:string" minOccurs="0" maxOccurs="1" />

<xsd:element name="canceledById" type="xsd:string" minOccurs="0" maxOccurs="1" />

<xsd:element name="cancelInd" type="xsd:short"/> <xsd:element name="cancelReasonCode" type="xsd:string" minOccurs="0" maxOccurs="1" />

<xsd:element name="cancelReasonText" type="xsd:string" minOccurs="0" maxOccurs="1" />

<xsd:element name="closedInd" type="xsd:short"/> <xsd:element name="completeTime" type="xsd:string" minOccurs="0" maxOccurs="1" />

<xsd:element name="createTime" type="xsd:string" minOccurs="0" maxOccurs="1" />

<xsd:element name="linkApplTag" type="xsd:string" minOccurs="0" maxOccurs="1" />

<xsd:element name="linkCount" type="xsd:int"/> <xsd:element name="linkedInd" type="xsd:short"/> <xsd:element name="linkWorkItemId" type="xsd:string" minOccurs="0" maxOccurs="1" />

<xsd:element name="startTime" type="xsd:string" minOccurs="0" maxOccurs="1" />

<xsd:element name="status" type="xsd:string" minOccurs="0" maxOccurs="1" />

<xsd:element name="suspendInd" type="xsd:short"/> <xsd:element name="suspendReasonCode" type="xsd:string" minOccurs="0" maxOccurs="1" />

....................................................................53


<xsd:element name="WI_PriorityCode" type="xsd:string" minOccurs="0" maxOccurs="1" />

<xsd:element name="workItemSubType" type="xsd:string" minOccurs="0" maxOccurs="1" />

<xsd:element name="workItemType" type="xsd:string" minOccurs="0" maxOccurs="1" />

</xsd:sequence> </complexType>  <complexType name="WMSoapWorkItemData"> <xsd:sequence> <xsd:element name="workitem" type="wsdlns:WMSoapWorkItem"/> <xsd:element name="workitemrequest" type="wsdlns:WMSoapWorkItemRequest"/>

</xsd:sequence> </complexType>  <complexType name="ArrayOfWMSoapWorkItem"> <xsd:sequence>

<xsd:element name="WMSoapWorkItem" type="typens:WMSoapWorkItem" minoccurs="0" maxOccurs="unbounded" />

</xsd:sequence> </complexType>

 <complexType name="ChildWorkItemId"> <xsd:sequence>

<xsd:element name="workItemId" type="xsd:string" minoccurs="1" maxOccurs="1" />

</xsd:sequence> </complexType>





<xsd:element name="ApplFault"> <xsd:complexType> <xsd:sequence> <xsd:element name="errorCode" type="xsd:int" minOccurs="1" maxOccurs="1" />

<xsd:element name="errorMsg" type="xsd:string" minOccurs="1" maxOccurs="1" />

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

....................................................................54

<xsd:element name="sessionHeader" type="typens:WMSoapAuthInfo"/>

<xsd:element name="CreateWorkItemRequest"> <xsd:complexType> <xsd:sequence> <xsd:element name="wirSoap" type="wsdlns:WMSoapWorkItemRequest" minOccurs="1" maxOccurs="1" />


<xsd:element name="CreateWorkItemResponse"> <xsd:complexType> <xsd:sequence> <xsd:element name="workitemId" type="xsd:string" minOccurs="1" maxOccurs="1" />


<xsd:element name="LinkWorkItemRequest"> <xsd:complexType> <xsd:sequence> <xsd:element name="parentWorkItemId" type="xsd:string" minOccurs="1" maxOccurs="1" />

<xsd:element name="childWorkItemIds" type="xsd:string" minOccurs="1" maxOccurs="1" />

<xsd:element name="userNotes" type="xsd:string" minOccurs="0" maxOccurs="1" />


<xsd:element name="UnlinkFromParentRequest"> <xsd:complexType> <xsd:sequence> <xsd:element name="childWorkItemIds" type="xsd:string" minOccurs="1" maxOccurs="1" />

....................................................................55


<xsd:element name="UnlinkChildrenRequest"> <xsd:complexType> <xsd:sequence> <xsd:element name="parentWorkItemId" type="xsd:string" minOccurs="1" maxOccurs="1" />



<xsd:element name="FindWorkItemsRequest"> <xsd:complexType> <xsd:sequence> <xsd:element name="userInfo" type="wsdlns:SearchCriteria" minOccurs="1" maxOccurs="1" />

<xsd:element name="startIndex" type="xsd:int" minOccurs="1" maxOccurs="1" />

<xsd:element name="totalNumber" type="xsd:int" minOccurs="1" maxOccurs="1" />


<xsd:element name="FindWorkItemsResponse"> <xsd:complexType> <xsd:sequence> <xsd:element name="workItemData" type="wsdlns:ArrayOfWMSoapWorkItem" minOccurs="0" maxOccurs="1" />


<xsd:element name="UpdateWorkItemRequest"> <xsd:complexType> <xsd:sequence> <xsd:element name="updateWirSoap" type="wsdlns:WMSoapUpdateRequest" minOccurs="1" maxOccurs="1" />

....................................................................56

<xsd:element name="UpdateWorkItemResponse"> <xsd:complexType> <xsd:sequence> <xsd:element name="updateWorkItemId" type="xsd:string" minOccurs="1" maxOccurs="1" />


<xsd:element name="CancelWorkItemRequest"> <xsd:complexType> <xsd:sequence> <xsd:element name="cancelWorkItem" type="xsd:string" minOccurs="1" maxOccurs="1" />

<xsd:element name="cancelWorkerId" type="xsd:string" minOccurs="0" maxOccurs="1" />

<xsd:element name="cancelReasonCode" type="xsd:string" minOccurs="0" maxOccurs="1" />

<xsd:element name="cancelUserNotes" type="xsd:string" minOccurs="0" maxOccurs="1" />


<xsd:element name="RetrieveWorkItemRequest"> <xsd:complexType> <xsd:sequence> <xsd:element name="retrieveWorkItemId" type="xsd:string" minOccurs="1" maxOccurs="1" />


<xsd:element name="RetrieveWorkItemResponse"> <xsd:complexType> <xsd:sequence> <xsd:element name="workItemData" type="wsdlns:WMSoapWorkItemData" minOccurs="1" maxOccurs="1" />


</schema>

</types>

....................................................................57


<message name="MessageFault" > <part name="ApplFault" element="wsdlns:ApplFault" /></message>

<message name="AuthorizeUserRequest" > <part name="parameters" element="wsdlns:sessionHeader" /></message>

<message name="AuthorizeUserResponse" ></message>

<message name="CreateWorkItemRequest" > <part name="sessionHeader" element="wsdlns:sessionHeader" /> <part name="parameters" element="wsdlns:CreateWorkItemRequest" /></message>

<message name="CreateWorkItemResponse" > <part name="workItemId" element="wsdlns:CreateWorkItemResponse" /></message>

<message name="LinkWorkItemRequest" > <part name="sessionHeader" element="wsdlns:sessionHeader" /> <part name="parameters" element="wsdlns:LinkWorkItemRequest" /></message>

<message name="LinkWorkItemResponse" ></message>

<message name="UnlinkFromParentRequest" > <part name="sessionHeader" element="wsdlns:sessionHeader" /> <part name="parameters" element="wsdlns:UnlinkFromParentRequest" /></message>

<message name="UnlinkFromParentResponse" ></message>

<message name="UnlinkChildrenRequest" > <part name="sessionHeader" element="wsdlns:sessionHeader" /> <part name="parameters" element="wsdlns:UnlinkChildrenRequest" /></message>

....................................................................58

<message name="UnlinkChildrenResponse" ></message>

<message name="FindWorkItemsRequest" > <part name="sessionHeader" element="wsdlns:sessionHeader" /> <part name="parameters" element="wsdlns:FindWorkItemsRequest" /></message>

<message name="FindWorkItemsResponse" > <part name="parameters" element="wsdlns:FindWorkItemsResponse" /></message>

<message name="LogoutRequest" ></message>

<message name="LogoutResponse" ></message>

<message name="UpdateWorkItemRequest" > <part name="sessionHeader" element="wsdlns:sessionHeader" /> <part name="parameters" element="wsdlns:UpdateWorkItemRequest" /></message>

<message name="UpdateWorkItemResponse" > <part name="workItemId" element="wsdlns:UpdateWorkItemResponse" /></message>

<message name="CancelWorkItemRequest" > <part name="sessionHeader" element="wsdlns:sessionHeader" /> <part name="parameters" element="wsdlns:CancelWorkItemRequest" /></message>

<message name="CancelWorkItemResponse" ></message>

<message name="RetrieveWorkItemRequest" > <part name="sessionHeader" element="wsdlns:sessionHeader" /> <part name="parameters" element="wsdlns:RetrieveWorkItemRequest" /></message>

<message name="RetrieveWorkItemResponse" > <part name="workItemData" element="wsdlns:RetrieveWorkItemResponse" />

....................................................................59


</message>



<portType name="WM_PortType">

<operation name="WM_AuthorizeUser"> <input message="wsdlns:AuthorizeUserRequest" /> <output message="wsdlns:AuthorizeUserResponse" /> <fault name="WM_AuthorizeUserFault" message="wsdlns:MessageFault" />

</operation>

<operation name="WM_CreateWorkItem"> <input message="wsdlns:CreateWorkItemRequest" /> <output message="wsdlns:CreateWorkItemResponse" /> <fault name="WM_CreateWorkItemFault" message="wsdlns:MessageFault" />

</operation>

<operation name="WM_LinkWorkItem"> <input message="wsdlns:LinkWorkItemRequest" /> <output message="wsdlns:LinkWorkItemResponse" /> <fault name="WM_LinkWorkItemFault" message="wsdlns:MessageFault" />

</operation> <operation name="WM_UnlinkFromParent"> <input message="wsdlns:UnlinkFromParentRequest" /> <output message="wsdlns:UnlinkFromParentResponse" /> <fault name="WM_UnlinkFromParentFault" message="wsdlns:MessageFault" />

</operation> <operation name="WM_UnlinkChildren"> <input message="wsdlns:UnlinkChildrenRequest" /> <output message="wsdlns:UnlinkChildrenResponse" /> <fault name="WM_UnlinkChildrenFault" message="wsdlns:MessageFault" />

</operation>

<operation name="WM_FindWorkItems"> <input message="wsdlns:FindWorkItemsRequest" /> <output message="wsdlns:FindWorkItemsResponse" /> <fault name="WM_FindWorkItemsFault" message="wsdlns:MessageFault" />

</operation>

....................................................................60

<operation name="WM_Logout"> <input message="wsdlns:LogoutRequest" /> <output message="wsdlns:LogoutResponse" /> <fault name="WM_LogoutFault" message="wsdlns:MessageFault" /> </operation>

<operation name="WM_UpdateWorkItem"> <input message="wsdlns:UpdateWorkItemRequest" /> <output message="wsdlns:UpdateWorkItemResponse" /> <fault name="WM_UpdateWorkItemFault" message="wsdlns:MessageFault" />

</operation>

<operation name="WM_RetrieveWorkItem"> <input message="wsdlns:RetrieveWorkItemRequest" /> <output message="wsdlns:RetrieveWorkItemResponse" /> <fault name="WM_RetrieveWorkItemFault" message="wsdlns:MessageFault" />

</operation> <operation name="WM_CancelWorkItem"> <input message="wsdlns:CancelWorkItemRequest" /> <output message="wsdlns:CancelWorkItemResponse" /> <fault name="WM_CancelWorkItemFault" message="wsdlns:MessageFault" />

</operation>

</portType>



<binding name="WMBinding" type="wsdlns:WM_PortType">

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

<operation name="WM_AuthorizeUser" > <soap:operation style="rpc" soapAction="WM_AuthorizeUser" /> <input> <soap:body parts="parameters" namespace="http://lucent.com/wm/ws/V1_0" use="literal"/>

</input> <output> <soap:body parts="parameters" namespace="http://lucent.com/wm/ws/V1_0" use="literal" />

</output> <fault name="WM_AuthorizeUserFault">

....................................................................61


<soap:fault name="WM_AuthorizeUserFault" use="literal" /> </fault> </operation> <operation name="WM_CreateWorkItem" > <soap:operation style="rpc" soapAction="WM_CreateWorkItem" /> <input> <soap:header message="wsdlns:CreateWorkItemRequest" part="sessionHeader" namespace="http://lucent.com/wm/ws/V1_0" use="literal"/>

<soap:body parts="parameters" namespace="http://lucent.com/wm/ws/V1_0" use="literal"/>

</input> <output> <soap:header message="wsdlns:CreateWorkItemResponse" part="sessionHeader" namespace="http://lucent.com/wm/ws/V1_0" use="literal"/>

</output> <fault name="WM_CreateWorkItemFault"> <soap:fault name="WM_CreateWorkItemFault" use="literal" /> </fault> </operation>

<operation name="WM_LinkWorkItem" > <soap:operation style="rpc" soapAction="WM_LinkWorkItem" /> <input> <soap:header message="wsdlns:LinkWorkItemRequest" part="sessionHeader" namespace="http://lucent.com/wm/ws/V1_0" use="literal"/>


</input> <output> <soap:header message="wsdlns:LinkWorkItemResponse" part="sessionHeader" namespace="http://lucent.com/wm/ws/V1_0" use="literal"/>

</output> <fault name="WM_LinkWorkItemFault"> <soap:fault name="WM_LinkWorkItemFault" use="literal" /> </fault> </operation>

<operation name="WM_UnlinkFromParent" > <soap:operation style="rpc" soapAction="WM_UnlinkFromParent" /> <input> <soap:header message="wsdlns:UnlinkFromParentRequest" part="sessionHeader" namespace="http://lucent.com/wm/ws/V1_0" use="literal"/>


....................................................................62

</input> <output> <soap:header message="wsdlns:UnlinkFromParentResponse" part="sessionHeader" namespace="http://lucent.com/wm/ws/V1_0" use="literal"/>

</output> <fault name="WM_UnlinkFromParentFault"> <soap:fault name="WM_UnlinkFromParentFault" use="literal" /> </fault> </operation>

<operation name="WM_UnlinkChildren" > <soap:operation style="rpc" soapAction="WM_UnlinkChildren" /> <input> <soap:header message="wsdlns:UnlinkChildrenRequest" part="sessionHeader" namespace="http://lucent.com/wm/ws/V1_0" use="literal"/>


</input> <output> <soap:header message="wsdlns:UnlinkChildrenResponse" part="sessionHeader" namespace="http://lucent.com/wm/ws/V1_0" use="literal"/>

</output> <fault name="WM_UnlinkChildrenFault"> <soap:fault name="WM_UnlinkChildrenFault" use="literal" /> </fault> </operation>

<operation name="WM_FindWorkItems" > <soap:operation style="rpc" soapAction="WM_FindWorkItems" /> <input> <soap:header message="wsdlns:FindWorkItemsRequest" part="sessionHeader" namespace="http://lucent.com/wm/ws/V1_0" use="literal"/>


</input> <output> <soap:header message="wsdlns:FindWorkItemsResponse" part="sessionHeader" namespace="http://lucent.com/wm/ws/V1_0" use="literal"/>

<soap:body parts="parameters" namespace="http://lucent.com/vqip/ws/V1_0" use="literal" />

</output> <fault name="WM_FindWorkItemsFault"> <soap:fault name="WM_FindWorkItemsFault" use="literal" /> </fault> </operation>

....................................................................63


<operation name="WM_Logout" > <soap:operation style="rpc" soapAction="WM_Logout" /> <input> <soap:header message="wsdlns:LogoutRequest" part="sessionHeader" namespace="http://lucent.com/wm/ws/V1_0" use="literal"/>


</input> <output> <soap:header message="wsdlns:LogoutResponse" part="sessionHeader" namespace="http://lucent.com/wm/ws/V1_0" use="literal"/>

</output> <fault name="WM_LogoutFault"> <soap:fault name="WM_LogoutFault" use="literal" /> </fault> </operation>

<operation name="WM_UpdateWorkItem" > <soap:operation style="rpc" soapAction="WM_UpdateWorkItem" /> <input> <soap:header message="wsdlns:UpdateWorkItemRequest" part="sessionHeader" namespace="http://lucent.com/wm/ws/V1_0" use="literal"/>


</input> <output> <soap:header message="wsdlns:UpdateWorkItemResponse" part="sessionHeader" namespace="http://lucent.com/wm/ws/V1_0" use="literal"/>

</output> <fault name="WM_UpdateWorkItemFault"> <soap:fault name="WM_UpdateWorkItemFault" use="literal" /> </fault> </operation> <operation name="WM_CancelWorkItem" > <soap:operation style="rpc" soapAction="WM_CancelWorkItem" /> <input> <soap:header message="wsdlns:CancelWorkItemRequest" part="sessionHeader" namespace="http://lucent.com/wm/ws/V1_0" use="literal"/>


</input> <output>

....................................................................64

<soap:header message="wsdlns:CancelWorkItemResponse" part="sessionHeader" namespace="http://lucent.com/wm/ws/V1_0" use="literal"/>

</output> <fault name="WM_CancelWorkItemFault"> <soap:fault name="WM_CancelWorkItemFault" use="literal" /> </fault> </operation> <operation name="WM_RetrieveWorkItem" > <soap:operation style="rpc" soapAction="WM_RetrieveWorkItem" /> <input> <soap:header message="wsdlns:RetrieveWorkItemRequest" part="sessionHeader" namespace="http://lucent.com/wm/ws/V1_0" use="literal"/>


</input> <output> <soap:header message="wsdlns:RetrieveWorkItemResponse" part="sessionHeader" namespace="http://lucent.com/wm/ws/V1_0" use="literal"/>

</output> <fault name="WM_RetrieveWorkItemFault"> <soap:fault name="WM_RetrieveWorkItemFault" use="literal" /> </fault> </operation>

</binding>



<service name="WMService" > <port name="WM_Port" binding="wsdlns:WMBinding" > <soap:address location="http://127.0.0.1:8200/axis/services/WM_Port" />

</port></service>

</definitions>

....................................................................65

B Workflow Manager SOAP notification WSDL

..........................................................................................................................................................................................Overview

Purpose

This appendix provides a sample SOAP notification WSDL.

Contents


Sample SOAP notification WSDL 66

....................................................................66

..........................................................................................................................................................................................Sample SOAP notification WSDL

The following is a sample Workflow Manager SOAP notification WSDL:

<?xml version="1.0" encoding="UTF-8"?><wsdl:definitions targetNamespace="urn:SOAPNotify" xmlns:impl="urn:SOAPNotify" xmlns:intf="urn:SOAPNotify" xmlns:apachesoap="http://xml.apache.org/xml-soap" xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">

 <wsdl:types> <schema xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="urn:SOAPNotify">

<import namespace="http://schemas.xmlsoap.org/soap/encoding/"/> <complexType name="WMSoapIdentity"> <sequence> <element name="applicationTag" nillable="true" type="soapenc:string"/>

<element name="milestoneInstanceId" nillable="true" type="soapenc:string"/>

<element name="modelInstanceId" nillable="true" type="soapenc:string"/>

<element name="taskInstanceId" nillable="true" type="soapenc:string"/>

<element name="taskModelId" nillable="true" type="soapenc:string"/>

<element name="workItemId" nillable="true" type="soapenc:string"/>

<element name="workItemSubType" nillable="true" type="soapenc:string"/>

<element name="workItemType" nillable="true" type="soapenc:string"/>

</sequence> </complexType> <complexType name="WMSoapLogEntry"> <sequence> <element name="applicationNotes" nillable="true" type="soapenc:string"/>

<element name="completeTime" nillable="true" type="soapenc:string"/>

<element name="description" nillable="true" type="soapenc:string"/>

<element name="id" nillable="true" type="impl:WMSoapIdentity"/> <element name="jobFunctionId" nillable="true" type="soapenc:string"/>

<element name="logTag" nillable="true" type="soapenc:string"/>

....................................................................67

Sample SOAP notification WSDL

<element name="logTime" nillable="true" type="soapenc:string"/> <element name="logType" type="xsd:short"/> <element name="modelInstanceId" nillable="true" type="soapenc:string"/>

<element name="notesInd" type="xsd:short"/> <element name="outcome" nillable="true" type="soapenc:string"/> <element name="repeatCount" type="xsd:int"/> <element name="startTime" nillable="true" type="soapenc:string"/> <element name="stepLabel" nillable="true" type="soapenc:string"/> <element name="stepNumber" type="xsd:int"/> <element name="systemId" nillable="true" type="soapenc:string"/> <element name="taskInstanceId" nillable="true" type="soapenc:string"/>

<element name="timeAssigned" nillable="true" type="soapenc:string"/>

<element name="userNotes" nillable="true" type="soapenc:string"/> <element name="workerId" nillable="true" type="soapenc:string"/> </sequence> </complexType> <complexType name="WMSoapMilestone"> <sequence> <element name="actualTime" nillable="true" type="soapenc:string"/>

<element name="applicationTag" nillable="true" type="soapenc:string"/>

<element name="errorMessage" nillable="true" type="soapenc:string"/>

<element name="jeopardyInd" type="xsd:short"/> <element name="jeopardyTime" nillable="true" type="soapenc:string"/>

<element name="jobId" nillable="true" type="soapenc:string"/> <element name="milestoneId" nillable="true" type="soapenc:string"/>

<element name="milestoneInstanceId" nillable="true" type="soapenc:string"/>

<element name="milestoneName" nillable="true" type="soapenc:string"/>

<element name="milestoneRepeatCount" type="xsd:int"/> <element name="milestoneState" nillable="true" type="soapenc:string"/>

<element name="milestoneType" nillable="true" type="soapenc:string"/>

<element name="milestoneTypeCode" type="xsd:short"/> <element name="modelInstanceId" nillable="true" type="soapenc:string"/>

<element name="pivotInd" type="xsd:short"/> <element name="previousTargetComplnTime" nillable="true" type="soapenc:string"/>

<element name="recalculatedTime" nillable="true" type="soapenc:string"/>

....................................................................68

<element name="requestedTime" nillable="true" type="soapenc:string"/>

<element name="returnCode" type="xsd:int"/> <element name="targetComplnTime" nillable="true" type="soapenc:string"/>


<element name="taskModelId" nillable="true" type="soapenc:string"/>

<element name="usePreviousTargetInd" type="xsd:short"/> <element name="weight" type="xsd:int"/> <element name="workItemId" nillable="true" type="soapenc:string"/>



</sequence> </complexType> <complexType name="ArrayOfWMSoapMilestone"> <complexContent> <restriction base="soapenc:Array"> <attribute ref="soapenc:arrayType" wsdl:arrayType="impl:WMSoapMilestone[]"/>

</restriction> </complexContent> </complexType> <complexType name="WMSoapWorkItem"> <sequence> <element name="WI_PriorityCode" nillable="true" type="soapenc:string"/>

<element name="activateReasonCode" nillable="true" type="soapenc:string"/>

<element name="adminStateCode" type="xsd:short"/> <element name="applicationTag" nillable="true" type="soapenc:string"/>

<element name="applyToLinkedInd" type="xsd:short"/> <element name="blockCancelInd" type="xsd:short"/> <element name="blockLinkInd" type="xsd:short"/> <element name="cancelDate" nillable="true" type="soapenc:string"/>

<element name="cancelInd" type="xsd:short"/> <element name="cancelReasonCode" nillable="true" type="soapenc:string"/>

<element name="cancelReasonText" nillable="true" type="soapenc:string"/>

<element name="canceledById" nillable="true" type="soapenc:string"/>

<element name="checkChildCanInd" type="xsd:short"/> <element name="closedInd" type="xsd:short"/>

....................................................................69


<element name="completeTime" nillable="true" type="soapenc:string"/>

<element name="createTime" nillable="true" type="soapenc:string"/>

<element name="linkApplTag" nillable="true" type="soapenc:string"/>

<element name="linkCount" type="xsd:int"/> <element name="linkWorkItemId" nillable="true" type="soapenc:string"/>

<element name="linkedInd" type="xsd:short"/> <element name="logEntry" nillable="true" type="impl:WMSoapLogEntry"/>

<element name="logInd" type="xsd:short"/> <element name="maxRelinkCount" type="xsd:int"/> <element name="milestones" nillable="true" type="impl:ArrayOfWMSoapMilestone"/>

<element name="nextMilestoneName" nillable="true" type="soapenc:string"/>

<element name="nextTargetComplnTime" nillable="true" type="soapenc:string"/>

<element name="parentWorkItemInd" type="xsd:short"/> <element name="relinkLimitInd" type="xsd:short"/> <element name="resumeInd" type="xsd:short"/> <element name="startTime" nillable="true" type="soapenc:string"/> <element name="status" nillable="true" type="soapenc:string"/> <element name="suspendInd" type="xsd:short"/> <element name="suspendReasonCode" nillable="true" type="soapenc:string"/>

<element name="userNotes" nillable="true" type="soapenc:string"/> <element name="workItemId" nillable="true" type="soapenc:string"/>



<element name="workerId" nillable="true" type="soapenc:string"/> </sequence> </complexType> <complexType name="MapItem"> <sequence> <element name="key" nillable="true" type="xsd:anyType"/> <element name="value" nillable="true" type="xsd:anyType"/> </sequence> </complexType> <complexType name="ArrayOfMapItem"> <complexContent> <restriction base="soapenc:Array"> <attribute ref="soapenc:arrayType" wsdl:arrayType="impl:MapItem[]"/>

</restriction>

....................................................................70

</complexContent> </complexType> <complexType name="SOAPResponseData"> <sequence> <element name="WMSoapWorkItem" nillable="true" type="impl:WMSoapWorkItem"/>

<element name="attributesMap" nillable="true" type="impl:ArrayOfMapItem"/>

<element name="notificationType" nillable="true" type="soapenc:string"/>


<element name="workItemId" nillable="true" type="soapenc:string"/>

</sequence> </complexType> </schema> </wsdl:types>

<wsdl:message name="notifyRequest">

<wsdl:part name="in0" type="impl:SOAPResponseData"/>

<wsdl:part name="in1" type="impl:ArrayOfMapItem"/>

</wsdl:message>

<wsdl:message name="notifyResponse">

</wsdl:message>

<wsdl:portType name="SOAPNotify">

<wsdl:operation name="notify" parameterOrder="in0 in1">

<wsdl:input name="notifyRequest" message="impl:notifyRequest"/>

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

</wsdl:operation>

</wsdl:portType>

<wsdl:binding name="SOAPNotifySoapBinding" type="impl:SOAPNotify">

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

....................................................................71


<wsdl:operation name="notify">

<wsdlsoap:operation soapAction=""/>

<wsdl:input name="notifyRequest">

<wsdlsoap:body use="encoded" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" namespace="urn:SOAPNotify"/>

</wsdl:input>

<wsdl:output name="notifyResponse">

<wsdlsoap:body use="encoded" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" namespace="urn:SOAPNotify"/>

</wsdl:output>

</wsdl:operation>

</wsdl:binding>

<wsdl:service name="SOAPNotifyService">

<wsdl:port name="SOAPNotify" binding="impl:SOAPNotifySoapBinding">

<wsdlsoap:address location="http://localhost:8080/axis/services/SOAPNotify"/>

</wsdl:port>

</wsdl:service>

</wsdl:definitions>

....................................................................72

....................................................................73

C Sample request and response messages

..........................................................................................................................................................................................Overview

Purpose

This appendix provides sample request and response messages for each supported method.

Contents


Sample Create Work Item 74

Sample Retrieve Work Item 77

Sample Update Work Item 81

Sample Link Work Item 83

Sample Unlink From Parent 85

Sample Unlink Children 87

Sample Cancel Work Item 89

Sample Find Work Items 91

....................................................................74

..........................................................................................................................................................................................Sample Create Work Item

Create Request Message<?xml version="1.0" encoding="UTF-8"?>

<soapenv:Envelopexmlns: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:Header>

<ns1:sessionHeader xmlns:ns1="http://lucent.com/wm/ws/V1_0">

<ns1:userName>ovadm</ns1:userName>

<ns1:password>ovadm123</ns1:password>

</ns1:sessionHeader>

</soapenv:Header>

<soapenv:Body>

<WM_CreateWorkItem xmlns="http://lucent.com/wm/ws/V1_0">

<CreateWorkItemRequest>

<wirSoap>

<parameters>

<item>

<key xsi:type="xsd:string">name</key>

<value xsi:type="xsd:string">Jane Doe</value>

</item>

<item>

<key xsi:type="xsd:string">employeeId</key>

....................................................................75

Sample Create Work Item

<value xsi:type="xsd:string">12345</value>

</item>

<item>

<key xsi:type="xsd:string">phoneNum</key>


</item>

<item>

<key xsi:type="xsd:string">emailAddress</key>

<value xsi:type="xsd:string">[email protected]</value>

</item>

<item>

<key xsi:type="xsd:string">location</key>

<value xsi:type="xsd:string">Holmdel</value>

</item>

<item>

<key xsi:type="xsd:string">room</key>

<value xsi:type="xsd:string">6H-999</value>

</item>

</parameters>

<taskModelName>NotifySOAP</taskModelName>

<workItemId>workItemId007</workItemId>

<userId>user1</userId>

</wirSoap>

....................................................................76

</CreateWorkItemRequest>

</WM_CreateWorkItem>

</soapenv:Body>

</soapenv:Envelope>

Create Response Message

<?xml version="1.0" encoding="UTF-8"?>


<soapenv:Body>

<WM_CreateWorkItemResponsexmlns="http://lucent.com/wm/ws/V1_0">

<CreateWorkItemResponse>

<workitemId>workItemId007</workitemId>

</CreateWorkItemResponse>

</WM_CreateWorkItemResponse>

</soapenv:Body>

</soapenv:Envelope>

....................................................................77

Sample Retrieve Work Item

..........................................................................................................................................................................................Sample Retrieve Work Item

Retrieve Request Message



<soapenv:Header>


<ns1:userName>ovadm</ns1:userName>



</soapenv:Header>

<soapenv:Body>

<WM_RetrieveWorkItem xmlns="http://lucent.com/wm/ws/V1_0">

<RetrieveWorkItemRequest>

<retrieveWorkItemId>workItemId007</retrieveWorkItemId>

</RetrieveWorkItemRequest>

</WM_RetrieveWorkItem>

</soapenv:Body>

</soapenv:Envelope>

....................................................................78

Retrieve Response Message<?xml version="1.0" encoding="UTF-8"?>

<soapenv:Envelopexmlns: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>

<WM_RetrieveWorkItemResponse xmlns="http://lucent.com/wm/ws/V1_0">

<RetrieveWorkItemResponse>

<workItemData>

<workitem>


<applicationTag>WMQIP</applicationTag>

<adminStateCode>3</adminStateCode>

<blockCancelInd>0</blockCancelInd>

<blockLinkInd>0</blockLinkInd>

<cancelInd>0</cancelInd>

<closedInd>0</closedInd>

<createTime>20051024111420.0</createTime>

<linkCount>0</linkCount>

<linkedInd>0</linkedInd>

<suspendInd>0</suspendInd>

<workItemType>API</workItemType>

</workitem>

<workitemrequest>

....................................................................79

Sample Retrieve Work Item

<parameters>

<item>

<key xsi:type="xsd:string">reqType</key>

<value xsi:type="xsd:string">API</value>

</item>

<item>

<key xsi:type="xsd:string">room</key>

<value xsi:type="xsd:string">6H-999</value></item>

<item>

<key xsi:type="xsd:string">emailAddress</key>

<value xsi:type="xsd:string">[email protected]</value>

</item>

<item>

<key xsi:type="xsd:string">employeeId</key>


</item>

<item>

<key xsi:type="xsd:string">location</key>

<value xsi:type="xsd:string">Holmdel</value>

</item>

<item>

<key xsi:type="xsd:string">phoneNum</key>


....................................................................80

</item>

<item>


<value xsi:type="xsd:string">Jane Doe</value>

</item>

</parameters>

<taskModelName>NotifySOAP</taskModelName>


<userId>user1</userId>

</workitemrequest></workItemData></RetrieveWorkItemResponse>

</WM_RetrieveWorkItemResponse>

</soapenv:Body>

</soapenv:Envelope>

....................................................................81

Sample Update Work Item

..........................................................................................................................................................................................Sample Update Work Item

Update Request Message



<soapenv:Header>


<ns1: userName>ovadm</ns1:userName>



</soapenv:Header>

<soapenv:Body>

<WM_UpdateWorkItem xmlns="http://lucent.com/wm/ws/V1_0">

<UpdateWorkItemRequest>

<updateWirSoap>

<parameters>

<item>


<value xsi:type="xsd:string">Tony Blaze</value>

</item>

</parameters>

....................................................................82


</updateWirSoap>

</UpdateWorkItemRequest>

</WM_UpdateWorkItem>

</soapenv:Body>

</soapenv:Envelope>

Update Response Message



<soapenv:Body>

<WM_UpdateWorkItemResponse xmlns="http://lucent.com/wm/ws/V1_0">

<UpdateWorkItemResponse>

<updateWorkItemId>workItemId007</updateWorkItemId>

</UpdateWorkItemResponse>

</WM_UpdateWorkItemResponse>

</soapenv:Body>

</soapenv:Envelope>

....................................................................83

Sample Link Work Item

..........................................................................................................................................................................................Sample Link Work Item

Link Work Item Request



<soapenv:Header>





</soapenv:Header>

<soapenv:Body>

<WM_LinkWorkItem xmlns="http://lucent.com/wm/ws/V1_0">

<LinkWorkItemRequest>

<parentWorkItemId>workItemId007</parentWorkItemd>

<childWorkItemIds>workItemId029</childWorkItemIds>

<userNotes>Test of WM_LinkWorkItem</userNotes>

</LinkWorkItemRequest>

</WM_LinkWorkItem>

</soapenv:Body>

</soapenv:Envelope>

....................................................................84

Link Work Item Response Message



<soapenv:Body>

<WM_LinkWorkItemResponse xmlns="http://lucent.com/wm/ws/V1_0"/>

</soapenv:Body>

</soapenv:Envelope>

....................................................................85

Sample Unlink From Parent

..........................................................................................................................................................................................Sample Unlink From Parent

Unlink From Parent Request Message



<soapenv:Header>





</soapenv:Header>

<soapenv:Body>

<WM_UnlinkFromParent xmlns="http://lucent.com/wm/ws/V1_0">

<UnlinkFromParentRequest>

<childWorkItemIds>workItemId029</childWorkItemIds>

<userNotes>Test of WM_UnlinkFromParent over SOAPInterface</userNotes>

</UnlinkFromParentRequest>

</WM_UnlinkFromParent>

</soapenv:Body>

</soapenv:Envelope>

....................................................................86

Unlink From Parent Response Message



<soapenv:Body>

<WM_UnlinkFromParentResponsexmlns="http://lucent.com/wm/ws/V1_0"/>

</soapenv:Body>

</soapenv:Envelope>

....................................................................87

Sample Unlink Children

..........................................................................................................................................................................................Sample Unlink Children

Unlink Children Request Message



<soapenv:Header>





</soapenv:Header>

<soapenv:Body>

<WM_UnlinkChildren xmlns="http://lucent.com/wm/ws/V1_0">

<UnlinkChildrenRequest>

<parentWorkItemId>workItemId007</parentWorkItemId>

<userNotes>WM_Unlink Children over SOAP Interface</userNotes>

</UnlinkChildrenRequest>

</WM_UnlinkChildren>

</soapenv:Body>

</soapenv:Envelope>

....................................................................88

Unlink Children Response Message



<soapenv:Body>

<WM_UnlinkChildrenResponsexmlns="http://lucent.com/wm/ws/V1_0"/>

</soapenv:Body>

</soapenv:Envelope>

....................................................................89

Sample Cancel Work Item

..........................................................................................................................................................................................Sample Cancel Work Item

Cancel Request Message



<soapenv:Header>





</soapenv:Header>

<soapenv:Body>

<WM_CancelWorkItem xmlns="http://lucent.com/wm/ws/V1_0">

<CancelWorkItemRequest>

<cancelWorkItem>workItemId029</cancelWorkItem>

<cancelWorkerId>jdoe</cancelWorkerId>

<cancelReasonCode>Cancelcode1</cancelReasonCode>

<cancelUserNotes>Test of Cancel</cancelUserNotes>

</CancelWorkItemRequest>

</WM_CancelWorkItem>

</soapenv:Body>

....................................................................90

</soapenv:Envelope>

Cancel Response Message



<soapenv:Body>

<WM_CancelWorkItemResponse xmlns="http://lucent.com/wm/ws/V1_0"/>

</soapenv:Body>

</soapenv:Envelope>

....................................................................91

Sample Find Work Items

..........................................................................................................................................................................................Sample Find Work Items

Find Work Items Request Message



<soapenv:Header>





</soapenv:Header>

<soapenv:Body>

<WM_FindWorkItems xmlns="http://lucent.com/wm/ws/V1_0">

<FindWorkItemsRequest>

<userInfo>

<criteria>

<key>workItemId</key>

<searchType>EQUALS</searchType>

<value>WI060223000099</value>

</criteria>

</userInfo>

....................................................................92

<startIndex>0</startIndex>

<totalNumber>1</totalNumber>

</FindWorkItemsRequest><

/WM_FindWorkItems>

</soapenv:Body>

</soapenv:Envelope>

Find Work Items Response Message



<soapenv:Body>

<WM_FindWorkItemsResponse xmlns="http://lucent.com/wm/ws/V1_0">

<FindWorkItemsResponse>

<workItemData>

<WMSoapWorkItem>


<applicationTag>WMQIP</applicationTag>

<adminStateCode>3</adminStateCode>

<blockCancelInd>0</blockCancelInd>

<blockLinkInd>0</blockLinkInd>

<cancelInd>1</cancelInd>

....................................................................93

Sample Find Work Items

<closedInd>0</closedInd>

<createTime>20051019074447.0</createTime>

<linkCount>0</linkCount>

<linkedInd>0</linkedInd>

<suspendInd>0</suspendInd>

<workItemType>API</workItemType>

</WMSoapWorkItem>

</workItemData>

</FindWorkItemsResponse>

</WM_FindWorkItemsResponse>

</soapenv:Body>

</soapenv:Envelope>

....................................................................94

....................................................................95

D Input parameters for standard workflows

..........................................................................................................................................................................................Overview

Purpose

This appendix provides input parameters for standard workflows.

Contents

This appendix covers the following topic

Input parameters for standard workflows 96

....................................................................96

..........................................................................................................................................................................................Input parameters for standard workflows

WFM is delivered with a set of standard workflows. In order to create work items for these flows via the SOAP API’s WM_CreateWorkItem(), one needs to know the parameters that WFM expects. The table below presents these parameters for each workflow.

Workflow Parameter Required/Optional

HostIP_RegisterAddNoAuth name R

employeeId R

phoneNum R

faxNum O

emailAddress R

location R

room R

objectClass O

MAC_Address O

hostName R

userName R

password R

organization R

domainName R

subnetAddress R

....................................................................97

Input parameters for standard workflows

HostIP_RegisterChangeNoAuth name R

employeeId R

phoneNum R

faxNum O

emailAddress R

location R

room R

objectClass O

MAC_Address O

domainName R

hostName R

IP_Address R

newHostName R

userName R

password R

organization R

subnetAddress R

newDomainName R

newSubnetAddress R


....................................................................98

HostIP_RegisterDeleteNoAuth name R

employeeId R

phoneNum R

faxNum O

emailAddress R

location R

room R

objectClass O

MAC_Address O

domainName R

hostName R

IP_Address R

userName R

password R

organization R


....................................................................99


CopyAdministrator name R

employeeId R

phoneNum R

faxNum O

emailAddress R

location R

room R

existingAdmin R

newAdmin R

adminLastName R

adminFirstName R

adminPhoneNume R

adminPagerNum R

adminEmailaddress R

userName R

password R

organization R


....................................................................100

SubnetDelete name R

employeeId R

phoneNum R

faxNum O

emailAddress R

location R

room R

subnetAddress R

userName R

password R

organization R

SubnetDeleteNoPasswd name R

employeeId R

phoneNum R

faxNum O

emailAddress R

location R

room R

subnetAddress R

organization R


....................................................................101


UpdateRIPE_DB name R

employeeId R

phoneNum R

faxNum O

emailAddress R

location R

room R

inetNum R

netName R

descrRIPE R

country R

adminC R

techC R

statusRIPE R

mntBy R

passwordRIPE R

emailAddress2 R

source R

SendRequestToRIPE name R

employeeId R

phoneNum R

faxNum O

emailAddress R

location R

room R

requestType R


....................................................................102

regId R

legalOrgName R

orgLocation R

website R

spaceAvail R

netName R

currentSize R

immediateSize R

oneYearSize R

twoYearSize R

currentTotalSize R

immediateTotalSize R

oneYearTotalSize R

twoYearTotalSize R

purpose R

equipment1 O

manuf1 O

model1 O

other1 O

equipment2 O

manuf2 O

model2 O

other 2 O

networkDescr R


....................................................................103


NotifySOAP name R

employeeId R

phoneNum R

faxNum O

emailAddress R

location R

room R

AddCustAddress name R

employeeId R

phoneNum R

faxNum O

emailAddress R

location R

room R

LIR R

custName R

address R

city R

province R

postalCode R

country R

custEmail R

reqSize R

use O

use1y O

use2y O


....................................................................104

purpose R

userName R

password R

organization R


....................................................................105

..........................................................................................................................................................................................

..........................................................................................................................................................................................

..........................................................................................................................................................................................

..........................................................................................................................................................................................

Glossary

S SOAPSimple Object Access Protocol. A lightweight XML-based messaging protocol used to encode the information in Web service request and response messages before sending them over a network. SOAP messages are independent of any operating system or protocol and may be transported using a variety of Internet protocols, including SMTP, MIME, and HTTP. See also: http://www.w3.org/TR/soap.

U UDDIUniversal Description, Discovery and Integration. A Web-based distributed directory that enables businesses to list themselves on the Internet and discover each other, similar to a traditional phone book's yellow and white pages.

W WSDLWeb Services Description Language. An XML-formatted language used to describe a Web service's capabilities as collections of communication endpoints capable of exchanging messages. WSDL is an integral part of UDDI, an XML-based worldwide business registry. WSDL is the language that UDDI uses. WSDL was developed jointly by Microsoft and IBM. See also: http://www.w3.org/TR/wsdl.

X XMLExtensible Markup Language. XML is designed especially for Web documents. It allows designers to create their own customized tags, enabling the definition, transmission, validation, and interpretation of data between applications and between organizations.

....................................................................106

Index........................................................................................................................

A

activateReasonCode, 45adminStateCode, 45Apache Axis, 3Apache Axis version 1.2, 5Apache TomCat, 3applicationTag, 45Axis 1.2/TomCat 4.0, 7

........................................................................................................................

B

blockCancelInd, 45blockLinkInd, 45

........................................................................................................................

C

cancelDate, 45canceledById, 45cancelInd, 45cancelReasonCode, 20, 45cancelReasonText, 45cancelUserNotes, 20cancelWorkerId, 20cancelWorkItemId, 20childWorkItemIds, 21, 23closedInd, 45completeTime, 45createTime, 45

........................................................................................................................

E

Error messages, 36

........................................................................................................................

H

Hardware Requirements, 3

........................................................................................................................

L

linkApplTag, 45

linkCount, 45linkedInd, 45linkWorkItemId, 45

........................................................................................................................

N

notificationType, 44

........................................................................................................................

O

otherProperties, 24

........................................................................................................................

P

parentWorkItemId, 21, 22passwd, 24

........................................................................................................................

R

retrieveWorkItemId, 18

........................................................................................................................

S

SOAP, v, 105SOAP 1.1, 7SOAP 1.2, 7SOAP API, vSOAP interface, 2SOAP Northbound Interface, 5SOAP notification, 44SOAP notification WSDL, 65Software Requirements, 3startIndex, 14startTime, 45status, 45Steps involved in receiving a client request, 6suspendInd, 45suspendReasonCode, 45

........................................................................................................................

T

taskInstanceId, 44TomCat server, 5TomCat servlet, 7

totalNumber, 14

........................................................................................................................

U

UDDI, 5, 7, 105userInfo, 15userName, 24userNotes, 21, 22, 23

........................................................................................................................

W

Web Service, 5WI_PriorityCode, 45Workflow Manager, 3Workflow Manager Web Service WSDL, 49workitem, 18workItemId, 13, 44workitemrequest, 18workItemSubtype, 45workItemType, 45WSDL, 105WSDL1.0, 7

........................................................................................................................

X

XML, 105

vitalqip® workflow manager (wfm) northbound soap … · workflow manager (wfm) northbound soap api...

Documents