Lifecycle and Events

Этот раздел перенесён из документации Camunda 7 и в дальнейшем будет доработан с учётом особенностей OpenBPM Engine

Events

<ol> <li> The form is parsed, and variable names are collected from the markup. This means that directives like <code>cam-variable-name</code> are evaluated and the resulting variables are declared in the <code>variableManager</code>. Events: <ul> <li><code>form-loaded</code> is fired after the form has been parsed, and all form directives have been evaluated.</li> </ul> </li> <li> In the second phase, a request is made to the server to gather the values of the variables declared in the variable manager. Events: <ul> <li><code>variables-fetched</code> is fired after the request returns and the values of the variables have been merged into the variableManager.</li> </ul> </li> <li> If a saved state of the form exists, the variable values are replaced with the saved state. Events: <ul> <li><code>variables-restored</code> is fired after the saved values of the variables have been merged with the values in the variableManager.</li> </ul> </li> <li> Next, the variables are applied to the form controls. This means that HTML input fields and select boxes are populated with the variable values present in the variableManager. Events: <ul> <li><code>variables-applied</code> is fired after the values of the variables have been applied to the form controls.</li> </ul> </li> <li> The user interacts with the form. In this phase no events are fired. </li> <li> The user can save the form, which causes the current values of the variables to be stored in the localStorage. If the user comes back to the form later, the values are restored. Events: <ul> <li><code>store</code> is fired before the values of the variables are written to the localStorage. An event handler may prevent the values from being stored.</li> <li><code>variables-stored</code> is fired after the values are written to the localStorage.</li> </ul> </li> <li> Finally, the form is completed. Triggering an BPMN error or escalation event will submit the form . Events: <ul> <li><code>submit</code>, <code>error</code> or <code>escalation</code> is fired before the submit request is sent to the server. An event handler may prevent the form from being submitted by setting the property submitPrevented, errorPrevented or escalationPrevented to true.</li> <li><code>submit-success</code>, <code>error-success</code> or <code>escalation-success</code> is fired after the server successfully treated the submission.</li> <li><code>submit-failed</code>, <code>error-failed</code> or <code>escalation-failed</code> is fired after the server failed at treating the submission or when a network error happened.</li> </ul> </li>

Event Listeners

Event listeners can be registered from custom JavaScript:

<form role="form" name="form">

  <script cam-script type="text/form-script">

    camForm.on('form-loaded', function() {
      // handle form loaded
    });

    camForm.on('variables-fetched', function() {
      // handle variables fetched
    });

    camForm.on('variables-restored', function() {
      // handle variables restored
    });

    camForm.on('variables-applied', function() {
      // handle variables applied
    });

    camForm.on('store', function(evt) {
      // handle store
      // may prevent the store from being executed
      evt.storePrevented = true;
    });

    camForm.on('variables-stored', function() {
      // handle variables stored
    });

    camForm.on('submit', function(evt) {
      // handle submit
      // may prevent the submit from being executed:
      evt.submitPrevented = true;
    });

    camForm.on('submit-success', function() {
      // handle submit-success
    });

    camForm.on('submit-failed', function(evt, res) {
      // handle submit-failed:
      var error = res[0];
    });

    camForm.on('error', function(evt) {
      // handle error
      // may prevent the error from being executed:
      evt.errorPrevented = true;
    });

    camForm.on('error-success', function() {
      // handle error-success
    });

    camForm.on('error-failed', function(evt, res) {
      // handle error-failed:
      var error = res[0];
    });

    camForm.on('escalation', function(evt) {
      // handle escalation
      // may prevent the escalation from being executed:
      evt.escalationPrevented = true;
    });

    camForm.on('escalation-success', function() {
      // handle escalation-success
    });

    camForm.on('escalation-failed', function(evt, res) {
      // handle escalation-failed:
      var error = res[0];
    });

  </script>

</form>

Лицензия и атрибуция

Эта документация была создана на базе материала "Camunda 7 Docs" от Camunda, находится под лицензией Creative Commons Attribution-ShareAlike 3.0 Unported License .

Оригинал документации: https://docs.camunda.org