Customizing DOCUMENTS using the API
DOCUMENTS is designed to be a part of a complex environment, and its open interface makes it easy to integrate with a variety of other systems.
You can customize the program to suit your requirements, using add-ons to modify its functionality and adding more features. You can add dialogs, perform automation calls, ODBC access, file manipulation, and much more.
Two APIs to use
-
The DOCUMENTS API.
-
The Invoice API.
Access points from the Invoice Manager module:Warning The Invoice-internal VBA engine is recommended only for simple debugging or status messages. We strongly advise against using the VBA engine for production customizations. For those, use COM plug-ins.
FYI, this snippet is used in INV API Help, too.
Separate documentation is available for each API. Add-on programming is a complex task that requires knowledge of programming in Visual Basic, C, C++, or C# (Microsoft Visual Studio .NET).
Custom Properties / user-defined variables
The following Custom Properties on document instances are used for communication between the Administration and Production modules and the Invoice modules (where they are called user-defined variables – UDVs). Please refer to Invoice API Help for more information.
-
DOXID
-
BATCHID
-
BUYERID
-
Batch.BatchNumber
-
Batch.BatchDescription
-
Batch.Tag
-
InvoiceXML
-
FUSION-Temporary-filename0
-
FUSION-Temporary-filename1
-
FUSION-Temporary-filename2, etc.
Some of these UDVs are also used when creating an inbox (specifically, for choosing columns to display) and configuring the Scan Information add-on.
| Warning |
|---|
|
Customizations can be quite powerful. They can change values on documents and even cause the program to malfunction. We recommend you proceed with caution when implementing event handlers. |
Applying an event map ( " )