Med MessageLog-endpointet kan du skicka information från händelser i din integration så att den blir synlig i Handyman Office. Det kan vara felmeddelanden från integrationen eller loggning av händelser vid dataöverföring. Detta kommer att vara värdefull information för supportpersonal och kunder att utvärdera flödet av data i en integration.
Introduction
Meddelandeloggen kan bestå av enskilda meddelanden eller flera meddelanden som är kopplade i en "session". Den grundläggande strukturen för en loggningsession är:
- Header record
- This is a record with “sequence” = 0
- The “sessionid” used for this record must also be used in the subsequent messages
- n messages connected to the same session
- “sequence” > 0 (Vanligtvis ökar den med 1 för varje meddelande. Detta används för att sortera meddelandena i gränssnittet)
- If we get an error from HMAPI or CW API we must log them as errors or warnings.
SessionID format
SessionID can be any numeric decimal value, but we are using this format internally to make a unique value:
-<yy><MM><dd>.<HH><mm><ss><fff> (fff is milliseconds)
Example: -221009.122455879
Example code in C#
string sessionId = DateTime.Now.ToString("-yyMMdd.HHmmssfff");
return double.Parse(sessionId, CultureInfo.InvariantCulture)
MessageLog-endpointet tar en array av meddelanden. Om du inte anger en sessionId kommer API:et att skapa en och använda den för alla element i arrayen. Om du vill logga ytterligare felmeddelanden till samma session måste du skapa din egen sessionId enligt beskrivningen ovan och skicka med den för alla meddelanden.
Values in MessageID field
The message id has en enum that will result in different icons connected to the message in the Handyman Office UI.
ProgramError = 1
Warning = 2
OrderEvent = 3
Communication = 4
DebugMessage = 5
SyncOk = 6
Store = 7
Database = 8
ProgramErrorInfo = 9
Customer = 10
SalaryCode = 11
ItemPackage = 12
Wholesaler = 13
PurchaseOrder = 14
Employee = 15
Settings = 16
Groups = 17
Dictionaries = 18
CheckLists = 19
Printouts = 20
ToBackoffice = 21
FromBackoffice = 22
Appointment = 23
ItemNumberType = 24
TimerEvent = 25
Quote = 26
AutomaticCopy = 27
AutomaticEmail = 28
AutomaticPrint = 29
PDFGenerated = 30
The most common for header records is 21 and 22 (Export, Import)