Metastorm BPM Release 7.6

Transcription

1 Metastorm BPM Release 7.6 Web Client ASP.NET Web Parts Developer Guide May 2008 Metastorm, Inc.

2 Copyrights and Trademarks Metastorm, Inc. All Rights Reserved. Copyright Notice Metastorm, Metastorm BPM, e-work, Process Pod, Enterprise Process Advantage, ProVision, The Best Process Wins, Proforma, Metastorm Knowledge Exchange, Metastorm DNA, Metastorm Discovery, STAR, Insight, Envision, and Metastorm Enterprise are either registered trademarks or trademarks of Metastorm in the United States and/or other countries. Microsoft, Outlook, SQL Server, Windows, Vista, Active Directory, Visual Basic, JScript, SharePoint and BizTalk are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Adobe is a registered trademark of Adobe Systems, Inc. Netscape is a registered trademark of Netscape Communications Corporation. Other trademarks are the property of their respective owners. Disclaimer Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However, Metastorm accepts no responsibility, and offers no warranty whether expressed or implied, for the accuracy of this publication. No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without the express written permission of Metastorm, Inc. The information in this document is subject to change without notice. Metastorm, Inc. inquiries@metastorm.com ii May 2008 Metastorm Inc., 2008

3 Contents Metastorm BPM Release 7.6 Web Client ASP.NET Web Parts Developer Guide Table of Contents 1 Introduction Acronyms Terminology Getting Started Files and Dependencies Web Part List Adding Metastorm Controls to Visual Studio Supported document types Using the ASP.NET Web Parts Creating a new Web Site Creating a Web Part Page Connecting to a Process Engine Creating a To Do List Creating a Watch List Creating a Blank Form List Creating an Administration Form List Creating a Dashboard View Creating a Custom List Deleting a Web Part Deploying Deploying the Web Site Deploying Client Side Resources Enabling Single Sign On Localization Changing the Language Preference Creating Custom Localization Files Beer House Sample Setting up the database Attaching the Database User Credentials Modifying web.config Single Sign On Known Issues Localization Extending Language support...30 Appendix A Control Properties, Methods and Events ServicePart...31 ToDoListPart...32 WatchListPart...33 BlankFormListPart...34 Metastorm BPM Release 7.6 May 2008 iii

4 AdminFormListPart DashboardViewPart CustomGrid iv May 2008 Metastorm Inc., 2008

5 Web Client ASP.NET Web Parts Developer Guide 1 INTRODUCTION The Metastorm ASP.NET Web Parts are reusable, customizable components that enable Metastorm BPM processes to be monitored and acted upon in ASP.NET web applications. The following diagram illustrates the relationship between the Metastorm ASP.NET Web Parts and other Metastorm BPM components they interact with: Figure 1: Metastorm ASP.NET web parts The features provided by the Metastorm ASP.NET Web Parts are listed below: Process Engine Connectivity The ServicePart web part establishes a connection to a Process Engine using the Metastorm Enterprise Class Library for.net (.NET ECL). The.NET ECL is implemented using.net remoting. To Do List Monitoring The ToDoListPart web part displays the user s To Do list in a configurable grid allowing list items to be viewed and acted upon. Metastorm BPM Release 7.6 May

6 Watch List Monitoring The WatchListPart web part displays the user s watch list in a configurable grid allowing list items to be viewed and acted upon. Process Initiation The BlankFormListPart web part displays the user s blank form list in a configurable grid allowing new processes to be initiated. Process Administration The AdminFormListPart web part displays administration form lists in a configurable grid. Interactive Dashboard Key Performance Indicators can be displayed using the DashboardViewPart web part. Custom List With the CustomListPart web part, process designers can create custom lists instead of using the standard list types provided by Metastorm BPM. 1.1 Acronyms Table 1 below lists acronyms that are used in this guide: Acronym ASP.NET IIS IWA.NET ECL SSO URL Meaning Active Server pages for.net Internet Information Services Integrated Windows Authentication Metastorm Enterprise Component Library for.net Single Sign On Universal Resource Locator Table 1: Acronyms 1.2 Terminology Table 2 below lists terms that have specific meanings for this guide: Engine Service Term Engine Service List Metastorm Enterprise Component Library for.net Metastorm Designer Process Designer Process Engine Web Extensions Meaning A Process Engine configuration in the Engine Service List An XML configuration file containing connection information to Process Engines. This configuration file is used by both the Web Extension and.net ECL. Class library that exposes a.net component based interface to Metastorm functionality. Application used by a Process Designer to design Metastorm processes. The person who uses the Metastorm Designer to create a process using the functions provided by the System Integrator. A single Metastorm server process. The Metastorm Web Extension components installed on the web server. Table 2: Terminology 6 May 2008 Metastorm Inc., 2008

7 Web Client ASP.NET Web Parts Developer Guide 2 GETTING STARTED 2.1 Files and Dependencies The Metastorm ASP.NET Web Parts are defined in the following.net assembly: /bin/metastorm.web.webcontrols.dll Typically this file can be found in the default location: C:\Program Files\Metastorm BPM\ASP.NET Web Parts\Site Template\bin The Metastorm ASP.NET Web Parts also have the following file dependencies: /bin DevExpress.Web.ASPxDataControls.v6.2.dll DevExpress.Web.ASPxGrid.v6.2.dll ework.common.engineutilities.dll ework.engine.interop.eworktransaction.dll Interop.ADODB.dll Metastorm.ECL.dll Metastorm.ECL.Support.dll /bin/de Metastorm.ECL.resources.dll Metastorm.ECL.Support.resources.dll /bin/es Metastorm.ECL.resources.dll Metastorm.ECL.Support.resources.dll /bin/fr Metastorm BPM Release 7.6 May

8 Metastorm.ECL.resources.dll Metastorm.ECL.Support.resources.dll /App_GlobalResources MbpmResources.de.resx MbpmResources.es.resx MbpmResources.fr.resx MbpmResources.resx /Mbpm_Resources/css grid.css /Mbpm_Resources/Images (All files are needed) /Mbpm_Resources/Scripts (All files are needed) The Metastorm ASP.NET Web Parts assembly along with its dependent files should be copied to a shared location for easy access. 2.2 Web Part List The table below lists the Metastorm ASP.NET Web Parts: Logo Web Part Description AdminFormListPart BlankFormListPart CustomListPart DashboardViewPart. ServicePart ToDoListPart WatchListPart A grid control with optional filters to display administration form list items. A grid control with optional filters to display blank form list items. A grid control with optional filters to display custom list items. A dashboad control designed primarily to display Key Performance Indicators and Insight reports in administration forms. A control to provide connections to Metastorm Process Engines. A grid control with optional filters to display to do list items. A grid control with optional filters to display watch list items. Table 3: Metastorm ASP.NET controls 2.3 Adding Metastorm Controls to Visual Studio 2005 Follow the steps below to add the Metastorm ASP.NET controls to the Visual Studio 2005 toolbox: 8 May 2008 Metastorm Inc., 2008

9 Web Client ASP.NET Web Parts Developer Guide 1. Click Start, point to All Programs, and then point to Microsoft Visual Studio Click Microsoft Visual Studio 2005 in the shortcut menu. 3. Click the View menu, and then click Toolbox. 4. Right-click on any existing tab and choose Add Tab from its shortcut menu. 5. In the text box at the bottom of the Toolbox, type Metastorm for the new tab and then press ENTER. 6. Right-click the Metastorm tab in the Toolbox, and then click Choose Items from the shortcut menu. 7. In the Choose Toolbox Items dialog box, click the Browse button in the.net Framework Components tab. 8. In the Open dialog box, use the icon to navigate to the folder containing the Metastorm.Web.WebControls.dll assembly. 9. Double-click the Metastorm.Web.WebControls.dll assembly in the file list. 10. Click OK. The controls listed in table 3 should be automatically selected in the Choose Toolbox Items dialog box. 2.4 Supported document types When creating web part pages that use the MBPM ASP.NET web parts the following document types are supported: <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" " <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" " <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" " Note that the following document type is not supported. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" " Metastorm BPM Release 7.6 May

10 When using the above document type the contents of list web parts are chopped off (see picture on the right). When the correct document type is used the web part looks like the picture on the left. Figure 2: Correct Document Type Figure 3: Incorrect Document Type 10 May 2008 Metastorm Inc., 2008

11 Web Client ASP.NET Web Parts Developer Guide 3 USING THE ASP.NET WEB PARTS This section demonstrates the functionality provided by the Metastorm ASP.NET controls as a series of step-by-step tutorials. 3.1 Creating a new Web Site 1. In Microsoft Visual Studio 2005, click the File menu, and then point to New. 2. Click Web Site. 3. In the New Web Site dialog box, click ASP.Net Web Site. 4. Change the Location and Language settings if necessary. For the examples below, the language is assumed to be Visual C#. 5. Click OK. 6. From the installation folder, copy the App_GlobalResources and bin folders into the root of web site you have just created. The default installation folder is C:\Program Files\Metastorm BPM\ASP.NET Web Parts\Site Template. 7. Right-click in the Solution Explorer, and then click Add New Item in the shortcut menu. 8. From the dialog select Web Configuration File. 9. Click Add 10. Double-click the Web.Config file. 11. Add the following tags just below the <configuration> element. Metastorm BPM Release 7.6 May

12 <configsections> <section name="metastormwebparts" type="system.configuration.dictionarysectionhandler"/> </configsections> <MetastormWebParts> <add key="webclientbaselocation" value=" <add key="engineservicelist" value=" "/> <add key="resourcesfolder" value=" </MetastormWebParts> 12. Set the value attribute of the WebClientBaseLocation <add> element to the base URL of the Metastorm web client. 13. Set the value attribute of the EngineServiceList <add> element to the location of the Metastorm Process Engine service list. 14. Set the value attribute of the ResourcesFolder<add> element as shown in the example above. Make sure that the URL contains the machine name where the web site will run from. If localhost is used in the EngineServiceList or ResourcesFolder value attribute, other machines will not be able to access your site. 3.2 Creating a Web Part Page Follow the steps below to prepare the default web page to use the Metastorm ASP.NET Web Parts: 1. Double-click the Default.aspx file. 2. Replace the document type with: <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" " Refer to section 2.4 for more details on the document type. 3. Replace the tags beneath the page and document type declarations with the tags shown below: <html xmlns=" > <head id="head1" runat="server"> <title>web Parts Page</title> </head> <body> <h1>web Parts Demonstration Page</h1> <form runat="server" id="form1"> 12 May 2008 Metastorm Inc., 2008

13 Web Client ASP.NET Web Parts Developer Guide <asp:webpartmanager ID="WebPartManager1" runat="server"> </asp:webpartmanager> <div> <asp:panel ID="Panel1" runat="server" Borderwidth="1" Width="120" BackColor="lightgray" Font-Names="Verdana, Arial, Sans Serif" > <asp:label ID="Label1" runat="server" Text="Display Mode" Font-Bold="true" Font-Size="8" Width="120" /> <asp:dropdownlist ID="DisplayModeDropdown" runat="server" AutoPostBack="true" Width="120" OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" /> </asp:panel> </div> <br /> <table cellspacing="0" cellpadding="0" border="0"> <tr> <td valign="top"> <asp:webpartzone ID="ServiceZone" runat="server"> </asp:webpartzone> </td> <td valign="top" rowspan="2"> <asp:catalogzone ID="CatalogZone1" runat="server"> <ZoneTemplate> <asp:declarativecatalogpart ID="DeclarativeCatalogPart1" Title="Metastorm Web Parts" runat="server"> <WebPartsTemplate> </WebPartsTemplate> </asp:declarativecatalogpart> </ZoneTemplate> </asp:catalogzone> <asp:editorzone ID="EditorZone1" runat="server"> <ZoneTemplate> <asp:appearanceeditorpart ID="AppearanceEditorPart1" runat="server" /> <asp:layouteditorpart ID="LayoutEditorPart1" runat="server" /> <asp:behavioreditorpart ID="BehaviorEditorPart1" runat="server" /> <asp:propertygrideditorpart ID="PropertyGridEditorPart1" runat="server" /> </ZoneTemplate> </asp:editorzone> <asp:connectionszone ID="ConnectionsZone2" runat="server"> </asp:connectionszone> </td> </tr> <tr> <td valign="top"> <asp:webpartzone ID="MainZone" runat="server"> </asp:webpartzone> </td> Metastorm BPM Release 7.6 May

14 </tr> </table> </form> </body> </html> 4. Drag and drop a Metastorm DashboardViewPart web part just below the <WebPartsTemplate> element. 5. Drag and drop a Metastorm CustomListPart web part just below the <WebPartsTemplate> element. 6. Drag and drop a Metastorm AdminFormListPart web part just below the <WebPartsTemplate> element. 7. Drag and drop a Metastorm BlankFormListPart web part just below the <WebPartsTemplate> element. 8. Drag and drop a Metastorm WatchListPart web part just below the <WebPartsTemplate> element. 9. Drag and drop a Metastorm ToDoListPart web part just below the <WebPartsTemplate> element. 10. Drag and drop a Metastorm ServicePart web part just below the <WebPartsTemplate> element. 11. Add a title for each web part. For example: <cc1:servicepart Title="Engine Service" ID="ServicePart1" runat="server" /> 12..Double-click the Default.aspx.cs file. 13. Add the following code to the _Default class directly under protected void Page_Load(object sender, EventArgs e) { // Fill the dropdown with the names of supported display modes. foreach (WebPartDisplayMode mode in WebPartManager1.SupportedDisplayModes) { String modename = mode.name; // Make sure a mode is enabled before adding it. if (mode.isenabled(webpartmanager1)) 14 May 2008 Metastorm Inc., 2008

15 Web Client ASP.NET Web Parts Developer Guide } } { } ListItem item = new ListItem(modeName, modename); DisplayModeDropdown.Items.Add(item); // Change the page to the selected display mode. protected void DisplayModeDropdown_SelectedIndexChanged(object sender, EventArgs e) { String selectedmode = DisplayModeDropdown.SelectedValue; WebPartDisplayMode mode = WebPartManager1.SupportedDisplayModes[selectedMode]; if (mode!= null) WebPartManager1.DisplayMode = mode; } 3.3 Connecting to a Process Engine The ServicePart web part creates connections to Metastorm Process Engines on behalf of the other ASP.NET web part. Follow the steps below to establish connection to a Process Engine: 1. Press Ctrl+F5 to execute the web application. 2. Select Catalog in the Display Mode dropdown list control. 3. Check the Engine Service option in Metastorm Web Parts panel. 4. Select ServiceZone in the Add to dropdown list control and then click. 5. Click the Add button to add the web part to the web part zone. 6. Select Edit in the Display Mode dropdown list control. 7. Click the icon in the Engine Service web part to display the web part context menu. 8. Select Edit in the context menu. 9. Enter a Metastorm BPM user name in the User Name textbox. 10. Enter the password of the Metastorm BPM user in the Password textbox. 11. Set the appearance as required. 12. Click the OK button to apply changes. 13. Select Browse in the Display Mode dropdown list control. 14. The Engine Service web part should change to something similar to below: Metastorm BPM Release 7.6 May

16 Figure 4: Engine Service web part 15. Close the Internet Explorer window to return to Visual Studio Creating a To Do List The ToDoListPart web part creates To Do list, with optional filters, in a grid to view and take action on. Follow the steps below to create a To Do list: 1. Press Ctrl+F5 to execute the web application. 2. Select Catalog in the Display Mode dropdown list control. 3. Check the Todo List option in Metastorm Web Parts panel. 4. Select MainZone in the Add to dropdown list control and then click. 5. Click the Add button to add the web part to the web part zone. 6. Select Connect in the Display Mode dropdown list control. 7. Click the icon in the Todo List web part to display the web part context menu. 8. Select Connect in the context menu. 9. Click the Create a connection to a Provider link in the Connections Zone. 10. Select Engine Service in the From dropdown list. 11. Click the Connect button to connect to the Engine Service web part. 12. Select Browse in the Display Mode dropdown list control. 13. The Todo List web part should change to something similar to below: Figure 5: To Do List web part 16 May 2008 Metastorm Inc., 2008

17 Web Client ASP.NET Web Parts Developer Guide 14. Close the Internet Explorer window to return to Visual Studio Creating a Watch List The WatchListPart web part creates a Watch list, with optional filters, in a grid. The grid can be viewed and actions taken. Follow the steps below to create a Watch list: 1. Press Ctrl+F5 to execute the web application. 2. Select Catalog in the Display Mode dropdown list control. 3. Check the Watch List option in Metastorm Web Parts panel. 4. Select MainZone in the Add to dropdown list control and then click. 5. Click the Add button to add the web part to the web part zone. 6. Select Connect in the Display Mode dropdown list control. 7. Click the icon in the Watch List web part to display the web part context menu. 8. Select Connect in the context menu. 9. Click the Create a connection to a Provider link in the Connections Zone. 10. Select Engine Service in the From dropdown list. 11. Click the Connect button to connect to the Engine Service web part. 12. Select Browse in the Display Mode dropdown list control. 13. The Watch List web part should change to something similar to below: Figure 6: Watch List web part 14. Close the Internet Explorer window to return to Visual Studio Creating a Blank Form List The BlankFormListPart web part creates Blank Form lists, with optional filters, in a grid to initiate processes. Follow the steps below to create a Blank Form list: Metastorm BPM Release 7.6 May

18 1. Press Ctrl+F5 to execute the web application. 2. Select Catalog in the Display Mode dropdown list control. 3. Check the Blank Form List option in Metastorm Web Parts panel. 4. Select MainZone in the Add to dropdown list control and then click. 5. Click the Add button to add the web part to the web part zone. 6. Select Connect in the Display Mode dropdown list control. 7. Click the icon in the Blank Form List web part to display the web part context menu. 8. Select Connect in the context menu. 9. Click the Create a connection to a Provider link in the Connections Zone. 10. Select Engine Service in the From dropdown list. 11. Click the Connect button to connect to the Engine Service web part. 12. Select Browse in the Display Mode dropdown list control. 13. The Blank Form List web part should change to something similar to below: Figure 7: Blank Form List web part 14. Close the Internet Explorer window to return to Visual Studio Creating an Administration Form List The AdminFormListPart web part creates Administration Form lists, with optional filters, in a grid to administer processes. Follow the steps below to create an Administration Form list: 1. Press Ctrl+F5 to execute the web application. 2. Select Catalog in the Display Mode dropdown list control. 3. Check the Admin Form List option in Metastorm Web Parts panel. 18 May 2008 Metastorm Inc., 2008

19 Web Client ASP.NET Web Parts Developer Guide 4. Select MainZone in the Add to dropdown list control and then click. 5. Click the Add button to add the web part to the web part zone. 6. Select Connect in the Display Mode dropdown list control. 7. Click the icon in the Admin Form List web part to display the web part context menu. 8. Select Connect in the context menu. 9. Click the Create a connection to a Provider link in the Connections Zone. 10. Select Engine Service in the From dropdown list. 11. Click the Connect button to connect to the Engine Service web part. 12. Select Browse in the Display Mode dropdown list control. 13. The Admin Form List web part should change to something similar to below: Figure 8: Admin Form web part 14. Close the Internet Explorer window to return to Visual Studio Creating a Dashboard View The Dashboard View web part creates dashboards to display Key Performance Indicators and Insight reports in Metastorm administration forms. This tutorial requires the KPI Dashboard.xep administration procedure to be published in the Process Engine database. Follow the steps below to create a Stage Performance Dashboard in the Process Monitoring process: 1. Press Ctrl+F5 to execute the web application. 2. Select Catalog in the Display Mode dropdown list control. 3. Check the Dashboard View option in Metastorm Web Parts panel. 4. Select MainZone in the Add to dropdown list control and then click. 5. Click the Add button to add the web part to the web part zone. Metastorm BPM Release 7.6 May

20 6. Select Connect in the Display Mode dropdown list control. 7. Click the icon in the Dashboard View web part to display the web part context menu. 8. Select Connect in the context menu. 9. Click the Create a connection to a Provider link in the Connections Zone. 10. Select Engine Service in the From dropdown list. 11. Click the Connect button to connect to the Engine Service web part. 12. Select Edit in the Display Mode dropdown list control. 13. Click the icon in the Dashboard View web part to display the web part context menu. 14. Select Edit in the context menu. 15. In the Appearance group, enter 352 pixels for the Height and 577 pixels for the Width. 16. Enter Stage Performance Dashboard in the Administration Form Name textbox. 17. Enter Process Monitoring in the Administration Form Group textbox. 18. Select Browse in the Display Mode dropdown list control. 19. The DashboardViewPart now displays the Administration Form specified in step 16. Figure 9: Dashboard View web part 20. Close the Internet Explorer window to return to Visual Studio May 2008 Metastorm Inc., 2008

21 Web Client ASP.NET Web Parts Developer Guide 3.9 Creating a Custom List The CustomList web part displays the custom list created by the Process Designer using the Metastorm Designer application. This tutorial assumes a custom list has already been created in the CustomFolder administration form of the Sample administration procedure. For information publishing a custom list definition, refer to the Administration Guide. Follow the steps below to create a custom list for the Sample procedure: 1. Press Ctrl+F5 to execute the web application. 2. Select Catalog in the Display Mode dropdown list control. 3. Check the Custom List option in Metastorm Web Parts panel. 4. Select MainZone in the Add to dropdown list control and then click. 5. Click the Add button to add the web part to the web part zone. 6. Select Connect in the Display Mode dropdown list control. 7. Click the icon in the Custom List web part to display the web part context menu. 8. Select Connect in the context menu. 9. Click the Create a connection to a Provider link in the Connections Zone. 10. Select Engine Service in the From dropdown list. 11. Click the Connect button to connect to the Engine Service web part. 12. Select Edit in the Display Mode dropdown list control. 13. Click the icon in the Custom List web part to display the web part context menu. 14. Select Edit in the context menu. 15. Enter Sample in the Procedure Name textbox. 16. Enter CustomFolder in the Administration Form Name textbox. 17. Select Browse in the Display Mode dropdown list control. 18. The Custom List web part should change to something similar to below: Metastorm BPM Release 7.6 May

22 Figure 10: Custom List web part 19. Close the Internet Explorer window to return to Visual Studio Deleting a Web Part 1. Select Edit in the Display Mode dropdown list control. 2. Click the icon on a web part to display the web part context menu. 3. Select Delete in the context menu. 4. Click the OK button in popup message to delete the web part Deploying There are additional steps for deploying the web site and deploying client side resources Deploying the Web Site Additional steps are required to deploy a web site that uses the Metastorm BPM ASP.NET Web Parts on a different machine. The web parts use a specific Event source for event logging. 1. To install it, a registry key needs to be created. 2. Create a registry key in this location. HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Eventlog\Applicat ion 3. Name the key Metastorm WSS Integration. 4. Within the new key create a Multi-String value. 5. Name the value EventMessageFile. 6. Set the value to: 22 May 2008 Metastorm Inc., 2008

23 Web Client ASP.NET Web Parts Developer Guide C:\WINDOWS\Microsoft.NET\Framework\v \EventLogMessages.dll Deploying Client Side Resources The client side resources need to be deployed on the machine with the web site. 1. On the machine where the ASP.NET web parts where originally installed copy the folder Mbpm_Resources which can be found in the location: C:\Program Files\Metastorm BPM\ASP.NET Web Parts\Site Template 2. Paste the folder it into the file system where you are deploying the web site. 3. Create a virtual folder in IIS called WebPartClientResources which points to the folder you just copied. The registry key, value and virtual IIS folders are initially setup by the Process Orchestrator for.net install Enabling Single Sign On To enable SSO follow these steps: 1. Make sure that the Metastorm BPM Engine is setup for SSO as described in section 3.3 of the Windows Single Sign-On document. 2. The web site must be set to use integrated windows authentication. 3. The web site s anonymous access is disabled. Note that there is no need to install the SSO web application. Metastorm BPM Release 7.6 May

24 4 LOCALIZATION The Metastorm ASP.NET web parts are shipped with four language resources files: MbpmResources.de.resx German language file MbpmResources.es.resx Spanish language file MbpmResources.fr.resx French language file MbpmResources.resx English language file To change the language used, in Internet Explorer change the language preference. The Beer House sample shipped with Metastorm ASP.NET web parts localizes differently. Refer to section 5.5 Localization for further information. 4.1 Changing the Language Preference The steps for changing the language preference are: 1. On the Tools menu, click Internet Options. 2. Click the General tab and click Languages. 3. Select the required language and click Move Up. 4. Click OK twice. The default location of these files is C:\Program Files\Metastorm BPM\ASP.NET Web Parts\Site Template\App_GlobalResources 24 May 2008 Metastorm Inc., 2008

25 Web Client ASP.NET Web Parts Developer Guide 4.2 Creating Custom Localization Files To create customized localization files follow the steps below: 1. Copy a Metastorm resx file. 2. Rename the file MbpmResources.<culture>.resx Where <culture> is a RFC 1766 language identifier in the following format: <languagecode2>-<country/regioncode2> Where <languagecode2> is a lowercase two-letter code derived from ISO and <country/regioncode2> is an uppercase two-letter code derived from ISO For example, the culture identifier for Arabic (Tunisia) language is ar-tn and the resource file name: MbpmResources.ar-TN.resx For language neutral support, only the <languagecode2> is required. For instance, the text resource file name for neutral Arabic language would be MbpmResources.ar.resx 3. Edit the newly created resx file. 4. Translate the Value strings. 5. Save the file. 6. Change the Language Preference in Internet Explorer. Metastorm BPM Release 7.6 May

26 5 BEER HOUSE SAMPLE A sample is provided called Beer House with the Process Orchestrator for.net. This sample is aimed at developers and contains a starter kit which uses themes and resources. For further information on this ASP.NET Web Parts example refer to the book "ASP.NET 2.0 Website Programming" by Marco Bellinaso. 5.1 Setting up the database During the installation there is an option for attaching the database. If this option is checked, the database is attached automatically. The account under which the application pool for the Beer House sample is running in IIS (by default, Network Service) should have DBO login privileges to the SQL 2005 server where the Beer House database is attached. (This is not applicable to SQL2005 Express Edition.) Attaching the Database If the database is not attached during installation, in SQL Server you will need to run the following query: exec [Your [YourFolder]\Database\TheBeerHouse_Log.ldf The default location of The Beer House is: C:\Program Files\Metastorm BPM\ASP.NET Web Parts\TheBeerHouse\Database User Credentials 26 May 2008 Metastorm Inc., 2008

27 Web Client ASP.NET Web Parts Developer Guide The user credentials should also be changed and then run SQL query. USE TheBeerHouse GO EXEC sp_addlogin 'DBuserName', 'SecretPassword', 'TheBeerHouse' GO EXEC sp_grantdbaccess 'DBuserName', 'DBuserName' GO EXEC sp_addrolemember 'db_datareader', 'DBuserName' GO EXEC sp_addrolemember 'db_owner', 'DBuserName' GO Both the DBuserName and the SecretPassword statements on the script should be changed 5.2 Modifying web.config The web.config file located in the website folder should be updated with the user credentials used above: <connectionstrings> <remove name="localsqlserver"/> <add name="localsqlserver" connectionstring="server=localhost; Initial Catalog=TheBeerHouse; uid=dbusername; pwd=secretpassword" providername="system.data.sqlclient"/> </connectionstrings> Modify the following tags just below the <configuration> element. <configsections> <section name="metastormwebparts" type="system.configuration.dictionarysectionhandler"/> </configsections> <MetastormWebParts> <add key="webclientbaselocation" value=" Metastorm BPM Release 7.6 May

28 <add key="engineservicelist" value=" "/> <add key="resourcesfolder" value=" </MetastormWebParts>Modify the value attribute of the WebClientBaseLocation <add> element to the base URL of the Metastorm web client. Modify the value attribute of the EngineServiceList <add> element to the location of the Metastorm Process Engine service list. Set the value attribute of the ResourcesFolder<add> element as shown in the example above. Make sure that the URL contains the machine name where the web site will run from. 5.3 Single Sign On For those customers who use SSO with the Beer House sample, the setup steps vary slightly as the sample site virtual folder needs to be set to Integrated Windows authentication only. The steps are as follows: 1. Install ASP.NET web parts using Process Orchestrator for.net installer. 2. Set the environment up for SSO as per section 3.12 Enabling Single Sign On. 3. Configure the web parts. 4. On the web machine open IIS. 5. Right click on the sample site, MetastormASPWPBeerHouseSample and select Properties 6. Click the Directory Security tab. 7. In the Authentication access and authentication control section, click the Edit button. 8. In the Authentication Methods dialog, uncheck the Anonymous access checkbox and ensure that the Integrated Windows authentication checkbox is checked. 5.4 Known Issues When using the beer house sample there are a few known issues: Changing the Beer House theme will swap the left & right web part zones the opposite way round. For example, the Left web part zone will appear on the right and the Right web part zone on the left. If adding a To Do, Watch, Admin, Blank Form or Custom List web part to the left zone, the web part may auto expand by a few pixels when you interact with the column headers, page navigation or web part Refresh button (Custom List only). 28 May 2008 Metastorm Inc., 2008

29 Web Client ASP.NET Web Parts Developer Guide If the web parts or sample site times out, clicking on Connect View, Catalog View or Edit View may return an IIS error of Server Error in '/MetastormASPWPBeerHouseSample' Application. This is not the case with both Browse and Design views. Web parts on both the left and right hand zones will not display the menu icon as found in the web parts contained within the center zones. It will instead display a. If changing a Custom List in the Designer and then republishing it, the Custom List web part has to be deleted in the sample site and re-added so that it displays the changes made. Avoid setting a web part s width to relative sizes for example, 100% when using Internet Explorer 6.0. Due to the way controls have been laid out on the page it causes some weird side effects, for example, auto expansion of the columns width and high CPU usage. Footer in the theme PlainHtmlYellow does not expand to the bottom to fit long content. 5.5 Localization The Beer House sample has its own language support and supports English and Italian. Setting the language in the browser options will not affect the language of the Beer House sample. To change the language in the BeerHouse sample: 1. Log in to the sample. 2. From the right hand side click the profile link. For example: Figure 11: Profile link in the Beer House sample 3. In Site preferences change the Language drop down to the desired languge and then click the Update Profile button. Metastorm BPM Release 7.6 May

30 Figure 12: Beer House site preferences Extending Language support To extended the language support to other languages: 1. Open the controls\ UserProfile.ascx file. 2. Locate <asp:dropdownlist runat="server" ID="ddlLanguages"> 3. Modify and save the languages supported, for example: <asp:dropdownlist runat="server" ID="ddlLanguages"> <asp:listitem Text="English" Value="en-US" Selected="true" /> <asp:listitem Text="Italian" Value="it-IT" /> <asp:listitem Text="French" Value="fr-FR" /> <asp:listitem Text="German" Value="de-DE" /> <asp:listitem Text="Spanish" Value="es-ES" /> </asp:dropdownlist> The values used are in the format: Value= <culture> Where <culture> is a RFC 1766 language identifier in the following format: <languagecode2>-<country/regioncode2> Where <languagecode2> is a lowercase two-letter code derived from ISO and <country/regioncode2> is an uppercase two-letter code derived from ISO For example, the culture identifier for the English (United States) language is en-us. Metastorm BPM by default supports English, French, Spanish and German. To extend the language support in Metastorm BPM ASP.NET follow the steps in section.if the language is not supported, for example, Italian in Metastorm BPM ASP.NET, English will be displayed. 30 May 2008 Metastorm Inc., 2008

31 Web Client ASP.NET Web Parts Developer Guide APPENDIX A CONTROL PROPERTIES, METHODS AND EVENTS ServicePart This ASP.NET web part has no interface. It serves as a connection object to a Process Engine. Public Properties User Password EnableJawsSupport EngineServiceListLocation EngineService UseSso WebClientBaseLocation WebClientSsoLocation EngineSession WebClientSettings Gets or sets the Metastorm BPM user name. Gets or sets the Metastorm BPM password. Gets or sets the Boolean flag indicating whether to support the JAWS screen reader. Gets or sets the ECL.NET engine service list. Gets or sets the ECL.NET engine service. Gets or sets the Boolean flag indicating whether Metastorm BPM single sign-on should be used. Gets or sets the Metastorm BPM ASP.NET web client base URL. Gets or sets the Metastorm BPM single sign-on URL. Gets the Metastorm BPM engine session object upon a successful automatic login. Gets or sets the language and regional settings for the Metastorm web client render contents. This setting should not be changed from its default value. Public Methods Metastorm BPM Release 7.6 May

32 Reconnect Disconnect Reconnects to the Metastorm Engine. Log out of the current Metastorm Engine session. Public Events LoginComplete LoginFailed Occurs when the server control has successfully logged in to the Metastorm Engine. Occurs when the server control failed to login to the Metastorm Engine. ToDoListPart This ASP.NET web part displays Metastorm BPM To Do lists in a configurable grid. Public Properties PageSize EnableFiltering FilterWidth PageNumber OrderBy WhereFilter Columns Native Kind Controls SelectedRowBackColor SelectedRowForeColor AlternatingRowCssClass GridHeaderCssClass Gets or sets the page size of the grid. If set to -1 then no paging is used and all rows are returned. Gets or sets the Boolean flag indicating whether to allow filtering of the list. Gets or sets the filter s width. If set to zero then the filter resizes dynamically so all items in it are visible. Gets or sets the zero-based index of the page to display. Gets or sets the alert ORDER BY expression. Gets or sets the alert WHERE filter expression. Gets or sets the Metastorm BPM alert list columns to display. This property is a comma-separated list of columns, where the name of the column refers to the column name in the Metastorm BPM Transaction Protocol elistresponse, see the SharePoint section of the Administration Guide for details. Gets or sets a value determining whether the server control is painted in Windows native style. Gets or sets a value defining the manner in which the control is painted. Returns the list of child controls. Gets or sets the background color of the currently selected row. Gets or sets the foreground color of the currently selected row. Gets or sets the Cascading Style Sheet (CSS) class name to be used for alternating rows. Gets or sets the Cascading Style Sheet CSS class name 32 May 2008 Metastorm Inc., 2008

33 Web Client ASP.NET Web Parts Developer Guide to be used for the header of the grid. GridCssClass FilterWidth DefaultCssClass UseClientLocale Gets or sets the Cascading Style Sheet CSS class name to be used for the grid. Gets or sets the filter s width. If set to zero then the filter resizes dynamically so all items in it are visible. Gets or sets the default Cascading Style Sheet CSS class name. Gets or sets the Boolean flag to indicate the locale to use for the grid. Public Events EngineError Occurs whenever the Metastorm Process Engine returns an error response. WatchListPart This ASP.NET web part displays Metastorm BPM watch lists in a configurable grid. Public Properties PageSize EnableFiltering PageNumber OrderBy WhereFilter Columns Native Kind Controls SelectedRowBackColor SelectedRowForeColor Gets or sets the page size of the grid. If set to -1 then no paging is used and all rows are returned. Gets or sets the Boolean flag indicating whether to allow filtering of the list. Gets or sets the zero-based index of the page to display. Gets or sets the alert ORDER BY expression. Gets or sets the alert WHERE filter expression. Gets or sets the Metastorm BPM alert list columns to display. This property is a comma-separated list of columns, where the name of the column refers to the column name in the Metastorm BPM Transaction Protocol elistresponse, see the SharePoint section of the Administration Guide for details. Gets or sets a value determining whether the server control is painted in Windows native style. Gets or sets a value defining the manner in which the control is painted. Returns the list of child controls. Gets or sets the background color of the currently selected row. Gets or sets the foreground color of the currently selected row. Metastorm BPM Release 7.6 May

34 AlternatingRowCssClass GridHeaderCssClass GridCssClass FilterWidth DefaultCssClass UseClientLocale Gets or sets the Cascading Style Sheet (CSS) class name to be used for alternating rows. Gets or sets the Cascading Style Sheet CSS class name to be used for the header of the grid. Gets or sets the Cascading Style Sheet CSS class name to be used for the grid. Gets or sets the filter s width. If set to zero then the filter resizes dynamically so all items in it are visible. Gets or sets the default Cascading Style Sheet CSS class name. Gets or sets the Boolean flag to indicate the locale to use for the grid. Public Events EngineError Occurs whenever the Metastorm engine returns an error response. BlankFormListPart This ASP.NET web part displays Metastorm BPM blank form lists in a configurable grid. Public Properties PageSize EnableFiltering PageNumber OrderBy WhereFilter Columns Native Kind Controls SelectedRowBackColor Gets or sets the page size of the grid. If set to -1 then no paging is used and all rows are returned. Gets or sets the Boolean flag indicating whether to allow filtering of the list. Gets or sets the zero-based index of the page to display. Gets or sets the alert ORDER BY expression. Gets or sets the alert WHERE filter expression. Gets or sets the Metastorm BPM alert list columns to display. This property is a comma-separated list of columns, where the name of the column refers to the column name in the Metastorm BPM Transaction Protocol elistresponse, see the SharePoint section of the Administration Guide for details. Gets or sets a value determining whether the server control is painted in Windows native style. Gets or sets a value defining the manner in which the control is painted. Returns the list of child controls. Gets or sets the background color of the currently selected row. 34 May 2008 Metastorm Inc., 2008

35 Web Client ASP.NET Web Parts Developer Guide SelectedRowForeColor AlternatingRowCssClass GridHeaderCssClass GridCssClass FilterWidth DefaultCssClass UseClientLocale Gets or sets the foreground color of the currently selected row. Gets or sets the Cascading Style Sheet (CSS) class name to be used for alternating rows. Gets or sets the Cascading Style Sheet CSS class name to be used for the header of the grid. Gets or sets the Cascading Style Sheet CSS class name to be used for the grid. Gets or sets the filter s width. If set to zero then the filter resizes dynamically so all items in it are visible. Gets or sets the default Cascading Style Sheet CSS class name. Gets or sets the Boolean flag to indicate the locale to use for the grid. Public Events EngineError Occurs whenever the Metastorm engine returns an error response. AdminFormListPart This ASP.NET web part displays Metastorm BPM admin form lists in a configurable grid. Public Properties PageSize EnableFiltering PageNumber Native Kind Controls SelectedRowBackColor SelectedRowForeColor AlternatingRowCssClass GridHeaderCssClass Gets or sets the page size of the grid. If set to -1 then no paging is used and all rows are returned. Gets or sets the Boolean flag indicating whether to allow filtering of the list. Gets or sets the zero-based index of the page to display. Gets or sets a value determining whether the server control is painted in Windows native style. Gets or sets a value defining the manner in which the control is painted. Returns the list of child controls. Gets or sets the background color of the currently selected row. Gets or sets the foreground color of the currently selected row. Gets or sets the Cascading Style Sheet (CSS) class name to be used for alternating rows. Gets or sets the Cascading Style Sheet CSS class name to be used for the header of the grid. Metastorm BPM Release 7.6 May

36 GridCssClass FilterWidth DefaultCssClass UseClientLocale Gets or sets the Cascading Style Sheet CSS class name to be used for the grid. Gets or sets the filter s width. If set to zero then the filter resizes dynamically so all items in it are visible. Gets or sets the default Cascading Style Sheet CSS class name. Gets or sets the Boolean flag to indicate the locale to use for the grid. Public Events EngineError Occurs whenever the Metastorm engine returns an error response. DashboardViewPart This ASP.NET web part displays Metastorm BPM action form contents in an IFrame. Public Properties MapName ActionName Gets or sets the admin form map name. Gets or sets the admin form action name. CustomGrid This ASP.NET server control displays Metastorm BPM custom lists in a configurable grid. Public Properties AdminProcedureName AdminFormName PageSize EnableFiltering PageNumber OrderBy WhereFilter Columns Gets or sets the name of the custom list administration procedure. Gets or sets the name of the custom list administration form. Gets or sets the page size of the grid. If set to -1 then no paging is used and all rows are returned. Gets or sets the Boolean flag indicating whether to allow filtering of the list. Gets or sets the zero-based index of the page to display. Gets or sets the alert ORDER BY expression. Gets or sets the alert WHERE filter expression. Gets or sets the Metastorm BPM alert list columns to display. This property is a comma-separated list of columns, where the name of the column refers to the column name in the Metastorm BPM Transaction Protocol elistresponse, see the SharePoint section of the 36 May 2008 Metastorm Inc., 2008

37 Web Client ASP.NET Web Parts Developer Guide Administration Guide for details. Native Kind Controls SelectedRowBackColor SelectedRowForeColor AlternatingRowCssClass GridHeaderCssClass GridCssClass FilterWidth DefaultCssClass UseClientLocale Gets or sets a value determining whether the server control is painted in Windows native style. Gets or sets a value defining the manner in which the control is painted. Returns the list of child controls. Gets or sets the background color of the currently selected row. Gets or sets the foreground color of the currently selected row. Gets or sets the Cascading Style Sheet (CSS) class name to be used for alternating rows. Gets or sets the Cascading Style Sheet CSS class name to be used for the header of the grid. Gets or sets the Cascading Style Sheet CSS class name to be used for the grid. Gets or sets the filter s width. If set to zero then the filter resizes dynamically so all items in it are visible. Gets or sets the default Cascading Style Sheet CSS class name. Gets or sets the Boolean flag to indicate the locale to use for the grid. Public Events EngineError Occurs whenever the Metastorm Engine returns an error response. Metastorm BPM Release 7.6 May