Edit the attributes of a task
SCHED / EditTask '<TaskName>' {AttributeName} <Parameters>
The SCHED EditTask Connect command edits the attributes of a task in STK/Scheduler. This command can be used to edit a single task attribute or multiple attributes of a single task. When editing multiple task attributes, all attributes will be applied to the task in the order in which they appear in the command with three exceptions. The Locked, Deferred, and Assignments keywords get applied in the order listed here after all other keywords get applied.
<TaskName> must be in singe quotes
{AttributeName} and related <Parameters> are:
All associated values for each parameter is required.
| {AttributeName} | <Parameters> | Parameters Values |
| Description | '<Description>' | '<text string>' in single quotes. Empty string is allowed. |
| Priority | <Priority> | Integer Number (must be within defined task priority scale for the schedule file) |
| Preference | <Preference> | "None", "Early", "Middle", or "Late" |
| Timeslot Preference | <TimeslotPreference> | "Early", "Middle", or "Late" |
| Groups | <# of groups> '<Group1Name>' '<GroupNName>' |
'<GroupNName>' must be in single quotes. If the task group does not exist, one will be created. |
| RecurringType | <RecurringType> | You cannot set this value if you are editing a task that is of type recurringChild "SingleInstance", "RecurringTime", or "RecurringResource" |
| NonRecurringDiscreteWindows | <# Windows> <DisWindow1Start> <DisWindow1Stop> '<DisWindow1Comment>' . . . <DisWindowNStart> <DisWindowNStop> '<DisWindowNComment>' |
<# Windows> is an integer value indicating the number of discrete window definitions contained in this command. For all Start and Stop parameters, enter time in YYYY/MM/DD_hh:mm:ss format. For Comment parameters, enter '<Any text string>' in single quotes. Empty string is allowed. Any previous discrete windows are deleted. Only used if RecurringType task attribute is = "SingleInstance" |
| NonRecurringPeriodicWindows | <# periodic definitions> <Frequency1> <Period1Start> <Period1Stop> <Epoch (custom only)> <Interval (custom only)> '<Period1Comment>' <# Inside Windows> <Per1Window1Start> <Per1Window1Duration> '<Per1Window1Comment>' . . . <Per1WindowNStart> <Per1WindowNDuration> '<Per1WindowNComment>' . . . PeriodicDefinitionN |
<# periodic definitions> is an integer value indicating the number of periodic definitions contained in this command. <Frequency> options are "Yearly", "Monthly", Weekly", "Daily", "Hourly", "Minutely", and "Custom" <Epoch> and <Interval> needed only when <Frequency> is set to "Custom" For Period Start, Stop, and Epoch parameters, enter absolute time in proper format (YYYY/MM/DD_HH:MM:SS). <PerPeriodPerWindow> options are "PerPeriod" or "PerWindow" <Repeats> must be a positive integer value For intervals and durations, enter time in integer seconds. For Comment parameters, enter '<Any text string>' in single quotes. Empty string is allowed. # Inside Windows is required but may be zero, in which case PerNWindow parameters should not be included. Any previous periodic windows are deleted. Only used if RecurringType task attribute is = "SingleInstance". For more information on parameters, see the description of the Periodic Window Definition Form |
| NonRecurringTimeImport | '<AbsoluteFileNamePath>' | Absolute Path/Filename of a window file. Only used if RecurringType task attribute is = "SingleInstance" |
| NonRecurringSTKReports | <# STK Reports> <Rep1Start> <Rep1Stop> <Rep1WindowType> <Rep1StartOffset> <Rep1StopOffset> <Rep1Duration> '<Rep1STKObj1>' '<Rep1STKObj2>' '<Rep1ReportName>' <Rep1MaintTimeOffset> . . . <RepNStart> <RepNStop> <RepNWindowType> <RepNStartOffset> <RepNStopOffset> <RepNDuration> '<RepNSTKObj1>' '<RepNSTKObj2>' '<RepNReportName>' <RepNMaintTimeOffset> |
<# STK Reports> is an integer value indicating the number of STK Report definitions contained in this command. For all Start and Stop parameters, enter time in YYYY/MM/DD_hh:mm:ss format. <RepNWindowType> is "Window", "FixedStart", or "FixedStop"; only required for Single Time type reports (ascending node, AOS, etc.). If not used, put filler such as "None" in this field. "Window" and "Value" report types are now automatically determined based on the selected report style name (Access, Range, etc.). <RepNStartOffset> is a Real Number representing seconds for Single Time type report, or Value1 for a value type report. This value is ignored for Single Time type reports where <RepNWindowType> = "FixedStop" <RepNStopOffset> is a Real Number representing seconds for Single Time type report, or Value2 for a value type report. This value is ignored for Single Time type reports where <RepNWindowType> = "FixedStart" <RepNDuration> is an Integer Number representing seconds. This value is ignored if <RepNWindowType> = "Window" '<RepNSTKObj1>' represents the first STKObject path not including the scenario name. This value must be in single quotes. (For Example: 'Satellite/FUSE'.) Empty String is not allowed. RepNSTKObj1 is case sensitive. '<RepNSTKObj2>' represents the second STKObject path not including the scenario name. This value must be in single quotes. (For Example: 'Satellite/FUSE'.) Empty string is allowed. RepNSTKObj2 is case sensitive. '<RepNReportName>' represents the STK report type. This value must be compatible with the number of defined STK Objects defined for <RepNSTKObj1> and <RepNSTKObj2>. An empty String is not allowed. Report name is case sensitive and must be in single quotes. <RepNMaintTimeOffset> requires a "yes" or "no" entry (an empty string is not allowed). If "yes", then any report start/stop time offsets from schedule start/stop times are maintained if schedule start/stop times are changed. Any previous Availability STK Report Definitions are deleted. |
| RecurringDiscreteWindows | <# Windows> <DisWindow1Start> <DisWindow1Stop> '<DisWindow1Comment>' . . . <DisWindowNStart> <DisWindowNStop> '<DisWindowNComment>' |
<# Windows> is an integer value indicating the number of discrete window definitions contained in this command. For all Start and Stop parameters, enter time in YYYY/MM/DD_hh:mm:ss format. For Comment parameters, enter '<Any text string>' in single quotes. Empty string is allowed. Any previous discrete windows are deleted. Only used if RecurringType task attribute is = "RecurringTime" |
| RecurringPeriodicWindows | <# periodic definitions> <Frequency1> <Period1Start> <Period1Stop> <PerPeriodPerWindow> <Repeats> <Epoch (custom only)> <Interval (custom only)> '<Period1Comment>' <# Inside Windows> <Per1Window1Start> <Per1Window1Duration> '<Per1Window1Comment>' . . . <Per1WindowNStart> <Per1WindowNDuration> '<Per1WindowNComment>' . . . PeriodicDefinitionN |
<# periodic definitions> is an integer value indicating the number of periodic definitions contained in this command. <Frequency> options are "Yearly", "Monthly", Weekly", "Daily", "Hourly", "Minutely", and "Custom" <Epoch> and <Interval> needed only when <Frequency> is set to "Custom" For Period Start, Stop, and Epoch parameters, enter absolute time in proper format (YYYY/MM/DD_HH:MM:SS). <PerPeriodPerWindow> options are "PerPeriod" or "PerWindow" <Repeats> must be a positive integer value For intervals and durations, enter time in integer seconds. For Comment parameters, enter '<Any text string>' in single quotes. Empty string is allowed. Any previous periodic windows are deleted. # Inside Windows is required but may be zero, in which case PerNWindow parameters should not be included. PerNWindowNStart is an offset in integer seconds. Only used if RecurringType task attribute is = "RecurringTime". For more information on parameters, see the description of the Periodic Window Definition Form |
| RecurringTimeImport | '<AbsoluteFileNamePath>' | Absolute Path/Filename of a window file. Only used if RecurringType task attribute is = "RecurringTime" |
| RecurringSTKReports | <# STK Reports> <Rep1Start> <Rep1Stop> <Rep1WindowType> <Rep1StartOffset> <Rep1StopOffset> <Rep1Duration> '<Rep1STKObj1>' '<Rep1STKObj2>' '<Rep1ReportName>' <Rep1MaintTimeOffset> . . . <RepNStart> <RepNStop> <RepNWindowType> <RepNStartOffset> <RepNStopOffset> <RepNDuration> '<RepNSTKObj1>' '<RepNSTKObj2>' '<RepNReportName>' <RepNMaintTimeOffset> |
<# STK Reports> is an integer value indicating the number of STK Report definitions contained in this command. For all Start and Stop parameters, enter time in YYYY/MM/DD_hh:mm:ss format. <RepNWindowType> is "Window", "FixedStart", or "FixedStop"; only required for Single Time type reports (ascending node, AOS, etc.). If not used, put filler such as "None" in this field. "Window" and "Value" report types are now automatically determined based on the selected report style name (Access, Range, etc.). <RepNStartOffset> is a Real Number representing seconds for Single Time type report, or Value1 for a value type report. This value is ignored for Single Time type reports where <RepNWindowType> = "FixedStop" <RepNStopOffset> is a Real Number representing seconds for Single Time type report, or Value2 for a value type report. This value is ignored for Single Time type reports where <RepNWindowType> = "FixedStart" <RepNDuration> is an Integer Number representing seconds. This value is ignored if <RepNWindowType> = "Window" '<RepNSTKObj1>' represents the first STKObject path not including the scenario name. This value must be in single quotes. (For Example: 'Satellite/FUSE'.) Empty String is not allowed. RepNSTKObj1 is case sensitive. '<RepNSTKObj2>' represents the second STKObject path not including the scenario name. This value must be in single quotes. (For Example: 'Satellite/FUSE'.) Empty string is allowed. RepNSTKObj2 is case sensitive. '<RepNReportName>' represents the STK report type. This value must be compatible with the number of defined STK Objects defined for <RepNSTKObj1> and <RepNSTKObj2>. An empty String is not allowed. Report name is case sensitive and must be in single quotes. <RepNMaintTimeOffset> requires a "yes" or "no" entry (an empty string is not allowed). If "yes", then any report start/stop time offsets from schedule start/stop times are maintained if schedule start/stop times are changed. Any previous Availability STK Report Definitions are deleted. |
| RecurringConstraints | <minAfterType> <minTimeAfter> <maxAfterType> <maxTimeAfter> |
<minAfterType> is the constraining task reference point to use, either "afterStart" or "afterStop" (without quotes). <minTimeAfter> is the recurring task minimum time between interval in integer seconds. A value of "NA" means that the constraint is not applicable. <maxAfterType> is the constraining task reference point to use, either "afterStart" or "afterStop" (without quotes). <maxTimeAfter> is the recurring task maximum time between interval in integer seconds. A value of "NA" means that the constraint is not applicable. |
| Duration | <DurationType> <FullTimeslot> <FixedDuration> <MinDuration> <MaxDuration |
"Fixed", "MaxNoHandovers", or "MaxHandovers" <FullTimeslot> may be "FullTimeslot" or "NA"."FullTimeslot" is only a valid value for "MaxNoHandovers". Any Duration values are integers representing seconds <FixedDuration> value is ignored if "Fixed" <DurationType> is not defined. <MinDuration> values is ignored if "FixedDuration" <DurationType> is defined. <MaxDuration> values is ignored if "FixedDuration" <DurationType> is defined. If <MaxDuration> < 0, this means that the task has an unlimited duration |
| Min_Total_Duration | <MinTotalDuration> |
Duration value is an integer representing seconds Only used for tasks with duration option Maximize - Allow Handovers. For these tasks, MinDuration from the Duration attribute (above) is used as Minimum Segment Duration (minimum duration for each single assignment). |
| ResourceFormula | <CreateSTKAccessReport> '<Formula>' |
<CreateSTKAccessReport> options are "Yes" or "No". If "Yes" is selected, then for each possibility, the default STK access report will be created and applied to that possibility for timeslot creation. '<Text string of the resource formula>' The entire formula must be in single quotes. Each Resource Name must be enclosed in quotes. Example: Yes '"ResourceNameA" AND "ResourceNameB" AND ("ResourceNameC" OR "ResourceNameD")' |
| SetPossibilityPriority | '<Possibility Name>' <Priority> |
'<PossibilityName>' is a comma delimited list of resources in the possibility. Order is not required. Value must be in single quotes. Do not encompass resource names in quotes. <Priority> Integer Number (must be within defined resource priority scale for the active schedule) |
| SetPossibilitySTKReports | '<Possibility Name>' <# STK Reports> <Rep1Start> <Rep1Stop> <Rep1WindowType> <Rep1StartOffset> <Rep1StopOffset> <Rep1Duration> '<Rep1STKObj1>' '<Rep1STKObj2>' '<Rep1ReportName>' <Rep1MaintTimeOffset> . . . <RepNStart> <RepNStop> <RepNWindowType> <RepNStartOffset> <RepNStopOffset> <RepNDuration> '<RepNSTKObj1>' '<RepNSTKObj2>' '<RepNReportName>' <RepNMaintTimeOffset> |
'<PossibilityName>' is a comma delimited list of resources in the possibility. Order is not required. Value must be in single quotes. Do not encompass resource names in quotes. <# STK Reports> is an integer value indicating the number of STK Report definitions contained in this command. For all Start and Stop parameters, enter time in YYYY/MM/DD_hh:mm:ss format. <RepNWindowType> is "Window", "FixedStart", or "FixedStop"; only required for Single Time type reports (ascending node, AOS, etc.). If not used, put filler such as "None" in this field. "Window" and "Value" report types are now automatically determined based on the selected report style name (Access, Range, etc.). <RepNStartOffset> is a Real Number representing seconds for Single Time type report, or Value1 for a value type report. This value is ignored for Single Time type reports where <RepNWindowType> = "FixedStop" <RepNStopOffset> is a Real Number representing seconds for Single Time type report, or Value2 for a value type report. This value is ignored for Single Time type reports where <RepNWindowType> = "FixedStart" <RepNDuration> is an Integer Number representing seconds. This value is ignored if <RepNWindowType> = "Window" '<RepNSTKObj1>' represents the first STKObject path not including the scenario name. This value must be in single quotes. (For Example: 'Satellite/FUSE'.) Empty String is not allowed. RepNSTKObj1 is case sensitive. '<RepNSTKObj2>' represents the second STKObject path not including the scenario name. This value must be in single quotes. (For Example: 'Satellite/FUSE'.) Empty string is allowed. RepNSTKObj2 is case sensitive. '<RepNReportName>' represents the STK report type. This value must be compatible with the number of defined STK Objects defined for <RepNSTKObj1> and <RepNSTKObj2>. An empty String is not allowed. Report name is case sensitive and must be in single quotes. <RepNMaintTimeOffset> requires a "yes" or "no" entry (an empty string is not allowed). If "yes", then any report start/stop time offsets from schedule start/stop times are maintained if schedule start/stop times are changed. Any previous Availability STK Report Definitions are deleted. |
| SetPossibilityTIMEImports | '<Possibility Name>' <# File Imports> '<file1>' '<file2>' . . . '<fileN>' |
'<PossibilityName>' is a comma delimited list of resources in the possibility. Order is not required. Value must be in single quotes. Do not encompass resource names in quotes. <# File Imports> is an integer value indicating the number of file definitions contained in this command. '<fileN>' is the full pathname of the file in single quotes. |
| SetPossibilityTimes | '<Possibility Name>' <# Times> <Times1> <Times2> . . . <TimesN> |
'<PossibilityName>' is a comma delimited list of resources in the possibility. Order is not required. Value must be in single quotes. Do not encompass resource names in quotes. <# Times> is an integer value indicating the number of time pair definitions contained in this command. <TimesN> is the start and stop time for a possibility time. These Times should be space delimited and in the same format as the times in the Time Import Files. <StartTime> <EndTime> in the format YYYY/MM/DD_hh:mm:ss YYYY/MM/DD_hh:mm:ss. |
| SetPossibilityTimeslot | '<PossibilityName>' <TimeslotStartTime> <TimeslotStopTime> <TimeslotPreferredStartTime> <Desirability> '<Comment>' |
'<PossibilityName>' is a comma delimited list of resources in the possibility. Order is not required. Value must be in single quotes. Do not encompass resource names in quotes. For all Start, Stop, and Preferred Start parameters, enter time in YYYY/MM/DD_hh:mm:ss format. The <TimeslotStartTime> and <TimeslotStopTime> represent an existing timeslot within the defined possibility. The <TimeslotPreferredStartTime> is an optional parameter that is used to set a preferred start time within the existing window and must be between <TimeslotStartTime> and <TimeslotStopTime> minus the minimum duration of the task. If <TimeslotPreferredStartTime> is omitted then <TimeslotPreferredStartTime> is defaulted to <TimeslotStartTime>. <Desirability> is an integer value bwtween 0 and 100 For Comment parameters, enter '<Any text string>' in single quotes. Empty string is allowed. |
| SetPossibilityResource | '<PossibilityName>' '<ResourceName>' <CapacityType> <FixedValue> <SetupTime> |
This parameter will define resource usage for a single task possibility. This parameter has been superceded by SetPossibilityResource2, but has been left in the software for the purposes of backwards compatibility with integrated software installations. '<PossibilityName>' is a comma delimited list of resources in the possibility. Order is not required. Value must be in single quotes. Do not encompass resource names in double quotes. '<ResourceName>' is the resource that you wish to define how it is used. This value must be in single quotes. <CapacityType> options are "Resilient", "Deplete", or "Replenish", or "NA". This value must be compatible with the corresponding resource capacity attributes. <FixedValue> is a floating point number. This is ignored for "NA" <CapacityType> <SetupTime> is an integer value that represents seconds. |
| SetPossibilityResource2 | '<PossibilityName>' '<ResourceName>' <CapacityType> <RateType> <Amount> <RateTime> <RateInterval> <SetupAmount> <SetupTime> <Reserved> <Animation> |
This parameter will define resource usage for a single task possibility. '<PossibilityName>' is a comma delimited list of resources in the possibility. Order is not required. Value must be in single quotes. Do not encompass resource names in double quotes. '<ResourceName>' is the resource that you wish to define how it is used. This value must be in single quotes. <CapacityType> options are "Resilient", "Deplete", or "Replenish", or "NA". This value must be compatible with the corresponding resource capacity attributes. <RateType> is either FIXED or RATE. <Amount> is a floating point number indicating the capacity amount. This is ignored for "NA" <CapacityType> <RateTime> is integer seconds representing the rate time period. <RateInterval> is the integer number of intervals to break the resource capacity span into for the purposes of algorithm task scheduling. The larger the number the higher the time fidelity and capacity fidelity of resource assignments (at the expense of algorithm speed). <SetupAmount> is a floating point number indicating the capacity amount used during the <SetupTime>. This is ignored for "NA" and "RATE" <CapacityType>. <SetupTime> is an integer value that represents seconds. <Animation> options are "NA", "None", "SensorOn", and "ObjectLine". The "SensorOn" option is only valid for resources associated with STK sensor objects. "NA" should be used for resources not associated with STK objects. <Reserved> must be an integer >=0, but this number is not currently used. |
| SetTaskResource | '<ResourceName>' <CapacityType> <FixedValue> <SetupTime> |
This parameter will define resource usage for a particular resource for all a task's possibilities. This parameter has been superceded by SetTaskResource2, but has been left in the software for the purposes of backwards compatibility with integrated software installations. '<ResourceName>' is the resource that you wish to define how it is used. This value must be in single quotes. <CapacityType> options are "Resilient", "Deplete", or "Replenish", or "NA". This value must be compatible with the corresponding resource capacity attributes. <FixedValue> is a floating point number. This is ignored for "NA" <CapacityType> <SetupTime> is an integer value that represents seconds. |
| SetTaskResource2 | '<ResourceName>' <CapacityType> <RateType> <Amount> <RateTime> <RateInterval> <SetupAmount> <SetupTime> <Reserved> <Animation> |
This parameter will define resource usage for a particular resource for all a task's possibilities. '<ResourceName>' is the resource that you wish to define how it is used. This value must be in single quotes. <CapacityType> options are "Resilient", "Deplete", or "Replenish", or "NA". This value must be compatible with the corresponding resource capacity attributes. <RateType> is either FIXED or RATE. <Amount> is a floating point number indicating the capacity amount. This is ignored for "NA" <CapacityType> <RateTime> is integer seconds representing the rate time period. <RateInterval> is the integer number of intervals to break the resource capacity span into for the purposes of algorithm task scheduling. The larger the number the higher the time fidelity and capacity fidelity of resource assignments (at the expense of algorithm speed). <SetupAmount> is a floating point number indicating the capacity amount used during the <SetupTime>. This is ignored for "NA" and "RATE" <CapacityType>. <SetupTime> is an integer value that represents seconds. <Animation> options are "NA", "None", "SensorOn", and "ObjectLine". The "SensorOn" option is only valid for resources associated with STK sensor objects. "NA" should be used for resources not associated with STK objects. <Reserved> must be an integer >=0, but this number is not currently used. |
| ObjectLineColor | <Color> | <Color> is the color that STK will use to draw Object Lines for this task. The colors you may use are: azure1, black, blue, chartreuse1, chocolate, cyan, DarkSeaGreen, DarkTurquoise, desertdust, gold, gray30, gray60, green, HotPink, IndianRed1, khaki, LavenderBlush1, LightCoral, LightSkyBlue, magenta, MediumOrchid, OliveDrab, orange, purple1, red, RoyalBlue, white, and yellow. These colors are also listed in the _Default.ap STK file |
| Dependencies | <NofDuring> <NofPredecessor> <NumberDep> '<Dep1TaskName>' <Dep1Type> <Dep1MinTimeAfterType> <Dep1MinTimeAfter> <Dep1MaxTimeAfterType> <Dep1MaxTimeAfter> . . . '<DepNTaskName>' <DepNType> <DepNMinTimeAfterType> <DepNMinTimeAfter> <DepNMaxTimeAfterType> <DepNMaxTimeAfter> |
<NofDuring> is the number of defined during task constraints that must be met before this task can be assigned. <NofPredecessor> is the number of defined predecessor task constraints that must be met before this task can be assigned. <NumberDep> is total number of task dependency definitions to follow. '<DepNTaskName>' is the name of the constraining task in single quotes. <DepNType> is the type of dependency ("Pred" for predecessor or "During", without the quotes). <minAfterType> is either "afterStart" or "afterStop". This value is required but ignored if minTimeAfter is "NA" (not applicable). <minTimeAfter> is the minimum time between definition in integer seconds ("NA" means minimum time between constraint does not apply). <maxAfterType> is either "afterStart" or "afterStop". This value is required but ignored if maxTimeAfter is "NA" (not applicable). <maxTimeAfter> is the maximum time between definition in integer seconds ("NA" means maximum time between constraint does not apply). This command will delete any previous existing list of dependency constraints. |
| Notes | '<Notes>' | <Notes> value must be in single quotes. This value can contain special character codes, including carriage returns and line feeds. |
| Locked | lock | "YES" or "NO" |
| Deferred | deferred | "YES" or "NO" |
| Assignments | <# of Assignments> <Assignment1StartTime> <Assignment1StopTime> '<Assignment1PossibilityName>' . . . <AssignmentNStartTime> <AssignmentNStopTime> '<AssignmentNPossibilityName>' |
<# of Assignments> is an integer value indicating the number of assignment definitions contained in this command. For all Start and Stop parameters, enter time in YYYY/MM/DD_hh:mm:ss format. '<AssignmentPossibilityName>' is a comma delimited list of resources in the possibility. Order is not required. Value must be in single quotes. Do not encompass resource names in double quotes. |
| Hide | <HideOption> | "Yes" or "No" |
To change the values of the Description, Priority, and RecurringDiscreteWindows attributes of the SSRDump task in the active schedule to "This is a test", 7, and 2002/05/20 12:00:00 2002/05/20 12:52:00 "Demo comment", respectively:
SCHED / EditTask 'SSRDump' Description 'This is a test' Priority 7 RecurringDiscreteWindows 1 2002/05/20_12:00:00 2002/05/20_12:52:00 'Demo comment'
| Syntax | Example |
| <CommandName> | SCHED / EditTask |
| <TaskName> | 'SSRDump' |
| {AttributeName} | Description |
| <Parameters> | 'This is a test' |
| {AttributeName} | Priority |
| <Parameters> | 7 |
| {AttributeName} | RecurringDiscreteWindows |
| <Parameters> | 1 2002/05/20_12:00:00 2002/05/20_12:52:00 'Demo comment' |
If activated, Connect returns an acknowledgment message.
This command belongs to the following group(s):
4.3.1 and 5.0
Copyright and Terms of Use, © 2002-2005 Orbit Logic, Inc. All rights reserved.