Read application settings

Use this step to read app settings from appSettings.JSON file.

Last published at: July 21st, 2023

readAppSettings Step


Reads a value from the appSettings.JSON file 


  • appKey – Name of the key
  • variableName – Variable to store the value of the key
  • appSettings - Multiple App Settings 



  • True – step executed successfully
  • False – step failed to execute 




Let’s build and execute the readAppsettingsDef example.          

  • Create a new definition called “readAppsettingsDef”
  • Select the definition and click the “design” button
  • Drag a “readAppsettingsDef” step from the toolbox
  • Connect the dots between the start and “readAppsettings” step as shown above
  • Define a variable/global to store the app setting values after execution
  • Click on the "readAppsettings" step to configure its "Settings" properties. Provide a name to the step. 
  • Click on the "readAppsettings" step to configure its "Advanced" properties. Provide the application key and the variable/global to hold the settings value. Click on the button to define multiple app settings as shown below. 
  • Multiple app settings configuration (use either one and not both)
  • The “Logging” setting configuration is necessary for documentation and also measure the workflow progress and the percent complete. This is acheived by configuring the step state and percent fields individually as shown in the images below. Configure the “Logging” using the following properties.
  • To work with this step, appSettings.JSON file should have data like below code:
     <add key="ShowQueryTextbox" value="true"/>
     <add key="IsMultiTenant" value="true"/>
  • Save the process definition, create a new process instance and execute. 
  • Render the process instance. Click on the process step. The step properties should read value from application configuration.