ags forms
ags forms komutu, kullanıcının kimlik bilgilerini girdiği giriş formlarını yönetir: formun adı, başlığı, açıklaması ve içindeki alanlar. Panel karşılığı Login Forms ekranıdır.
Form, erişim akışının form adımıdır. Kullanıcının girdiği değerler akışa geçer ve kimlik doğrulama adımı bunları %AGS_USER_INPUT(alan adı) ifadesiyle kullanır; bu yüzden form alanlarının adları, sağlayıcının beklediği adlarla uyuşmalıdır.
Komut Özeti
Yazım Sırası
ags forms add name giris-formuZorunlu tek alan addır, ancak alansız bir form kabul edilmez: en az bir form alanı verilmelidir.
--fields.0.fieldType text --fields.0.fieldName username--fields.0.label.type universal --fields.0.label.text "Kullanıcı adı"ags gateway update id <vService> --actions.0.actionType agsForms --actions.0.actionProfileId <form>Zorunlu Alanlar
| Sıra | Alan | Durum | Değer |
|---|---|---|---|
| 1 | name | Zorunlu | Formun benzersiz adı |
| — | --fields.0.… | En az bir alan | Tamamlama listesinde isteğe bağlı görünür, ancak alansız form kabul edilmez |
Çok Dilli Metin Alanları
Kullanıcıya görünen her metin (title, description, alan etiketi, ipucu, yardım metni, buton metni, seçenek metni, ayraç metni, bilgi metni) aynı kalıbı kullanır: önce tür, sonra türe göre içerik.
| Tür | İçerik alanı | Anlamı |
|---|---|---|
universal | .text | Tüm dillerde aynı metin (varsayılan tür) |
localized | .key | Sözlükten çözülen anahtar; çeviri Dictionaries ekranından gelir |
default | — | Sistemin hazır metni kullanılır |
none | — | Metin gösterilmez |
Metin alanlarının üç parçası
Kalıbı kullanan her metin, komut satırında üç alana açılır. Aşağıdaki tabloda <metin> yerine ilgili alan adı yazılır.
| Alan | Ne yapar | Arkasına ne yazılır |
|---|---|---|
--<metin>.type | Metnin nereden geleceğini seçer | universal (varsayılan) · localized · default · none |
--<metin>.text | Metni doğrudan yazar | Görünecek metin; yalnız type universal iken açılır |
--<metin>.key | Metni sözlükten çağırır | Sözlükteki anahtar; yalnız type localized iken açılır |
Kalıbı kullanan metinler ve tam alan adları:
| Metin | Alan adları |
|---|---|
| Form başlığı | --title.type · --title.text · --title.key |
| Form açıklaması | --description.type · --description.text · --description.key |
| Alan etiketi | --fields.N.label.type · --fields.N.label.text · --fields.N.label.key |
| Alan ipucu | --fields.N.placeholder.type · --fields.N.placeholder.text · --fields.N.placeholder.key |
| Alan yardım metni | --fields.N.helpText.type · --fields.N.helpText.text · --fields.N.helpText.key |
| Seçenek metni | --fields.N.options.M.text.type · --fields.N.options.M.text.text · --fields.N.options.M.text.key |
| Gönder düğmesi metni | --fields.N.buttonText.type · --fields.N.buttonText.text · --fields.N.buttonText.key |
| Buton grubundaki düğme metni | --fields.N.buttons.M.text.type · --fields.N.buttons.M.text.text · --fields.N.buttons.M.text.key |
| Bilgi metni | --fields.N.content.type · --fields.N.content.text · --fields.N.content.key |
| Ayraç metni | --fields.N.dividerText.type · --fields.N.dividerText.text · --fields.N.dividerText.key |
Alan Türleri
| Alan | Ne yapar | Arkasına ne yazılır |
|---|---|---|
--fields.N.fieldType | Form alanının türünü seçer; türe özel ayarlar buna göre açılır | Aşağıdaki on sekiz değerden biri |
Türe göre ek ayarlar değişir:
fieldType | Panel adı | Türe özel ayarlar |
|---|---|---|
text | Text | validationPattern · minLength · maxLength |
password | Password | minLength · maxLength |
email | — | |
number | Number | min · max |
textarea | Multi-line text | rows (varsayılan 4) · minLength · maxLength |
select | Single select | options.N.value · options.N.text.… |
multipleSelect | Multiple select | options.N.value · options.N.text.… |
file | File | accept · maxSize |
date · time · datetime | Date · Time · Date and time | — |
checkbox | Checkbox | — |
hidden | Hidden field | hiddenValue |
submitButton | Submit button | buttonText.… · buttonStyle · buttonIcon · submitBehavior · submitData.N.key · submitData.N.value |
infoText | Information text | content.… |
divider | Divider | dividerText.… |
customHtml | HTML content | htmlContent |
buttonGroup | Button group | layout · columns · buttons.N.… |
Alt nesne alanları her türde listelenir
options, buttons, submitData, content gibi alt alanlar tamamlama listesinde alan türünden bağımsız görünür. İlgisiz bir türde yazılmaları bir işe yaramaz; yukarıdaki tablo hangi ayarın hangi türe ait olduğunu gösterir.
Tüm Alanlarda Ortak Ayarlar
| Ayar | Varsayılan | Notlar |
|---|---|---|
--fields.N.fieldName | — | Alanın akıştaki adı; harfle başlar, harf, rakam ve alt çizgi içerir. divider, infoText ve customHtml türlerinde bulunmaz |
--fields.N.label.… · --fields.N.placeholder.… · --fields.N.helpText.… | Metin kalıbı | Etiket, ipucu ve yardım metni |
--fields.N.required | false | Kullanıcının doldurması zorunlu mu; buton, ayraç, bilgi metni ve gizli alanlarda yok |
--fields.N.defaultValue | — | Alanın açılışta taşıyacağı değer; buton, ayraç, bilgi metni, gizli alan ve buton grubunda yok |
--fields.N.cond | Koşulsuz | Alan yalnız koşul sağlandığında gösterilir |
--fields.N.assignToUserFields.0 | userId | Alanın değerinin kopyalanacağı kullanıcı oturum alanı; text, email, number, select ve hidden türlerinde geçerli |
--fields.N.assignToUserFields.N şu değerleri alır: userId, username, email, displayName, firstName, lastName, phone, picture, locale, timezone, company, department, title, employeeId, groups.
--fields.N.validationPattern yalnız text türünde geçerlidir ve şu değerleri alır: None, email, domain, ip, port, url, alphanumeric, numeric.
Türe Özel Alanların Tam Listesi
Yukarıdaki tabloda kısaca verilen ayarların tam alan adları, ne yaptıkları ve hangi alan türünde açıldıkları:
| Alan | Ne yapar | Arkasına ne yazılır | Hangi türde |
|---|---|---|---|
--fields.N.validationPattern | Girilen değerin biçimini denetler | None · email · domain · ip · port · url · alphanumeric · numeric | text |
--fields.N.minLength · --fields.N.maxLength | Girilecek metnin en kısa ve en uzun uzunluğunu sınırlar | Karakter sayısı | text · password · textarea |
--fields.N.rows | Çok satırlı alanın kaç satır görüneceğini belirler | Satır sayısı (varsayılan 4) | textarea |
--fields.N.min · --fields.N.max | Girilecek sayının alt ve üst sınırını belirler | Sayı | number |
--fields.N.options.M.value | Seçeneğin arka planda taşıyacağı değeri belirler | Değer; en az bir seçenek gerekir | select · multipleSelect |
--fields.N.accept | Yüklenebilecek dosya türlerini sınırlar | Dosya türü listesi, örneğin .pdf,.png | file |
--fields.N.maxSize | Yüklenebilecek en büyük dosya boyutunu belirler | Boyut | file |
--fields.N.buttonStyle | Gönder düğmesinin görünümünü seçer | primary (varsayılan) · secondary · danger · success · custom | submitButton |
--fields.N.buttonIcon | Gönder düğmesinin simgesini belirler | Simge adı | submitButton |
--fields.N.submitBehavior | Gönderimde hangi verinin taşınacağını seçer | fullForm formun tamamı (varsayılan) · merge forma ek veri katar · override yalnız verilen veriyi gönderir | submitButton |
--fields.N.submitData.M.key · --fields.N.submitData.M.value | Gönderime eklenecek ad ve değer çiftlerini yazar | Alan adı ve değeri | submitButton, submitBehavior merge ya da override iken |
--fields.N.htmlContent | Forma gömülecek HTML içeriğini yazar | HTML metni | customHtml |
--fields.N.hiddenValue | Gizli alanın taşıyacağı değeri yazar | Değer | hidden |
--fields.N.layout | Buton grubundaki düğmelerin nasıl diziliceğini seçer | horizontal (varsayılan) · vertical · grid | buttonGroup |
--fields.N.columns | Izgara yerleşiminde sütun sayısını belirler | Sayı (varsayılan 2); yalnız --fields.N.layout grid iken açılır | buttonGroup |
--fields.N.buttons.M.value | Düğmeye basıldığında gönderilecek değeri belirler | Değer | buttonGroup |
--fields.N.buttons.M.cond | Düğmenin yalnız belirli durumda görünmesini sağlar | Koşul ifadesi | buttonGroup |
--fields.N.buttons.M.icon | Düğmenin simgesini belirler | Simge adı | buttonGroup |
--fields.N.buttons.M.style | Düğmenin görünümünü seçer | primary · secondary (varsayılan) · danger · success · custom | buttonGroup |
--fields.N.buttons.M.backgroundColor · --fields.N.buttons.M.textColor | Düğmenin arka plan ve yazı rengini belirler | Renk değeri; style custom seçildiğinde kullanılır | buttonGroup |
Örnekler
Güncelleme ve Silme
Güncelleme kimliği id alanıyla ister ve yalnız yazılan alanları değiştirir. Alan listesi indeksle güncellenir; --fields.delete listenin tamamını boşaltır.
Bilinmesi Gerekenler
- Alan adları sağlayıcıyla uyuşmalıdır. Kimlik doğrulama sağlayıcıları varsayılan olarak
usernamevepasswordadlarını bekler; farklı ad kullanılacaksa sağlayıcının kullanıcı adı ve parola ifadeleri de güncellenmelidir. - Alansız form kabul edilmez. Alan listesi tamamlama listesinde isteğe bağlı görünse de en az bir alan gerekir; alansız komut hata döner.
- Sıra indeks sırasıdır. Alanların formda görünme sırası
--fields.0,--fields.1… indekslerine göredir; araya alan eklemek indekslerin yeniden yazılmasını gerektirir. - Boşluklu metinler tırnak ister. Etiket ve başlık gibi boşluk içeren değerler çift tırnakla yazılır.
- Form tek başına çalışmaz. Ağ geçidinin akışına form adımı olarak eklenene kadar kullanılmaz.
