Winshuttle Workflow Configuration Keys; options list with descriptions (A-Z)

Back to

Workflow Configurator option descriptions

Workflow Configuration Options

Name	Workflow Version	Type	Description	Scope
AdHocRouterEnabled	10.5 and later	true \| false \| adminonly	Determines whether or not choosing Route in the context menu in ShareVis Explorer allows the user to create an ad hoc route.	List
AdminEmailReturnAddress	10.5 and later	string	Specifies the contents of the From field in emails that the system sends.	Lowest Available
AllowNoAssignmentSwimLanes	10.5 and later	string	A comma-separated list of swimlanes that are optional in the standard process control. Available only for DocEx. It is not mandatory for swimlanes assigned under this key to be assigned while routing a form. But while routing, the swimlane should be assigned to avoid an error.	List
ArchiveHistoryXsl	10.5 and later	text	The name of the XSL to use in generating the column-based history by the svadm archive operation. The file must reside in the directory \Program Files\ShareVis\config, or wherever the ShareVisConfigDirectory points.	List
AssignedMessage	10.5 and later	text	The message sent when a task is assigned.	Global
AssignmentCompletionButtons	10.5 and later	comma-separated list of any combination of these: all, cancel, save, delete	Describes which buttons to show when completing an assignment.	List
AssignmentStyleNormal	10.5 and later	text	The style to use when showing a normal assignment. (Supported in SharePoint 2007 only.)	List
AssignmentStyleOverdue	10.5 and later	text	The style to use when showing an overdue assignment. (Supported in SharePoint 2007 only.)	List
AssignmentStyleWarn	10.5 and later	text	The style to use when showing a warning assignment. (Supported in SharePoint 2007 only.)	List
AssignmentSummaryNotificationEnabled	10.5 and later	true \| false	Whether or not to send a summary of all open assignments via email to each assignee.	Global
AssignmentSummaryNotificationTimeOfDay	10.5 and later	text	The time of day to send the open assignment summary.	Global
AssignmentSummaryNotificationRescheduleHours	10.5 and later	integer	The number of hours to wait to reschedule the next open assignment email.	Global
AssignmentSummaryNotificationSchemeAuthorityPort	10.5 and later	string	The first portion of the URL to use in the links in the summary email. For example, http://www.somesite.com:8100	Global
AutoApproveNewFolders	10.5 and later	true \| false	Whether or not ShareVis should automatically approve new folders created in a DocEx library.	List
AutoSaveInterval	10.5 and later	integer	The number of minutes to wait before automatically saving the contents of a form in the background.	List
AttachmentControlValidationRegExp	10.5 and later	text	Regular expression to use with custom Attachment Control validation. Defaults to ^([a-zA-Z0-9_ ]+\\.?)+$ This key works in conjunction with the AttachmentControlValidationType key.	List
AttachmentControlValidationType	10.5 and later	standard \| custom	How the form Attachment Control validation should behave. Standard behavior searches the file name for known illegal characters, and then present an error if a file name contains those characters. Custom retrieves a regular expression from the AttachmentControlValidationRegExp key, and if that regular expression does not match the file name, presents the error to the end user. IMPORTANT: The TYPE must be specified in lower case, i.e. standard or custom. This key works in conjunction with the AttachmentControlValidationRegExp key.	List
AutoCheckout	10.5 and later	true \| false	Controls the behavior of a Value Setter operation. If AutoCheckout is true, and the list item requires checkout before updating, and the list item is not already checked out, then the list item will automatically be checked out/in while updating the list value.	List
AutoDeleteBlankRepeatingFormAreas	10.5 and later	true \| false	Whether or not to automatically delete blank rows in repeating tables and sections in forms.	List
AutoDeleteNonShareVisVersions	10.5 and later	true \| false	Determines whether or not the system automatically purges non-ShareVis versions after a document's process has been set to either approved or completed. (Purging will not take place if a document's contents are rejected.)	List
AutoIncrementFormVersion	10.5 and later	true \| false	Determines whether or not to automatically increment a form’s version when doing a Resubmit.	List
AutoMarkInactiveProcesses	10.5 and later	true \| false	Whether or not to automatically mark a process as being inactive if an exception is thrown when accessing the site, list, or item associated with the process.	Global
AutoRunLookupRunRules	10.5 and later	start \| startandend	When to run InfoPath rules during an autorun Lookup Control. Start runs only before the lookup is done, and startandend runs both before and after the lookup.	List
BackgroundFormProcessing	10.5 and later	true \| false	Whether or not to process forms in a background thread.	List
Bcc	10.5 and later	semicolon-delimited list of email addresses to blind copy	A list of email addresses to blind copy anytime correspondence is sent.	List
BlockedMessage	10.5 and later	text	The email message that is sent when a process becomes blocked.	Global
BulkReassignmentPermissionSets	10.5 and later	string	Comma-separated list of permission sets that have the rights to perform bulk reassignments.	Global
BusinessCalendar	10.5 and later	true \| false	If true, the system will not consider holidays (specified in sharevis.config) and weekends when calculating due dates. If false, the system will do a straight calendar-based calculation.	Global
ButtonLabelApprove	10.5 and later	text	The label to use for the Approve button.	List
ButtonLabelCancel	10.5 and later	text	The label to use for the Cancel button.	List
ButtonLabelContinue	10.5 and later	text	The label to use for the Continue button.	List
ButtonLabelReject	10.5 and later	text	The label to use for the Reject button.	List
ButtonLabelRoute	10.5 and later	text	The label to use for the Save and Route button.	List
ButtonLabelSave	10.5 and later	text	The label to use for the Save button.	List
BypassDestinationTasks	10.5 and later	text	Comma-separated list of Task names that should be bypassed.	List
BypassDoubleHopSecurity	10.5 and later	true \| false	Bypass double hop security system. True (True is default for Workflow 10.9 and later): Application will use its own proprietary security mechanism to communicate with Winshuttle Server web services. False: Application will not use its own proprietary security mechanism to communicate with Winshuttle Server web services. Note: If Launch GUI and Kerberos are both included in your setup, set this key to "true".	Global
BypassSourceTasks	10.5 and later	text	Comma-separated list of Task names whose assignees will be eligible for bypass later in the workflow.	List
CancelEnabled	10.5 and later	true \| false	Whether or not the Cancel option is available for Originators who are non-admins.	List
CancelMessage	10.5 and later	text	The email message that is sent when a process is cancelled by an administrator or the Originator.	Global
CannedCancelComments	10.5 and later	text	A comma delimited list of cancellation reasons to be displayed when a process is being canceled. Each reason can be in the form 'DisplayText' or 'DisplayText\|Value'	List
CannedCancelMode	10.5 and later	string	Valid modes are 'prepend', 'append', or 'overwrite'. The default mode is overwrite where the selected cancellation reason is stored as the user comment. With prepend and append modes the selected cancellation reason is combined with the user comment.	List
Cc	10.5 and later	semicolon-delimited list of email addresses to copy	A list of email addresses to copy anytime correspondence is sent.	List
CheckInExcludeColumns	10.5 and later	comma-separated list of field names	This option specifies the user-created columns in the document library that should not be displayed in the check-in form.	List
ColorWarningThreshold	10.5 and later	integer	This number tells the system when the color should be set to the warning color in the ShareVis Task List.	Global
ColorWarningThresholdUnits	10.5 and later	days\|hours	The units used by the ColorWarningThreshold key.	Global
ConfiguratorCacheTTL	10.5 and later	timespan	The amount of time that a Configurator value should be valid before reloading the key values.	Global
ConfiguratorCacheType	10.5 and later	value\|table	value caches individual Configurator items. table caches the whole Configurator table.	Global
CustomCss	10.5 and later	text	Path to a custom CSS file. (Supported in SharePoint 2007 only.)	Global
DatabaseImpersonationDomain	10.5 and later	text	Domain for database login. Set by the Installer.	Global
DatabaseImpersonationPassword	10.5 and later	text	Password for database login. Set by the Installer.	Global
DatabaseImpersonationUsername	10.5 and later	text	Username for database login. Set by the Installer.	Global
DefaultMessage	10.5 and later	text	The email message that is sent when an item is set for automatic approval.	Global
DelimitedCommentFilterRegex	10.5 and later	text	This key is used to remove html content that is displayed in Show Form (process history) after using EMailApprovalType as delimited eg. DelimitedCommentFilterRegex- <.*?> This is applicable for email approval cases.	Global
DetailViewPageSize	10.5 and later	integer	Specifies the maximum number of items to display on the detail pages.	Global
DocReturnPage	10.5 and later	string	The URL of the page to return to after submitting or canceling a DocEx file.	List
DocumentVersionColumn	10.5 and later	text	The name of the column to display as the document’s version in the ShareVis History page.	List
DocumentWorkspaceInheritance	10.5 and later	true \| false	Indicates whether or not to treat the document workspace such that potential workflow participants are chosen from a document workspace while the processes are chosen from the parent site.	Global
DropdownTooltipsEnabled	10.5 and later	true \| false	Whether or not to show the drop-down list tooltips.	List
EdgeConfiguration	10.5 and later	text	The name of the file that contains the Edge Server rules and other Edge configuration items.	Global
EdgeServers	10.5 and later	comma-separated list of edge server hosts	Specifies the Edge Servers that should be synchronized with documents in document libraries.	List
EMailApprovalAddress	10.5 and later	text	The address to which email approval messages are sent.	Global
EMailApprovalApproveSubject	10.5 and later	text	Template for the email subject in an approval message with an approved disposition.	List
EMailApprovalBody	10.5 and later	text	The body to use when composing an email to send back for approval during email approvals.	Global
EMailApprovalBoundaryRegExp	10.5 and later	text	A regular expression to use in searching for the boundary in an email approval reply-type email. Everything following should be ignored in the comment placed into the workflow. This works with xml escape character sequence
EMailApprovalCompleteSubject	10.5 and later	text	Template for the email subject in an approval message with a completed disposition. Works in conjunction with EMailApprovalReceipt=True.	List
EMailApprovalDeleteMessage	10.5 and later	true \| false	Whether or not to delete messages that are received by the email approval account after the message has been processed.	Global
EmailApprovalIgnoreIncludeItem	10.5 and later	true \| false	Specifies whether 'Include Item' is ignored while sending email with attachment or not.	List
EMailApprovalMailServer	10.5 and later	text	The email approval mail server to which the system should connect to find email assignment completions.	Global
EMailApprovalMailServerPort	10.5 and later	integer	The email approval mail server port.	Global
EMailApprovalMailServerType	10.5 and later	text	The type of mail server for email approvals. Can be either pop3 or imap.	Global
EMailApprovalPassword	10.5 and later	text	The email approval password on the POP3 server.	Global
EMailApprovalPop3Server	Obsolete .	text	The email approval POP3 server.	Global
EMailApprovalPop3ServerPort	Obsolete .	integer	The email approval POP3 server port.	Global
EMailApprovalReceipt	10.5 and later	true \| false	Whether or not to send a receipt email after an email approval submission.	Global
EMailApprovalRegExp	10.5 and later	text	The regular expression to use when parsing the return message for email approvals. This regular expression should extract the comment for the assignment as the first group.	Global
EMailApprovalRegExpGroups	10.5 and later	0 \| 1	Describes which regular expression group indexes to use when searching for a comment from an email approval. The first non-empty string will be used as the comment.	Global
EMailApprovalRejectSubject	10.5 and later	text	Template for the email subject in an approval message with a rejected disposition.	List
EMailApprovalRescheduleTime	10.5 and later	integer	The amount of time to wait between checking the email approval account for a new message	Global
EMailApprovalSubjectRegExp	10.5 and later	text	The regular expression to use when parsing the return message subject for email approvals. This regular expression should extract the identifying keys for the assignment as the first group.	Global
EMailApprovalSubjectRegExpGroups	10.5 and later	comma-separated integers	Describes which regular expression group indexes to use when searching for the identifying keys in the subject of an email approval. The first non-empty string will be used as the key string.	Global
EMailApprovalType	10.5 and later	text	The type of message sent back to the handler. Can be plaintext, delimited, or regexp.	Global
EMailApprovalUser	10.5 and later	text	The email approval user on the POP3 server.	Global
EMailApprovalUseSSL	10.5 and later	true \| false	Whether or not to use SSL when the email approval mailbox is polled. Note: If EMailApprovalUseSSL is set to True, set StartTLS to False.	Global
EMailAssignmentSubject	10.5 and later	text	Template for the email subject in an assignment message.	List
EmailCancellationSubject	10.5 and later	test	This option defines the subject of the e-mail notification that is sent when a process is canceled.	List
EMailDispositionDescription	10.5 and later	text	The description to use in the email disposition section of an assignment email and a participant receives the assignment task.	Global
EMailDispositionTitle	10.5 and later	text	Used with email approval, this is the title to use in the email disposition section of a notification email.	Global
EMailExceptionSubject	10.5 and later	text	Template for the email subject in an exception message. The default value is as follows: Process Exception: [$ProcessDefinition.Name] - [$Activity.Name] Process Name: [$Process.Name] This can be customized as needed.	List
EMailIncomingAnonymousCode	10.5 and later	text	For email sent from external mail servers. Use with EMailIncomingAnonymousIdentity to confirm that the sender of an attached document is legitimate. The value can be any string, but the string must exist in the subject or body of the email, otherwise the email is discarded. No effect when email is sent by a valid SharePoint user.	List
EMailIncomingAnonymousIdentity	10.5 and later	text	For email sent from external mail servers. Specify an email address or user name that can be used to add an attached doc to the doc library. If no value is provided, the email will be discarded. Values: "system" uses the system identity to create the document. When no value is provided the email is discarded. No effect when email is sent by a valid SharePoint user.	List
EMailNotificationStyles	10.5 and later	text	Styles to embed in the notification emails. These styles can be referred to in the body of the email.	List
EMailNotificationSubject	10.5 and later	text	Template for the email subject in a notification message.	List
EMailPastDueSubject	10.5 and later	text	Template for the email subject in a past due message.	List
EMailReminderSubject	10.5 and later	text	Template for the email subject in a reminder message.	List
EnableBlackbirdLogs	11.4.0	true \| false	Whether to generate Blackbird logs.	Global
EnforcePrivilegedUser	10.5 and later	true \| false	Whether or not to throw an exception when a user who is not privileged attempts to view history for an item.	List
EnforceUniqueFormName	10.5 and later	true \| false	If this value is true, the system will not allow two forms with the same form name.	List
ExcludeFormFieldSyncs	10.5 and later	text	Comma-separated list of fields to exclude when synchronizing a form’s data with SharePoint fields.	List
FiscalYearStart	10.5 and later	number, >= 1 and <= 12	The one-based month in which the fiscal year begins. This is used by the Quarter component of the Name Template Generator.	Site
ForcedApprovalMessage	10.5 and later	text	The email message that is sent when an item is force approved by an administrator.	Global
ForceRejectionMessage	10.5 and later	text	The email message that is sent when an item is force rejected by an administrator.	Global
ForceUseAssignmentView2	10.5 and later	boolean	If set to true, the entire system will use AssignmentView2 with the NOLOCK statement. The purpose of this option is to aesolve database deadlocks. See also UseAssignmentView2 (below).	Global
FormAlignment	10.5 and later	left, right, or center	How to align the form within the SharePoint page.	List
FormApplicationMaster	10.5 and later	text	The name of the application master file to use for the form.	List
FormAttachmentExtension	10.5 and later	text	The extension to use when attaching a read-only form to an email message.	List
FormCopyEnabled	10.5 and later	true \| false	Whether or not to allow a user to copy a form.	List
FormDefaultButtons	10.5 and later	true \| false \| comma-separated list of views	Whether or not to display the default buttons at the bottom of the form. If a list of views is given, only those views will contain the buttons in a form. Composer Notes: When using a comma-separated list, go into the properties of your InfoPath view, and remove the extra text after the actual name of the view. When using Composer, the pre-defined fields have different internal names. In this key you need to use the internal name (see below): Composer Name: Internal Name Originator View: ShareVisPreProcessView ReSubmit View: ShareVisResubmitView Process Status View: ShareVisProcessStatusView Process Completed View: ShareVisPostProcessView	List
FormInternalDateFormat	10.5 and later	text	The internal format in which to store dates in forms. The preferred format is XSD format.	Global
FormInternalDateTimeFormat	10.5 and later	text	The internal format in which to store date/times in forms. The preferred format is XSD format.	Global
FormLibraryCacheDayLimit	10.5 and later	integer	This is the maximum age (in days) of a Form before it will no longer be available in the Form Library Web part. The default value is -1, which indicates there is no limit. All forms will be displayed regardless of age. This value can be used to improve the performance of the Form Library Web part when there are a large number of legacy Forms that you do not require to be displayed. Note: This Key is only effective when Dynamic Refresh is ON for the Form Library Web part.	List
FormLibraryCacheShared	10.5 and later	true \| false	By default the Form Library Web part provides each user with their own private Form Library cache. This is necessary when the security configuration allows different users to access different items in a list. However, if security is configured in such a way that all users have equal access to all the items in a list, then setting this value to true will enhance performance of the Form Library Web part by allowing all users to share a single cache. Note: This Key is only effective when Dynamic Refresh is ON for the Form Library Web part.	List
FormMargin	10.5 and later	true \| false	Whether or not to display the standard SharePoint left margin when completing forms.	List
FormMsxmlType	10.5 and later	3, 6, or auto	The version of MSXML to use. The auto option will attempt to use MSXML6, and if it cannot be found, it will use MSXML3. Changing this value requires republication of any forms in question.	List
FormPreProcess	10.5 and later	true \| false	Whether or not to preprocess the form when it is published.	List
FormProcessingPage	10.5 and later	true \| false	Whether or not to display the working page after submitting a form.	List/Site
FormResubmitEnabled	10.5 and later	true \| false	Whether or not to allow a user to resubmit a rejected or canceled form.	List
FormResubmitAllowedOnApprovedForm	10.5 and later	true \| false	Whether or not to allow the resubmitting of an approved form.	List
FormReturnPage	10.5 and later	string	The URL of the page to return to after submitting or canceling a form.	List
FormReplace	10.5 and later	string	Sequenced set of strings to replace when a search string is located. See FormSearch.	List
FormSearch	10.5 and later	string	Sequenced set of strings to search for when expanding a form definition. See FormReplace.	List
FormTitle	10.5 and later	string	The name to display as the title of a form.	List
FormTitleType	10.5 and later	default \| formname \| custom	How the name displayed at the top of a form should be determined.	List
FormSharePointHeader	10.5 and later	true \| false	Whether or not to display the standard SharePoint top header when completing forms.	List
FormUpdateType	10.5 and later	always \| auto \| none	The type of form completion to use. always does a form update every time a field in the form changes. auto computes the field dependencies in the form, and only updates when necessary. none does no updating of the form when field values change.	List
HistoryControlXsl	10.5 and later	text	The name of the XSL to use in generating the History Control markup in a form. The file must reside in the directory \Program Files\ShareVis\config, or wherever the ShareVisConfigDirectory points.	List
Holiday	10.5 and later	text (date)	Holiday keys are 'hidden' keys but they can be manually created and configured so that when a due date for a task is calculated, the specified holiday (date) will be factored into the calculation. Note: Holiday keys are respected only if the BusinessCalendar configuration key value is set to True. Adding configuration keys (Workflow 10.5-10.7 ) Adding configuration keys (Workflow 10.8 and later ) You can create and define more than 1 holiday key, but the keys must be created and numbered sequentially (for example, Holiday0, Holiday1, Holiday2, etc.) for all of the keys to be calculated. If a number is missing (for example, you have the following 3 keys: Holiday1, Holiday2, and Holiday4), Holiday4 will not be calculated because Holiday3 is missing. Holiday keys must be specified using the same date format (for example, mm/dd/yyyy) as the SharePoint server.	List
IgnoreLateFlag	Obsolete		Obsolete	Global
IgnoreReminderFlag	Obsolete		Obsolete	Global
IncludeImplicitlyCompletedHistoryItems	10.5 and later	true \| false	Whether or not to include assignments that are implicitly approved by either default approval periods or because of team assignment settings.	List
IncludeNotificationHistory	10.5 and later	true \| false	Whether or not notifications are displayed in the workflow history.	List
IncludePluginHistory	10.5 and later	true \| false	Whether or not information about the plug-ins is included in the workflow history.	List
IncludeSelf	Obsolete	true \| false	Whether or not the current user should be included when selecting workflow participants if that user happens to be a member of site groups associated with the swimlanes of the process. This option is now specified on a swimlane-by-swimlane basis in ShareVis Designer in a process definition.	Global
Inherit	10.5 and later		Obsolete	Global
InlineDocumentDisplay	10.5 and later	true \| false	Whether or not to display a routed document’s contents inline in the approval form if possible.	List
InlineDocumentHeight	10.5 and later	text	Height of the inline document.	List
InlineDocumentWidth	10.5 and later	text	Width of the inline document.	List
ItemCache	10.5 and later	true \| false	Indicates whether or not to use the ShareVis Explorer item cache.	Global
JavascriptInclude	10.5 and later	comma-separated list of paths to Javascript	The paths to Javascript files to include in forms.	List
LocalUrl	10.5 and later	text	The root url for the Web application that Winshuttle Workflow uses. Note: Make sure the value is correct; if it is incorrect, a workflow will stop working.	Global
ms-authoringcontrols	10.5 and later	text	ShareVis components that generate markup (ie Process Control, etc) typically use the SharePoint theme enabled CSS class named 'ms-authoringcontrols'. This config value can be used to change that to a different class name.	List
NoOfPageLinksBeforeAndAfterCurrentPage	10.9 and later	Number	For a paginated list, this value is the number of additional web page links displayed before and after the page that the user is currently viewing. For example, if this value is set to 5 and a user is viewing page 20 of 50, the user would see links for pages 15-19 and 21-25 (with '...50' added to the end of the links). Default Value is 10.	List
NoPerformerMessage	10.5 and later	text	The email message that is sent when at least one workflow participant has not been assigned to a swimlane when an assignment is made in that swimlane.	Global
OfflineFormProcessorDeleteMessage	10.5 and later	true \| false	Whether or not to delete messages that are received by the offline form processor account after the message has been processed.	Global
OfflineFormProcessorMailServer	10.5 and later	text	The mail server to use for offline form processing.	Global
OfflineFormProcessorMailServerPort	10.5 and later	text	The port for the offline form processor mail server.	Global
OfflineFormProcessorMailServerType	10.5 and later	text	The type of mail server for offline form processing. Valid values are imap or pop3.	Global
OfflineFormProcessorPassword	10.5 and later	text	The password for the user to connect to the mail server for offline form processing.	Global
OfflineFormProcessorReceiptMessage	10.5 and later	text	The message to send when an offline form has been accepted for processing.	Global
OfflineFormProcessorRescheduleTime	10.5 and later	timespan	The timespan string to use in calculating rescheduling of the offline form processing.	Global
OfflineFormProcessorUser	10.5 and later	text	The user to connect to the mail server for offline form processing.	Global
OfflineFormProcessorUseSSL	10.5 and later	true \| false	Whether or not to use SSL when doing the offline form processing.	Global
OriginatorApprovalCheck	10.5 and later	true \| false	Key enables additional SOX compliance functionality and is disabled by default (disabled = set to “false”).	Global
OutOfOfficeDelegationDuration	10.5 and later	Integer	Specifies the maximum duration (in calendar days) for Out of Office Delegation. The default value is -1, which indicates there is no limit on maximum duration. Note that this key is respected while setting up Out of Office Delegation. If a selected duration for an Out of Office Delegation is more than the duration specified in this key, a warning/error is displayed.	Global
PageLevelCacheMaxCount	10.5 and later	integer	The number of items that the page level cache can contain before space is reclaimed.	Global
ParserEnabled	10.5 and later	true \| false	Whether or not to enable the SharePoint Office document property parser when uploading documents.	List
ParticipantFormFilter	10.5 and later	true \| false	Indicates whether or not to display the additional form filter in the ShareVis Form Library Web Part. This filter’s options are Show forms where I…, have rights to see, am the Originator, or am a participant. Note that for this option to work, SharePoint permissions must be modified on the form lists in question so that SharePoint returns the list items appropriately (FormEx only).	Site
PastDueMessage	10.5 and later	text	The message sent when an assignment is past its due date.	Global
PluginDirectory	10.5-10.7	file system path	Where the plug-ins are located. Set by the Installer.	Global
PollingTime	10.5 and later		Obsolete .	Global
PreferredHostname	10.5 and later	text	The hostname to use instead of the default SharePoint hostname.	Global
PrinterFriendlyMenuEnabled	10.5 and later	true \| false	Whether or not to show the printer-friendly menu options.	List
ProcessControlledDocumentLibraryMenuFilterEnabled	10.5 and later	true \| false	Whether or not to run the filter responsible for replacing the SharePoint system menu with the ShareVis menu in a Process Controlled Document Library’s detail page.	Site
ProcessControlXsl	10.5 and later	text	The name of the XSL to use in generating the Process Control markup in a form displaying a form’s status. The file must reside in the directory \Program Files\ShareVis\config, or wherever the ShareVisConfigDirectory points.	Global
ProcessDefinitionFilterType	10.5 and later	Trivial\|SiteGroup	Describes the implementation to use for the process definition filter. Can be used to filter out processes based on the Originator’s site group, for example.	List
ProcessNameColumn	10.5 and later	text	The name of a SharePoint column from which the system will attempt to retrieve the name of the process to run. If this column has a value that matches the processes published to the list, no other selections will be available upon check-in.	List
ProcessOwner	10.5 and later	login identifier	The login ID of the person designated as the ProcessOwner for the given list. This should be of the form DOMAIN\USERNAME.	List
ProcessSelectionServerUpdate	10.5 and later	true \| false	Indicates whether or not a server transaction should be completed when a user changes the selected process when checking in a document or starting an explicit predefined route. Setting this option to true will boost performance when displaying the check-in or start route pages. This option must be false if you are using Labeled Assignments.	Global
ProcessStartButtons	10.5 and later	comma-separated list of any combination of these: all, cancel, save	Describes which buttons to show when starting a new process.	List
ProcessStatusColumn	10.5 and later	text	The name of a SharePoint column to populate with the current ShareVis process status.	List
ProcessStyleNormal	10.5 and later	text	The style to use when showing a normal process. (Supported in SharePoint 2007 only.)	List
ProcessStyleOverdue	10.5 and later	text	The style to use when showing an overdue process. (Supported in SharePoint 2007 only.)	List
ProcessStyleWarn	10.5 and later	text	The style to use when showing a warning process. (Supported in SharePoint 2007 only.)	List
PromptOnReject	10.5 and later	true \| false	Whether or not to prompt the user when the Reject button is clicked.	List
PruneItemXmlCacheFormXml	10.5 and later	true \| false	True: Removes FormXml information from the ItemXml column of WFProcess table. False: Leaves FormXml information from the ItemXml column of WFProcess table. Default value: True	List
ReferenceUrl	10.5 and later	string	The URL to use in any emails sent to assignees.	List
ReminderMessage	10.5 and later	text	The message sent when an assignment has come within the threshold of its due date.	Global
ReminderPeriod	10.5 and later	integer	The number of days before an assignment is due that the system begins sending reminder emails.	Site
RestrictedFormLaunchersSPGroup	10.6 and later	SharePoint group name	The value for this key is a SharePoint group. Members of this group will be unable to launch a new form from the following locations: Form Library Webpart: Restricted users are unable to see the form launch icon, as well as the copy and resubmit links in the context menu for the Web part. ListItem: Restricted users that launch a form from the list item will see an error message. Plugins: Form Monitor, Form Process Launch, and Launch Form plugins are used to launch a new form. If a user is restricted to launch a form, then while running svservice.exe, the status of the Plugin will be changed to 'Error' and the process ends. (The user can see the error message in the logs.) Offline Forms: Restricted users can not launch a new form process from offline forms. The originator receives an email saying that user is not authorized to do the same Launch From URL: Launching a form from a URL generates an error message for the user.	Site
ReviewPageRedirect	10.5 and later	true \| false	Whether or not to send a browser redirect from the review processing page. If this is set to false, a byte stream is returned directly from the review processing page.	List
SAPFieldLookupRecordsLimit	10.5 and later	integer	Maximum number of records to be retrieved from SAP. The default returns are 500 records, but this is user configurable. Search is case sensitive. Search is always performed on field text\description. Search will always filter result on contain/like condition. No other filter condition is supported. If search value is blank then it will return all records, limit to max value given in API. It works for SAP releases later than 4.7 Search is performed on data ‘Description’ field Pattern search works with Contains operator only Descriptions not available for all search results In search result; values in Description column prefix with field value(i.e Value + Description). Specifies the maximum number of records for the WSO.Webservice Lookup control. This key is bound to the SAPFieldLookup control and the WSO.Webservice Lookup control.	Global
SecurityAuthenticatedUsers	10.5 and later	string	Override the internal name for the Authenticated Users group (normally NT AUTHORITY\Authenticated Users). Note:This option is unavailable in Winshuttle Server versions 10.6.1 and later.	Global
ServerPort	10.5 and later	integer	The port for the ShareVis remote assistant.	Global
SharePointRoot	10.5 and later	string	This is set by the Installer.	Global
ShareVisConfigDirectory	10.5-10.7	string	This is set by the Installer.	Global
ShowFieldDescriptions	10.5 and later	true \| false	Whether or not to display available field descriptions in Sharevis forms.	List
SmtpAuthMethod	10.5 and later	string	The SMTP server authentication method. Normally, this should be left blank. Valid values are NONE, LOGIN, PLAIN, CRAM-MD5, or NTLM.	Global
SmtpHost	10.5 and later	string	The name of the SMTP server. This setting overrides the SharePoint setting for ShareVis-related emails.	Global
SmtpImplementation	10.5 and later	string	Which implementation to use when sending email. Valid values are dotnet or chilkat. The chilkat option must be used if you want to use SMTP authentication. The sharepoint option does not allow attachments.	Global
SmtpLoginDomain	10.5 and later	string	The Windows domain to use when logging in to the SMTP server.	Global
SmtpPassword	10.5 and later	string	The password to use when authenticating to the SMTP server.	Global
SmtpPort	10.5 and later	integer	The SMTP port to use. If this is not specified, the default port will be used.	Global
SmtpUsername	10.5 and later	string	The username to use when connecting to the SMTP server.	Global
SqlConnection	10.5 and later	string	Used to connect to the ShareVis database. This is set by the Installer.	Global
StartTLS	11.2.12 and later	True \| False	Whether or not to use TLS when the email approval mailbox is polled. Note: If StartTLS is set to True, then set EMailApprovalUseSSL to False.
SwimLanesInHistory	10.5 and later	true \| false	Whether or not to show swimlane information in the Process History Running view.	List
TaskListPropertiesEnabled	10.5 and later	true \| false	Whether to show the Properties menu item in the Task List.	Global
TeamAssignmentListBoxHeight	10.5 and later	integer	Height of the list box in a team assignment page.	Global
TempDirectory	10.5 and later	text	The path to a Web-accessible location that can be used as a temporary cache. Used only by FormEx.	Global
TempDirectoryServerRelativeUrl	10.5 and later	text	The URL to the TempDirectory. Used only by FormEx.	Global
TemplateDocumentColumns	10.5 and later	text	Comma-separated list used to specify the columns to display in the document template selection screen.	List
TemplateDocumentLibrary	10.5 and later	text	The name of the document library to use as the template library for a DocEx library.	List
TemplateDocumentNameTemplateColumn	10.5 and later	text	The name of the column in the template library that contains the name of name template to use for each document.	List
TemplateDocumentUrl	10.5 and later	text	The URL of the site from which the document templates should be retrieved. If this is not specified, the current site is used.	List
TemplateFieldInclusions	10.5 and later	comma-separated list of field names	Obsolete .	Global
Tfoot	10.5 and later	html or text	The footer to include on each printed page.	List
Thead	10.5 and later	html or text	The header to include on each printed page.	List
ThreadedRemoteInterfaceDisposal	10.5 and later	true \| false	Whether or not to use another thread to dispose of remote interfaces.	Global
UploadExcludeColumns	10.5 and later	comma-separated list of field names	This option specifies the user-created columns in the document library that should not be displayed when uploading a new document.	List
UploadTimeout	10.5 and later	integer	Specifies the number of milliseconds to wait before an upload timeout is reported.	Global
UseAssignmentView2	10.5 and later	boolean	If set to true, the webparts will use AssignmentView2 with the NOLOCK statement. The purpose of this option is to resolve database deadlocks. See also ForceUseAssignmentView2 (above).	Global
UseUrlGuidCache	10.5 and later	true \| false	Whether or not to use the internal URL to SharePoint GUID cache. This option can be turned off if a site GUID could be mapped to multiple URLs, such as when using distinct external and internal URLs.	Global
UsePermissionSetsAsGroups	10.5 and later	true \| false	Whether to use permission sets in SharePoint 2007 or SharePoint 2010 as groups or to use real SharePoint groups.	Site
UsePreferredHostnameForUrlComposition	10.5 and later	true \| false	Whether to use the PreferredHostname value when composing URLs for the Web Parts and Detail Views.	Global
UsePreviousAssignees	10.5 and later	true \| false	Indicates whether to automatically select the same assignees for the previously run process on the same item.	List
UseUserRegionalSettingsForDates	10.5 and later	true \| false	Indicates whether to use the current user’s SharePoint regional settings to convert dates.	Global
ValidateListItemOwner	10.5 and later	true \| false	Whether to validate that a user starting, saving, or deleting another already saved item is the creator of the item.	List
ValidateOnReject	10.5 and later	true \| false	Indicates whether to validate form controls when a form is rejected.	List
WebServicePageLookupRecordsLimit	10.6 and later	integer	Specifies the maximum number of records to be retrieved when using Page Lookup with WSO.Webservice Lookup control. Default value: 10	Global
WebPartItemLinkType	10.5 and later	string	Type of link to use in the Task List and Process List Web Parts. Valid values are “item” and “completion”.	Global
WebServiceProxyTimeout	10.6 and later	string	This key changes the timeout value of a web service. The default value is 500000 milliseconds Note: This key is added in 10.4 Hotfix 9, 10.5 Hotfix 6 and 10.6 onwards.	Global
WebServiceProgressiveResponse	10.6 and later	True \| False	This specifies whether or not the response of each Web service should be shown on the Workflow form. This can be useful for cases when running multiple Web services from Form on Field Change, Button Click or Form Load. Default value is False (beginning in Workflow 10.9. For previous versions the default value is True.)	list
WinshuttleUpdateLegacyOperation	11.2.12	True \| False	This key determines whether to use new or legacy priority ordering.	Global
WinshuttleWebServiceRunAsync	10.9 and later	True \| False	Enables multiple postings to SAP. Applicable to the Winshuttle Update Pluginonly for Transaction (TxR) Web services.	Global
WorkflowDatabaseLocale	10.6 and later	Text	The value of this key represents the locale of SQL Server, for example ‘fr-FR’ for French, ‘en-US’ for English or ‘de-DE’ for German etc. This key needs to be configured when the SQL Server and Winshuttle Workflow Server are in different locales.	Global
WorkflowProcessAutoCopyEnable	10.5 and later	True \| False	This key enables you to control whether or not to automatically copy the completed process data to a SharePoint List item that is associated with the process. The List item will contain the XML and a link to the .MHT file. Note: The default value for is FALSE for all processes and all sites. If the key is enabled, then only an .MHT file, a List Item, and XML are generated.	Global
WorkflowReplace	10.5 and later	string	Sequenced set of strings to replace when a search string is located. See WorkflowSearch.	List
WorkflowSearch	10.5 and later	string	Sequenced set of strings to search for when publishing a workflow. See WorkflowReplace.	List

Winshuttle Workflow Configuration Keys; options list with descriptions (A-Z)

Back to

Related Topics

Workflow Configuration Options