Scheduled Tasks Settings
InstallShield 2022
Project:The Scheduled Tasks view is available in the following project types:
| • | Basic MSI |
| • | DIM |
| • | InstallScript MSI |
| • | Merge Module |
| • | MSI Database |
| • | Transform |
The settings for a scheduled task are organized into the following main categories in the Scheduled Task view.
| • | General |
| • | Schedule |
Use a scheduled task’s General settings to specify details such as the name of the task, the component that contains the task, and the file that you want the task to run.
|
Setting |
Description |
||||||
|
Task Name |
Enter the name that you want to use for the selected scheduled task. When you type a value for this setting, you are creating a string entry and setting its initial value for all of the languages that are currently in the project. As an alternative to typing a new value, you can click the ellipsis button (...) next to this setting to select an existing string. For more information, see Using String Entries in InstallShield. |
||||||
|
Component |
Select the component that you want to contain this scheduled task by using one of the following methods:
If the installation installs this component at run time, the scheduled task is added to the target system. |
||||||
|
Comments |
Enter the description that you want to be displayed in the Windows task scheduler for this task. When you type a value for this setting, you are creating a string entry and setting its initial value for all of the languages that are currently in the project. As an alternative to typing a new value, you can click the ellipsis button (...) next to this setting to select an existing string. For more information, see Using String Entries in InstallShield. |
||||||
|
Target |
Enter the path to the file on the target system that should be launched when the scheduled task is run. Use Windows Installer directory properties—for example, [INSTALLDIR]File.exe—instead of hard-coded directory paths. As an alternative to manually entering a value, you can click the ellipsis button (...) to browse to the target location and specify the file name. |
||||||
|
Arguments |
Enter the command-line arguments for the target file. |
||||||
|
Working Directory |
Enter the working directory for the target, or click the ellipsis button (...) to select or create a directory. For example, if you want your working directory to be set to a subdirectory of INSTALLDIR called Files, select [INSTALLDIR] from the list and add the subdirectory name Files to the end of it. When you are finished, it should read [INSTALLDIR]Files. |
||||||
|
Run As |
Enter the account that should be used to run the scheduled task. For example: DomainName\UserName Note that if you select Yes for this setting, you must also specify a password in the Password setting. Otherwise the scheduled task cannot be created at run time, and the installation aborts. Tip:You can use a Windows Installer public property to specify this information. This enables you to use data that end users enter in dialogs, or other configuration information that is determined at run time, when a scheduled task is configured at run time. For more information, see Using Windows Installer Properties to Dynamically Configure a Scheduled Task. |
||||||
|
Password |
Enter the password that should be used to with the user account that is specified in the Run As setting to run the scheduled task. Note that if you select Yes for the Run Only If Logged On setting, you must also specify a password in the Password setting. Otherwise the scheduled task cannot be created at run time, and the installation aborts. Tip:You can use a Windows Installer public property to specify this information. This enables you to use data that end users enter in dialogs, or other configuration information that is determined at run time, when a scheduled task is configured at run time. For more information, see Using Windows Installer Properties to Dynamically Configure a Scheduled Task. |
||||||
|
Run Only If Logged On |
Specify whether you want the task to run only if the user account that is specified in the Run As setting is logged on to the system at the time that the task is scheduled. Note that if you select Yes for this setting, you must also specify a password in the Password setting (which is under the Run As setting). Otherwise the scheduled task cannot be created at run time, and the installation aborts. |
Use a scheduled task’s Schedule settings to specify details such as how often you want the task to run. Note that some of the settings are displayed only if you select certain schedule options.
|
Setting |
Description |
|||||||||
|
Schedule Type |
Select the option that describes how often you want the scheduled task to be run. |
|||||||||
|
Start Time |
Enter the time that the task should start to be run in the following format: hh:mm where hh is the number of hours that have passed since midnight, and mm is the number of minutes that have passed since the start of the hour. The time that you specify should be from 00:00 to 23:59. For example, for a start time of 2:45 PM, enter 14:45. |
|||||||||
|
Start Date |
Enter the date on which the task should start to be run. Use the same date format that is configured for the operating system of the machine on which you are using InstallShield. |
|||||||||
|
Interval |
Specify how often the scheduled task should be run, starting at the specified time and date. |
|||||||||
|
Run On |
This setting varies, depending on the option that you select in the Schedule Type setting.
|
|||||||||
|
Week |
Select which week of the month you want the monthly scheduled task to be run. |
|||||||||
|
Day |
To specify the days on which you want the monthly scheduled task to be run, click the ellipsis button (...) in this setting, and then select the check boxes of the appropriate days. |
|||||||||
|
Months |
To specify the months of the year in which you want the monthly scheduled task to be run, click the ellipsis button (...) in this setting, and then select the appropriate check boxes. |
|||||||||
|
Idle Time |
Specify the number of minutes that the target system should be idle before running the scheduled task. |
See Also