Configuration Settings for a Siebel Application Interface Profile
The following table describes the settings that are requested in the Siebel Management Console for configuring a new Siebel Application Interface profile or modifying an existing Siebel Application Interface. This topic is part of Configuring the Siebel Application Interface.
Required fields display an asterisk (*) next to the field label. For most of the options, pointing to the option displays tooltip text that provides a brief description of the field. Clicking the large plus (+) icon next to some options adds a new instance of a configurable item, which is represented in the second column using italics.
Default values have changed for some of these settings in recent releases, as follows:
-
The default setting changed for HTTP 1.1-Compliant Firewall / Enable Web Compression to be enabled by default. You can optionally update any Siebel Application Interface profiles created before Siebel CRM 21.3 to enable this setting.
-
The default values changed for Method to Check Server Availability and Command to Check Server Availability to the values shown in this table. As a consequence, customers must update any Siebel Application Interface profiles created before Siebel CRM 20.2 to reflect the values shown in the table. Failing to do so could result in idle sessions not getting logged out in timely fashion.
| Setting in Siebel Management Console | Section (Under Create Profile) | Comment or Description |
|---|---|---|
|
HTTP 1.1-Compliant Firewall / Enable Web Compression |
Basic Information |
Specify that the Siebel Application Interface compresses HTTP traffic. Compressing HTTP traffic, where it is feasible to do so, substantially reduces bandwidth consumption. This feature is supported on HTTP 1.1 and is not supported on HTTP 1.0. Default value: enabled. Note: This feature compresses only dynamic HTML content that is served by the
application container. To compress static content like cascading style sheets (CSS
files) and Javascript (JS files), you must change the Tomcat connector configuration
in server.xml of the application container for Siebel Application Interface. For
details, see Compressing Static Content for Siebel Application Interface.
For more information about specifying compression, see Siebel Security Guide. |
|
Configure Fully Qualified Domain Name |
Basic Information |
Specify whether you are using a fully qualified domain name (FQDN) for your Siebel CRM deployment. It is strongly recommended to use the FQDN feature. For more information, see Configuring Siebel CRM for Pop-Up Blocker Compatibility. |
|
Fully Qualified Domain Name |
Basic Information This option appears if you selected Configure Fully Qualified Domain Name. |
Specify the fully qualified domain name (FQDN) for your Siebel CRM deployment, such as example.com. It is strongly recommended to use the FQDN feature. |
|
Active Session Timeout Value |
Authentication |
Specify the total number of seconds that a session can remain inactive before the user is logged out and the session is closed. Default value: 900 (in seconds) |
|
Login Session (guest session) Timeout Value |
Authentication |
Specify the timeout value for the login session. Default value: 300 (seconds) |
|
Method to Check Server Availability |
Authentication |
Specify the method to use for checking server availability. Default value: UpdatePrefMsg |
|
Command to Check Server Availability |
Authentication |
Specify the command to use for checking server availability. Default value: HeartBeat |
|
Session Token Usage Duration |
Authentication |
Specify the usage duration for the session token. Default value: 2880 (minutes) |
|
Session Token Timeout Value |
Authentication |
Specify the timeout value for the session token. Default value: 900 (seconds) |
|
Maximum Possible Tabbed Sessions |
Authentication |
Specify the maximum possible number of tabs for multiple tab browsing. Default value: 1 This setting is effective only when the EnableMultiTab server parameter is set to True for the specified Application Object Manager. For more information about configuring multiple tab browsing, see Configuring Siebel Open UI. |
|
Configure Web Single Sign-On (Web SSO) |
Authentication |
Specify whether to use Web single sign-on. |
|
Anonymous User Name |
Authentication |
Specify the Siebel user ID that starts the anonymous session from which an end user is shown the login page for an application. For example: GUESTCST Later in profile configuration, you can optionally configure a different anonymous user for individual applications, if you require settings different from the defaults. For example, you might use a different anonymous user for customer applications than for employee applications. For more information about anonymous users, see Requirements for Configuring Anonymous Users for the Siebel Application Interface. |
|
Anonymous User Password |
Authentication |
Specify the password for the anonymous user. |
|
Trust Token |
Authentication This option appears if you selected Configure Web Single Sign-On. |
Specify the trust token to use for Web SSO authentication. |
|
User Specification |
Authentication This option appears if you selected Configure Web Single Sign-On. |
Specify the user specification to use for Web SSO authentication. |
|
Anonymous User Name |
Authentication > REST Inbound Authentication |
Specify the anonymous user to use for REST inbound authentication. For more information about anonymous users, see Requirements for Configuring Anonymous Users for the Siebel Application Interface. See also Siebel REST API Guide. |
|
Anonymous User Password |
Authentication > REST Inbound Authentication |
Specify the password for the anonymous user for REST inbound authentication. |
|
Authentication Type |
Authentication > REST Inbound Authentication |
Specify the authentication type for REST inbound authentication. You can select one of the following options:
For more information, see Siebel REST API Guide. |
|
Introspection URL |
Authentication > REST Inbound Authentication This option appears if you selected OAuth. |
Specify the introspection URL for REST inbound authentication. For more information, see Siebel REST API Guide. |
|
Client Id |
Authentication > REST Inbound Authentication This option appears if you selected OAuth. |
Specify the client ID, which is created when Siebel CRM is registered as a confidential client in the OAuth server. For more information, see Siebel REST API Guide. |
|
Client Secret |
Authentication > REST Inbound Authentication This option appears if you selected OAuth. |
Specify the client secret, which is created when Siebel CRM is registered as a confidential client in the OAuth server. For more information, see Siebel REST API Guide. |
|
Trust Token |
Authentication > REST Inbound Authentication This option appears if you selected Single Sign-On or OAuth. |
Specify the trust token to use for REST inbound authentication. Use the same value specified for the security adapter. For more information, see Siebel REST API Guide. |
|
User Specification |
Authentication > REST Inbound Authentication This option appears if you selected Single Sign-On. |
Specify the user specification to use for REST inbound authentication. For more information, see Siebel REST API Guide. |
|
Session Timeout (seconds) |
Authentication > REST Inbound Authentication |
Specify the Object Manager session timeout, in seconds, to use for REST inbound authentication. For more information, see Siebel REST API Guide. |
|
Secure Channel |
Authentication > REST Inbound Authentication |
Specify whether to use a secure channel. Enforces OAuth server certificate validation, as required for introspection. For more information, see Siebel REST API Guide. |
|
User Interface Log Level |
Logging |
Specify the user interface logging level. Select one of the following options: Fatal, Error (default), Warning, Debug, Trace, Information, All |
|
EAI Log Level |
Logging |
Specify the EAI logging level. Select one of the following options: Fatal, Error, Warning, Debug, Trace, Information, All |
|
DAV Log Level |
Logging |
Specify the DAV logging level. Select one of the following options: Fatal, Error (default), Warning, Debug, Trace, Information, All |
|
REST Outbound Log Level |
Logging |
Specify the REST outbound logging level. Select one of the following options: Fatal, Error (default), Warning, Debug, Trace, Information, All |
|
REST Inbound Log Level |
Logging |
Specify the REST inbound logging level. Select one of the following options: Fatal, Error (default), Warning, Debug, Trace, Information, All |
|
SOAP Outbound Log Level |
Logging |
Specify the SOAP outbound logging level. Select one of the following options: Fatal, Error (default), Warning, Debug, Trace, Information, All |
|
Object Manager |
REST Inbound Defaults |
Select the Object Manager component to use for REST inbound communications, such as EAI Object Manager. For more information, see Siebel REST API Guide. |
|
REST Response Base URL |
REST Inbound Defaults |
Specify the base URL for a REST response. For more information, see Siebel REST API Guide. |
|
Maximum Possible Connections |
REST Inbound Defaults |
Specify the REST connection pool size. Default value: 20. For more information, see Siebel REST API Guide. |
|
Method Name |
REST Inbound Defaults > REST Resource Parameter List > Query |
Specify the method name to use for queries. For more information, see Siebel REST API Guide. |
|
Name |
REST Inbound Defaults > REST Resource Parameter List > Query > Parameter List |
Specify the name for each query parameter. For more information, see Siebel REST API Guide. |
|
Alias |
REST Inbound Defaults > REST Resource Parameter List > Query > Parameter List |
Specify the alias for each query parameter. For more information, see Siebel REST API Guide. |
|
Application Name |
Applications > Language > Basic Information |
Specify an application to configure for this instance of Siebel Application Interface, for each specified language. |
|
Object Manager |
Applications > Language > Basic Information |
Specify the Object Manager component for the selected application. |
|
Language |
Applications > Language > Basic Information |
Displays the language for the selected application. |
|
Request Start Command |
Applications > Language > Basic Information |
Specify the request start command for the selected application. |
|
Configure EAI HTTP Inbound Transport |
Applications > Language > Basic Information |
Specify whether to configure the EAI HTTP Inbound Transport. Choose this option for EAI applications only, and not for any other applications. |
|
Configure Anonymous Pool |
Applications > Language > Basic Information This option appears if you selected Configure EAI HTTP Inbound Transport. |
Specify whether to configure the anonymous pool for EAI requests. For more information, see Siebel Performance Tuning Guide. |
|
Anonymous Pool Size |
Applications > Language > Basic Information This option appears if you selected Configure EAI HTTP Inbound Transport and Configure Anonymous Pool. |
Specify the size of the anonymous pool for EAI requests. For more information, see Siebel Performance Tuning Guide. |
|
Maximum Retry for Processing EAI-SOAP Request |
Applications > Language > Basic Information This option appears if you selected Configure EAI HTTP Inbound Transport. |
Specify the maximum number of retries for processing SOAP requests for EAI. |
|
No Session Preference in EAI-SOAP |
Applications > Language > Basic Information This option appears if you selected Configure EAI HTTP Inbound Transport. |
Specify whether the session preference is required in EAI-SOAP. |
|
Configure Siebel Mobile |
Applications > Language > Mobile |
Specify whether to configure Siebel Mobile applications. |
|
Application Display Name |
Applications > Language > Mobile This option appears if you selected Configure Siebel Mobile. |
Specify the display name of the Siebel Mobile application. |
|
Application Display Order |
Applications > Language > Mobile This option appears if you selected Configure Siebel Mobile. |
Specify the display order of the Siebel Mobile application. |
|
Application Icon Name |
Applications > Language > Mobile This option appears if you selected Configure Siebel Mobile. |
Specify the icon name of the Siebel Mobile application. |
|
Active Session Timeout Value |
Applications > Language > Enhanced Authentication Note: Use the Enhanced Authentication settings to optionally configure authentication for individual applications, if you require override settings different from the defaults specified under Basic Information and Authentication. |
Specify the total number of seconds that a session can remain inactive before the user is logged out and the session is closed. Default value: 900 (seconds) |
|
Login Session (guest session) Timeout Value |
Applications > Language > Enhanced Authentication |
Specify the timeout value for the login session. Default value: 300 (seconds) |
|
Method to Check Server Availability |
Applications > Language > Enhanced Authentication |
Specify the method to use for checking server availability. Default value: UpdatePrefMsg |
|
Command to Check Server Availability |
Applications > Language > Enhanced Authentication |
Specify the command to use for checking server availability. Default value: HeartBeat |
|
Session Token Usage Duration |
Applications > Language > Enhanced Authentication |
Specify the usage duration for the session token. Default value: 2880 (minutes) |
|
Session Token Timeout Value |
Applications > Language > Enhanced Authentication |
Specify the timeout value for the session token. Default value: 900 (seconds) |
|
Configure Web Single Sign-On (Web SSO) |
Applications > Language > Enhanced Authentication |
Specify whether to use Web single sign-on. |
|
Anonymous User Name |
Applications > Language > Enhanced Authentication |
Specify the Siebel user name that starts the anonymous session for the specified application. For example: GUESTCST For more information about anonymous users, see Requirements for Configuring Anonymous Users for the Siebel Application Interface. |
|
Anonymous User Password |
Applications > Language > Enhanced Authentication |
Specify the password for the anonymous user. |
|
Trust Token |
Applications > Language > Enhanced Authentication This option appears if you selected Configure Web Single Sign-On. |
Specify the trust token to use for Web SSO authentication. |
|
User Specification |
Applications > Language > Enhanced Authentication This option appears if you selected Configure Web Single Sign-On. |
Specify the user specification to use for Web SSO authentication. |
|
Resource Type |
REST Inbound Resources > Data |
In this section, you optionally provide alias names to the REST parameters. Specify the resource type for the REST resource parameter: Data, Service, or Workspace. |
|
Method Name |
REST Inbound Resources > Data > REST Resource Parameter List > Query |
Specify the method name: Query (for example). |
|
Name Alias |
REST Inbound Resources > Data > REST Resource Parameter List > Query > Parameter List |
For the current method name (such as Query), specify each REST resource parameter name for which you want to specify an alias, and specify the alias. For example, for the REST resource parameter named PageSize, you can configure an alias, such as Limit, as shown: Name=PageSize Alias=Limit Or, for the StartRowNumber parameter, you can specify an alias like Offset, as shown: Name=StartRowNumber Alias=Offset |
|
Language |
Other Information > SWE |
Provide the default language for Siebel CRM. |
|
HTTP-POST Request Size |
Other Information > SWE |
Specify the maximum size, in bytes, of HTTP POST requests from the Siebel Application Interface. |
|
Seed File Location |
Other Information > SWE |
Specify the location of the seed file. (This setting is available for future use.) |
|
Monitor Sessions |
Other Information > SWE |
Specify whether to gather statistics on all of the current sessions and report them in the Siebel Application Interface statistics (stats) page. For more information about this page, see Siebel System Monitoring and Diagnostics Guide. |
|
Collect Application-Specific Statistics |
Other Information > SWE |
Specify whether to enable the collection of application-specific statistics. |