Skip to end of metadata
Go to start of metadata

Inledning

Händelser (Event Actions) är en teknik för att automatiskt utföra operationer (sk. händelsekommandon) när ett dokument är på väg att ändras eller påverkas, eller efter motsvarande händelse. Exempel på händelser är Spara, Godkänn och att Publiceringsdatum infaller.

Event Actions är en vanligt förekommande teknik för exempelvis korspublicering, dvs. att information publiceras på flera ställen, exempelvis externa webbplatser eller intranät.

Tekniken aktiveras på kategorinivå i Content Studio och administreras via kategoriinställningarna.

En viktig egenskap med Content Studio händelsehantering är att den sker helt automatiskt av servern, och att den inte går att kringgå. Detta betyder högre att en högre säkerhetsnivå uppnås eftersom händelseinställningarna och de regler som implementerats i den programkod som körs när händelsen startar, alltid kommer att gälla.
Content Studio bevakar händelser relaterade till förändringar eller påverkan av dokument som lagras i Content Studio. Händelserna registreras av Content Studio Server och kallas därför Server Side Events. Händelser (Events) kan kopplas samman med en aktivitet (Action) vilket har inneburit att tekniken kallas Event Actions.

Det finns två grundläggande typer av händelser: synkrona och asynkrona händelser.De synkrona händelserna triggas i samband med händelsen (exempelvis Spara) och de asynkrona triggas EFTER händelsen inträffat, exempelvis att arkiveringsdatum för ett dokument har passerats.

De flesta synkrona händelser kan avbryta den operation som inletts, exempelvis Spara dokument, medan de asynkrona händelserna kan inte avbryta den påbörjade operationen eftersom händelsen triggas först efter att operationen slutförts.
Asynkrona händelser hanteras av Content Studio Service Manager.

Händelser på kategorier (Event Actions)

För att administrera händelser på kategorinivå, använd kategoriinställningarna. I den dialog som presenteras visas de händelsekommandon som finns konfigurerade för kategorin:


Händelser på kategorier


Lägga till ett händelsekommando

Händelsedialogen innehåller funktioner för att lägga till nya händelsekommandon, eller ändra egenskaper på redan registrerade händelsekommandon. I den dialogruta som visas konfigureras händelsekommandot: namn, typ av händelse, eventuella inloggningsuppgifter, typ av hanterare, eventuellt kommand, timeout mm. Se nedanstående beskrivningar:


Egenskaper för händelsekommande

Synkrona händelser

Synkrona händelsekommandon triggas omedelbart när händelsen inträffar. Den största fördelen med synkrona händelser är att de kan avbryta händelsen, och återställa dokumentet i det tillstånd det hade innan händelsen inträffade. Det är exempelvis möjligt att avbryta sparning eller radering av dokument.
Synkrona händelsekommandon kallas ibland även OnBeforeEventHandlers.

Nedan presenteras de synkrona händelser som stöds:

Synkrona händelser

 

Händelse

Beskrivning

OnBeforeDocumentSave

Denna händelse finns tillgänglig from v5.2 av Content Studio
Denna händelse triggas innan dokumentet är på väg att skapas eller sparas. Händelsen gör det möjligt att analysera innehållet och utifrån detta ta beslut om att eventuellt avbryta processen, eller att förändra innehållet innan dokumentet skapas/sparas.
Det bör noteras att eftersom händelsen inte kan bedöma om den efterföljande processen kunde slutföras i Content Studio databas, inte kan användas för alla typer av iplementationer.

OnDocumentApprove

Triggas när dokumentet godkänns.

OnDocumentCreate

Triggas när dokumentet skapas.

OnDocumentDelete

Triggas när dokumentet raderas (till papperskorgen).

OnDocumentDestroy

Triggas när dokumentet tas bort permanent (tas bort från papperskorgen).

OnDocumentSave

Triggas när ett dokument sparas, men efter att dokumentets metadata har uppdaterats.



Att använda asynkrona händelser

Synkrona händelser hanteras av händelsehanterare som skapats i programkod (.dll-filer) som installeras i samma katalog som Content Studio. Händelsehanterarna måste utformas på ett speciellt sätt och implementera interfacet ICSEventHandler. För mer information, se http://docs.contentstudio.se

Asynkrona händelsekommandon

Asynkrona händelserkommandon påminner mycket om de synkrona motsvarigheterna. Skillnaden är att de asynkrona händelserna triggas EFTER respektive händelse i Content Studio. När en händelse inträffar köas händelsekommandot upp av Content Studio Service Manager och kommer att utföras så snart som möjligt. Ett exempel på asynkrona händelser är indexering av XML som sker automatiskt via Content Studio XML-Index.
Asynkrona händelsekommandon exekveras i bakgrunden och kan inte avbryta eller ångra den händelse som skett. Exempelvis kan inte händelsen Spara avbrytas så att dokumentet inte sparas i Content Studio.
Exempel på användningsområden är bland annat korspublicering eller e-postutskick triggade av händelsen OnDocumentPublish.

Händelse

Beskrivning

OnDocumentApprove

Triggas när dokumentet godkänts.

OnDocumentCheckIn

Triggas när dokumentet checkats in.

OnDocumentCheckOut

Triggas när dokumentet checkats ut.

OnDocumentDelete

Triggas när dokumentet raderats (till papperskorgen).

OnDocumentDestroy

Triggas när dokumentet permanent tagits bort.

OnDocumentExpire

Triggas när dokumentets arkiveringsdatum passerats.

OnDocumentPublish

Triggas när dokumentets publiceringsdatum passerats.

OnDocumentUnPublish

Triggas när dokumentet inte längre är publicerat.

OnDocumentReject

Triggas när dokumentet underkänns.

OnDocumentRevision

Triggas när dokumentet skickats för godkännande.

OnDocumentSave

Triggas när dokumentet sparats.

OnXMLIndexChange

Används endast internt av Content Studio.

OnDocumentSubscription

Triggas när dokumentet skickats ut till prenumeranter.

OnTestDocumentSubscription

Triggas när en administrator genomför ett testutskick till prenumerant.

Olika typer av händelserkommandon


Metod

Beskrivning

Asynchronous event handler object

En asynkron anpassad händelsehanterare (custom event handler) kommer att köras av Content Studio Service Manager. En anpassad händelsehanterare kan skapas i valfritt programspråk som är kompatibelt med Microsoft .NET. På liknande sätt som en synkron händelsehanterare måste programkoden implementera ett speciellt interface, ICSAsyncEventHandler.Denna typ av händelsehanterare är mycket kraftfulla och kan utvecklas och debuggas I Visual Studion. Hur en asynkron, anpassad händelsehanterare skapas finns beskrivet i Content Studio API.

Http POST

Denna metod innebär att Content Studio Service Manager kommer att anropa en HTTP adress med metoden HTTP Post. Anropet kan förses med ett antal kommandoparametrar som kommer att postas till angiven URL.
Den webbsida som anropas kan vara skapad i Content Studio eller ett annat verktyg.
Exempel: http://www.minsajt.se/send.aspx?theid=$ElementID

Http Get

Denna metod innebär att Content Studio Service Manager kommer att anropa en HTTP address med metoden HTTP Get. Anropet kan förses med ett antal kommandoparametrar som kommer att skickas till angiven URL via querystrings.
Exempel: http://www.minsajt.se/send.aspx?theid=$ElementID

Calling a web service

Denna metod innebär att Content Studio Service Manager anropar angiven web service.
För närvarande (Content Studio v5.2) är denna metod inte implementerad.

Calling a regular executable application

Denna metod innebär att Content Studio Service Manager startar en .exe fil på webbservern.


Kommandoparametrar

När händelsekommandon av typen HTTP Post eller HTTP Get används kan den URL som anges kompletteras med parametrar. Parametrarna gör det möjligt att skicka information till den externa tjänsten (URL:en (\\\\olympus\\projects\\TH Content Studio NET_THSOCO062_3006\\Dokumentation användarmanual\\Användarmanual\\en)).
Händelseparametrarna anges efter URL, exempelvis http://www.externsajt.se/inbox?filename=$DocFileName.

Parameter

Beskrivning

$EventID          

Unikt ID-nummer för händelsen. ID-nummer skapas automatiskt av Content Studio.

$ConnectionID           

ConnectionID för webbplatsen

$UserID

ID för den användare som triggade händelsen.

$UserFullName

Användarnamn för den användare som triggade händelsen.

$ElementID

ID på det dokument som händelsen berör.

$EAID

Unikt ID-nummer för händelsekommandot. ID-nummer skapas automatiskt av Content Studio.

$EAName

Namn på händelsekommandot .

$EATimeOut

Den timeout som angivits för händelsekommandot.

$EARunOnce

Inställning för om händelsekommandot endast ska utföras en gång.

$Now

Nuvarande tid.

$ServerName

Namn på webbserver.

$EventTimeStamp

Tidpunkt när händelsekommandot startades.

$MsgID

ID-nummer för det meddelande som genereras när händelsekommandot skickas till Content Studio Service Manager. ID-nummer skapas automatiskt av Content Studio.

$DocumentName

Namn på det dokument händelsen berör.

$DocFileName

Filnamn på det dokument händelsen berör.

$Encoding

Den encoding som används för det dokument händelsen berör.

$BR

Radbrytning

$AdminURL

URL till Content Studio admin.

$SiteURL

Webbplatsens URL


Labels
  • None