kfs.properties

datetimemacro.timezone

Gets the current date depending on TimeZone setting:

• If the TimeZone is set to 0, use UTC.

• If the TimeZone is set to 1, use the local time on the server.

enable.scan.activity.shortcuts

Select whether or not shortcuts for existing cases appear after logging onto the device.

• false (default): Do not display the shortcut.

• true: Display the shortcut.

This feature applies to certain devices. See the MFP Administrator's Guide for information.

job.entry.confirmation

Display a confirmation message when the user sends a job with no pages.

• false (default): Do not display a confirmation.

• true: Display the confirmation message.

This feature applies to certain devices. See the MFP Administrator's Guide for information.

ProxyServer

How Kofax TotalAgility 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.

ProxyServerPath

If Kofax TotalAgility uses a virtual directory, enter the name of the directory.

ProxyServerPort

Default http port for communicating with the Kofax TotalAgility. The default is 80.

ProxyServerProtocol

Specifies the protocol for communication with Kofax TotalAgility when UseProxyServerProtocol is set to true. The value is either:

• https

• http

If UseProxyServerProtocol is set to false, this setting is ignored.

ProxyServerSecurePort

Default https port for communicating with the Kofax TotalAgility. The default is 443.

scan.activity.shortcuts.todisplay

Enter the number of shortcuts for existing cases to display if enable.scan.activity.shortcuts is enabled. If you enter 0 or a negative number, no shortcuts are displayed. The default is 100.

UseProxyServerProtocol

Select whether the proxy server protocol is determined automatically or set manually.

• false (default): Have the proxy server protocol determined automatically.

• true: The proxy server protocol is set manually with the ProxyServerProtocol value. Use this setting if communications between the MFP and proxy server require a different protocol.

mfp.properties

failed.job.transmission.process.name

Enter the name of the process used when a scan job fails to be submitted to the server. A new job is created when the scan job fails.

mfp.retry.count

Number of attempts to send images to the server before failing. To have the request fail without retries, enter 0. To disable this feature and keep retrying without failing, enter -1 or any negative number. If you switch between a negative number and 0 or higher, restart the client application or MFP to apply the change for how retries are handled. (Default is 5.)

This setting and mfp.retry.interval apply to Canon, Lexmark, Fujitsu, and the MFP Emulator. These settings also apply to Ricoh if the mfp.retry.count setting in the mfp.ricoh.properties namespace is disabled.

mfp.retry.interval

Seconds between retries. To retry without delays, enter 0.

mfp.canon.properties

mfp.scan.preview

Enables scan preview mode.

• true: Turn on scan preview.

• false (default): Turn off scan preview.

server.max.job.age.mins

Number of minutes before submitting an incomplete job on ScanFront devices (default = 60).

timeout.scancomplete.mins

Number of minutes the Scan Complete screen remains on screen before sending and exiting automatically (default = 5).

sso.mapped.activedirectory.attributes

Comma-delimited list of Active Directory attributes and values used for Equitrac authentication.

Each item is listed as a key/value pair:

• The key is an attribute in the Activate Directory schema.

• The value is a single sign-on parameter, either singleSignOnCanonCN can be used for the full name field in Equitrac or singleSignOnCanonMail for the email address field.

Multiple key/value pairs are separated by commas.

Example: mail=singleSignOnCanonMail,displayName=singleSignOnCanonMail first searches for an Active Directory user with a matching "mail" attribute. If no match is found, a search is done searches for an Active Directory user with a matching "displayName" attribute.

mfp.hp.properties

activedirectory.domains

Active Directory domain to search for user accounts. To enter more than one domain, separate each one with a semicolon (;).The authentication process appends a backslash (\) between the domain name and user ID.

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.image.preview

Enables image preview mode.

• true: Turn on image preview.

• false (default): Turn off image preview.

mfp.password

Password for the MFP user.

mfp.protocol

Protocol used for communication to the MFP from Kofax TotalAgility server:

• https

• http (default)

If UseProxyServerProtocol is set to false, this setting is ignored.

mfp.retry.count

Number of attempts to send images to the server before failing. The default is 5.

mfp.retry.interval

Minutes between retries (must be a positive value). The default is 5.

mfp.scan.color.mode

The color mode:

• Color

• Grayscale (default)

mfp.scan.crop.setting

Display auto crop options on the MFP front panel:

• True: Display auto crop options.

• False: Do not display auto crop options (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.

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 TotalAgility features (single sign on). Kofax TotalAgility 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 TotalAgility 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 TotalAgility.

  • 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 TotalAgility server. This is used to generate the server URL when registering the client. The value is either:

• https

• http

If UseProxyServerProtocol is set to false, this setting is ignored.

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

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

sso.activedirectory.domain

Domain name associated with authenticated MFP users. Single-sign-on will append a backslash and the user name when authenticating users. If you enter companydomain1 for the sso.activedirectory.domain setting, the complete user name will be companydomain1\username.

webdav.domain

Domain of the WebDAV user.

webdav.server

WebDAV server address.

webdav.path

WebDAV upload location. Leave empty to use the WebDAV root folder.

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).

webdav.trust.all.certificates

Specify whether or not all WebDAV SSL certificates are trusted.

• true: Trust all certificates.

• false (default): Only certificates that have been successfully validated are trusted.

imagetransfer.method

Select the transfer method for images, either ftp or webdav (default = webdav).

mfp.lexmark.properties

lexmark.csf.application.cert

Server certificate public key for cSF app. Click Upload to upload the file with the certificate. Click the field to expand field to display the certificate.

lexmark.csf.application.additionalcerts

Additional certificates for use by the cSF app. Click Upload to upload the file with the certificate. Click the field to expand field to display the certificate.

lexmark.csf.application.icon

Application icon for the cSF app. Click Upload to upload the file. When the icon has been selected, select Click to see preview to view the image. If this field is left blank, the default icon provided with the app is used.

lexmark.csf.application.name

Name to display for the cSF app. If left blank, the default name provided with the app is used.

lexmark.csf.application.url

URL of the app on the server.

sso.activedirectory.domain

Domain name to be added with a backslash (\) in front of the user name for Single Sign On. (Example: company\username)

mfp.ricoh.properties

job.empty.submit.enabled

Whether or not to allow jobs with no pages to be submitted to the server.

• true: Allow jobs with no pages to be submitted.

• false: Do not allow jobs with no pages to be submitted. An error message is displayed to the user (default).

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.scan.preview

Enables scan preview mode.

• true: Turn on scan preview.

• false (default): Turn off scan preview.

mfp.hide.new.scanned.pages.on.first.scan

Hide or show New Pages Scanned information until the user clicks Add New Pages. Set to true to hide the information or false (default) for it to remain visible.

mfp.root.category

Define the categories to appear at the top level of the device screen. Separate top-level categories with a comma (,). Indicate sublevel categories by including the levels above them separated with a slash (/). (Example: "A,B/C" displays forms and categories of A and C, which is a sublevel of B, at the top level.)

mfp.retry.count

Number of attempts to send images to the server before failing. To have the request fail without retries, enter 0. To disable this feature and keep retrying without failing, enter -1 or any negative number. If this feature is disabled, the setting for mfp.retry.count in the mfp.properties namespace is used instead. (Default is -1.)

mfp.retry.interval

Seconds between retries. To retry without delays, enter 0. If mfp.retry.count for Ricoh is disabled, the setting for mfp.retry.interval in the mfp.properties namespace is used instead.

mfp.xerox.properties

failed.job.threshold.min

Amount of time to determine a job is failed for Xerox MFPs, expressed in minutes.

http.scan.enabled

Enable Xerox HTTP(s) Scanning.

• true: Use Xerox HTTP(s) Scanning

• false: Use Xerox FTP Scanning

failed.jobs.polling.interval.ms

Failed jobs polling interval for Xerox MFPs, expressed in milliseconds.

ftp.server.host

FTP server host used by Xerox device to send scanned image files. Note: a blank value will stop polling if no Xerox devices are used.

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 before moving it to the failed jobs folder, default=5.

Note: in a Kofax TotalAgility cluster configuration this would be per node so total attempts could be higher.

ftp.server.password

FTP user password.

ftp.server.path

Path on FTP server host where Kofax TotalAgility files are stored, must start with /.

ftp.server.polling.initial.delay.ms

FTP polling timer initial delay in milliseconds, default = 10000

ftp.server.polling.interval.ms

FTP polling timer interval in milliseconds, default = 120000

ftp.server.username

FTP user name

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.preview

Enables scan preview mode.

• true: Turn on scan preview.

• false (default): Turn off scan preview.

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.

server.max.job.age.mins

Number of minutes before an incomplete job is flagged as failed (default = 60).