Görev Akışı Özellikleri
Görev Çıktısı Kullanımı
Kendinden önce çalışan görev çıktısını kullanabilir.
Çoklu Çalıştırma
Görevi bir kere ya da birden fazla çalıştırabilir.
Görev Akışı Oluşturma
1
Task Flows Sayfasına Git
Ekranınızda solda bulunan navigasyon çubuğundan Development sekmesi altında bulunan API Integration içerisindeki Task Flows sayfasına gidin.
2
Yeni Görev Akışı Oluştur
Sağ üst köşede bulunan Create butonuna basarak yeni bir Görev Akışı (Task Flow) oluşturun.
3
Görev Akışını İsimlendir ve Kaydet
Görev akışını isimlendirerek Save and Next butonuyla görev akışını oluşturun.
Oluşturma Formu Alanları
Name
Alan: NameTip: stringZorunlu: EvetGörev akışını tanımlayan benzersiz isim
Description
Alan: DescriptionTip: stringZorunlu: HayırGörev akışının içeriğine dair bilgi metni (opsiyonel)
Görev Akışı Konfigürasyonları
Konfigürasyon Alanları
Temel Bilgiler
Temel Bilgiler
Ad
Görev akışının listede görünen adıdır. Zorunludur ve proje bazında eşsiz (unique) olmalıdır.
Açıklama
Görev akışına ilişkin açıklamadır.
Durum ve İzleme
Durum ve İzleme
Durum (Status)
Görev akışının aktif/pasif olma durumunu ifade eder.
Trace Status
Trace (Debugging) özelliğinin açık/kapalı olma durumunu ifade eder.
Tetikleme ve Görevler
Tetikleme ve Görevler
Trigger Every
Görev akışının ne sıklıkla otomatik olarak tetikleneceğini ifade eder.
Görevler (Tasks)
Görev akışının içeriğinde tanımlanan görevler grafik üzerine gösterilir. Ekleme, silme ve konfigürasyon işlemleri buradan gerçekleştirilir.
Endpoint
Görev akışının REST API endpoint’i üzerinden tetiklenme seçeneğidir.
Eylemler (Actions)
Tanımlanan görev akışının işleyişi sırasında bir hata olması halinde gerçekleştirilecek eylemleri ifade eder.
Tetiklenme Sıklığı Konfigürasyonu (Trigger Every)
Görev akışını belirli zamanlarda otomatik çalıştırmak için zamanlayıcı tanımlayabilirsiniz.1
Trigger Configuration Penceresini Aç
Oluşturulan görev akışının ne sıklıkla tetiklenmesi gerektiğiyle ilgili konfigürasyon Trigger Every altındaki Change butonuna basınca açılan pencere üzerinden gerçekleştirilir.
2
Değer ve Birim Alanlarını Doldur
Zamanlayıcı konfigürasyonu tanımlanması için Değer ve Birim alanlarını doldurun.
- Minute - Dakika
- Hour - Saat
- Custom - Özel Quartz Cron Expression
Görev Akışı Tanım Ayarları
Görev akışı tanım ayarları, sağ üstte bulunan Edit butonu üzerinden açılan pencere aracılığıyla gerçekleştirilir.
Ad
Görev akışının listede görünen adıdır. Zorunludur ve proje bazında eşsiz (unique) olmalıdır.
Açıklama
Görev akışına ilişkin açıklamadır.
Durum (Status)
Görev akışının aktif/pasif durumu.
Trace Status
Görev akışı adımlarını izleme durumu. Aktif olduğunda çalışan adımlara ait verilerin loglarda gözükmesi sağlanırken, pasif (suspend) olduğunda detaylı loglama yapılmaz.
Görev (Task) Ayarları
Görev (Task) Nedir?
API Integration modülünde, her bir sistem ya da uygulama ile yapılan entegrasyon işlemine görev (task) denilmektedir. Apinizer, entegrasyonları mümkün mertebe API çağrıları ile yapmayı benimsediğinden API ile çağrılabilecek endpoint’lerin her biri için bir görev/bağlantı tipi tanımlamayı benimsemiştir.
Görev Tipleri
E-Posta Gönderme
E-posta gönderimi için kullanılır
API Çağrısı (API Call)
Harici API’lere istek göndermek için kullanılır
Veritabanı Connector
Veritabanı işlemleri için kullanılır
Linux Script Çalıştırma
Linux komutları çalıştırmak için kullanılır
Script (JS/Groovy)
JavaScript veya Groovy script çalıştırmak için kullanılır
Bildirim
Bildirim göndermek için kullanılır
SNMP
SNMP protokolü işlemleri için kullanılır
Görev Tanımlama
1
Görev Ekleme Butonuna Tıkla
Sırasıyla çalışan işlemleri (transactions) tanımlama arayüzü üzerinden yönetilir. Yeni bir görev tanımlamak için Tasks (görevler) altında bulunan şema üzerinde + butonuna basılır.
2
Görev Tipini Seç
Görev seçim ekranı:
3
Görev Detaylarını Yapılandır
Örnek olması açısından bu belge içerisinde API Çağrısı (API Call) örneği üzerinden anlatım gerçekleştirilecektir.
Görevler Arası Veri Aktarımı
Görev akışı (Task Flow) içerisindeki görevlerde bir önceki görevin çıktısı sonraki görevlerin girdisi olarak kullanılabilir. Api Call’ın (Api Çağrısı) çıktısını kendisinden sonra eklenen Script politikasının girdisi olarak nasıl kullanılacağı aşağıdaki ekran görüntülerinde mevcuttur.
Output Key Kullanımı
API Call görevinin çıktısını kendisinden sonra eklenen Script politikasının girdisi olarak kullanabilirsiniz:
Görev Akışı Detaylarını Görme
1
Detaylar Menüsünü Aç
Görev akışı listesinden detayına gidilmek istenen kaydın en sağdaki kolonunda bulunan menü tuşuna tıklayıp Details seçilerek loglara bakılabilir.
2
Log Kayıtlarını İncele
Görev Akışının log detayını içeren ekrana ulaşılır.
3
Çalışma Detaylarını Görüntüle
Görev akışının çalışma detaylarını incelemek için ilgili çalışma anı log kaydının yanındaki üç nokta butonuna basılır.
4
Task Log Details
Görev akışı içerisindeki her bir görevin detaylı çalışma logu ve çıktılarına ulaşmak için Task Log Details seçilir.
5
Görev Çıktılarını Görüntüle
Açılan pencere üzerinden görev akışı içerisinde tanımlı her bir görevin çalışma logları görüntülenir. İlgili log kaydının yanında bulunan üç nokta butonuna basılarak log detayları ve görevin çıktıları görüntülenebilir.
Görevlerdeki Ortak Alanlar
Görev oluşturulurken her tip için aynı olan bazı girdi ve çıktı alanları bulunur. Görevlerdeki ortak bilgilerin konfigürasyonu için kullanılan alanlar aşağıdaki tabloda görülmektedir.Ortak Alan Açıklamaları
| Alan | Açıklama |
|---|---|
| Bu Görevi Çalıştır (Execute This Task For) | Bir önceki görevden üretilen sonucun, mevcut görev içinde nasıl çalıştırılacağı tipi seçilir. Bir Kere (Once): Mevcut görev bir kere çalıştırılır. Döngü (Loop): Mevcut görev önceki görevden aldığı sonuç üzerinde belirtilecek olan tanımlama ile döngü şeklinde çalıştırılır. |
| JSON Path/XPath Söz Dizimi | Bu seçenek, görev çalışma tipi Döngü olarak seçildiyse aktifleşir. JSON Path/XPath ile verilen değerin sonucu döngü olarak çalıştırılır. |
| İşlem başarısız olursa devam etsin | Bu seçenek, görev çalışma tipi Döngü olarak seçildiyse aktifleşir. Döngüdeki eylemler yürütülürken bir hata meydana gelirse, görevin çalışmasına devam etme ya da hemen durdurulması gerektiği işlemi yönetilir. |
| Çıktı Anahtarları Liste butonu (Output Keys) | Önceki görevlerde oluşturulan çıktı anahtarının listesi görülür. Böylelikle görev tanımı girdilerinde buradaki çıktı anahtarı kullanılabilir. |
| Çıktı Anahtar (Output Key) | Görev çalıştırıldığında oluşacak olan değerin atanacağı, değişken adı girilir. Bu görevden sonraki görevler, eğer bu görevin çıktısıyla işlem yapmak isterlerse bu alana girilen çıktı anahtarını kullanacaklardır. |
| **Ad ** | Görevin adı yazılır. Bu bilgi, {{taskflow.name}} değişkeninin değeri olarak atanmaktadır. |
| **Açıklama ** | Görevin açıklaması yazılır. |
Apinizer Söz Dizimi
Bu alandaki kritik nokta değerin Apinizer’ın söz dizimine uygun yazılmasıdır. Bu kuralda dikkat edilmesi gereken 2 unsur vardır.- Söz Dizimi 1: Veriyi Sorgulama
- Söz Dizimi 2: Döngüdeki Veriyi Kullanma
Söz dizilimi kuralları:Örnek:
Önceki görevlerden birinde
- 2 tane süslü parantez ile açılıp kapanmalıdır
- Söz diziminin ilk bölümünde önceki görevin output anahtar adı verilir. Sonuna
#işareti konulur - Söz diziminin ikinci bölümünde output değerinin içinden alınacak değerin, veri tipine ait sorgulama diliyle (JSONPath, XPath) yazılmasıdır
centralRates adında bir sonuç üretilmektedir. Sonucun değerleri Merkez Bankasına ait kur bilgilerini içermektedir. Bu sonucun içerdiği dizideki elemanları tek tek almak için XPath ile /Date/Currency sorgusu yazılmıştır.Görev Akışını Tetikleme
Görev akışı üç farklı şekilde tetiklenebilir:- Manuel Tetikleme
- Otomatik Tetikleme
- Endpoint Üzerinden Tetikleme
Sağ üst köşede bulunan işaretli Execute butonuna her tıklandığında görev akışı tetiklenir.
Görev Akışını Silme
Görev akışı listesinde silinmek istenen kaydın en sağdaki kolonunda bulunan menü tuşuna tıklayıp Delete seçilerek kayıt silinir.
Endpoint Konfigürasyonu
Görev akışları zamanlayıcı ile ya da execute butonu ile manuel tetiklenmekle beraber görev akışı oluşturulduğu an görev akışı için özel ve benzersiz olarak oluşturulan endpoint üzerinden HTTP istekleriyle de tetiklenebilir.
1
Endpoint Seçeneğini Aktifleştir
Görev akışı düzenleme arayüzünden endpoint seçeneği aktif hale getirilmelidir.
2
Endpoint URL'ini Kullan
Endpoint seçeneği aktif hale getirildikten sonra görüntülenen URL’e istek atarak görev akışının tetiklenmesi sağlanabilir.
3
Token Oluştur
Görev akışının erişim URL’i üzerinden tetiklenebilmesi için kullanıcı token’ını Authorization header’ına ekleyerek istek atmak gerekmektedir.Token oluşturmak için: Sağ üstten Profil menüsü > Profilim içerisinden giriş yapan kullanıcı ile token oluşturulabilir.
Eylemler (Actions) Konfigürasyonu
Eylem (Action) Nedir?
Eylem (Action), görev akışı (task flow) çalışma anında bir hata oluşması durumunda gerçekleştirilecek işlemleri ifade eder.
1
Eylem Ekleme
Eylemler (Actions) bölümünden + butonuna basılarak olası bir hata durumunda gerçekleşmesi istenen görevleri tanımlayabilirsiniz.
2
Eylem Tipini Seç
Açılan pencere üzerinden görev akışında olası bir hatayla karşılaşılması durumunda bir görev tanımlayarak hata durumlarından haberdar olabilir veya hata durumları için özel işlemler gerçekleştirebilirsiniz.