Manual Interaction - Xyna-Factory/xyna GitHub Wiki

Figure 1: Manual Interaction Figure 2: Error handling example with Retry step
(A) Cancel, (B) Continue, (C) Retry

In some processes it is essential that single Process Steps are executed manually before the further process can continue automatically. The Modeling Block Manual Interaction (MI) can be used to mark a position inside a Workflow, at which the process will be interrupted until a user finishes this MI from the exterior.

A Xyna Order corresponding to a process, which is situated in Manual Interaction, is indicated in the MI Monitor section of the Xyna Process Monitor and can be continued, retried or canceled from there. If the user chooses Continue or Retry, this result is returned via the Manual Interaction's Output Parameter (cf. fig. 2 (B), fig. 2 (C) respectively). If the user chooses Cancel, the Manual Interaction Process Step throws an Manual Interaction Aborted Exception (cf. fig. 2 (A)).

Prerequisite for having the option to retry in the MI Monitor is the existence of a Retry step inside a Catch area as shown in fig. 2 (C). Additionally the MI has to be called by either the Workflow xmcp.manualinteraction.Manual Interaction (default in Process Modeller), or one of the Workflows specified in Xyna Property xyna.xprc.xpce.manualinteraction.customworkflows.

Table of Contents

Add a Manual Interaction to the Workflow

To insert a Manual Interaction object into a Workflow, drag the MI symbol out of the icon bar (<kbd>Ctrl+Alt+I</kbd>).

Configure a Manual Interaction

The MI object expects following four Input Parameters:

  • Reason: Detailed statements to the cause
  • Type: Integration into a special category (e.g. visible MI, not visible MI or area in which MI appeared)
  • User Group: Target group designated for the MI processing
  • To Do: Operating instructions or data necessary for the processing user

Use Cases

A typical use case is the processing of errors and not automatable Process Steps, e.g. such as the potentially necessary re-plugging of a DSLAM port by a service engineer.

Custom Manual Interactions

Beside the common MI other Workflows can be marked as Custom Manual Interaction by adding their name to the Xyna Property xyna.xprc.xpce.manualinteraction.customworkflows (comma-separated values). These Workflows have to call the common MI internally and can have other Input Parameters. Custom MIs look like the common MI. It is possible to use them instead of a common MI in the constellation shown in fig. 2 (C) to enable the Retry option like mentioned above.

See Also

⚠️ **GitHub.com Fallback** ⚠️