Konfigurera bevakade mappslutpunkter configuring-watched-folder-endpoints

En administratör kan konfigurera en nätverksmapp, en så kallad bevakad mapp, så att en konfigurerad tjänståtgärd anropas och filen ändras när en användare placerar en fil (till exempel en PDF-fil) i den bevakade mappen. När tjänsten har utfört den angivna åtgärden sparas den ändrade filen i en angiven utdatamapp.

Konfigurera tjänsten Bevakade mappar configuring-the-watched-folder-service

Konfigurera tjänsten Bevakade mappar innan du konfigurerar en bevakad mappslutpunkt. Konfigurationsparametrarna för tjänsten Bevakade mappar har två syften:

När du har konfigurerat tjänsten Bevakade mappar lägger du till en bevakad mappslutpunkt för måltjänsten. När du lägger till slutpunkten anger du värden, till exempel tjänstnamnet och åtgärdsnamnet som ska anropas när filer eller mappar placeras i indatamappen för den konfigurerade tjänsten Bevakade mappar. Mer information om hur du konfigurerar tjänsten Bevakade mappar finns i Inställningar för tjänsten Bevakade mappar.

Skapa en bevakad mapp creating-a-watched-folder

Du kan skapa en bevakad mapp på följande två sätt:

I en klustermiljö måste mappen som används som en bevakad mapp vara tillgänglig, skrivbar och delad i filsystemet eller nätverket. I det här fallet måste varje programserverinstans i klustret ha åtkomst till samma delade mapp.

Om programservern körs som en tjänst i Windows måste den startas med lämplig åtkomst till den delade mappen på något av följande sätt:

Sammanfoga bevakade mappar chaining-together-watched-folders

Bevakade mappar kan sammanfogas så att ett resultatdokument för en bevakad mapp är indatadokumentet för nästa bevakade mapp. Varje bevakad mapp kan anropa en annan tjänst. Genom att konfigurera bevakade mappar på det här sättet kan flera tjänster anropas. En bevakad mapp kan till exempel konvertera PDF-filer till Adobe PostScript® och en andra bevakad mapp kan konvertera PostScript-filerna till PDF/A-format. Det gör du genom att ange att mappen result i den bevakade mappen som definieras av din första slutpunkt ska peka på mappen input i den bevakade mappen som definieras av din andra slutpunkt.

Utdata från den första konverteringen går till \path\result. Indata för den andra konverteringen är \path\result, och utdata från den andra konverteringen går till \path\result\result (eller den katalog som du definierar i rutan Resultatmapp för den andra konverteringen).

Hur användare interagerar med bevakade mappar how-users-interact-with-watched-folders

För en bevakad mappslutpunkt kan användare anropa genom att kopiera eller dra indatafiler eller -mappar från sina datorer till en bevakad mapp. Filerna kommer att bearbetas i den ordning som de kommer fram.

Om jobbet endast kräver en indatafil kan användaren kopiera den filen till roten i den bevakade mappen för bevakade mappslutpunkter.

Om jobbet innehåller mer än en indatafil måste användaren skapa en mapp utanför den bevakade mapphierarkin som innehåller alla nödvändiga filer. Den nya mappen bör innehålla indatafilerna (och eventuellt en DDX-fil om det behövs av processen). När jobbmappen har skapats kopierar användaren den till den bevakade mappens indatamapp.

Bevakade mapputdata watched-folder-output

När indata är en mapp och utdata består av flera filer skapar AEM en utdatamapp med samma namn som indatamappen och kopierar utdatafilerna till den mappen. När utdata består av en dokumentöversikt som innehåller ett nyckelvärdepar, till exempel utdata från en utdataprocess, används nyckeln som utdatafilens namn.

Namn på utdatafiler som härrör från en slutpunktsprocess får inte innehålla andra tecken än bokstäver, siffror och punkter (.) före filtillägget. AEM konverterar andra tecken till sina hexadecimala värden.

Klientprogrammen hämtar resultatdokumenten från den bevakade mappens resultatmapp. Processfel loggas i den bevakade mappen för mappfel.

Så här fungerar Bevakade mappar how-watched-folder-works

Modulen Bevakade mappar innehåller följande tjänster:

Förutom de tjänster som anges ovan är Bevakade mappar också beroende av andra tjänster, inklusive schemaläggningstjänsten för schemaläggning av jobb och jobbhanterartjänsten för asynkront anrop av måltjänster.

Hur bevakad mapp bearbetar en anropsbegäran how-watched-folder-processes-an-invocation-request

Tjänsten Bevakade mappar hanterar generering, uppdatering och borttagning av slutpunkterna. När administratören har skapat slutpunkterna schemaläggs de att utlösas av tjänsten Schemaläggaren baserat på det angivna upprepningsintervallet eller cron-uttrycket.

Bilden visar hur Bevakade mappar bearbetar en anropsbegäran.

Så här anropar du en tjänst med bevakade mappar:

Slutpunktsinställningar för bevakad mapp watched-folder-endpoint-settings

Använd följande inställningar för att konfigurera en bevakad mappslutpunkt.

Namn: (obligatoriskt) Identifierar slutpunkten. Ta inte med ett <-tecken eftersom det kortar av namnet som visas i Workspace. Om du anger en URL som namn på slutpunkten kontrollerar du att den överensstämmer med de syntaxregler som anges i RFC1738.

Beskrivning: En beskrivning av slutpunkten. Ta inte med ett <-tecken eftersom det kortar av beskrivningen som visas i Workspace.

Sökväg: (obligatoriskt) Anger platsen för bevakad mapp. I en klustrad miljö måste den här inställningen peka på en delad nätverksmapp som är tillgänglig från alla datorer i klustret.

Asynkron: Identifierar anropstypen som asynkron eller synkron. Standardvärdet är asynkront. Asynkron rekommenderas för långvariga processer, medan synkron rekommenderas för tillfälliga eller kortvariga processer.

Cron-uttryck: Ange ett cron-uttryck om den bevakade mappen måste schemaläggas med ett cron-uttryck. När den här inställningen är konfigurerad ignoreras upprepningsintervall.

Intervall för upprepning: Intervallet i sekunder för skanning av den bevakade mappen för indata. Om inte inställningen Gräns är aktiverad ska intervallet för upprepning vara längre än tiden för att bearbeta ett genomsnittligt jobb. Annars kan systemet bli överbelastat. Standardvärdet är 5. Mer information finns i beskrivningen för Batchstorlek.

Antal upprepningar: Antal gånger den bevakade mappen genomsöker mappen eller katalogen. Värdet -1 anger oändlig skanning. Standardvärdet är -1.

Begränsning: När det här alternativet är markerat begränsas antalet bevakade mappjobb som AEM formulärprocesser vid en given tidpunkt. Det maximala antalet jobb bestäms av värdet för Batchstorlek. (Se Om begränsning.)

Användarnamn: (obligatoriskt) Det användarnamn som används när en måltjänst anropas från den bevakade mappen. Standardvärdet är SuperAdmin.

Domännamn: (obligatoriskt) Användarens domän. Standardvärdet är DefaultDom.

Batchstorlek: Antalet filer eller mappar som ska hämtas per skanning. Används för att förhindra överbelastning i systemet. Om du skannar för många filer samtidigt kan det orsaka en krasch. Standardvärdet är 2.

Inställningarna Intervall för upprepning och Gruppstorlek avgör hur många filer i Bevakade mappar som tas upp vid varje sökning. Bevakad mapp använder en Quartz-trådpool för att skanna indatamappen. Trådpoolen delas med andra tjänster. Om skanningsintervallet är litet genomsöks indatamappen ofta av trådarna. Om filer ofta placeras i den bevakade mappen bör du hålla sökintervallet litet. Om filerna tas bort sällan bör du använda ett större inläsningsintervall så att de andra tjänsterna kan använda trådarna.

Om det finns en stor mängd filer som tas bort gör du gruppstorleken stor. Om till exempel tjänsten som anropas av den bevakade mappens slutpunkt kan bearbeta 700 filer per minut, och användarna släpper filer i indatamappen med samma hastighet, och du sedan anger värdet 350 för Gruppstorlek och intervallet för upprepning till 30 sekunder, kommer prestandan för bevakad mapp att bli bättre utan att kostnaden för att skanna den bevakade mappen för ofta påverkas.

När filer släpps i den bevakade mappen visas filerna i indata, vilket kan försämra prestanda om skanningen sker varje sekund. Om du ökar skanningsintervallet kan prestandan förbättras. Om volymen för de filer som tas bort är liten justerar du batchstorleken och upprepningsintervallet därefter. Om till exempel 10 filer tas bort varje sekund, kan du försöka med att ange intervallet för upprepning till 1 sekund och gruppstorleken till 10.

Väntetid: Den tid i millisekunder som du vill vänta innan du skannar en mapp eller fil efter att den har skapats. Om väntetiden till exempel är 3 600 000 millisekunder (en timme) och filen skapades för en minut sedan, kommer filen att hämtas efter 59 eller fler minuter. Standardvärdet är 0.

Den här inställningen är användbar för att säkerställa att en fil eller mapp kopieras helt till indatamappen. Om du t.ex. har en stor fil att bearbeta och det tar tio minuter att hämta filen anger du väntetiden till 10*60 *1000 millisekunder. Detta förhindrar att den bevakade mappen skannar filen om den inte är tio minuter gammal.

Uteslut filmönster: Ett semikolon ; avgränsad lista över mönster som används i en bevakad mapp för att avgöra vilka filer och mappar som ska sökas igenom och plockas upp. Filer och mappar med det här mönstret skannas inte för bearbetning.

Den här inställningen är användbar när indata är en mapp med flera filer. Innehållet i mappen kan kopieras till en mapp med ett namn som hämtas av den bevakade mappen. Detta förhindrar att den bevakade mappen hämtar en mapp för bearbetning innan mappen kopieras till indatamappen.

Du kan använda filmönster för att exkludera:

Mer information om filmönster finns i Om filmönster.

Inkludera filmönster: (obligatoriskt) Ett semikolon ; avgränsad lista över mönster som den bevakade mappen använder för att avgöra vilka mappar och filer som ska sökas igenom och plockas upp. Om till exempel Inkludera filmönster är indata* hämtas alla filer och mappar som matchar indata*. Detta inkluderar filer och mappar med namnen input1, input2 och så vidare.

Standardvärdet är * och anger alla filer och mappar.

Du kan använda filmönster för att inkludera:

Mer information om filmönster finns i Om filmönster.

Resultatmapp: Mappen där de sparade resultaten lagras. Om resultaten inte visas i den här mappen kontrollerar du felmappen. Skrivskyddade filer bearbetas inte och sparas i felmappen. Värdet kan vara en absolut eller relativ sökväg med följande filmönster:

Om det till exempel är 2009-08-17 och du anger C:/Test/WF0/failure/%Y/%M/%D/%H/ blir resultatmappen C:/Test/WF0/failure/2009/07/17/20.

Om sökvägen inte är absolut men relativ skapas mappen i den bevakade mappen. Standardvärdet är result/%Y/%M/%D/, som är resultatmappen i den bevakade mappen. Mer information om filmönster finns i Om filmönster.

Bevara mapp: Platsen där filerna lagras efter att sökningen och hämtningen har slutförts. Sökvägen kan vara en absolut, relativ eller null-katalogsökväg. Du kan använda filmönster enligt beskrivningen för resultatmappen. Standardvärdet är preserve/%Y/%M/%D/.

Felmapp: Mappen där felfiler sparas. Den här platsen är alltid relativ till den bevakade mappen. Du kan använda filmönster enligt beskrivningen för resultatmappen.

Skrivskyddade filer bearbetas inte och sparas i felmappen.

Standardvärdet är fel/%Y/%M/%D/.

Bevara vid fel: Bevara indatafiler om det inte går att köra åtgärden på en tjänst. Standardvärdet är true.

Skriv över duplicerade filnamn: Om värdet är True skrivs filerna i resultatmappen och bevara mappen över. Om värdet är Falskt används filer och mappar med ett numeriskt indexsuffix för namnet. Standardvärdet är Falskt.

Töm varaktighet: (obligatoriskt) Filer och mappar i resultatmappen tas bort när de är äldre än det här värdet. Detta värde mäts i dagar. Den här inställningen är användbar för att säkerställa att resultatmappen inte blir full.

Värdet -1 dagar anger att resultatmappen aldrig ska tas bort. Standardvärdet är -1.

Åtgärdsnamn: (obligatoriskt) En lista över åtgärder som kan tilldelas till den bevakade mappens slutpunkt.

Mappningar av indataparameter: Används för att konfigurera de indata som krävs för att bearbeta tjänsten och åtgärden. Vilka inställningar som är tillgängliga beror på vilken tjänst som använder den bevakade mappens slutpunkt. Här är två typer av indata:

Litteral: Den bevakade mappen använder det värde som anges i fältet när det visas. Alla grundläggande Java-typer stöds. Om ett API till exempel använder indata som String, long, int och Boolean, konverteras strängen till rätt typ och tjänsten anropas.

Variabel: Det angivna värdet är ett filmönster som den bevakade mappen använder för att välja indata. Om det till exempel finns en krypterad lösenordstjänst där indatadokumentet måste vara en PDF-fil, kan användaren använda *.pdf som filmönster. Den bevakade mappen hämtar alla filer i den bevakade mappen som matchar mönstret och anropar tjänsten för varje fil. När en variabel används konverteras alla indatafiler till dokument. Endast API:er som använder Document som indatatyp stöds.

Mappningar av utdataparameter: Används för att konfigurera utdata för tjänsten och åtgärden. Vilka inställningar som är tillgängliga beror på vilken tjänst som använder den bevakade mappens slutpunkt.

Bevakade mapputdata kan vara ett enstaka dokument, en lista med dokument eller en karta med dokument. Dessa utdatadokument sparas sedan i resultatmappen med det mönster som anges i Mappning av utdataparameter.

Om filmönster about-file-patterns

Administratörer kan ange vilken typ av fil som kan anropa en tjänst. Du kan skapa flera filmönster för varje bevakad mapp. Ett filmönster kan vara någon av följande filegenskaper:

Administratören kan definiera filmönstret för utdatamappen där resultaten ska lagras. För utdatamappar (resultat, bevarande och fel) kan administratören ange något av följande filmönster:

Sökvägen till resultatmappen kan till exempel vara C:\Adobe\Adobe_Experience_Manager_forms\BarcodedForms\%y\%m\%d.

Mappningar av utdataparametrar kan även ange ytterligare mönster, som:

Om mappningsmönstret för utdataparametrar avslutas med "File.separator" (som är sökvägsavgränsaren) skapas en mapp och innehållet kopieras till den mappen. Om mönstret inte avslutas med "File.separator" skapas innehållet (resultatfilen eller mappen) med det namnet. Mer information om mappningar av utdataparametrar finns i Tips och tricks för bevakade mappar.

Om begränsning about-throttling

När du har aktiverat begränsning för en bevakad mappslutpunkt begränsas antalet bevakade mappjobb som kan bearbetas vid en given tidpunkt. Det maximala antalet jobb bestäms av värdet för Gruppstorlek, som också kan konfigureras i slutpunkten för bevakad mapp. Inkommande dokument i indatakatalogen för den bevakade mappen avsöks inte när begränsningsgränsen har uppnåtts. Dokumenten kommer också att finnas kvar i indatakatalogen tills andra bevakade mappjobb har slutförts och ytterligare ett avsökningsförsök görs. Om det finns synkron bearbetning räknas alla jobb som bearbetas i en enda omröstning mot begränsningsgränsen, även om jobben bearbetas i följd i en enda tråd.

Så här fungerar strypning how-throttling-works

Bevakad mapp skannar indatamappen vid varje upprepningsintervall, hämtar det antal filer som anges i gruppstorleken och anropar måltjänsten för var och en av dessa filer. Om till exempel gruppstorleken är fyra hämtar Bevakad mapp fyra filer vid varje skanning, skapar fyra anropsbegäranden och anropar måltjänsten. Om Bevakade mappar anropas startas fyra jobb igen innan dessa begäranden har slutförts, oavsett om de föregående fyra jobben har slutförts eller inte.

Begränsning förhindrar att bevakad mapp anropar nya jobb när tidigare jobb inte har slutförts. Bevakad mapp identifierar pågående jobb och bearbetar nya jobb baserat på batchstorleken minus pågående jobb. I det andra anropet anropas bara tre jobb till om antalet slutförda jobb är tre och ett jobb fortfarande pågår.

Prestanda och skalbarhet performance-and-scalability

Bevakad mapp kan hantera totalt 100 mappar på en enda nod. Hur övervakad mapp fungerar beror på Forms-serverns prestanda. För asynkrona anrop är prestanda mer beroende av systeminläsningen och jobben i jobbhanterarkön.

Du kan förbättra prestanda för bevakade mappar genom att lägga till noder i klustret. Bevakade mappjobb distribueras mellan klusternoderna med hjälp av Quartz-schemaläggaren och, om det finns asynkrona begäranden, med tjänsten Job Manager. Alla jobb sparas i databasen.

Bevakad mapp är beroende av schemaläggningstjänsten för schemaläggning, avschemaläggning och omplanering av jobben. Andra tjänster, som händelsehanteringstjänsten, tjänsten User Manager och e-postprovidertjänsten, är tillgängliga som delar trådpoolen för tjänsten Scheduler. Detta kan påverka prestandan för bevakade mappar. Inställningen av trådpoolen för schemaläggningstjänsten behövs när alla tjänster börjar använda den.

Bevakade mappar i ett kluster watched-folders-in-a-cluster

I ett kluster beror Bevakade mappar på Quartz-schemaläggaren och jobbhanterartjänsten för belastningsutjämning och failover. Mer information om klusterbeteendet i Quartz finns i Quartz-dokumentation.

Bevakad mapp utför följande tre huvuduppgifter vid varje omröstning:

Beteendet för belastningsutjämning och failover ändras beroende på om den bevakade mappen är konfigurerad för synkront eller asynkront anrop.

Synkron bevakad mapp i ett kluster synchronous-watched-folder-in-a-cluster

För synkrona anrop avgör Quartz-belastningsutjämnaren vilken nod som får avsökningshändelsen. Noden som hämtar avsökningshändelsen utför alla åtgärder: skanna mappen, anropa måltjänsten och hantera resultaten.

För synkrona anrop skickas nya avsökningshändelser till andra noder när en nod misslyckas. Anrop som startades på den misslyckade noden går förlorade. Mer information om hur du återställer filer som är associerade med det misslyckade jobbet finns i Felpunkter och återställning.

Asynkron bevakad mapp i ett kluster asynchronous-watched-folder-in-a-cluster

För asynkrona anrop avgör belastningsutjämnaren i Quartz vilken nod som får avsökningshändelsen. Noden som hämtar avsökningshändelsen genomsöker indatamappen och anropar måltjänsten genom att placera begäran i jobbhanterarens tjänstkö. Belastningsutjämnaren för tjänsten Job Manager ansvarar i sin tur för att avgöra vilken nod som ska bearbeta anropsbegäran. Det är möjligt att även om nod A skapade anropsbegäran så kommer nod B att bearbeta begäran. Eller så kan noden som startade anropsbegäran också avsluta bearbetningen av begäran.

För asynkrona anrop skickas nya avsökningshändelser till andra noder när en nod misslyckas. Anropsbegäranden som har skapats på den misslyckade noden finns i jobbhanterarens tjänstkö och skickas till andra noder för bearbetning. Filer som inte har någon startbegäran kommer att finnas kvar i scenmappen. Mer information om hur du återställer filer som är associerade med det misslyckade jobbet finns i Felpunkter och återställning.

Felpunkter och återställning failure-points-and-recovery

Vid varje omröstning låses indatamappen av Bevakad mapp, filerna som matchar inkluderingsfilmönstret flyttas till scenmappen och indatamappen låses upp. Låsning krävs så att två trådar inte kan hämta samma uppsättning filer och bearbeta dem två gånger. Risken för detta ökar med ett litet upprepningsintervall och en stor batchstorlek. När filer har flyttats till scenmappen låses indatamappen upp så att andra trådar kan skanna in mappen. Det här steget ger hög genomströmning eftersom andra trådar kan skanna medan en tråd bearbetar filerna.

När filer har flyttats till scenmappen skapas en anropsbegäran för varje fil och måltjänsten anropas. Det kan finnas tillfällen då bevakad mapp inte kan återskapa filerna i scenmappen:

Synkron: Om bevakad mapp är konfigurerad att anropa tjänsten synkront förblir alla filer i scenmappen obearbetade i scenmappen.

Asynkron: I det här fallet är den bevakade mappen beroende av tjänsten Jobbhanteraren. Om tjänsten Jobbhanteraren anropar den bevakade mappen, flyttas filerna i scenmappen till mappen för bevarande eller fel baserat på resultatet av anropet. Om tjänsten Jobbhanteraren inte anropar den bevakade mappen kommer filerna inte att bearbetas i scenmappen. Detta inträffar när den bevakade mappen inte körs när jobbhanteraren anropar tillbaka.

Återställa obearbetade källfiler i scenmappen recovering-unprocessed-source-files-in-the-stage-folder

Om den bevakade mappen inte kan bearbeta källfilerna i scenmappen kan du återställa de obearbetade filerna.

Säkerhetsaspekter för bevakade mappar security-considerations-for-watched-folders

Varje bevakad mapp konfigureras med ett användarnamn och lösenord. Dessa autentiseringsuppgifter används när tjänsterna anropas. Bevakad mapp är beroende av att den delade mappen skyddas med det underliggande säkerhetsfilsystemet, så att bara ägaren till den bevakade mappen kan komma åt den delade mappen.

Tips och tricks för bevakade mappar tips-and-tricks-for-watched-folders

Här följer några tips och råd när du konfigurerar slutpunkten för bevakad mapp:

Servicespecifika rekommendationer för bevakade mappar service-specific-recommendations-for-watched-folders

För alla tjänster bör du justera gruppstorleken och upprepningsintervallet för den bevakade mappen så att hastigheten med vilken bevakade mappar hämtar nya filer och mappar för bearbetning inte överstiger hastigheten för de jobb som kan bearbetas av AEM Forms Server. De faktiska parametrarna som ska användas kan variera beroende på hur många bevakade mappar som har konfigurerats, vilka tjänster som använder bevakade mappar och hur intensiva jobben är för processorn.

Generera servicerekommendationer för PDF generate-pdf-service-recommendations

rekommendationer för streckkodsblanketttjänst barcoded-forms-service-recommendations