Run Tool

User Settings

User Settings are user configuration variables that can be re-used in your step configurations. Simply define the setting, and then make use of them within any of your steps.

It means you can change a parameter in all of the steps that use the setting in one go without needing to edit them all each time.

You can view any settings you have created by clicking onto the Settings tab.

View Settings

Create a Setting

To create a new user setting first click onto the settings tab and then either use the shortcut button in the toolbar or by going to File > Add Setting.

Add Setting Shortcut

Add Setting

You then need to set a name and a value for your setting in the configuration window.

Configure Setting

Using Settings

To use your settings in your step configurations you need to type the name inside two curly braces. For example {{MySetting}}.

An example of how you can use user settings is shown in the below screen capture using the external program step. User settings are being used to set the program, program arguments and working directory.

External Program Example

User Settings can also use other User Settings. Just enter them into the setting as you would if you were using the setting in your step configuration.

Pass Settings at RunTime

You can dynamically pass settings into your project at Run Time, using either the built in settings or by using the Import Command Line Parameter step.

Built in Settings

The Run Tool has a few built in settings, that are calculated at the point the Run Tool project is started.

Below is a table of all of the built in settings that you can make use of in your steps.

Name Setting Example
DAY {{DAY}} 14
MONTH {{MONTH}} 05
YEAR {{YEAR}} 2021
FILEDATE {{FILEDATE}} 2021-05-14
DATE {{DATE}} 2021-05-14
FILETIME {{FILETIME}} 134339
TIME {{TIME}} 13:43:39
HOUR {{HOUR}} 13
MIN {{MIN}} 43
SEC {{SEC}} 39
MACHINE {{MACHINE}} MachineName
USERNAME {{USERNAME}} User1
DOMAIN {{DOMAIN}} MyDomain
APPPATH {{APPPATH}} C:\Program Files\Simego\Data Synchronisation Studio 3.0
PERSONAL {{PERSONAL}} C:\Users\{{USERNAME}}\Documents
LOCALAPPLICATIONDATA {{LOCALAPPLICATIONDATA}} C:\Users\{{USERNAME}}\AppData\Local
APPLICATIONDATA {{APPLICATIONDATA}} C:\Users\{{USERNAME}}\AppData\Roaming
COMMONAPPLICATIONDATA {{COMMONAPPLICATIONDATA}} C:\ProgramData
PROGRAMFILES {{PROGRAMFILES}} C:\Program Files
PROGRAMFILESX86 {{PROGRAMFILESX86}} C:\Program Files (x86)
SYSTEM {{SYSTEM}} C:\WINDOWS\system32
SYSTEMX86 {{SYSTEMX86}} C:\WINDOWS\SysWOW64
WINDOWS {{WINDOWS}} C:\WINDOWS\system32
TEMP {{TEMP}} C:\Users\{{USERNAME}}\AppData\Local\Temp\
NEWGUID {{NEWGUID}} {87747ce2-ada0-4ae7-b603-240832ff37cf}
SMTPUsername {{SMTPUsername}} myemail@domain.com
SolutionName {{SolutionName}} RunToolProject
SolutionPath {{SolutionPath}} C:\Users\{{USERNAME}}\source\repos\myRepo\RunToolProject
SolutionDataPath {{SolutionDataPath}} C:\Users\{{USERNAME}}\source\repos\myRepo\RunToolProject\.ds