Glossary

ModuleName

Replace " ModuleName" or "e xxxxx" with one of these values that represents a ReadSoft Invoices module:

  • eimngr (Manager)
  • eiscan (Scan)
  • eiitrp (Interpret)
  • eiveri (Verify)
  • eitrans (Transfer)
  • eiopti (Optimize)

Event

An event is a condition or the result of an activity at a specific point in a program.

GUID

GUID (Globally Unique Identifier) is a randomly generated 128-bit number that is almost certain to be unique, used to identify a particular component, application, file, database entry, etc.

Although there is no absolute guarantee that each GUID is unique, the total number of unique keys (3.4028×10 38) is so large that the probability of the same number being generated twice is very small. GUIDs are written using a four-byte word, three two-byte words, and a six-byte word. Example:

{3F2504E0-4F89-11D3-9A0C-0305E82C3301}

.

Definition As Object

Application object

Returns the currently active invoice definition object (Definition), or a NULL object if no invoice definition is active.

Related topics

The Application object

OLE Automation

ReadSoft Invoices acts as an OLE automation server by exposing a set of objects that implement the IDispatch interface. You can access the interface either by looking up functions and methods dynamically in runtime (late binding), or by using the dispatch IDs of the interface at compile time (early binding). The latter requires the type library file, EHICOM10.tlb, which can be found in ReadSoft Invoices's Bin folder.

Early binding has the advantage that you can use tools that wrap the OLE mechanics and provide easy-to-use interfaces (objects) that you use to access ReadSoft Invoices objects and methods. It is also faster compared to late binding. The disadvantage is that you must recompile your code each time a new version of ReadSoft Invoices has interface changes made to its objects.

Late binding has the advantage that changes made in ReadSoft Invoices do not affect the OLE automation client (the DLL) and do not require recompiling (unless the particular function you call has changed). The disadvantage is that it is somewhat slower than early binding and more complicated to use.

CloseApp()

Application object

Shuts down the application.

Note Be careful with this method, since you might end up with timing problems. For example, make sure the job is stopped before the module is closed. This method cannot be used from an external automation server object that has been connected to ReadSoft Invoices in the AppStarted event. Use an internal VBA event to execute CloseApp.

Related topics

The Application object

GetDataSourceConfiguration() As String

Job object

Returns the data source configuration string. The usual way of setting this string is to select Data source extension on the Source settings of the Job description dialog, and then click Configure. A call is made to the data source extension, and the settings can then be retrieved during the interpretation session.

Note For use with data source extensions only. Used by ReadSoft EMAIL and ReadSoft Collector. (ReadSoft EMAIL is not supported with Kofax ReadSoft Invoices 5.6.)

Related topics

SetDataSourceConfiguration

The Job object

SetDataSourceConfiguration() As String

Job object

Sets the data source configuration string on the Job object. The string must be "pure" string data (no new line characters, for example) and is saved as one text line in the job file.

Note For use with data source extensions only. Used by ReadSoft EMAIL and ReadSoft Collector. (ReadSoft EMAIL is not supported with Kofax ReadSoft Invoices 5.6.)

Related topics

GetDataSourceConfiguration

The Job object

Methods