[PYTHON] Zeichnen Sie benutzerdefinierte Ereignisse mit der Shotgun-API auf

Was ist das?

Informationen zum Aufzeichnen von Protokollen in Shotgun über die Shotgun-API Ich werde über den Fall schreiben, dass absichtlich ein beliebiges Protokoll anstelle des automatisch hinterlassenen Protokolls hinterlassen wird.

EventLogEntry-Entität

Bei Shotgun lautet die Datentabelle für die Protokollierung ** "EventLogEntry Entity" **. Wenn jemand etwas im Shotgun Web tut (öffnet eine Seite, ändert den Status, durchsucht eine Version usw.), wird es protokolliert.

Charakteristisch

• Kann nicht gelöscht werden
• Nicht bearbeitbar
• Wird sowohl vom Browser als auch über die API aufgezeichnet

… Weil es natürlich ein Protokoll ist

Zeichnen Sie das Protokoll [willkürlich] auf

Annahme

Das Protokoll wird aufgezeichnet, ohne etwas zu tun. Darüber hinaus gibt es Zeiten, in denen Sie Ihre eigenen Ereignisse als Orientierungspunkt protokollieren möchten.

Es ist ein sogenanntes "benutzerdefiniertes Ereignis".

Verwendete Methode = erstellen

Es gibt keine Methode zum Aufzeichnen von Ereignissen. Normalerweise ** erstellen ** für die EventLogEntry-Entität

Feld

• event_type
• Darf nicht leer gelassen werden. Wird später beschrieben
• description
• Wenn Sie dieses Feld leer lassen, wird "Neues Ereignis" automatisch geschrieben.
• user
• entity ――Sie können diese beiden leer lassen, aber wenn Sie sie nicht schreiben, werden Sie in Schwierigkeiten geraten.

• Ein Beispiel für das versehentliche Erstellen nur mit project und event_type. * *

Apropos "RTS" in der Projektspalte, Es ist hier serialisiert> http://area.autodesk.jp/column/tutorial/road_to_stingray/ Ich habe neulich auch einen Vortrag gehalten> http://www.guncys.com/?p=378 Ich freue mich auf die Fertigstellung!

Wie schreibe ich event_type

Da event_type selbst nur ein Textfeld ist, können Sie es frei schreiben. Grundsätzlich ist es besser, das folgende Format anzupassen

{Was ist das Protokoll}_{Bei welcher Entität soll angemeldet werden?}_{Welche Art von Operation haben Sie durchgeführt?}

"Wer", "Wo" und "Was ist passiert" sind durch einen Unterstrich verbunden. Aus dem standardmäßig geschriebenen Protokoll geht hervor, dass das obere Kamelgehäuse mit einem Unterstrich für 3 Elemente verbunden ist.

Wer

• "Who" * wird im offiziellen Wiki als ** "application" ** geschrieben. Die meisten Protokolle werden durch Vorgänge über den Browser geschlossen, sodass "Schrotflinte" eingegeben wird. Ich denke, es wäre schön, wenn ich die extreme Geschichte "Shotgun'not '" zeigen könnte, ohne sie zu detailliert zu machen. Sie können daraus ein Skript machen, das den Namen ScriptUser enthält.

wo

• Geben Sie den ** Entitätsnamen ** selbst in "where" * ein.

Was ist passiert

• Geben Sie ** "Aktion" ** in "Was ist los" * ein. Wenn Sie das von Shotgun hinterlassene Protokoll beachten, wird "Neu" bei der Neuerstellung und "Änderung" bei der Aktualisierung berücksichtigt. Es geht um ein Wort, ohne es zu lang zu machen. (Methode "Löschen" = Ruhestand. Es ist ein Rätsel, warum die Methoden "Erstellen" und "Aktualisieren" nicht unterstützt werden. Handelt es sich um einen Datenbankbegriff?) Da wir uns die Mühe machen, hier ein Skript zu schreiben und ein Protokoll zu hinterlassen, werden hier meiner Meinung nach Aktionen zugewiesen, die sich von diesen Standardaktionen unterscheiden.

Beispielsatz

Schreiben

Basierend auf dem bisherigen Inhalt lautet das Skript, das ein beliebiges Protokoll hinterlässt, beispielsweise wie folgt.

python

data = {}
data['project'] = PROJ
data['event_type'] = 'MyApp_Entity_SomeAction'
data['description'] = 'some action'
data['user'] = SCRIPT_USER
data['entity'] = SOME_TARGET
    
sg.create('EventLogEntry',data)

Erhalten

Der Beispielsatz zum Abrufen des geschriebenen Protokolls sieht wie folgt aus

python

eventType = 'MyApp_Entity_SomeAction'

log = sg.find_one(
                  'EventLogEntry',
                  [['event_type','is',eventType ],['project','is',PROJ]],
                  ['created_at','entity'],
                  order=[{'field_name':'id','direction':'desc'}]
                  )

Verwenden Sie die Methode "find_one" und geben Sie an, dass die Artikel in der neuesten Reihenfolge mit "order" (where'desc "zurückgegeben werden.) Ich habe eine "neueste" MyScript_Shot_SomeAction ". Geben Sie außerdem "created_at" in das zurückgegebene Feld ein, um den Zeitstempel zu erhalten.

Wenn Sie den Ereignistyp eingeben, wäre es schön, ihn zu einer Funktion zu machen, als ob er zurückgegeben würde.

Zusammenfassung

--Verwenden Sie erstellen.

• ** Vorsicht, es kann nicht gelöscht werden **!

Bemerkungen

Ereignisbeispiel

Hier sind einige Beispiele für Ereignistypen, die fließen, wenn Sie sie normal verwenden (= ohne etwas wie das oben Genannte zu tun).

• Shotgun_Task_Retirement
• Shotgun_User_Logout
• Shotgun_User_FailedLogin
• Shotgun_ProjectUserConnection_New
• Der Ereignistyp, der aufgezeichnet wird, wenn Sie einem Projekt Mitarbeiter zuweisen.
• Shotgun_AppWelcomeUserConnection_New ――Es wird aufgezeichnet, wenn Sie einen neuen Benutzer einladen. Vielleicht.
• Shotgun_PageSetting_Change
• Toolkit_Desktop_ProjectLaunch
• Protokolle über das Pipeline-Toolkit.

Referenz

How to write event driven triggers https://support.shotgunsoftware.com/entries/44575-How-to-write-event-driven-triggers

Event Types https://github.com/shotgunsoftware/python-api/wiki/Event-Types

Es gibt auch so eine gute Sache

Shotgun Event Framework https://github.com/shotgunsoftware/shotgunEvents