Customizing ST Workflow in Web

Frequently, we get asked the question, “Can I customize ST workflows in Web Editor?”  The answer is yes…and no.  Web Editor does allow for some workflow customizations, but there are some limitations.  We’ll cover these limitations, and go over some things to watch for when customizing ST workflow in Web, and deploying those customizations. 

Workflow via Web Editor works pretty much the same as the thick client (or Editor) product.  Users can check their SmartBox, initiate, and participate in workflows just like an Editor user.  The flowchart is also available in the Web, and looks identical to the Editor version.

Like Editor, custom forms may be presented to the user at various events (see supported events below) or via tasks.  The form is a standard ASP.NET (.aspx) page and can use any .NET 2.0 – compatible control or supporting library.  Like its Editor counterpart, Web Editor exposes the SmarTeam session, workflow process object, node, and response to the customization. 

Limitations

Unlike Editor, Workflows in Web Editor can be customized only for the following events:

• Before Send Accept
• Before Send Reject
• After Send Accept
• After Send Reject

The following events are not available to Workflows in Web Editor:

• Before Send
• After Send
• On Receive
• On Open

A note for server-side scripting developers:  On Receive, After Send and Before Send events are available for use in server-side scripts if a GUI isn’t required.

Things to watch for when customizing ST workflow in Web:

• When referencing SmarTeam assemblies (or custom libraries) in a web customization, the Web Editor web.config must be updated to include them.  Ensure that the assembly information is added to the <Assemblies> section of the web.config.
• During development of a customization, it may be necessary to copy some of the SmarTeam assemblies from the GAC (Global Assembly Cache) to a separate folder for ease of referencing.  Remember to update the web.config accordingly for any assemblies referenced.
• Some SmarTeam service packs wipe the web.config during installation.  Before applying any SmarTeam service pack, back up the web.config and take note of the changes made to support the customization.  Be sure to update the versions of the referenced assemblies within the <Assemblies> section after any service pack.
• If using compiled assemblies to support your workflow customization, copy the DLLs to Program Files\SmarTeam\Web Editor\Web\Bin.
• If any configuration is needed to support the customization, add keys to the <AppSettings> section of the web.config rather than a custom xml file.
• Be careful when customizing a form on either Editor or Web Editor if the workflow is to be shared by Editor and Web Editor clients.

These guidelines are just a start when customizing ST workflow in Web.  For additional information on creating custom forms for web workflows, see the SmarTeam document, “SmarTeam-Web Editor Customization Guide.pdf”, available on the Docs installation CD.  This document provides a walkthrough of a simple workflow customization and describes in greater detail the steps required to configure a workflow for usage in the web.  If you need more help than the documentation can provide, please contact us for technical support, or to explore your training options.

Tags: .NET 2.0, custom programming, ENOVIA SmarTeam, forms, service pack, SmarTeam-Web, SmarTeam-Workflow, workflow