Workflows

You can package and deploy the workflow definition with its associated and child artifact from one environment or repository to another environment or repository.

To add a workflow to a package template, you must first publish the workflow. Ensure that the workflow that you want to package is not disabled.

You can resolve workflow activities by editing the database and also identifying the associated artifacts while installing the package. This is done to ensure that the workflow is run without any errors. For more information, see Resolving Workflow Activities.

Adding Workflows to Package Template

1. Log on to the Enterprise Console.

2. In the Enterprise Console, click the Menu button, and then click Workflows.

   The Workflows page appears.

3. Select the workflow that you want to package.

4. Right-click the workflow, and then click Add to Package Template.

   The Add to Package Template window appears.

   For more information about adding artifacts to Package Template, see Adding Artifacts to a Package Template.

   You can set the configuration properties of the workflow in the Add to Package Template window. The left side of the configuration window shows the package template and its configurations. You can set the configuration properties of the workflow package in the Settings form on the right side of the Add to Package Template window.

Runtime Initialization Settings

You can configure runtime initialization settings for workflows. For more information about configuring runtime initialization settings, see Runtime Initialization Settings.

Configuration Settings for Workflows

Workflows have a unique set of configuration settings required to install, update, and uninstall the package. You can view and edit the configuration settings from one of the following windows:

• Source Environment > Package Template window

• Target Environment > Manage Package window

Settings

You can define the configuration settings of Workflows artifact in the Settings tab. Set the properties in this tab to take appropriate actions while installing, updating, or uninstalling the package.

Install

Use this tab to set the configurations for installing the package.

• Inherit Artifact Type Settings: Use this property to define whether the settings inherited from the artifact type or the settings configured at the artifact-level must be considered.

  • Yes: Select this option if the workflow must inherit the settings configured for the artifact type. If this option is selected, then the artifact type settings take precedence.

    No: Select this option if the workflow must consider the settings configured at the artifact-level. The following options are available:

    Property	Description
    Install Workflow as Draft	Use this property to install the Workflow. Yes: Select this option to install the Workflow in the Draft status in the target environment. No: Select this option to install the Workflow in the Published status in the target environment.
    Workflow Exists	Use this property to take appropriate action when the Workflow definition specified in the package is already present in the target environment. Install as next major version: Select this option to install the Workflow as a next major version. Install as next minor version: Select this option to install the Workflow as a next minor version. You can install the Workflow as a next minor version up to 12 times only. Install as next version: Select this option to install the Workflow as a next version. Overwrite latest (published) version: Select this option to overwrite the latest published version of workflow in the target environment. An existing Workflow Definition gets replaced with the Workflow Definition contained in this package. Do not install: Select this option if you do not want to install the Workflow, as it is already present in the target environment.

• Running Workflow Instance: Use this property if you want to kill the running workflow instance or do not want to overwrite the workflow. You can also pause and resume the running workflow instance. This property is available only when you select the Overwrite latest (published) version option for Workflow Exists property.

  • Kill: Select this option to kill the running workflow instance.

  • Pause and Resume: Select this option to pause, overwrite, and resume the running workflow instance in the target environment.

• Associated Artifacts Not Present: Use this property to take appropriate action when the associated artifacts of the Workflow are not present in the target environment.

  This property is not applicable for the associated artifact of the type Event Association. The artifact will be installed even if the Event Association is unavailable in the target environment.

  • Install as draft: Select this option to install the Workflow in the Draft status, even if the associated artifacts are not present in the target environment.

  • Do not install: Select this option if you do not want to install the Workflow as its associated artifacts are not present.

    Note: Consider, the latest published workflow exists in the target environment, and the Overwrite latest (published) version option is selected. During package installation, the backup of the existing workflow is taken and stored in the database. And, the workflow in the target environment is overwritten with the packaged source definition.
    
    During Overwrite, the package name and the description does not get updated in the artifact Package Name (Version) column.
    
    For Pause, Resume, and Kill scenarios, the workflow needs to be published manually to get the latest workflow definition.

Update

Use the settings in this to update an installed package.

• Delete Workflow: Use this property to delete the Workflow that is present in the target environment.

  • Yes: Select this option to remove the Workflow from the target environment.

    Workflow is modified: Use this option to retain or delete the workflow in the target environment even after the package is updated. This property is applicable only if Delete Workflow is set to Yes and the workflow is modified.

    • Retain: Select this option to retain the Workflow along with the modifications, in the target environment.

    • Rollback to original state: Select this option to rollback the Workflow to the original state if you have made any modifications in the target environment. You can kill, pause, or resume the running workflow instance.

      - Kill: Select this option to kill the running workflow instance.

      - Pause and Resume: Select this option to pause, rollback, and resume the running workflow instance in the target environment.

    • Delete: Select this option to delete the Workflow from the target environment.

  • No: Select this option to retain the Workflow in the target environment. When you select No, the Install Workflow as draft, Workflow exists and Associated artifacts not present options appear.

    Only when the Delete Workflow option is set to No, the Inherit Artifact Type Settings option is enabled.

• Inherit Artifact Type Settings: Use this property to define whether the settings inherited from the artifact type or the settings configured at the artifact-level must be considered.

  • Yes: Select this option if the workflow must inherit the settings configured for the artifact type. If this option is selected, then the artifact type settings take precedence.

  • No: Select this option if the workflow must consider the settings configured at the artifact-level. The following options are available:

• Running Workflow Instance: Use this property if you want to kill the running workflow instance or do not want to overwrite the workflow. You can also pause and resume the running workflow instance. This property is available when you select the Overwrite latest (published) version option for Workflow Exists property.

  • Kill: Select this option to kill the running workflow instance.

  • Pause and Resume: Select this option to pause, overwrite, and resume the running workflow instance in the target environment.

• Associated artifacts not present: Use this property to take appropriate action when the associated artifacts of the Workflow are not present in the target environment.

  This property is not applicable for the associated artifact of the type Event Association. The artifact will be installed even if the Event Association is unavailable in the target environment.

  • Install as draft: Select this option to install the Workflow in Draft status, even if the associated artifacts are not present in the target environment.

  • Do not install: Select this option if you do not want to install the Workflow as its associated artifacts are not present.

  Note: Consider, the latest published workflow exists in the target environment, and the Overwrite latest (published) version option is selected. During package update, the backup of the existing workflow is not be taken if available; and taken if not available. And, the workflow in the target environment is overwritten with the packaged source definition.
  
  During Overwrite, the package name and the description does not get updated in the artifact Package Name (Version) column.

Uninstall

Use this tab to configure the settings when the package is being uninstalled from the target environment.

• Delete Workflow: Use this property to retain or delete the Workflow in the target environment even after the package is uninstalled..

  • Yes: Select this option to remove the Workflow from the target environment when the package is uninstalled.

  • No: Select this option to retain the Workflow in the target environment even after the package is uninstalled.

• Workflow is modified: Use this property to retain or delete the Workflow in the target environment even after the package is uninstalled. This property is displayed only if Delete Workflow is set to Yes. However, if Delete Workflow is set to No, this property is not displayed.

  • Retain: Select this option to retain the Workflow along with the modifications even after the package is uninstalled.

  • Rollback to original state: Select this option to rollback the Workflow to the original state if any modifications are made in the target environment.

  • Delete: Select this option to delete the Workflow from the target environment.

• Running Workflow Instance: Use this property if you want to kill the running workflow instance or do not want to overwrite the workflow. You can also pause and resume the running workflow instance. This property is available when you select the Rollback to original state option for Workflow is modified property.

  • Kill: Select this option to kill the running workflow instance.

  • Pause and Resume: Select this option to pause, rollback, and resume the running workflow instance in the target environment.

    Note:
    - During package uninstall, with the Rollback to original state option selected, the overwritten workflow definition is replaced with backup data, and the backup from the database gets deleted.
    - During rollback, the package name and the description does not get updated in the artifact Package Name (Version) column.
    - When a workflow is locked by another user, you cannot overwrite or install new versions of the same workflow through the package.
    - When a workflow in the package is in the Published state, and you select Install Form as Draft option as Yes, while install or update, the workflow will be in the Published state when you overwrite it.
    - When all the workflow versions are in the Draft state, the latest workflow version is overwritten when you overwrite the workflow.

Associated Artifacts of Workflows Definition

The Associated Artifacts tab displays all the associated artifacts of a selected Workflow.

When you set the Include Associated Artifacts option to Yes, while adding the workflow to a package template, then the associated artifacts are added to the package template, and it also allows you to view the associated artifacts of the workflow in the tree view of the package. If you set the Include Associated Artifacts option to No, then the associated artifacts are not added to the package template, and are also not visible in the tree view of the package. This condition is also applicable for the Include Child Artifacts and Include Security Artifacts options.

A workflow can have the following associated artifacts:

• Parent Folder

• Workflows

• Calendar

• SOA Assembly

• SOA Folder

• Database Connection

• Forms

• Event Associations

  • Scheduler

  • Enterprise Console

  • File Watcher

• Web API

• Queue

• Analyst's Process Model

• Work Item Field

• Logic App Connection

• Message Queue Connection

You can import and export a workflow with event associations from one repository to another repository. During install, when the associated artifact is of type Event Association, workflow artifact does not validate whether Event Association is available or not, as Event Association cannot exist without workflow. While installing the package, you must ensure that the event association is available in the same package or in a different package, so that it is installed and associated to the workflow.

Note:

- The Analyst's Process Model will not appear as an associated artifact when the value for the Analyst's Process Model Filename for Execution View is set through the Expression Editor as the value is resolved only during run-time.

- If a SOA Assembly is registered through a Web Service and a physical path (dll), by default the Web Service is a static method and the physical path can be a static or non- static method. While packaging workflows that does not use SOA Assembly, by default the static objects of the registered SOA Assembly is considered as an associated artifact.

- When you package a workflow that is associated from Form, the Form does not appear as associated artifact of the workflow.

- When you package a Workflow, the Work Item Fields mentioned below are also packaged, and the Work Item Fields are displayed in the tree view of the package and the Associated Artifacts tab of the selected workflow.
- All the Work Item Fields at the workflow level
- The application level Work Item Fields, which are used in that specific workflow

Identifying Event Association as Associated Artifact

Consider that you want to package a workflow, Telematics of version 2. While adding to package template, the package identifies Event Association as associated artifact based on the following conditions:

• Event Association mapped to version 2 of Telematics workflow.

• Event Association mapped to latest version of Telematics workflow (version 2 of the workflow "Telematics" is the latest version).

Child Artifacts for Workflows

The Child Artifacts tab displays all the child artifacts of the Workflow.

A workflow can have another workflow as its child artifact.

• Workflow

Include Child Item

For more information, see Include Child Item.

Security Artifacts

The Security Artifacts tab displays the security artifacts of a workflow, if any. For more information about including security artifacts, see Include Security Artifacts.

Activity Rebuild and Complete Rebuild

In the package template, an orange icon, , appears for the workflow which denotes that the workflow needs to be rebuilt as the workflow is published, unpublished, or edited after it is added to the package template. Similarly, in the target environment if the workflow installed by the package is published, unpublished, or edited, then while uninstalling the package, the workflow settings will be retained.

When a workflow in the package template is modified, ensure to perform a rebuild on the particular workflow. You can right-click the workflow from the left hand side configuration tree view in the package template, and click Complete Rebuild or Activity Rebuild to rebuild the workflow.

• Complete Rebuild: Click Complete Rebuild to rebuild the particular workflow artifact in the package template. During complete rebuild, the install, update, or uninstall settings do not change. However, the settings done to resolve any activity properties in the target section of the Settings form get cleared.

• Activity Rebuild: Click Activity Rebuild to rebuild only a modified workflow artifact. All settings done to resolve any activity property in the target section of the Settings form does not get changed. Only the new values of the modified activity get updated in the package. However, if you want to rename an activity in the workflow, use the Complete Rebuild option. Any changes in the property of a workflow do not get updated in the package unless the activity name is modified.

Note: Consider a scenario where a workflow 'Workflow1' having associated artifact 'List 1' is added to package template. If this workflow is rebuilt after modifying and changing the associated artifact to 'List 2', then 'List 2' will be added to the package template as the associated artifact. However, 'List 1' will not be deleted form the package template. If required, you can manually delete 'List1' from the package template.

The same behavior is applicable for other artifacts.

When an artifact, for example, a workflow is added to a package template, its associated artifacts are also added to the package template. If you delete an artifact from the workflow, and then perform a complete rebuild on the same package template, the deleted artifact is removed from the target environment. However, the associated artifacts of the deleted artifact are retained in the target environment. For example, consider that a workflow contains a form, and this workflow is added to the package template. While installing the package template, the associated artifacts of the form, such as the associated database lookup also get installed in the target environment. Now, if the form artifact is deleted from the workflow, and if the package template is rebuilt again, though the form is removed, its associated artifacts, such as the database lookup is retained in the target environment.

For information about resolving workflow activities, see Resolve Workflow Activities.