Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
- System configuration parameters
- Service Manager Server and Web Tier configuration files
- System parameters
- Web tier parameters
- Enter a parameter in the web client URL
- Enter a parameter in the sm.ini file
- Enter a parameter in the web.xml file
- Enter a parameter in the webtier.properties files
- Enter a parameter in sm.cfg or the server’s OS command prompt
- View parameters by function
- Alert parameters
- Application development parameters
- Background and scheduled process parameters
- Client parameters for Web clients
- Web parameter: acceptBrowserLang
- Web parameter: allowed
- Web parameter: antiCSRFEnabled
- Web parameter: applicationIcon
- Web parameter: autoCloseMaskDelay
- Web parameter: autoCompleteDelayTime
- Web parameter: autoCompleteListSize
- Web parameter: autoCompleteMinChars
- Web parameter: autoCompleteSkipCachingChar
- Web parameter: autoSubmit
- Web parameter: cacerts
- Web parameter: comfillAutoComplete
- Web parameter: compactLayout
- Web parameter: compress_soap
- Web parameter: customize-folder
- Web parameter: disableJumpAddress
- Web parameter: disableKeyHelp
- Web parameter: disableLoginAutoComplete
- Web parameter: enableExitConfirmMessage
- Web parameter: enableGetOriginalUrl
- Web parameter: enableLegacyTelephony
- Web parameter: enableListFrameStateRetain
- Web parameter: enableMoreContextMenu
- Web parameter: enableRecordlistOddEvenRowStyle
- Web parameter: enableSidebarMenu
- Web parameter: enableTableEllipsis
- Web parameter: enableTableMagnify
- Web parameter: helpServerContext
- Web parameter: helpServerHost
- Web parameter: helpServerPort
- Web parameter: honorUrlHost
- Web parameter: honorUrlPort
- Web parameter: isCustomAuthenticationUsed
- Web parameter: JCEProviderClassName
- Web parameter: JCEProviderName
- Web parameter: jsDebug
- Web parameter: labelbgunderline
- Web parameter: lockWaitTimeout
- Web parameter: log.properties
- Web parameter: maskMessageDelay
- Web parameter: maxGroupCacheSize
- Web parameter: maxattachuploadsize
- Web parameter: maxtotalattachuploadsize
- Web parameter: maxMessageNumber
- Web parameter: maxRequestPerSecond
- Web parameter: message display properties
- Web parameter: openTabsSoftLimit
- Web parameter: preventDuplicatedAttachmentName
- Web parameter: querySecurity
- Web parameter: recordListArrayDisplayStyle
- Web parameter: recordListArrayMaxChars
- Web parameter: refreshMessages
- Web parameter: refreshMessagesInterval
- Web parameter: rememberLang
- Web parameter: secureLogin
- Web parameter: serverHost
- Web parameter: serverPort
- Web parameter: session-timeout
- Web parameter: showAddFavButton
- Web parameter: showFavMgrButton
- Web parameter: showHelp
- Web parameter: showNavIcon
- Web parameter: showReloadNavButton
- Web parameter: sideBarButtonNumberToCollapse
- Web parameter: socketReadTimeout
- Web parameter: sortNavItems
- Web parameter: ssl
- Web parameter: sslPort
- Web parameter: sso.failure.httpStatus
- Web parameter: startDayOfWeek
- Web parameter: tracesoap
- Web parameter: unmaskDeferMillis
- Web parameter: useJavaDynamicVersioning
- Web parameter: useServertabs
- Web parameter: viewactivenotes
- Web parameter: viewcontexthelp
- Web parameter: viewpromptforsave
- Web parameter: viewrecordlist
- Web parameter: xff.trusted.proxies
- Client parameters for Windows clients
- Connection parameters
- Database parameters
- Debugging parameters
- Help parameters
- Information retrieval (IR) expert parameters
- LDAP parameters
- Localization parameters
- Regional settings parameters
- Security parameters
- Servlet parameters
- SSL parameters
- System information parameters
- System performance parameters
Client parameters for web clients
These parameters override web client preferences. Any client parameter that you set on the server overrides the local client preference and prevents users from changing it. You can set some of these parameters from the web client login URL, some from the web tier configuration file (web.xml), and some from the webtier.properties file. In the following table, a check mark (√) indicates that you can set the parameter from the URL or web.xml file, and an em dash (–) indicates the opposite.
Web parameter | URL | web.xml | web.properties | Description |
---|---|---|---|---|
Web parameter: acceptBrowserLang | – | √ | √ | Specifies if the browser’s language preference is used for trusted sign-on login when the lang parameter is not set in the web client login URL |
allowed | – | √ | √ | Specifies the allowed list of file extensions that may be attached to a Service Manager record, such as an Incident record. |
Web parameter: antiCSRFEnabled | – | √ | √ | Enables tokenization for the web client |
Web parameter: applicationIcon |
– |
√ | √ | Enables you to modify the Micro Focus logo to display a custom company icon in the URL address bar |
autoCloseMaskDelay | – | √ | √ | Defines the delay in seconds before the web tier mask is automatically closed |
Web parameter: autoCompleteDelayTime | – | √ | √ | Defines the delay time in milliseconds to trigger auto complete after the user stops typing characters |
Web parameter: autoCompleteListSize | – | √ | √ | Indicates the record number size fetched from the server side at the first time |
Web parameter: autoCompleteMinChars | – | √ | √ | Indicates the number of characters that are required to trigger the auto complete feature |
Web parameter: autoCompleteSkipCachingChar | – | √ | √ |
The previous response will not be cached if this character is included in the user input |
Web parameter: autoSubmit | √ | √ | √ | Enables users to submit forms when they press the Enter key |
Web parameter: cacerts | – | √ | √ | Defines the path to the cacerts file required for Web clients to make SSL connections to the Web tier |
Web parameter: CACLogin | – | √ | √ | Enabling this parameter causes all Web clients to present a Common Access Card (CAC) certificate as authentication information and use SSL connections to the Web tier. |
Web parameter: comfillAutoComplete | – | √ | √ | Enables the auto complete for the comfill widgets globally |
Web parameter: compactLayout | – | √ | √ | Enables the compact layout of the web client |
Web parameter: compress_soap | – | √ | √ | Requires the Web tier to compress SOAP messages to Web clients |
Web parameter: customize-folder | – | √ | √ | Defines the location to save the branding configurations |
Web parameter: disableJumpAddress | – | √ | √ | Enables use of the Quick Jump component on the toolbar |
– | √ | √ |
This parameter allows you to disable the contextual help. |
|
Web parameter: disableLoginAutoComplete | – | √ | √ | Controls password auto-complete for the web client login page. |
Web parameter: enableExitConfirmMessage | – | √ | √ | Displays a confirmation message when users click the Close (x) button of the SM web client page or manually refresh the entire web client page. |
Web parameter: enableGetOriginalUrl | – | √ | √ | Enables the webtier to obtain the original URL from the browser before a user logs in (in TSO or LWSSO mode). |
Web parameter: enableLegacyTelephony | – | – | √ | Enables or disables the legacy CTI method when set to true or false. |
Web parameter: enableListFrameStateRetain | – | √ | √ | Enables the list detail page to retain the expand-collapse state of the List Pane when the list detail page refreshes. |
Web parameter: enableMoreContextMenu | – | √ | √ | Enables a contextual "More" menu that is displayed when you right-click lists on the details pane of a record in the web client. |
Web parameter: enableRecordlistOddEvenRowStyle | – | √ | √ | This parameter determines if the odd rows and the even rows in the record list have the same background color or not. |
Web parameter: enableSidebarMenu | – | √ | √ |
This parameter specifies if the System Navigator of the web client can use the sidebar mode and icons. |
Web parameter: enableTableMagnify | – | √ | √ | Specifies whether the Magnify button appears for editable tables in the web client. |
Web parameter: enableTableEllipsis | – | √ | √ | For certain read-only controls in record details area, you can enable this parameter to display '...' at the end of the text fields when the input value is too long to be shown completely. |
Web parameter: helpServerContext | – | √ | √ | Defines the context path when deploying the Service Manager help on a web server (for example, Apache) |
Web parameter: helpServerHost | √ | √ | √ | Defines the name of the Help server host listening for client requests |
Web parameter: helpServerPort | √ | √ | √ | Defines the communications port number on which the Help server listens to client requests |
Web parameter: honorUrlHost | – | √ | √ | Determines whether Web client users can specify the name of the Service Manager server from the URL |
Web parameter: honorUrlPort | – | √ | √ | Determines whether Web client users can specify the communications port of the Service Manager server from the URL |
Web parameter: isCustomAuthenticationUsed | – | √ | √ | Determines how web client users are authenticated |
Web parameter: JCEProviderClassName | – | √ | √ |
The class name of a third-party JCE provider that you want to use when the web tier is running in non-FIPS mode. |
Web parameter: JCEProviderName | – | √ | √ |
The name of a third-party JCE provider that you want to use when the web tier is running in non-FIPS mode. |
Web parameter: jsDebug | – | √ | √ | Enables the web client to display to end users an error message that includes full stack trace. |
lockWaitTimeout | – | √ | √ | Specifies the time after which a Web tier application server thread will cease trying to acquire a lock |
Web parameter: log.properties | – | √ | √ | Defines the path to the Web tier's logging properties file |
Web parameter: labelbgunderline | – | √ | √ | Defines the form-level label background display if a color other than white was selected but the Background Style property was left blank |
maskMessageDelay | – | √ | √ | Specifies the number of seconds before the Web tier mask message is displayed after the mask is shown. |
Web parameter: maxattachuploadsize | – | √ | √ |
Specifies the maximum size limit for individual attachments in a record. |
Web parameter: maxtotalattachuploadsize | – | √ | √ | Specifies the maximum total size of all the attachments in a record. |
Web parameter: maxGroupCacheSize | – | √ | √ | Defines the maximum number of records that can be cached in the user's web browser when the user navigates through the groups in a record list |
Web parameter: maxMessageNumber | – | – | √ | Defines the maximum number of messages displayed in Messages And Alerts. |
Web parameter: message display properties | – | √ | √ | Indicate how different types of messages are displayed |
Web parameter: openTabsSoftLimit | – | √ | √ | Defines the maximum number of tabs a user can open in a browser before a warning message displays to advise them to close some tabs. |
preventDuplicatedAttachmentName | – | √ | √ | This parameter controls whether to prevent an attachment that has the same file name with existing ones from being uploaded to Service Manager. |
Web parameter: querySecurity | – | √ | √ | Embeds a security key in all queries generated by the Web client |
Web parameter: recordListArrayDisplayStyle | – | √ | √ | Defines how array column values are displayed in record lists |
Web parameter: recordListArrayMaxChars | – | √ | √ | Defines the maximum allowed field length of any array fields that appear in record lists |
Web parameter: refreshMessages | √ | √ | √ | Enables the Web client to query the Service Manager server for messages at a regular interval |
Web parameter: refreshMessagesInterval | √ | √ | √ | Defines the interval the Web client waits before checking for messages on the Service Manager server |
– | – | √ | Enables the Web client to remember the browser’s language preference | |
Web parameter: secureLogin | – | √ | √ | Controls the encryption of network communication between the Web application server and the Web browser |
Web parameter: serverHost | √ | √ | √ | Defines the name of the Service Manager host listening for client requests |
Web parameter: serverPort | √ | √ | √ | Defines the communications port number on which the Service Manager server listens to client requests |
Web parameter: session-timeout | – | √ | √ | Defines the number of minutes that the server waits for a client heartbeat signal before the server assumes that the client session has timed out and closes the connection |
showAddFavButton | – | √ | √ | Enables use of the Add Favorite button to add favorites in Favorites and Dashboards |
showFavMgrButton | – | √ | √ | Enables use of the Favorite Manager button to manage favorites in Favorites and Dashboards |
Web parameter: showHelp | – | √ | √ | Displays the Online Help option when you click the Help button, which allows you to access the help server |
showReloadNavButton | – | √ | √ | Enables use of the Reload button on the navigator toolbar. The Reload button refreshes the list of favorites in Favorites and Dashboards |
sideBarButtonNumberToCollapse | – | √ | √ | Defines the number of side bar buttons to be collapsed. |
socketReadTimeout | – | √ | √ | Specifies the time that a thread on the Web tier application server will wait for a socket IO operation. |
Web parameter: sortNavItems | – | √ | √ | Defines the sort order of the System Navigator menu items |
Web parameter: ssl | – | √ | √ | Requires all Web clients to use SSL connections to the Web tier |
Web parameter: sslPort | – | √ | √ | Defines the SSL port of the Web application server; required only when secureLogin is set to true |
sso.failure.httpStatus | – | √ | Specifies the HTTP status code to be returned when TSO, LW-SSO, IdM or CAC fails. | |
Web parameter: startDayOfWeek | – | √ | √ | Defines the first day of the week in the date picker. |
Web parameter: tracesoap | √ | √ | √ | Logs SOAP messages in the Web server's sm.log file (<Web server home directory>/sm.log ) |
– | √ | √ | Defers the unmasking of a browser window after an unmask request is issued | |
Web parameter: useJavaDynamicVersioning | – | √ | √ | Enables use of the system registry to locate the latest version of Java installed on a user's system |
Web parameter: useservertabs | √ | √ | √ | Displays tabs in the order the server has them saved on the form |
Web parameter: viewactivenotes | √ | √ | √ | Displays messages in a message box as well as in the status bar |
Web parameter: viewcontexthelp | √ | √ | √ | Display the same context-sensitive help debug information (field) in field help as the Windows client does. |
Web parameter: viewpromptforsave | √ | √ | √ | Displays a warning message when users cancel records with unsaved changes |
Web parameter: viewrecordlist | √ | √ | √ | Displays the record list/detail view for search results |
Related topics
System parameters
Web tier parameters
Related topics
Enter a parameter in the web client URL
Enter a parameter in the web.xml file