53
Disaster Recovery
306
Kofax Capture Administrator's Guide
Transferring Custom Module Configuration Data
You can place custom module configuration data in a designated folder at the central site
and the KCN Server automatically sends the configuration data to remote sites when they
synchronize and to alternate central sites when a batch of another central site is uploaded.
This allows administrators to easily send custom module configuration data to the entire
installation. This feature is for large binary data files, such as images.
To obtain the name of the designated folder that is used for this data, invoke the
CustomDataFolder method.
For example, you might want to run a custom module on several remote sites that all require
the same sample image. In this case, an admin plug-in would pass the custom module name
to the CustomDataFolder method and it would return a data storage path. After copying
the sample image to the designated folder on the central site, the next time published batch
class information is transferred to other sites, the sample image and any other data in the
designated custom module folder would also be transferred. Consequently, a custom module
at any remote site can access the image from the corresponding folder location at its remote
site.
The values that each method returns are read-only and determined automatically based on
the batch class name and the custom module’s ID. You can also create subfolders within the
designated folder location and all data included in the subfolders are transferred.
Each object library (Kofax Capture AdminMod and Kofax Capture Document Access)
contains two methods that return a custom module folder name. You can use the methods
during setup and during runtime. One method returns a global custom data folder location
based on the provided module ID. The other method returns a custom data folder name
based on the published batch class and the provided module ID.
The following tables show each method per object library and the folder name string that it
returns.
Table 12-6. Kofax Capture AdminMod (
ACAdMod.dll
)
Method
Returns folder name string
AdminApplication.CustomDataFolder (strModuleID
as string)
"<CaptureSV>\PubTypes\Custom\<strModuleID>"
BatchClass.CustomDataFolder (strModuleID as
String)
"<CaptureSV>\PubTypes\Custom\<Batch Class
Name>\<strModuleID>"
Table 12-7. Kofax Capture Document Access (
DBLite.dll
)
Method
Returns folder name string
RuntimeSession.CustomDataFolder (strModuleID
as String)
"<CaptureSV>\PubTypes\Custom\<strModuleID>"
Batch.CustomPublishedDataFolder (strModuleID
as String)
"<CaptureSV>\PubTypes\Custom\<Batch Class
Name>\<strModuleID>"
39
Disaster Recovery
Kofax Capture Administrator's Guide
307
Note To ensure that your custom module data folder is unique, it is recommended
that the value you pass to strModuleID be the custom module ModuleID
(<company>.<application>.<module>) you use when you register the custom module.
Switching to a New Primary Central Site
The KCN Server Site Switch utility, KcnsSiteSwitch.exe, is a standalone command line utility
that specifies a new primary central site in a Kofax Capture Disaster Recovery configuration.
By specifying a URL, you are broadcasting to any remote site that currently uses that
central site as a primary to no longer use it and use the site from which you are running the
KcnsSiteSwitch utility as its new primary central site.
The central site switch takes place automatically once a remote site synchronizes. If the
remote site’s existing primary central site URL matches a URL in the site switch list, it makes
the switch to the new primary central site.
You can find this utility in the Kofax Capture bin folder.
Command Line Parameters
The utility supports several command line parameters. You can specify the URL of the old
primary central site, and when required, a user name and password. You can also remove a
URL from the site switch list, view all currently specified central site URLs in the site switch
list, and display the correct usage. If you specify an invalid or incomplete parameter, the
utility defaults to the behavior of the View (v) parameter.
You can specify only one command line parameter at a time using a forward slash (/) or a
hyphen (-).
/url [URL]
To specify a primary central site to switch from, you must specify its URL. The URL
parameter is followed by a valid URL, as in the following example:
KcnsSiteSwitch /url http://mywebserver/kcn
Note For WebSphere, the specified URL must be an exact match of the primary central site’s
web server URL because it is case-sensitive. This restriction does not apply to IIS.
/url [URL] [user] [password]
If you run the utility on a central site where User Profiles is selected, an administrator login is
required. The following example specifies a valid user, robert, and his password, MyC8q29x.
KcnsSiteSwitch /url http://mywebserver/kcn
robert MyC8q29x
/v
The View (v) parameter displays all entries in the site switch list, which is a list of URLs
specified at the central site where the utility is run.
/r [URL]
60
Disaster Recovery
308
Kofax Capture Administrator's Guide
The Remove (r) parameter removes a specified URL from the site switch list. Once all affected
remote sites have completed switching primary central sites, you may want to remove
any URL entries that are no longer relevant by removing them from the list. The following
example removes
http://phoenix/kcn
from the site switch list:
KcnsSiteSwitch /r http://phoenix/kcn
/r [URL] [user] [password]
This parameter removes a specified URL from the site switch list when an administrator
login is required. For more information, see the “/r” parameter. The following example
removes
http://phoenix/kcn
from the site switch list using a valid user, john_baker, and his
password, Z73Nt2x:
KcnsSiteSwitch /r http://phoenix/kcn john_baker Z73Nt2x
/?
The “?” parameter displays the correct usage of the KcnsSiteSwitch utility to the console. The
following command displays information about correct usage:
KcnsSiteSwitch /?
Error Codes
The KCN Server Site Switch command utility returns the following codes.
Table 12-8. Error Codes
Value
Name
Description
0
Normal
The utility ran successfully and without exception.
1
BadUsage
Invalid parameters were entered.
2
LoginRequired
User Profiles is enabled, but a login was not
provided.
3
LoginFailed
Credentials were supplied but could not be
validated.
4
SiteNotFound
A site targeted for removal was not on the site list.
5
LicenseError
An enterprise license is required but not found.
6
UnknownError
An unhandled exception was encountered. Check
the error log.
Deleting a Central Site
The KCN Remove Central Site command utility, KcnsRemoveCentralSite.exe, is a standalone
command line utility that deletes a central site (URL) from the KCN Server central site list.
Once deleted, the central site is no longer available to remote sites. The utility duplicates the
functionality of deleting a central site from the KCN Server Central Site Manager in the Kofax
Capture Administration module.
KCN Remove Central Site is controlled completely via command line parameters. You can
specify parameters with a forward slash (/) or a hyphen (-).
48
Disaster Recovery
Kofax Capture Administrator's Guide
309
You can find this utility in the Kofax Capture
bin
folder.
Command Line Parameters
The utility supports several command line parameters. You can specify the URL of the central
site to be deleted, and when required, a user name and password. If you specify any invalid
or incomplete parameters, you are prompted with the correct usage. You can specify only one
command line parameter at a time.
/r [URL]
When you want to delete a central site, you must specify its URL. The “r” parameter is
followed by a valid URL, as in the following example:
KcnsRemoveCentralSite/r http://<mywebserver>/kcns
For WebSphere, the specified URL must be an exact match of the central site’s web server
URL because it is case-sensitive. This restriction does not apply to IIS.
/r [URL] [user] [password]
An administrator login is required if the utility is run on a central site where User Profiles is
active. If the current user is already logged in as an administrator, the credentials are used
automatically. Otherwise, a User Profiles username and password must be supplied. The
following example switches one primary central site to another using a valid user, robert_s,
and his password, MyC8q29x.
KcnsRemoveCentralSite/r http://<mywebserver>/kcns robert_s MyC8q29x
/v
Use the “v” parameter to view the <URL> for each of the central sites that are currently
available. Central sites shown here can be deleted.
/?
Use the “?” parameter to display the correct usage of the KcnsRemoveCentralSite utility to the
console. The following command displays information about correct usage.
KcnsRemoveCentralSite /?
The correct usage also appears when you enter any invalid parameter.
Error Codes
The KCN Remove Central Site command utility returns the following codes.
Table 12-9. Error Codes
Value
Name
Description
0
Normal
The utility ran successfully and without exception.
1
BadUsage
Invalid parameters were entered.
2
LoginRequired
User Profiles is selected, but a login was not
provided.
49
Disaster Recovery
310
Kofax Capture Administrator's Guide
Value
Name
Description
3
LoginFailed
Credentials were supplied but could not be
validated.
4
SiteNotFound
An alternate site targeted for removal was not on
the site list.
5
UnknownError
An unhandled exception was encountered. Check
the error log.
Exporting and Importing Administrative Data
You can export and import administrative data such as batch classes, KCNS profiles, and user
profiles to save periodic snapshots of administrative data. You can use administrative data to
export and import in the following cases:
▪ To duplicate administrative settings when restoring or switching primary sites
▪ To transfer administrative settings from a development site to a production site
Administrative data includes:
▪ Batch classes
▪ KCNS profiles (includes the Central Site List, Central Site Profile, Remote Site List, and
Remote Site Profiles)
▪ User profiles
Batch Classes
Use this feature to export and import batch class assignments and override settings for user
profiles and KCNS profiles (central and remote). When you export a batch class, it also
exports the user profiles and KCNS profiles it is assigned to, as well as the class-specific
overridden batch routing settings for KCNS profiles.
Exported and Imported Data
The following data is exported and imported with batch classes.
Option
Description
Export
All batch class assignments and override settings with the associated
batch class are exported.
Import
Optionally imports all batch class assignments and override settings for
batch classes selected for import. The import process matches batch
class assignments and override settings to profiles by name. If a profile is
not found, the settings for that profile are not imported.
Transfer Mode
Select one of the following options to specify how duplicate batch classes are handled if the
import process encounters a duplicate batch class name.
Documents you may be interested
Documents you may be interested
