Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:ac_insertactionlog_ad

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:ac_insertactionlog_ad [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== ac_InsertActionLog_Ad =====
 +
 +Protokolliert "​Log-Einträge"​ zu einer angegebenen "​Action"​. Die Information (der Eintrag selbst also) wird in der Tabelle "​tempdb.dbo.TextData"​ erwartet.\\ Hintergrund ist die Möglichkeit,​ die Abarbeitung einer "​Action"​ (also letztlich die Ausführung eines Programms) verfolgen bzw. "​debug"​en zu können.\\ ​
 +
 +
 +
 +Hinweise :\\ 
 +
 +1. Im Fall "​ReplaceLastLogPart"​ muß immer der KOMPLETTE "​Log"​-Eintrag"​ übergeben werden, da es in T-SQL keine Möglichkeit gibt, beim Datentyp "​text"​ den "​+"​-Operator (für "​string-Konkatenation"​) anzuwenden (daher auch "​...Replace..."​ im Namen des Parameters) !\\ 
 +
 +2. Es können nicht beliebig viele "​Log-Parts"​ angelegt werden, sondern nur so viele, wie zur "​CommandID"​ der "​ActionID"​ in "​CommandSettings"​ zum Schlüssel "​MaxNumberOfLogPartsPerAction"​ konfiguriert wurden !\\ 
 +
 +3. Intern wird je nach "​ReplaceLastLogPart"​ entweder die Prozedur [[dstoreproc>​fo_InsertPosting_Pu]] oder [[dstoreproc>​fo_ModifyPosting_Pu]] zur Speicherung des "​Log-Eintrags"​ verwendet. Daher sind u.a. Identifizierungsdaten nötig. Diese und evtl. andere Informationen,​ die als Parameter an besagte Prozeduren weitergereicht werden, müssen hier aber nicht übergeben werden, sondern sind via [[dstoreproc>​ac_ModifyCommandSettings_Ad]] zu konfigurieren.\\ Anders ausgedrückt :\\ Die Identifizierungsdaten und sämtliche andere Informationen,​ die benötigt werden, aber hier nicht übergeben werden, ermitteln wir uns aus "​CommandSettings"​ (zur "​CommandID"​ der "​ActionID"​) !\\ 
 +
 +4. Um ein Suchen in den "​Log-Einträgen"​ zu ermöglichen,​ sollte der Parameter "​MaintainSearchPostings"​ auf "​1"​ gesetzt und die Suchwörter (im Regelfall alle Wörter des Eintrags) via "​tempdb.dbo.AnyValues"​ (die Spalte "​ID"​ spielt keine Rolle) übergeben werden.\\ Hintergrund : s. gleichnamiger Parameter von [[dstoreproc>​fo_InsertPosting_Pu]] bzw. [[dstoreproc>​fo_ModifyPosting_Pu]] !\\ 
 +
 +5. Es gibt die Möglichkeit,​ zusätzliche "​Eigenschaften"​ (sprich Informationen) zum "​Log-Eintrag"​ zu speichern. Dazu ist "​SavePostingProperties"​ auf "​1"​ zu setzen, und die Eigenschaften müssen via "​tempdb.dbo.CharacteristicValues"​ übergeben werden :
 +  * "​CharacteristicID"​ enthält die ID eines Merkmals, zu der die Eigenschaft gehört
 +  * "​Value"​ enthält die Eigenschaft selbst
 +s.a. gleichnamiger Parameter von [[dstoreproc>​fo_InsertPosting_Pu]] bzw. [[dstoreproc>​fo_ModifyPosting_Pu]] !\\ 
 +|HTTP-Method|POST |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[ac Insert Action Log Ad]}}|
 +|Engine-Kategorie|actions |
 +|Engine-Typ|Daten-Änderung |
 +|Letzte Aktualisierung|7.0.7 (2015-01-29)|
 +
 +==== Parameter ====
 +
 +|__ActionID__| |ID einer "​Action",​ zu der ein "​Log-Eintrag"​ erzeugt werden soll\\ |integer|5.5.0|
 +|ReplaceLastLogPart|1 |Steuert, ob ein NEUER "​Log"​-Eintrag erzeugt ("​0"​) oder der LETZTE "​Log"​-Eintrag ersetzt wird ("​1"​). Unbedingt Hinweis in der Beschreibung beachten !\\ |bit|5.5.0|
 +|MaintainSearchPostings|1 |Sollen zum Log-Eintrag Suchwörter hinterlegt werden (um den Eintrag über [[dstoreproc>​fo_SearchPostings_Pu]] wiederfinden zu können), übergibt man hier den Wert "​1"​ und fügt die Wörter vor dem Aufruf in "​tempdb.dbo.AnyValues"​ ein\\ |bit|5.5.0|
 +|SavePostingProperties|0 |Angeben, um Eigenschaften zum Log-Eintrag zu speichern (s. Beschreibung):​\\ "​1"​ : Fehlerhafte Eigenschaften führen zum Abbruch\\ "​2"​ : Fehlerhafte Eigenschaften ignorieren\\ "​3"​ : Wie "​1"​ + Ergebnismenge der Fehler\\ "​4"​ : Wie "​2"​ + Ergebnismenge der Fehler\\ |tinyint|5.5.0|
 +|Country|'​german'​ |Wird nur beachtet, wenn "​SavePostingProperties > 0" ist. Gibt an, in welchem Format Datums-Eigenschaften angegeben sind (Groß-/​Kleinschreibung wird nicht beachtet) :\\ '​german',​ '​germany'​ : Tag-Monat-Jahr\\ '​english',​ '​england'​ : Monat-Tag-Jahr\\ |varchar(10)|5.5.0|
 +==== Rückgabe ====
 +
 +=== wenn Result (Pseudo-Parameter) IN (0, -874) und SavePostingProperties IN (3, 4) ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|PostingCharacteristicID|ID eines Posting-Merkmals,​ auf das sich die fehlerhafte Eigenschaft "​Value"​ bezieht\\ |smallint|5.5.0 |
 +|Value|Fehlerhafte Eigenschaft zum Merkmal "​PostingCharacteristicID"​\\ |varchar(250)|5.5.0 |
 +|ErrorCode|Gibt die Ursache des Fehlers an, also warum die Eigenschaft nicht übernommen werden konnte. Mögliche Werte : s. Beschreibung von [[dstoreproc>​fo_InsertPosting_Pu]] bzw. [[dstoreproc>​fo_ModifyPosting_Pu]] (Bereich ' Anmerkung zur Rückgabespalte "​ErrorCode"​ ').\\ |tinyint|5.5.0 |
 +==== Output-Parameter ====
 +
 +|PostingID|Wurde der "​Log-Eintrag"​ erfolgreich eingefügt bzw. geändert, so wird hier die ID des erzeugten bzw. geänderten Beitrags zurückgegeben|
 +==== Mögliche Return-Codes ====
 +
 +^Code ^Beschreibung ^Quelle ((direkt meint "von der Prozedur selber"​ und indirekt meint "von intern aufgerufenen Unterprozeduren"​)) ^
 +|-874|Die Posting-Eigenschaften können nicht gesetzt/​geändert/​gelöscht werden, da Fehler auftraten|nur indirekt|
 +|-856|Fehlerhafte Daten in "​MainPostingSorting"​|nur indirekt|
 +|-855|Fehlerhafte Konfiguration des Sortier-Kriteriums|nur indirekt|
 +|-850|Sortier-Kriterium nicht definiert oder inaktiv oder nicht verwendbar|nur indirekt|
 +|-840|Posting kann nicht bearbeitet werden, weil es bereits von einem anderen Prozess bearbeitet wird|nur indirekt|
 +|-830|Spam-Schutz:​ Posting konnte nicht angelegt werden|nur indirekt|
 +|-814|Auf abgeschlossene oder gelöschte Postings kann nicht geantwortet werden|nur indirekt|
 +|-813|Keine Berechtigung zum Antworten auf ein bestehendes Posting|nur indirekt|
 +|-812|Keine Berechtigung zur Eröffnung eines neuen Threads|nur indirekt|
 +|-804|Keine Berechtigung zum Bearbeiten des Postings|nur indirekt|
 +|-803|Das Posting ist gelöscht|nur indirekt|
 +|-660|Identifikation fehlgeschlagen|nur indirekt|
 +|-621|Fehlender oder falscher Eintrag in PersonTypeSettings|nur indirekt|
 +|-602|Zur defaultUniqueID ("​VisitorID = -2") können keinerlei Daten gespeichert oder verändert werden|nur indirekt|
 +|-599|Lizenz ist ungültig oder abgelaufen|nur indirekt|
 +|-572|Die Prozedur darf nur innerhalb einer Transaktion ausgeführt werden|nur indirekt|
 +|-569|Der Benutzer hat kein Ausführungsrecht für die Prozedur|nur indirekt|
 +|-567|Die Prozedur darf z. Zt. nicht ausgeführt werden|nur indirekt|
 +|-566|Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werden|nur indirekt|
 +|-557|Maximale Anzahl Log-Parts erreicht|nur direkt|
 +|-556|Fehlender oder falscher Eintrag in CommandSettings|nur indirekt|
 +|-550|Fehlender oder falscher Eintrag in Settings|nur indirekt|
 +|-540|Falsches Format|nur indirekt|
 +|-535|Das Datum liegt nicht in der Vergangenheit|nur indirekt|
 +|-530|Der Wert ist nicht konvertierbar|nur indirekt|
 +|-510|Der Benutzer ist nicht registriert|nur indirekt|
 +|-504|Es ist ein Problem aufgetreten,​ das nicht gelöst werden kann, Prozedur wird daher abgebrochen|nur indirekt|
 +|-502|Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)|nur indirekt|
 +|-500|Falsche Parameter|direkt und indirekt|
 +==== XML-Schema ====
 +
 +Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema [[http://​resources.dstore.de/​xsd/​webservice_SmartGate/​Response/​EngineProcedure_v1_0.xsd|Response/​EngineProcedure_v1_0.xsd]] validiert.
 +==== Historie ====
 +
 +|7.0.7 |2015-01-29|Interne Änderung : Datentyp-Erweiterung des "​ReferenceKey"​ [für "​_mi_StartProcedure"​-Aufruf]\\ ​ |
 +|7.0.5 |2014-05-26|Aufruf von [[dstoreproc>​mi_InsertTempdb_CharacValues]] bzgl. neuer Parameter angepasst\\ ​ |
 +|6.5.3 |2013-03-18|1. Quellcode-Anpassungen\\ 2. Zwei Fehler beim internen Aufruf von "​_mi_StartProcedure"​ behoben [Tabellen mit Daten wurden zwecks logging nicht übergeben und "​UserID"​ wurde nicht als "​out"​ übergeben obwohl benötigt]\\ ​ |
 +|5.5.0 |2008-01-07|Erstmalig in dieser Version erstellt\\ ​ |
 +
 +==== Code-Snippets ====
 +
 +== Engine Playground ==
 +Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
 +  * [[http://​playground.dstore.de/​index.php?​proc=ac_InsertActionLog_Ad|ac_InsertActionLog_Ad im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X POST  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​ac_InsertActionLog_Ad?​ActionID=<​value>'</​code>​Mit xmllint ((I.d.R. auf Unix-artigen Systemen bereits installiert,​ Bestandteil der libxml2, siehe http://​www.xmlsoft.org)) formatierte Ausgabe:
 +<code bash>
 +curl -X POST  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​ac_InsertActionLog_Ad?​ActionID=<​value>'​ | xmllint --format -</​code>​== dStore_php ==
 +<code php>
 +use dStore_php\WebService;​
 +
 +$service = new WebService\Service( WebService\Scheme::​HTTP,'<​partner>​-<​project>​.dstore.de',​ 80);
 +
 +$request = new WebService\Requests\Engine\Procedure\Request(
 + new WebService\Requests\AccessData('​default'​),​
 + '​ac_InsertActionLog_Ad',​
 + array(
 + '​ActionID'​ => <​value>,​
 + // '​ReplaceLastLogPart'​ => 1,
 + // '​MaintainSearchPostings'​ => 1,
 + // '​SavePostingProperties'​ => 0,
 + // '​Country'​ => '​german'​
 + )
 +);
 +
 +$service->​execute($request);​
 +
 + $xml_result = $request->​getResponse()->​getBody()->​toSimpleXmlDocument();​
 + $ResultSet = $xml_result->​getRowsAsArray();​
 +
 +$OutputParams = $xml_result->​getOutputParametersAsArray();</​code>​
 +== engine/​execute ==
 +XML zur Ausführung mit der Methode [[:​webservice:​engine:​execute|engine/​execute]],​ z.B. per
 +  curl --header '​Content-Type:​ application/​xml'​ -X POST '​http://<​partner>​-<​kunde>​.dstore.de/​default/​engine/​execute'​ -d '<​xml-daten>'​
 +
 +<code xml>
 +<?xml version="​1.0"​ encoding="​UTF-8"?>​
 +<​ListOfBatches>​
 + <Batch No="​0">​
 + <​Procedure Name="​ac_InsertActionLog_Ad">​
 + <​Parameters>​
 + <​Parameter Name="​ActionID"><​!-- integer value --></​Parameter>​
 + <!-- <​Parameter Name="​ReplaceLastLogPart">​1</​Parameter>​ -->
 + <!-- <​Parameter Name="​MaintainSearchPostings">​1</​Parameter>​ -->
 + <!-- <​Parameter Name="​SavePostingProperties">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​Country">'​german'</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/ac_insertactionlog_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)