Community preferences
The following tables list the default community preferences and alternate community preferences for the IBM® Sametime® Connect Client and Sametime Embedded Client for Notes®.
| Attribute | Variable type | Description |
|---|---|---|
| kioskMode | Boolean | Sets whether or not the client functions in kiosk mode. |
| logoutWhenIdle | Boolean | Sets the initial value of whether or not the client logs out when idle. This preference takes effect for new Sametime users with no previous workspace. For any existing user, this preference will be overridden to "false" when the autostatus settings are retrieved from the server since the preference did not exist prior to release 8.0.1. |
| logoutWhenIdleOverride | Boolean | Provides a mechanism for an admin to override the user's logoutWhenIdle setting. If set to true, then the client will always logout when idle, and the user will not be able to change the value in the UI. |
| logoutWhenLocked | Boolean | Sets the initial value of whether or not the client logs out when locked. This preference takes effect for new Sametime users with no previous workspace. For any existing user, this preference will be overridden to "false" when the autostatus settings are retrieved from the server since the preference did not exist prior to release 8.0.1. |
| logoutWhenLockedOverride | Boolean | Provides a mechanism for an admin to override the user's logoutWhenLocked setting. If set to true, then the client will always logout when locked, and the user will not be able to change the value in the UI. |
| tokenLoginOnly | Boolean | Specifies the whether or not to force login by token for the default community. Part of login extensibility (see the Sametime SDK). Must be set prior to client launch. |
| host | String | Specifies the initial community host value. Must be set prior to client launch. |
| useAuthServer | Boolean | Specifies the initial useAuthServer value for the default community. Part of login extensibility (see the Sametime SDK). Must be set prior to client launch. |
| authServerUrl | String | Specifies the initial authentication server URL value for the default community. Part of login extensibility(see the Sametime SDK). Must be set prior to client launch. |
| defaultAuthType | String | Specifies the authentication type for the default community. Part of login extensibility (see the Sametime SDK). Must be set prior to client launch. |
| keepAlive | Boolean. Default is true. | Specifies the initial keep alive value. Must be set prior to client launch. |
| keepAliveInterval | Integer. Default is 60. | Specifies the initial keep alive interval value for the default community. Must be set prior to client launch. |
| loginByToken | Boolean | Specifies the initial loginByToken value for the default community. Part of login extensibility (see the Sametime SDK). Must be set prior to client launch. |
| name | String | Specifies the initial name for the default community. Must be set prior to client launch. |
| port | Integer. Default is 1533. | Specifies the initial community port value. Must be set prior to client launch. |
| savePassword | Boolean. Default is false. | Specifies the initial savePassword value for the default community. Must be set prior to client launch. |
| connectionType | String. Valid values include direct, tls-direct, http-direct, socks4-proxy, socks5-proxy, http-proxy, https-proxy, reverse-proxy, useBrowserSettings. | Specifies the initial connectionType value for the default community. Must be set prior to client launch. |
| proxyHost | String | Specifies the initial proxy host value for the default community. Must be set prior to client launch. |
| proxyPort | Integer | Specifies the initial proxy port value for the default community. Must be set prior to client launch. |
| proxyUserName | String | Specifies the initial proxy user name for the default community. Must be set prior to client launch. |
| proxyPassword | String | Specifies the initial proxy password for the default community. Must be set prior to client launch. |
| proxyResolvesLocally | Boolean | Specifies the initial proxyResolvesLocally value for the default community. Must be set prior to client launch. |
| loginTokenRefreshInterval | Integer. Default is 900000. | Specifies the login token refresh interval in milliseconds. The default is 900000, or 15 minutes. |
| Attribute | Variable type | Description |
|---|---|---|
| altCommunityConfig.managedIds | String | Required. A comma-delimited set of IDs that represents each alternate community. For example, altCommunityConfig.managedIDs=altHost1,altHost2 defines two alternate communities named altHost1 and altHost 2. |
| altCommunityConfig.altHost.altHostID.targetCommunityHost | String | Required. The host name of the alternate community. altHostID represents the ID you defined for the alternate community in the managedIds preference, such as altHost1. |
| altCommunityConfig.altHost.altHostID.enabled | Boolean. Default is true. | Enables the alternate community configuration. |
| altCommunityConfig.altHost.altHostID.weight | Integer. Default is 0. | The weight of the alternate community configuration relative to other alternate communities. The higher the value, the greater the weight. For example, a connection to an alternate community with a weight of 2 is tried before one with a weight of 0. Regardless of the assigned weight, the client attempts a connection to the last successful alternate community first. |
| altCommunityConfig.altHost.altHostID.type | String. The default is postDefaultConfig. | Determines if the alternate community connection is tried before the default community or after. A value of postDefaultConfig attempts the connection after trying to connect to the default community. A value of preDefaultConfig attempts to connect to the alternate community first. |
| altCommunityConfig.altHost.altHostID.attemptCount | Integer. The default is 1. | Sets the number of times the client attempts to connect to the alternate community before trying another community. |
| altCommunityConfig.altHost.altHostID.fallbackOnly | String | By default, this preference is not set and the client attempts a connection to the last successful alternate community first. If you set the preference fallbackOnly for a specific alternate community, it will never be retried first, even if it was the last successful connection. |
| altCommunityConfig.altHost.altHostID.host | String | Defines a secondary alternate community host to connect to if the host defined in the targetCommunityHost preference cannot be reached. For example, if the targetCommunityHost is im1.example.com, the host could point to im2.example.com. |
| altCommunityConfig.altHost.altHostID.authServerUrl | String | Specifies the server URL for Single Sign-on authentication. |
| altCommunityConfig.altHost.altHostID.authType | String | Defines the method used for Single sign-on authentication. Use TAM-SPNEGO for SPNEGO authentication or ST-DOMINO-SSO for Domino® authentication within Notes. |
| altCommunityConfig.altHost.altHostID.port | Integer | The port to use if other than the default 1533. |
| altCommunityConfig.altHost.altHostID.connectionType | String. Valid values include direct, tls-direct, http-direct, socks4-proxy, socks5-proxy, http-proxy, https-proxy, reverse-proxy. | Determines how the client connects to the alternate community. The default is direct. |
| altCommunityConfig.altHost.altHostID.proxyHost | String | Specifies the initial proxy host value for the alternate community. |
| altCommunityConfig.altHost.altHostID.proxyPort | Integer | The port of the proxy. |
| altCommunityConfig.altHost.altHostID.loginByToken | Boolean | Determines if the client logs in by token. If the token login fails and the password is available, the client attempts password-based authentication instead. |
| tryLastSuccesfulConfigFirst | Boolean. Default is true. | Determines if the client first tries the alternate community it last connected to successfully. If you change the value to false, the client always attempts Connections to the alternate communities in the default priority order set in the managedIDs list, regardless of which alternate community connection was successful last. |