Aptify supports several configuration properties that an administrator can configure in the Startup.exe.config file (to apply to all users), the Aptify Shell.exe.config file (to apply to all users), or in the Attributes.xml file (to apply to a specific client). See Modifying the Login Configuration Attributes Globally and Modifying the Login Configuration Attributes Locally for information on how to set these properties within these files.
The following list contains the most commonly used properties that an administrator may want to configure, including Login preferences and system display settings. Also, refer to the Aptify Software Development Kit (SDK) for a complete list of the AptifyLogin properties.
- Server: This property specifies the server to which the user is connecting. If blank, the Server field appears on the login dialog and the user must enter a server name or select one from the Aptify Server List dialog (if configured). This is the default behavior. If a server name is specified for this property, the Server field does not appear in the dialog (but the server's name is specified in the Login caption, as shown in the example below). Note that the login dialog will not appear if you specify a Server value and user account values in one of the configuration files. Configure this attribute in Startup.exe.config when specifying globally (as opposed to in Aptify Shell.exe.config).
- SuggestedServer: This property is similar to the Server property, except that when a SuggestedServer is specified, the Server field appears on the login dialog with the suggested server name filled in. With this setting, a user can leave this field at its default setting to connect to the suggested server, but it also gives the user an opportunity to specify a different server if necessary. Configure this attribute in Startup.exe.config when specifying globally (as opposed to in Aptify Shell.exe.config).
- RecentServer: This property specifies a server name that will appear in the Aptify Server List dialog (see example below). The Server List dialog can support up to five servers, which correspond to the RecentServer01 to RecentServer05 configuration properties. Configure this attribute in Startup.exe.config when specifying globally (as opposed to in Aptify Shell.exe.config).
- EntitiesDatabase: This specifies the database that contains the entity definitions. By default, this value is set to Aptify, and a corresponding field does not appear on the login dialog (in other words, a user cannot change the Entities Database value from within the dialog). Configure this attribute in Startup.exe.config when specifying globally (as opposed to in Aptify Shell.exe.config).
- SuggestedEntitiesDatabase: This property is similar to the EntitiesDatabase property, except that when a SuggestedEntitiesDatabase is specified, the Entities Db field appears on the login dialog with the suggested database name filled in. With this setting, a user can leave this field at its default setting, but it also gives the user an opportunity to specify a different database if necessary. See the example below. Configure this attribute in Startup.exe.config when specifying globally (as opposed to in Aptify Shell.exe.config).
- UsersDatabase: This specifies the database that stores record data. By default, this value is set to Aptify, and a corresponding field does not appear on the login dialog (in other words, a user cannot change the Users Database value from within the dialog). Configure this attribute in Startup.exe.config when specifying globally (as opposed to in Aptify Shell.exe.config).
- SuggestedUsersDatabase: This property is similar to the UsersDatabase property, except that when a SuggestedUsersDatabase is specified, the Users Db field appears on the login dialog with the suggested database name filled in. With this setting, a user can leave this field at its default setting, but it also gives the user an opportunity to specify a different database if necessary. See the example above. Configure this attribute in Startup.exe.config when specifying globally (as opposed to Aptify Shell.exe.config).
- Trusted: By default, this property is set to False, and the SQL Server login option (that is, the Specify a User Name and Password option) is the default selection in the login dialog in the Database Login Information section. When this property is set to True, the system assumes that the user is trusted so the Database Login Information section of the dialog does not display (as shown in the example below). Configure this attribute in Startup.exe.config when specifying globally (as opposed to in Aptify Shell.exe.config).
- Note that when a server is specified (using the Server property) and Trusted is set to True, the login dialog does not appear, and a user is logged in automatically when the Aptify Desktop client is launched.
- Note that when a server is specified (using the Server property) and Trusted is set to True, the login dialog does not appear, and a user is logged in automatically when the Aptify Desktop client is launched.
- SuggestedTrusted: You can use this property with a value of True to display the Database Login Information section of the dialog but default to the Use Windows Integrated Security option. This provides the user with the opportunity to log in as an untrusted SQL Server user, if necessary. Configure this attribute in Startup.exe.config when specifying globally (as opposed to in Aptify Shell.exe.config).
- SQLLogin: You can use this property in conjunction with a Trusted or SuggestedTrusted property set to False to specify an untrusted SQL server login account. If you specify this account's corresponding password using the Password property, then the Database Login Information section of the dialog does not display (as shown the example above). If you do not specify a Password, the specify SQL login name appears in the User Name field and the user can modify this login name as necessary. Configure this attribute in Startup.exe.config when specifying globally (as opposed to in Aptify Shell.exe.config).
- Note that when a server is specified (using the Server property), Trusted is set to False, SQLLogin is set to an untrusted user, and Password is set to that user's password, then the login dialog does not appear, and a user is logged in automatically when the Aptify client is launched.
- SuggestedSQLLogin: This property is similar to the SQLLogin property, except that when this property is used along with a specified Password, the Database Login Information section of the dialog appears. With this setting, a user can leave the User Name field at its default setting, but it also gives the user an opportunity to specify a different user account if necessary. Configure this attribute in Startup.exe.config when specifying globally (as opposed to in Aptify Shell.exe.config).
- Password: You can use this property in conjunction with the SQLLogin property to specify an untrusted SQL server login account. Configure this attribute in Startup.exe.config when specifying globally (as opposed to in Aptify Shell.exe.config).
-
SuggestedPassword: You can use this property in conjunction with the SuggestedSQLLogin property to specify a default untrusted SQL server login account while still displaying the DatabaseLogin Information section of the dialog. Configure this attribute in Startup.exe.config when specifying globally (as opposed to in Aptify Shell.exe.config).
The Password and SuggestedPassword properties save a user's password to a file as plain text. Aptify recommends that you not specify these properties in a configuration file.
- LoginCaption: This property determines what text appears in the login dialog's caption area. By default, the caption reads Aptify. (This is the value that appears if you do not include this property in the configuration file.) If you want to provide your own caption, add this property to the configuration file and specify the desired text as the property's value. In the example below, the LoginCaption property has a value of My Organization: CRM Solution. Configure this attribute in Startup.exe.config when specifying globally (as opposed to in Aptify Shell.exe.config).
- Note that the caption does not support all characters. For example, you cannot use a single quote (') in the LoginCaption.
- Note that the caption does not support all characters. For example, you cannot use a single quote (') in the LoginCaption.
- EnhancedUI: Aptify includes an enhanced user interface that includes visual features such as a gradient fill on forms. However, these features require that Aptify use more system resources than earlier versions of Aptify. Therefore, users who have slower hardware may see improved productivity by disabling the Enhanced UI feature. This property uses True/False values to determine whether or not the Enhanced UI feature is enabled. Configure this attribute in Aptify Shell.exe.config when specifying globally (as opposed to in Startup.exe.config). Note that you can also add this attribute to a local user's Attributes.xml file to turn off the functionality only for users with slower hardware.
- ColorScheme: Aptify includes support for the Office 2010 and Office 2007 color schemes: Blue, Silver, and Black. By default, Aptify uses whatever color scheme is currently configured for Office 2010, or Blue if Office 2010 is not installed. However, you can use this attribute to set Aptify to use a particular color scheme regardless of the Office 2010 settings. For this attribute, a value of 0 or 1 corresponds to the user's current Office 2010 theme. When set to 2, Aptify will always use the Blue scheme. When set to 3, Aptify will always use the Silver scheme. When set to 4, Aptify will always use the Black theme. Configure this attribute in Aptify Shell.exe.config when specifying globally (as opposed to inStartup.exe.config).
- BuiltInCultureID: Aptify includes extensive support for localizing the system for multiple cultures. However, many organizations do not require this functionality. For these organizations, Aptify provides a localization bypass for a specified Culture. By default, Users with a Culture ID of 1 (English in the standard Aptify system) bypass localization. With the bypass in place, Aptify uses the Culture String data's Base String only and does not load Local String information. To change the ID of the Culture, an administrator can add the entry shown below to Aptify Shell.exe.config (when this entry does not exist, then the bypass Culture is ID 1 (English)). Configure this attribute in Aptify Shell.exe.config when specifying globally (as opposed to in Startup.exe.config). See "Localization" in the Admin Guie for more information on localizing the Aptify interface.
<add key="Aptify.Framework.BusinessLogic.CultureUtility.BuiltInCultureID" value="[CultureID]"/>
-
DisplayOnlineHelpOnFieldHover: Aptify includes the ability to display information about a specific field simply by hovering over the desired field. By default, this functionality is turned off with a value of False. However, this functionality which works throughout the Aptify system can be enabled by changing the value to True. See Using the Help Button for more details.
Aptify Shell.exe.config also includes attributes that control the appearance of the label caption for required fields. See Configuring the Appearance of Required Fields for details.
Comments
Please sign in to leave a comment.