SPWorkflow Component
Properties Methods Events Configuration Settings Errors
Manages the workflows of the list items relating to a specific SharePoint list.
Syntax
nsoftware.InSP.Spworkflow
Remarks
The SPWorkflow component allows you to manage SharePoint workflows.
To get started, first set the URL, User, and Password properties to point the component to your Site, and then set ItemURL to the URL of a specific SharePoint item. To retrieve URLs for all of the items in a list, use the SPList component.
When ListWorkflows is called, the Workflow event will fire for each workflow associated with the specified item. Additionally, the WorkflowCount and WorkflowIndex properties can be used to iterate through each workflow. The WorkflowDescription, WorkflowId, WorkflowName, and WorkflowParams properties can be used to get information about each of the workflows returned by SharePoint.
To start a workflow, call the StartWorkflow method with the WorkflowId of the desired workflow.
The ListTasks method is used to list the tasks for a particular item. The tasks can be iterated through using the TaskCount and TaskIndex properties. Each task will populate the TaskParams collection with information about that particular task.
About SharePoint Online Services
When using Microsoft SharePoint Online you must set AuthScheme to authSPOnline (7).
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
AuthScheme | The authentication scheme to be used while authenticating with the server. |
Firewall | A set of properties related to firewall access. |
Idle | The current status of the component. |
ItemURL | The URL for the item. |
Password | The password to use for authentication. |
Proxy | A set of properties related to proxy access. |
SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLServerCert | The server certificate for the last established connection. |
TaskCount | The number of tasks. |
TaskIndex | The task index. |
TaskParams | A collection of task parameters. |
Timeout | A timeout for the component. |
URL | The base URL for the site. |
User | The user account to use for authentication. |
WorkflowCount | The number of workflows. |
WorkflowDescription | The workflow description. |
WorkflowId | The workflow id. |
WorkflowIndex | The workflow index. |
WorkflowName | The workflow name. |
WorkflowParams | A collection of workflow parameters. |
WorkflowParamXML | The full XML of the workflow parameters. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AlterToDo | Alter a todo task item. |
Config | Sets or retrieves a configuration setting . |
DoEvents | Processes events from the internal message queue. |
Interrupt | Interrupt the current method. |
ListTasks | Lists the tasks for a particular item for the User . |
ListWorkflows | Lists the workflows for a particular item. |
Reset | Resets request-related properties. |
StartWorkflow | Start the workflow. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
Error | Information about errors during data delivery. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
Workflow | Fired for each workflow. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
FormBasedCookies | Holds the security cookies for Form-Based Authentication. |
SPOnlineSecurityCookies | Holds the security cookies for SharePoint Online. |
SPOnlineSSO | Whether to use Single Sign On (SSO) with Active Directory Federation Services (ADFS). |
SPOnlineSTS | The URL of the online STS. |
SPOnlineADFSAuthScheme | The HTTP authentication scheme used when working with SSO. |
SSODomain | Specifies the federation domain configured in Office 365. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowIdenticalRedirectURL | Allow redirects to the same URL. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
EncodeURL | If set to true the URL will be encoded by the component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to true the component will perform a GET on the new location. |
HTTPVersion | The version of HTTP used by the component. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
TransferredHeaders | The full set of headers as received from the server. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
UserAgent | Information about the user agent (browser). |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The TCP port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
RecordLength | The length of received data records. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
UseIPv6 | Whether to use IPv6. |
TcpNoDelay | Whether or not to delay when sending packets. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
CodePage | The system code page used for Unicode to Multibyte translations. |