Call & Wait

The Call & Wait Intermediate Event element is located in the Event & Gateway drawer of the process editor palette.

Element Details

This element is one of Xpert.ivy facilities to integrate custom-made software, legacy systems, proprietary applications or any other external system through an Xpert.ivy Java interface. The Call & Wait element is slitted into a Call part and a Wait part. The Call part is similar to the Program Interface process element. It can be used to call (send request) an external system. Whereas the Wait part is similar to the Intermediate Event element and can be used to wait for the response from the external system. For the process designer the use of a Call & Wait element is easier compared to the use of a Program Interface followed by an Intermediate Event because he only has to configure one Java class and does not have to care about event identifiers.

The Call part of the element will instantiate a Java class that must implement the interface IUserAsynchronousProcessExtension and will call the method performRequest each time a process comes to the Call & Wait element. The common way to implement a Call bean is to extend the abstract base class AbstractUserAsynchronousProcessExtension .

The Wait part of the element will interrupt the process execution and waits for an external event to occur. Technically spoken the current task will be ended and a new system task is created that waits for the event. If the event is fired the new task and therefore the process after the Call & Wait element will be executed.

You provide a listener for the external event by implementing a public static inner Java class of the Call part with the name IntermediateEvent that implements the IProcessIntermediateEventBean interface. The Call & Wait element instantiates the IntermediateEvent Java class. It can then trigger the event by calling the method fireProcessIntermediateEventEx on the Xpert.ivy runtime engine IProcessIntermediateEventBeanRuntime . The common way to implement a Wait (Intermediate Event) bean is to extend the abstract base class AbstractProcessIntermediateEventBean .

The interface also includes an inner editor class to parametrize the beans. The editor provides one configuration which is set on both beans the Call and the Wait bean. You will find the documentation of the interface and the abstract class in the Java Doc of the Xpert.ivy Public API.

Inscription

Name Tab

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

Call Tab

On this tab you set the Java class which implements the interface IUserAsynchronousProcessExtension and defines a public static inner class called IntermediateEvent that implements the interface IProcessIntermediateEventBean . This class is called when the Call & Wait step is executed. Furthermore, you can define exception handlers to react on errors such as not reachable systems, insufficient privileges and many more.

Figure 5.9. The Call tab

The Call tab

Java Class to Execute

The fully qualified name of the Call & Wait Java class implementing IUserAsynchronousProcessExtension and a public static inner class called IntermediateEvent that implements the interface IProcessIntermediateEventBean . Use the New Bean Class Wizard () to create a new Java source file with an example implementation of the bean class.

Tip

You can add a graphical configuration editor for the Java call (i.e. setting the parameter values) on the Call & Wait inscription mask. See section Tab Editor for more details.

Program Exception / Exception Handler

The Exception step which is executed whenever errors during the call to the Call part Java class or during the execution of the class are returned.

Timeout

Sets a timeout for the return of the call to the Call part Java class. When the timeout ends without an answer from the Call part Java class, then the Exception step below is executed

Timeout Exception Handler

The Exception step which is executed whenever the timeout ends without an answer from the Call part Java class call.

Wait Tab

On this tab you define the timeout behaviour during the Wait part of the element.

Figure 5.10. The Wait tab

The Wait tab

Timeout

Here you can specify a time (Duration) how long the current case should wait for an intermediate event and what should happen if no event was received after this time. You can optionally start an exception process, delete the waiting task or continue the waiting task without receiving an intermediate event.

Tab Editor

This tab displays the editor, that can be integrated in the external Java bean of the process element. The editor is implemented as an inner public static class of the Java bean class and must have the name Editor. Additionally the editor class must implement the IProcessExtensionConfigurationEditorEx interface. The common way to implement the editor class is to extend the abstract base class AbstractProcessExtensionConfigurationEditor and to override the methods createEditorPanelContent, loadUiDataFromConfiguration and saveUiDataToConfiguration. The method createEditorPanelContent can be used to build the UI components of the editor. You can add any AWT/Swing component to the given editorPanel parameter. With the given editorEnvironment parameter, which is of the type IProcessExtensionConfigurationEditorEnvironment , you can create text fields that support ivyScript and has smart buttons which provide access to the process data, environment functions and Java classes.

Here is an example of such an editor:

As you can see, the editor provides you access to any process relevant data, which can be used by your own process elements. For instance, you can easily transfer process data to your legacy system.

The following part shows the implementation of the editor shown above. As mentioned above Xpert.ivy provides the IIvyScriptEditor which represents a text field with ivyScript support and smart buttons. Inside createEditorPanelContent use the method createIvyScriptEditor from the editorEnvironment parameter to create an instance of such an editor. Use the loadUiDataFromConfiguration method to read the bean configuration and set them to the UI components. Inside this method you can use the methods getBeanConfiguration or getBeanConfigurationProperty to read the bean configuration. Use the method saveUiDataToConfiguration to save the data in the UI components to the bean configuration. Inside this method you can use the methods setBeanConfiguration or setBeanConfigurationProperty to save the bean configuration.

  public static class Editor extends AbstractProcessExtensionConfigurationEditor
  {
    private IIvyScriptEditor editorUser;
    private IIvyScriptEditor editorEventTyp;
    private IIvyScriptEditor editorLinkId;
    private IIvyScriptEditor editorFieldValue;
    
    @Override
    protected void createEditorPanelContent(Container editorPanel,
            IProcessExtensionConfigurationEditorEnvironment editorEnvironment)
    {
      editorPanel.setLayout(new GridLayout(4,2));
      editorUser = editorEnvironment.createIvyScriptEditor(null,null, "String");
      editorEventTyp = editorEnvironment.createIvyScriptEditor(null,null, "String");
      editorLinkId = editorEnvironment.createIvyScriptEditor(null, null, "String");
      editorFieldValue = editorEnvironment.createIvyScriptEditor(null, null);
      
      editorPanel.add(new JLabel("User"));
      editorPanel.add(editorUser.getComponent());
      editorPanel.add(new JLabel("Event Typ"));
      editorPanel.add(editorEventTyp.getComponent());
      editorPanel.add(new JLabel("Link-Id"));
      editorPanel.add(editorLinkId.getComponent());
      editorPanel.add(new JLabel("Feldwert"));
      editorPanel.add(editorFieldValue.getComponent());        
    }

    @Override
    protected void loadUiDataFromConfiguration()
    {
      editorUser.setText(getBeanConfigurationProperty("User"));
      editorEventTyp.setText(getBeanConfigurationProperty("EventTyp"));
      editorLinkId.setText(getBeanConfigurationProperty("LinkId"));
      editorFieldValue.setText(getBeanConfigurationProperty("Feldwert"));
    }

    @Override
    protected boolean saveUiDataToConfiguration()
    {
      setBeanConfigurationProperty("User", editorUser.getText());
      setBeanConfigurationProperty("EventTyp", editorEventTyp.getText());
      setBeanConfigurationProperty("LinkId", editorLinkId.getText());
      setBeanConfigurationProperty("Feldwert", editorFieldValue.getText());
      return true;
    }
  }    

At runtime you have to evaluate the IvyScript the user have entered into the ivy script editors. If you implement for example the AbstractUserProcessExtension class there is a perform method which is executed at runtime. At this point you want to access the configured data in the editor. The following code snippet show how you can evaluate the value of an IIvyScriptEditor . If you use the IIvyScriptEditor you only get the value by calling the executeIvyScript method of the AbstractUserProcessExtension .

  public CompositeObject perform(IRequestId requestId, CompositeObject in,
     IIvyScriptContext context) throws Exception
  {
    IIvyScriptContext ownContext;
    CompositeObject out;
    out = in.clone();
    ownContext = createOwnContext(context);

    String eventtyp = "";
    String linkId = "";
    String fieldValue = "";
    String user= "";

    user = (String)executeIvyScript(ownContext, getConfigurationProperty("User"));
    eventtyp = (String)executeIvyScript(ownContext, getConfigurationProperty("Event Typ"));
    linkId = (String)executeIvyScript(ownContext, getConfigurationProperty("Link-Id"));
    fieldValue = (String)executeIvyScript(ownContext, getConfigurationProperty("Feldwert"));
    
    // add your call here
    
    return out;
  }           

Task Tab

On this tab you configure the parameters of the awaited event which is handled as an Intermediate Event Task. Thus it can be displayed in a task list with a filter applied to the task kind parameter. The task kind code is the internally used identifier to sort and order the processes. The task kind name is a human readable description of the code. The Business milestone usually sets the current DateTime for process activity analysis and reports.

You can set the name of the business calendar that should be used for the task. In the context of the task ivy.cal will return this business calendar regardless of what you've set for the case.

For more information about business calendar administration see the server guide.

For more information about business calendar usage see the Public API of ch.ivyteam.ivy.application.calendar.IDefaultBusinessCalendar.

Output Tab

On this tab you can configure the output of the element (i.e. the data that leaves the element). You can use the variable result that holds additional information about the event received by the Wait part Java class.

See Output Tab for a more detailed description.

Note

For each incoming connection you have a separate inX object available which carries the data of the Xth input. Hover with the mouse over the incoming connections of the element to learn which input connection corresponds to which variable.