Get Environment Folder
AutomatR.DefaultActivities.Environment.GetEnvironmentFolder
The "Get Environment Folder" activity in AutomatR is designed to retrieve the path to the specified system special folder. This activity provides a convenient way to obtain the path of predefined system folders, enhancing the flexibility of automation workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Folder Name | Select the folder name for which the path has to be retrieved. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variable or argument containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Get Environment Folder" activity. This can be useful for handling synchronization issues. Integer variable or argument containing the delay duration. Example: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
| Output | |
| Folder Path | Returns the path of the folder specified as a string. String variable or argument to store the obtained folder path. |
How to use:
- Drag and drop the "Get Environment Folder" activity onto the workflow.
- Configure the properties by selecting the desired system special folder for which you want to obtain the path.
- Optionally, configure the delay and customize the display name.
- Execute the workflow to retrieve the path of the specified system special folder.
Example: Consider an example where the "Get Environment Folder" activity is used to retrieve the path of the "MyDocuments" folder:
Get Environment Folder:
Display Name: "Get MyDocuments Path"
Folder Name: MyDocuments
Folder Path: myDocumentsPath
In this example, the activity retrieves the path of the "MyDocuments" folder, and the result is stored in the string variable "myDocumentsPath" for further use in the workflow.