Doğrulama
Model denetimleri
Tüm model üzerinde 75 kurala dayalı denetimi ve kendi kural kümelerinizi çalıştırın, bulguları önem derecesine, sınıfa, kurala ve etikete göre daraltın, yerinde düzeltin, kasıtlı olanları yok sayın ve her kuralın ne kadar katı olacağını ayarlayın.
Bu sayfada
Genel bakış
Doğrulama → Model denetimleri, projedeki her öğe üzerinde bir kural kataloğu çalıştırır ve her kuralın bulduklarını listeler. Kurallar, bir modele güvenmeyi veya onu incelemeyi zorlaştıran boşlukları arar: eksik adlar ve numaralar, tek başına duran öğeler, kimsenin gerçekleştirmediği eylemler, hiçbir şey taşımayan arayüzler, tahsis edilmemiş veya doğrulanmamış gereksinimler, ele alma planı olmayan riskler ve eşiklerini tutturamayan ölçüler.
Denetimler model her değiştiğinde yeniden çalışır; böylece sayfa, Ana sayfadaki Model denetimleri kartı ve Doğrulama üzerindeki rozet her zaman uyuşur.
Kavramlar
- Kural: bir numarası (örneğin Requirement.10), bulduğunu adlandıran bir başlığı, iyi bir modelin neye benzediğini anlatan bir ifadesi ve bir düzeltmesi olan tek bir denetim. Kurallar denetledikleri sınıfa göre gruplanır: Global (her öğe), Action, Asset, Conduit, Input/Output, Requirement, Risk, Test Case ve Measure.
- Bulgu: tek bir kuralı ihlal eden tek bir öğe. Bir bulgu ilgili öğeleri adlandırabilir; örneğin bir adın kopyalarını veya bir üst öğenin alt öğelerini.
- Önem derecesi: her kural Hata veya Uyarı olarak raporlar ya da Yok say olarak ayarlanır ve çalışmaz. Varsayılan Uyarı'dır; şema kopyası LML 2.0'dan eski olan bir projedeki LML 2.0 kuralları Global.10 ve Global.11 hariç (bkz. Kurallar).
- Yok sayılan bulgu: bir öğe için kabul ettiğiniz bir bulgu. Artık sayılmaz ve Yok sayılanları göster onu Geri yükle ile listeler.
- Uygulanabilir denetim: kendi sınıfından en az bir öğe üzerinde çalışan bir kural. Başlık satırı, kaç uygulanabilir denetimin bulgusu olmadığını sayar.
- Kural kümesi: kendi kurallarınızdan oluşan, projede saklanan ve bütün olarak açılıp kapatılan adlandırılmış bir grup. Kuralları yerleşik denetimlerle birlikte çalışır ve bulguları aynı listeyi, Düzelt ve Yok say'ı kullanır. Bkz. Kural kümeleri.
Nasıl kullanılır
Denetimleri her incelemeden önce, büyük bir içe aktarmadan sonra ve Ana sayfa model denetimi hataları gösterdiğinde çalıştırın. Tek bir soruyu yanıtlarlar: başka biri okumadan önce modelde neyin ilgilenilmesi gerekiyor?
Bulgular üzerinde çalışma
- Doğrulama → Model denetimleri'ni açın. Başlık satırı örneğin “Uygulanabilir denetimlerin %84'ü geçiyor” gösterir; ardından hata ve uyarı sayısı ile son çalıştırmadan bu yana değişim gelir.
- Liste kurala göre gruplanır, önce hatalar. Açmak için bir kural başlığına tıklayın; açıklaması kuralın neden önemli olduğunu söyler.
- Her bulgu için Düzelt'e tıklayın. Düzeltme iletişim kutusu öğeyi, kuralı ve önerilen düzeltmeyi gösterir: doldurulacak bir alan, eklenecek ilişkiler, birleştirilecek kopyalar veya öğeyi ya da diyagramını açan bir düğme.
- Düzeltmeyi kaydedin. Bulgu kaybolur ve sayılar güncellenir.
- Bir bulgu kasıtlı olduğunda (örneğin iki üst öğe altında yeniden kullanılan bir eylem) Yok say'a tıklayın.
Tek bir alana odaklanma
- Yalnızca hataları görmek için soldaki fasetlerde Önem derecesi altında Hatalar'ı işaretleyin.
- Sınıf altında bir sınıfı (bulgusu olan öğenin sınıfı), Kural altında bir kuralı veya Etiket altında bir etiketi işaretleyin. Bir fasetteki işaretler VEYA ile, fasetler VE ile birleşir. Her değer kaç bulgusu olduğunu gösterir.
- Bir öğe adını veya kural başlığını eşleştirmek için Bulguları filtrele'ye yazın.
- Her şeyi yeniden göstermek için Faset filtrelerini temizle'ye tıklayın.
Bir öğenin bulgularını birlikte inceleme
- Filtrenin yanında Nesneye göre gruplandır'ı seçin.
- Her öğe tüm bulgularıyla birlikte bir kez, numara sırasıyla listelenir. Hatası olan bir öğe başlığında bir Hata rozeti gösterir.
Uygulamalı örnek: CubeSat EO-1 demosu
- CubeSat EO-1 demo projesini açın ve Doğrulama → Model denetimleri'ne gidin.
- Sınıf altında Requirement'ı işaretleyin. Kalan kurallar hangi gereksinimlerin üst öğesi olmadığını, tahsisi olmadığını (Requirement.8) veya doğrulayan test senaryosu olmadığını (Requirement.10) gösterir.
- Requirement.10'u açın, bir bulguda Düzelt'e tıklayın ve onu doğrulayan test senaryosunu bağlayın. Bulgu listeden çıkar ve başlık satırı yükselir.
- Bir gereksinimin kalan tüm bulgularını aynı anda görmek için Nesneye göre gruplandır'ı seçin.
Kendi kuralınızı yazma
- Sayfa başlığında Kural kümeleri…'ne, ardından + Yeni kural kümesi'ne tıklayın. Kümeyi adlandırın, örneğin “Program Rules”, ve Tamam'a tıklayın.
- Kümenin altında + Kural ekle'ye tıklayın. Kural düzenleyici R1 kimliğiyle açılır.
- Kuralın ne bulduğunu söyleyen bir Ad yazın, örneğin “Doğrulayan test senaryosu olmayan gereksinimler”.
- Uygulandığı öğeler içinde Requirement'ı seçin.
- Şu durumda öğeyi raporla içinde Bir ilişki eksik'i seçin, ardından İlişki içinde verified by'ı seçin.
- Önem derecesi'ni Hata olarak ayarlayın ve Mesaj'ı yazın, örneğin “Gereksinimi doğrulayan test senaryosunu bağlayın.”
- Alanların altındaki önizlemeyi okuyun, örneğin “Şu anda 3 öğe raporlanıyor: SYS-2 Top Speed, …”. Kaydet'e tıklayın.
- Kapat'a tıklayın. Kuralın bulguları listede R1 altında, önce hatalar olmak üzere görünür. Bir test senaryosu bağlamak için Düzelt'e tıklayın; bulgu listeden çıkar.
Birimlerle bir kütle bütçesini denetleme
- CubeSat EO-1 demosunda Kural kümeleri…'ni açın, + Yeni kural kümesi'ne tıklayın ve onu “Mass Budget” olarak adlandırın.
- + Kural ekle'ye tıklayın. Onu “Kütle tahsisini aşan montajlar” olarak adlandırın ve Uygulandığı öğeler içinde Asset'i seçin.
- Şu durumda öğeyi raporla içinde İlgili değerlerin toplamı bir değerle karşılaştırılır'ı seçin. İşlev'i Toplam, İlişki'yi decomposed by, Her ilgili öğenin değeri'ni Mass, Karşılaştırma'yı is more than ve Şununla karşılaştır'ı Mass Allocation olarak ayarlayın.
- Önem derecesi'ni Hata olarak ayarlayın ve Kaydet'e, ardından Kapat'a tıklayın.
- Parçaları tahsisinden ağır gelen bir montaj listelenir; örneğin “Total Mass of “decomposed by” 2.34 kg is more than Mass Allocation 1.35 kg”. Gram ve kilogram cinsinden kütleler toplanır; metre cinsinden girilmiş bir kütle “Cannot add mass and length: the dimensions differ (kg vs m).” (kütle ve uzunluk toplanamaz: boyutlar farklı) olarak listelenir.
Kuralları başka bir projeyle paylaşma
- Kural kümeleri… içinde kümenin yanındaki Dışa aktar'a tıklayın.
program-rules.holarch-rules.jsongibi adlandırılmış bir dosya indirilir. - Diğer projede Kural kümeleri…'ni açın, İçe aktar…'a, ardından Dosya seç…'e tıklayın (veya dosyanın metnini yapıştırın) ve İçe aktar'a tıklayın.
- Bir kitaplık üzerinden paylaşmak için kural kümelerini kitaplık projesinde tutun ve bir sürüm yayımlayın. Kitaplığı kullanan bir projede Kitaplıktan…'a tıklayın, kümeleri işaretleyin ve Kopyala'ya tıklayın.
- Kitaplık, kümeyi içeren daha yeni bir sürüm yayımladığında Kural kümeleri… kopyanın yanında “Daha yeni bir sürüm var” gösterir. Güncelle…'ye tıklayın, değişiklikleri gözden geçirin, her iki yerde de değişen her kural için Benimkini koru veya Kitaplığınkini al'ı seçin ve Güncelle'ye tıklayın. Kopyada yaptığınız diğer düzenlemeler korunur.
İpuçları
- Ekibinizin engelleyici saydığı kuralları Ayarlar'da Hata olarak ayarlayın; böylece Ana sayfa onları sorun olarak listeler.
- Bir bulguyu yalnızca kasıtlı olduğunda yok sayın ve nedenini öğenin açıklamasında veya bir yorumda belirtin. Yok sayılanları göster, gözden geçirenlerin neyin kabul edildiğini görmesini sağlar.
- Bir içe aktarmadan sonraki uzun bir adlandırma bulguları listesi genellikle en hızlı, adları Veritabanı'nda düzenleyerek düzeltilir.
- Temel çizginin bilinen boşlukları taşımaması için temel çizgiyi kaydetmeden önce denetimleri çalıştırın.
Sayfa
Sayfa başlığı
| Denetim | Ne yapar |
|---|---|
| Dışa aktar… | Dışa aktarma iletişim kutusunu Findings (CSV) ile açar: kural, önem derecesi, başlık, öğe kimliği, numara, ad, sınıf, not ve ilgili öğelerle birlikte yok sayılmamış her bulgu. |
| Ayarlar | Her kuralın önem derecesini ve düzey başına alt öğe sayısını ayarlar (bkz. Ayarlar). |
| ↻ Denetimleri çalıştır | Her denetimi yeniden çalıştırır ve sayıları son çalıştırma olarak kaydeder. |
Başlık satırı
- “Uygulanabilir denetimlerin %N kadarı geçiyor”: herhangi bir bulgu hata olduğunda kırmızı, yalnızca uyarılar olduğunda kehribar, düzeltilecek bir şey olmadığında yeşil.
- Bulgu, hata ve uyarı sayısı.
- Bu cihazdaki son çalıştırmadan bu yana değişim; örneğin “Son çalıştırmadan 3 bulgu daha az.” Son çalıştırma, sayfayı açtığınızda veya sayfadan ayrıldığınızda ve ↻ Denetimleri çalıştır'a tıkladığınızda kaydedilir. İlk ziyarette “Bu cihazda ilk çalıştırma.” yazar.
Büyük bir projede denetimler arka planda çalışır, böylece sayfa kullanılabilir kalır: ilk ziyaret “Model denetimleri çalıştırılıyor…” gösterir, sonraki ziyaretler yenileri hazır olana kadar önceki bulguları gösterir ve bir saniyeden uzun süren bir çalıştırmayı bir ilerleme kartı gösterir.
Araç çubuğu
- Kurala göre gruplandır (varsayılan) veya Nesneye göre gruplandır. Seçim bu cihazda hatırlanır.
- Bulguları filtrele: öğe adlarını, kural numaralarını ve kural başlıklarını eşleştirir.
- Tümünü genişlet ve Tümünü daralt her grubu açar veya kapatır.
Fasetler
| Faset | Değerler |
|---|---|
| Önem derecesi | Hatalar, Uyarılar |
| Sınıf | Bulgusu olan her öğenin sınıfı |
| Kural | Bulgusu olan her kural, numarası ve başlığıyla |
| Etiket | Bulgusu olan bir öğedeki her etiket |
| Yok sayıldı | Yok sayılanları göster, yok sayılan bulguları Yok sayıldı olarak işaretli ve Geri yükle ile listeye ekler |
Sayılar diğer fasetleri ve filtreyi izler; böylece bir değeri işaretlemenin geriye ne bırakacağını gösterir.
Bulgular
Her bulgu öğeyi (veya nesneye göre gruplandığında kuralı), notu (örneğin “Vague words: adequate, TBD” veya “14 children”), ilgili öğeleri ve Düzelt ile Yok say düğmelerini ya da yok sayılan bir bulgu için Geri yükle'yi gösterir. Tek bir Geri al bir Yok say veya Geri yükle işlemini geri alır.
Düzeltmeler
| Düzeltme | Kullanan | Ne yapar |
|---|---|---|
| Bir alanı düzenle | Eksik ad, numara veya açıklama; fiil ve isim denetimleri | Alanı geçerli değerle açar. |
| Büyük harf yap | Küçük harfli adlar | Adı büyük ilk harfle önerir. |
| İlişki ekle | Eksik üst öğe, gerçekleştiren, girdiler, çıktılar, kanallar, standartlar, izler | Şemanın ilişki için izin verdiği öğeleri listeler; onları işaretleyin ve İlişki ekle'ye tıklayın. |
| Birleştir | Benzer adlar, tek alt öğeler | Bir öğeyi tutar, diğerlerinin her ilişkisini ona taşır, açıklamaları birleştirir ve diğerlerini siler (tek bir Geri al ile hepsi geri alınır). |
| İlgilileri sil | Kullanıldıktan sonra üretilen bir girdiye sahip eylemler | Var olmadan önce tüketilen girdi/çıktıları siler. |
| traced to ekle | İlgisiz nesneleri adlandıran gereksinimler | Gereksinimden metninin adlandırdığı her öğeye traced to ekler. |
| Issue oluştur | Bağlı Issue öğesi olmayan başarısız test senaryoları | Test senaryosuna ve doğruladığı gereksinimlere bağlı bir Issue oluşturur. |
| Açılış | Uzun alt öğe listeleri, alışverişler, standartlar, eşikler, şemanın izin vermediği ilişkiler | Öğeyi veya diyagramını açar. |
| UAF görünümünü aç | Gösterilemeyen UAF görünümleri | Kökün görünümlerini sorunlarıyla listeler ve ilkini açar. |
Ayarlar
- Düzey başına alt öğe: Action.9 ve Asset.9, bu sayıdan fazla alt öğesi olan bir üst öğeyi raporlar. Varsayılan, insanların bir düzeyde yaklaşık 7 ± 2 öğeyle başa çıktığı yönergesinden gelen 9'dur. İzin verilen değerler 2 ile 99 arasıdır; başka bir değer “Düzey başına alt öğe sayısı 2 ile 99 arasında bir tam sayı olmalıdır.” gösterir.
- Kural başına önem derecesi: Hata, Uyarı veya Yok say. Yok sayılan bir kural çalışmaz.
- Varsayılanları geri yükle her kuralı varsayılanına (Uyarı; Requirement.11 Yok say; şema kopyası LML 2.0'dan eski olan bir projede Global.10 ve Global.11 Yok say) ve düzey başına alt öğe sayısını 9'a geri döndürür.
Ayarlar projede saklanır, projedeki herkesle paylaşılır ve geri alınabilir.
Kural kümeleri
Sayfa başlığındaki Kural kümeleri…, Kural kümeleri iletişim kutusunu açar. Kendi kurallarınız Model denetimleri'nde yerleşik denetimlerle birlikte çalışır: bulguları kuralın kimliğini (örneğin R1) ve adını gösterir, başlık satırında sayılır, fasetlerde Kural altında görünür ve her bulgu gibi Düzelt, Yok say ve Dışa aktar…'ı kullanır. Kural kümeleri projede saklanır, projedeki herkesle paylaşılır ve her değişiklik tek bir geri alma adımıdır.
Kural kümeleri iletişim kutusu
| Denetim | Ne yapar |
|---|---|
| + Yeni kural kümesi | Bir ad sorar ve açık durumda boş bir küme ekler. |
| İçe aktar… | Bir kural kümesi dosyasının kural kümelerini ekler: Dosya seç… veya metnini yapıştırın, ardından İçe aktar. Her kural önce denetlenir; sorunlu bir dosya reddedilir ve sorunlar listelenir. Zaten kullanılan bir ad “ (2)” alır. |
| Kitaplıktan… | Bu projenin kullandığı kitaplıkların sürümlerindeki kural kümelerini listeler; onları işaretleyin ve Kopyala'ya tıklayın. Kopya, kitaplığını ve sürümünü hatırlar. |
| Güncelle… | Kitaplığı kümeyi içeren daha yeni bir sürüm yayımladığında kopyalanmış bir kümenin yanında (“Daha yeni bir sürüm var”). Kitaplıkta eklenen, değişen ve kaldırılan kuralları, yaptığınız ve korunan düzenlemeleri ve hem burada hem kitaplıkta değişen kuralları önizler; bunların her biri için Benimkini koru veya Kitaplığınkini al'ı seçin, ardından Güncelle'ye tıklayın. Tek bir Geri al ile hepsi geri alınır. |
| Bir kümenin yanındaki onay kutusu | Kümeyi açar veya kapatır. Kapalı bir küme çalışmaz. |
| Yeniden adlandır… | Kümeyi yeniden adlandırır. |
| Dışa aktarma | Kümeyi bir JSON kural kümesi dosyası olarak indirir. |
| Sil | Bir onaydan sonra kümeyi ve kurallarını siler. Geri al onları geri yükler. |
| + Kural ekle, Düzenle, Sil | Kümeye bir kural ekleyin, değiştirin veya silin. |
Bu projede çalışamayan bir kural, örneğin şemada bulunmayan bir sınıfı veya ilişkiyi adlandıran bir kural, sorunu adının altında kırmızıyla gösterir ve hiçbir şey raporlamaz.
Kural düzenleyici
| Alan | Ayarladığı |
|---|---|
| Ad | Kuralın bulgularının başlığı: kuralın ne bulduğu. |
| Kimlik | Kümede kısa ve benzersiz, örneğin R1 veya SYS-NUM; en fazla 40 harf, rakam, nokta, tire ve alt çizgi. |
| Uygulandığı öğeler | Herhangi bir öğe, bir sınıf (alt sınıflar dahil: bir Test Case aynı zamanda bir Action'dır) veya bir SysML v2 projesinde Part ya da Requirement gibi bir model türü. |
| Yalnızca eşleşen öğeler | İsteğe bağlı: öğeleri önce daraltan, Veritabanı filtre dilinde bir filtre; örneğin is:leaf. |
| Şu durumda öğeyi raporla | Koşul, aşağıda. |
| Önem derecesi | Hata veya Uyarı. |
| İleti | Düzeltme iletişim kutusunda gösterilen, yapılacak düzeltme. |
Alanların altındaki satır, kuralın şu anda kaç öğe raporladığını söyler ve ilk beşini adlandırır.
| Koşul | Alanlar | Şu durumda öğeyi raporlar |
|---|---|---|
| Bir öznitelik boş | Öznitelik | Özniteliğin değeri yoktur. |
| Bir öznitelik bir desenle eşleşiyor | Öznitelik, Desen, Büyük/küçük harfi yoksay | Özniteliğin metni, bir düzenli ifade olan desenin bir eşleşmesini içerir. |
| Bir öznitelik bir desenle eşleşmiyor | Öznitelik, Desen, Büyük/küçük harfi yoksay | Özniteliğin metninde eşleşme yoktur; örneğin SYS- ile başlaması gereken numaralar için ^SYS-\d+$. |
| Bir ilişki eksik | İlişki, Şu öğelerden | Öğenin o ilişkiden (o sınıfın öğelerine) bir bağlantısı yoktur. |
| Bir ilişki mevcut | İlişki, Şu öğelerden | Öğenin böyle bir bağlantısı vardır. |
| İlgili öğe sayısı en az N | İlişki, Şu öğelerden, N | Öğenin N veya daha fazla ilgili öğesi vardır; örneğin 9'dan fazla alt öğe. |
| İlgili öğe sayısı en fazla N | İlişki, Şu öğelerden, N | Öğenin N veya daha az ilgili öğesi vardır. |
| Bir değer aralığın dışında | Öznitelik, En küçük, En büyük, Birim | Özniteliğin sayısı en küçük değerin altında veya en büyük değerin üstündedir. Açık bir aralık için bir sınırı boş bırakın. |
| Bir değer aralığın içinde | Öznitelik, En küçük, En büyük, Birim | Özniteliğin sayısı, sınırlar dahil, aralığın içindedir. |
| İlgili değerlerin toplamı bir değerle karşılaştırılır | İşlev, İlişki, Şu öğelerden, Her ilgili öğenin değeri, Karşılaştırma, Şununla karşılaştır | İlgili öğeler üzerindeki bir değerin Toplam, En küçük veya En büyük değeri (ya da Öğe sayısı), öğenin bir özniteliğinden (örneğin Mass Allocation) veya birimiyle birlikte bir değerden (12 kg) büyüktür, en az ona eşittir, küçüktür, en fazla ona eşittir, eşittir ya da farklıdır. Değeri olmayan ilgili öğeler atlanır. |
| Bir ifade eşleşiyor | İfade | Öğe ifadeyle eşleşir. |
Öznitelikler öğedeki gibi adlandırılır: Ad, Numara ve Açıklama (bir SysML v2 projesinde Short Name ve Belgeler) veya sınıfın herhangi bir özniteliği. Bir SysML v2 projesinde, elemanın mass gibi bir öznitelik kullanımı da adlandırılabilir. Sınıfında böyle bir öznitelik olmayan bir öğe atlanır. Bir LML öğesinin değerleri, specified by ile bağlı olduğu karakteristikleri (Value 2.4 ve Units kg olan bir Mass karakteristiği 2.4 kg olarak okunur) ve bütçe tahsislerini (Bütçeler'den Mass Allocation) de içerir. Bir Birim olmadan, bir aralık değerin baştaki sayısını okur (1,500 kg ve 1500 [kg] 1500 olarak okunur) ve sayı olmayan değerleri atlar. kg gibi bir Birim ile değerler önce dönüştürülür (25000 g 25 kg olarak okunur) ve 3 m gibi başka türden bir değer kendi başına bir bulgudur: “Cannot compare length and mass: the dimensions differ (m vs kg).” (uzunluk ve kütle karşılaştırılamaz: boyutlar farklı). Toplamlar ve ifadeler birimleri aynı şekilde dönüştürür ve bir uyumsuzluğu aynı şekilde raporlar; asla sessiz bir karşılaştırma olarak değil.
İfade kuralları
Bir ifade, Veritabanı filtre çubuğunun filtre dilinde yazılır; böylece orada sorunlu öğeleri bulan bir filtre bir kural olarak çalışır: eşleşen her öğe raporlanır. Örnekler:
| İfade | Raporlar |
|---|---|
class:Requirement is:leaf NOT relationship:"verified by" | Hiçbir test senaryosunun doğrulamadığı yaprak gereksinimler. |
class:Requirement Requirement:"Status=Draft" | Hâlâ Draft durumundaki gereksinimler. |
class:Action is:root NOT relationship:"performed by" | Hiçbir şeyin gerçekleştirmediği en üst düzey eylemler. |
class:Asset (name:%TBD% OR description:TBD) | Adında veya açıklamasında TBD olan varlıklar. |
class:Asset value:"sum(decomposed by → Mass) > Mass Allocation" | Parçaları, herhangi bir birim karışımında, tahsislerinden ağır gelen montajlar. |
Birimlerle aritmetik: value:"Mass * 1.1 <= 12 kg" veya value:"sum(decomposed by → Mass) > Mass Allocation", öğenin değerlerini ve ilgili öğeleri üzerindeki toplamları (sum, min, max, count) +, -, *, /, parantezler ve sayılardan sonra birimlerle (12 kg, 9.81 [m/s^2]) karşılaştırır. Asset:"Mass>2 kg" gibi birimli öznitelik karşılaştırmaları da dönüştürülür.
Terimler: serbest metin, name: (% herhangi bir metinle eşleşir), number: (* herhangi bir metinle eşleşir), description:, class:, label:, relationship:"…", status:, id:, under:"<number>", is:root, is:leaf, is:orphan, is:top, is:locked, is:diagram, Requirement:"Priority>=3" gibi öznitelik karşılaştırmaları (=, ~ içerir, <, <=, >, >=; değersiz = boş anlamına gelir), AND, OR, NOT ve parantezler. Projede hiçbir şeyi adlandırmayan bir terim, örneğin bilinmeyen bir sınıf, sorun olarak gösterilir.
Kural kümesi dosyaları
Bir kural kümesi dosyası; "format": "holarch-rule-set", "version": 1, bir name, isteğe bağlı bir description ve her biri id, name, severity, message, isteğe bağlı bir target ({"class": "Requirement"}), isteğe bağlı bir where filtresi ve bir check içeren bir rules listesi olan bir JSON dosyasıdır. Tam yapıyı görmek için bir kümeyi dışa aktarın. Aynı dosyalar genel API'nin ve MCP'nin model denetimlerinde de çalışır. SysML v2 projelerinde de çalışırlar: orada API ve MCP yalnızca projenin kural kümelerini çalıştırır (yerleşik kurallar uygulamada çalışır) ve Holarch'ın bağlantılardan ve akışlardan okuduğu ilişkiler (connected by, transfers, generates, receives) üzerindeki bir kural yalnızca uygulamada çalışır.
Kurallar
| Kural | Heading | İyi bir model |
|---|---|---|
| Global.1 | Aynı veya neredeyse aynı adlar | Bir sınıf içinde iki nesne aynı adı paylaşmaz. Adlar her dilde, büyük/küçük harf, boşluk, noktalama ve karakter genişliği yok sayılarak karşılaştırılır (“ABS制御” “ABS制御”'ye eşittir); aksanlı harfler sayılır (“Größe” ve “Grüße” farklıdır). |
| Global.2 | Küçük harfli adlar | Her nesne adı büyük harfle başlar. |
| Global.4 | Bir sınıfta yinelenen numaralar | Bir sınıf içinde her numara benzersizdir. |
| Global.5 | Adlarda veya açıklamalarda belirsiz sözcükler | Adlar ve açıklamalar kesin sözcükler kullanır. |
| Global.6 | İlişkisi olmayan nesneler | Her nesnenin bir ilişkisi vardır. |
| Global.7 | Eksik hedefleri gösteren canlı değerler | Açıklamalardaki canlı değerler, matris blokları, canlı tablolar (tablolar, sayımlar ve toplamlar) ve çapraz başvurular, var olan nesneleri, belgeleri, sınıfları, etiketleri, ilişkileri, şekilleri ve tabloları gösterir. |
| Global.8 | Gösterilemeyen UAF görünümleri | Her UAF görünümü, görünüm türünün kabul ettiği bir kök, sınıf ve ilişki kullanır. |
| Global.9 | Şemanın izin vermediği ilişkiler | Her ilişki, şemanın o ilişki türü için izin verdiği sınıfları birleştirir. |
| Global.10 | Ne adı ne numarası olan nesneler | Her nesnenin bir adı veya numarası vardır. |
| Global.11 | Özniteliğinin seçenekleri dışındaki değerler | Her numaralandırma ve çoklu seçim değeri, özniteliğinin seçeneklerinden biridir ve bir kez seçilmiştir. |
| Action.1 | Fiille başlamayan Action adları | Her Action adı bir fiille başlar. |
| Action.2 | Küçük harfli Action adları | Her Action adı büyük harfle başlar. |
| Action.3 | Adı olmayan eylemler | Her eylemin bir adı vardır. |
| Action.4 | Numarası olmayan eylemler | Her eylemin bir numarası vardır. |
| Action.5 | Açıklaması olmayan eylemler | Her eylemin bir açıklaması vardır. |
| Action.6 | Üst veya alt öğesi olmayan eylemler | Her eylemin bir üst veya alt öğesi vardır. |
| Action.7 | Tek alt öğesi olan eylemler | Hiçbir eylemin tek bir alt öğesi yoktur. |
| Action.9 | 9'dan fazla alt öğesi olan eylemler | Hiçbir eylemin 9'dan fazla alt öğesi yoktur. |
| Action.10 | Birden çok üst öğesi olan eylemler | Hiçbir eylemin birden çok üst öğesi yoktur. |
| Action.11 | Hiçbir varlığın gerçekleştirmediği eylemler | Her eylemi bir varlık gerçekleştirir. |
| Action.12 | Hiçbir şey üretmeyen eylemler | Her eylem bir girdi/çıktı üretir. |
| Action.13 | Hiçbir şey tüketmeyen eylemler | Her eylem bir girdi/çıktı tüketir. |
| Action.14 | Girdisi veya çıktısı olmayan eylemler | Her eylem bir girdi/çıktı tüketir veya üretir. |
| Action.15 | Üreten ama hiçbir şey tüketmeyen eylemler | Çıktı üreten her eylem bir girdi de tüketir. |
| Action.16 | Tüketen ama hiçbir şey üretmeyen eylemler | Girdi tüketen her eylem bir çıktı da üretir. |
| Action.17 | Kullanıldıktan sonra üretilen bir girdiye sahip eylemler | Hiçbir eylem, daha sonraki bir eylemin ürettiği bir girdi/çıktıyı almaz. |
| Action.18 | Bir gereksinime izlenmeyen eylemler | Her eylem bir gereksinime izlenir. |
| Action.19 | Hiç bitemeyen döngüler | Her döngü sona erebilir. Döngüyü ve EXIT'ini engelleyen %0'daki OR dalını adlandırır. |
| Asset.1 | İsim içermeyen varlık adları | Her varlık adı bir isim veya isim öbeğidir. |
| Asset.2 | Küçük harfli varlık adları | Her varlık adı büyük harfle başlar. |
| Asset.3 | Adı olmayan varlıklar | Her varlığın bir adı vardır. |
| Asset.4 | Numarası olmayan varlıklar | Her varlığın bir numarası vardır. |
| Asset.5 | Açıklaması olmayan varlıklar | Her varlığın bir açıklaması vardır. |
| Asset.6 | Üst veya alt öğesi olmayan varlıklar | Her varlığın bir üst veya alt öğesi vardır. |
| Asset.7 | Tek alt öğesi olan varlıklar | Hiçbir varlığın tek bir alt öğesi yoktur. |
| Asset.9 | 9'dan fazla alt öğesi olan varlıklar | Hiçbir varlığın 9'dan fazla alt öğesi yoktur. |
| Asset.10 | Birden çok üst öğesi olan varlıklar | Hiçbir varlığın birden çok üst öğesi yoktur. |
| Asset.11 | Hiçbir eylem gerçekleştirmeyen varlıklar | Her varlık bir eylem gerçekleştirir. |
| Asset.12 | Kanalla bağlanmamış varlıklar | Her varlık bir kanalla bağlıdır. |
| Asset.13 | Ortak kanalı olmayan alışveriş yapan varlıklar | Girdi/çıktı alışverişi yapan varlıklar bir kanalla bağlıdır. |
| Asset.14 | Ortak standardı olmayan etkileşen varlıklar | Etkileşen varlıklar aynı standarda başvurur. |
| Asset.15 | Hiçbir şey alışverişi yapmayan varlıklar | Her varlık başka bir varlıkla bir girdi/çıktı alışverişi yapar. |
| Conduit.1 | İsimle başlamayan kanal adları | Her kanal adı bir isimle başlar. |
| Conduit.2 | Adı olmayan kanallar | Her kanalın bir adı vardır. |
| Conduit.3 | Numarası olmayan kanallar | Her kanalın bir numarası vardır. |
| Conduit.4 | Açıklaması olmayan kanallar | Her kanalın bir açıklaması vardır. |
| Conduit.5 | İkiden fazla varlığı olan kanallar | Hiçbir kanal ikiden fazla varlığı bağlamaz. |
| Conduit.6 | İkiden az varlığı olan kanallar | Her kanal iki varlığı bağlar. |
| Conduit.7 | Varlıklarıyla ortak standardı olmayan kanallar | Bir kanal ve bağladığı varlıklar aynı standarda başvurur. |
| Conduit.8 | Hiçbir şey aktarmayan kanallar | Her kanal bir girdi/çıktı aktarır. |
| Conduit.9 | Bir gereksinime izlenmeyen kanallar | Her kanal bir gereksinime izlenir. |
| IO.1 | Adı olmayan girdi/çıktılar | Her girdi/çıktının bir adı vardır. |
| IO.2 | Numarası olmayan girdi/çıktılar | Her girdi/çıktının bir numarası vardır. |
| IO.3 | Açıklaması olmayan girdi/çıktılar | Her girdi/çıktının bir açıklaması vardır. |
| IO.4 | Birden çok üst öğesi olan girdi/çıktılar | Hiçbir girdi/çıktının birden fazla üst öğesi yoktur. |
| IO.5 | Hiçbir eylemin üretmediği girdi/çıktılar | Her girdi/çıktıyı bir eylem üretir. |
| IO.6 | Hiçbir eylemin tüketmediği girdi/çıktılar | Her girdi/çıktıyı bir eylem tüketir. |
| IO.7 | Hiçbir eylemin kullanmadığı girdi/çıktılar | Her girdi/çıktı bir eylem tarafından üretilir veya tüketilir. |
| IO.8 | Bir eylemin hem ürettiği hem tükettiği girdi/çıktılar | Hiçbir eylem kendi ürettiği bir girdi/çıktıyı tüketmez. |
| IO.9 | Varlıklarıyla ortak standardı olmayan girdi/çıktılar | Bir girdi/çıktı ve onu alışveriş eden varlıklar aynı standarda başvurur. |
| IO.10 | Bir gereksinime izlenmeyen girdi/çıktılar | Her girdi/çıktı bir gereksinime izlenir. |
| Requirement.1 | İlgisiz nesneleri adlandıran gereksinimler | Bir gereksinim, adlandırdığı her nesneyle ilişkilidir. |
| Requirement.2 | “shall” içermeyen yaprak gereksinimler | Her yaprak gereksinim “shall” sözcüğünü kullanır. |
| Requirement.3 | Adı olmayan gereksinimler | Her gereksinimin bir adı vardır. |
| Requirement.4 | Numarası olmayan gereksinimler | Her gereksinimin bir numarası vardır. |
| Requirement.5 | Açıklaması olmayan gereksinimler | Her gereksinimin bir açıklaması vardır. |
| Requirement.6 | Üst öğesi veya alt öğesi olmayan gereksinimler | Her gereksinimin bir üst veya alt öğesi vardır. |
| Requirement.7 | Birden çok üst öğesi olan gereksinimler | Hiçbir gereksinimin birden çok üst öğesi yoktur. |
| Requirement.8 | Hiçbir tasarım nesnesinin karşılamadığı yaprak gereksinimler | Her yaprak gereksinim bir Action, Asset, Input/Output veya Conduit ile ilişkilidir. |
| Requirement.9 | Birden çok girdi/çıktı tarafından karşılanan gereksinimler | Hiçbir gereksinim birden fazla girdi/çıktı tarafından karşılanmaz. |
| Requirement.10 | Doğrulayan test senaryosu olmayan yaprak gereksinimler | Her yaprak gereksinim bir Test Case tarafından doğrulanır. |
| Requirement.11 | EARS kalıplarının dışındaki gereksinimler | “shall” içeren her yaprak gereksinim EARS kalıplarından birini izler. Önem derecesini ayarlayana kadar kapalıdır (Yok say). |
| Risk.1 | Azaltımı olmayan en üst düzey riskler | Risk matrisinin en üst düzeyindeki her açık risk bir şeyle azaltılır. |
| Risk.2 | Bir kontrol değişikliğinden daha eski tehlike kabulleri | Hiçbir tehlikenin kalan risk kabulü, kontrollerinde veya bunların doğrulamasında yapılan bir değişiklikten önceye dayanmaz. |
| TestCase.1 | Bağlı Issue öğesi olmayan başarısız test senaryoları | Her başarısız Test Case bir Issue ile bağlantılıdır. |
| Measure.1 | Eşiğini aşan Measure öğeleri | Her Measure öğesinin öngörülen (veya geçerli) değeri eşiğini karşılar. |
Kurallarla ilgili notlar:
- Gereksinim yazma kuralları INCOSE Guide to Writing Requirements'a dayanır: belirsiz sözcükler (R7, belirsiz terimler; R8, kaçamak ifadeler), “shall” (R1, yapılandırılmış ifadeler) ve büyük harfler (R39, stil kılavuzu). Tam yazım denetimi Gereksinim kalitesi'dir.
- Görevler, test senaryoları, durum geçişleri, portlar ve kaynaklar Action ve Asset kurallarınca atlanır; Global kurallar onlara yine uygulanır.
- Ayrıştırılmış bir öğe, alt soyundan herhangi biri öyleyse gerçekleştirilmiş, beslenmiş, üretken veya izlenmiş sayılır. Bir döngü içinde birbirini ayrıştıran öğeler birlikte sayılır.
- Global.9 her öğeyi bir kez, şemanın izin vermediği ilişkilerinin diğer uçlarıyla ve notta ilişki ile sınıfla raporlar; örneğin “Not allowed: decomposed by → Risk”. Şema bir ilişkiye iki yönden birinde izin veriyorsa ilişki izinli sayılır. Bu tür ilişkiler, Şema düzenleyici'de bir hedef kaldırıldıktan sonra kalır ve içe aktarmalarla gelebilir.
- Global.10 ve Global.11 LML 2.0'dan gelir: bir nesne bir ad veya numarayla tanımlanır (§2.1) ve bir numaralandırma ya da çoklu seçim değeri, özniteliğinin listesinden seçilir (§2.5.6, §2.5.12). Global.11 bir öğenin tüm sorunlarını notuna koyar; örneğin
Status: "Pending" is not a choiceveyaVerification Method: "Test" chosen twice. İkisi de şemanın LML 2.0 yerleşiklerine sahip olduğu yerlerde varsayılan olarak çalışır: varsayılan şema veya Şema → Yeni yerleşikleri ekle… sonrasında bir projenin kendi kopyası. Şema kopyası daha eski olan bir projede Yok say ile başlarlar; böylece LML 1.x ile yapılmış bir model öncekiyle aynı bulguları gösterir. Onları çalıştırmak için Ayarlar'da Uyarı veya Hata olarak ayarlayın. Şema düzenleyici, bir liste oluşturduğunuzda veya değiştirdiğinizde en az iki değer ister. - Portlar parça değil arayüz noktalarıdır: alt öğe sayılmazlar ve bir porttaki kanal, portun sahibi olan varlık için sayılır.
- Kullanım senaryoları (Use Case etiketli Action'lar) fiil kuralından ve girdi/çıktı kurallarından muaftır.
- Requirement.11, “shall” içeren cümleyi altı EARS kalıbına göre denetler (EARS şablonlarıyla yazma) ve düzeltilecek ilk şeyi adlandırır; örneğin “Event-driven: Put a comma after the \"When\" condition, before the system name.” (When koşulundan sonra, sistem adından önce virgül koyun). Diğer cümlelerdeki gerekçe ve notlar denetlenmez.
- SysML v2 projeleri kuralların 17'sini SysML v2 terimleriyle çalıştırır: Global.1, .2, .4 ile .8 arası, Requirement.2 ile .5 arası, .8, .10 ve .11, Risk.1, TestCase.1 ve Measure.1. Action, Asset, Conduit ve Input/Output kuralları uygulanmaz; modelin adlarını, türlerini ve yapısını Düzenleyici'nin tanılamaları denetler. Gereksinim kuralları gereksinim kullanımlarını denetler: örneğin Requirement.8 “Hiçbir şeyin karşılamadığı yaprak gereksinimler” (onu karşılayan bir parça veya eylem) ve Requirement.10 “Doğrulama senaryosu olmayan yaprak gereksinimler” olarak görünür. Global.1, .2 ve .6 modelin yanındaki riskler, görevler ve belgeler gibi öğeleri denetler.
Ürün hattı kuralları
Bir projede bir Feature veya Configuration olduğunda, Model denetimleri yerleşik Product line kural kümesini de çalıştırır (ProductLine.1 ile ProductLine.11 ve 13 ile 17 arası kurallar, Product Line sınıfı). Applies To içinde eksik özellikler veya konfigürasyonlar (ProductLine.1), bir kuralı ihlal eden veya eksik konfigürasyonlar (ProductLine.3) ve gereksinimleri kendilerinde doğrulanmamış Released konfigürasyonlar (ProductLine.16) hatadır; diğer kurallar uyarıdır. ProductLine.10 ve 11 her konfigürasyonun eksiksizliğini Tüm konfigürasyonlar'dan denetler. ProductLine.13 ve 14 bir öğenin revizyonlarını (supersedes) denetler: aynı birim için yürürlükte olan iki revizyon ve hiç revizyonu olmayan birimler. Bir konfigürasyon görünümünde her kural o konfigürasyonu denetler. Bkz. Ürün hatları ve konfigürasyonlar.
İletiler
| İleti | Anlamı |
|---|---|
| “Bulgu yok. Uygulanabilir her denetim geçiyor.” | Düzeltilecek bir şey yok. |
| “Bulgu yok. N bulgu yok sayıldı; Yok sayılanları göster onları listeler.” | Kalan her bulgu yok sayıldı. |
| “Filtreyle eşleşen bulgu yok. Filtreyi veya fasetleri temizleyin.” | Fasetler veya filtre her bulguyu gizliyor. |
| “Şema, sınıf için bu ilişkilerin hiçbirine izin vermiyor …” | Düzeltme, proje şemasının o sınıf için izin vermediği bir ilişki gerektiriyor. Bunu Şema düzenleyici'de ekleyin veya bulguyu başka bir yolla düzeltin. |
| “Desen geçerli bir düzenli ifade değil (…). Düzeltin.” | Kural düzenleyicide veya içe aktarılan bir dosyada okunamayan bir desen var. |
| ““…” kimliği bu kural kümesinde zaten kullanılıyor. Başka bir tane seçin.” | Bir kümedeki iki kuralın farklı kimlikleri olmalıdır. |
| ““…” ilişkisi bu projenin şemasında yok.” | Bir kural, bu projede bulunmayan bir ilişkiyi adlandırıyor; siz değiştirene kadar hiçbir şey raporlamaz. |
| “İfade, “…” sınıfı için hiçbir şey adlandırmıyor.” | Bir ifade veya filtre, projede bulunmayan bir sınıfı, etiketi, ilişkiyi veya öğeyi adlandırıyor. |
| “N sürümü desteklenmiyor. Holarch'ın bu sürümü 1. sürümü okur.” | Kural kümesi dosyası daha yeni bir Holarch tarafından yazılmış. |
Sınırlar
- Liste grup başına en fazla 200 bulgu gösterir; geri kalanını görmek için listeyi filtreleyin.
- Bir kural kümesi en fazla 500 kural içerir; bir dosya en fazla 50 kural kümesi ve 2 MB içerir. Desenler en fazla 300 karakterdir ve bir değerin ilk 20.000 karakterini denetler.
- Son çalıştırmadan bu yana değişim projede değil, cihaz ve tarayıcı başına tutulur.
- Genel API ve MCP araçları projenin ayarlarıyla aynı bulguları döndürür; sonuçları saklamazlar.