opis_plikow_xml_workflow [Firmatic]

Ta strona jest tylko do odczytu. Możesz wyświetlić źródła tej strony ale nie możesz ich zmienić.

<h1>XML dla Workflow</h1>
<div class="level1">

<p>
Jako repozytorium i silnik bpmn używamy Activiti.
Poniższa dokumentacja jest rozszerzeniem <a href="http://www.activiti.org/userguide/index.html#bpmn20" class="urlextern" title="http://www.activiti.org/userguide/index.html#bpmn20"  rel="nofollow">http://www.activiti.org/userguide/index.html#bpmn20</a> i należy się z nią wcześniej zapoznać.
</p>

</div>

<h2>Ogólny opis zawartości pliku</h2>
<div class="level2">

<p>
W pliku występują następujące znaczniki:
</p>
<ol>
<li class="level1"> <em><</em>startEvent> - oznacza rozpoczęcie workflow i może zawierać formatkę</li>
<li class="level1"> <em><</em>userTask> - oznacza pojedyncze zadania i może zawierać formatkę</li>
<li class="level1"> <em><</em>documentation> - oznacza opis do zadania</li>
<li class="level1"> <em><</em>extensionElements> - zawiera opisy formatki</li>
<li class="level1"> <em><</em>activiti:formProperty> - zawiera opis pojedynczego pola z formatki</li>
</ol>

</div>

<h2>Przykład znacznika //<//startEvent></h2>
<div class="level2">
<pre class="code xml">< startEvent id="start" activiti:initiator="owner">
< extensionElements>
   <span class="sc1">&lt;</span>activiti:formProperty id="ID:firTytul;TYPE:FIRMATIC_FIELD;ARGS:FIR_NAME:Tytul;" name="Tytuł" type="string" /<span class="sc1">&gt;</span>
   <span class="sc1">&lt;</span>activiti:formProperty id="ID:firDate_Realize;TYPE:FIRMATIC_FIELD;ARGS:FIR_NAME:Date_Realize;" name="Data realizacji" type="string" /<span class="sc1">&gt;</span>
   <span class="sc1">&lt;</span>activiti:formProperty id="ID:firAPartnerIdent;TYPE:FIRMATIC_FIELD;ARGS:FIR_NAME:APartnerIdent;" name="Kontrahent symbol" type="string" /<span class="sc1">&gt;</span>
   <span class="sc1">&lt;</span>activiti:formProperty id="ID:firAPartnerName;TYPE:FIRMATIC_FIELD;ARGS:FIR_NAME:APartnerName;" name="Kontrahent" type="string" /<span class="sc1">&gt;</span>
   <span class="sc1">&lt;</span>activiti:formProperty id="ID:firDescription;TYPE:FIRMATIC_FIELD;ARGS:{FIR_NAME:Description, FIELD_OPT:TEXTAREA};" name="Opis" type="string" /<span class="sc1">&gt;</span>
   <span class="sc1">&lt;</span>activiti:formProperty id="ID:firBtn;TYPE:FIRMATIC_SIGNAL;ARGS:KEY:306;" name="Pokaż WKT" type="string" /<span class="sc1">&gt;</span>
< /extensionElements>
< /startEvent>

</pre><p> </p>




<p>
Wartości parametru <b>name</b> mogą być dowolne i nie mają wpływu na pracę workflow.
</p>

</div>

<h2>Opis znacznika //<//activiti:formProperty></h2>
<div class="level2">

<p>
Jest to najważniejszy znacznik w workflow i definiuje on co będzie widział użytkownik na formatce.
Istotne znaczenie mają atrybuty id i type.
</p>

<p>
Atrybuty dodatkowe:
</p>
<ul>
<li class="level1"> writable - określa możliwość zapisu</li>
<li class="level1"> readable - określa możliwość widoczności</li>
<li class="level1"> default - określa wartość początkową pola</li>
<li class="level1"> required - określa wymagalność pola</li>
</ul>

<p>
Znaczenie poszczególnych wartości w atrybutach zostanie pokazana na przykładach:
</p>

</div>

<h5>Pole firmaticowe</h5>
<div class="level5">
<pre class="code xml">< activiti:formProperty id="ID:firTytul;TYPE:FIRMATIC_FIELD;ARGS:FIR_NAME:Tytul;" name="Tytuł" type="string" />

</pre><p> </p>



<ul>
<li class="level1"> ID - jest nazwą dowolną używaną tylko w workflow</li>
<li class="level1"> TYPE - FIRMATIC_FIELD</li>
<li class="level1"> ARGS - FIR_NAME:Tytul - <b>Tytul</b> jest to nazwa pola znajdująca się w xmlu z firmatica</li>
</ul>

<p>
W tym polu można używać atrybutu writable w celu ograniczenia edytowalności pola (tzn. z pola edytowalnego w firmaticu można zrobić nieedytowalne w workflow).
</p>

</div>

<h5>Pole firmaticowe odświeżane w zakładce "Informacje o procesie"</h5>
<div class="level5">

<p>
Domyślnie pola firmaticowe w zakładce "Informacje o procesie" nie są odświeżane. Można wymusić odświeżanie poprzez zastosowanie opcji MUTABLE
</p>
<pre class="code xml">< activiti:formProperty id="ID:firPrefix;TYPE:FIRMATIC_FIELD;ARGS:{FIR_NAME:NumberPrefix, MUTABLE:true};" name="Prefix" type="string" />

</pre><p> </p>




</div>

<h5>Pole firmaticowe wyświetlane jako TextArea</h5>
<div class="level5">
<pre class="code xml">< activiti:formProperty id="ID:firDescription;TYPE:FIRMATIC_FIELD;ARGS:{FIR_NAME:Description, FIELD_OPT:TEXTAREA};" name="Opis" type="string" />

</pre><p> </p>

<p>
<span class='np_break'> </span>
Dodatkowy parametr w ARGS to FIELD_OPT.
</p>

</div>

<h5>Pole firmaticowe typu przycisk</h5>
<div class="level5">

<p>
Pole to tworzy na formatce przycisk o dowolnej nazwie. Jego kliknięcie powoduje wysłanie komunikatu do Firmatica.
</p>
<pre class="code xml">< activiti:formProperty id="ID:firBtn;TYPE:FIRMATIC_SIGNAL;ARGS:{KEY:1097,CODEPROC:121};" name="Oferta" type="string" />

</pre><p> </p>



<ul>
<li class="level1"> TYPE - FIRMATIC_SIGNAL</li>
<li class="level1"> KEY - kod klawisza który ma być wysłany</li>
<li class="level1"> CODEPROC - codeproc który ma być dołączony do klawisza</li>
</ul>

</div>

<h5>Pole workflow typu string</h5>
<div class="level5">
<pre class="code xml">< activiti:formProperty id="ID:wp_o_1_comment;" name="Komentarz" type="string" required="true" />

</pre><p> </p>




</div>

<h5>Pole workflow typu string - wyświetlane jako TextArea</h5>
<div class="level5">
<pre class="code xml">< activiti:formProperty id="ID:wp_o_1_comment;TYPE:TEXTAREA;" name="Komentarz" type="string" required="true" />

</pre><p> </p>




</div>

<h5>Pole wyboru użytkownika</h5>
<div class="level5">
<pre class="code xml">< activiti:formProperty id="ID:PTP_boss;TYPE:FIRMATIC_USER;" name="Sekcja PTP" type="string" variable="PTP_boss" required="false" default="user:tadkob" />

</pre><p> </p>

<p>
<span class='np_break'> </span>
W powyższym przykładzie wykorzystano atrybut variable, który zawsze musi mieć wartość taką jak "ID". Jest on używany do przypisywania zadań do użytkowników za pomocą zmiennych.
</p>

</div>

<h5>Pole wyboru użytkownika z opcją DW</h5>
<div class="level5">

<p>
Jest to specjalne pole, które umożliwia dodanie nowej linii firmaticowej dla użytkownika, nawet jeżeli nie jest on przypisany do żadnego zadania.
</p>
<pre class="code xml">< activiti:formProperty id="ID:dw_1;TYPE:FIRMATIC_USER;ARGS:DW:TRUE;" name="DW PT" type="string" variable="dw_1" required="false" writable="true" default="user:b" />

</pre><p> </p>



<ul>
<li class="level1"> DW:TRUE - oznacza, że pole jest do wiadomości</li>
<li class="level1"> ARGS:{DW:TRUE, INNER_LIST:szef} - można również zdefiniować listę z której wybiera się pracowników</li>
</ul>

</div>

<h5>Pole wyboru użytkownika ze wskazaniem grupy oraz z wartością domyślną</h5>
<div class="level5">

<p>
Jest to pole wyboru użytkownika ze specjalnymi opcjami. Pierwszą z nich wskazanie listy z której można wybierać użytkowników. Drugim elementem jest wartość domyślna. Może ona zarówno określać pojedynczego użytkownika jak i całą listę.
</p>
<pre class="code xml">< activiti:formProperty id="ID:user;TYPE:FIRMATIC_USER;ARGS:INNER_LIST:PTP-330;" name="Sekcja PTP-330" type="string" variable="user" required="false" writable="true" default="user:b" />

</pre><p> </p>



<ul>
<li class="level1"> INNER_LIST:PTP-330 - wybór będzie tylko z listy PTP-330</li>
</ul>

</div>

<h5>Pole wyświetlające linie 2 spraw</h5>
<div class="level5">
<pre class="code xml">< activiti:formProperty id="ID:firLineAff0;TYPE:FIRMATIC_LINEAFF2;ARGS:{NUM:9, FIELD_OPT:TEXTAREA, FIELD_HEIGHT:100};" name="Komentarz do sprawy" type="string" writable="true" />

</pre><p> </p>



<ul>
<li class="level1"> TYPE - musi być FIRMATIC_LINEAFF2</li>
<li class="level1"> NUM:9 - jeżeli na danej formatce ma być więcej pól tego typu to każde musi mieć swój numer</li>
<li class="level1"> FIELD_HEIGHT:100 - określenie wysokości pola w px</li>
</ul>

</div>

<h5>Pole typu radio button</h5>
<div class="level5">
<pre class="code xml">< activiti:formProperty id="ID:nextStep;DEFAULT:;" name="Czy zakończyć?" type="enum" required="true" variable="nextStep">
	< activiti:value id="isEnd" name="Koniec sprawy" />
	< activiti:value id="answer" name="Odpowiedź do osoby" />
< /activiti:formProperty>

</pre><p> </p>



<ul>
<li class="level1"> DEFAULT: - oznacza, że nie ma wartości domyślnej, mogło by też być np. DEFAULT:isEnd i wówczas isEnd byłoby znaznaczone</li>
</ul>

</div>

<h5>Pole z historią zmian</h5>
<div class="level5">
<pre class="code xml">< activiti:formProperty id="ID:firLog;TYPE:FIRMATIC_LINEAFF2_LOG;ARGS:{NUM:0, FIELD_OPT:TEXTAREA, FIELD_HEIGHT:100};ARGS2:{firDescription};" name="Historia zmian" type="string" writable="true" />

</pre><p> </p>



<ul>
<li class="level1"> TYPE - FIRMATIC_LINEAFF2_LOG</li>
<li class="level1"> NUM:0 - lepiej stosować konwencję i dać 0</li>
<li class="level1"> ARGS2:{firDescription} - oznacza jakie pola mają być brane do historii zmian</li>
</ul>

</div>

<h5>Pole z warunkową walidacją</h5>
<div class="level5">
<pre class="code xml">< activiti:formProperty id="ID:worker;TYPE:FIRMATIC_USER;REQUIRED_IF_EXPR:{#is_to_board == 'false'};" name="Osoba odpowiedzialna" type="string" variable="worker" writable="true" />

</pre><p> </p>



<ul>
<li class="level1"> REQUIRED_IF_EXPR - pole to będzie wymagane jeżeli zostanie spełnione wyrażenie</li>
</ul>

</div>

<h5>Wartości domyślne w polach z użytkownikami</h5>
<div class="level5">
<ul>
<li class="level1"> default="list:szef" - domyślnie lista szef (= wszyscy pracownicy z tej listy)</li>
<li class="level1"> default="user:b" - domyślnie tylko jeden pracownik </li>
</ul>

</div>

<h2>Przepływy i warunki</h2>
<div class="level2">

<p>
Ogólnie o przepływach i warunkach należy przeczytać w dokumentacji do Activiti.
</p>

<p>
W <b>startEvent</b> lub <b>userTask</b> można zdefiniować pole logiczne lub enum które będzie użyte w sterowaniu przepływem.
</p>

</div>

<h3>Przepływ po zmiennej logicznej</h3>
<div class="level3">

<p>
Najpierw w <b>userTask</b> definiujemy zmienną logiczną:
</p>
<pre class="code xml">< activiti:formProperty id="ID:is_claim_valid;" name="Czy reklamacja zasadna?" type="boolean" variable="is_claim_valid" />

</pre><p> </p>



<ul>
<li class="level1"> variable="is_claim_valid" - pozwala na odnoszenie się do tej zmiennej w innych punktach xml-a</li>
</ul>

<p>
Następnie możemy zdefiniować warunek:
</p>
<pre class="code xml">< sequenceFlow sourceRef="do_work" targetRef="after_worker_decision" />
 
< exclusiveGateway id="after_worker_decision" />
< sequenceFlow sourceRef="after_worker_decision" targetRef="claim_denied_work">
      <span class="sc1">&lt;</span>conditionExpression xsi:type="tFormalExpression"<span class="sc1">&gt;</span>${is_claim_valid == 'false'}<span class="sc1">&lt;</span>/conditionExpression<span class="sc1">&gt;</span>
< /sequenceFlow>
 
< sequenceFlow sourceRef="after_worker_decision" targetRef="claim_accept_work">
      <span class="sc1">&lt;</span>conditionExpression xsi:type="tFormalExpression"<span class="sc1">&gt;</span>${is_claim_valid == 'true'}<span class="sc1">&lt;</span>/conditionExpression<span class="sc1">&gt;</span>
< /sequenceFlow>

</pre><p> </p>




</div>

<h3>Przepływ po zmiennej enum</h3>
<div class="level3">

<p>
Najpierw w <b>userTask</b> definiujemy zmienną enum:
</p>
<pre class="code xml">< activiti:formProperty id="ID:is_to_board_approval;DEFAULT:;" name="Czy skierować do zarządu?" type="enum" required="true" variable="is_to_board_approval">
	< activiti:value id="toBoard" name="Skierować do zarządu (ostateczne zatwierdzenie)" />
	< activiti:value id="sendToWorker" name="Do kolejnej osoby (opis pozycji)" />
< /activiti:formProperty>

</pre><p> </p>



<ul>
<li class="level1"> variable="is_to_board_approval"</li>
</ul>

<p>
Następnie możemy zdefiniować warunek:
</p>
<pre class="code xml">< sequenceFlow sourceRef="describe_invoice" targetRef="after_describe_decision" />
< exclusiveGateway id="after_describe_decision" default="after_describe_decision_flow3" />
 
< !-- do zatwierdzenia do zarządu -->
< sequenceFlow id="after_describe_decision_flow1" sourceRef="after_describe_decision" targetRef="board_approval">
	< conditionExpression xsi:type="tFormalExpression">${is_to_board_approval == 'toBoard'}< /conditionExpression>
< /sequenceFlow>
 
< !-- do kolejnego pracownika -->
< sequenceFlow id="after_describe_decision_flow3" sourceRef="after_describe_decision" targetRef="describe_invoice">
< /sequenceFlow>

</pre><p> </p>



<ul>
<li class="level1"> z uwagi na default="after_describe_decision_flow3", nie trzeba definiować warunku przepływu w <em><</em>sequenceFlow id="after_describe_decision_flow3"</li>
</ul>

</div>
Narzędzia użytkownika

Narzędzia witryny

Narzędzia strony
