SCHED: BatchConvertSTKReportDefs
Format
SCHED / BatchConvertSTKReportDefs <IncludeResources> <IncludeTasks> <IncludeSingleInstanceTasks> <IncludeTaskProfiles> '<ReportNames>' {OptionalAttributeName} <Parameters>
Description
The SCHED BatchConvertSTKReportDefs Connect command updates the STK report definition for all existing reports on resources and/or tasks.
Parameters
- IncludeResources: Defines if reports definitions on Resources should be updated. Options are True/False.
- IncludeTasks: Defines if reports definitions on Recurring Tasks should be updated. Options are True/False.
- IncludeSingleInstanceTasks: Defines if reports definitions on Single Instance Tasks should be updated. Options are True/False.
- IncludeTaskProfiles: Defines if reports definitions on Task Profiles should be updated. Options are True/False.
- ReportNames: Comma delimited string of existing report types to update.
- StartingWindowTypes: Optional. A comma delimited string selecting only reports that currently have the specified starting window type. Options are 'FixedStart', 'FixedStop', 'FixedStoporStop', 'Window', 'ValueRange',and 'ValueReport'.
- TargetReportName: Optional. String of the new report type to replace all selected reports.
- TargetWindowType: Optional. String of the new starting window type. Options are 'FixedStart', 'FixedStop', 'FixedStoporStop', 'Window', 'ValueRange',and 'ValueReport'.
- RecreateAffectedPossibilites: Optional. Recreates the affected tasks, including any that use resources whose availabilities have been modified. This option must be placed at the end of the command. Accepts all parameter found in RecreatePossibilites.
Examples
Update all Line of Sight Access reports on any recurring task or task profile using a Fixed Start window type to become Ascending Node reports using a Fixed Stop window type. Recreate any affected tasks, retaining all resource usage settings, but not retaining any existing assignments.
SCHED / BatchConvertSTKReportDefs False True False True 'Line of Sight Access' StartingWindowTypes 'FixedStart' TargetReportName 'Ascending Node' TargetWindowType 'FixedStop' RecreateAffectedPossibilites RetainSettings True RetainAssignments False
| Syntax | Example |
|---|---|
| <CommandName> | SCHED / BatchConvertSTKReportDefs |
| <IncludeResources> | False |
| <IncludeTasks> | True |
| <IncludeSingleInstanceTasks> | False |
| <IncludeTaskProfiles> | True |
| <ReportNames> | 'Line of Sight Access' |
| <StartingWindowTypes> | 'FixedStart' |
| <TargetReportName> | 'Ascending Node' |
| <TargetWindowType> | 'FixedStop' |
| <RecreateAffectedPossibilites> | RetainSettings True RetainAssignments False |
Return Message
If successful, Connect returns an acknowledgment message.
Group Membership
This command belongs to the following group(s):
Version
12.9
