Differences

This shows you the differences between two versions of the page.

--- en:software:tss:start [2017/01/03 20:36]
semen.bortnik
+++ en:software:tss:start [2021/07/01 09:52] (current)
@@ Line 15: / Line 15: @@
 ===== 2. Access to the Tim smartform suite =====
-==== 2.1 Systemrollen für den Zugang zur TSS ====
+==== 2.1 Systemroles required to access the TSS ====
-A user has to have the following TODO:roles [[software:tim:roles|Systemrollen]]to use the corresponding version of the TIM smartform suite:
+A user has to have the following roles [[en:software:tim:roles|roles]] to use the corresponding version of the TIM smartform suite:
-  * „smartform-designer“ to gain excess to TODO [[#3. TIM Smartform Designer|TIM Smartform Designer]]
+  * „smartform-designer“ to gain excess to [[#3. TIM Smartform Designer|TIM Smartform Designer]]
-  * „smartform-architect“ to gain excess to TODO [[#4. TIM Smartform Architect|TIM Smartform Architect]]
+  * „smartform-architect“ to gain excess to [[#4. TIM Smartform Architect|TIM Smartform Architect]]
-  * „smartform-expert“ to gain excess to TODO[[#5. TIM Smartform Expert|TIM Smartform Expert]]
+  * „smartform-expert“ to gain excess to [[#5. TIM Smartform Expert|TIM Smartform Expert]]
-==== 2.2 Excess via repository ====
+==== 2.2 Access via repository ====
-The acces to the configurator of the TSS happens via TODO [[software:tim:processrepository|TIM Repository]]. In the Tab "Smartform" you can find an "EDIT"-Button. The configurator will be opened in a seperate tab upon clicking it.
+The access to the configurator of the TSS happens via [[en:software:tim:processrepository|TIM Repository]]. In the Tab "Smartform" you can find an "EDIT"-Button. The configurator will be opened in a seperate tab upon clicking it.
-{{ :software:tss:02_repository_smartform.png?direct&1000 |}}
+{{ :en:software:tss:en_02-repository_smartform.png?direct&1000 |}}
-==== 2.3 Systemrolle für die Verwaltung von TSS Ressourcen ====
+==== 2.3 Systemroles for the maintenance of TSS resources ====
 Every data-artifact wich is used for the creation of a smartform is saved in a central database.
 An UI is integrated for the management of the artifacts was integrated in the admin client.
-A user needs the following role to manage the tss-recources (z.B- confiuratins, CSV-documents, CSS-documents etc. TODO[[#6.8 Verwaltung von TSS-Resourcen|Verwaltung von TSS-Resourcen]]  in his client or super- client:
+A user needs the following role to manage the tss-recources (z.B- confiuratins, CSV-documents, CSS-documents etc. [[#6.8 Maintenance of TSS-Resourcen|Maintenance of TSS-Resourcen]]  in his client or super- client:
   * „resource-manager“ (If a user is a "resource-manager he doesn't necessarily need the role "admin")
@@ Line 38: / Line 39: @@
     * The document will be automatically renamed into css.css upon uploading.
 {{ :software:tss:tss_resourcestabinsupermandant.png?direct&1000 |}}
-  * Wth the document-type TODO?Logo-Dateien? you can upload a PNG-Document with your corporate logo, wich will be automatically renamed into logo.png upon uploading and will be displayed in the top-left corner of the configurator.
+  * With the document-type Logo-Datei you can upload a PNG-Document with your corporate logo, wich will be automatically renamed into logo.png upon uploading and will be displayed in the top-left corner of the configurator.
-=== 2.3.2 client-specific resources ===
+=== 2.3.2 Client-specific resources ===
 It is possible to have artifacts in your client, wich are only available and effective in your client.
   * For example a CSS-document wich implements your corporate CI
@@ Line 53: / Line 54: @@
   * Creation and arrangement of attributes
   * Only simple Smartform, which means without tab-pages, tables or accordions etc.  Nur einfache Smartforms, d.h. ohne Tabpages, Tabellen, Accordions, etc.
-    * For more complex smartforms you have to use the other versions: TODO [[#4. TIM Smartform Architect|TIM Smartform Architect]] and [[#5. TIM Smartform Expert|TIM Smartform Expert]].
+    * For more complex smartforms you have to use the other versions: [[#4. TIM Smartform Architect|TIM Smartform Architect]] and [[#5. TIM Smartform Expert|TIM Smartform Expert]].
 ==== 3.2 Explanation of the UI and function - target group professional users! ====
@@ Line 63: / Line 64: @@
   * The TSS enables you to use a uniform operating philosophy in your smartforms.
     * Because of the uniform structures of the arrangements of attribute, validations, and mandatory fields and editability etc. your end-users will quickly understand all your processes.
-{{ :software:tss:03.0_smartform_designer.png?direct&1000 |}}
+{{ :en:software:tss:en03.0_smartform_designer.png?direct&1000 |}}
   * With the button //Import activities// you can import the activities of your modeled process
   * With the //Import// and //Export// button you can import configurations or export them as a backup or for further usage in other processes.
   * With the //Validate// button you can validate your configuration.
-  * With the //Test// button you can test your smartform from user-perspective TODO:(For further details [[#3.2.3 Testmodus]])
+  * With the //Test// button you can test your smartform from user-perspective:(For further details see [[#3.2.3 Testmode]])
   * With the button //Deploy// you can safe your configurations. Everything you change must be safed by pressing the //Deploy// button, afterwards it can be seen in the ToDo client.
@@ Line 74: / Line 75: @@
   * The changes on your smartform will be effective for the value "---" in the status-dropdown. In symbolizes the basic configuartion.
-    * In the chapter TODO [[#3.2.4 Statusabhängige Konfiguration - Aktivitäten einlesen]] it will be explained, how you can individualize your smartform for specific activities in the process.
+    * In the chapter [[#3.2.4 Statusspecified configuration - Import activities]] it will be explained, how you can individualize your smartform for specific activities in the process.
   * Attributes can be placed in any order, moved to another element or be hidden for a specific status via drag and drop
-    * For further details: TODO[[#3.2.2 Attribute]]
+    * For further details: [[#3.2.2 Attributes]]
-=== 3.2.2 Attribute ===
+=== 3.2.2 Attributes ===
 In the smartform Designer you can create attributes to gather and display process information.
   * A new attribute can be created by drag&dropping the //[new] ()// tag into the smartfom.
-    * This is only possible if the status-dropdown is set to "---". (For further details to status-specified configurations see also TODO[[#3.2.4 Statusabhängige Konfiguration - Aktivitäten einlesen|Statusabhängige Konfiguration - Aktivitäten einlesen]])
+    * This is only possible if the status-dropdown is set to "---". (For further details to status-specified configurations see also [[#3.2.4 Statusspecified configuration - Import activities|Statusspecified configuration - Import activities]])
   * A new attribute will be safed as a TIM-process-variable.
   * For futher usage (e.g. in Word templates or Emails etc.) the attributes can be found in the process with ${name_of_the_attribute}
@@ Line 87: / Line 88: @@
   * If a new attribute is dragged into the smartform or if an existing attribute is clicked, a pop-up will appear. There you can change the properties of the attribute:
-{{ :software:tss:03.2_smartform_designer_attribut.png?direct&1000 |}}
+{{ :en:software:tss:en_03.2_smartform_designer_attribute.png?direct&1000 |}}
 <div>
 ^Field^ Description ^
 |Attribute | Identifier of the attribute. Can be referenced with ${...} in emails. ("status" and "name" mustn't be used as attribute-identifier)|
 |Decription |Appears as a tooltip as soon as the user places his mouse on the attribute|
-|Data-Type | You can select a data-type or create an individual validation (see also TODO[[#3.2.5 Datentypen|Datentypen]]) |
+|Data-Type | You can select a data-type or create an individual validation (see also [[#3.2.5 Data-Types|Data-Types]]) |
 |Caption |Will be displayed as text in the left side of the attribute|
 |UI-Flag |Definition of the editability of the attribute|
-|Layout |Selection of a layout for the display of the attribute. (see also TODO[[#3.2.5 Datentypen|Datentypen]]) |
+|Layout |Selection of a layout for the display of the attribute. (see also [[#3.2.5 Data-Types|Data-Types]]) |
 |Width label |Width of the space where the desctription will appear|
 |Width space |Distance between description and attribute|
 |Width value |Width of the attribute |
-|Height |Height of the attribute. Every height that is bigger than 24px will be displayed with the layout-option "big" (see also TODO[[#3.2.5 Datentypen|Datentypen]]) |
+|Height |Height of the attribute. Every height that is bigger than 24px will be displayed with the layout-option "big" (see also [[#3.2.5 Data-Types|Data-Types]]) |
 </div>
@@ Line 106: / Line 107: @@
 |Reset all status to default |This button will appear, if the status-dropdown is set to "---". It will reset every status-specified versions of the attribute.|
 |Reset actual status to default |This button will appear if the status-dropdown is set to something different then "---". By pressing it you will reset the configurations of this attribute for the selected status. |
-|"Reset a selected attribute-property"-Icon |Every attribute-property that differs from the standart-configuration will be desplayed in a bold text. Moreover a button will appear, that will reset the property upon pushing |
+|"Reset a selected attribute-property"-Icon |Every attribute-property that differs from the default-configuration will be desplayed in a bold text. Moreover a button will appear, that will reset the property upon pushing |
 |Copy-Icon | Uses the attribute for the creation of a new one. The properties  //Attribute// and //Label// will be reseted.|
 |Delete-Icon |Deletes the attribute. This icon only appears while the status-dropdown is set to "---". If you want to hide an attribute, drag&drop it onto the //Hide attribute// area near the status-dropdown. The attribute will be hidden for the selected status but is still available in the attribute-list in the left side of the screen |
@@ Line 112: / Line 113: @@
 |Reset-Icon |Sets all attributes to the last saved value |
 </div>
-**Reference**: For further details see also TODO[[#3.2.4 Statusabhängige Konfiguration - Aktivitäten einlesen|Statusabhängige Konfiguration - Aktivitäten einlesen]]
+**Reference**: For further details see also [[#3.2.4 Statusspecified configuration - Import activities|Statusspecified configuration - Import activities]]
   * Every new or changed attribute must be safed by clicking on the save-icon.
@@ Line 118: / Line 119: @@
   * Every attribute can be moved inside one element or to another per drag&drop.
-  * If you want to hide an attribute, drag&drop it onto the //Hide attribute// area near the status-dropdown. The attribute will be hidden for the selected status. See also the screenshots in TODO[[#3.2.4 Statusabhängige Konfiguration - Aktivitäten einlesen|Statusabhängige Konfiguration - Aktivitäten einlesen]]
+  * If you want to hide an attribute, drag&drop it onto the //Hide attribute// area near the status-dropdown. The attribute will be hidden for the selected status. See also the screenshots in [[#3.2.4 Statusspecified configuration - Import activities|Statusspecified configuration - Import activities]]
     * The attribute will be still saved in the coniguration, but invisible for the selected status.
 The Ui-Flags define the editability and can be found in the attribute Pop-up. You can either select them fromm a list wich pops up after ckicking on the magnifying glass or write them in the text field:
-{{ :software:tss:03.3_smartform_designer_attribut_ui-flags.png?direct&1000 |}}
+{{ :en:software:tss:en_03.3_smartform_designer_attribute_ui_flags.png?direct&1000 |}}
-=== 3.2.3 Testmodus ===
+=== 3.2.3 Testmode ===
 After clicking on the //Test//-button the smartform will appear like it would look in the current status. Now you can check if the attributes are editable and visible like they should be.
 {{ :software:tss:03.4_smartform_designer_testmodus.png?direct&1000 |}}
-=== 3.2.4 Statusabhängige Konfiguration - Aktivitäten einlesen ===
+=== 3.2.4 Statusspecified configuration - Import activities ===
 After you have constructed a smartform for the "---"-status you can now define special process-cases. You need to click the  //IMPORT ACTIVITIES// -button.The status-dropdown will be filled with your process activities.
   * Now you can select an activity or a standart status [neu, Suche, in Arbeit, Prozess-Manager, beendet, Betrachter] and change your smartform as you wish:
@@ Line 135: / Line 136: @@
 	* Modify attribute properties by clicking on an attribute. See also [[#3.2.2 Attribute]]
 	  * You can for example make a certain field a mandatory field for an activity.
-**Attention**: If you want to create an attribute just for one status, you have to create it for the status "---" first, then drag it onto //Hide attribute//. Afterwards you have to select the status you want this specific attribute to be visible in and then drag&drop the attribute from the attribute list on the left side of the screen.
+**Attention**: If you want to create an attribute just for one status, you have to create it for the status "---" first, then drag it onto //Hide attribute//. Afterwards you have to select the status you want this specific attribute to be visible in and then drag&drop the attribute from the attribute list on the left side of the screen. WILLBECHANGED
 {{ :software:tss:03.1_smartform_designer_aktivitaeten_einlesen.png?direct&1000 |}}
 {{ :software:tss:03.5_smartform_designer_statusabhaengige_attributkonfiguration.png?direct&1000 |}}
-  * in the attribute pop-up the status-specified configurations will be displayed **bold**. Configurations that are inherited from the "---"-status will be displayed//cursive//
+  * in the attribute pop-up the status-specified configurations will be displayed **bold**. Configurations that are inherited from the "---" - status will be displayed //cursive//
-  * {{ :software:tss:03.6_smartform_designer_statusabhaengige_attributkonfiguration.png?direct&1000 |}}
+  * {{ :en:software:tss:en_03.6_smartform_designer_statusabhaengige_attributeconfigs.png?direct&1000 |}}
   * Specification of the configurations of the smartform that was created above for the status //[neu]//, which is active while the process is started.
-{{ :software:tss:03.7_smartform_designer_statusabhaengige_attributkonfiguration.png?direct&1000 |}}
+{{ :en:software:tss:en_03.7_smartform_designer_statusspecified_configs.png?direct&1000 |}}
-=== 3.2.5 Datentypen ===
+=== 3.2.5 Data-Types ===
 In the attributee pop-up yoiu can find a list of predefined data-types:
-{{ :software:tss:03.10_smartform_designer_datentypen.png?direct&1000 |}}
+{{ :en:software:tss:en_03.10_smartform_designer_datentypen.png?direct&1000 |}}
   * While using the Smartform designer you will be limited to the following list of data-types.
 <div>
@@ Line 165: / Line 167: @@
 </div>
-  * If you click the symbol on the right side of the datatype-dropdown list in the attribute-popup you can look through different layouts
+  * If you click the symbol on the right side of the datatype-dropdown list in the attribute-popup you can look through different layouts:
-{{ :software:tss:03.9_smartform_designer_datentypen.png?direct&1000 |}}
+{{ :en:software:tss:en_03.9_smartform_designer_datatypes.png?direct&1000 |}}
   * You can also create an own data-type in the //Data-type//-popup by clicking the green PLUS-Icon
     * This data-types are based on existing data-types
     * By creating length-limitations or input-masks you can create a validation. This can be used to create a field that validates input to fit a certain structure, for example an accounting area XX_098_XX.
-	* For further details to the creation of new data-types see TODO [[#6.4 Modul Datentypen]]
+	* For further details to the creation of new data-types see [[#6.4 Module Datatypes]]
-    * Coplex data-tyoes, like CSV-Lists for autocomletes or Dropdowns can be created in the TODO [[#4. TIM Smartform Architect|TIM Smartform Architect]]
+    * Coplex data-tyoes, like CSV-Lists for autocomletes or Dropdowns can be created in the [[#4. TIM Smartform Architect|TIM Smartform Architect]]
     * Created data-types will appear in the data-type dropdown-list in the attribute pop-up and can be also used in the designer.
@@ Line 181: / Line 183: @@
 === 3.2.6 Templates ===
 The basis of a smartform is the template. Upon creating a new smartform, the //3columns//-template will be selected. If you need a special template you have to create it by using the Smartform-Architect or -Expert. A user with the right //smartform-architect// or //smartform-expert// can create a unique template.
-**Attention**: The Smartform Architect is for professional users. Deswegen ist eine Pflege von komplexen Layoutelementen, wie z.B. Tabs und Platzhalter für die Darstellung von Tabellen, nicht im Designer pflegbar
+**Attention**: The Smartform Architect is for professional users. Because of that it is impossible to create complex layouts with tabs or dummies for the display of tables with the designer.
-  * Via //ELEMENTE ANPASSEN// können Sie zudem die Überschriften der Template-Elemente anpassen:
+  * By clicking on //CUSTOMIZE ELEMENTS// you can change the headline of the selected template element:
-{{ :software:tss:03.8_smartform_designer_template_modifizieren.png?direct&1000 |}}
+{{ :en:software:tss:en_03.8_smartform_designer_template_modify.png?direct&1000 |}}
 === 3.2.7 Ergebnis im ToDo Client ===
-Der folgende Screenshot zeigt das konfigurierte Smartform einmal für den Prozessstart und einmal für die erste Aufgabe. Sie können sehen, dass teilweise Attribute ausgeblendet, oder rot als Pflichtfelder hervorgehoben sind:
+The following screenshot shows a configured smartform at the beginning of the process and for the first task. You can see that some attributes are hidden and others are coloured red:
-  * Smartform für den Start eines Vorgangs "TSS Testprozess":
+  * Smartform at the beginning of a process "TSS Testprozess":
 {{ :software:tss:03.11_smartform_designer_prozessstart.png?direct&1000 |}}
-  * Smartform für die Erledigung der ersten Aufgabe "Erste Aufgabe im Prozess" Vorgangs "TSS Testprozess":
+  * Smartform for the first task "Erste Aufgabe im Prozess" of the process "TSS Testprozess":
 {{ :software:tss:03.12_smartform_designer_aufgabe.png?direct&1000 |}}
-=== 3.2.8 Config zum Selbertesten ===
+=== 3.2.8 Configurations for testing ===
-Die Konfiguration, anhand der die Screenshots erstellt wurden, können Sie hier einsehen und für Ihre Tests verwenden: [[software:tss:sample_config_designer|Beispielkonfiguration]]
+The configurations used for the process above can be found here: [[software:tss:sample_config_designer|Example configurations]]
 ----
 ===== 4. TIM Smartform Architect =====
-==== 4.1 Zielgruppe & Projektscope ====
+==== 4.1 Targetgroup & projectscope ====
-  * IT Berater
+  * IT consultants
-  * Erstellung komplexer Smartforms mit Datenstrukturen, Tabpages, etc.
+  * Creation of complex smartforms with data-structures, tabs etc.
-  * Integration von strukturierten Daten aus csv, txt, xls oder Datenbanktabellen
+  * Integration of structured data from csv, txt xls oder database-tables
-  * Erstellung von Übersetzungen für mehrsprachige Smartforms in DE und EN
+  * Creation of translations for multi-language smartforms
-  * Erstellung von Datentypen, Templates und Meldungen für einen Prozess
+  * Creation of data-types, templates and messages for a process
-  * Einfacher Zugang zu Groovy für showInterface zum modifizieren der Benutzeroberfläche für Sonderkonstellationen oder Feldabhängigkeiten
+  * Easy excess to Groovy for showInterface in order to modify the user interface.
-  * ALLES, was für einen Prozess definiert wird, d.h. Templates, Datentypen, etc. ist nur innerhalb dieses Prozesses gültig und existent!
+  * ANYTHING that is defined for a process. E.g. Templates, data-types etc. only exists for the process where it was created
-==== 4.2 Erklärung der Oberfläche und Funktionen ====
+==== 4.2 Explanation of the UI and functions ====
-  * Überblick: Menü; Sidebar; WYSIWYG
+  * TODO Overview: Menu; Sidebar; WYSIWYG
-  * Details siehe [[#6. Module des TIM Smartform Architect und Expert]]
+  * For further details see [[#6. Module des TIM Smartform Architect und Expert]]
 ----
 ===== 5. TIM Smartform Expert =====
-==== 5.1 Zielgruppe & Projektscope ====
+==== 5.1 Targetgroup & projectscope ====
-  * IT Berater und Entwickler
+  * IT consultants and developers
-  * Tiefe Systemintegration
+  * Deep system integration
-  * Komplexe Konfigurationsmöglichkeiten
+  * Complex configuration-possibility
-  * Groovy extended. Auch zur Verwendung im Prozess via CBAGenericActionHandler möglich
+  * Groovy extended. CBAGenericActionHandler can be used in the process
-  * ALLES, was für einen Prozess definiert wird, d.h. Templates, Datentypen, etc. ist nur innerhalb dieses Prozesses gültig und existent!
+  * ANYTHING that is defined for a process. E.g. Templates, data-types etc. only exists for the process where it was created
-==== 5.2 Erklärung der Oberfläche und Funktionen ====
+==== 5.2 Explanation of the UI and functions ====
-  * Überblick: Menü; Sidebar; WYSIWYG
+  * Overview: Menu, Sidebar; WYSIWYG
-  * Details siehe [[#6. Module des TIM Smartform Architect und Expert]]
+  * For further details ss [[#6. Modules of the TIM Smartform Architect und Expert]]
 ----
-===== 6. Module des TIM Smartform Architect und Expert =====
+===== 6. Modules of the TIM Smartform Architect und Expert =====
+==== 6.1 Module UI ====
+  * Creation of new templates:
+You need architect- or expert-rights. Click on the tab "Templates" in the top left corner, then on the green "PLUS-Icon". Name your template by entering something in the field "Template" and save everything (by clicking on the floppy disk). Afterwards click the tab "Elements" and then the green "PLUS-icon"
+on the top right corner. Name your element. (This is not the only correct way but a step by step tutorial on how to create a blank element with a certain
+size) Select position 1 if you havent placed any other elements into your smartform. Select "A-Element" as the "Element type" and "uie-details formular element" as "UIE". In the section "positioning you can select the size and the gap between this and other elements. To finalize this creation click //SAVE// and //DEPLOY//.
-==== 6.1 Modul Bedienoberfläche ====
+==== 6.2 Module templates ====
-  * Eigenes Template erstellen:
-Sie brauchen Architect- oder Expertrechte. Klicken Sie oben rechts auf den Reiter "Templates", anschließend auf das grüne "PLUS-Icon". Bennen Sie ihr neues Template in dem Feld "Template" und speichern Sie alles (Diskette). Anschließend gehen Sie auf den Reiter Elemente und klicken auf das grüne PLUS-Icon am rechten Bildschirmrand. Bennen Sie ihr Element. (Folgendes ist nicht der einzig richtige Weg sondern nur ein Vorschlag wie man ein blankes Template in passender Größe designen kann). Wählen Sie als Position 1 aus, falls Sie noch keine anderen Elemente eingefügt haben, geben Sie als Element-Typ "A-Element" und als "UIE" "uie-details Formular-Element" an. In dem Abschnitt "Positionierung" können Sie die gewünschte Größe sowie den Abstand zu anderen Elementen in Pixeln angeben. Anschließend drücken Sie auf Speichern (Diskette) und auf "Veröffentlichen".
-==== 6.2 Modul Templates ====
   *
-==== 6.3 Modul Tabellen ====
+==== 6.3 Module tables ====
-  * dau- immer entsprechend des Dateityps, oder Datenbankzugriff
+  * The dau specifies the storage medium (e.g. files or database)
   * Bei Ablage als Prozessvariable (BL-Flag P) immer dau-tim verwenden. Achtung: Max. 4000 Zeichen in einer Prozessvariable erlaubt. Dies schließt Steuerzeichen der Tabelle mit ein. Bitte nur zum fixen Testen verwenden
-==== 6.4 Modul Datentypen ====
+==== 6.4 Module Datatypes ====
-Auflistung aller Basistypen und Details dazu
+List of all basic types and further details
-Reguläre Ausdrücke
+Regular expressions
-  * Stellen Pattern erlaubter Zeichenketten dar.
+  * Represent patterns of valid strings.
-  * Ist im Feld für den regulären Ausdruck ein Pattern eingegeben, ist der Attributwert nur erlaubt, wenn er dem Pattern entspricht.
+  * If there is a pattern for the regular expression, then teh attribute value is only allowed if it is simular to the pattern.
-  * Syntax von regulären Ausdrücken ist nicht einfach – bitte Literatur verwenden, z.B. http://www.regular-expressions.info/quickstart.html.
+  * The sytax of regular expressions is not easy, please use literature e.g.: http://www.regular-expressions.info/quickstart.html.
-Masken
+Masks
-  * Geben dem Nutzer definierte Pattern zur Eingabe vor und lehnen Falscheingaben ab:
+  * Only allow input with a certain pattern:
-    * 0 .. Vorzeichen und Ziffern
+    * 0 .. algebraic signs and numbers
-    * 9 .. nur Ziffern
+    * 9 .. only nummbers
-    * a .. Buchstaben (A-Z,a-z) sowie ‘-’ und ‘_’
+    * a .. Letters (A-Z,a-z) and ‘-’ and ‘_’
-    * z .. nur Buchstaben (A-Z,a-z)
+    * z .. only letters (A-Z,a-z)
-    * *  .. Buchstaben (A-Z,a-z) und Ziffern sowie ‘-’ und ‘_
+    * *  .. letters (A-Z,a-z) ,numbers, ‘-’ and ‘_
-==== 6.5 Modul Meldungen ====
+==== 6.5 Module massage ====
   *
-==== 6.6 Modul Übersetzung ====
+==== 6.6 Module translation ====
   *
-==== 6.7 Modul funktionale Struktur ====
+==== 6.7 Module functional structure ====
   *
-==== 6.8 Verwaltung von TSS-Resourcen ====
+==== 6.8 Maintenance of TSS-Resourcen ====
 ----
-===== 7. praktische Tipps für die gängigsten Smartformanforderungen =====
+===== 7. Usefull tipps for the most common smartform applications =====
-==== 7.1 Attribute in Taskliste darstellen ====
+==== 7.1 Display attributes in the taskbar ====
-  * Attribute, die in der Taskliste angezeigt werden sollen, sind sog. Indexfelder
+  * Attributes that are visible in the taskbar are called Indexfields
-  * Es gibt 10 Felder, die mit beliebigen Attributen belegt werden können
+  * There are 10 fields wich can display any attribute
-  * Modul Tabellen - tim_process auswählen - Tab Attribute - Attribut auswählen - rechts in der Sidebar unter Geschäftslogik das BL-Flag auf 1 oder 2 ... oder 0 setzen - speichern - Veröffentlichen - Echten Prozess zum Testen starten
+  * Modul tables - select tim_process - Tab Attribute - select Attribut - In the right sidebar you have to select the BL-Flag 1 or 2 ... or 0 - save - Deploy - Start a real process for testing
-  * Die Spaltenüberschriften können mittels dem folgenden Eintrag in der custom.js für jeden Mandanten angepasst werden:
+  * The headlines for each index can be changed in the custom.js like this for every vlient:
     * gadget.languages.de.standard_smartformindex1= 'Überschrift für Index 1 in DE';
     * gadget.languages.en.standard_smartformindex2= 'Überschrift für Index 1 in EN';
-==== 7.2 Besondere Eigenschaften von Attributen ====
+==== 7.2 Special properties of attributes ====
-  * Zusätzliche Flags zu "E" oder "D" für:
+  * Additional flags for "E" or "D" :
-    * Mail (e): Es wird automatisch rechts neben dem Eingabefeld ein kleines Icon gerendert. Wenn der Nutzer auf das Icon klickt, dann öffnet sich das Systemstandardprogramm für den Versand einer Mail. Die Empfängeradresse wird dabei vorbelegt
+    * Mail (e): A button will appear on the right side of the input field. If clicked, the default Email massenger will be opened. The email adress will be auto-filled.
-    * HTML-Link (w): Es wird automatisch rechts neben dem Eingabefeld ein kleines Icon gerendert. Wenn der Nutzer auf das Icon klickt, dann öffnet sich der Systemstandardbrowser und die eingegebene Webseite wird geladen.
+    * HTML-Hyperlink (w):  A button will appear on the right side of the input field. If clicked the default browser will be opened and the entered adress will be opened.
-  * Zusätzliche Flags zu "E":
+  * Additional flags for "E":
-    * Placeholder (h): Der eingegebene Text aus dem Feld Beschreibung wird nicht nur als Tooltip verwendet, sondern auch als Hintergrundtext in editierbaren einzeiligen Textfeldern. Sobald der Nutzer etwas eintippt,  verschwindet der Hintergrundtext
+    * Placeholder (h): The entered text will additionally be displayed in the background of the textfield
-    * refresh (r ): Dies führt dazu, dass nach Eingabe durch einen Nutzer in das Feld, das Smartform neu geladen wird. Alle Daten bleiben erhalten. Dadurch wird aber die Groovy Methode showInterface erneut ausgeführt. Dort abgelegte Funktionen können nun basierend auf der Eingabe des Nutzers z.B. Attribute ein-/ ausblenden oder Pflichtfeldbedingungen individualisieren
+    * refresh (r ): After enterign something in the field, the smartform will be refreshed. The Groovy method showInterface will be executed again. Functions wich are stored there cna now modify the smartorm, e.g. change the visibility of of attributes etc.
-    * Werden diese beiden Flags in Kombination mit "D" ond/oder ohne "E" genutzt, dann haben sie in dem Moment keine Wirkung
+    * If this flags ar ecombined with the flag "D" or aren't combined with the flag "E" they won't have any impact.
-  * Umbruch Labelbreite zu Feldbreite:
+  * Break of the label-width and field-width:
-    * Per default wird ein Attribut immer wie folgt gerendert: Label + Zwischenabstand + Eingabefeld
+    * Normally an attribute will be displayed like this: Label + gap + field
-    * Wenn nun das Eingabefeld einmal unter dem Label erscheinen soll, dann muss die Breite des Labels, d.h. Breite Übers., einfach breiter eingestellt werden. Wenn nun Breite Übers. + Breite Zw.raum + Breite Wert > Breite des Elements, in dem das Attribut platziert wird, dann bricht das Eingabefeld automatisch nach unten um
+    * If the field should appear under the label, then the label-width has to be bigger than usual. If the label-width + gap-width + value-width are bigger than the element they are placed in the input field will be placed under the label.
-==== 7.3 Einbinden einer csv-Datei für ein Autocomplete-/Dropdownfeld ====
+==== 7.3 Import a csv-document for an autocomplete-/dropdownfield ====
-  * Zuerst muss im Modul Tabellen eine Tabelle angelegt werden, die genau so heißt, wie die vorliegende csv, txt oder xls
+  * First you have to create a module wich is named like the csv, txt or xls file
-    * Die Tabelle bekommt die entsprechend ihrer Endung passende DAU zugeordnet.
+    * The table must get the matching DAU
-    * Die BLU muss immer auf blu-basic gesetzt werden
+    * The BLU must be set to "blu-basic"
-    * Nun müssen in dieser Tabelle alle Spalten, die in der zugrundeliegenden Datei existieren, als Attribute angelegt werden
+      * Now you have to create an attribute for every column
-      * Dies ist analog zu den Attributen im Smartform auszufüllen
+      * The usage is correspondent to the smartform-fields
-      * Wichtig: DA-Flag immer auf "SIU" setzen
+      * Important: DA-flag must be set to "SIU"
-      * Indizes: Hier geben Sie an, welche Spalten zur eindeutigen Referenz (= Index 1) eines Datensatzes zusammengezogen werden müssen
+      * Index: Here you have to select wich columns will be used as a unique reference (=index 1) of a data type
-      * Ref.-Typ:
+      * Ref.-type:
-        * Hier entscheiden Sie, welches Attribut mit "D" automatisch als Bezeichnung, z.B. später in einer Dropdown verwendet wird
+        * Here you select wich attribute will be used as a discription, for example in a drop. This is selected with "D"
-        * Hier entscheiden Sie, welches Attribut mit "I" automatisch als fachlicher Kurzidentifier verwendet wird
+        * Here you select wich attribute will be used as short identifier. This is selected with "I"
-        * Hier entscheiden Sie, welches Attribut mit "V" automatisch verwendet wird, wenn ein ausgewählter Eintrag gespeichert wird
+        * Here you select wich attribute will be used if a selected entry will be saved. This is selected with "V"
-        * Details siehe unten (Exemplarisches Ergebnis eines Dropdowneintrags im HTML: <option value="Attribut mit V">"Attribut mit I" "Attribut mit D"</option>)
+        * For further details see (Example of a dropdown-option in HTML: <option value="Attribut mit V">"Attribut mit I" "Attribut mit D"</option>)
-  * Nun muss die Datei via Tab Ressources im Admin Client hochgeladen werden. Hierbei ist der Datentyp Datendatei auszuwählen
+  * Now the file has to be reuploaded in the resource tab in the admin-client. Select the datatype "filefile"
-    * Nach dem Upload bitte den Button Cache löschen klicken, damit die neueste hochgeladene Version verwendet wird
+    * After the upload press the button "Delete Cache"
-  * Datentyp für Dropdown
+  * Data-type for Dropdown
-    * Damit die Tabelle nun als Grundlage für eine Dropdown oder ein Autocompletefeld verwendet werden kann, muss hierfür ein datentyp angelegt werden
+    * For the table to be used as a basis for a dropdown or an autocomplete field a data-type must be created
-      * Basistyp: = Datentyp der Spalte aus der CSV, die als eindeutige Referenz dient
+      * Baic-type: = Data-type of the column of the CSV which is used as the unique reference
-      * Eigenschaften: Referenzliste
+      * Properties: Reference list
-      * Tabelle: vorher angelegte Tabelle
+      * Table: a priviously created table
-      * Attribut: Das Attribut aus der Tabelle, das in der DB gespeichert werden soll. Es muss eindeutig sein. Entspricht dem Attribut mit dem "V"
+      * Attribute: The attribute from the table which should be saved in the database. It has to be unique. Matches the attribute with "V"
-      * Filter: optional - hier kann mit der Syntax ATTRIBUT= die Ergebnismenge der Tabelle auf ein Attribut eingeschränkt werden. Mittels ATTRIBUT={ATTRIBUT_IN_TIM_PROCESS} kann auch auf den Inhalt eines anderen Attributs gefiltert werden, um somit eine Filterung zu ermöglichen, die vom Inhalt eines anderen Attributs abhängig ist. WICHTIG: Das Attribut, wonach gefiltert werden soll, muss das Flag "r" haben, damit bei einem Wechsel des Wertes auch die Tabelle mit dem neuen Filter geladen wird
+      * Filter: optional - here you can limit the number of results to one attribute. Use this syntax: ATTRIBUT= . By using ATTRIBUT={ATTRIBUT_IN_TIM_PROCESS} you can search the content of another attribute. IMPORTANT: The attribute wich is searched has to have te "r"-flag, so if the value is changed the table will be loaded with the new filter.
-      * Anzeige:
+      * Display:
-        * leer lassen, dann zieht der Default, bestehend aus I und D
+        * Leave empty, then the default will be applied:I and D
-        * oder mit {Attribut} die Attribute auswählen, die angezeigt werden sollen. z.B.: {nachname}, {vorname} ergibt: "Schirach, Oliver"
+        * or select attributes with {Attribut}, that should be displayed e.g.: {nachname}, {vorname} results in: "Schirach, Oliver"
-  * Alternativ kann die Tabelle auch als Grid eingebunden werden, um Datensätze tabellarisch darzustellen oder bearbeitbar zu machen
+  * Alternativly a table can be used as a grid to display data sets in a table
-==== 7.4 Erstellung von Tabpages ====
+==== 7.4 Creation of tabpages ====
-  * Im Smartform muss ein Element mit der uie-tabpages-interfaces eingebunden werden.
+  * An element with the uie-tabpages-interfaces must be included into the smartform
-    * Soll das erste enthaltene Tab direkt geladen werden, dann muss unter Eigenschaften das Flag "t" ausgewählt werden
+    * If the first tab should load immediatly you have slect the Flag "t"
-  * Nun muss für jedes zu platzierende Tab ein Template erstellt werden
+  * Now you have to create a template for each tab
-    * Achtung: Bitte vermeiden Sie eine Überschneidung der verwendeten Elementbuchstaben, da sonst beim drag&drop die platzierten Attribute in allen Tabs auftauchen, in denen der selbe Buchstabe existiert
+    * Attention: Please avoid same element-letter, because then attributes would appear in every tab with the same letter
-    * Sollte eine Überschneidung von Buchstaben unumgänglich sein, so dürfen die Attribute, die in den betroffenen Buchstaben nur in einem Tab auftauchen, nicht per drag&drop platziert werden
+    * If overlapping letters cannot be avoided then attributes must not be placed by drag&drop
-    * Die Attribute müssten dann via Bedienoberflächen - Attribute in der tabellarischen Ansicht den jeweiligen Buchstaben zugeordnet werden. Achten Sie hierbei darauf, dass Sie sich im richtigen Tab befinden. Wenn in der Tabelle ein Elementbuchstabe eingegeben wird, dann erscheint das Attribut exakt nur in dem gewünschten Tab.
+    * The attributes then have to be placed via user interface - attribute assigned in the table to the selected letters. Make sure the selected tab is the one you want to place the attribute on. If an element-letter is entered in the table then the attribute will only appear on the selevted tab.
-  * Zur Kombination des Tabs mit dem Element im Smartform, müss aus dem Accordion in Bedienoberfläche - Editor der Eintrag "[neu] ()" aus dem Untermenü "Inhalte" auf das Element mit der uie-tabpages-interfaces gezogen werden
+  * In order to combine the tab with the element in the smartform, the entry "[new] ()" has to be drag&dropped from the accordion (content) onto the element with the uie-tabpages-interface
-    * Hierbei erscheint links eine leere Sidebar, in der das einzufügende Tab konfiguriert wird:
+    * An empty sidebar will appear, where the added Tab will be configured:
-      * Bedienoberfläche: technischer Name für das Tab
+      * User interface: technical name for the tab
-      * Beschriftung: im Smartform verwendeter Bezeichner für das Tab
+      * Description: label for the tab
-      * übergeordnet: Smartform
+      * superordinate: Smartform
-      * Template: Das zu verwendende Template für das Tab auswählen
+      * Template: The template for the tab
-      * Menü / Inhalt: Das Element mit der uie-tabpages-interfaces auswählen
+      * Menu / content: Select the element with the uie-tabpages-interfaces
-      * UIU: Wenn der Tab auch einfach nur Attribute enthält, die als Prozessvariablen in tim_process abgebildet werden, dann: uiu-selection
+      * UIU: If the tab contains processvariables that are saved in tim_process, then: uiu-selection
         * Wenn das Tab auf eine Tabelle zeigt, die mit dem Prozess in Verbindung steht, dann uiu-details
-      * Eigenschaften: E, damit der Tab generell editierbar ist
+      * Properties: E, so the tab is editable
-        * zusätzlich n und a, wenn der Tab auf eine Tabelle zeigt, di emit dem Prozess in Verbindung steht und die darin befindlichen Attribute unmittelbar im Tab angeordnet werden. Sobald eine grid in dem Tab verwendet wird, so sind n und a nicht zu verwenden
+        * additionally n and a, if the tab uses a table and the attribute are arranged in the tab. If you use a grid, don't use n and a
-      * Icons: keine notwendig. Sie kommen zum Tragen wenn über diesen Weg ein grid zur tabellarischen Ansicht/ Bearbeitung von Datensätzen eingebunden wird
+      * Icons: Not necessary. They are used if you use a grid to display data-sets
-      * Tabelle: tim_process, wenn einfach nur Prozessvariablen dargestellt werden sollen, oder eine andere fachliche Tabelle, wie gewünscht
+      * Table: tim_process, if only process varables should be displayed
-      * Filter: Einschränkung einer fachlichen Tabelle auf gewisse Einträge. So könnten z.B. aus einer Stammdatentabelle Informationen angezeigt werden, die entsprechend nach einem oder mehreren Attributen gefiltert sind
+      * Filter: Limitation of table to certain entries. YOu can desplay information that is filtered by one or more attributes
-==== 7.5 Integration einer fachlichen Tabelle als Grid ====
+==== 7.5 Integration of a table as a grid ====
-  * Achtung: verwendetes Template grid-Template unter Bedienoberfläche - Elemente - G - auf uie-grid-edit umstellen, sonst tauchen die Icons nicht auf
+  * Attention: Used template grid - template in the user interface section - Elements - G - set to uie-grid-edit or the icons won't be visible
-==== 7.6 Erstellung eines Accordions ====
+==== 7.6 Creation of an accordion ====
-  * Subelemente
+  * Subelements
-==== 7.7 Erstellung eines Groovy Codes, der beim Laden des Smartforms gezogen werden soll ====
+==== 7.7 Creation of a Groovy code, wich will be executed upon loading the smartform ====
-  * Im Modul Bedienoberfläche gibt es für jede Bedienoberfläche links in der Sidebar den Button "showInterface"
+  * In the module user interface there is a sidebar with the button "showInterface" for every interface
-    * Dort kann Groovy Code hinterlegt werden, der im Moment des Seitenaufbaus ausgeführt wird
+    * There you can save Groovy code which will be executed as soon as the site will be loaded
-  * Mit dem Flag r kann das Neuladen des Smartforms nach Eingabe eines Wertes in ein Feld aktiviert werden
+  * With the flag r you can reload a page after a value is entered.
-    * Dadurch wird das Smartform neu geladen und showInterface erneut ausgeführt
+    * The interface will be reloaded and showInterface will be executed again
-    * Ebenso werden dynamische Filter in Datentypen oder Tabellen, die auf andere Attribute zugreifen, neu ausgeführt
+    * All dynamic filters in data-types or tables that access other attributes will be executed again too
-    * Eingegebene Daten bleiben bei diesem Neuladen erhalten
+    * Incoming data will be preserved
-  * Beispiele:
+  * Examples:
-    * Auslesen der Benutzersprache und setzen in das Attribut "sprache":
+    * Pick out the user language and set it into the attribute "language":
       <code>
       def locale = FRAME.getProperty("locale_id").toUpperCase();
@@ Line 362: / Line 367: @@
       }
       </code>
-    * Setzen des UI-Flags für ein Attribut:
+    * Set a UI-Flags for an attribut:
       <code>
       ICbaRow attribut_xxxx = FRAME.searchRow("dd_intattr", "interf_recid=" + CONFIG_ROW.getRecid() + "&attr_id=TECHNISCHER_ATTRIBUTNAME");
@@ Line 368: / Line 373: @@
       </code>
-    * Lesen eines Wertes für ein Attribut:
+    * Read the value for an attribute:
       <code>
       String wert_des_attributs_im_moment_des_seitenaufbaus = DATA_ROW.getValue("TECHNISCHER_ATTRIBUTNAME");
       </code>
-    * Setzen eines Wertes für ein Attribut:
+    * Set a value for an attribute:
       <code>
       DATA_ROW.setValue("TECHNISCHER_ATTRIBUTNAME", "neuer_Wert_für_das_Attribut");
       </code>
-==== 7.8 Konfiguration von statusabhängigen Attributeigenschaften ====
+==== 7.8 Configuration of status-specified attribute-properties ====
-  * Zurücksetzen einzelner Attributvarianten auf Standard
+  * Reset variants of an attribute to standart
-  * „Für alle Status auf Standard zurücksetzen“ bzw. „Auf Standard zurücksetzen“ Schaltflächen
+  * „Reset for every status“ bzw. „Reset“ buttons
-  * Statusübersicht. Kopieren, Löschen, *** Schritt, der entfallen ist ***
+  * Statusoverview. Copy , delete , *** Step that has been omitted ***
 ----
 ===== 8. Installation =====
-  * siehe [[software:cba:installation_cba|Installation]]
+  * see also [[software:cba:installation_cba|Installation]]
 ----
-===== 9. Altes CBA Wiki =====
+===== 9. Old CBA Wiki =====
 <wrap indent>[[software:cba:start | 16.0 Übersicht ]] </wrap> \\
 <wrap indent>[[software:cba:overview | 16.1 Einführung ]] </wrap> \\

TIM Wiki / NEW TIM 6 Documentation

User Tools

Site Tools

Differences

Page Tools