| Document number | Revision |
|---|---|
| DOCU12422 | 14 |
Advanced built-in parameters not found in ts_parameter table
Advanced built-in parameters not found in ts_parameter tableBackgroundIntroductionOfficial supportParameters
Background
This article introduces you to the available parameters which can be set in the schema file or in the web.config file.
Introduction
Parameters defines Highstage behavior. Parameters may exist in ts_parameter sql table, in schema file and in web.config file.
If parameter has been defined more than one place, the priority is:
Web-config
Ts_parameters table
Schema file
Thus parameters defined in web.config overrules other definitions of the same parameter.
Parameters may be set in schema file at schema top-level using the following syntax:
<parameter name="ParameterName" value="ParameterValue" />
Parameters may be set in web.config in <appSettings>:
xxxxxxxxxx<add key="ParameterName" value="ParameterValue" />
If TS_webApp has been mounted more than once, then parameters in web.config may be set differently for different sub-applications by prefixing parameter name with sub-application name:
xxxxxxxxxx<add key="SubAppplication:ParameterName" value="ParameterValue" />
The following is a list of supported/built-in parameters not defined in ts_parameter table. They must be set in schema file or in web.config file.
Official support
Officially supported parameters (✔️) are parameters that are fully supported in Highstage. We provide support and continuous maintenance for the use of these parameters throughout Highstage.
Not officially supported parameters (❌) are parameters that are not formally supported by Highstage. These parameters are available for use at your own risk.
Parameters
| Name | Default value | Description | Officially supported | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
AllowMailToInitiator | 0 | Allows for mails to be sent to users who initiated the mail to be sent from Highstage. Disabled (Default): <parameter name="AllowMailToInitiator" value="0" />Enabled: <parameter name="AllowMailToInitiator" value="1" /> | ✔️ | ||||||||||||
AllowDevicePartReference | 0 | Allow creating references from Device to Part. Normally the MasterPart column at Device specifies is used to specify Device design. However, some organizations may require to be able to add more references from Device to Parts. To allow references from Device to Part add the following schema line.<parameter name="AllowDevicePartReference" value="1" /> | ✔️ | ||||||||||||
AllowSingleRevisionObsolete | 0 | Allows obsoleting a single revision of an item without obsoleting an entire item with all of it's revisions. Disable (default): <parameter name="AllowSingleRevisionObsolete" value="0">Enable: <parameter name="AllowSingleRevisionObsolete" value="1"> | ❌ | ||||||||||||
AllowSingleRevisionMoveWorkspace | 0 | Sample, allow moving single revision of item to another workspace:<parameter name="AllowSingleRevisionMoveWorkspace" value="1" /> | ❌ | ||||||||||||
AllowVirtualColumnsWithSqlSelectInMails | 0 | Allows for the utilization of virtual columns (must include an underlying <sqlselect> element within the virtual column definition) in email notification templates. | ✔️ | ||||||||||||
AsposeRefineSubtypes | - | Enable Aspose refine. Observe that to use this feature the properties.aspx has to be migrated. Sample exists in documentation/samples. To activate on specific subtypes set the parameter AsposeRefineSubtypes to a semicolon separated list of subtypes:<parameter name="AsposeRefineSubtypes" value="RS;TS;TR" />, or * for all subtypes. <parameter name="AsposeRefineSubtypes" value="*" /> | ✔️ | ||||||||||||
AsposeFontPath | - | Enables a different source for the fonts used by Aspose refine. It should be pointing to the local path of the folder.<parameter name="AsposeFontPath" value="e:\highstage\fonts\" /> | ✔️ | ||||||||||||
CrawlSearchType | - | Types to search by default. Both basetypes and subtypes can be used. Grid, filter and other options may be specified by adding search URL parameters. Sample searching doc default grid for latest approved documents, and including columns 'predecessor' and 'workspace.name' (comma is used as separator):doc&_filter=latestapproved&_columns=+predecessor,workspace.nameThe columns included can also be virtual. | ✔️ | ||||||||||||
ColumnDetailsMinimumUserLevel | AdminRead | users with a minimum set userlevel can click on column titles and access details around the column definition. Example: <parameter name="ColumnDetailsMinimumUserLevel" value="user" /> will make column details available to all users with a set minimum userlevel of user. Permitted values includes user, advanceduser, superuser, adminread, adminwrite. | ✔️ | ||||||||||||
ColumnValueTitleEdit | 0 | Sample, use title instead of value when editing columns with value/title definitions (ex. FolderType column).<parameter name="ColumnValueTitleEdit" value="1" /> | ✔️ | ||||||||||||
DefaultPath | - | Relative path to default web page. To remove the menu, use the following:<parameter name="DefaultPath" value="~/ts/main/main.aspx" /> | ✔️ | ||||||||||||
DisableActionClosedConstraint | 0 | Sample, allow closing parent action even if child actions are not closed.:<parameter name="DisableActionClosedConstraint" value="1" /> | ✔️ | ||||||||||||
DisableForeignReferencesSqlselectReplace | 0 | When using foreign-references over three levels (eg. workspace.manager.mail), the SQL-query will be generated with a [.] reference that cannot be resolved. Enabling this parameter prevents that. Sample for enabling parameter: <parameter name="DisableForeignReferencesSqlselectReplace" value="1" /> | |||||||||||||
DisableGridContentAutoHide | 0 | Enable to display Search, Scope, Grid and Filter capabilities for search pages displaying referenced items. parameter name="DisableGridContentAutoHide" value="1" /> | ✔️ | ||||||||||||
DisablePlusMinusOnColumnWrite | 0 | Disables the capability of being able to add / remove values from a column with lists by using +value / -value. parameter="DisalbePlusMinusOnColumnWrite" value="1" /> | ✔️ | ||||||||||||
DisableRefineBackupDeletion | 0 | Disables the automated deletion of backed-up files (Refined Word, Excel, Visio and Powerpoint documents) when Documents reaches the Approved status. Enabled: <parameter name="DisableRefineBackupDeletion" value="1" />Read more about automated backup of Office files here. | ✔️ | ||||||||||||
DisableColumnDataValidation | 1 | Disable server-side Data validation on fields:<parameter name="DisableColumnDataValidation" value="1" /> | ✔️ | ||||||||||||
DisableMailImportNotification | 0 | Disable automated email notifications to be sent to resources whenever a new email is automatically added to an existing item in Highstage. | ✔️ | ||||||||||||
DisableMsWebDavFix | 0 | Microsoft WebDAV implementation have had many problems, and have also changed behavior. MS WebDAV client requires access to all ancestor folders in order to be able to access leaf folder that the user has permission to. This has been solved by everyone having read attributes permissions on all folders. The following sample shoes how to disable this, but disabling will give problems for users using MS WebDAV client:<parameter name="DisableMsWebDavFix" value="1" /> | ✔️ | ||||||||||||
DisableRefSecurity | 0 | By default user will only see references that the users has access to, the reference search grid will include an indication if references exists that the user does not have access to. To enable the user to see all references set this parameter. The user will still not have access to files, and of cause the user will only to be able to see references is user has access to parent:<parameter name="DisableRefSecurity" value="1" /> | ✔️ | ||||||||||||
DisableUpdateSecurityCheck | 0 | When updating column values a security check is always done. To temporary disable this check, set the parameter:<parameter name="DisableUpdateSecurityCheck" value="1" /> | ✔️ | ||||||||||||
ExpandRefSubSections | 0 | Reference section on item web page will always be expanded if any references exists. This sample makes reference section expand always, even if no references:<parameter name="ExpandRefSubSections" value="1" /> | ✔️ | ||||||||||||
FieldEditSearchFocus | 0 | Sample, causing focus to be set to search instead of editing if edit popup contains searchable list:<parameter name="FieldEditSearchFocus" value="1" /> | ✔️ | ||||||||||||
FolderFileLinks | 1 | Sample, disabling links to file in folder file list, forcing user to open folder to be able to open file:<parameter name="FolderFileLinks" value="1" /> | ✔️ | ||||||||||||
FolderLock | 0 | Folder enables author to exclude other authors from writing in folder/files, so that author can perform a “transaction” that will not be corrupted by other authors writing during the transaction. Sample for enabling folder lock: <parameter name="FolderLock" value="1" /> | ✔️ | ||||||||||||
FolderSecurityCheckSet | 0 | In a few infrastructures NTFS permissions (ACL) have been lost or changed, seems like an infrastructure problem that has been fluctuating in a few (2) installations. The following sample enables thorough check/set of item folder and subfolders/files security, however with performance penalty: <parameter name="FolderSecurityCheckSet" value="1" /> | ✔️ | ||||||||||||
FolderSubfolderInfo | 0 | Sample, enabling display of subfolder size, at a significant performance penalty depending on number of subfolders/files:<parameter name="FolderSubfolderInfo" value="1" /> | ✔️ | ||||||||||||
ForeingTypesIncludedInMail | N/A | Include any number of foreign types to make associated columns available in email notification templates. Sample: Include workspace or subtype related columns in an associated email notification template: <parameter name="ForeignTypesIncludedInMail" value="workspace;subtype" />. | ✔️ | ||||||||||||
FormTitleVariant | 0 | Sample, use simple form titles:<parameter name="FormTitleVariant" value="1" /> | ✔️ | ||||||||||||
GridColumnFilterSelect | 1 | Enable button in grid header for selecting value:<parameter name="GridColumnFilterSelect" value="1" /> | ✔️ | ||||||||||||
GridRefExplorer | 1 | Disable references section on search grids<parameter name="GridRefExplorer" value="1" /> | ✔️ | ||||||||||||
HttpClientProtocol | tls12 | Enforces the version of the Secure Sockets Layer (SSL) or Transport Layer Security (TLS) protocol used when making Http requests. Available configurations (values separated by / are mutually valid and permitted) :<parameter name="HttpClientProtocol" value="tls12 / tls1.2" /><parameter name="HttpClientProtocol" value="tls11 / tls1.1" /><parameter name="HttpClientProtocol" value="ssl / ssl3" /><parameter name="HttpClientProtocol" value="tls / tls10 / tls1.0" /> | ✔️ | ||||||||||||
IeAutoFolderType | 0 | Default folder type in highstage is webdav. If users is using Internet Explorer as browser the default folder type may be set to MsNetworkFolder (SIFS protocol) by setting the following parameter value:<parameter name="IeAutoFolderType" value="5" /> | ✔️ | ||||||||||||
KeyColumnCharWhiteList | ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789 | KeyColumnCharWhiteList) controls which characters that are allowed for key columns. Some key columns must be consistent cross-systems, and common policies should be applied. Also some key columns are used in file system, invalid file system characters are not allowed as key column characters (’<’, ’>’, ’\’, ’/’ etc.), and also some words (LPT1, COM1 etc), these characters and words are not allowed for key columns: https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx Sample, allowing lower case characters and underscore character: <parameter name="KeyColumnCharWhiteList"value="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_" /> | ✔️ | ||||||||||||
LdapSecure | 0 | Enables the Ldap Secure protocol (LDAPS) for communication with LDAP server (AD). | ✔️ | ||||||||||||
LdapSecureAuthMode | 0 | LdapSecureAuthMode: Enable signing authentication when LdapSecure is enabled (Official reference documentation). | ✔️ | ||||||||||||
LogicalOperatorWords | 0 | Sample, enable depreciated Boolean operators in searches<parameter name="LogicalOperatorWords" value="1" /> | ✔️ | ||||||||||||
LogLdapReplicationOK | 0 | Sample, enable LdapReplicate ok status to be written to eventlog, with log size penalty:<parameter name="LogLdapReplicationOK" value="1" /> | ✔️ | ||||||||||||
MandatoryAcceptDefault | 0 | If enabled, default values on columns will be considered a valid value when used as a mandatory field. By default, MandatoryAcceptDefault is disabled, and thus, default values in columns will not be considered valid when used as a mandatory field.Sample for enabling parameter: <parameter name="MandatoryAcceptDefault" value="1" /> | ✔️ | ||||||||||||
MinorChangeTraceability | 0 | If enabled, making a minor change to an item will create a new separate revision of the associated item. Sample for enabling parameter: <parameter name="MinorChangeTraceability" value="1" />⚠️ Warning: Do not enable before all ongoing minor changes are fully resolved and approved. | ✔️ | ||||||||||||
NoAccessRedirect | - | If user does not have access to one or more references then a link is provided to user if this parameter has been set. The link destination page is a relative path, relative to web application root, to a custom page located in tweak folder. The custom page can give user support for getting access to the relevant information, for example by sending mail to relevant personal. Sample redirecting to tweak/NoAccessRedirect.aspx: <parameter name="NoAccessRedirect" value="tweak/NoAccessRedirect.aspx" /> | ✔️ | ||||||||||||
OpenCmdBehavior | - | Method for opening files with &open command. Sample, using ITHit for opening files: <parameter name="OpenCmdBehavior" value="ithit"/>Sample, using classic redirect which works best in IE. Other browsers will download file: <parameter name="OpenCmdBehavior" value="redirect"/>Sample, using preview for opening PDF files in a browser: <parameter name="OpenCmdBehavior" value="preview"/> | ✔️ | ||||||||||||
PreviewLinkTarget | _top | Sets/adds the specified target attribute on all <a> elements within the preview contents to specify where to open the link.
The target attribute specifies where to open the linked document. Read the official documentation about the target attribute here. | ✔️ | ||||||||||||
PreviewLinkTargetBase | _parent | Sets/adds the specified target attribute on the <head> element within the preview contents to specify a target attribute for all links.
The target attribute specifies where to open the linked document. Read the official documentation about the target attribute here. | ✔️ | ||||||||||||
ReadOnlyAlerts | 0 | Sample, enable warning to user if file link is read-only:<parameter name="ReadOnlyAlerts" value="1" /> | ✔️ | ||||||||||||
RefineOnCreate | 0 | Sample, enabling refine on item create:<parameter name="RefineOnCreate" value="1" /> | ✔️ | ||||||||||||
RefineryLoadVirtualColumns | 0 | Sets virtual columns so that they are also loaded (in addition to physical columns) in refinery. Risk is exceptions in virtual column sqlselect sub-queries Sample for enabling load of virtual columns on refine: <parameter name="RefineryLoadVirtualColumns" value="1" /> | ✔️ | ||||||||||||
ReplaceUrl | 1 | Sample, disable update of browser URL address:<parameter name="ReplaceUrl" value="0" /> | ✔️ | ||||||||||||
ReportFolderFeatureException | 0 | For reporting folder view exception for trouble shooting the parameter ReportFolderFeatureException can be set:<parameter name="ReportFolderFeatureException" value="1"/> | ✔️ | ||||||||||||
ServerEmailAddressEnforcement | 0 | Sample, enforcing that all emails with server email address as sender:<parameter name="ServerEmailAddressEnforcement" value="1" /> | ✔️ |
