Setting process options

You can set process options in the Process Options dialog when you create or edit a process. You can open the Process Options dialog by clicking the Options icons on the build page or clicking the Process Mode link in the Start step dialog.

Process Mode

The Process Mode setting determines how a process will execute regarding performance and logging. It is particularly important for listener processes that are used for APIs and event-based integrations.

• General — The default process mode for all new processes. General mode results in full process logging.

• Bridge — This process mode results in improved performance over General mode and full process logging. Bridge mode is ideal for high-volume, event-based processes for which you want to capture log data.

• Low Latency — Use this process mode to improve performance for short-lived processes (where total execution time is generally expected to be less than 30 seconds). In this process mode, the Start step dialog is set to use the Connector option.

  When the process mode is set to Low Latency:

  • The Action field is set to Listen and Runtime Web Server manages the connection settings and these settings cannot be changed.

  • Some functionality is disabled. Refer to the Low Latency processes topic for more information.

A subprocess called by a low latency process always uses Low Latency mode. In other words, the subprocess settings in the Process Options dialog are ignored and it uses the same Process Options settings as the top-level low latency process that calls it.

For more detailed information on Process Modes and its general usage considerations, refer to Understanding execution modes.

The following options appears in the Process Options dialog:

Allow Simultaneous Executions

Allow Simultaneous Executions

This check box is always available and can be turned on or off. If the Process Mode field is set to General, this check box is off by default. If it is set to Low Latency, this check box is on by default.

• If selected, more than one instance of this process can run at the same time on a given Runtime.

• If cleared, only one instance can run at a time. This is often beneficial when you are processing large amounts of data (to conserve system resources) or performing time- or state-sensitive synchronizations.

• When a process calls a subprocess, the subprocess always executes immediately regardless of how the Allow Simultaneous Executions check box is set on the subprocess or its parent process.

note

This option is not recommended for use with processes that use persisted process properties.

Auto Capture Errors/Warnings to Local Log

Auto Capture Errors/Warnings to Local Log

If selected, logs for the process are stored in the local Runtime's execution history directory. The default location is a zip file in the <atom_installation_directory>/execution/history/<process_execution_date> folder. The zip file contains the log files for the process.

This check box is always available and can be selection or cleared. It is cleared by default.

Capture Run Dates

Capture Run Dates

Records the last run date and the last successful run date for the process. There is significant performance degradation if this option is enabled for web server, AS2, or event-based processes.

This check box is always available and can be turned on or off. If the Process Mode field is set to General, this check box is on by default. If the process mode is set to Low Latency, this check box is off by default.

Purge Data Immediately

Purge Data Immediately

If this setting is on, processed documents and temporary data are purged immediately after each execution of the process.

There is a like-named setting at the Runtime level.

• If the Runtime-level setting is on, purging occurs for any process execution on that Runtime, regardless of the individual process option settings.

• If the Runtime-level setting is off, purging occurs only for executions of processes for which the process option setting is on.

Set at the process level, the Purge Data Immediately option always purges document data regardless of success or failure, and does not purge process or document logs.

For a process running as a subprocess, the process option setting for the parent process takes precedence.

This check box is always available and can be turned on or off. It is off by default.

Only Generate Process Log on Error

Only Generate Process Log on Error

If selected, the process log is created only if the process encounters an error. We recommend that you turn on this check box for web server or event-based processes to improve performance.

This check box is available only when the Process Mode field is set to Low Latency. The check box is on by default for new processes and off by default for existing processes. It can be turned on or off.

When you configure the Start step for a process, you might see a message containing recommendations about how to set the Allow Simultaneous Executions and Capture Run Dates check boxes. Following these recommendations should improve process performance. For example:

• If you select a regular connector or No Data and Allow Simultaneous Executions is on, it is recommended that you turn it off.

• If you select Passthrough and Capture Run Dates is on, it is recommended that you turn it off.

• If you select Trading Partner or any type of listener (Action = Listen) and Capture Run Dates is on, it is recommended that you turn it off.

• If you select Trading Partner or any type of listener (Action = Listen) and Allow Simultaneous Executions is off, it is recommended that you turn it on.

To follow the recommendation, click the Make Change(s) link within the message.

Setting process options to recommended settings

There is a shortcut in the Start step dialog for setting recommended process options.

1. Do one of the following:

   • Open an existing process, and click the Start step to configure it.

   • Create a process.

   The Start step dialog opens.

2. If you are not using the Services Enablement feature, or if you are using Services Enablement and the process mode is set to General, select a configuration (Connector, Trading Partner, Data Passthrough, or No Data) and set its related fields as needed.

   Depending on the configuration and settings that you select, you may see a message highlighted in yellow that recommends how to set the process options for optimal performance.

3. To accept the recommended setting(s), click Make the recommended change for me.

   The settings in the Process Options dialog are changed for you.

4. Click OK.

5. Make other changes to the process as needed, then click Save or Save and Close.

Setting process options manually

Use the Process Options dialog to manually set process options.

The Process Mode option determines process execution regarding performance and logging. For more information about the different modes and typical use cases, refer to Understanding execution modes topic.

1. On the Build page, open a process.

2. Do one of the following:

   • Click the Options link.

   • Click the Start step and in the Start step dialog, click the Process Mode link.

   The Process Options dialog opens.

3. Select a process mode: General, Bridge, or Low Latency.

   If the Services Enablement feature is not enabled in your account, the Process Mode list box will not be visible.

4. Select or clear these options:

   • Allow Simultaneous Executions

   • Auto Capture Errors/Warnings to Local Log

   • Capture Run Dates

   • Purge Data Immediately

5. If you selected Low Latency, select or clear Only Generate Process Logs on Error.

6. Click OK.

   If you changed the process mode from General to Bridge or Low Latency, you may see a message highlighted in yellow that recommends how to set the process options for optimal performance.

7. To accept the recommended setting(s), click Make the recommended change for me.

8. In the Connector field, choose a connector.

9. Click OK to confirm the change.