Skip to content

U
ulakbus-ui
Commit e5eb1188 authored by Evren Kutar's avatar Evren Kutar
Browse files
Options

ADD refs GH-42 writing docs

parent 8fe14dc0
Hide whitespace changes
Inline Side-by-side
Showing with 50 additions and 376 deletions
docs/ulakbus-api-ui-iliskisi.rst
View file @ e5eb1188
...@@ -15,16 +15,16 @@ Ulakbus kullanıcı arayüzü yapacağı işlemlerle ilgili komutları API'dan a ...@@ -15,16 +15,16 @@ Ulakbus kullanıcı arayüzü yapacağı işlemlerle ilgili komutları API'dan a
İş akış şemaları yani *workflow* lar bpmn formatında backend API'da oluşturulur. İş akış şemaları yani *workflow* lar bpmn formatında backend API'da oluşturulur.
İş akışının arayüzde akışa uygun şekilde gerçekleştirilmesi için kullanılacak anahtar-değerler ( *key-value* ) API İş akışının arayüzde akışa uygun şekilde gerçekleştirilmesi için kullanılacak anahtar-değerler ( *key-value* ) API
tarafından `response` nesnesinde arayüze gönderilir ve arayüz tarafından yorumlanır. tarafından ``response`` nesnesinde arayüze gönderilir ve arayüz tarafından yorumlanır.
API'ın `Response` nesnesinde sayfaların yorumladığı datanın (`forms`, `objects`, `object`) dışında kullanıcı arayüzünü şekillendiren, işlev ekleyen bazı anahtarlar bulunmaktadır. Bunlar aşağıdaki örnekte sıralanmıştır; API'ın ``Response`` nesnesinde sayfaların yorumladığı datanın (``forms``, ``objects``, ``object``) dışında kullanıcı arayüzünü şekillendiren, işlev ekleyen bazı anahtarlar bulunmaktadır. Bunlar aşağıdaki örnekte sıralanmıştır;
.. code:: json .. code:: json
{ {
"client_cmd":["form"], "client_cmd":["form"],
"reload_cmd":"add_edit_form", "reload_cmd":"add_edit_form",
"token":"80c5fd8148cc466a836dce4d6a944419", "token":"zxcv4321",
"meta":{ "meta":{
"allow_search":true, "allow_search":true,
"allow_selection":false "allow_selection":false
...@@ -33,7 +33,7 @@ API'ın `Response` nesnesinde sayfaların yorumladığı datanın (`forms`, `obj ...@@ -33,7 +33,7 @@ API'ın `Response` nesnesinde sayfaların yorumladığı datanın (`forms`, `obj
{ {
"TIMESTAMP":1453289218.893847, "TIMESTAMP":1453289218.893847,
"BUCKET":"models_user", "BUCKET":"models_user",
"KEY":"Bkhc7dupquiIFPmOSKuO0kXJC8q", "KEY":"7890yuhjk",
"TIME":0.00275 "TIME":0.00275
} }
], ],
...@@ -43,7 +43,7 @@ API'ın `Response` nesnesinde sayfaların yorumladığı datanın (`forms`, `obj ...@@ -43,7 +43,7 @@ API'ın `Response` nesnesinde sayfaların yorumladığı datanın (`forms`, `obj
client_cmd client_cmd
^^^^^^^^^^ ^^^^^^^^^^
`client_cmd` anahtarı arayüzün yapması istenen komutu taşır. Bu komutlar şunları kapsar; **list**, **form**, **show**, ``client_cmd`` anahtarı arayüzün yapması istenen komutu taşır. Bu komutlar şunları kapsar; **list**, **form**, **show**,
**reload**, **reset**. **reload**, **reset**.
- **form** gönderilen datanın `forms` nesnesi taşıdığı ve kullanıcı arayüzünün bunu form olarak yorumlaması gerektiği durumlarda kullanılır. - **form** gönderilen datanın `forms` nesnesi taşıdığı ve kullanıcı arayüzünün bunu form olarak yorumlaması gerektiği durumlarda kullanılır.
...@@ -61,17 +61,17 @@ gereklidir. ...@@ -61,17 +61,17 @@ gereklidir.
reload_cmd reload_cmd
^^^^^^^^^^ ^^^^^^^^^^
`reload_cmd` anahtarı `"client_cmd": "reload"` durumunda arayüzün backend API'dan isteyeceği komutu taşır. ``reload_cmd`` anahtarı ``"client_cmd": "reload"`` olması durumunda arayüzün backend API'dan isteyeceği komutu taşır. UI post datası içinde ``cmd`` anahtarında bu değeri gönderir.
token token
^^^^^ ^^^^^
`token` anahtarında iş akış şemasının ( *workflow* ) redis'te tutulan token değeri vardır. İş akışı tamamlanmadığı sürece bu token `request` nesnesinde API'a gönderilir. ``token`` anahtarında iş akış şemasının ( *workflow* ) redis'te tutulan token değeri vardır. İş akışı tamamlanmadığı sürece bu token `request` nesnesinde API'a gönderilir.
meta meta
^^^^ ^^^^
`meta` anahtarında arayüzde istenen yapılandırmalar yer alır. Boolean değer taşırlar. Bunlar şunlardır; ``meta`` anahtarında arayüzde istenen yapılandırmalar yer alır. Boolean değer taşırlar. Bunlar şunlardır;
- **allow_search** Listeleme ekranında arama kutusunun gösterilmesi için kullanılır. - **allow_search** Listeleme ekranında arama kutusunun gösterilmesi için kullanılır.
- **allow_selection** Listeleme ekranında tablonun solunda selectBox yer alması için kullanılır. - **allow_selection** Listeleme ekranında tablonun solunda selectBox yer alması için kullanılır.
...@@ -82,13 +82,13 @@ meta ...@@ -82,13 +82,13 @@ meta
_debug_queries _debug_queries
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
`_debug_queries` anahtarı geliştiriciler için yardımcı bir anahtardır. Veritabanına yapılan sorguların süresi ve kaç adet sorgu yapıldığı gibi değerler bu anahtarda yer alır. ``_debug_queries`` anahtarı geliştiriciler için yardımcı bir anahtardır. Veritabanına yapılan sorguların süresi ve kaç adet sorgu yapıldığı gibi değerler bu anahtarda yer alır.
Aktif olması için API ortamında çevre değişkeni DEBUG=1 olarak set edilmelidir. Aktif olması için API ortamında çevre değişkeni DEBUG=1 olarak set edilmelidir.
is_login is_login
^^^^^^^^ ^^^^^^^^
`is_login` anahtarı kullanıcının giriş yapıp yapmadığını gösteren bir anahtardır. ``is_login`` anahtarı kullanıcının giriş yapıp yapmadığını gösteren bir anahtardır.
Bu anahtar *false* değer taşıdığında arayüz login sayfasına yönlendirir. Bu anahtar *false* değer taşıdığında arayüz login sayfasına yönlendirir.
...@@ -136,34 +136,16 @@ angular-schema-form'un beklediği formatta olmalı ya da değilse extend edilere ...@@ -136,34 +136,16 @@ angular-schema-form'un beklediği formatta olmalı ya da değilse extend edilere
{ {
"forms":{ "forms":{
"constraints":{}, "constraints":{},
"model":{ "model":{ "ad":null, "soyad":null },
"ad":null,
"soyad":null,
"cinsiyet": null,
"e_posta":null,
"save_edit":null,
"nufus_kayitlari_id":null,
"dogum_tarihi":"0000-00-00T00:00:00Z",
"save_list":null
},
"grouping":{}, "grouping":{},
"form":[ "form":[
{ { "helpvalue":null, "type":"help" },
"helpvalue":null,
"type":"help"
},
"ad", "ad",
"soyad", "soyad",
{ {
"titleMap":[ "titleMap":[
{ { "name":"Bay", "value":1 },
"name":"Bay", { "name":"Bayan", "value":2 }
"value":1
},
{
"name":"Bayan",
"value":2
}
], ],
"type":"select", "type":"select",
"key":"cinsiyet", "key":"cinsiyet",
...@@ -171,60 +153,27 @@ angular-schema-form'un beklediği formatta olmalı ya da değilse extend edilere ...@@ -171,60 +153,27 @@ angular-schema-form'un beklediği formatta olmalı ya da değilse extend edilere
}, },
"e_posta", "e_posta",
"dogum_tarihi", "dogum_tarihi",
"save_edit", "save_edit"
"save_list",
"nufus_kayitlari_id", "nufus_kayitlari_id",
], ],
"schema":{ "schema":{
"required":[ "required":[ "ad", "soyad" ],
"ad",
"soyad",
"cinsiyet",
"e_posta",
"dogum_tarihi",
"save_edit",
"save_list"
],
"type":"object", "type":"object",
"properties":{ "properties":{
"ad":{ "ad":{ "type":"string", "title":"Adı" },
"type":"string", "soyad":{ "type":"string", "title":"Soyadı" },
"title":"Ad\u0131" "e_posta":{ "type":"string", "title":"E-Posta" },
}, "save_edit":{ "cmd":"save::add_edit_form", "type":"button", "title":"Kaydet" },
"soyad":{
"type":"string",
"title":"Soyad\u0131"
},
"e_posta":{
"type":"string",
"title":"E-Posta"
},
"save_edit":{
"cmd":"save::add_edit_form",
"type":"button",
"title":"Kaydet"
},
"nufus_kayitlari_id":{ "nufus_kayitlari_id":{
"list_cmd":"select_list", "list_cmd":"select_list",
"title":"N\u00fcfus Bilgileri", "title":"Nüfus Bilgileri",
"wf":"crud", "wf":"crud",
"add_cmd":"add_edit_form", "add_cmd":"add_edit_form",
"type":"model", "type":"model",
"model_name":"NufusKayitlari" "model_name":"NufusKayitlari"
}, },
"dogum_tarihi":{ "dogum_tarihi":{ "type":"date", "title":"Doğum Tarihi" },
"type":"date", "cinsiyet":{ "type":"select", "title":"Cinsiyet" }
"title":"Do\u011fum Tarihi"
},
"cinsiyet":{
"type":"select",
"title":"Cinsiyet"
},
"save_list":{
"cmd":"save::list",
"type":"button",
"title":"Kaydet ve Listele"
}
}, },
"title":"Personel" "title":"Personel"
} }
...@@ -239,26 +188,12 @@ Liste sayfası ...@@ -239,26 +188,12 @@ Liste sayfası
{ {
"forms":{ "forms":{
"constraints":{ "constraints":{},
"model":{ "add": null },
}, "grouping":{},
"model":{ "form":[ "add" ],
"add":null
},
"grouping":{
},
"form":[
{
"helpvalue":null,
"type":"help"
},
"add"
],
"schema":{ "schema":{
"required":[ "required":[ "add" ],
"add"
],
"type":"object", "type":"object",
"properties":{ "properties":{
"add":{ "add":{
...@@ -277,16 +212,11 @@ Liste sayfası ...@@ -277,16 +212,11 @@ Liste sayfası
"page":1 "page":1
}, },
"objects":[ "objects":[
[ [ "Adı", "Soyadı", "TC No", "Durum" ],
"Ad\u0131",
"Soyad\u0131",
"TC No",
"Durum"
],
{ {
"fields":[ "fields":[
"Id\u0131k", "Işık",
"\u00dclker", "Ülker",
"19189958696", "19189958696",
null null
], ],
...@@ -301,7 +231,7 @@ Liste sayfası ...@@ -301,7 +231,7 @@ Liste sayfası
}, },
{ {
"cmd":"add_edit_form", "cmd":"add_edit_form",
"name":"D\u00fczenle", "name":"Düzenle",
"show_as":"button", "show_as":"button",
"mode":"normal" "mode":"normal"
}, },
...@@ -312,244 +242,27 @@ Liste sayfası ...@@ -312,244 +242,27 @@ Liste sayfası
"mode":"normal" "mode":"normal"
} }
], ],
"key":"Aqq2O50XGqerJsfOPquqDmINbyM" "key":"1234qwer"
},
{
"fields":[
"jjgsjs",
"shkjs",
"6214614",
null
],
"actions":[
{
"fields":[
0
],
"cmd":"show",
"mode":"normal",
"show_as":"link"
},
{
"cmd":"add_edit_form",
"name":"D\u00fczenle",
"show_as":"button",
"mode":"normal"
},
{
"cmd":"delete",
"name":"Sil",
"show_as":"button",
"mode":"normal"
}
],
"key":"QkXjlwawft0MDotI6Vnqr00SNsd"
},
{
"fields":[
"Mahmut",
"Can",
"98765432101",
null
],
"actions":[
{
"fields":[
0
],
"cmd":"show",
"mode":"normal",
"show_as":"link"
},
{
"cmd":"add_edit_form",
"name":"D\u00fczenle",
"show_as":"button",
"mode":"normal"
},
{
"cmd":"delete",
"name":"Sil",
"show_as":"button",
"mode":"normal"
}
],
"key":"TILjcZZpBzbVXdFMCWkYjNMnDSi"
},
{
"fields":[
"G\u00fcle\u011fen",
"Zorlu",
"62244187555",
null
],
"actions":[
{
"fields":[
0
],
"cmd":"show",
"mode":"normal",
"show_as":"link"
},
{
"cmd":"add_edit_form",
"name":"D\u00fczenle",
"show_as":"button",
"mode":"normal"
},
{
"cmd":"delete",
"name":"Sil",
"show_as":"button",
"mode":"normal"
}
],
"key":"CDmesac2G6rk6HAhC8wyQqEdPgG"
},
{
"fields":[
"Kutun",
"Arsoy",
"63488661696",
null
],
"actions":[
{
"fields":[
0
],
"cmd":"show",
"mode":"normal",
"show_as":"link"
},
{
"cmd":"add_edit_form",
"name":"D\u00fczenle",
"show_as":"button",
"mode":"normal"
},
{
"cmd":"delete",
"name":"Sil",
"show_as":"button",
"mode":"normal"
}
],
"key":"N3CZKVlBMy0LHmlV0liEQVWCLZv"
},
{
"fields":[
"Cuheyna",
"Sezer",
"19022246095",
null
],
"actions":[
{
"fields":[
0
],
"cmd":"show",
"mode":"normal",
"show_as":"link"
},
{
"cmd":"add_edit_form",
"name":"D\u00fczenle",
"show_as":"button",
"mode":"normal"
},
{
"cmd":"delete",
"name":"Sil",
"show_as":"button",
"mode":"normal"
}
],
"key":"1GlJkQ3L4olBxsHFLGqXieWPvf5"
},
{
"fields":[
"sdf sdfs",
"24wefds",
"234234234",
null
],
"actions":[
{
"fields":[
0
],
"cmd":"show",
"mode":"normal",
"show_as":"link"
},
{
"cmd":"add_edit_form",
"name":"D\u00fczenle",
"show_as":"button",
"mode":"normal"
},
{
"cmd":"delete",
"name":"Sil",
"show_as":"button",
"mode":"normal"
}
],
"key":"TTWkO19AvQPSTYjgusRaeOSo7Wo"
},
{
"fields":[
"ali",
null,
null,
null
],
"actions":[
{
"fields":[
0
],
"cmd":"show",
"mode":"normal",
"show_as":"link"
},
{
"cmd":"add_edit_form",
"name":"D\u00fczenle",
"show_as":"button",
"mode":"normal"
},
{
"cmd":"delete",
"name":"Sil",
"show_as":"button",
"mode":"normal"
}
],
"key":"MpvUBrkK36CIntG7mU4NBpgZzzN"
} }
], ]
"client_cmd":[
"form"
],
"reload_cmd":"list",
"token":"dd6e868e87b1461f9d3d4a48eee5d2b4",
"meta":{
"attributes":{
},
"allow_search":true,
"allow_selection":false
},
"is_login":true
} }
Detay sayfası Detay sayfası
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
.. code:: json
{
"object":{
"Cep Telefonu":"+90 (259) 6925396",
"Cinsiyet":"Erkek",
"Soyadı":"Arsoy",
"TC No":"63488661696",
"Adı":"Kutun",
"Doğum Tarihi":"03.04.1969",
"E-Posta":"daslan@arsoy.com"
}
}
UI Menu ve Diğer Öğeler UI Menu ve Diğer Öğeler
======================= =======================
...@@ -559,34 +272,20 @@ UI Menu ve Diğer Öğeler ...@@ -559,34 +272,20 @@ UI Menu ve Diğer Öğeler
{ {
"ogrenci":[ "ogrenci":[
{ {
"kategori":"Se\u00e7ime Uygun G\u00f6revler", "kategori":"Seçime Uygun Görevler",
"text":"Devam Durumu", "text":"Devam Durumu",
"model":"DersKatilimi", "model":"DersKatilimi",
"param":"ogrenci_id", "param":"ogrenci_id",
"wf":"crud" "wf":"crud"
},
{
"kategori":"Se\u00e7ime Uygun G\u00f6revler",
"text":"Har\u00e7 Bilgileri",
"model":"Borc",
"param":"ogrenci_id",
"wf":"crud"
} }
], ],
"personel":[ "personel":[
{ {
"kategori":"Se\u00e7ime Uygun G\u00f6revler", "kategori":"Seçime Uygun Görevler",
"text":"Kimlik ve Iletisim Bilgileri", "text":"Kimlik ve Iletisim Bilgileri",
"model":"Personel", "model":"Personel",
"param":"object_id", "param":"object_id",
"wf":"kimlik_ve_iletisim_bilgileri" "wf":"kimlik_ve_iletisim_bilgileri"
},
{
"kategori":"Se\u00e7ime Uygun G\u00f6revler",
"text":"Hizmet Cetveli",
"model":"HizmetKayitlari",
"param":"personel_id",
"wf":"crud"
} }
], ],
"settings":{ "settings":{
...@@ -599,13 +298,6 @@ UI Menu ve Diğer Öğeler ...@@ -599,13 +298,6 @@ UI Menu ve Diğer Öğeler
"model":"Personel", "model":"Personel",
"param":"other_id", "param":"other_id",
"wf":"crud" "wf":"crud"
},
{
"kategori":"Genel",
"text":"Ogrenciler",
"model":"Ogrenci",
"param":"other_id",
"wf":"crud"
} }
], ],
"current_user":{ "current_user":{
...@@ -623,7 +315,7 @@ UI Menu ve Diğer Öğeler ...@@ -623,7 +315,7 @@ UI Menu ve Diğer Öğeler
], ],
"role":"BaseAbsRole", "role":"BaseAbsRole",
"is_student":false, "is_student":false,
"avatar":"http://ulakbus.3s.ulakbus.net/a861758aabec44a2a2b925b88fc718e2.jpg" "avatar":"http://ulakbus.3s.ulakbus.net/abcd.jpg"
}, },
"is_login":true, "is_login":true,
"quick_menu":[ "quick_menu":[
...@@ -633,24 +325,6 @@ UI Menu ve Diğer Öğeler ...@@ -633,24 +325,6 @@ UI Menu ve Diğer Öğeler
"model":"Program", "model":"Program",
"param":"other_id", "param":"other_id",
"wf":"crud" "wf":"crud"
},
{
"kategori":"Kadro Islemleri",
"text":"Kadro \u0130\u015flemleri",
"param":"id",
"wf":"kadro_islemleri"
},
{
"kategori":"Genel",
"text":"Akademik Takvim",
"param":"id",
"wf":"akademik_takvim"
},
{
"kategori":"Genel",
"text":"Ders Ekle",
"param":"id",
"wf":"ders_ekle"
} }
] ]
} }
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment