SCHED: SetConfigOptions
Format
SCHED / SetConfigOptions <AttributeName> <Parameters>
Description
The SCHED SetConfigOptions Connect command edits the STK Scheduler configuration options (available through the GUI under the File > Configuration menu selection). One or more of the optional attributes may be included in the command.
| {AttributeName} | <Parameters> | Parameters Values |
|---|---|---|
| AutoValidate | Boolean | "yes"/"on"/"true" or "no"/"off"/"false" |
| ErrPopup | Boolean | "yes"/"on"/"true" or "no"/"off"/"false" |
| NaturalSort | Boolean | "yes"/"on"/"true" or "no"/"off"/"false" |
| SchedUserDir | '<AbsoluteFileNamePath>' | '<AbsoluteFileNamePath>'. This value must be in single quotes. |
| GanttTableWidth | TableWidth | <integer>. Integer value between 0 and 100. |
| EventLogging | Boolean | "yes"/"on"/"true" or "no"/"off"/"false" Note: Events will still appear on the bottom of Scheduler |
| EnableTimelineViewForSTKAnimate | Boolean | "yes"/"on"/"true" or "no"/"off"/"false" |
| ConnectCommandLogging | Boolean | "yes"/"on"/"true" or "no"/"off"/"false" |
| EnableSocketConnectionToSTK | Boolean | "yes"/"on"/"true" or "no"/"off"/"false" |
| ShowGUI | Boolean | "yes"/"on"/"true" or "no"/"off"/"false" |
| GraphicsOn | Boolean | "yes"/"on"/"true" or "no"/"off"/"false" |
| UseDayOfYear | Boolean | "yes"/"on"/"true" or "no"/"off"/"false" |
| ApiReturnDataEnabled | Boolean | "yes"/"on"/"true" or "no"/"off"/"false" |
| STKServer | Server name | "localhost" or the name of the server running STK |
| STKPort | TCP Port number | 5001 is the default number, but can be configured to use other ports in STK |
| STKTimestep | Decimal number of seconds | Any value from .001 to 1,000,000,000 |
| EnableTCP | Boolean | "yes"/"on"/"true" to use TCP or "no"/"off"/"false" to use COM |
| MaxCOMConnectionsToSTK | Number of connections to allow concurrently to STK via COM, which will limit the number of STK instances that Scheduler opens | -1 for unlimited, or any positive number as a limit |
| TCPPort | Scheduler's TCP Port number | 8001 is the default number, but can be set to any valid port number within 1024 to 65535 |
| EnableREST | Boolean | "yes"/"on"/"true" or "no"/"off"/"false" |
| RESTUrl | URL or semicolon-separated URLs with port numbers | 'http://*:5000' or 'http://schedulerserver.com:5000;http://localhost:5000' or other urls |
| RESTDir | REST schedule directory | Local directory path such as 'C:\\SchedulerRESTSchedules' |
Examples
Disables all STK Scheduler popups
SCHED / SetConfigOptions AutoValidate no Errpopup no
| Syntax | Example |
|---|---|
| <CommandName> | SCHED / SetConfigOptions |
| {AttributeName} | AutoValidate |
| <AutoValidate> | no |
| {AttributeName} | Errpopup |
| <Errpopup> | no |
Disables Natural Sort for Scheduler
SCHED / SetConfigOptions NaturalSort no
| Syntax | Example |
|---|---|
| <CommandName> | SCHED / SetConfigOptions |
| {AttributeName} | NaturalSort |
| <NaturalSort> | no |
Return Message
If activated, Connect returns an acknowledgment message.
Group Membership
This command belongs to the following group(s):
Version
6.0
