AgilePoint Knowledge Base » Knowledgebase » AgilePoint BPMS Suite » AgilePoint Developer

How to use api.QueryWorkList to pull out WorkItems based on ProcessInstanceID?

Brian A — Tue, 12 Aug 2008 10:45:00 GMT

The information in this article applies to:

AgilePoint Suite
AgilePoint Enterprise Manager
AgilePoint Envision
AgilePoint Developer
AgilePoint Server

GOAL(S)
	How to query a list of Work Items based on ProcessInstanceID using the api.QueryWorkList call?

SUMMARY
	There are number of ways to use QueryWorkList or QueryWorkListEx to pull out Work Items associated with different search criteria such as: Status, ProcessInstanceID, Process template name, etc. You can construct a search criteria and then pass it in as an argument to the QueryWorkList or QueryWorkListEx call.

SOLUTION
	The following is an example code of using QueryWorkListEx to retrieve the Work Items based on the Process Instance ID: public WFManualWorkItem[] GetProcessInstanceWorkItems( string ProcessInstanceID ) { string _searchClause = ""; try { if ( ProcessInstanceID.Length > 0 ) _searchClause += " WF_MANUAL_WORKITEMS.PROC_INST_ID = '" + ProcessInstanceID + "'"; WFManualWorkItem[] wks = api.QueryWorkListEx( _searchClause ); return wks; } catch ( Exception e ) { throw new Exception( "Error with GetProcessInstanceWorkItems", e ); } }
	When using the PROC_INST_ID in your search clause, make sure you specify the actual table name you want to search against as PROC_INST_ID exists in multiple tables. The following is an example code of using QueryWorkList to retrieve the Work Items based on the Process Instance ID: String piID = m_ProcInst.ProcInstID; WFAny any = WFAny.Create(piID); WFQueryExpr expr = new WFQueryExpr("PROC_INST_ID", SQLExpr.EQ, any, true); WFManualWorkItem[] wks = api.QueryWorkList( expr );

Last Reviewed:
Keywords:

How to complete a work item in asynchronous web service call with the NeedCallBack property set to true?

Brian A — Mon, 16 Jun 2008 14:00:00 GMT

The information in this article applies to:

AgilePoint Suite
AgilePoint Enterprise Manager
AgilePoint Envision
AgilePoint Developer
AgilePoint Server

GOAL(S)
	Trying to get the asynchronous web service call to work for an activity with NeedCallBack property set to true. Does it require coding and what API should be used?

SUMMARY
	When NeedCallBack is set to true, the activity can only be completed by explicit API call CompleteProcedure(wID).

SOLUTION
	For asynchronous web service calls to work with the NeedCallBack property set to true, the work item will wait for an explicit call back in order to complete. This call back could be from a 3^rd party component which completes the work item explicitly through custom code. In this sceanrio, you will be completing an automatic work item, the API to use is CompleteProcedure(wID) in which work item ID (wID) must be passed in as the argument. NOTE: In order to send the wID, pelase use the $WorkItemID (case sensitive) as one of the Input Parameters.

Last Reviewed:
Keywords:

Find the License Key associated with an installed AgilePoint component

Brian A — Thu, 15 Nov 2007 11:28:00 GMT

The information in this article applies to:

AgilePoint Suite Licensing Information
AgilePoint Envision
AgilePoint Server
AgilePoint Developer

GOAL(S)
	To provide instructions for finding the License Key that is associated with an installed AgilePoint component.

SUMMARY
	The License Key for a particular installed AgilePoint component (Envision, Server, Developer) can be found by either using the utility attached below or by navigating the registry.

SOLUTION
	Solution 1: The easiest way to find the license key associated with a particular installed AgilePoint component is to download and run the ShowlicenseKey.exe utility. This utility can be downloaded as an attachment below. Solution 2: An alternative solution to finding the license key associated with a particular installed AgilePoint component is via the registry as is detailed below. Click Start > Run. In the Open field, type regedit and click OK. Navigate to the following location: My Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Installer\UserData\ Right click on the UserData folder and click Find. Type www.ascentn.com and click Find Next. Press the F3 key until you see "AgilePoint Server" in the Display Name field. The Product ID field shows the License Key information as shown below: Continue pressing the F3 key until you find the AgilePoint Developer and AgilePoint Envision components, each of which displays a Product ID field. This is the License Key used for the installation.

Last Reviewed:
Keywords:

Deploying custom AgilePoint-enabled ASP.NET Web pages developed in Visual Studio 2005 to SharePoint 2007

Brian A — Thu, 13 Sep 2007 12:32:00 GMT

The information in this article applies to:

AgilePoint Developer
AgilePoint SharePoint Integration

GOAL(S)
	To provide information about deploying custom ASP.NET Web pages to SharePoint 2007.

SUMMARY
	When compiling a Web application in Visual Studio 2005 a dll is not generated that can be deployed to SharePoint to allow for AgilePoint-enabled custom task pages to be hosted in SharePoint. If you have a pre-built Web application using Visual Studio 2005 you can download and install a Visual Studio add-in called "WebDeploymentSetup" to generate the dll that is needed. For a new Web application that needs to generate a dll, you can download a Visual Studio add-in called "WebApplicationProjectSetup" that will create the dll in the same way that Visual Studio 2003 does.

SOLUTION
	For a pre-built Web application using Visual Studio 2005 If you have a project that is pre-built in Visual Studio 2005 and you need to deploy that dll and aspx pages to SharePoint 2007, you can install an application called "WebDeploymentSetup". This will allow you to generate a dll that you can deploy. To download, go to: http://download.microsoft.com/download/c/c/b/ccb4877f-55f7-4478-8f16-e41886607a0e/WebDeploymentSetup.msi For instructions on installing go to: http://msdn2.microsoft.com/en-us/library/aa479568.aspx Note: If you want to migrate from Visual Studio 2005 Web Site Projects to Visual Studio 2005 Web Application Projects go to this link for directions: http://webproject.scottgu.com/CSharp/migration2/migration2.aspx To deploy an ASP.NET Web application to SharePoint: Build your project. Go to the bin directory of your Web application project and copy the application dll and the Ascentn.Workflow.WebControls.dll. Paste the dlls to all the SharePoint virtual directories that will be using the aspx pages. Open the web.config file associated with the SharePoint virtual directory and investigate the trust level tag to ensure that the security level attribute is set to “Full”. If this attribute is not set to full an error may be generated after submitting the aspx page. <trust level="Full" originUrl="" /> NOTE: This change must be done for each of the SharePoint Virtual Directories that will be using the aspx page. Copy or deploy your Web project to the SharePoint LAYOUTS\AP directory. Example: C:\Program Files\Common Files\Microsoft Shared\web server extensions\12\TEMPLATE\LAYOUTS\AP IMPORTANT: Do not copy the cs files. Open the web.config file at C:\Program Files\Common Files\Microsoft Shared\web server extensions\12\TEMPLATE\LAYOUTS and paste the following between the <assemblies> tag. NOTE: It is recommended to make a backup copy of the web.config file before making any changes. NOTE: Make sure there are no duplicates. <add assembly="Ascentn.Workflow.WebService, Version=2.0.2.1, Culture=neutral, PublicKeyToken=6404F39064AB2A4E"/> <add assembly="Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71E9BCE111E9429C"/> <add assembly="Microsoft.SharePoint.Portal, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71E9BCE111E9429C"/> <add assembly="Ascentn.SharePoint.Common, Version=4.0.0.1, Culture=neutral, PublicKeyToken=2F06EF94BAC0A40F"/> <add assembly="Ascentn.Workflow.WFBase, Version=2.0.2.1, Culture=neutral, PublicKeyToken=021CA826AE8118AA"/> Reset IIS. For a new Web application that needs to generate a dll using Visual Studio 2005 If you are going to build a new Web project in Visual Studio 2005 and need to deploy that dll and aspx pages to SharePoint 2007, you can install an application called "WebApplicationProjectSetup". This will allow you to build a Web application the way that Visual Studio 2003 does. To download go to: http://msdn2.microsoft.com/en-us/asp.net/aa336618.aspx. For instructions on installing go to: http://msdn2.microsoft.com/en-us/library/aa730880(VS.80).aspx. To deploy an ASP.NET Web application to SharePoint use the same steps as detailed above.

Last Reviewed:
Keywords:

How to initiate a SPS Integration process from an external application?

Brian A — Mon, 25 Jun 2007 11:59:00 GMT

The information in this article applies to:

AgilePoint Suite
AgilePoint Enterprise Manager
AgilePoint Envision
AgilePoint Developer
AgilePoint Server

GOAL(S)
	Learn how to create and start a new SPS Integration process with an external application.

SUMMARY
	Usually SPS Integration processes are initiated by a user uploading a document or filling out a new InfoPath form. You can automate this process by using an external application to upload/spool documents to a document library or use the AgilePoint Web services to upload an InfoPath form to a form library to trigger processes.

SOLUTION
	Users can either leverage the existing event handlers for process initiation or call the API explicitly to initiate the processes for SPS Integration. We do recommend to leverage the existing event handler for the process initiation because our AgilePoint SPS event handlers perform extra operations besides the process initiation. These extra operations are required as part of the SPS Integration. One example is to initiate an InfoPath based process from an external application. Rather than having a user to log into SharePoint and fill out a form, you can create an external module to upload a plain InfoPath form (using pre-defined template and UploadInfoPathForm Web service) into the form library which triggers the event handler to initiate a new process instance. You can include a step in the process to fill out data into the form by using the UpdateInfoPathForm AgilePart. Attached is a sample project which has a C# console program to access the APWS\AgileParts.asmx Web service to call UploadInfoPathForm to upload a plain form (template.xml) to the SharePoint Form library. If the form library is associated with a process template, a process instance will be initiated. In the sample code, an UpdateInfoPathForm call is made to update the InfoPath Form with data from a sample file (UpdateForm.xml). IMPORTANT NOTE: URLs are case sensitive. When referring to URLs in your code, ensure you are using the exact case. If the correct case is not used, processes may not be initiated. The following is the code snippet: private void button1_Click(object sender, System.EventArgs e) { //Plain InfoPath Form to upload XmlDocument xmlDoc = new XmlDocument(); xmlDoc.Load("c:\\template.xml"); //Access the AgilePart web service APWS.AgileParts apws = GetAPWS( "http://virtual:8080" ); //Upload the plain InfoPath to a specific Form Library string s = apws.UploadInfoPathForm("http://virtual:8080/sites/AscentnFinancialSite/TestUpload", "TestUpload", "yyMMdd", "0000", xmlDoc.OuterXml); textBox1.Text = s; string s2 = apws.GetProcessInitialAttributes(s); textBox2.Text = s2; //Update the InfoPath Form with the latest data xmlDoc.Load("c:\\UpdateForm.xml"); apws.UpdateInfoPathForm(s, xmlDoc.OuterXml); } The above sample is built under the Virtual PC environment with SharePoint installed at http://virtual:8080. The SharePoint Form Library for this sample is: http://virtual:8080/sites/AscentnFinancialSite/TestUpload and the InfoPath Form associated with the library is template.xsn as attached in the zip file. To test the sample: Make the appropriate changes to the SharePoint URL, Form Library and test login credential. Open and rebuild the solution, make sure no error is occurred. Copy the template.xml and UpdateForm.xml to c:\ folder. Run the Upload.exe under the bin\Debug folder to simulate the test. Similarly, you can also implement your own AgilePart that leverages UploadInfoPathForm in the existing AgilePart Web service, the following is code snippet: #region AgilePart : UploadInfoPathForm [ Description("UploadInfoPathForm"), AgilePartDescriptor( typeof(UpdateInfoPathFileDescriptor) ) ] public void UploadInfoPathForm( WFProcessInstance pi, WFAutomaticWorkItem w, IWFAPI api, NameValue[] parameters) { WriteToLog("Start update"); try { Hashtable h = Convert2Hasttable( parameters ); string fileUrl = (string)h["InfoPathFileURL"]; XmlDocument xmlDoc = new XmlDocument(); xmlDoc.Load("c:\\template.xml"); WriteToLog(xmlDoc.OuterXml); WriteToLog(fileUrl); APWS.AgileParts apws = GetAPWS( fileUrl ); apws.UploadInfoPathForm(fileUrl, "TestUpload", "yyMMdd", "0000", xmlDoc.OuterXml); if( w.Synchronous ) MarkSuccess(api, pi, w, parameters); WriteToLog("succes"); } catch ( Exception ex ) { HandleException(api, pi, w, parameters, ex ); WriteToLog(" Exception = " + ex.ToString()); } WriteToLog(""); } #endregion

Last Reviewed:
Keywords:

AgilePoint Developer is not creating AgilePoint Web Application completely

Brian A — Thu, 15 Mar 2007 16:44:00 GMT

The information in this article applies to:

IE 7 users with AgilePoint versions 3.2.0.4 (.NET 2.0), 4.0.0.0 (.NET 2.0), or 4.0.0.0 (.NET 3.0)
AgilePoint Developer

SYMPTOMS
	When using AgilePoint Developer to create a new AgilePoint Web Application or to AgilePoint enable an existing Web Application, AgilePoint Developer fails to properly create all the necessary parts.

CAUSE
	This problem only occurs for IE 7 users with AgilePoint versions 3.2.0.4 (.NET 2.0), 4.0.0.0 (.NET 2.0), or 4.0.0.0 (.NET 3.0).

RESOLUTION
	Download the Developer.Hotfix.zip file attached to this article. Instructions for applying this fix are in the README.txt file. Copy the default.htm file to: C:\Program Files\Microsoft Visual Studio 8\Web\WebProjWizards\CSharp\AGILEPOINTWEBAPP\html\1033\default.htm -and- C:\Program Files\Microsoft Visual Studio 8\Web\WebProjWizards\VB\AGILEPOINTWEBAPP\HTML\1033\default.htm NOTE: a) 1033 is for U.S. English, you may check LCID on your local machine. b) Folder "C:\Program Files\Microsoft Visual Studio 8" is the Visual Studio 2005 installation folder. It may be different on your machine. Copy Developer.dll to the AgilePoint Developer folder (C:\Program Files\Ascentn Corp\AgilePoint Developer). IMPORTANT: If your AgilePoint Developer folder is not at C:\Program Files\Ascentn Corp\AgilePoint Developer, please change four "CodeBase" entries in the developer_fix.reg file with the correct file path. Apply registry developer_fix.reg by right-clicking on the file and selecting Merge.

Last Reviewed:
Keywords:

Can't access SharePoint site after installation

Brian A — Tue, 21 Nov 2006 11:16:00 GMT

The information in this article applies to:

Microsoft SharePoint

SYMPTOMS
	Receive Internet Explorer Security dialog when trying to launch SharePoint. NOTE: The following steps are only recommended when setting up the Ascentn Financial Site application in an AgilePoint evaluation environment. Consult your SharePoint Administrator when installing for other purposes (e.g. production environment installations).

CAUSE
	The SharePoint site is not yet part of the Trusted sites in Internet Explorer.

RESOLUTION
	Launch the SharePoint main page (http://Machine_Name:Share_Point_Port_Numer/default.aspx) in Internet Explorer. The Internet Explorer Security dialog appears as shown above. Click Add. The Trusted Sites dialog appears. In the Add this web site to the zone field, type in http://Machine_Name (the machine name that hosts the SharePoint Portal Server). Make sure Required server verification (https://) for all sites in this zone is unchecked and click Add, then Close. If your company policy prevents you from adding the SharePoint site to the Trusted Sites, you should first find out if you are accessing SharePoint using Internet or Local Intranet. (You can find out by accessing the SharePoint site and looking at the status bar at the bottom of the IE window, which will indicate if you are running SharePoint using Internet, Local Intranet, or Trusted. Depending on which mode you use to access SharePoint, change the Internet Security Settings for that mode by following these steps: Click Tools > Internet Options > Security > and click on the Custom Level button. Under Reset to, choose Low. Click Reset and then Yes. Under Settings, make sure the settings below are enabled: Under ActiveX controls and plug-ins: Download unsigned ActiveX control Initialize and script ActiveX controls not marked as safe Under Miscellaneous Allow scripting of Internet Explorer Web browser control Submit nonencrypted form data Under Scripting Active scripting Under User Authentication > Logon Automatic login with current username and password Click OK then Yes.

Last Reviewed:
Keywords:

When developing AgileParts and AgileWorks, it is often desirable to write information to the AgilePoint Server log

Brian A — Tue, 10 Oct 2006 09:21:00 GMT

The information in this article applies to:

AgilePoint Developer
AgilePoint Server

TOPIC(S)
	When writing AgileParts and AgileWorks, it is often desirable to write information to the AgilePoint Server log.

SUMMARY
	See below.

DETAILS
	The code below can be used to write infomation about your custom AgilePart or AgileWork to the AgilePoint Server log file. Logger.WriteLine(“YourAgilePartName: {0}”, yourLogMessge) If you wish to write log messages only when AgilePoint Server debug mode is enabled, check WFSystem.DebugMode as follows: if (WFSystem.DebugMode) { Logger.WriteLine(“YourAgilePartName: {0}”, yourLogMessge); }

Last Reviewed:
Keywords:

How to incorporate changes in a process template into an existing AgilePoint Web Application project?

Brian C — Thu, 28 Sep 2006 10:09:00 GMT

The information in this article applies to:

AgilePoint Suite
AgilePoint Enterprise Manager
AgilePoint Envision
AgilePoint Developer
AgilePoint Server

GOAL(S)
	Update an AgilePoint Web Application project with an updated process template to sync up the changes in the process template.
	Scenario: User created a process template using AgilePoint Envision and then created a new AgilePoint Web Application project in Visual Studio .NET to automatically build the pages. Now, the user has made some changes to the workflow, including the addition of new manual activities, and would like VS.NET to create stubs for the new pages. User can't figure out how this is done and is not sure if he/she needs to delete the solution and start again.
SUMMARY
	It is not necessary to delete the whole solution and start again. See below for details.

SOLUTION
	If you have made changes to your process template such as adding new manual activities, the way to incorporate the new changes into your AgilePoint Web Application is as follows: First, make sure you back up or duplicate the existing source files such as: .aspx, .aspx.cs, .aspx.resx and vsd.cs files; especially those that you have modified after the initial auto-generation. Copy the new process template, .vsd into another folder. In the Visual Studio .NET, in the opened solution, remove the two process template files under the Process Templates folder. They should be .vsd and .vsd.cs. You may want to back these up before removing. Select Tools > Generate Process Template Skeleton (Stub and ASP.NET page). Browse and select the new updated process template file. You will see the following message.
	You may also receive the following warning about files that already exist. Click OK to continue and the wizard will leave the existing files untouched and generate new files if needed. In the event that any existing files do get overwritten, copy those files back into the project from where you had previously backed them up.

Last Reviewed:
Keywords:

When testing and debugging custom AgileShapes, how can I ensure that AgilePoint Envision is using the correct version

Brian A — Fri, 15 Sep 2006 16:02:00 GMT

The information in this article applies to:

AgilePoint Envision
AgilePoint Developer

TOPIC(S)
	Testing and debugging custom AgileShapes

SUMMARY
	When testing and debugging custom AgileShapes (including AgileParts and AgileWorks), how can I ensure that AgilePoint Envision is using the correct version because once it is installed in the GAC, it is hard to tell whether AgilePoint Envision is using the latest version especially when you are changing the code frequently.

DETAILS
	When making minor implementation changes to an AgilePart or AgileWork, use the same assembly version number when you recompile. (i.e. make sure that the AssemblyInfo file in your project uses a hard-coded version number, and does not include any wildcards). After compiling a new version, add it to the GAC, or use the AgilePart Deployment Utility to deploy it. If AgilePoint Server is already running and has already loaded an older copy of the assembly into memory, then you will need to reset IIS (e.g. run "iisreset") or restart the AgilePoint Server application in order to force AgilePoint Server to load the newer copy of the assembly into memory the next time it is needed. If you compile a new copy of the assembly with a new assembly version number (as opposed to #1 above), then you will also need to unregister and reregister the AgileShape's assembly in Envision. However, if you followed the recommendations in #1 above, then you do not need to unregister or reregister the AgileShape's assembly from Envision (other than the single, initial registration of the assembly before you first use it. If you follow the above steps, then you should be able to test and debug your custom AgileShapes without any problems.

Last Reviewed:
Keywords:

Create a process instance using AgilePoint's Workflow API

Brian A — Fri, 15 Sep 2006 13:23:00 GMT

The information in this article applies to:

AgilePoint Developer

GOAL(S)
	To provide information about creating a process instance using AgilePoint's Workflow API.

SUMMARY
	The file attached below provides a samle project and source code for creating a process instance using AgilePoint's Workflow API.

SOLUTION
	Below is the sample code from the CreateProc.cs file. using System; using Ascentn.Workflow.Base; namespace Ascentn.HowTo { /// <summary> /// Summary description for CreateProc. /// </summary> class CreateProc { /// <summary> /// The main entry point for the application. /// </summary> [STAThread] static void Main(string[] args) { string agilePointUrl = "http://localhost:8088/AgilePointServer"; try { // Instantiate a workflow api object WorkflowService api = new WorkflowService(agilePointUrl); // Set credentials api.Credentials = System.Net.CredentialCache.DefaultCredentials; // process template name must be same as the one designed by AgilePoint Envision string processTemplateName = "NewHire"; // get UUID of released process definition string pid = api.GetReleasedPID(processTemplateName); // Generate a unique process instance ID string piid = Ascentn.Workflow.Base.UUID.GetID(); // Create a unique name for the process instance string piname = "MyProcess_" + DateTime.Now.ToString("MMdd-HHmmss"); // Create a unique work object ID; string workObjectId = string.Format("MyProcess-{0}",UUID.GetID()); string superPIID = null; // No parent process ID in this example string customID = null; string attrVal1 = "Testing one"; bool attrVal2 = false; // Initialize custom process attributes NameValue[] attrs = NameValue.Array( "MyAttrOne", attrVal1, "MyAttrTwo", attrVal2 ); // Start the process WFEvent evt = api.CreateProcInstEx(pid, piid, piname, workObjectId, superPIID, customID, attrs, true); Console.Write("Started: " + piname); } catch (Exception ex) { Console.Write("Error: " + ex.Message); } } } }

Last Reviewed:
Keywords:

For Visual Basic ASP.NET AgilePoint Web applications, the Task Page is not displaying correctly

Brian A — Fri, 15 Sep 2006 09:54:00 GMT

The information in this article applies to:

AgilePoint Developer

ERROR
	For Visual Basic ASP.NET Web application projects, the Task Page is not displaying correctly. The following error occurs:

STEPS TO REPRODUCE
	Build an AgilePoint ASP.NET Web application with a Visual Basic project including task pages. At run-time, launch a task page and see that the task page does not display correctly.

DETAILS
	The interim fix is to open the TaskPage.aspx.vb source in AgilePoint Developer and drop the "0" index of the WFManualWorkItem() array. Private Sub TaskListControl1_QueryTaskListData(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles TaskListControl1.QueryTaskListData Dim api As IWFWorkflowService = GetAPI() Dim statusList As String = String.Format("{0};{1};{2}", WFManualWorkItem.ASSIGNED, WFManualWorkItem.OVERDUE, "Pseudo") Dim wks() As WFManualWorkItem = api.GetWorkListByUserID(GetCurrentUser(), statusList) If wks Is Nothing Then wks = New WFManualWorkItem(0) {} ß correction is WFManualWorkItem() {} End If Dim qArgs As TaskListControl.QueryTaskListEventArgs = CType(e, TaskListControl.QueryTaskListEventArgs) qArgs.Data = wks End Sub

Last Reviewed:
Keywords:

Is it possible to include multiple steps within an activity instead of creating separate activities?

Brian A — Thu, 14 Sep 2006 16:23:00 GMT

The information in this article applies to:

AgilePoint Envision
AgilePoint Developer

QUESTION(S)
	In AgilePoint, is it possible to create multiple steps within an activity instead of creating separate activities (e.g. an approval activity that consists of a participant receiving and responding to an email).

SHORT ANSWER
	This can be done by managing the list of work items within an activity using the AgileWork framework.

ANSWER
	To be able to handle more dynamic scenarios, such as associating multiple work items with one single activity you can explore the AgileWork framework. The AgileWork framework allows you to build highly dynamic process models that can self-adapt at run-time driven by metadata or business rules and can be easily mastered by business users (without incurring IT to custom code each scenario). This is in stark contrast to traditional code-generation based workflow tools that are good for fairly static, repetitive automations (e.g. for simple document approvals but not for dynamic approvals). It has been communicated to us more and more from our enterprise customers (who list the support of ‘dynamic’ approval scenarios one of their biggest challenges) that they were unable find this type of functionality in the traditional workflow tools they employed, which led to their current adoption of AgilePoint. This is also one of the key differentiations between Business Process Management and Workflow.

Last Reviewed:
Keywords:

How can I find the AgilePoint Web Controls such as: WFTextBox in Visual Studio .Net Toolbox?

Brian A — Tue, 12 Sep 2006 09:14:00 GMT

The information in this article applies to:

AgilePoint Suite
AgilePoint Enterprise Manager
AgilePoint Envision
AgilePoint Developer
AgilePoint Server

GOAL(S)
	To incorporate AgilePoint Web Controls into Visual Studio.NET Toolbox.

SUMMARY
	See Below for details.

SOLUTION
	The AgilePoint Web Control can be added into the Visual Studio.NET following these steps: Launch Visual Studio .NET and select Tools > Add/Remove Toolbox Items… In the Customize Toolbox dialog, click on the Browse… button. Browse to the [Drive]\Program Files\Ascentn Corp\Developer\Assembly folder to locate the Ascentn.Workflow.WebControls.dll Select the dll and click Open to add the web control to the toolbox and the web controls will be shown in the Customized Toolbox as shown: Now select the web controls that you want to use and mark the check boxes. Click OK to complete the addition. Now these web controls will be available when you are working on a web page in the Visual Studio.NET.

Last Reviewed:
Keywords:

How to register a new user and assign the new user a role using the API?

Brian A — Tue, 12 Sep 2006 09:09:00 GMT

The information in this article applies to:

AgilePoint Suite
AgilePoint Developer
AgilePoint Server

GOAL(S)
	Use Web Service API to register a new user and add a role to the user programmatically.

SUMMARY
	APIs of RegisterUser and AddRoleMember can be used respectively. Please see details below.

SOLUTION
	The following is a sample code snippet that registers a user into AgilePoint as well as adding the user into a Role as a role member. AdminService adm = new AdminService(this.textBoxAPUrl.Text); adm.CookieContainer = new System.Net.CookieContainer(); adm.Credentials = System.Net.CredentialCache.DefaultCredentials; RegisteredUser newuser = new RegisteredUser("virtual\\pm2", "virtual@ascentn.com", DateTime.Now, "Virtual User"); adm.RegisterUser(newuser); adm.AddRoleMember("QA", "virtual\\pm2", "User", "", null, null); As you can see in the code snippet, RegisterUser api is used to register a user into AgilePoint and AddRoleMember api is used to add a registered user into a Role.

Last Reviewed:
Keywords:

How to pass the InfoPath form xml to a web service agilepart as an argument?

Brian A — Tue, 12 Sep 2006 09:08:00 GMT

The information in this article applies to:

AgilePoint Envision
AgilePoint Server

GOAL(S)
	I want to use the web service activity in Envision in order to send the InfoPath form to a web service that reads the xml and updates our database. Could you explain how to map the xml of the form to the web method parameter?

SUMMARY
	Arguments to web service agilepart are passed in as custom attributes. A built-in custom attribute $// can be used to pass the InfoPath xml as the argument to web service agilepart.

SOLUTION
	In web service AgilePart, the argument passed in such as $xmldoc is actually referring to the custom attribute with the name: xmldoc. For example, if you want to pass in the whole InfoPath xml, one way is to set a custom attribute with the InfoPath xml as the value of the custom attribute and then you can further pass it as the argument of the web service agilepart input. In all InfoPath based process instance, AgilePoint will set an internal custom attribute ($//) that contains the xml of the whole InfoPath. You can directly pass it the custom attribute of $// as the argument to the web service agilepart. Please see attached screen shot as an example:

Last Reviewed:
Keywords:

How to generate a custom attribute with multiple participants information?

Brian A — Tue, 12 Sep 2006 09:07:00 GMT

The information in this article applies to:

AgilePoint Suite
AgilePoint Envision
AgilePoint Developer
AgilePoint Server

GOAL(S)
	How do I assign a task to two different participants that are not in any shared group? for instance, if someone completes an infopath form and selects two people from a list, how can I assign a manual task to both of these selected people? I tried to use a comma separated list, but this breaks the workflow.

SUMMARY
	Semi-colon instead of comma is the separator for participant list.

SOLUTION
	You can concatenate a list of participants into a single custom attribute and pass it as the participant of a manual activity. This way multiple manual work items will be created and assigned to each participant in the list. The separator of the participant list must be Semi-colon. For example: Mydomain\user1;Mydomain\user2

Last Reviewed:
Keywords:

Error when using the InfoPathForm AgilePart

Brian A — Tue, 12 Sep 2006 09:06:00 GMT

The information in this article applies to:

AgilePoint Suite
AgilePoint Enterprise Manager
AgilePoint Envision
AgilePoint Developer
AgilePoint Server

SYMPTOMS
	Running a process template with an UpdateInfoPathForm AgilePart, the following error occurred in the log file: Failed to find the procedure with process='/sites/BPM/Conferences/1/Conference-0033.xml#1', activity='Update InfoPath', and procedure='#AgilePart:Ascentn.Workflow.SPSAgileParts,

CAUSE
	The AgilePoint Server is running an older version of the AgilePoint.

RESOLUTION
	The UpdateInfoPathForm AgilePart is introduced in v3.1.6.3. If the AgilePoint Server is running an older version, the process templated created with a newer version that has such AgilePart will fail running in this server and the above error will occur. To resolve the issue, please upgrade your AgilePoint Server to v3.1.6.3 or higher.

Last Reviewed:
Keywords:

What is the purpose for the location column on the AgilePoint SharePoint Web part?

Brian A — Tue, 12 Sep 2006 09:05:00 GMT

The information in this article applies to:

AgilePoint Suite
AgilePoint Enterprise Manager
AgilePoint Envision
AgilePoint Developer
AgilePoint Server

TOPIC(S)
	What's the purpose of the Location column in the AgilePoint SharePoint Web Part. Sometimes it is showing information such as Process Instance ID which is not meaningful to the end users.

SUMMARY
	Please see details below.

DETAILS
	The Location column is used different depending whether it is a SharePoint document/form based process or a Web application based process. For SharePoint Document/Form library based processes, the location column in the SharePoint Web part is used to show the location of the document or form relative to the SharePoint server. This provides user a quick link into the actual library to perform addition work if needed, such as editing or viewing the properties of the document etc. When you are incorporating Web application tasks into the SharePoint Web part, this column instead will be used to display the Process Name associated with this particular task. This provides you the additional information to reference the process instance that is associated with the task. In some Web application processes, it may show the Process Instance ID here if the process instance uses process instance ID as the process name. Normally, this is controlled by the process initiation program/module of your web app. If you use the ProcessInstanceID as the name of the process instance during the process instance creation, therefore the ProcessInstanceID will be shown here. In order to show more meaningful name here for the web app. based processes, it is recommended to use a more meaningful Process Name during the process creation. One example is to use the combination of the Process Template Name and a time stamp.

Last Reviewed:
Keywords:

Delete a document file from a SharePoint Document Library

Brian A — Tue, 12 Sep 2006 09:05:00 GMT

The information in this article applies to:

AgilePoint SharePoint Integration
AgilePoint Server
AgilePoint Envision
AgilePoint Developer

GOAL(S)
	To delete a document file from a SharePoint Document Library.

SUMMARY
	This article provides a few options for deleting a document file in a SharePoint Document Library.

SOLUTION
	Option 1: Build a custom web service (that would be installed on your SharePoint Server) that uses the SharePoint SDK to delete a specified SharePoint document. Then call the web service from your process using the Web Service AgileShape. Option 2: Build a custom AgilePart that uses the SharePoint SDK to delete a specified SharePoint document. Then use the AgilePart in your process. NOTE: The SharePoint SDK can only be used in code that executes directly on the SharePoint server machine, so this option would only work if AgilePoint Server is installed and running on the same machine as SharePoint. Otherwise, you would need to use web services (or some other means of remote code execution) to call the code containing the SharePoint SDK calls from within your AgileShape (e.g. as described in Option 1). Option 3: Use the Move Files AgileShape to move the document to a "trash" or "to be deleted" library. This will remove the file from your main library, but will not remove the document from SharePoint completely. However, you could periodically delete all documents in the specified library manually to finish the removal.

Last Reviewed:
Keywords:

Sorting in WFProcessTemplateDownList Web control

Brian A — Tue, 12 Sep 2006 09:00:00 GMT

The information in this article applies to:

AgilePoint Developer

GOAL(S)
	To provide sorted list (alphetically) of Process Template names in WFProcessTemplateDropDownList Web control.

SUMMARY
	Using the WFProcessTemplateDropDownList Web control in your Web application will return you the list of process template names in the AgilePoint Server in a descending order.

SOLUTION
	The list is sorted starting v3.2.

Last Reviewed:
Keywords:

What is the best way to store server-specific configuration values (e.g. DB connection strings)?

Brian A — Tue, 12 Sep 2006 08:58:00 GMT

The information in this article applies to:

AgilePoint Suite

QUESTION(S)
	What is the best way to store DB connection strings (or other values that must be configured differently for testing and production environments)? I am developing an AgilePart that will need to access a database. What is the best way to make the database connection string available to the AgilePart? It would be nice to have it in the Web.config for the application, but since AgileParts run as part of the server I don't know if the web.config is available. Is there recommended place for this type of information?

SHORT ANSWER
	See below.

ANSWER
	As of AgilePoint v3.2.0.1, one of the best places to do this is via the Shared Custom Attributes page in AgilePoint Enterprise Manager. There you can define (or modify the current values of) "shared" custom attributes that can be used from any process running on the server. However, there is another alternative for storing/retrieving such values from within a custom AgileShape. The AgilePoint Server web application has a web.config file just like any other web application. Therefore, it is possible to add such values as custom keys in the web.config file, and then you can read the values from within an AgilePart or AgileWork just as you would normally.

Last Reviewed:
Keywords:

Change the refresh frequency of the Process Viewer in an AgilePoint ASP.NET web application

Brian A — Tue, 12 Sep 2006 08:58:00 GMT

The information in this article applies to:

AgilePoint Developer

GOAL(S)
	To provide instructions for customizing the refresh rate of the Process Viewer in an AgilePoint ASP.NET Web application.

SUMMARY
	The Process Viewer page in an AgilePoint ASP.NET Web application refreshes itself in order to update the displayed content to match any recent changes. The frequency at which this refresh occurs can be customized by changing a value in the code of the ProcessViewer.aspx page. Depending on your business requirements, server hardware, and end-user usage patterns, increasing the length of this interval (to reduce the frequency at which the Process Viewer refresges) may help reduce the amount of traffic and/or load for your AgilePoint Web Server(s). In some environments, this change may affect server performance and responsiveness.

SOLUTION
	Change the interval value in the ProcessViewer.aspx page. Look for the init( ) function in that page. The default interval is 1000 milliseconds (i.e. 1 second). function init() { window.dialogWidth = "770px"; window.dialogHeight = "500px"; var piID = ProcessViewer.hiddenProcInstID.value; if( piID == null \|\| piID == "" ) return; highlightCtrl = document.all("HighlightActivity"); service.useService("ProcessViewerService.asmx?WSDL","Workflow"); window.setInterval("updateProcessInstance()", 1000); }

Last Reviewed:
Keywords:

Data does not bind in WFDataBindingControl when populating the values during page Load

Brian A — Tue, 12 Sep 2006 08:57:00 GMT

The information in this article applies to:

AgilePoint Developer

SYMPTOMS
	In ASP.NET, if you create a web control such as wfDropDownList and populate it by hard-coding the option values under the control's collection object, binding works as expected (the mapped field is selected on the correct value). However, if I populate the list of items by performing a data bind in the page's load event, it doesn't recognize the binding of the mapped field.

CAUSE
	The values of WFDataBindingControl controls are normally loaded from the workflow DB automatically as part of the page's lifecycle, during the page's Init phase. However, when you dynamically create the controls and add them to the page after the Init phase of the page's lifecycle, the controls' data will not be automatically loaded because it was not present when the page loaded the data. Therefore, the list value must be populated before OnInit(), or the mapped field will not be bound.

RESOLUTION
	Populate the list values before the OnInit() call. To do this, you can call the page's protected "UpdateBindingControls()" method after you have finished creating your dynamic controls and inserting them into the page's control hierarchy. Calling this method manually will reload the data for all of the page's WFDataBindingControl controls. Also, the values of WFDataBindingControl controls are normally saved to the workflow DB automatically as part of the page's "CompleteWorkItem()" method. However, you can also save the values without completing the work item by calling the pages protected "WriteBindingControls()" method.

Last Reviewed:
Keywords:

When registering a custom AgilePart, the assembly is not updated with the latest version of the DLL

Brian A — Tue, 12 Sep 2006 08:56:00 GMT

The information in this article applies to:

AgilePoint Envision
AgilePoint Developer
AgilePoint Server

SYMPTOMS
	When using the AgilePart Deployment Wizard to remove and re-add a custom AgilePart DLL, it doesn’t seem to update the assembly with the latest version of the DLL that was compiled.

CAUSE
	If a previous version of the assembly was already loaded into memory by AgilePoint Server, any changes to the assembly would not take effect until after AgilePoint Server is restarted.

RESOLUTION
	Modifying the assembly will not automatically cause AgilePoint Server to restart. If you want any DLL changes to take effect immediately, you will need to restart IIS or the AgilePoint Server (please refer to the AgilePoint User's Guide for instructions on how to safely shut down and/or restart AgilePoint Server). NOTE: Modifying any file in the BIN directory will automatically cause IIS to restart AgilePoint Server. So copying the DLL into AgilePoint Server's BIN directory should force the changed DLL to take effect immediately. However, if an older version of the DLL is also in the machine's GAC (Global Assembly Cache), the older DLL may still be used if you only put the newer DLL in the BIN folder.

Last Reviewed:
Keywords: