Examples: query, "exact match", wildcard*, wild?ard, wild*rd
Fuzzy search: cake~ (finds cakes, bake)
Term boost: "red velvet"^4, chocolate^2
Field grouping: tags:(+work -"fun-stuff")
Escaping: Escape characters +-&|!(){}[]^"~*?:\ with \, e.g. \+
Range search: properties.timestamp:[1587729413488 TO *] (inclusive), properties.title:{A TO Z}(excluding A and Z)
Combinations: chocolate AND vanilla, chocolate OR vanilla, (chocolate OR vanilla) NOT "vanilla pudding"
Field search: properties.title:"The Title" AND text
Beantwortet
Best-Practices im Hinblick auf Namens - Konventionen

Hallo zusammen,
mich interessiert es sehr, welche Best practices ihr im Hinblick auf ein sauber und ordentlich gepflegtes System verwendet. Sowohl für globale als auch prozesspezifische JobRouter Elemente.

Global: Nach welcher Konvention benennt ihr Prozesse, Job Functions, Tabellen etc?
Prozessspezifisch: Welcher Guideline folgt ihr beim Benennen von Prozesstabellenfeldern, Dialogfeldern etc?

Beispielsweise:
Prozess: A_0001_"WF Name"
Jobfunction: A_0001_"WF Name"01(Start)
Prozesstabellenfelder: "CAPITAL LETTER"
Dialogfelder: "lowercase letter"

Über Einblicke und Anregungen eurerseits würde ich mich sehr freuen
Viele Grüße,
Karim

1
1
Gepostet vor 3 Jahren
Stimmen Neuste

Antworten 3


Wenn ich die Wahl habe, sieht mein Standard wie unten aufgeführt aus.

Prozessname: PascalCase => OrderManagement
Prozesstabelle: {Acronym aus ProcessName}_MAIN => OM_Main
Untertabellen:  {Acronym aus ProcessName}_{Inhalt} => OM_Orders

Wenn man sich die Tabellen auf der Datenbank mal direkt anschauen muss, sind die bei diesen Namen untereinander aufgelistet und man muss nicht hin und her scrollen, wenn man sich die Tabellen des Prozesses zusammen suchen will

TabellenFelder: PascalCase => VendorNo

JR erlaubt nur 20 Zeichen daher ist PascalCase ein guter Kompromiss aus lesbarkeit und länge

DialogFelder: camcelCase => vendorNo

in html ist der "standard" oft kebab-case oder snake_case. kebab-case kann man in JR nicht bei allen Elementen verwenden, da es Probleme mit einigen Events gibt.

Bei Rollen kommt es darauf an, wofür die gedacht sind. Gehören die eher zu einem Prozess sieht der Name bei mir so aus:
Rollen: {Acronym aus ProcessName}_{Zweck} => OM_Approver

Existieren schon Prozesse beim Kunden versuche ich mich so gut wie möglich an den vorhandenen Standard zu orientieren.

  
  

Vielen lieben Dank, Dominic!

Karim - Lukas   vor 3 Jahren Melden

Hallo Karim,

ich habe mich gestern mit meinen Kollegen bei DemandFlow darüber unterhalten. Bei uns gibt es eine Präferenz dahin, Prozessnamen, Tabellen, Datenbankfelder (auch Prozesstabellenfelder) in Großbuchstaben zu schreiben und mit Unterstrich. Das hat den Vorteil, dass ich nicht darüber nachdenken muss, ob ein Feld nun processId, processID oder processid heißen soll ;-)

Dialogfelder benennen wir gerne in Kleinbuchstaben mit Unterstrich, wenn nötig. Dadurch lassen sie sich optisch im Dialogeditor super von den Bezeichnungen unterscheiden, die immer mit Großbuchstaben beginnen.

Im Code natürlich camel case.

Ich habe gesehen, dass das in jedem Team etwas anders gehandhabt wird. Aktuell arbeite ich mit Kollegen von einer anderen Firma zusammen, die auch in der Prozesstabelle und für Dialogelemente camel case verwenden.

Viele Grüße,
Ben

1
1
Gepostet vor 3 Jahren
  
  

Hi Ben, vielen Dank für deine Antwort!

Karim - Lukas   vor 3 Jahren Melden

Moin Moin,

das ist natürlich eine sehr individuelle Frage, da jeder Entwickler da eigene Präferenzen hat.
Wichtig ist jedoch vorneweg die Konsistenz.
Wenn ich zu einem bestehenden Projekt dazukomme dann analysiere ich die bisherigen Konventionen und führe diese weiter.
Wenn ich mit jemandem zusammen einen neuen Prozess entwickle dann spreche ich mich mit jener Person ab, sodass es konsistent ist.
Wenn ich jedoch alleine einen neuen Prozess entwickle mache ich es üblicherweise so:
Datenbankfelder, also Prozess oder Untertabellenfelder, Datenbanktabellen wie UTs alle in GROSSBUCHSTABEN
Dialogelemente, Prozessmeldungen und Konfigurationen mit Underscores also my_process_config
Skripte und Funktionsnamen in camelCase (außer bei Klassenfunktionen, dann CamelCase).

Grüßle
Stefan

  
  
Gepostet vor 3 Jahren
Stefan Köngeter
309 × 7 Administrator
5K Ansichten
3 Antworten
vor 3 Jahren
vor 3 Jahren
Stichwörter