Skip to main content

Processes

Introduction​

General​

  • A Process is a configurable unit designed to define and manage a Camunda Process that can be interacted with from Web2Publish Application.
  • A Process can be executed in a wizard step and the user can monitor and control its progress via supported user interface.
  • A Process can also be executed in the background:
    • Save & Refresh button in the Customization step.
    • As a post-process after the publication is duplicated.
  • It allows to define the arguments (variables) for the process execution (if the process is triggered in the background).

Process Arguments (variables)​

  • When executing a Process in the background, we support passing configured arguments. These arguments can be either static or dynamic. For dynamic arguments, we provide placeholders for values:
    • <Publication.Id>: Represents the current publication ID.
    • <Template.Id>: Represents the template ID of the current publication.
    • <Session.Id>: Represents the current session ID.
    • <Entity.Context>: Represents the current entity context.
    • <Metadata.{metadata_identifier}: Represents the value of publication metadata (mapped by metadata identifier).

Configuration​

ISON Configuration Details​

Sample​

<processes>
  <process key="process_1">
    <label>process_1_label</label>
    <description>process_1_description</description>
    <executingMessage>executing_message_process_1</executingMessage>
    <arguments>
      <argument key="templateId">&lt;Template.Id&gt;</argument>
      <argument key="publicationId">&lt;Publication.Id&gt;</argument>
      <argument key="booleanArgument" type="CHECK_BOX">true</argument>
      <argument key="textArgument">text_argument</argument>
    </arguments>
  </process>
</processes>

Explanation​

  • <processes>: Wrapper element for Processes configuration.
  • <process>: Each <process> element represents the configuration for a single Process.
    • Attributes:
      • key: The unique key of the Process. Should be matched with the process key that configured in the wizard. This attribute is required.
    • Elements:
      • label: The label of the Process. Supports language-dependent translation.
      • description: The description of the Process. Supports language-dependent translation.
      • methodName: The name of the Method. This element is required.
      • arguments: Wrapper element for process arguments (variables) configuration.
      • argument: Defines an individual argument (variable) for the process execution.
        • Attributes:
          • key: The key of the argument. This attribute is required.
          • type: The type of the argument. The default value is TEXT.