Server Configuration > Server Properties for Workflow > Configuration Properties for Workflows and Documents > Workflow and Document Configuration Properties in the Database
  
Workflow and Document Configuration Properties in the Database
Property
Description
mksis.im.additionalTokenCharacters
Specifies additional characters that are considered part of a search token when breaking up a text search string. This property applies only for Windchill RV&S servers that are running on an Oracle database.
If you specify additional characters here, they must be supported by the database lexer (or word breaker) of the underlying Oracle database.
The following characters are ignored if specified in this policy:
*| " + - ~
The default value of this policy is:
_.
mksis.im.adminObjectConfigurationLocales
This localization property allows the administrator to set the locale code for which translations are required. The locale code value is a semicolon (;) separated list of supported locales. When the property is set for a locale, it indicates that administrative operations such as create, edit, and view can be performed in that locale for the display name and description attributes of the administrative objects for Fields, Test Result Fields, Types, and States. When the default value for a locale is blank, it means that the administrator does not require translations to be used, and can use any of the PTC supported locales to manage the administrative operations.
mksis.im.allowAdminDeletionWithAdminMigration
Permits you to delete admin objects on a staging server, even if that object has been migrated to the production server. By default, you may only delete admin objects if they have not been migrated to the production server.
Default is false.
mksis.im.allowPrincipalCreationOnLockedServer
Permits you to create and import users and groups on a locked server.
Default is false.
mksis.im.allowProjectModificationOnLockedServer
Permits you to create or modify projects on a locked server.
Default is false.
mksis.im.allowDynamicGroupModificationOnLockedServer
Permits you to create and modify dynamic groups on a locked server.
Default is false.
mksis.im.allowOverrideSuppression
This policy is only used if a server is configured to be a staging server. If set to true, when you launch the migration wizard, it searches for Type objects in your workflow that have been created but not yet migrated. You can then choose to not migrate State and Field overrides that refer to one or more of the Types that you select. This allows you to not be forced to migrate newly created Type objects if you want to migrate only States or Fields that reference those Type objects but not those objects themselves. After the migration, the Fields and States that had their overrides suppressed will still contain the original overrides for later migration.
mksis.im.allowPartialAdminMigration
Permits administrators to select specific changes to migrate using Admin Migration Wizard.
mksis.im.cacheNotificationPoolSize
Controls the maximum number of threads available to the Windchill RV&S server for notifying Windchill RV&S clients about cache updates. Cache update notifications ensure that clients update their caches to reflect current data on the Windchill RV&S server. If users report that they are not seeing current data on the Windchill RV&S server, their clients may not have received cache update notifications yet. You may consider increasing the number of threads to improve the server's ability to handle the rate at which cache notifications are generated and sent to connected clients. Before you increase the number of threads, PTC recommends that you analyze the server statistics for the thread pool to determine if the value needs to be increased.
Default is 50.
mksis.im.connectionLimit
Limit number of client connections for Windchill RV&S to fixed limit. Setting to 0 means no restriction set.
Default is 0.
mksis.im.contextSearchOn
Context search indexes. Context search indexes are automatically built for text searches if underlying database supports it; however, text search queries perform differently using context search.
Default is true.
* 
If you have queries from previous release that rely on old text searching behavior, you may want to temporarily disable use of context search indexes. Otherwise, you can leave context searching enabled if underlying database supports it.
mksis.im.contextSearchSync
Setting any value for this property will have no impact on the Windchill RV&S server.
mksis.im.defaultSourceServer
The hostname and port for the default configuration management server. If this property is set, users are not prompted to specify a configuration management server. If this property is not set, the mksis.im.promptSourceServer property must be set to true.
mksis.im.distributionChartGroupingMax
Maximum number of values permitted in a field used by a grouping in a distribution chart. A larger number requires more server heap memory.
mksis.im.documentMemoryGovernor
To improve the performance, a limit can be set, in bytes, for the amount of data that is returned for a document. By default, there is no limit. To set a maximum limit for a document that can be returned by a server, set this property to a specific value (for example, 10000000 for 10 MB). If this limit is exceeded, the user receives an error.
mksis.im.httpSessionHeartbeat
If set to true, the Web interface issues a “heartbeat” to artificially keep the HTTP session active while the browser window is open. If set to false, the HTTP session expires after the time specified in the mksis.im.httpSessionTimeout property.
PTC recommends that you retain the value as true for best user experience with DocStudio
mksis.im.httpSessionTimeout
Sets the timeout for the server’s global HTTP sessions. If an HTTP session remains inactive for longer than the timeout period, the session expires. Sessions associated with the Web interface can avoid this timeout if they are artificially kept active with the mksis.im.httpSessionHeartbeat property. A value of 0 effectively ignores this property and the session timeout for the Web interface becomes the server's configured value. The value is stored as seconds.
mksis.im.ignoreNotificationSecurityRules
Ignores visibility rules in e-mail notifications, allowing anyone receiving e-mail notifications to see all available fields. While this option may improve server performance, it reduces security in e-mail notifications.
mksis.im.initialRevisionMajor
Sets the starting value for the first part of the revision number, known as the major revision (the number to the left of the decimal point) for item types that have been enabled for revisioning.
Valid values are 1 and 0. Default is 0.
Set this property in combination with the mksis.im.initialRevisionMinor property to form a revision number schema. Windchill RV&S supports four revision number schemas: 0.0, 0.1, 1.0, and 1.1. The default schema is 0.1.
Each revision schema produces a unique revision pattern, as follows:
If schema is 0.0, then pattern is: 0.0, 0.1, 0.2, ... 1.0, 1.1, 1.2, ... 2.0, 2.1, ...
If schema is 0.1, then pattern is: 0.1, 0.2, ... 1.0, 1.1, 1.2, ... 2.0, 2.1, ...
If schema is 1.0, then pattern is: 1.0, 1.1, 1.2, ... 2.0, 2.1, ...
If schema is 1.1, then pattern is: 1.1, 1.2, ... 2.1, 2.2, ...
A major increment sets the first or next major revision as indicated in bold. A minor increment sets the first or next minor revision in the sequence.
* 
Changes to this property take effect immediately and do not affect existing revisions.
mksis.im.initialRevisionMinor
Sets the starting value for the second part of the revision number, known as the minor revision (the number to the right of the decimal point) for item types that have been enabled for revisioning.
Valid values are 1 and 0. Default is 1.
Set this property in combination with the mksis.im.initialRevisionMajor property to form a revision number schema. For information about the supported revision schemas and the resulting revision patterns they produce, see mksis.im.initialRevisionMajor.
* 
Changes to this property take effect immediately and do not affect existing revisions.
mksis.im.issueLockTimeout
The time in seconds that the Windchill RV&S server is to wait for the release of a database issue lock before timing out. This property applies only for servers that are running on an Oracle database.
The default value is 1, and the maximum value is 30. If an edit times out because of a database lock, an error message displays, indicating that the item is currently locked by another user and to try again later.
mksis.im.itemTextFilterThreshold
Maximum number of items that can be returned by a query in the Items view in order for the text filter to be enabled. If the number of items is greater than the threshold, the text filter is disabled.
Default is 1000.
mksis.im.maxAttachmentSize
Maximum file size (in megabytes) users can attach to item. Minimum limit for attachment size is 1 MB, while maximum limit is 250 MB.
Default is 4.
* 
For any changes to take affect, the Windchill RV&S client GUI must be restarted.
mksis.im.maxDashboardImageSize
Maximum size for dashboard image in kilobytes. Minimum value is 1 KB, and maximum value is unlimited.
Default is 100.
mksis.im.maxIBPLIssueCount
Prevents an item backed picklist field (IBPL) from being created if it contains more than the specified number of backing items at its creation or modification. Specifying this value prevents the accidental creation of an IBPL with large numbers of entries, which can cause the server and/or clients to run low on memory.
mksis.im.minimumIssueNumber
Item number for next item submitted to database. If items have already been submitted, this number must be greater than the next item number or it gets ignored.
Default is 0.
The maximum item number is 1073741824. Keep this in mind when setting this property.
mksis.im.notificationsOnAdminLockBreak
Comma-delimited list of e-mail addresses to be notified when a server lock is released.
mksis.im.notifierAddress
Identifier for server when sending out e-mail notifications (that is, e-mail address to use in “From” field). Must specify to enable e-mail notifications, for example: mksis.im.notifieraddress=account@smtp1.abc.com.
Default is "MKSIntegrity".
* 
The address may not contain spaces. For example, Windchill RV&S Server@ptc.com or Windchill RV&S Administrator is not acceptable.
mksis.im.perUserSessionLimit
Restricts the number of sessions a user can open at one time. This property is a global value that applies to all users and assists in managing resource allocation for the Windchill RV&S server. You can specify a maximum of 100 connections and the default is 25.
For example, if you allow users to open 25 sessions at a time, a user can begin a session in the Web interface, and open upto 25 tabs in a browser to run a chart in each tab.
Note the following:
Although this property is a global value, you can override the value at the group level in the Create Group and Edit Group dialog boxes. If no session limit value is specified at the group level, the global value is used.
If there are Web interface users with heartbeat and idle timeout, then an idle-timed-out user still continues to exist, and is not subject to this limit.
If a user belongs to multiple groups and the session limit value is specified in all or some of the groups, the session limit resolves to the highest value specified in the groups and global value. For example, if a user belongs to Group A (session limit = 4) and Group B (session limit = 7), and the global value is 3, the maximum allowed sessions is 7. If the global value is 9, then 9 is the maximum allowed sessions.
mksis.im.promptSourceServer
Prompts users to specify a configuration management server. If a default configuration management server is set, this property should be set to false. If a default configuration management server is not set, this property must be set to true. The default configuration management server is set in mksis.im.defaultSourceServer.
mksis.im.queryGovernor
Limit returned item count of query or report. Extremely large queries can demand significant memory resources from both server and client. Property governs computation and return of query, and displays a warning message along with the partial set of results if the number of items returned exceeds the specified limit. This behavior does not apply to queries that are not directly run by a run (for example, a query behind a report). In such cases, Windchill RV&S displays an error message.
Minimum value is 100, and maximum value is unlimited.
Default is 10000.
* 
Property governs total of all pages and is independent of client’s page size.
mksis.im.queryMemoryGovernor
Extremely large queries, or items with large amounts of history, or large text fields can take a lot of memory in both server and client. The full list of all items with their requested information must be constructed in memory on the server before being sent back to the client. This limits the maximum memory, in bytes, that the server can use for a given request. The actual memory usage is estimated for performance purposes. If the limit is exceeded, the user will receive an error. This applies to all requests for item information, whether viewing an individual issue, running a query, a query behind a report, or other methods.
mksis.im.QueryTimeOut
A limit on the execution time in seconds for the running of a database query. The value 0 indicates no timeout.
mksis.im.QueryTimeOut.Default
The default limit on the execution time in seconds for the running of a database query. The value 0 indicates there is no default and the mksis.im.QueryTimeOut will be used.
mksis.im.reportCreationLanguageList
Used to externalize and localize static reports, and specifies the languages that the report recipe will be saved as (in the database).
The property value is a semi-colon (;) separated list of languages. For example, en;de;ja;zh_CN;ko,fr. The list must only contain languages supported by Windchill RV&S.
Setting languages makes the static report generate in those languages for your users, based on the locale. For example, If English and German are specified, then both English and German locale users will run the report in their locale language.
Setting this property to a blank value has the following impact:
Created reports are saved in the client language, so they can be run at a later time in that language. For example, if the client language is German (de) then the static report is created only in the German language.
Users with a client locale that is not specified in this property will see a report with tokens as the resource. For more information on tokens used in reports, see the documentation for localizing report recipes.
mksis.im.reportMemoryGovernor
Specifies the maximum amount of memory, in bytes, that the server can use to run a report. Extremely large reports containing a lot of items in the top-level query or large text fields can consume large quantities of memory on the client and server. If the memory limit is exceeded, the user receives an error message.
Default is 10000000 bytes.
mksis.im.spellingDictionary=
External dictionary to use for spell checking in rich content fields. Must be a valid and accessible URL (an http:// URL for a Web service, or a file:// to a UNC path of a known public share). If unspecified, the internal English spelling dictionary is used.
This property value can only be changed for the external spelling dictionary, it cannot be changed for the internal user dictionary.
* 
This property must conform to the format of either one word per line and sorted, or one letter per line with words after the “=” and separated by “;”.
mksis.im.sqlGenerationHints
Workflow SQL generation hints. The general format is a semi-colon delimited list of key=value Valid values are 1 and 0. Default is 1.
All hints are undocumented and should only be used on when recommended by Windchill RV&S Technical Support.
mksis.im.useBcc
If true, causes server to send e-mail notifications as blind carbon copies preventing recipients from viewing e-mail addresses not their own. If false, other recipients e-mail addresses appear in To field of e-mail header.
Default is false.
mksis.im.validURLPrefixes
Specifies valid URL prefixes for hyperlinks in rich content fields. You can add URL prefixes, permitting users to include external hyperlinks to third party applications, for example, adding doors:// to allow external hyperlinks to requirements in DOORS. Similarly, you can remove URL prefixes, preventing users from clicking certain types of external hyperlinks.
Default values are http, https, mailto, file, \\, and integrity. Each value is separated by “;”.
Note the following:
For changes to this property to take effect, the Windchill RV&S server. and client must be restarted.
For some URL prefixes, such as https, Windchill RV&S does not automatically create a hyperlink. Users may need to select the URL in the rich content field and insert the hyperlink manually.
mksis.im.privateUserPrefs
This property defines the private user preferences. This is a system-generated property. User must not edit this property.
mksis.im.publicUserPrefs
This property defines the public user preferences. This is a system-generated property. User must not edit this property.
mksis.im.preValidateConstrainedPickFieldValuesInBatchEdit
This property determines if pre-validation of the constrained pick field values is required before submission of such edited fields during item batch edit operations.
The default value is false.
* 
This property applies to the client GUI only.
For more information, see Batch Editing Items.
mksis.im.documentViewLinksInLargeContent
This property ensures that the hyperlinks and cross-reference links work as expected while working with nodes having large content (> 8000 characters) in the Document View.
The default value is false.
* 
For changes to this property to take effect, the Windchill RV&S client must be restarted.
Post restart, user might experience a lag, when using a mouse wheel to scroll through a document with many large content nodes.
How to count the number of characters?
1. Execute the command im viewissue –showRichContent {item id} and copy the rich text field content.
Alternatively, in Edit mode of the Swing client, view the source code of the rich text field and copy it.
2. Paste the content in a text editor like Notepad++ and count the characters.
mksis.im.allowCopyingNonEditableFieldValues
This property ensures that the copied content with non-editable fields is successfully saved in the document view, while editing multiple rows.
The default value is false.
* 
For changes to this property to take effect, the Windchill RV&S client must be restarted or reconnected to the server.
For documents which are already open in multiple-row editing mode, the relevance, editability, visibility, permissions, mandatory constraints and conflicts detection checks are performed after the user clicks Save.
The copied content must be committed before it is pasted in the document view.
mksis.im.usePreciseMatchingForBranchedDocumentsDifferencing
Setting the value of this property to true, ensures that the branched items are matched precisely without taking into consideration the generated item IDs, which may not be in sequence in some cases.
Using this property, you can overcome the limitations of the default algorithm used to calculate differences between branched documents, which gives incorrect results when the items IDs generated by the underlying database for branching operation are not in sequence. As a result, while viewing differences from the GUI, some of the contents may appear as moved without performing a Move operation.
* 
Do not use this property unless required as it will result in slow performance for document differencing operations.