Read application settings

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

Last published at: July 21st, 2023

readAppSettings Step

Description:

Reads a value from the appSettings.JSON file 

 

Inputs

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

 

Returns

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

 

Usage:

 

 

Example:

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” steps as shown above
  • Define a variable/global to store the app setting values after execution
  • Click the "readAppsettings" step to configure its "Settings" properties. Provide a name to the step. 

 

  • Click the "readAppsettings" step to configure its "Advanced" properties. Provide the application key and the variable/global to hold the setting's 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 measures the workflow progress and the percent complete. This is achieved 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 the below code:
<configuration>
  <appSettings>
     <add key="ShowQueryTextbox" value="true"/>
     <add key="IsMultiTenant" value="true"/>
   </appSettings>
</configuration>

 

  • 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 the value from the application configuration.

 

Definition Sample:

You may download the sample definition(s) from the link here and later import it (drag-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.

NOTE: Please verify and complete the process steps for any missing configurations, such as file path references and database connections after import. Then, save the definition to confirm the changes.

Click here to download the sample file.