Description:

The ReadAppSettings step reads application configuration values during workflow execution. You can specify an Application key, along with the name of the Variable or Global to use for the retrieved value. The step also provides a Multiple App Settings property for mapping multiple application settings.

This makes the step useful when workflow behavior or downstream processing needs values maintained in the application's configuration rather than values hard-coded into the workflow definition.

Usage:

The Read Application Settings step is useful when a workflow needs to retrieve configuration-driven values while executing.

A typical workflow pattern is:

Read Application Settings → Use Configuration Value

The value retrieved from the application configuration can then be made available to subsequent workflow activities through the configured Variable or Global.

For example:

Read Application Settings → Build Message → Send Notification

or:

Read Application Settings → Configure Processing → Process Data

Using configuration values this way helps keep environment- or deployment-specific values outside individual workflow definitions.

The reference documentation follows the same general pattern: place a processing step after required input or preparation, then use its resulting value in subsequent activities.

Typical Workflow Suggestions:

Read an Application Configuration Value

Use the step to retrieve a specific application setting using its Application key.

Example:

Read Application Settings → Use Retrieved Value

You can then use the retrieved value in subsequent workflow activities.

Use Configuration Values in Notifications

A configuration setting can provide a value for workflow notifications.

Example:

Read Application Settings → Build Notification → Send Notification

This can be useful when a notification requires a value that is maintained in application configuration.

Configure Environment-Specific Processing

Use application settings to provide values that may differ between workflow environments.

Example:

Read Application Settings → Determine Processing → Continue Workflow

This approach lets the workflow consume configuration-driven values rather than embedding them directly in the process definition.

Build Dynamic Workflow Messages

Read a configured value before constructing a message that is sent to a user or another system.

Example:

Read Application Settings → Build Message → Send Message

The configuration value can be made available through the specified Variable or Global.

Supply Values to a Downstream Integration

Use the step before an activity that requires a configuration-driven value.

Example:

Read Application Settings → Prepare Integration → External Integration

This is particularly useful when the downstream activity needs a value that is maintained as part of application configuration.

Read Multiple Application Settings

The Multiple App Settings property provides AppSettings mapping. This can be useful when a workflow requires more than one application configuration value.

A typical pattern is:

Read Application Settings → Use Configuration Values

The exact configuration options and mapping behavior of the AppSettings data type are not defined in the supplied XML, so verify those details against the corresponding FlowWright designer behavior.

Centralize Configuration-Driven Workflow Behavior

Instead of placing configuration-dependent values directly into several workflow steps, retrieve the required value and pass it to subsequent activities through a Variable or Global.

Example:

Read Application Settings → Store Value → Multiple Subsequent Steps

This follows the same reusable-result pattern used by other FlowWright steps where an operation produces a value for later workflow activities.

Control Workflow Processing with Configuration

You can read a configuration value before a decision or processing activity.

Example:

Read Application Settings → Evaluate Configuration → Processing Path

This can be useful when the workflow needs configuration information before determining how subsequent activities should proceed.

Example:

Let’s build and execute the “readAppsettingsDef” example.          

• Create a new process definition called “readAppsettingsDef” and open it in Designer mode.
• Drag a “readAppsettingsDef” step to the canvas. 
• Connect the dots between the “Start” and “readAppsettings” steps, as shown above.
• Select the line between the steps to configure the “Connection Properties”. The default property values are “None, True, False, Error, and Evaluate”. Depending on the step’s purpose, you can configure additional values.
• Define a variable or a global to store the app settings.
• Click the "readAppsettings" step to configure its "Required" properties. Provide a name for the step, then click Save. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description. 

• Click the "readAppsettings" step to configure its "Optional" properties. Provide the application key and the variable or global to store the setting's value. Click the button to define multiple app settings. Then click the Save button. 

• Click the button to define multiple app settings. A pop-up window appears for configuration. Click the Add Row button to insert an empty row. Enter the App Setting Key and the variable or global reference to hold the value. Click the Save button. You may add multiple app setting references by using the Add Row button. Note: Use either single or multiple app setting configurations, not both. 

• The “Logging” configuration is necessary for documentation and also measures workflow progress and percent complete. Do this by configuring the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties.

• To proceed with this step, the appSettings.JSON file should contain data like the following code:

<configuration>
  <appSettings>
     <add key="SslEnabled" value="true"/>
     <add key="IsMultiTenant" value="false"/>
   </appSettings>
</configuration>

• Save the process definition, create a new instance, and execute it. Render the process instance and click the Read Application Settings step to view its properties. When the workflow reaches this step, FlowWright reads the configured application setting based on the step configuration. Subsequent workflow activities can then use the configured Variable/Global. The reference workflow documentation uses the same execution pattern: save the definition, create an instance, execute it, render the instance, and inspect the step when execution reaches it.

Tips:

• Use a clear and consistent naming convention for application configuration keys.
• Give the destination Variable or Global a meaningful name that describes the value it contains.
• Keep configuration-dependent values outside workflow definitions when they are expected to vary by environment.
• Test the workflow in each environment where the application configuration may differ.
• Verify that the required application configuration value exists before relying on it in downstream processing.
• If using multiple application settings, keep the mappings organized and document what each setting represents.
• Avoid assuming that a configuration value exists simply because the workflow definition references its key.
• Test both the True and False workflow paths.
• Use the retrieved value only after the Read Application Settings step has completed.
• If several subsequent activities use a configuration value, store it in a clearly named Variable or Global for reuse.
• Avoid placing sensitive configuration information directly into workflow documentation or examples.
• Because the supplied XML does not define missing-key behavior, default-value behavior, or configuration-file precedence, verify those behaviors in the target FlowWright environment rather than assuming them.

Notes:

• Category: Engine
• Internal Name: readappsettings
• Label: Reads values from the application configuration file
• Display Name: Read Application Settings
• Namespace: FlowWright.Workflow.ReadAppSettings
• DLL: FlowWright.Workflow.dll
• Step Definition Type: Process
• Incoming Connections: 2
• Outgoing Connections: 2

Definition Sample:

A sample Read Application Settings definition demonstrates retrieving an application configuration value and making it available to later workflow activities.

Before importing or using a definition sample, verify:

• The Application key corresponds to a configuration setting available in the target environment.
• The Variable/Global name is valid for the workflow.
• Any Multiple App Settings mapping is appropriate for the target environment.
• Downstream activities reference the correct Variable or Global.
• Environment-specific configuration values are available where the workflow will execute.
• The True and False paths are connected appropriately.
• Handle any configuration values containing sensitive information according to the environment's security requirements.

Save the process definition before creating and executing a workflow instance.

Click here to download the sample file.