User Exits
Use this tab to configure your user exits. The assemblies and business rules are supported by all installations including multi-tenant and Azure environments. Other user exits that cannot be used by assemblies or business rules are supported by on-premise installations only.
Assemblies
Use these settings to configure the user exit assemblies. You are prompted to save your changes after each entry.
This group has the following settings:
|
Setting |
Description |
|---|---|
|
Extraction Assembly |
When deploying to the GAC, this is the strong name of the assembly that contains the user exit implementations for extraction. A strong name is not just a DLL name and resembles something like UserExitExtraction, Version=1.0.0.0, Culture=neutral, PublicKeyToken=3057196b1314d857, processorArchitecture=MSIL. When deploying the user exit assembly to the transformation project, this is the simple name of the assembly that contains the user exit implementations for extraction. In this case, use the DLL name. |
|
Extraction Class |
This is the fully qualified name of the class that implements the ICustomInitializer interface within the extraction assembly. |
|
Validation Assembly |
This setting is available only when running in an on-premise environment. This is the strong name of the assembly that contains the user exit implementations for validation. A strong name is not just a DLL name and resembles something like UserExitValidation, Version=1.0.0.0, Culture=neutral, PublicKeyToken=3057196b1314d857, processorArchitecture=MSIL. When you store the user exit settings, a plausibility test is done and an error is raised if the passed value does not look like a strong name. |
|
Validation Class |
This setting is available only when running in an on-premise environment. This is the fully qualified name of the class that implements the ICustomInitializer interface within the validation assembly. |
Use the following button to maintain your assemblies:
|
Setting |
Description |
|---|---|
|
Save |
Saves any changes made to the user exit settings and updates the Kofax TotalAgility server variables. |
After you have entered values for all assemblies required, restart the following services:
-
Kofax TotalAgility Core Worker
-
Kofax Transformation Server
-
World Wide Web Publishing Service
Business Rules
Business rules are a way for a multi-tenant environment to make use of a subset of the available user exits.
The business rules table has three columns:
|
Setting |
Description |
|---|---|
|
User Exit |
The name of the user exit You can use the Before Validate, After Validate, and PO Vendor Validate user exits for one business rule only. As a result, once one is added, it cannot be added a second time. |
|
Field Name |
This setting is available only when the User Exit setting is set to Field Validate. Select from the list of active fields in your solution. (Mandatory) |
|
Business Rule |
Enter the name of the Kofax TotalAgility business rule that you have created to validate the selected user exit. (Mandatory) This business rule must exist before you add a use exit business rule. If you enter an incorrect name or the name of a business rule that does not exist, an error message is displayed in the Business Rules table for this user exit. |
Below this table you can add or modify the business rules with the following buttons:
|
Setting |
Description |
|---|---|
|
Add |
Click to add a new user exit business rule. |
|
Edit |
Click to edit the selected business rule. |
|
Delete |
Deletes the selected business rule. |
Related topics: