Configuration Options

This page lists all available Configuration Options for use with the Workflow. Click an option in the table (below) to view the following information for each option:

Type: The type of option--for example, string, true/false, list, etc.
Description: A brief description of what the option does and how it is used.
Scope: The particular Solution, App, or Global (All apps) to which the option applies.

These keys can be added, removed and updated from Administration site - on Workflow page present under Settings tab.

Workflow Configuration Options

Key Name	Type	Description	Scope	Default Value
AssignedMessage	Text	The email sent when a task is assigned.	Global	<p>$EmailTemplate.AssignmentMessage</p>
AssignmentCompletionButtons	Comma-separated list	Description of which buttons to show when completing an assignment.	Solution	all
AutoSaveInterval		The number of minutes to wait before automatically saving the contents of a form in the background.	Solution	Empty. Feature is off.
AttachmentControlValidationRegExp	standard \| custom	The regular expression to use with custom Attachment Control validation. Defaults to ^([a-zA-Z0-9_ ]+\\.?)+$ This key works in conjunction with the AttachmentControlValidationType key.	Solution	^([a-zA-Z0-9_ ]+\.?)+$
AttachmentControlValidationType		The way the form Attachment Control validation should behave. Standard behavior searches the file name for known characters which are not allowed, and then presents an error if a file name contains those characters. Custom behavior retrieves a regular expression from the AttachmentControlValidationRegExp key, and if that regular expression does not match the file name, presents an error to the end user. Note: The TYPE must be specified in lower case, i.e., “standard” or “custom”. This key works in conjunction with the AttachmentControlValidationRegExp key.	Solution	Standard
AutoDeleteBlankRepeatingFormAreas		Within forms, indicates whether or not to automatically delete blank rows in repeating tables and sections.	Solution	false
AutoRunRetries		If an error occurs during AutoRun, this key defines the number of retries which will be executed.	Global	3
AutoRunRetryMinutes		This key defines the number of minutes between retries.	Global	30
BusinessCalendar		If true, the system will consider holiday keys and weekends when calculating due dates. If false, the system will do a straight calendar-based calculation (without considering holiday keys and weekends).	Global	true
ButtonLabelApprove		The label to use for the Approve button.	Solution	Empty
ButtonLabelCancel		The label to use for the Cancel button.	Solution	Empty
ButtonLabelContinue		The label to use for the Continue button.	Solution	Empty
ButtonLabelReject		The label to use for the Reject button.	Solution	Empty
ButtonLabelRoute		The label to use for the Save and Route button.	Solution	Empty
ButtonLabelSave		The label to use for the Save button.	Solution	Empty
CancelEnabled		Indicates whether or not the Cancel option is available for originators who are not admins.	Solution	true
CancelMessage		The email message sent when a process is cancelled either by an administrator or by the process originator.	Solution	Your submission was cancelled. [$Process.Comment] Process Name: [$ Process.Name ] Item Title: [Title]
Cc		A list of email addresses to copy anytime emails are sent.	Solution	Empty
ColorWarningThreshold		This number tells the system when the color should be set to the warning color in the Task List. It works with the ColorWarningThresholdUnits key.	Global	30
ColorWarningThresholdUnits		The units used by the ColorWarningThreshold key. It has 3 values: days, hours and percentage. Percentage means that when a specified percentage of time remains in the assignment, the assignment is considered close to being due.	Global	Percentage
DelimitedCommentFilterRegex		This key is used to remove HTML content that is displayed in the Show Form (Process History) after using EMailApprovalType as delimited eg. DelimitedCommentFilterRegex- <.*?> This is applicable to email approval cases.	Global	Empty
EMailApprovalApproveSubject		The template for the email subject in approval messages with the approved disposition.	Solution	Approved: [$ ProcessDefinition.Name ] - [$ Activity.Name ]
EMailApprovalBody		The body to use when composing an email to send back for approval during email approvals.	Global	%0AEnter your comment between the quotes:
EMailApprovalBoundaryRegExp		A regular expression to use in searching for the boundary in an email approval reply-type email. Everything following this expression should be ignored in the comment placed into the workflow. This works with the XML escape character sequence.	Global	[-]+original message[-]+
EMailApprovalCompleteSubject		The template for the email subject in an approval message with a completed disposition. Works in conjunction with EMailApprovalReceipt=True.	Solution	Completed: [$ ProcessDefinition.Name ] - [$ Activity.Name ]
EmailApprovalIgnoreIncludeItem		Specifies whether the “ Include Item” designation is ignored when sending email with an attachment or not.	Solution	true
EMailApprovalReceipt		Indicates whether or not to send a receipt email after an email approval submission.	Global	false
EMailApprovalRegExp		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	Enter your comment between the quotes: (.*)
EMailApprovalRegExpGroups		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. Used with EMailApprovalRegExp.	Global	1
EMailApprovalRejectSubject		The template for the email subject in an approval message with a rejected disposition.	Solution	Rejected: [$ ProcessDefinition.Name ] - [$ Activity.Name ]
EMailApprovalSubjectRegExp		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	Empty
EMailApprovalSubjectRegExpGroups		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. Used with EMailApprovalSubjectRegExp	Global	1
EMailApprovalType		The type of message sent back to the handler. Can be plaintext, delimited, or regexp. Used with DelimitedCommentFilterRegex	Global	plaintext
EMailAssignmentSubject		The template for the email subject in an assignment message.	Solution	Assignment: [$ ProcessDefinition.Name ] - [$ Process.Name ] : [$ Activity.Name ]
EmailCancellationSubject		This option defines the subject of the email notification that is sent when a process is canceled.	Global	Assignment Cancelled: [$ ProcessDefinition.Name ] - [$ Process.Name ] : [$ Activity.Name ]
EMailDispositionDescription		The description to use in the email disposition section of an assignment email - where a participant receives the assignment task. Used with EMailDispositionTitle	Global	Empty
EMailDispositionTitle		Used with email approval, this is the title to use in the email disposition section of a notification email. Used with EMailDispositionDescription	Global	Empty
EMailExceptionSubject		The template for the email subject in an exception message. This subject is used in email when a process is blocked.	Solution	Process Exception: [$ ProcessDefinition.Name ] - [$ Activity.Name ] Process Name: [$ Process.Name ]
EMailNotificationStyles		Styles to embed in the notification emails. These styles can be referred to in the body of the email.	Solution	Empty
EMailNotificationSubject		The template for the email subject in a notification message.	Solution	Assignment: [$ ProcessDefinition.Name ] - [$ Process.Name ] : [$ Activity.Name ]
EMailPastDueSubject		The template for the email subject in a past due message.	Solution	Assignment Past Due: [$ ProcessDefinition.Name ] - [$ Activity.Name ]
EMailReminderSubject		The template for the email subject in a reminder message. Used with ReminderMessage	Solution	Assignment Reminder: [$ ProcessDefinition.Name ] - [$ Activity.Name ]
EnableBlackbirdLogs		Indicates whether to generate a form debug logs (run-time). Enabled by default. To view the form log, press keys Ctrl + F12.	Global	True
FileLibraryBlockedFileTypes		Comma-separated values (extensions) not allowed for upload in a file library.	Global	exe, dll, js, svc, soap, asmx, ashx
FiscalYearStart		The month in which the fiscal year begins (a number between 1 and 12). This is used by the Quarter component of the Name Template Generator. By default it assigns a value starting at 01.	App	01
ForcedApprovalMessage		The email message sent when an item is force approved by an administrator.	Global	<p>$EmailTemplate.ForceApprove</p>
ForceRejectionMessage		The email message that is sent when an item is force rejected by an administrator.	Global	<p>$EmailTemplate.ForceReject</p>
FormCopyEnabled		Indicates whether or not to allow a user to copy a form.	Solution	true
FormDefaultButtons		Whether or not to display the default buttons at the bottom of a form. If a list of views is displayed, only those views will contain the buttons in a form. Notes: When using Solution Designer, the predefined views have different internal names. In this key, you need to use the internal name (see below). For user-defined views, use the name as-is. Solution Designer Name: Internal Name Originator View: ShareVisPreProcessView ReSubmit View: ShareVisResubmitView Process Status View: ShareVisProcessStatusView Process Completed View: ShareVisPostProcessView	Solution	true
FormReturnPage		The URL of the page to return to after submitting or canceling a form.	Solution	Empty
FormReplace		The sequenced set of strings to replace when a search string is located. See FormSearch.	Solution	Empty
FormSearch		The sequenced set of strings to search for when expanding a form definition. See FormReplace.	Solution	Empty
Holiday		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. 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.) in order for all 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 is used by the Evolve server.	Global	Empty
IncludeImplicitlyCompletedHistoryItems		Indicates whether or not to include assignments that are implicitly approved by either default approval periods or because of team assignment settings.	Solution	true
IncludeNotificationHistory		Indicates whether or not notifications are displayed in the workflow history.	Solution	false
IncludePluginHistory		Indicates whether or not information about the plug-ins is included in the workflow history. The history of the plug-ins below will always be displayed in the process history, irrespective of the setting of this key. Wait Wait for Child Process Form Process Launch Winshuttle Update Winshuttle Autorun	Solution	false
JavascriptInclude		The paths of Javascript files to include in forms. The value of this key is represented by a comma-separated list of Javascript paths.	Solution	Empty
OutOfOfficeDelegationDuration		Specifies the maximum duration (in calendar days) for an Out of Office Delegation. The default value is -1, which indicates there is no limit on the maximum duration. Note that this key is respected while setting up an 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	-1
PrinterFriendlyMenuEnabled		Indicates whether or not to show the printer menu options.	Solution	true
ProcessOwner		The person designated as the process owner for a given list. This should be in the form DOMAIN\USERNAME.	Solution	Empty
PromptOnReject		Indicates whether or not to prompt the user when the Reject button is clicked. This key is applicable only for forms.	Solution	false
ReminderMessage		The message sent when an assignment has reached its due date.	Global	<p>$EmailTemplate.AssignmentReminder</p>
SAPFieldLookupRecordsLimit		The maximum number of records to be retrieved from SAP. The default returns are 500 records, but the user can configure the number. This key is bound to the SAPFieldLookup control. Works with WebServicePageLookupRecordsLimit	Solution	500
TeamAssignmentListBoxHeight		The height of the list box in a team assignment page.	Global	5
ValidateListItemOwner		Indicates whether to validate that a user starting, saving, or deleting a saved item is the creator/originator of that item.	Solution	false
ValidateOnReject		Indicates whether to validate form controls when a form is rejected.	Solution	true
WebServiceProxyTimeout		This key changes the timeout value of a web service. The default value is 500,000 milliseconds. Note: This key is added in the following versions of Foundation: 10.4 Hotfix 9, 10.5 Hotfix 6 and 10.6 onward.	Global	500000
WorkflowReplace		The sequenced set of strings to replace when a search string is located. See WorkflowSearch. Indexed type key.	Solution	Empty
WorkflowSearch		The sequenced set of strings to search for when publishing a workflow. See WorkflowReplace. Indexed type key.	Solution	Empty
EnableExtensionsAPI		This key is not visible on the UI by default. If the value is set to True, the process extensions feature is enabled.	Global	False
EnableDataCorrectionLoopBackSingle		Enables the creation of a Data Correction task for data files with a single script.	Global	true
EnableDataCorrectionLoopBackLinked		Enables the creation of a Data Correction task for data files with a linked script.	Global	true
StandardWorkflowProcessDueDays		The default due date of a Standard Workflow process in the following format: timespan D.hh:mm:ss i.e. 30.00:00:00	Global	30.00:00:00
StandardWorkflowTaskDueDays		The default due date for all tasks of a Standard Workflow in the following format: timespan D.hh:mm:ss i.e. 30.00:00:00	Global	30.00:00:00
CancellationMessage		The email message that is sent to task's assignee when a process is canceled/force approved/force rejected by an administrator or the originator.	Global	<p>$EmailTemplate.AssignmentCancel</p>
SortProcessHistoryByCompletionDate		If set to true, the history of various activities of a process will be shown, sorted on the basis of the activities' completion dates. In addition, if multiple processes are found in the history, they will be sorted in the same manner.	Solution	false
TaskLock		If the swimlane property "LockType" is empty, the value in this key will be respected. Off : Assignment locking is not enabled. Manual : Assignment locking is enabled. After users open the form, they have the option of locking the task. The task remains locked until the user unlocks it. Automatic : Assignment locking is enabled. As users open forms, tasks are automatically locked. TaskUnit and TaskDuration keys allow users to set an amount of time during which the task will remain locked. Unless the original user completes the task, the task will be unlocked after the designated time period has elapsed. At that time, the task will become available to others who have been assigned the same task.	Global	Off
TaskUnit		The unit of time used for TaskDuration. The value can be “Minute” or “Hour.”	Global	Empty
TaskDuration		The time duration for which the task will remain locked for the user who locked the task.	Global	Empty

Configuration Options

Related Topics

Workflow Configuration Options