K2.net 2003 SharePoint Process Wizard XML Fields

LEGACY/ARCHIVED CONTENT

This article has been archived, and/or refers to legacy products, components or features. The content in this article is offered "as is" and will no longer be updated. Archived content is provided for reference purposes only. This content does not infer that the product, component or feature is supported, or that the product, component or feature will continue to function as described herein.

The following article explains the use of the XML Field created by the SharePoint Process Wizard.

The purpose of this article is to explain the usage of the various K2.net XML Fields utilized by K2.net to integrate with SharePoint Portal Server 2003.
K2.net 2003 makes use of the following fields AttachedDocuments EventDetails

AttachedDocuments
The "AttachedDocuments" field is a Process XML Field. This field is created by the SPS wizard and populated with data based on the details entered by the user during the configuration steps. The K2.net Document Attachment Control (SmartForm Control) uses this field as the source for all the documents that are part of a process instance. The control has the ability to work with single or multiple documents. The "AttachedDocuments" field is updated by the control to ensure that the correct location of all documents is saved each time a user makes changes to any document or attaches new documents.

Field	Description
server	The server element contains the actual URL that points to the SharePoint server e.g. http://MySPSServer:8181
site	The site element contains the information related to the site where the document is located e.g. /sites/MySiteName
workspace	Not Used. The workspace element is only included for backwards compatibility with previous versions of K2.net 2003.
folder	The folder element contains the name of the actual document library (include subfolders) e.g. Shared Documents
docname	The docname element contains the document name including a valid file extension e.g. MyDocument.doc
filefullurl	The filefullurl element contains the path (URL encoded) relative to the location of the document within SharePoint e.g. http://MySPSServer:8181/sites/MySiteName/Shared%20Documents/MyDocument.doc
id	The document node is the repeating node of the field. The repeating node contains all the details to each attached document that is part of the Process Instance. Each document stored has a unique ID. In a scenario where an action on a document library starts the Process Instance only one document will be listed in this field. The Document attachment control may add more documents to the field later on in the Process Instance.
procinstid	Not Used. The workspace element is only included for backwards compatibility with previous versions of K2.net 2003.
documentid	Not Used. The workspace element is only included for backwards compatibility with previous versions of K2.net 2003.

EventDetail
The "EventDetail" field is a Process XML Field which is created by the SPS wizard and populated during the creation of the Process Instance. Population of the field is based on the action that raised the event in SharePoint. The EventData section stored in the field is based on the public members available on the Microsoft.SharePoint.SPListEvent and Microsoft.SharePoint.SPFile object.

Field	Description
EventType	The action that raised the event e.g. CheckIn, CheckOut
ServerUrl	Stores the relative URL (SPFile.ServerRelativeUrl) of the file based on the URL for the server e.g. http://vm2003:81
SiteFullUrl	Stores the URL (SPFile.ParentFolder.ParentWeb.Url) of the parent folder of the file e.g. http://vm2003:81/sites/Contoso
SiteRelativeUrl	Stores the ServerRelativeUrl (SPFile.ParentFolder.ParentWeb.ServerRelativeUrl) of the parent folder of the file e.g. /sites/Contoso
DocumentLibrary	Stores the Document Library name (SPFile.ParentFolder.Url) containing the document e.g. Shared Documents
DocumentLibraryRelativeUrl	Stores the relative URL (SPFile.ParentFolder.ServerRelativeUrl) of the Document Library e.g. /sites/Contoso/Shared Documents
DocumentLibraryFullUrl	Stores the full URL (SPFile.ParentFolder.ParentWeb.Site.MakeFullUrl(File.ParentFolder.ServerRelativeUrl) of the Document Library e.g. http://vm2003:81/sites/Contoso/Shared%20Documents
FileName	Stores the document file name (SPFile.Name) including the file extension e.g. MyDocument.doc
FileRelativeUrl	Stores the relative URL (SPFile.ServerRelativeUrl) of the document e.g. /sites/Contoso/Shared Documents/MyDocument.doc
FileFullUrl	Stores the full URL (SPFile.ParentFolder.ParentWeb.Site.MakeFullUrl(File.ServerRelativeUrl)) of the document e.g. http://vm2003:81/sites/Contoso/Shared%20Documents/ MyDocument.doc
Fields	Stores collection Field nodes. Each Title attribute holds the title of the meta data column and the inner text of the value. Please note that the collection is based on the Metadata columns selected during the configuration of the wizard. <Field Title="ID">1</Field> <Field Title="Created By">K2DEMO\administrator</Field>