This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
en:software:tim:section_handling [2014/06/30 11:54] melanie.yesilcay created |
en:software:tim:section_handling [2021/07/01 09:52] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | FIXME **This page is not fully translated, yet. Please help completing the translation.**\\ //(remove this paragraph once the translation is finished)// | + | |
==== General ==== | ==== General ==== | ||
Line 13: | Line 13: | ||
The part which should be affected by the Section Handling will be enclosed for example with **DIV** in the smartform, and therefore marks a completed part. \\ | The part which should be affected by the Section Handling will be enclosed for example with **DIV** in the smartform, and therefore marks a completed part. \\ | ||
- | The **DIV** should be given necessarily the attribute class="section". The ID of **DIV** can be chosen optional. \\ | + | The **DIV** should be given necessarily the attribute class="section".An element which has the attribute class = "section", can not have any other classes. The ID of **DIV** can be chosen optional. \\ |
Two DIV-areas are seen in the following example: | Two DIV-areas are seen in the following example: | ||
* DIV with the ID="section1", contains: | * DIV with the ID="section1", contains: | ||
Line 34: | Line 34: | ||
</code> | </code> | ||
- | >> If the Section is inside a table (<table>), a tBody should be used instead of a DIV, for defining the Section. | + | >> If the Section is inside a table (<table>), a tBody(tr,td) should be used instead of a DIV, for defining the Section. |
==== Section Handling Parameter ==== | ==== Section Handling Parameter ==== | ||
- | Die Parameter für das Section Handling, mit welchen die Rechte zugewiesen werden, werden in [[software:signavio| Signavio]] für den Prozess definiert : | + | The parameters for the Section Handling, with which the rights are assigned, are defined in [[en:software:igrafx_documentation| iGrafx]] for the process : |
- | {{ software:tim:eigenschaften.jpg?200 }} | + | {{ :en:software:tim:section_definition.png?500 |}} |
- | ==== Section Handling Parameter Allgemein ==== | + | ==== Section Handling Parameter general ==== |
<code XML> | <code XML> | ||
<section-node-mapping> | <section-node-mapping> | ||
- | <node-mapping name="Name_einer_Node_aus_dem_Prozess"> | + | <node-mapping name="Name_of_a_node_from_the_process"> |
- | <section name="ID_der_Section_aus_der_Smartform"> | + | <section name="ID_of_the_Section_from_the_smartform"> |
<read assignment="*"/> | <read assignment="*"/> | ||
<write assignment="*"/> | <write assignment="*"/> | ||
Line 55: | Line 55: | ||
</code> | </code> | ||
- | * **<section-node-mapping>** : das section-node-mapping Element ist das Hauptstück des Section Handlings, innerhalb welchem sich die Regeln für die Beschränkungen befinden | + | * **<section-node-mapping>** : the section-node-mapping element is the major component of the Section Handlings, where the rules of the restriction are |
- | * **<node-mapping>** : hier kann optional das Attribut name mitgegeben werden. Damit ist es möglich die Beschränkungen so zu konfigurieren, dass diese nur an einem bestimmten Stand innerhalb des Prozesses gelten, z.B. User A darf das Textfeld sehen, wenn die Smartform während der ersten Node geöffnet wird, aber nicht mehr sobald der Prozess sich auf Node B befindet. \\ Wird das Attribut name an dieser Stelle nicht mitgegeben erstrecken sich die Beschränkungen auf den gesamten Prozessverlauf .Zudem können innerhalb des **<section-node-mapping>** Elements mehrere **<node-mapping>** s angegeben werden. | + | * **<node-mapping>** : the attribute name can be given optionally here. This makes it possible to configure the restrictions that they apply only at a certain level within the process, e.g. User A is allowed to see the textarea, if the smartform is opend during the first node but not once the process is on node B. \\ If the attribute name is not given at this point, the restrictions extend to the entire course of the process. In addition, multiple **<node-mapping>** can be specified within the **<section-node-mapping>** element. |
- | * **<section>** diesem Element muss das Attribut name mitgegeben werden, welches die ID der gewünschten Section aus der Smartform angibt. Innerhalb des Section Elements können nun die Rechte verteilt werden, die für die angegebene Section gelten sollen. | + | * **<section>** to this element must be given the attribute name, which indicates the ID of the desired Section of the smartform. Within the Section element, now the rights can be distributed that will apply for the specified Section. |
- | * **<read>** über das read Element wird nun bestimmt, wer den Inhalt innerhalb einer Section sehen darf. Die Personen werden über das Assignement Attribut bestimmt. | + | * **<read>** it can be defined now via the read element, who can see the content within a section. The people are determined via the assignment attribute. |
- | * **<write>** über das write Element wird nun bestimmt, wer den Inhalt innerhalb einer Section bearbeiten darf (z.B. in ein Textfeld schreiben). Die Personen werden über das Assignement Attribut bestimmt. | + | * **<write>** it can be defined now via the write element, who can work on the content within a section (e.g. write in a textarea). The people are determined via the assignment attribute. |
---- | ---- | ||
Line 65: | Line 65: | ||
====Assignment==== | ====Assignment==== | ||
- | Für die Assignments innerhalb der read und write Elemente stehen nun folgende Möglichkeiten zur Auswahl: | + | Following options are now available for the assignments within the read and write elements: |
- | ^ Zielgruppe ^ Schreibweise ^ | + | ^ Target group ^ Notation ^ |
- | | einzelne Benutzer | "user(Benutzername)" | | + | | individual user | "user(username)" | |
- | | Swimlanes | "swimlane(Swimlanename)" | | + | | Swimlanes | "swimlane(swimlanename)" | |
- | | Gruppe | "group(Gruppenname)" | | + | | Group | "group(groupname)" | |
- | | Wildcard (für keinen Benutzer) | "" | | + | | Wildcard (for no user) | "" | |
- | |Wildcard (keine Beschränkung) | "*"| | + | |Wildcard (for all users) | "*"| |
- | |Negation(dieser User darf nicht...) | "! user(…)"| | + | |Negation(this user can not...) | "! user(…)"| |
- | Mehrere Angaben können getrennt durch Semikolons realisiert werden, z. B.: "group(Vertrieb);group(Controlling);user(Max.Mustermann)" | + | Multiple selections can be realized by semicolons, e.g.: "group(Sales);group(Controlling);user(john.doe)" |
====Locking==== | ====Locking==== | ||
- | Locking kann zusätzlich zu den Assignments angegeben werden und dient als Bearbeitungssperre. Um das Locking zu implementieren muss der Parameter lockable="true" angegeben werden. Locking kann auf das node-mapping oder die section selbst gelegt werden. Das locking Attribut der section überwiegt immer das Attribut des node-mappings. | + | Locking can also be specified to the assignments and is used as a lock for editing. For implementation the locking the parameter lockable="true" must be declared. Locking can be place on the node-mapping or the section itself. The locking attribute of the section always outweighs the attribute of node-mappings. |
<code xml> | <code xml> | ||
Line 95: | Line 95: | ||
</code> | </code> | ||
- | Wird nun die Smartform geöffnet, ist der Bereich standardmäßig gesperrt, jedoch befindet sich hinter den gelockten Elementen ein Stiftsymbol : | + | If now the smartform is opend, the area is locked by default, but behind the locked element is a pen symbol: |
{{ software:tim:locking.jpg?200 }} | {{ software:tim:locking.jpg?200 }} | ||
- | Über einen Klick auf das Symbol kann das gelockte/gesperrte Feld entsperrt werden und somit auch bearbeitet werden. | + | Via a click on the symbol, the locked array can be unlocked and therefore edited. |
- | Das Feld ist nach dem Klick für alle anderen User gesperrt, d.h. öffnet ein anderer Benutzer die Smartform ist es für ihn nicht möglich das für ihn gesperrte Feld ebenfalls zu entsperren und zu bearbeiten während das Feld von dem ersten User entsperrt ist. | + | The array is locked for all the other users after clicking, which means if an other user opens the smartform it is not possible to unlock and edit the locked array while the array is unlocked by the first user. |
- | Damit wird verhindert dass eingegebene Daten versehentlich von einem anderen Nutzer überschrieben werden. | + | This is for preventing that input data are accidentally overwritten by an other user. |
- | Das Feld kann erst dann wieder von anderen Nutzern entsperrt werden, wenn der Benutzer der das derzeitige Bearbeitungsrecht besitzt die Smartform speichert und schließt. | + | The field can only be unlocked by other users, if the user, who owns the current edit permission, saves and closes the smartform. |
- | ====Siftsymbole ausblenden==== | + | ====Remove pen symbols==== |
- | Ist lockable auf false gesetzt, wird vor der einer Section ein Stiftsymbol angezeigt, solange sich der Prozess nicht an der Node befindet die in dem zugehörigen NodeMapping angegeben wurde. Befindet sich der Prozess dann an der Stelle, die angegeben wurde, so wird das Stiftsymbol ausgeblendet. | + | If lockable is set on false, a pen sybol appears infront of a section as long as the process is not at the node which was specified in the associated NodeMapping. If the process is then at the stage which is specified, the pen symbol will be removed. |
- | Sollen nun alle Stiftsymbole ausgeblendet werden, so muss ein globales NodeMapping angegeben werden, in welchem alle Sections einmal definiert werden und ein Assignment bekommen. Soll sich an der Funktionsweise der Smartform nichts ändern, so reicht es in dem globalen NodeMapping jeder Section eine Wildcard zu geben. | + | If now all pen symbols shall be removed, a global NodeMapping must be specified, in which all sections are defined once and get an assignment. If there is no change onf the functioning of the smartform, it is enough to give a wildcard to every section in the global NodeMapping. |
- | ====NodeMapping bereits vor Instanzstart==== | + | ====NodeMapping before instance start==== |
- | Sollen bereits vor Start der Instanz Bereiche eingegrenzt werden, so muss ein NodeMapping eingefügt werden, welches den Namen des Starts trägt. | + | If parts should be limited before instance start, a NodeMapping must be inserted which has the name of the start. |
- | Ist kein Name für den Start angegeben, so bekommt der Start standardmäßig den Namen **"StartEvent_1"** und das Ende den Namen **"EndEvent_1"**, dieser kann dann im NodeMapping benutzt werden | + | If no name is given for the start, the start gets the name **"StartEvent_1"** by default and the end the name **"EndEvent_1"**, which can be used in NodeMapping |
----- | ----- | ||
- | ==== Section Handling Parameter Beispiele anhand des Smartform Beispiels ==== | + | ==== Section Handling Parameter examples using the smartform examples ==== |
- | Das folgende Bild zeigt den Ausgangszustand der Smartform ohne Section Handling (alles ist sichtbar und bearbeitbar): | + | The following image shows the initial state of the smartform without Section Handling (everything is visible and editable): |
{{ software:tim:sfohne.jpg?200 }} | {{ software:tim:sfohne.jpg?200 }} | ||
- | Der obere Teil befindet sich in der ersten Section und der untere Teil befindet sich in der zweiten Section. | + | The upper part is in the first section and the lower part in the second section. |
- | Bei den Beispielen werden alle auf einen User als Beschränkter ausgelegt, es ist jedoch genauso möglich alle folgenden Beispiele mit den oben genannten Assignments durchzuführen. | + | In the examples all are designed for one user as limited, but it is also possible to carry out all following examples with the assignments from above. |
- | Es können nun die folgenden Szenarien mit Hilfe des Section Handlings erzeugt werden: | + | The following szenarios can now be generated by using of the Section Handling: |
Line 132: | Line 132: | ||
- | === Section nur für bestimmten User sichtbar und bearbeitbar === | + | === Section visible and editable only for certain users === |
- | Nun soll der obere Teil nur für einen bestimmten User sichtbar und bearbeitbar sein. Die dafür benutzten Section Handling Parameter könnten wie folgt aussehen: | + | Now the upper part shall be visible and editable only for a specific user. The used Section Handling parameter for this, might look like this: |
<code XML> | <code XML> | ||
Line 151: | Line 151: | ||
</code> | </code> | ||
- | Die Smartform würde für den User TIM nach wie vor aussehen wir der Ausgangszustand für alle anderen jedoch würde sich das folgende Bild ergeben: | + | The smartform would be look like the initial state for the user TIM like for all the others but the following picture would result: |
{{ software:tim:nosection1.jpg?200 }} | {{ software:tim:nosection1.jpg?200 }} | ||
- | Wie man sieht ist nur der untere Teil der Smartform sichtbar. | + | As you can see, only the lower part of the smartform is visible. |
---- | ---- | ||
- | === Section nur für bestimmten User bearbeitbar === | + | === Section editable only for certain user === |
- | Nun soll der obere Teil zwar sichtbar sein, jedoch nur für den User TIM bearbeitbar sein. Die dafür benutzten Section Handling Parameter könnten wie folgt aussehen: | + | Now the upper part shall be visible, but editable only for the user TIM. The used Section Handling parameter for this, might look like this: |
<code XML> | <code XML> | ||
Line 177: | Line 177: | ||
</code> | </code> | ||
- | Daraus ergibt sich wiederrum das folgende Bild für alle anderen User, die die Smartform öffnen wollen: | + | In turn the following image for all other users results, who want to open the smartform: |
{{ software:tim:sfwritebottom.jpg?200 }} | {{ software:tim:sfwritebottom.jpg?200 }} | ||
- | Die obere Section ist nun zwar für alle sichtbar, jedoch kann in das Textfeld nichts eingegeben werden, da der read Parameter nicht gesetzt ist. | + | The upper Section is now visible for everybody, but nothing can be entered in the textarea, because the read parameter is not set. |
---- | ---- | ||
- | === Section Beschränkung auf begrenzten Bereich innerhalb des Prozesses === | + | === Section restriction on limited area within the process === |
- | Die Beschränkungen in den bisherigen Beispielen waren global und gelten für den gesamten Prozess.Nun kann man die Beschränkungen aber auch nur an bestimmten Stellen in einem Prozess geltend machen. | + | The restrictions in the previous examples were global and apply to the entire process. Now it is possible to assert the restriction at certain points in the process. |
- | Nun soll das erste Beispiel, in dem nur die zweite Section sichtbar ist so erweitert werden, dass die Beschränkung nur dann gilt, wenn sich der Prozessfortschritt auf einer bestimmten Node befindet. | + | The first example, where only the second section is visible, shall be extended now, that the restriction only applies if the progress of the process is at a particular node. |
- | Dies soll anhand des folgenden Prozesses verdeutlicht werden:\\ | + | This will be illustrated by the following process:\\ |
- | {{ software:tim:prozess.jpg?550 }} | + | {{ en:software:tim:section_task.png?550 }} |
- | Das gewünschte Ziel ist, dass solange sich der Prozess auf der Node A befindet nur der User TIM den oberen Teil der Smartform sehen darf. Sobald sich der Prozess auf Node B befindet darf zwar jeder den oberen Teil sehen, aber nicht bearbeiten. Hierfür müssen für jede Node die section Parameter angegeben werden .Die Parameter um dieses Ziel zu erreichen sind die folgenden: | + | The desired goal is, that as long as the process is at node Sales only the user TIM is allowed to see the upper part of the smartform. Once the process is at node Controlling everybody is allowed to see the upper part but not to edit. Therefore for every node section Parameter must be specified. The parameters for achieving the goal are the following: |
<code XML> | <code XML> | ||
<section-node-mapping> | <section-node-mapping> | ||
- | <node-mapping name="A"> | + | <node-mapping name="Sales"> |
<section name="section1"> | <section name="section1"> | ||
<read assignment="user(TIM)"/> | <read assignment="user(TIM)"/> | ||
Line 200: | Line 200: | ||
</section> | </section> | ||
</node-mapping> | </node-mapping> | ||
- | <node-mapping name="B"> | + | <node-mapping name="Controlling"> |
<section name="section1"> | <section name="section1"> | ||
<read assignment="*"/> | <read assignment="*"/> | ||
Line 213: | Line 213: | ||
</code> | </code> | ||
- | Während des ganzen Prozesses kann der User TIM die gesamte Smartform einsehen und bearbeiten da für ihn keine Beschränkungen angegeben sind. Befindet sich der Prozess auf der Node A ergibt sich für alle anderen das folgende Bild wenn die Smartform geöffnet wird: | + | During the whole process, the user TIM can view and edit the entire smartform because there are no restricitions for the user. If the process is on node A, the following image emerges for everybody else when the smartform is opened: |
- | Nur der untere Teil ist sichbar. | + | Only the lower part is visible. |
{{ software:tim:nosection1.jpg?200 }} | {{ software:tim:nosection1.jpg?200 }} | ||
- | Wird die Aufgabe nun erledigt und der Prozess schreitet auf Node b voran, kann der User TIM weiterhin alles sehen. Für alle anderen sieht die Smartform so aus: | + | If the task is now done and the process proceeds to node B, the user TIM can still see everything. For everybody else the smartform looks like this: |
- | Der obere Teil ist nicht bearbeitbar, aber sichtbar. | + | The upper part is not editable but visible. |
{{ software:tim:sfwritebottom.jpg?200 }} | {{ software:tim:sfwritebottom.jpg?200 }} | ||
---- | ---- | ||
- | === Wie verhält sich das Sectionhandling in der Smartform Suche? === | + | === How does the Sectionhandling behaves in the smartform search? === |
- | In der Smartform Suche werden nur die Read-Expressions angewendet welche für den ganzen Prozess gültig sind.\\ | + | In the smartform search only the read-expressions are used which are valid for the whole process.\\ |
\\ | \\ | ||
- | Das heißt:\\ | + | That means:\\ |
\\ | \\ | ||
- | Wenn ich die Section generell sehen darf, darf ich auch danach suchen und vice versa. | + | If I can see the Section in general, I may even search for it and vice versa. |