ReadSoft Invoices INI File Help: Overview > Others > ReporterPlugin.ini

ReporterPlugin.ini

The ReporterPlugin.ini file contains settings that apply to the Reporter Plug-in for ReadSoft Invoices, which collects data from ReadSoft Invoices clients and sends it to Reporter's Message Store database.

This file is used in Reporter 5-3 and later. In Reporter 5-2, the settings were found in the [ModuleName::REPORTERDataCollectionPlugin] section of Eilocal.ini, instead. Although that section is still created for later versions of REPORTER, in the newer versions it normally contains only the general settings (those which apply to all plug-ins). Those are described here. However, you can override "central" settings by duplicating them (with different values) in [ModuleName::REPORTERDataCollectionPlugin]. (More information.)

The location of ReporterPlugin.ini is specified by the GlobalPath setting in Eilocal.ini.

Strings used by Reporter are described here.

ReporterPlugin.ini contains only one section, [REPORTERDataCollectionPlugin], which in turn contains these settings:

ActionOnMessageLimitReached  
ActionOnNoConnectionToServer  
CopyImages Specifies whether copies of invoice images and appendices are saved so that Reporter users can view them. (You specify this during the installation procedure.) Such images are commonly produced by the ReadSoft Invoices Scan, Interpret and Transfer modules. 0 (default) = do not copy images. 1 = copy images.
DatabaseName The name of REPORTER's Message Store database.

Default value: RS_RReporter

EncryptedPassword  
ImagePath Used if CopyImages=1. Specifies where images are copied to. Use UNC notation to point to a shared folder that is accessible to the REPORTER server, to this computer with the ReadSoft Invoices module installed, and to the computer of every user who will access Reporter from a web browser. Example:

\\server_name\folder_name

Important Old images must be deleted from the specified location at regular intervals. Otherwise, the computer will eventually run out of disk space. How often does this need to be done? That depends on:
  • The number of invoices processed.
  • The size of the image files.
  • The amount of space that you allocated for this storage.
MessageLimit  
MsgSequenceFilePath  
Password Password for the user ID (UserID). See also: Password encryption in REPORTER
QuietMode  
SequenceNo Temporarily stores sequence numbers from msgsequence.ini while you reinstall or upgrade Reporter. Details.
  1. When you uninstall the Reporter Plug-in for ReadSoft Invoices (Data Collection Plug-in), the uninstall program checks whether any sequence numbers are stored in msgsequence.ini (or other file name, if you changed it using the MsgSequenceFilePath setting). If any non-zero sequence numbers are found, you are prompted to choose whether you want to save these.
  2. If you click Yes in response to that message, the numbers are stored in this SequenceNo setting.
  3. When you reinstall the plug-in, the installation program checks for non-zero values in SequenceNo. If any are found, you are prompted to decide whether or not to reuse them.
  4. If you click Yes in response to that message, the values are copied to msgsequence.ini (in the SequenceNumber parameter), as they were before you uninstalled the plug-in.

The SequenceNo setting is not used again until the next upgrade.

ServerAddress The name of Reporter's database server.
SkipJobStartStop Specifies whether the plug-in collects the pair of JobStarted/JobStopped events when nothing happens between them.

Default value: 1 – highly recommended when modules are run as a service and have automatic jobs scheduled.

TimeOut Specifies how many milliseconds of no response should pass before the plug-in considers its connection to the Message Store database to be lost.

Default value: 30000 (equal to 30 seconds).

UseEncryptedPassword  
UserID Used to connect to the database.
XMLMessagePath Specifies where messages are temporarily saved if the connection to the Message Store database is lost. These are saved in XML format.

By default, this location is the Reporter\ComputerName\TempXMLMessages\ModuleAbbreviation subdirectory of the location specified by GlobalPath. (Example.)

  • GlobalPath is set to C:\Program Files\ReadSoft\INVOICES.
  • The name of the computer is "Test".
  • The Scan module is run on the computer.

Result: The temporary XML messages are located by default in C:\Program Files\ReadSoft\INVOICES\Reporter\Test\TempXMLMessages\eiscan.

In the newer operating systems such as Windows Vista, Windows 7, and Windows Server 2008, the default path would be C:\Users\Public\ReadSoft\INVOICES\Reporter\Test\TempXMLMessages\eiscan.
  

Important Ensure that all users running ReadSoft Invoices modules have "Read" and "Modify" permissions to the specified folder.