Settings - Advanced Tab

The following table contains all the namespaces and properties listed on the Advanced tab and includes additional detail for property name descriptions that do not fit on the tab.

Filter the information that appears on the Advanced tab by entering criteria in the field at the top of each column. For example, to view only properties associated with the mfp.hp.properties namespace, type mfp.hp in the entry field at the top of the Namespace column. Only properties for the mfp.hp.properties namespace appear in the list.

To add a setting, click Create. The Create New Advanced Settings window appears where you define the namespace, property, and value for the setting.

To delete the settings you create, select the box to the left of the setting and click Delete. You cannot delete settings provided with Kofax Front Office Server.

Namespace / Property	Description and Settings
kc.properties
batchname.indexfield	Document class index field used to supply the name of the batch. If the index field is blank, Kofax Front Office Server generates a name. If the batch class contains a batch field with the same name as the index field, the batch field value is used for the batch name instead of the index value. The default is empty.
batchname.kofaxcapture.usedefault	Whether Kofax Capture names the batch based on the settings configured for the batch class. true: Kofax Capture names the batch. false (default): The user manually names the batch.
kfs.properties
CacheMaxAge	Maximum HTTP content age for static content (such as javascript files), expressed in minutes.
DisableCaching	Disables caching of static content.
LockInterval	The interval (in minutes) before a process lock expires. The default is 60 minutes. Caution Do not change this setting unless you are instructed to do so by Technical Support personnel.
ProxyServer	How Kofax Front Office Server identifies itself. In a single server configuration, this value is the server host name. In a clustered configuration, this value is the host name of the cluster proxy or load balancer.
ProxyServerPort	Default http port for communicating with the Kofax Front Office Server. The default is 80.
ProxyServerProtocol	Default protocol for communication with the Kofax Front Office Server: https http (default)
ProxyServerSecurePort	Default https port for communicating with the Kofax Front Office Server. The default is 443.
RetryInterval	The interval (in minutes) before the server retries a failed job. The default is 5 minutes.
kfsportal.properties
client.alive.notification.interval	The interval (in seconds) at which the Thin Client reports to the server that there is user activity (either mouse clicks or key presses and the server resets the session timeout clock. This value should be shorter than the session timeout value. Values greater than 0, but less than 10, are rounded up to 10 seconds. If this field is left blank or set to 0, the setting is not used.
client.session.timeout	The session timeout (in seconds) for the Administration Console and the Thin Client. If there is no user activity within the specified amount of time, the user session expires. The user must log on again to continue. The default is 1800 (30 minutes).
conf.exchange.domain	Fully qualified domain name where the Microsoft Exchange server is located. Microsoft Exchange user accounts to be associated with Kofax Front Office Server users must be on this domain. Used by enhanced lookup to search email addresses and fax numbers from Microsoft Exchange Server. Example where domain.com is the location: conf.exchange.domain=domain.com.
conf.exchange.server	Microsoft Exchange server host name or IP address. Example where the host name is exchange: conf.exchange.server=exchange.
conf.exchange.web.services	Reserved.
conf.exchange.web.service.url	Reserved.
inbox.refresh.interval	Reserved.
indexfield.maxlinewidth	Reserved.
paging.page.size	Reserved.
thumbnail.generator.priority	Reserved.
thumbnail.generator.threads	Reserved.
Licensing
ConcurrentMobileDeviceCleanupFrequency	Frequency in which idle devices are removed, expressed in minutes. The default is 15 minutes.
ConcurrentMobileLicenseDuration	Duration of a concurrent mobile license, expressed in minutes. The default is 15 minutes.
EvaluationEnablesConcurrentMobileLicensing	Whether an evaluation license can mobile devices concurrently. The default is True.
mfp.hp.properties
allowed.upload.compression.types	Allowed data compression types for TIFF files uploaded from the Thin Client if restrict.upload.compression.types is set to true. Separate the types with commas. (Example: GROUP4,GROUP3_1D,GROUP3_2D,NONE)
allowed.upload.extensions	File extensions that can be uploaded from the Thin Client if restrict.upload.extensions is set to true. Separate the extensions with commas. (Example: tif,jpg,png)
days.to.retain.failed.scan.images	Number of days to retain failed scan images for resend.
mfp.assembly	Assembly values are: true (default): Prompt users to scan more pages. false: Do not display the prompt.
mfp.duplex	Duplex values are: true: Double-sided scanning with the ADF. false (default): Single-sided scanning
mfp.password	Password for the MFP user.
mfp.port	Communication port to the MFP.
mfp.protocol	Protocol used for communication to the MFP from Kofax Front Office Server server: https http (default)
mfp.retry.count	Number of attempts to send images to the server before failing. The default is 20.
mfp.retry.interval	Minutes between retries (must be a positive value). The default is 10.
mfp.scan.color.mode	The color mode: Color Grayscale (default)
mfp.scan.file.type	A file type: JPG TIF (default)
mfp.scan.image.adjust.background.cleanup	A background cleanup value between 0 and 8. The default is 0.
mfp.scan.image.adjust.darkness	A darkness value between 0 and 8. The default is 4.
mfp.scan.image.adjust.sharpness	A sharpness value between 0 and 4. The default is 2.
mfp.scan.output.quality	The output quality: Low Medium High The default is Medium.
mfp.scan.optimize.text.photo	Optimize scanning for based on one of these settings: Text Graphic Mixed0 Mixed1 Mixed2 Mixed3 Mixed4 The default is Mixed2.
mfp.scan.page.size	The page size: A3 A4 A5 Executive Government-Legal JB4 JB5 Ledger Legal Letter Mixed (default) Statement
mfp.scan.resolution	The scan resolution value (as dots per inch or dpi): 75 150 200 (default) 300 400 600
mfp.selectionlist.max	Maximum number of items displayed in a list on the MFP. The default is 50.
mfp.username	Username to log on to the MFP.
restrict.upload.compression.types	Whether the system restricts TIFF file uploads: true: Restrict TIFF file uploads from the Thin Client to allowed compression types. false: Allow all TIFF files.
restrict.upload.extensions	Whether the system restricts file uploads: true: Restrict file uploads from the Thin Client to files with allowed extensions. false: Allow all files.
server.authmode	The authentication mode: none (Default): After logging on to the MFP device, the system prompts users for their user name and password for personal shortcuts. semi—After logging on to the MFP device, the system prompts users for their password for personal shortcuts. The user name field is already populated. full— At the MFP device, users log in once to use both MFP and Kofax Front Office Server features (single sign on). Kofax Front Office Server obtains the qualified user’s Windows domain name from the MFP as follows: WindowsDomainName\Username. For LDAP authentication at the MFP, enter userPrincipalName in the MFP LDAP field labeled “Retrieve the device user’s email address using attribute of.” (The field name may vary based on your MFP model.) Also, ensure that the LDAP attribute userPrincipalName uses the format: username@domain (for example: admin@mydomain.com). This setup and format are required by Kofax Front Office Server to obtain the user’s domain name. For SafeCom authentication at the MFP, ensure that the user’s email address is set at the MFP when the user is authenticated and the domain extracted from the email address is consistent with the user’s Windows domain name in Kofax Front Office Server. For SecureJet authentication at the MFP, ensure that the appropriate domain is specified when you configure the LDAP login and password profile (in the Domain box, under LdapLogin, in SecureJet Admin Software). For SecureJet 6.2, install OXPd before you install SecureJet to avoid a compatibility issue.
server.protocol	Protocol used for communication from the MFP to Kofax Front Office Server server: https http (default)
mfp.konica_minolta.properties
color.value	The color type: 1: FullColor 2: Black(Bitonal) 4: GrayScale
default.user.auth.option	The default option for Log On Mode 1=No Authentication, 2=Authentication.
enable.image.encryption	Image Transfer Encryption: 1=Enabled, 2=Disabled
enable.openapi.logging	Whether to log OpenAPI messaging between MFP device and connector: 1=Enabled, 2=Disabled
ftp.server.address	FTP server name or IP address.
ftp.server.anonymous	FTP Server Anonymous mode: 1=Disabled, 2=Enabled. Note: this setting applies only to communication between the Konica Minolta device and the FTP server.
ftp.server.lock.timeout	FTP lock timeout, expressed in minutes. We recommend that you do not change the value unless instructed to do so by Technical Support personnel.
ftp.server.max.job.processing.attempts	Number of attempts to process a job from the FTP folder before moving it to the failed jobs folder, default=5.
ftp.server.passive	FTP Server Passive mode: 1=Disabled, 2=Enabled. Note: this setting applies only to communication between the Konica Minolta device and the FTP server.
ftp.server.password	FTP server password.
ftp.server.port	FTP server port.
ftp.server.proxy	FTP Server Proxy mode: 1=Disabled, 2=Enabled. Note: this setting applies only to communication between the Konica Minolta device and the FTP server.
ftp.server.upload.folder	Location on the FTP server where files will be uploaded from the device. This should be a subdirectory of the home folder for the user specified below.
ftp.server.username	FTP server user.
polling.initial.delay	Polling thread in milliseconds.
polling.period	Polling period.
require.user.auth	Requires the user to select “Authentication” for Log On Mode. 1=Require Authentication, 2=Don't require Authentication.
resolution.value	1=Dpi200x100, 2=Dpi200x200, 3=Dpi300x300, 4=Dpi400x40, 5=Dpi600x600
webdav.username	User name of the WebDAV user used for authentication.
webdav.password	Password for the WebDAV user used for authentication.
webdav.port	Port number for WebDAV (default = 80).
webdav.protocol	Communications protocol for WebDAV communications, either http or https (default = http).
imagetransfer.method	Select the transfer method for images, either ftp or webdav (default = webdav).
mfp.ricoh.properties
mfp.password	Ricoh client deployer password, which is set to ricoh by default.
mfp.port	Ricoh client deployer port.
mfp.protocol	Ricoh client deployer protocol.
mfp.username	Ricoh client deployer user name.
mfp.xerox.properties
failed.job.threshold.min	Amount of time to determine a job is failed for Xerox MFPs, expressed in minutes.
failed.jobs.polling.interval.ms	Failed jobs polling interval for Xerox MFPs, expressed in milliseconds.
mfp.inactivity.timeout.seconds	Number of seconds of inactivity that elapse before automatic log off.
mfp.scan.color.mode	BLACK_AND_WHITE, GRAYSCALE, FULL_COLOR, default=BLACK_AND_WHITE Note: for file type XSM_TIFF_V6 only BLACK_AND_WHITE is allowed, for file type JFIF_JPEG only GRAYSCALE or FULL_COLOR is allowed.
mfp.scan.compression.quality	CompressionQuality=0-255 (0 lowest quality, 255 highest quality), default=127.
mfp.scan.contrast	-100 - 100, Default=0(depends on Document image mode and Darkness).
mfp.scan.darkness	-100 - 100, Default=0.
mfp.scan.file.type	File type values are XSM_TIFF_V6, JFIF_JPEG. The default is XSM_TIFF_V6.
mfp.scan.image.mode	TEXT\|PHOTO\|MIXED\|MAGAZINE\|HALFTONE, default=MIXED.
mfp.scan.orientation	PORTRAIT\|LANDSCAPE, default is PORTRAIT.
mfp.scan.resolution	Resolution values (as dots per inch or DPI): RES_72X72, RES_100X100, RES_200X100, RES_100X200, RES_200X200, RES_300X300, RES_400X400, RES_600X600.
mfp.scan.sharpness	-100 - 100, Default=0 (depends on Document image mode).
mfp.scan.sides	ONE_SIDED\|TWO_SIDED default is ONE_SIDED.
template.max.chars.per.metadata.entry	Index field value strings longer than this value are written in multiple parts as separate metadata items to avoid very long strings in metadata. The maximum value depends on the device model. Default = 100.
shared_resources.properties
cached.scan.job.lifetime.seconds	Reserved.
db.failover.retry.count	Reserved.
db.failover.retry.interval	Reserved.
email.smtp.timeout.millis	Email SMTP destination type timeout, expressed in milliseconds. The minimum value is 100000 milliseconds (1 minute and 40 seconds) and the default value is 1200000 milliseconds (20 minutes).
filesys.min.retries	Minimum number of times to retry, regardless of timeout.
filesys.retry.timeout.millis	Timeout period before stopping retries.
filesys.retry.wait.millis	Time to wait between retries.
kfs.db.failover.retry.count	Reserved.
kfs.db.failover.retry.interval	Reserved.
kfs.scanjob.db.failover.retry.count	Reserved.
kfs.scanjob.db.ignored.error.codes	Reserved.
max.cached.scan.jobs	Reserved.
scanjob.server.retry.frequency	Reserved.
SMTPNotification
Kofax.SMTP.Timeout	Email notification timeout, expressed in seconds.
system.resource.checker.properties
accept.requests.on.disk.check.error	Whether or not requests should be accepted if disk space check fails. If no value is specified, the default "true" is used. Values: true, false
check.frequency.millis	How often to check available disk space in milliseconds. If no value is specified, the default 60000 is used.
enabled	Whether or not the filter is enabled.
limits	Minimum limits for available disk space, and the paths to check. There is no default setting for this property. Format: <size>@<path>;<size>@<path>; where <size> is nK (kilobytes), nM (megabytes), or nG (gigabytes) <path> is a system file path or {SharedStorage} You can add multiple size/path pairs separated by a semicolon. Requests are blocked if any of the drives falls below the specified limit. If you only specify /, the drive where Kofax Front Office Server is installed is checked. The path can be a UNC path, for example 10G@//another server/scanjobs. Example: limits=100M@C:/;1G@D:/;50M@ {SharedStorage} Requests are blocked if drive C falls below 100 MB free space, drive D falls below 1 GB free space, and the drive where the workdir is located falls below 50 MB.
vrs-default.properties
AdvancedClarity	Applies only when ColorMode=3 (black/white). Applies advanced thresholding techniques for suppressing densely patterned document backgrounds.
AdvancedClarityPerf	Applies only when ColorMode=3 (black/white). Specifies the trade off between execution speed and image quality for the Advanced Clarity algorithm. Range 1-5 1 = fastest execution speed and a good quality image. 5 = slowest execution speed and best image quality.
AutoBrightness	Have VRS automatically assign the optimal value for the brightness of the image. 0=off, 1=on
BarAlg	Applies only when BarEnable=1. Specifies which bar code reader to use. 0=None, 1=Standard, 2=advanced
BarEnable	Enables or disables the bar code reading feature. 0=Disable, 1=Enable
BarHeight	Applies only when BarEnable=1. Specifies the height in hundredths of an inch of the bars in a bar code. Should be set to the physical height of the bar code. Range: 0.15 -1.25.
BarMaxPerLine	Specifies the maximum number of bar codes to search for on a horizontal search path. Range: 1-64.
BarSearchDirection	Specifies the orientations for the bar codes on an image, and controls the search directions to use to read bar codes. Applies only when BarEnable=1. Values: 1=0 degrees, 2=90 degrees, 4=180 degrees, 8=270 degrees
BarType	Applies only when BarEnable=1. Specifies the types of bar codes to search for on an image. You can add values together to specify two or more bar code types. Note Search for the smallest set of bar codes you need. Searching for a large range of bar codes may affect performance. 0=None 1=Code 39 (3 of 9) 2=Interleaved 2 of 5 4=Code 128 8=EAN 16=UPC-A 32=UPC-E 64=Codabar 128=Code 93 256=Postnet 512=Linear 2 of 5 1024=Aztek 2048=PDF417 4096=Data Matrix 8192=MaxiCode 16384=QR Code
BlackBG	The color of the scanner's background. 0=white 1=black
BrightnessAggr	Used in conjunction with AutoBrightness. A higher value of BrightnessAggr increases the brightness of the black and white image output. Range: 0-100
BWBrightness	Specifies the intensity of the output black and white image. Applies only when all of the following conditions exist: VRS is returning a black and white image, the input image is grayscale or color, AutoBrightness=0, and AdvancedClarity=0. The default value of 128 is neutral. Range: 0–255
BWContrast	Applies only when VRS is returning a black and white image and the input image is grayscale or color. The amount of difference between the lightest and darkest areas on an image. Range: 0-255
ColorBrightness	Specifies the intensity of the output color image. Applies only when VRS is returning a color image and the input image is color. Default value 128 is neutral. Range: 0–255
ColorContrast	Applies only when VRS is returning a color image and the input image is color. Similar to BWContrast, but the input image is color. Range: 0-255
ColorDetect	Have VRS evaluate each image to determine whether or not it should be processed as a color or black and white image. 0=off, 1=on
ColorGamma	Applies only when ColorMode=3 or ColorMode=1, and the input image is color. Used in VRS to compensate for scanners whose built-in gamma value leads to lower quality images. Range: 0-255
DropBGColorForBitonalFG	Applies only when ColorDetect=1. Have VRS ignore the color background of a document that is otherwise black and white. 0=off, 1=on
EdgeAggr	Fine-tuning parameter for the edge detection algorithm. Range: 0-255
GrayContrast	Applies only when the input image is grayscale. This setting is Similar to ColorGamma, but for grayscale input images. The default value of 128 is neutral. Range: 0-255
GrayGamma	Applies only when ColorMode=3 and the input image is grayscale. Similar to ColorGamma, but for grayscale input images. Range: 0-255
Performance
CMISDestinationXmlConfig	Identifies the path to CMIS-compliant repository destinations that are located on cloud services, authentication URLs, and ClientIDs and ClientSecrets. You can do the following: Edit the content directly in the value field Download content to edit in another application Upload the edited file or upload a different xml file In a network that has intermittent or low bandwidth issues, you can modify the <RequestTimeoutSeconds> entry to help alleviate the problem.

EmailNotificationThreads	Number of threads for sending email notifications. To apply the number of processors on the server, set the value to 0. If you change the value, it goes into effect the next time the server is started.
FaxThreads	Number of threads for fax processing. To apply the number of processors on the server, set the value to 0. If you change the value, it goes into effect the next time the server is started.
JobProcessingThreads	Number of threads for processing jobs. To apply the number of processors on the server, set the value to 0. If you change the value, it goes into effect the next time the server is started.
KofaxCaptureExportThreads	Number of threads for exporting to Kofax Capture.To apply the number of processors on the server, set the value to 0. If you change the value, it goes into effect the next time the server is started.
KofaxCaptureRestartInterval	Number of hours between each attempt to restart Kofax Capture. To disable, set the value to 0.
KofaxCaptureScriptingThreads	Number of threads for processing Kofax Capture validation scripts. To apply the number of processors on the server, set the value to 0. If you change the value, it goes into effect the next time the server is started.
PdfThreads	Number of threads for PDF processing. To apply the number of processors on the server, set the value to 0. If you change the value, it goes into effect the next time the server is started.
VrsThreads	Number of threads for VRS processing. To apply the number of processors on the server, set the value to 0. If you change the value, it goes into effect the next time the server is started.
Reporting
ReportingWSAUrl	Centrally available URL used for reporting. If you are deploying Local Clients, set the value to the Kofax Reporting WSA Sender URL. The Kofax Front Office Server Local Client uses the URL to locate the database for reporting data.