NRAO Home  >  Green Bank  |  Wiki Topic:    GB > Software > ModificationRequest4C805

Changes | Index | Contents | Search | Statistics | Go

Allow Saving of Invalid Scheduling Blocks within the Astrid Database

Modification Request #4 (C8 2005)

• 1. Introduction
• 2. Background
• 3. Requirements
• 4. Design
• 5. Test Plan
• 6. Out of Scope
• Signatures
• Status
• CCC Discussion Area

1. Introduction

Currently there is no means for an observer to save invalid scheduling blocks to the astrid database. We would like to change that fact.

2. Background

Currently astrid does not allow users to save invalid scheduling blocks to the astrid database. The idea is that invalid scheduling blocks (sbs) would instead be exported to a file for the purpose of saving them. A number of observers have complained about this and as a consequence we would like to remove the restriction.

3. Requirements

Users should be allowed to save invalid scheduling blocks to the astrid database. These invalid sbs should have a flag of some sort demarcating them as invalid. When an observer attempts to save an invalid scheduling block, a pop-up message should appear stating that the sb is invalid and asking if the observer would like to save it anyway. If they say yes, that sb should be visible within the astrid list of sbs in the edit tab and should be designated differently (e.g. have a red font). The designation (e.g. red font) would of course go away once the sb is valid (as determined when it is next saved). Only valid sbs will be listed in the Run tab.

4. Design

Chain for generating scheduling block lists:

Edit

app/turtle/EditPanel.GetSBs app/turtle/EditDocument.GetSBs =database/SchedulingBlock.GetName2IdDictionary

Queue

app/turtle/QueueManagementPanel.GetSBs app/turtle/QueueManagementDocument.GetSBs =database/Project.Get

Modifications:

• Add to table ObsProcedure a field status of type ENUM with values unknown, legit, illicit, and valid.
• Modify GetName2IdDictionary in database/SchedulingBlock to GetName2IdStatusDictionary.
• Modify app/turtle/EditDocument to use database/Project:GetName2IdStatusDictionary.
• Modify =database/Project.Get to include the status field along with name, script, and last_modified fields and modify client code accordingly.
• Modify app/turtle/QueueManagementDocument.GetSBs to return only valid scheduling blocks.
• Modify app/turtle/EditPanel.PopulateSBList to indicate invalid scheduling blocks.
• Modify app/turtle/EditPanel.OnSBItemActivated to indicate validity of scheduling blocks in trafficlight indicator when brought into editor panel from the database.
• Modify app/turtle/Editpanel.SaveScriptToDatabase to set the status.
• Add dialogs as described in the requirements in app/turtle/EditPanel.OnSave.
• Remove the field state and remove database/SchedulingBlock:SetCompleted.

5. Test Plan

We should save a number of different invalid sbs and insure they are designated as invalid in the edit tab sb lists and unavailable in the run tab. We should then fix the problems in the sbs and both save and run the now valid sbs, insuring they save and run correctly and that they are no longer designated as invalid. Conversely, a valid scheduling block should be modified to be invalid to insure it is removed from the run queue and marked appropriately. The trafficlight indicator should always correctly describe the state of the scheduling block.

6. Out of Scope

The careful reader will notice that nowhere in this document is valid defined. The operatonal definition of valid is in the current code in turtle. It involves running the scheduling block as a python script and "stubbing out" most scan types and observing directives, but in other instances it does more than pure syntactic checking, e.g., Configure checks if routing is available for the currently active telescope. This last example highlights an anomaly in that a scheduling block may be invalid today may become valid tomorrow as different telescope devices "come on line." Tagging a scheduling block as valid is not, of course, a guarantee that it will run on the telescope. Validating is an attempt to help observers find problems in their scripts as early as possible. The definition of valid and when validation should occur are all under review at this time. The important part of this MR is the needed changes in the database, not how validation takes place or what it means. Those -- more weighty issues -- will be covered in future MRs.

Some thoughts on the issue are available.

Signatures

APPROVED: I acknowledge that my request is fully contained in this MR, and if the SDD delivers exactly what I specified, I will be happy.

ACCEPTED: I acknowledge that I have validated the completed code according to the acceptance tests, and I am happy with the results.

Status

Written	- KarenONeil - 07 Dec 2005
Checked	- AmyShelton - 10 Apr 2006
Approved by Sponsor	- KarenONeil - 11 Apr 2006
Approved by CCC	- AmyShelton - 01 Jun 2006
Accepted/Delivered by Sponsor	- KarenONeil - 31 Jul 2006

Symbols:

• Use %X% if MR is not complete (will display )
• Use %Y% if MR iscomplete (will display )

CCC Discussion Area