XML eGateway Importer System Settings:
eGatewayXMLSettings.xml contains all system settings, which is in subdirectory of program directory called “Settings”.
Also available from "View >> System Settings" menu.
Element Name |
Notes |
GeneralSettings |
|
CompanyOLE |
Exchequer OLE Company code, but can be overridden on each Entity |
XMLFilePath |
Path of files to import. This can be expressed as: D:\IN \\Server1\IN IN (Relative to program directory) |
close_between_hour_start |
Close down at hour (24h) |
close_between_hour_end |
Start up again on hour (24h) |
DeleteImportedFiles |
Delete files after successful import, otherwise move to folder |
NotesUser |
Notes User, this must be a valid Exchequer User name. XML eGateway will post notes from this user account |
DebugMode |
If ON, the system will log each transaction to test.log in log directory, which is usually done only on errors XML eGateway import will bleep on import while on |
entBrowseObject |
If ON, the system will show Exchequer record, using COM Toolkit Object inspector, if fails import for examination. DO NOT LEAVE ON |
send_errors |
email is sent if the Exchequer COM Toolkit rejects the transaction due to wrong coding. Once setup this should never happen. Multiple e-mail addresses can be specified use "," to sperate addresses |
ImportAutomatically |
Automatically import files when hit XML import directory, otherwise wait for user to press [Import] button |
import_from_e-mail |
|
bymail_do_every_x_mins |
Usually set to 1 |
bymail_incoming_server |
Incoming mail box address. e.g "imap.1and1.co.uk" |
bymail_incoming_port |
Post for IMAPI server. Normally 143, but Gmail is 993 |
bymail_folder |
Usually set to "Inbox", but could be set to a different folder within mail box |
bymail_email_address |
E-mail address for this mail box |
bymail_username |
Username for IMAPI mail box |
bymail_password |
Password for IMAPI mail box |
bymail_subject_prefix |
Usually set to " XMLeGateway Import:". Will ignore all other messages in folder |
bymail_delete_message |
0/1 if 1 then everything else IS DELETED |
translate_program | |
file_of_type |
Filter, such as '*.csv' |
execute |
When file of type <file_of_type> is detected then call program 'c:\translator.exe _filename_' where _filename_ is replaced with filename. This allows an external program to transalate a file in a different format into XML for XML eGateway |
AccountSettings |
|
EntityName |
Name of Entity in XML file, default “Account” |
AllowUpdates |
Allow record editing |
MatchOnID |
Identify account record based on acCode or acAltCode If acAltCode then will automatically generate acCode if not specified according to AUTOCreateAccountFormat setting Set to acAltCode if using an external system with long account codes This can be overridden using the acMatchByExternalRef tag in XML data |
AddDiaryEntryOnCreation |
Create Diary entry on creation for Username, otherwise blank=OFF |
AddDiaryEntryOnCreationNote |
Note String |
if match on acAltCode then system needs to create account code automatically. AUTOCreateCustAccountFormat, allows you to set the format for this Exchequer Customer account. Record creation formats can be A00000,AA0000,AAA000,AAAA00, or NUM which is a counter |
|
AUTOCreateSuppAccountFormat |
if match on acAltCode then system needs to create account code automatically. AUTOCreateCustAccountFormat, allows you to set the format for this Exchequer Supplier account. Record creation formats can be A00000,AA0000,AAA000,AAAA00, or NUM which is a counter |
AUTOCreateAccountBasedOn |
Create Account code based on the value in field |
TransactionHeaderSettings |
|
EntityName |
Name of Entity in XML file, default “Header” |
MatchOnID |
Identify customer/supplier based on acCode or acAltCode Set to acAltCode if using an external system with long account codes This can be overridden using the thMatchByExternalRef tag in XML data |
AllImportOnHold |
All transactions import on Hold |
CalculateVATAutomatically |
If Yes, Calculate VAT automatically. Otherwise VAT is calculated by external system and each transaction is imported as Manual VAT on Exchequer Transaction |
AutoSetYearAndPeriod |
If Yes then Auto Set Year And Period based on Transaction Date, otherwise must specify in Transaction |
AddDiaryEntryOnCreation |
Create Diary entry on creation for Username, otherwise blank=OFF |
AddDiaryEntryOnCreationNote |
Note String |
thYourRefMustBeUnique |
If "Yes" then reject, and log error + e-mail |
thLongYourRefMustBeUnique |
If "Yes" then reject, and log error + e-mail |
thTransDateMustBeCurrentMonth |
thTransDate, date must be within -30 days + 90 days |
TransactionLineSettings |
|
EntityName |
Name of Entity in XML file, default “Line” |
StockSettings |
|
EntityName |
Name of Entity in XML file, default “Stock” |
AllowUpdates |
Allow record editing |
AddDiaryEntryOnCreation |
Create Diary entry on creation for Exchequer Username, otherwise blank=OFF |
AddDiaryEntryOnCreationNote |
Note String |
MatchSupplierOnID |
Match supplier ID can be either acCode or acAltCode |
JobSettings |
|
EntityName |
Name of Entity in XML file, default “Job” |
AllowUpdates |
Allow record editing |
MatchCustomerOnID |
Match customer ID can be either acCode or acAltCode This can be overridden using the jrMatchByExternalRef tag in XML data |
AddDiaryEntryOnCreation |
Create Diary entry on creation for Exchequer Username, otherwise blank=OFF |
AddDiaryEntryOnCreationNote |
Note String |
Directories
eGatewayXMLSettings.xml contains all system settings, which is in subdirectory of program directory called “Settings”
The eGatewayXMLSettings.xml file then points to the data directory, which has the following directories created automatically:
|
FailedXML |
for failed XML files |
|
ImportedXML |
archive for imported files if not delete switch is on |
|
Logs |
all errors are logged in this directory Each file imported, or attempted, can be logged in detail with all values read in |
|
Inhibit |
Used to stop program while file exists, see below |
Implications on Backup Systems
To stop XML eGateway processing XML files, while Exchequer Software backup is in progress, simply create a file called “Inhibit.flg” in the “Inhibit” directory, while backup is progress.
Or set the parameters close_between_hour_start and close_between_hour_end to define hours to close down.
How do I know the system is running?
Every Hour the program updates a file called "Running.Log" in program directory. This can be checked for last time updated.
The system can also be set to e-mail a user at 9 am. If the user does not get the e-mail then XML eGateway is not running.
Troubleshooting:
In normal operation XML eGateway should not report any errors, but when developing and testing the following is provided to report and trace errors.
Error Logs
XML eGateway will log all errors to Error.log. A detailed log for each transaction which fails is made in the “Logs” directory, with data and time in filename, which details the transaction and its contents. If <send_errors> tag has a valid e-mail address, or e-mail address separated by “,”, then XML eGateway will e-mail the detailed error log to user/users.
Indeed if the system is setup to accept transactions by e-mail, then a user could then edit the transaction to correct it, and resubmit it by e-mail.
Debug Mode
If <DebugMode> is on then Test.log gives detail of the last file processed which may help with debugging import problems. This file is overwritten on every import when on.