EMC® ApplicationXtender® Web Services for Workflow · ApplicationXtender Web Services for Workflow User’s Guide 7 Preface Conventions used in this document EMC uses the following

EMC® ApplicationXtender®Web Services for Workflow

6.0

User’s Guide300-008-323

REV A01

EMC CorporationCorporate Headquarters:

Hopkinton, MA 01748-9103

1-508-435-1000www.EMC.com

2

Copyright © 1994–2009 EMC Corporation. All rights reserved.

Published March, 2009

EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.

For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.

All other trademarks used herein are the property of their respective owners.

ApplicationXtender Web Services for Workflow User’s Guide

Contents

AppXWSforWorkflowUG.book Page 3 Thursday, February 19, 2009 4:45 PM

Preface.............................................................................................................................. 5

Chapter 1 Getting StartedInstallation and Setup ...................................................................... 10Components of AppXtender Web Services for Workflow ......... 11

Chapter 2 ApplicationXtender Web Services for Workflow Code SamplesOverview of Code Samples ............................................................. 14AppXtender Workflow Administrator Sample Application ...... 15AppXtender Workflow Client Sample Application..................... 16AppXtender Workflow Proxy Classes ........................................... 19

ApplicationXtender Web Services for Workflow User’s Guide 3

Contents


ApplicationXtender Web Services for Workflow User’s Guide4


Preface

This document provides instructions on how to use the ApplicationXtender Web Services for Workflow (AppXtender Web Services for Workflow) interface to support integration of the ApplicationXtender Workflow software product with a business’ internal processes.

As part of an effort to improve and enhance the performance and capabilities of its product lines, EMC periodically releases revisions of its hardware and software. Therefore, some functions described in this document may not be supported by all versions of the software or hardware currently in use. For the most up-to-date information on product features, refer to your product release notes.

If a product does not function properly or does not function as described in this document, please contact your EMC representative.

Audience The information in this document is intended for developers who are responsible for integrating the software products used in their environment. Developers should be familar with .NET programming before attempting to use this document.


6

Preface


Relateddocumentation

Post-release information is contained in the Release Notes for this product. This document is available at:

http://Powerlink.EMC.com.

Refer to the web site periodically to view the latest Release Notes.

Related documents include:

◆ ApplicationXtender Web Services User’s Guide

◆ ApplicationXtender Web Services Administrator’s Guide

◆ ApplicationXtender Software Developer Kit User’s Guide

◆ ApplicationXtender Workflow Administrator’s Guide

◆ ApplicationXtender Workflow User’s Guide

◆ ApplicationXtender Workflow Process Builder Guide

◆ ApplicationXtender Workflow Accounts Payable User’s Guide

◆ ApplicationXtender Workflow Accounts Payable Integration Guide

◆ ApplicationXtender Workflow Web Edition User’s Guide

◆ ApplicationXtender Workflow Basic Language Guide

Most of these documents can be found in the Documentation directory on the product media kit. All documents are in Adobe Acrobat Portable Document Format (PDF), and can be viewed by downloading and installing the Adobe Acrobat Reader. The Reader is available from Adobe at www.adobe.com. To install and use the Reader on the preferred platform, refer to the instructions on the Adobe web site.


http://powerlink.emc.com

http://Powerlink.EMC.com

Preface


Conventions used inthis document

EMC uses the following conventions for special notices.

Note: A note presents information that is important, but not hazard-related.

CAUTION!A caution contains information essential to avoid data loss or damage to the system or equipment. The caution may apply to hardware or software.

Where to get help EMC support, product, and licensing information can be obtained as follows.

Product information — For documentation, release notes, software updates, or for information about EMC products, licensing, and service, go to the EMC Powerlink website (registration required) at:

http://Powerlink.EMC.com

Technical support — For technical support, go to EMC Customer Service on Powerlink. To open a service request through Powerlink, you must have a valid support agreement. Please contact your EMC sales representative for details about obtaining a valid support agreement or to answer any questions about your account.


http://powerlink.emc.com

8

Preface




1Getting Started

This chapter provides information on installing the ApplicationXtender Web Services for Workflow (AppXtender Web Services for Workflow) API and how to start using it.

◆ Installation and Setup........................................................................ 10◆ Components of AppXtender Web Services for Workflow ........... 11

Getting Started 9

10

Getting Started


Installation and SetupBefore installing AppXtender Web Services for Workflow, you must have the .NET framework installed. If you are installing the Workflow Web Services feature, you must also have IIS installed and have Administrator privileges. The operating system of the machine that hosts Workflow Web Services must support the version of IIS installed on the machine. If IIS is missing or you do not have write access to the IIS directory, the Workflow Web Services feature will not appear in the features list. If you are only installing the sample applications, you do not need IIS or Administrator privileges.

AppXtender Web Services for Workflow is installed as an additional option when installing the AppXtender Web Services product. For complete instructions, refer to the AppXtender Web Services Administrator’s Guide.

Once you have installed AppXtender Web Services for Workflow, it may be changed or removed through the Add/Remove Programs utility. You should keep in mind that if you install the sample applications, make changes to the source code, and then reinstall or uninstall AppXtender Web Services for Workflow in the same location, any changes made to the sample applications will be overwritten or removed.

You can verify the correct installation of AppXtender Web Services for Workflow by opening your web browser and navigating to the following location:

http://localhost/WfServices/WfService.asmx.

If the installation was successful, a web page titled WF4AX will display listing all available AppXtender Web Services for Workflow operations.


Getting Started


Components of AppXtender Web Services for Workflow The AppXtender Web Services for Workflow product includes the following components:

◆ A Web Services API for the AppXtender Workflow product. If installed to the default location, the root folder for the Web Services API is: C:\Inetpub\wwwroot\WfServices.

◆ An HTML help file that provides a comprehensive reference for all AppXtender Web Services for Workflow methods and functions. This help file, if installed to the default location, is located in: C:\Inetpub\wwwroot\WfServices\WfServices\ Documentation.chm.

◆ A set of code samples that provide a fully functional AppXtender Workflow client application, an administrator application, and a set of proxy classes that aid in the development of Web Services-based applications. If installed to the default location, the code samples are located in: C:\WfServiceSample.

◆ An HTML help file that provides a comprehensive reference for using the AppXtender Web Services for Workflow proxy classes. If installed to the default location, this help file is located in: C:\WfServiceSample\ServiceSample.chm.

Users of AppXtender Web Services for Workflow must be expert users of AppXtender Workflow and also expert at .NET programming. The code samples are provided in C# but any .NET programming language may be used to create a custom application using the functionality available through AppXtender Web Services for Workflow.

Components of AppXtender Web Services for Workflow 11

12

Getting Started




2ApplicationXtender

Web Services forWorkflow Code

Samples

This chapter provides information on the ApplicationXtender Web Services for Workflow Code Samples:

◆ Overview of Code Samples .............................................................. 14◆ AppXtender Workflow Administrator Sample Application ....... 15◆ AppXtender Workflow Client Sample Application ...................... 16◆ AppXtender Workflow Proxy Classes ............................................ 19

ApplicationXtender Web Services for Workflow Code Samples 13

14

ApplicationXtender Web Services for Workflow Code Samples


Overview of Code SamplesThe AppXtender Web Services for Workflow code samples are implemented in Microsoft C# (.NET) and are provided in three Visual Studio projects (therefore, you must have Visual Studio installed to use the code samples). Two of the projects are fully implemented sample applications, one for the Administrator Web Service methods and one for the Client Web Service methods. These sample applications parallel the functionality of the AppXtender Workflow Web Access sites. The third project is a collection of Web Service proxy classes that provides a simpler interface for interacting with the Web Services.

If AppXtender Web Services for Workflow is installed to the default location, the code samples are located at: C:\WfServiceSample. Once the code samples are installed, they must first be compiled before you can run any of the sample applications.




AppXtender Workflow Administrator Sample ApplicationThis sample application demonstrates the use of the Web Service methods that pertain to AppXtender Workflow administration. This sample presents a simple form with server configuration fields and commits them upon pressing the save button. This sample application uses the WfServiceAdminProxy class located in the WfServiceProxies project.

The project for the WorkFlow Administrator sample application is named WfServiceAdmin and it contains:

◆ MainFrm.cs: the main Windows form that handles all of the UI and Web Service interaction. All of the relevant code is contained in MainFrm.cs, the main application form.

◆ Login.cs: the login dialog displayed to users when they start the application.

◆ WfServiceAdminConfig.cs: a configuration class that stores the last used web server in a file in the application's execution path.

The following figure illustrates the AppXtender Workfow Administrator user interface available through the sample application:

Figure 1 AppXtender Workflow Administrator Code Sample User Interface

AppXtender Workflow Administrator Sample Application 15

16



AppXtender Workflow Client Sample ApplicationThis sample application demonstrates how to build a fully functional AppXtender Workflow client application using Web Service methods. Almost every Web Service method available in AppXtender Workflow release 5.3 or later is used by this application. It demonstrates how to manipulate the data structures returned by the Web Service to both display the information and to update it. The user interface roughly parallels the Workflow Web Access edition of the product. This sample does not show attached documents; you must call the appropriate AppXtender Web Access .NET Web Services method if you want to render attached documents. This sample application uses the WfServiceProxy class located in the WfServiceProxies project.

The project for the Workflow Client sample application is named WfServiceClient and it contains:

◆ MainFrm.cs: the main Windows form that handles the majority of the UI

◆ LoginFrm.cs: the login dialog displayed to users when they start the application

◆ WfxChangePasswordFrm.cs: the change password dialog

◆ WfxUserSettingsFrm.cs: the user settings dialog

◆ WfxPersonalSettings.cs: the personal settings dialog

◆ WfxWorkOnFrm.cs: the work on dialog

• WfxWorkOnCtrl.cs: a control for the task pane on the work on dialog

• WfxWorkOnDetailsCtrl.cs: a control for the details pane on the work on dialog

• WfxWorkOnHistoryCtrl.cs: a control for the history pane on the work on dialog

◆ WfxLateItemFrm.cs: the late items dialog

◆ WfxLegendFrm.cs: the legend dialog

◆ WfxFilterFrm.cs: the filter dialog

◆ WfxFilterExpressionFrm.cs: the dialog used to construct expression-based filters




◆ WfxFilterValuesFrm.cs: the dialog used to construct list-of-values based filters

◆ WfxKeyValueEdit.cs: a control containing a Label and a TextBox used for key-value pairs

◆ WfxKeyValueList.cs: a control containing a Label and a ComboBox used for the key-value pairs where the list of values has been provided

◆ ProxyManager.cs: an abstract class shared by all forms containing a single static WfServiceProxy member

◆ ErrorManager.cs: an abstract class shared by all forms with a few static methods that show formatted error messages in MessageBox dialogs

◆ WfServiceClientConfig.cs: a configuration class that stores the last used web server in a file in the application's execution path

Examples of the use of each of the web service methods are listed in the following table:

Web Service Method Class and Method Filename

ChangePassword WfxChangePasswordFrm.btnOK_Click WfxChangePasswordFrm.cs

ClearFilters MainFrm.ClearFilter MainFrm.cs

CommitWorkItem WfxWorkOnFrm.btnCommit_Click WfxWorkOnFrm.cs

DeleteWorkItem MainFrm.DeleteItem MainFrm.cs

EnableListLimit MainFrm.mnuLimit_Click MainFrm.cs

GetBusinessProcess WfxBusinessProcessCtrl constructor WfxBusinessProcessCtrl.cs

GetColumns MainFrm.LoadWorkboxItems MainFrm.cs

GetFilter WfxFilterFrm constructor WfxFilterFrm.cs

GetLateItems WfxLateItemFrm constructor WfxLateItemFrm.cs

GetList MainFrm.LoadWorkboxItems MainFrm.cs

GetPersonalInfo WfxPersonalSettingsFrm constructor WfxPersonalSettingsFrm.cs

GetQueryLimit WfxUserSettingsFrm constructor WfxUserSettingsFrm.cs

GetSort MainFrm.LoadWorkboxItems MainFrm.cs

GetUserType MainFrm.OnLoad MainFrm.cs

AppXtender Workflow Client Sample Application 17

18



The following figure illustrates the AppXtender Workfow Client user interface available through the sample application:

Figure 2 AppXtender Workflow Client Code Sample User Interface

GetWorkDetails WfxWorkOnDetailsCtrl constructor WfxWorkOnDetailsCtrl.cs

GetWorkHistory WfxWorkOnHistoryCtrl constructor WfxWorkOnHistoryCtrl.cs

GetWorkItem WfxWorkOnFrm.AddTaskTab WfxWorkOnFrm.cs

HasFormFields WfxWorkOnFrm.SetupTabPages WfxWorkOnFrm.cs

HasGroupbox MainFrm.LoadPages MainFrm.cs

IsFilterSet MainFrm.RefreshWorkbox MainFrm.cs

IsObserver WfxWorkOnFrm.SetupTabPages WfxWorkOnFrm.cs

Login WfServiceProxy.Login WfServiceProxy.cs

Logout WfServiceProxy.Logout WfServiceProxy.cs

MoveToInbox MainFrm.MoveToInbox MainFrm.cs

SetFilter MainFrm.LaunchFilterForm MainFrm.cs

SetPersonalInfo WfxPersonalSettingsFrm.btnApply_Click WfxPersonalSettingsFrm.cs

SetQueryLimit WfxUserSettingFrm.btnOK_Click WfxUserSettingsFrm

SetSort MainFrm.listView_ColumnClick MainFrm.cs

Web Service Method Class and Method Filename




AppXtender Workflow Proxy ClassesThe Workflow Web Services proxy classes are designed to make interaction with the Web Services easier for developers by providing three major advantages:

◆ Serialization/deserialization of the XML to and from the Workflow Business Objects, the collection of data structures used by the Workflow system. This eliminates the need to work manually with XML every time a Web Service method is used.

◆ A framework for easy pre- and post-processing of Web Service methods and convenient error trapping.

◆ Automatic statistic collection for benchmarking your application.

An abstract base proxy class is provided for both admin and client Web Services. For the client, both a connect-and-drop and a persistent-token subclass are provided as examples of how to use the proxy. These can either serve as models for creating your own proxy or they can be used directly by your code. For more information about these proxy classes, refer to the ServiceSample.chm help file (default location = C:\WfServiceSample\ServiceSample.chm).

The project for the Workflow proxy classes is named WfServiceProxies and it contains:

◆ WfAdminServiceProxy.cs: an abstract base class for the administrative Web Service proxy

◆ WfAdminServiceStatelessProxy.cs: a concrete subclass of WfAdminServiceProxy that uses the connect-and-drop token handling paradigm

◆ WfServiceProxy.cs: an abstract base class for the client Web Service proxy

◆ WfServiceStatelessProxy.cs: a concrete subclass of WfServiceProxy that uses the connect-and-drop token handling paradigm

◆ WfServiceStateProxy.cs: a concrete subclass of WfServiceProxy that stores and reuses one token until it is explicitly logged out

AppXtender Workflow Proxy Classes 19

20



Note: The web reference in the WfServiceProxies project points to Web Services located on the current computer (local host). If your Web Services were installed on a different computer, you may need to change the location pointed to by the web reference before you can compile this project.


Index


CComponents of AppXtender Web Services for

Workflow 11

IInstallation and Setup 10

OOverview of Code Samples 14

WWorkflow Administrator Sample Application 15Workflow Client Sample Application 16Workflow Proxy Classes 19


22

Index



Documents

EMC® ApplicationXtender® Web Services for Workflow · ApplicationXtender Web Services for Workflow User’s Guide 7 Preface Conventions used in this document EMC uses the following