Enregistrez des événements personnalisés à l'aide de l'API Shotgun

Qu'est-ce que c'est?

À propos de l'enregistrement des journaux sur Shotgun via l'API Shotgun J'écrirai sur le cas de laisser intentionnellement un journal arbitraire au lieu du journal qui est automatiquement laissé.

Entité EventLogEntry

Sur Shotgun, la table de données pour la journalisation est ** "EventLogEntry Entity" **. Si quelqu'un fait quelque chose sur Shotgun Web (ouvre une page, change de statut, parcourt une version, etc.), il sera enregistré.

Fonctionnalité

• Ne peut pas être supprimé
• non modifiable
• Enregistré à la fois depuis le navigateur et via l'API

… Parce que c'est un journal, bien sûr

Enregistrer le journal [arbitrairement]

supposition

Le journal est enregistré sans rien faire, En outre, vous souhaitez parfois enregistrer vos propres événements en tant que marqueur.

C'est un soi-disant «événement personnalisé».

Méthode utilisée = créer

Il n'y a pas de méthode pour enregistrer les événements, Normalement ** create ** sur l'entité EventLogEntry

champ

• event_type
• Ne peut pas être laissé vide. Sera décrit plus tard
• description --Si laissé vide, "Nouvel événement" sera écrit automatiquement.
• user
• entity «Vous pouvez laisser ces deux vides, mais si vous ne les écrivez pas, vous aurez des ennuis.

• Un exemple de création accidentelle avec seulement project et event_type. *

Au fait, en parlant de "RTS" dans la colonne projet, Il est sérialisé ici> http://area.autodesk.jp/column/tutorial/road_to_stingray/ J'ai également donné une conférence l'autre jour> http://www.guncys.com/?p=378 J'attends avec impatience l'achèvement!

Comment écrire event_type

Puisque event_type lui-même n'est qu'un champ de texte, vous pouvez l'écrire librement, Fondamentalement, il est préférable de correspondre au format suivant

{Quel est le journal}_{À quelle entité se connecter}_{Quel genre d'opération avez-vous fait}

«Qui», «où» et «ce qui s'est passé» sont reliés par un trait de soulignement. En observant le journal écrit en standard, on a l'impression que le cas supérieur du chameau est connecté à un trait de soulignement pour 3 éléments.

Qui

• "Who" * est écrit comme ** "application" ** sur le wiki officiel. La plupart des journaux sont fermés par des opérations via le navigateur, donc "Shotgun" est entré. Je pense que ce serait bien si je pouvais montrer l'histoire extrême «Shotgun'not» »sans la rendre trop détaillée. Vous pouvez en faire un script contenant le nom de ScriptUser.

où

• Entrez le ** nom de l'entité ** lui-même dans "où" *.

Qu'est-il arrivé

• Entrez ** "Action" ** dans "Qu'est-ce qui ne va pas" *. En observant le journal laissé par Shotgun, "New" est inclus lors de sa création, "Change" est inclus lors de la mise à jour. Il s'agit d'un mot sans le rendre trop long. (Méthode "Supprimer" = Retrait. La raison pour laquelle les méthodes "créer" et "mettre à jour" ne sont pas prises en charge est un peu mystérieuse. S'agit-il d'un terme de base de données?) Puisque nous prenons la peine d'écrire un script ici et de laisser un journal, je pense que des actions différentes de ces actions standard seront attribuées ici.

Exemple de phrase

l'écriture

Sur la base du contenu jusqu'à présent, le script qui laisse un journal arbitraire est le suivant, par exemple.

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)

Avoir

L'exemple de phrase pour obtenir le journal écrit ressemble à ce qui suit

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'}]
                  )

En utilisant la méthode find_one et en spécifiant ʻorder` pour retourner dans l'ordre le plus récent (au point de'desc ') J'ai un "dernier'Myscript_Shot_SomeAction '". De plus, mettez `` created_at '' dans le champ renvoyé pour obtenir l'horodatage.

Si vous entrez le type d'événement, ce serait bien d'en faire une fonction afin qu'il soit renvoyé.

Résumé

--Utilisez create.

• ** Attention car il ne peut pas être effacé **!

Remarques

Exemple d'événement

Voici quelques exemples de types d'événements qui s'écouleront si vous les utilisez normalement (= sans rien faire comme ci-dessus).

• Shotgun_Task_Retirement
• Shotgun_User_Logout
• Shotgun_User_FailedLogin
• Shotgun_ProjectUserConnection_New
• Le type d'événement qui est enregistré lorsque vous affectez du personnel à un projet.
• Shotgun_AppWelcomeUserConnection_New ――C'est celui qui est enregistré lorsque vous invitez un nouvel utilisateur. Peut-être.
• Shotgun_PageSetting_Change
• Toolkit_Desktop_ProjectLaunch
• Journaux via la boîte à outils du pipeline.

référence

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

Il y a aussi une si bonne chose

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