SharePoint Integrator V4 - Online Help
SharePoint Integrator V4
Questions / Feedback?

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.

AuthSchemeThe authentication scheme to be used while authenticating with the server.
FirewallA set of properties related to firewall access.
IdleThe current status of the component.
ItemURLThe URL for the item.
PasswordThe password to use for authentication.
ProxyA set of properties related to proxy access.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
TaskCountThe number of tasks.
TaskIndexThe task index.
TaskParamsA collection of task parameters.
TimeoutA timeout for the component.
URLThe base URL for the site.
UserThe user account to use for authentication.
WorkflowCountThe number of workflows.
WorkflowDescriptionThe workflow description.
WorkflowIdThe workflow id.
WorkflowIndexThe workflow index.
WorkflowNameThe workflow name.
WorkflowParamsA collection of workflow parameters.
WorkflowParamXMLThe 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.

AlterToDoAlter a todo task item.
ConfigSets or retrieves a configuration setting .
DoEventsProcesses events from the internal message queue.
InterruptInterrupt the current method.
ListTasksLists the tasks for a particular item for the User .
ListWorkflowsLists the workflows for a particular item.
ResetResets request-related properties.
StartWorkflowStart 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.

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
WorkflowFired 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.

FormBasedCookiesHolds the security cookies for Form-Based Authentication.
SPOnlineSecurityCookiesHolds the security cookies for SharePoint Online.
SPOnlineSSOWhether to use Single Sign On (SSO) with Active Directory Federation Services (ADFS).
SPOnlineSTSThe URL of the online STS.
SPOnlineADFSAuthSchemeThe HTTP authentication scheme used when working with SSO.
SSODomainSpecifies the federation domain configured in Office 365.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 4.0.6240.0