This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
en:software:tim:start_instance [2014/06/05 09:27] melanie.yesilcay |
en:software:tim:start_instance [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)// | + | ===== Starting a Process Instance ===== |
+ | Process instances can be started using either the ToDo-Client or the Process-Manager Client. Both options require that the user have the right to start an instance for the given process definition. | ||
- | ====Start process instance==== | + | ==== Starting an instance in the Process Manager Client ==== |
- | For starting a run of an instance, a process instance must be started based on a definition. | + | The **processes** table in the process manager client displays the available process definitions. By clicking on the plus-icon, an instance for the selected process definition can be started. |
- | There are several ways: | + | |
- | * via [[todo-processmanager4g| Processmanager Client]]. (see element 7) | + | |
- | * via [[todo_clients| ToDo Client]] (see element 12) and thereby opening window | + | |
- | {{ :software:tim:todo_prozess_starten.jpg }} | ||
- | ===Start of an instance=== | + | {{:software:tim:startInstance_en.png?800|}} |
- | If a new instance shall be started, the following window opens: | + | Before the instance initiates, a pop-up appears in which the instance parameters can be entered; these include the instance name and description as well as the intended starting and ending dates. |
- | {{ :software:tim:todo_instanzstart.jpg }} | + | |
+ | {{:software:tim:startInstance2_en.png?800|}} | ||
^ Element ^ Description ^ | ^ Element ^ Description ^ | ||
- | | **1** | Here you can give an instance any name. | | + | | **1** | Here the instance is given a user-defined name. | |
- | | **2** | Here you can enter an additional description for the instance, for example, a description of the instance function or other information. | | + | | **2** | Here an additional description for the instance, for example, a description of the instance function or other information, can be entered. | |
- | | **3** | Here you can set a planned start for the instance. This is relevant mainly for the [[:support:cpm | CPM-Modul ]]. | | + | | **3** | Here the scheduled start for the instance is entered. This is relevant primarily for the [[en:support:cpm | CPM-Modul ]]. | |
- | | **4** | Here you can set a planned end for the instance. This is relevant mainly for the [[:support:cpm | CPM-Modul ]]. | | + | | **4** | Here the scheduled end for the instance is entered. This is relevant primarily for the [[en:support:cpm | CPM-Modul ]]. | |
- | | **5** | If the required information is entered, the instance can get started via this button. | | + | | **5** | Once the required information is entered, clicking this button starts the instance. | |
- | | **6** | Through the slide **Smartform** the smartform of the process opens and information can be set, which are already relevant by start of the instance. | | + | | **6** | The **Smartform**-tab opens the Smartform of the given process. Here, information that becomes relevant after the instance start can be entered. | |
+ | | **7** | In **Documents** tab, instance-related documents can be attached. | | ||
+ | |||
+ | ===Requirements for starting an instance=== | ||
+ | Not every user has the rights to start an instance for a process definition. In order to grant a user the rights to start an instance, the following criteria must be fulfilled: | ||
+ | * the user must be registered as a **starter** in Signavio (or iGrafx), or be part of a group which is registered as a **starter** | ||
+ | * the user must have the starter [[roles| rights ]] | ||
+ | |||
+ | If all criteria are met, the user is able to start an instance within the relevant process definition. | ||
+ | |||
+ | ==== Starting an instance in the Todo Client ==== | ||
+ | |||
+ | In the Todo Client you can start instances via the context menu in the upper right corner of the screen (see screenshot). | ||
+ | |||
+ | {{:software:tim:todostartpi.png?600|}} | ||
+ | |||
+ | In the **My startable process** pop up you can select the process definition to start an instance from (see Screenshot). | ||
+ | |||
+ | {{:software:tim:todostartpi2.png?600|}} | ||
+ | |||
+ | The necessary parameter to start an instance, have to be enter in the same way as in the Process Manager Client. | ||
- | ===Requirements for the start of an instance=== | + | ==== Starting an instance via a webform ==== |
- | Not every user can start a new instance, because the user takes part in a process only and does not actively start the process. | + | Process instances can be from without TIM via a [[en:software:tim:webform|Webform]]. This particularly useful if not all process participants have access to TIM. How to create webform is described in detail in the [[en:software:tim:webform|Webform page]].\\ |
- | For approving the instance start to a user the following conditions must be met: | + | \\ In the webform the process instance is created on submission by the following line. In the example a process instance of the **8D Problem Solving** process is created. |
- | * the user must be registered as **starter** in Signavio, or be part of the group which is registered as **starter** | + | <code><input type="hidden" name="processdefinition" id="processdefinition" value="8D Problem Solving" /></code> |
- | * the user must have the [[rights| right ]] starter | + | <note important>To start a process instance via a webform, the respective process definition has to be published in TIM</note> |
- | If all this is fulfilled, the user can see the relevant definition in its list and launch instances of this. | + | ==== Starting an instance via a URL ==== |
+ | Furthermore instances can be started via a URL. To do so, the term **startProcessInstanceByProcessDefinition="name of the process definition"** is attached to the TIM server URL.\\ | ||
+ | The following example URL starts an instance of the 8D Problem Solving process | ||
+ | <code>http://tim.taskinmotion.de/loom-portal/client/todo/index.htm?startProcessInstanceByProcessDefinition=8D%20Problem%20Solving</code> | ||
+ | <note important>To start a process instance via a webform, the respective process definition has to be published in TIM</note> | ||