A user exit is a dedicated public subroutine or function on the UserExits class script level where you can enter custom code.
Each user exit is called from a relevant point in the application layer baseline code and provides the you with a window to perform a custom activity as is appropriate for your implementation.
You should implement customizations in a modular fashion within the existing user exits. If any ancillary functions are required to support these modules, create them as public functions. You can place these ancillary functions on the UserExits script class if they are only used locally, but if they need to be accessed by custom script on other classes, you can place them at the end of the existing script on the GlobalVariables class in the marked area.
Periodically, Hyland Software reviews all submitted modules to ascertain which would be of value to be incorporated in the application layer baseline script.
The user exits that are available, along with their calling points and suggested uses, can be found in the following table.
| User Exit | Calling routine | Description and possible uses |
|---|---|---|
| UserExitCustomExport | ScriptModule_ ExportDocument | This is the user exit for custom export modules, such
as for custom flat files or custom database updates. This is the only user exit that has a corresponding activation parameter within the Export Settings. The interface is pWorkdoc, ExportPath, strDocLink, The strExportError global variable is populated with an appropriate error message in the event the export fails. This has the effect of setting the batch to a status of 750, with the error message set against the institution ID. This exit only calls for documents that have not been voided. Special handling for voided documents is inserted in the UserExitVoidDocumentExport user exit. |
| UserExitPostExtract | Document_ PostEvaluate on the Transcripts class | This is the user exit used to set any custom field defaults, or
to reevaluate any extracted fields. The interface is pWorkdoc. |
| UserExitRouteDocument | ScriptModule_ RouteDocument | This is the user exit for performing any custom activity
connected to the Brainware for Transcripts workflow state of each document,
such as changing the state based on a property of the workdoc or
document filename so that they can be filtered on a user-by-user basis. The interface is pWorkdoc, State. |
| UserExitVoidDocument Export | ScriptModule_ ExportDocument | This is the user exit provided for the custom export of
documents belonging to the void class. The interface is pWorkdoc, ExportPath, strDocLink. Populate the strExportError global variable with an appropriate error message for when the export fails. This has the effect of setting the batch to a status of 750, with the error message set against the institution ID. |
| UserExitTerminate | ScriptModule_ Terminate | This user exit is called from the beginning of ScriptModule_Terminate.
It can be used to unload any global script objects employed in custom
script. The interface is ModuleName. |
| UserExitPreImport | ScriptModule_ PreImport | This user exit is called from the beginning of ScriptModule_PreImport. The interface is pWorkdoc, FilePath, FileType, pCancel. |
| UserExitPostClassify | ScriptModule_ PostClassify | This user exit is called from the beginning of ScriptModule_PostClassify. The interface is pWorkdoc. |
| UserExitDocument OnAction | Document_OnAction on the Transcripts class | This user exit provides an opportunity for a developer to
add script that relates to custom buttons that they may elect to
add to the Verifier form. The ActionName parameter, which is passed into the function, is populated with the technical name of the action associated with a user pressing the button as designated in Verifier Design Mode in the Designer Module. The interface is pWorkdoc, ActionName. |
| UserExitXMLOutput | Internal application | This user exit is available for a developer to add any custom
fields into the XML output file. Custom fields can be entered into any of these four sections by use of the public fnWriteXMLField and fnWriteXMLDateField functions. The interface is pWorkdoc, pTable, lngLine, strSection The function is deprecated. It is replaced by UserExitXMLDoc. |
| UserExitExportSuccess | ScriptModule_ ExportDocument | This user exit is called at the point where it is known
that all selected exports have been successful for the document
being processed. It can be used to update additional reporting data
if required. The interface is pWorkdoc. |
| UserExitExportFailure | ScriptModule_ ExportDocument | This user exit is called at the point where it is known
that export has failed for the document being processed. It can
be used to update additional reporting data if required. The reason for the export failure can be found in the strExportError global parameter. The interface is pWorkdoc. |
| UserExitVerifierException | ScriptModule_Verifier Exception | This user exit is triggered when a user send a document
to an exception state in Verifier. The interface is pWorkdoc, Reason, CreateNewBatch, BatchName, BatchDocumentState, BatchPriority, BatchFolderName, ApplyExceptionHandling. |
| UserExitSetReporting LoginName | Internal application | This user exit allows a developer to change the name of
the user as reported in the Visibility reporting database. This is used in Intelligent Capture 5.2 and higher where the Web Verifier is being used. Otherwise, the system always populates the Verifier user column in the reporting database with the Intelligent Capture service user. The strUserName input parameter contains the user name that the system is currently using. The interface is pWorkdoc, strUserName. Note: It is no longer necessary
to insert code into this user exit for web verifier implementations.
The system always uses the Verifier logon ID as the user name.
|
| UserExitApplicantAddressArray | Internal application | This user exit is called each time the details for an applicant
are read from the applicant pool. You can amend or add new parameters
to the ApplicantAddress array. The user exit is not called if the applicant details have already been read and loaded into the local cache. The interface is oASSA, strID, ApplicantAddress |
| UserExitInstitutionAddressArray | Internal application | This user exit is called each time the details for an institution
are read from the institution pool. You can amend or add new parameters
to the InstitutionAddress array. The user exit is not called if the institution details have already been read and loaded into the local cache. The interface is oASSA, strID, InstitutionAddress |
| UserExitDocument Validate | Document_Validate on the Transcripts class script level | This user exit is called from Document_Validate on the Transcripts
class script level. It can be used to code in additional document
level validations and activities. The interface is pWorkdoc, pValid. |
| UserExitEditDocument Weblink | Internal application | This user exit permits a developer to manipulate the document
web link, as stored in the Visibility reporting database and exported
downstream. The current web link is passed into the user exit using the strWebLink interface parameter, and this may be changed to meet your business needs. The current unique document ID is passed in the strDocID interface parameter, and this cannot be changed. The interface is strWebLink, strDocID. |
| UserExitVerifierFormLoad | ScriptModule_Verifier FormLoad | This user exit is called at the end of ScriptModule_VerifierFormLoad. The interface is pWorkdoc, FormClassName, FormName |
| UserExitScriptModule Initialize | ScriptModule_ Initialize | This user exit is called at the end of ScriptModule_Initialize. The interface is pWorkdoc. |
| UserExitPostImport | ScriptModule_ PostImport | This user exit is called from the beginning of ScriptModule_PostImport. The interface is pWorkdoc. |
| UserExitPostImportBatch | ScriptModule_Post ImportBatch | This user exit is called at the beginning of ScriptModule_PostImportBatch. The interface is pWorkdoc. |
| UserExitPreClassify | ScriptModule_Pre Classify | This user exit is called from the beginning of ScriptModule_PreClassify. Interface is pWorkdoc |
| UserExitXMLDoc | Internal application | This user exit is available for a developer to add any custom
fields into the XML output file. Custom fields can be entered into the XML document by use of fnInsertXMLNode. The interface is pWorkdoc, xmlDoc. |
| UserExitUpdateSystemSecurity | ScriptModule_Update SystemSecurity | This is the user exit that is called during the system security
update event that is set to run as a periodic background job on
the runtime server. In Brainware for Transcripts, the system security
event is used to load users created in the SCM User Management settings
into the main system user table. This user exit is triggered subsequent to
that process. The interface is InstanceName. |
| UserExitMoveDocument | ScriptModule_Move Document | This is the user exit that is called when a document is sent to an exception batch in Thick Verifier. The internal application uses this event to apprise the Visibility reporting tables of any change in the document batch ID. The interface is pWorkdoc, OldBatchID, NewBatchID, Reason. |
| UserExitBatchOpen | ScriptModule_Batch Open | This is the user exit that is called upon the opening
of a batch in Thick Verifier. The interface is UserName, BatchDatabaseID, ExternalGroupID, ExternalBatchID, TransactionID, WorkflowType, BatchState. |
| UserExitProcessBatch | ScriptModule_ ProcessBatch | This is the user exit that is called during the Custom Processing
workflow step. The interface is pBatch, InputState, DesiredOutputStateSucceeded, DesiredOutputStateFailed. |
| UserExitBatchClose | ScriptModule_Batch Close | This is the user exit that is called when a batch is exited in
Thick Verifier. The interface is Username, BatchDatabaseID, ExternalGroupID, ExternalBatchID, TransactionID, WorkflowType, BatchState, BatchReleaseAction. |
| UserExitAppendWorkdoc | ScriptModule_Append Workdoc | This is the user exit that is called when a user merges documents
together in Thick Verifier. The interface is pLastWorkdoc, pCurrentWorkdoc, pAppendType. |
| UserExitPreOCR | ScriptModule_PreOCR | This user exit is called from the beginning of ScriptModule_PreOCR. This
call routine is triggered just before a document is OCR'ed. The interface is pWorkdoc and pCancel. |
| UserExitPostOCR | ScriptModule_PostOCR | This user exit is called at the beginning of ScriptModule_PostOCR. This call routine is triggered just after the document is OCR'ed. The interface is pWorkdoc. |
| UserExitVerifierClassify | ScriptModule_VerifierClassify | This user exit is called before and after the manual reclassification
from Verifier. The interface is pWorkdoc, Reason, and ClassName. |