If you can't find the product or version you're looking for, visit support.ataccama.com/downloads

Workflow Component

Defining the Workflow component adds the Workflows section to ONE Runtime Server Admin and enables running workflows on the server via the ONE Runtime Server Admin (see Workflows), HTTP Request, and OnlineCtl.

To use workflows on the server, the server configuration must contain the following definition:

<serverComponents>
    ...
    <component logLevel="2" httpListener="all" disabled="false" showRuntimeConfiguration="false" class="com.ataccama.adt.web.WorkflowServerComponent" resourcesFolder="../storage/resources/workflow">
        <sources>
            <sourceConfigBean path="../storage/resources/workflow/workflows1" id="src1"/>
            <sourceConfigBean path="../storage/resources/workflow/workflows2" id="src2"/>
        </sources>
        <stateStorageProvider class="com.ataccama.adt.runtime.state.storage.FileStateStorageProvider"/>
    </component>
      ...
</serverComponents>

A corresponding configuration in the Server Configuration Editor in ONE Desktop:

Property Value Required Description

Property	Value	Required	Description
Http Listener	all	No	The HTTP Dispatcher listener on which workflows can be executed via HTTP requests. See Execute Workflows for more information.
Log Level	2	Yes	Maximum level of events that are logged into the server console. The levels are: -1: Log everything. 0: Log nothing. 1: Log everything related to the Workflow component. 2: Log starts and ends of workflows, state changes of workflow tasks. 3: Log activities of workflow tasks. 4 and higher: Log activities of other subloggers (for example, ONE plans started by workflows). Workflows that log on the level 4 or higher are rare.
Resources Folder	N/A	No	Defines a relative (to the server configuration file) or absolute path denoting the location where supporting and resource files are stored. Currently, the following files are stored: File containing ID generation state for running task instances. Log files created by the workflow for individual workflow instances.
Show Runtime Configuration	N/A	No	Defines whether the ad hoc runtime configuration (`runtime-config.xml`) is displayed in the ONE Runtime Server Admin when the workflow uses the Run DQC Process task. By default, this option is turned off.
Sources	N/A	No	Defines named sources used of the workflow configurations. Each `source` has the following attributes: Id - Defines a name for the source. Workflows in the source with ID are accessible via the `<sourceId>:<workflowName>.ewf` notation. One of the sources might not have a name: in such cases, it is processed as an implicit source, so no Id is required to access workflows from this folder. Path - Defines relative (to the server configuration file) or absolute path denoting the location where the workflow definition files are stored. The component scans only the specified folder (no subfolders are processed) and processes files with the `*.ewf` extension.
State Storage Provider	N/A	Yes	Defines which backend should be used for storing the workflow execution states. Currently, there are two storage provider implementations: database state storage provider and filesystem state storage provider. For more information about workflow logging, see How to Log Workflow Execution.

Http Listener

all

The HTTP Dispatcher listener on which workflows can be executed via HTTP requests. See Execute Workflows for more information.

Log Level

Yes

Maximum level of events that are logged into the server console. The levels are:

-1: Log everything.
0: Log nothing.
1: Log everything related to the Workflow component.
2: Log starts and ends of workflows, state changes of workflow tasks.
3: Log activities of workflow tasks.
4 and higher: Log activities of other subloggers (for example, ONE plans started by workflows). Workflows that log on the level 4 or higher are rare.

Resources Folder

N/A

Defines a relative (to the server configuration file) or absolute path denoting the location where supporting and resource files are stored. Currently, the following files are stored:

File containing ID generation state for running task instances.
Log files created by the workflow for individual workflow instances.

Show Runtime Configuration

N/A

Defines whether the ad hoc runtime configuration (runtime-config.xml) is displayed in the ONE Runtime Server Admin when the workflow uses the Run DQC Process task. By default, this option is turned off.

Sources

N/A

Defines named sources used of the workflow configurations. Each source has the following attributes:

Id - Defines a name for the source. Workflows in the source with ID are accessible via the <sourceId>:<workflowName>.ewf notation.

One of the sources might not have a name: in such cases, it is processed as an implicit source, so no Id is required to access workflows from this folder.
Path - Defines relative (to the server configuration file) or absolute path denoting the location where the workflow definition files are stored. The component scans only the specified folder (no subfolders are processed) and processes files with the *.ewf extension.

State Storage Provider

N/A

Yes

Defines which backend should be used for storing the workflow execution states. Currently, there are two storage provider implementations: database state storage provider and filesystem state storage provider.

For more information about workflow logging, see How to Log Workflow Execution.

Filesystem state storage provider

Stores information about the workflow and its task states to a .wis file.

Filesystem state storage provider configuration sample

<component class="com.ataccama.adt.web.WorkflowServerComponent">
    ...
    <stateStorageProvider class="com.ataccama.adt.runtime.state.storage.FileStateStorageProvider"/>
    ...
</component>

Database state storage provider

Stores information about the workflow and its task states to the database. The database state storage provider is configured with the following attributes:

dialectFile - Database module descriptor file that describes the target database. Module files for the most commonly used databases are located at <ATACCAMA_HOME>/db/modules.
dataSource - Name of the connection to the database where logs will be stored. The connection definition must be present in the Runtime Configuration.
prefix - Prefix added to the names of database persistence tables. Default value: WISP_.
dialectFile - DB module descriptor file that describes the target database. Module files for the most commonly used databases are located at <ATACCAMA_HOME>/db/modules.
dataSource - name of the connection to the database where logs will be stored. The connection name must be present in runtime-configuration.adoc.
prefix - prefix added to the names of DB persistence tables. Default value: WISP_+.

Database state storage provider configuration sample

<component class="com.ataccama.adt.web.WorkflowServerComponent">
    ...
    <stateStorageProvider class="com.ataccama.adt.runtime.state.storage.DbStateStorageProvider">
        <dialectFile>../../ataccama/one/db/modules/pgsql.xml</dialectFile>
        <dataSource>db-postgres</dataSource>
    </stateStorageProvider>
    ...
</component>

The following databases can be configured to use as database state storage providers for the Workflow component: Oracle, PostgreSQL, Microsoft SQL Server. For the recommended and supported versions, see Supported Third-Party Components.

For non-production purposes, you can also use Apache Derby (recommended versions: 10.14.2.0, 10.10.2.0).

Was this page useful?