AgilePoint Knowledge Base » Knowledgebase » AgilePoint BPMS Suite » AgilePoint Developer » Coding & APIs

AgileConnector sample for Custom Exception Handling

DouglasD — Thu, 10 Jun 2010 12:51:58 GMT

The information in this article applies to:

AgilePoint Suite v4.0.1 Hotfix 1 or later

TOPIC(S)
	A sample AgileConnector (including source code) for custom exception handling.

SUMMARY
	AgilePoint makes available to customers options for flexibility in exception handling for out-of-the-box, and custom AgileParts by enabling the ability to implement custom logic. This article provides an AgileConnector sample and source code as well as information about how to develop, deploy, and implement an AgileConnector for custom exception handling for AgileParts. Note: Errors in SharePoint and SAP cannot be handled using custom exception handling because these errors tend to be severe with respect to AgilePoint processes. The default behavior for SharePoint and SAP errors is to pause the process and send a notification to the system administrator.

DETAILS
	Please refer to the PDF document contained in the attached ZIP file for additional details.

Last Reviewed:
Keywords:

Use AgilePoint's SendMail API to send email notifications

Brian A — Wed, 01 Jul 2009 10:16:14 GMT

The information in this article applies to:

AgilePoint Developer

GOAL(S)
	Provides an example of how to use AgilePoint's SendMail API to send email notifications.

SUMMARY
	AgilePoint's SendMail API provides application developers a function to develop custom notification scenarios for applications. For example, it can be used to develop custom email notifications at runtime and/or associate email notifications dynamically to any workflow tasks and/or objects within an application. There are two SendMail() functions under different classes: IWFWorkflowService.SendMail() – This function sends out the email, but does not support attachments. For example, this function is commonly used for an application that is not in-process with AgilePoint Server. IWFAPI.SendMail() – This function supports sending out email with attachments, but is only available in AgilePart/AgileWork/AgileStub components. (See Snippets below). An alternative approach for sending an email with attachments in an AgilePoint Web Application is to use the .NET class, System.Net.Mail.SMTPClient. Please note that for emails that are sent out using System.Net.Mail.SMTPClient, AgilePoint Server has no records of these emails. If in case you run into email issues for this scenario, the troubleshooting effort should be focused on the custom code in your Web application. The SMTP Server address is required when using the System.Net.Mail.SMTPClient. The screen captures below provide a sample for how to obtian the SMTP Server address.
	SMTP and Database is configured via the AgilePoint Server Configuration.
EXAMPLE
	Snippet 1: Sample Snippet The following is a C# code snippet of how the SendMail API is called: using System; using System.Collections; using System.Data; using System.Xml; using System.Net; using System.IO; using System.Text; using Ascentn.Workflow.Base; namespace ManagedCode { public class CSharpCodeSnippet { // Invoke method is this class's entry point public void Invoke( WFProcessInstance pi, WFAutomaticWorkItem w, IWFAPI api, NameValue[] parameters) { string emailAddress = WFSystem.SysAdmEMailAddress; string attachment = WFSystem.HomeDirectory + "\\License.en-US.RTF"; IWFActivityInstance ai = api.GetActivityInst(w.ActivityInstID); api.SendMail( pi, ai, emailAddress, null, string.Format("Request for Approval - {0}", pi.ProcInstName), "You are assigned with this task, please review and approve within two days.", attachment); } } } Snippet 2: In AgilePart /// <summary> /// This class is AgilePart runtime class that will be invoked by AgilePoint Server. /// </summary> [AgilePart("Put name here")] public class MyAgilePart : WFAgilePart { [ Description("Put description here"), AgilePartDescriptor(typeof(MyAgilePartDescriptor)) ] public void SendMailByAPI( WFProcessInstance pi, WFAutomaticWorkItem w, IWFAPI api, NameValue[] parameters) { try { string emailAddress = WFSystem.SysAdmEMailAddress; string attachment = WFSystem.HomeDirectory + "\\License.en-US.RTF"; Logger.WriteLine("Send e-mail to '{0}' with attachment '{1}'", emailAddress, attachment); IWFActivityInstance ai = api.GetActivityInst(w.ActivityInstID); api.SendMail( pi, ai, emailAddress, null, string.Format("How To Send E-Mail Using ServerAPI - AgilePart, {0}", pi.ProcInstName), "How To Send E-Mail Using ServerAPI", attachment); if (w.Synchronous) MarkSuccess(api, pi, w, parameters); } catch (Exception ex) { HandleException(api, pi, w, parameters, ex); } } } Snippet 3: In AgileWork /// <summary> /// This class is AgileWork runtime class that will be invoked by AgilePoint Server. /// </summary> [AgileWork("MyAgileWork AgileWork", typeof(MyAgileWorkDescriptor))] public class MyAgileWork : WFAgileWork { #region Constructor public MyAgileWork(WFProcessInstance instance, WFManualActivityInstance activity) : base(instance, activity) { base.AssignWorkItem += new EventHandler(MyAgileWork_AssignWorkItem); } #endregion #region Event Handlers private void MyAgileWork_AssignWorkItem(Object sender, System.EventArgs e) { WFGenerateManualWorkItemEventArgs args = e as WFGenerateManualWorkItemEventArgs; IWFAPI api = args.WFApi; string emailAddress = WFSystem.SysAdmEMailAddress; string attachment = WFSystem.HomeDirectory + "\\License.en-US.RTF"; Logger.WriteLine("Send e-mail to '{0}' with attachment '{1}'", emailAddress, attachment); api.SendMail( this.m_ProcessInstance, this.m_ActivityInstance, emailAddress, null, string.Format("How To Send E-Mail Using ServerAPI - AgileWork, {0}", this.m_ProcessInstance.ProcInstName), "How To Send E-Mail Using ServerAPI", attachment); Logger.WriteLine("MyAgileWork_AssignWorkItem, Activity Instance={0}", base.m_ActivityInstance.DisplayName); } #endregion } Snippet 4: In AgileStub using System; using Ascentn.Workflow.Base; /// <summary> /// Summary description for Class1. /// </summary> public class ProcessDefinition_85B694EF1C014A0FB759FAD859339534 : WFProcessInstance { public ProcessDefinition_85B694EF1C014A0FB759FAD859339534() { } public void SendMailByAPI( WFAutomaticWorkItem w, IWFAPI api) { string emailAddress = WFSystem.SysAdmEMailAddress; string attachment = WFSystem.HomeDirectory + "\\License.en-US.RTF"; Logger.WriteLine("Send e-mail to '{0}' with attachment '{1}'", emailAddress, attachment ); IWFActivityInstance ai = api.GetActivityInst(w.ActivityInstID); api.SendMail( this, ai, emailAddress, null, string.Format("How To Send E-Mail Using ServerAPI, {0}", this.ProcInstName), "How To Send E-Mail Using ServerAPI", attachment); } }

Last Reviewed:
Keywords:

Is it possible to use the AgilePoint Web Controls on top of my Entity Framework data model?

Brian A — Mon, 15 Jun 2009 10:37:06 GMT

Summary

If I have a Web application that has approximately 50 pages, and 10 of them I want associated with an AgilePoint process. I have developed the data model of the whole application using an entity framework, now I want to add these 10 pages "generated" by AgilePoint, is it possible to use the AgilePoint Web Controls but on top of my EF data model?

Applies To

AgilePoint Web applications
AgilePoint Developer

More Information

Binding data controls to an existing data model is implemented using the regular ASP.NET methodology (like providing the DataProviderID, and selecting the DataTextField to bind data from an entity’s property). AgilePoint Web Controls provide the mechanism to bind and persist “Process” related data to the AgilePoint Database. Hence any database (entity-relationship) implementation which is not AgilePoint related can be done the usual way (but AgilePoint provides a Data Population feature to persist data directly into a custom database table without the need to implement a Data Access layer). Also a point to note here is that AgilePoint Web Controls have been inherited from the base ASP.NET Web Controls and function the same way as any other ASP.NET Web Control.

Keywords

AgilePoint Web Controls, ASP.NET, data binding

Process Initiation via startImmediately Paramater

Brian A — Thu, 15 Jan 2009 11:31:05 GMT

Summary

This article provides information in regards to using the startImmediately parameter in the following API:

Create Process Instance
Create Process Instance Ex
Create Sub Process Instance

Applies To

When programmatically initializing processes using the AgilePoint Web Service API, the API provides a parameter that gives control over starting processes immediately (i.e. boolean startImmediately set to true/false).

Symptoms

If the startImmediately parameter value is set to false, a known behavior occurs when doing an IIS reset, where those processes are started.

More Information

It is recommended to always set this parameter to true. This parameter is available only for backward compatibility purposes.

Keywords

startImmediately, API, process initiation, CreateSubProcInst, CreateProcInstEx, CreateProcInst

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:

Access AgilePoint Web Service API from a 3rd party application such as SharePoint or ASP.NET application from a separate machine through Impersonation

Brian A — Mon, 11 Aug 2008 12:40:00 GMT

The information in this article applies to:

AgilePoint Developer
Web Service API

GOAL(S)
	Access AgilePoint Web Service API from a 3rd party application such as a SharePoint component or ASP.NET application in a separate machine through Impersonation.

SUMMARY
	Sometimes application developers may need to implement their own custom component to access AgilePoint through Web Service API. These components can be located in a physically separate machine (for example, calling from a SharePoint Web Part) and when accessing the AgilePoint Server through Web Service API, HTTP - 401 authentication error may occur. For the SharePoint component, it runs under the identity that is specified in the SharePoint Application Pool. In some case, the identity could be set using the NetworkService or LocalSystem. These identities will not be able to get authenticated remotely through IIS and therefore returned the HTTP - 401 error. NOTE: This approach is a solution to the well known double hop issue.

SOLUTION
	In a multiple-server envrionment, it is recommend to set up a dedicated user credential that the 3rd party application code can impersonate to get authenticated cross machine in order to access the AgilePoint Web Service. This dedicated user credential is typically stored in the web.config file of the application which can be retrieved before accessing the Web Service. AgilePoint also provides an API called Surrogate() to allow the custom code to set the login user identity after the initial authentication through the impersonation. This will allow the remaining operation with the Web Service to run under the correct login identity. Here are the steps to do surrogating: In your custom coding for surrogating, at api.SetClientAppName("MyApplication"), put in your desired application name (case sensitive). Open the AgilePoint Server Configuration and click the Extension link, then click the Add button. Enter the application name (case sensitive) you used in the custom coding and also the Impersonator name (see picture below). The Impersonator has to be a registered user and preferably an administrator in AgilePoint Server. Here are some code snippets: //Get the credentials using the dedicated user credential retrieved from the web.config System.Net.NetworkCredential credentials = new System.Net.NetworkCredential(ap.m_ImpersonatorName, ap.m_ImpersonatorPassword, ap.m_Domain); //Get the login user info from the HTTP context string context = this.Context.User.Identity.Name; string errmsg; try { // Workflow Web Service api = new WorkflowService(url); //url is the AgilePoint Server Url, should be obtained from the web.config api.CookieContainer = cookieContainer; api.Credentials = credentials; api.SetClientAppName("MyApplication"); //You must also set the Impersonator to this application name using the AgilePoint Server Configuration api.SetClientLocale("en-US"); api.Surrogate(context); string userName = api.CheckAuthenticated();
	... }

Last Reviewed:
Keywords:

Is it possible to change a manual activity's properties such as participant from .Net code?

Brian A — Wed, 22 Aug 2007 12:28:00 GMT

The information in this article applies to:

AgilePoint Suite
AgilePoint Enterprise Manager
AgilePoint Envision
AgilePoint Developer
AgilePoint Server

TOPIC(S)
	Is it possible to change a manual activity’s properties from .Net code. For example, in the application, setting the participant of an approval from the .NET code.

SUMMARY
	This can be done using the custom attributes.

DETAILS
	Some of the manual activity’s properties can be set dynamically using the Custom Attribute. For example, you can use custom attribute for the Participants property as well as the Length property of the Time Span. In the Participants property, you can specify a custom attribute such as $AssignedParticipants and then use your .NET code to set the custom attribute value for ‘AssignedParticipants’. This way you can dynamically set the participant of your manual activity through .Net code. The following is a sample code snippet in C# to set the custom attribute for $AssignedParticipants: SetCustomAttr(WorkObjectID, "AssignedParticipants", "DomainA\user1"); In the above code snippet, the user DomainA\user1 is assigned as the participant for manual activity that has the participant property set to $AssignedParticipants. Using this approach, you can assign multiple users as the participants by using demlited strings (with semi-colon as the delimiter). For example: SetCustomAttr(WorkObjectID, "AssignedParticipants", "DomainA\user1;DomainA\user2"); In the above code snippet, two users are assigned as the participants.

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:

How can I query a list of Work Items based on Process Template Name?

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

The information in this article applies to:

AgilePoint Suite
AgilePoint Enterprise Manager
AgilePoint Envision
AgilePoint Developer
AgilePoint Server

GOAL(S)
	To query a list of work items based on Process Template Name.

SUMMARY
	API such as QueryWorkList and QueryWorkListEx can be used to query a list of Work Items based on the process template name even though the WF_MANUAL_WORKITEMS table does not have a column for Process Template name (which is kept in a separate table).

SOLUTION
	The following is an example of query a list of work items with a specific process template name. string where = ""; SQLExprBuilder eb = SQLExprBuilder.GetBuilder( Global.DataBaseVendor ); if( criteria.processTemplateName != null && criteria.processTemplateName.Length > 0 ) { // To query the work item list belong to the specified process template name if( where.Length > 0 ) where += " and "; where += eb.GetExpr("WF_PROC_DEFS.DEF_NAME", Constants.EQ, criteria.processTemplateName ); } wks = api.QueryWorkListEx( where ); Or public WFManualWorkItem[] GetProcessInstanceWorkItems( string ProcessInstanceID ) { string _searchClause = ""; try { if ( ProcessInstanceID.Length > 0 ) _searchClause += "WF_PROC_DEFS.DEF_NAME = '" + ProcessTemplateName + "'"; WFManualWorkItem[] wks = api.QueryWorkListEx( _searchClause ); return wks; } catch ( Exception e ) { throw new Exception( "Error with GetProcessInstanceWorkItems", e ); } }

Last Reviewed:
Keywords:

Do you have any example of how to use WFDataGrid web control?

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

The information in this article applies to:

AgilePoint Suite
AgilePoint Enterprise Manager
AgilePoint Envision
AgilePoint Developer
AgilePoint Server

GOAL(S)
	To use WFDataGrid ot bind and display data from AgilePoint.

SUMMARY
	WFDataGrid binds with a xml serialzed dataset.

SOLUTION
	The following is an example of how to use WFDataGrid: protected Ascentn.Workflow.WebControls.WFDataGrid WFDataGrid1; private void ButtonShowProcess_Click(object sender, System.EventArgs e) { // query all process instances for selected process template string sql = string.Format("select PROC_INST_NAME, STATUS, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, STARTED_DATE, DUE_DATE, COMPLETED_DATE from WF_PROC_INSTS where DEF_NAME='{0}'", WFProcessTemplateDropDownList2.SelectedItem.Text.ToString() ); string xml = this.GetAPI().QueryDatabase(sql); DataSet d = new DataSet(); System.IO.StringReader sr = new System.IO.StringReader(xml); System.Xml.XmlTextReader xr = new System.Xml.XmlTextReader(sr); if (xml != "<DataSet />") { d.ReadXml( xr ); } else { d = null; //reset the datasource and DataGrid } xr.Close(); WFDataGrid1.DataSource = d; WFDataGrid1.DataBind(); }

Last Reviewed:
Keywords:

Problem using CreateWorkItem from AgilePart.

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

The information in this article applies to:

AgilePoint Suite
AgilePoint Enterprise Manager
AgilePoint Envision
AgilePoint Developer
AgilePoint Server

SYMPTOMS
	Calling CreateWorkItem with the following parameters inside an AgilePart and it gives an "Object reference not set to an instance of an object" error: api.CreateWorkItem(w.ActivityInstID, "Process Step", "Administrator", `new WFTimeDuration(1, WFTimeUnit.DAY, false),` `string.Empty);`

CAUSE
	CreateWorkItem api must be called from a manual activity.

RESOLUTION
	CreateWorkItem is an api to create a new workitem from an existing manual activity. There is a similar api called CreateLinkedWorkitem which is used to create a new workitem that links the new item with the existing work item. Both of these api can be used from the manual activities. The activity instance ID in CreatWorkItem must be a manual activity instance ID. api.CreateWorkItem( manualActivityInstanceID, ...) In other words, they can not be used in AgilePart or Stub and that’s why you are getting the error.

Last Reviewed:
Keywords:

Receive error message using Web Service AgilePart "Object must implement IConvertible"

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

The information in this article applies to:

AgilePoint Envision

ERROR
	"Error executing web service method (WebMethodName) : Object must implement IConvertible."

STEPS TO REPRODUCE
	This error occurs when a web method's output type needs to implement IConvertible interface in order for the web method to be used with the Web Service AgileShape.

DETAILS
	In some cases, the Type of the object instance returned by a web method may need to implement the IConvertible interface in order for the web method to be used with the Web Service AgileShape.

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

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:

Is it possible to rename a form once a workflow process has been started?

Brian A — Thu, 31 Aug 2006 09:21:00 GMT

The information in this article applies to:

AgilePoint Envision
AgilePoint Developer
AgilePoint InfoPath Integration
AgilePoint SharePoint Integration

QUESTION(S)
	Is it possible to rename a form once a workflow process has started?

SHORT ANSWER
	Yes, and the workflow process will continue to run, but for AgileParts such as MoveFiles, it will assign the original name because the SharePoint Portal Server Integration uses the document location as the process instance name (e.g., /sites/s1/a1/at1/IP5/IP5-2005-0002.xml#1). Currently, AgilePoint stores only the latest document location as a custom attribute during the move event. NOTE: We are taking a closer look at the moment to see if we can extend that.

ANSWER
	One option for renaming a form once a workflow process has started is to use the original name for the current process, then when the file is ready to move into the next state such as modification or published, move the file and then rename it in the new location. Another option would be to create a Rename AgilePart that renames the current document. Reference the SharePoint SDK, it provides API that you can use to modify fields in the existing document including the document name. To change the name of the document, the Field_Name should be Title or Name according to your need. You can then use this Rename AgilePart as the last step in your process template to rename the document when the process is completed. The following are code snippets extracted from the SharePoint SDK document: SPSite siteCollection = SPControl.GetContextSite(Context); SPWebCollection sites = siteCollection.AllWebs["Site_Name"].Webs; foreach (SPWeb site in sites) { SPListCollection lists = site.Lists; for (int i=0; i<lists.Count; i++) { if (lists[i].Title == "List_Name") { SPField fieldChange = lists[i].Fields["Field_Name"]; fieldChange.DefaultValue = "Default_Value"; fieldChange.Description = "Description"; fieldChange.Title = "New_Field_Name"; fieldChange.Update(); } } } You can then leverage this Rename AgilePart as the last step of your process template to rename the document when the process is completed.

Last Reviewed:
Keywords:

Argument for SendMail API without attachment

Justin W — Thu, 03 Nov 2005 17:37:00 GMT

The information in this article applies to:

AgilePoint Server API

SYMPTOMS
	Clients may sometimes use the AgilePoint Server API WFAPI.SendMail to create and deliver email notification dynamically in their custom code. One of the arguments for the API is 'string attachment' which is used to specify the file that will be attached with the email notification. What value should be passed in for this argument if no attachment will be attached in the email.

CAUSE
	Implement the email notification with SendMail API with no attachment needed for the email.

RESOLUTION
	Passing in either null or String.Empty will both work. Followings are some examples: WFApi.SendMail (emailAddress, null, string.Format("How To Send E-Mail Using ServerAPI, {0}", this.ProcInstName), "How To Send E-Mail Using ServerAPI", null); Or: WFApi.SendMail (emailAddress, null, string.Format("How To Send E-Mail Using ServerAPI, {0}", this.ProcInstName), "How To Send E-Mail Using ServerAPI", String.Empty);

Last Reviewed:
Keywords: