Packages file

The packages.csv file allows treatments to be grouped together in to sets that can be applied as a unit, The first or any treatment will be applied only if all treatments in the package can be applied. If any one treatment in the package is cancelled, then all treatments in the package are cancelled.

See Table 13, “Packages file format” for a detailed description of the packages file.

Table 13. Packages file format

AttributeData TypeDescription
TRACKStringAn alphanumeric label that matches a track label from the treatments file (see the section called “Treatments”).
BEGINinteger A number that represents the starting offset when this treatment package is eligible. The treatment package is eligible if the managed offset is greater than or equal to the beginning offset.
ENDinteger A number that represents the ending offset after which this treatment package is no longer eligible. The treatment package can only be applied if the managed offset is less than or equal to the ending offset.
TREATMENTString An alphanumeric label that identifies the treatment to be applied in the treatment package. This treatment must be defined in the the section called “Treatments” for this track.
CYCLEIntegerThe cycle value for the matching treatment in the the section called “Treatments” for this track
PACKAGEStringAn alphanumeric label that is used to match to the package sequence records in the package sequences file (see the section called “Package sequences file”).
NEWTREATMENTStringAn alphanumeric label that provides a name for this package. The label must be unique among treatment names for this track and cycle.
MANUAL A value of blank, "Managed" or "Unmanaged". This field controls the scheduling restrictions for this treatment package. Blank or not specified means that the treatment package may be applied by the solver, "Managed' (or "Unmanaged") means that the treatment package may be applied manually to the managed (or unmanaged) portion of the block, but cannot by used by the solver.

Packages are made up of treatments that are already defined in the treatment file (see the section called “Treatments”). The sequence of treatments in the package are composed of the first treatment, which is defined with the TREATMENT code in the package record, and the remaining sequence of treatments in the package, which are defined in the packagesequences.csv file (see the section called “Package sequences file”).

In order to set up a treatment package

During scheduling Patchworks will apply the treatments in the package as a unit: either all are applied or none are applied. The timing of the first treatment will depend on the operability limits and the scheduling objectives. All subsequent treatments are applied in a fixed timing as defined in the section called “Package sequences file”.

[Note]Note

The treatments that compose the package should be defined as MANUAL treatments. This will prevent the scheduler from choosing to apply these treatments independently outside of the package context.