Preference attributes

Preferences configure MarkView characteristics and behavior. Each preference uses attributes that determine how the preference interacts with MarkView.

The attributes displayed in the Details page of MarkView or MarkView Process Administration are set by the MarkView Installation application.

For the best results, leave shipped preferences in their existing configurations.

ID

The preference ID is an integer used by MarkView to identify the preference. The MarkView installer generates this number, which is visible only in the Administration interface.

Preference Name

The name of the preference, such as VIEWER_INCLUDE_PRINT.

Description

A brief description of the preference and its purpose in MarkView. This field can contain up to 200 characters. For example, the VIEWER_INCLUDE_PRINT description states whether to include a print option on the toolbar menu.

System Level YN

This attribute specifies whether the preference is available at the system level. System level preferences affect all users across the system. Use this attribute to set broad system defaults. If you set this attribute Y, you, as the administrator, can set system-level values. If you set this attribute to N, you cannot set system-level values. In the event of a conflict, group/role and user level preferences override system level preferences.

Group or Role Level YN

This attribute specifies whether or not the preference is available at the MarkView group or role level. Group level preferences affect users in a specific group; role level preferences affect users assigned to a specific role. For example, an AP user group might have preference settings that differ from a Purchasing user group. If you set this attribute to Y, then you, as the administrator, can set different values for different groups or roles. If you set this attribute to N, then you cannot set different preference values for different groups or roles. In cases where a user belongs to multiple groups or is assigned to multiple roles with conflicting preference settings, MarkView resolves the conflict using the Group|Role Resolution Method attribute.

User Level YN

This attribute specifies whether or not the preference is available at the user level. If you set this attribute to Y, then you, as the administrator, can set different values for different users. If you set this attribute to N, then you cannot set different preference values for different users. User level preferences are the most granular level of preference. They affect only a specific user, and they override all group or role level and system level preference settings.

Changeable YN

This attribute specifies whether or not the administrator can edit the preference value. The MarkView installer permanently sets some preference values at installation. If you set this attribute to Y, you can later change the value for this preference at all available levels. If you set this attribute to N, the installer sets a permanent value for this preference.

For example, SCAN_FILENAME_EXT sets the default file extension for MarkView document image files to TIF; this cannot be changed.

Use Default Value YN

Specifies whether or not to use the default preference value if no value is specified for the preference. If you set this attribute to Y, the preference uses the default value specified in the Default Value attribute. If you set this attribute to Y and leave the default value blank, the default value is NULL.

Default Value

If set to Y, the default value derives from this attribute. Default values that the MarkView installer sets are generally either typical values or examples of the correct form for the preference value. Kofax recommends that you leave the default value as an example of the correct form or typical setting for this preference, and apply system wide values using the System Level Value attribute.

System Level Value

Specifies the default system-level value for the preference. If no preference value is set on the System, Group, or User level subtabs, this value is used.

Group or Role Level Priority YN

Value priorities are numeric values attached to each potential preference value. This attribute specifies whether to use the value priorities to resolve group or role level conflicts when you specify a Group|Role Resolution Method attribute of 1 (Value). The MarkView installer specifies value priorities within the database; they are not visible in the Administration interface.

Group or Role Resolution Method

Specifies how to resolve conflicts between group or role level values. When a user belongs to multiple groups or is assigned to multiple roles with different values for the same preference, MarkView resolves the conflict using the method represented by one of the following values:

  • 1 (Value): Resolve conflicts by comparing the priority values assigned to the preference values. Use the preference value having the greatest priority value. When the domain is GENERIC_BOOLEAN_TRUE_DOMINATES, use TRUE, as the higher priority value of the two possible preference values TRUE and FALSE, to resolve conflicts.

  • 2 (Least): MarkView orders the preference values from low to high based on the ASCII order of the preference value and chooses the lowest value. When the domain is GENERIC_BOOLEAN_TRUE_DOMINATES, use FALSE, as the lower priority value of the two possible preference values TRUE and FALSE, to resolve conflicts.

  • 3 (Greatest): MarkView orders the preference values from low to high based on the ASCII order of the preference value and chooses the highest value. When the domain is GENERIC_BOOLEAN_TRUE_DOMINATES, use TRUE, as the higher priority value of the two possible preference values TRUE and FALSE, to resolve conflicts.

  • 4 (Random): Of the possible values, MarkView selects one at random. MarkView uses this method of conflict resolution to load balance URL values. When the preference domain is GENERIC_BOOLEAN_TRUE_DOMINATES, random selection between TRUE and FALSE over the course of ten iterations results roughly in five conflicts resolved with TRUE, and five resolved with FALSE.

Preference Domain Name

This attribute specifies the range of acceptable values for the preference. For example, the preference domain ADMIN_ACCESS_SELECT_ALL_NONE allows only three possible values: SELECT, ALL, and NONE. The preference domain LEGACY_FREE_TEXT allows a user-specified text string.

Although preference domain names are generally descriptive, the actual values specified within the domain are defined within the database. To view a preference domain’s allowable values, you must query your database.

Data Type

This attribute specifies the type of data used to represent the preference value. For example, a preference that specifies a URL would have a Data Type of character. Possible values are:

  • 1 (Character): Preference requires alphanumeric values.

  • 2 (Number): Preference requires numeric values.

  • 3 (Date): Preference requires date values.

Allow Null Value YN

This attribute specifies whether or not the preference can have a null value.

Range Low Value

For preferences that allow free text, this attribute specifies the low end of a range of valid ASCII characters. For example, for a preference that requires a number from 1 to 7, the low end would be 1. You can use ranges to constrain the entry to valid preference values.

Range High Value

For preferences that allow free text, this attribute specifies the high end of a range of valid ASCII characters. For example, for a preference that requires a number from 1 to 7, the high end would be 7. You can use ranges to constrain the entry to valid preference values.

Maximum Text Length

For preferences that take an alphanumeric value, this attribute specifies the maximum number of characters allowed in the preference value. This attribute is applicable to all Data Types. In the case of MVT_ADMIN_COLOR, this attribute is limited to ten, the number of characters needed to spell out the longest possible value.

Domain Values YN

This attribute specifies whether or not the preference is limited to a predefined list of values specified within the preference domain. A preference domain specifies the range of acceptable values for the preference. For example, a URL might allow unrestricted text values, whereas a list of actions would be limited to those that ship with MarkView